From 275b05f1b1f180ff1f0e7fc4cc0fce9ea27fcc86 Mon Sep 17 00:00:00 2001
From: Gal Rogozinski <galrogogit@gmail.com>
Date: Tue, 5 Oct 2021 14:24:47 +0300
Subject: [PATCH] Implement Grade Of Finality Support

---
 src/app/components/Settings.tsx               | 32 ++++++++++++++++++-
 src/app/components/SettingsState.ts           |  5 +++
 src/app/components/Wallet.tsx                 |  4 ---
 .../api/models/IUnspentOutputsResponse.ts     | 18 ++---------
 src/models/ISettings.ts                       |  5 +++
 src/models/IWalletBalance.ts                  |  5 ---
 src/models/IWalletOutput.ts                   |  4 +--
 src/models/IWalletOutputInclusionState.ts     |  6 +---
 src/services/settingsService.ts               |  5 ++-
 src/services/walletService.ts                 | 29 ++++++++---------
 10 files changed, 65 insertions(+), 48 deletions(-)

diff --git a/src/app/components/Settings.tsx b/src/app/components/Settings.tsx
index 16858fc..5c9fa0a 100644
--- a/src/app/components/Settings.tsx
+++ b/src/app/components/Settings.tsx
@@ -42,10 +42,22 @@ class Settings extends Component<SettingsProps, SettingsState> {
             password: settings.password,
             accessManaPledgeID: settings.accessManaPledgeID,
             consensusManaPledgeID: settings.consensusManaPledgeID,
+            gofConfThreshold: settings.gofConfThreshold,
             isBusy: false
         });
     }
 
+    private static imposeMinMax(el: HTMLInputElement): void {
+        if (el.value !== "") {
+            if (parseInt(el.value) < parseInt(el.min)) {
+                el.value = el.min;
+            }
+            if (parseInt(el.value) > parseInt(el.max)) {
+                el.value = el.max;
+            }
+        }
+    }
+
     /**
      * Render the component.
      * @returns The node to render.
@@ -139,6 +151,23 @@ class Settings extends Component<SettingsProps, SettingsState> {
                                 onChange={e => this.setState({ consensusManaPledgeID: e.target.value })}
                             />
                         </div>
+                        <div className="card--label">
+                            Grade Of Finality for confirmation
+                        </div>
+                        <div className="card--value">
+                            <input
+                                className="fill"
+                                type="number"
+                                min="1"
+                                max="3"
+                                value={this.state.gofConfThreshold}
+                                onChange={e => {
+                                    Settings.imposeMinMax(e.target);
+                                    this.setState({ gofConfThreshold: e.target.valueAsNumber });
+                                    }
+                                }
+                            />
+                        </div>
                         <div className="margin-t-s">
                             <button
                                 onClick={() => this.save()}
@@ -178,7 +207,8 @@ class Settings extends Component<SettingsProps, SettingsState> {
             user: this.state.user ?? "",
             password: this.state.password ?? "",
             accessManaPledgeID: this.state.accessManaPledgeID ?? "",
-            consensusManaPledgeID: this.state.consensusManaPledgeID ?? ""
+            consensusManaPledgeID: this.state.consensusManaPledgeID ?? "",
+            gofConfThreshold: this.state.gofConfThreshold ?? 0
         };
         await this._settingsService.set(newSettings);
 
diff --git a/src/app/components/SettingsState.ts b/src/app/components/SettingsState.ts
index 5fc4132..f434ad7 100644
--- a/src/app/components/SettingsState.ts
+++ b/src/app/components/SettingsState.ts
@@ -40,4 +40,9 @@ export interface SettingsState {
      * The nodeID of the consensus Mana pledge.
      */
     consensusManaPledgeID?: string;
+
+    /**
+     * The minimal grade of finality needed for an output to be confirmed
+     */
+    gofConfThreshold?: number
 }
diff --git a/src/app/components/Wallet.tsx b/src/app/components/Wallet.tsx
index 8bfb5bf..f555f70 100644
--- a/src/app/components/Wallet.tsx
+++ b/src/app/components/Wallet.tsx
@@ -255,7 +255,6 @@ class Wallet extends Component<WalletProps, WalletState> {
                                                     <th>Color</th>
                                                     <th>Confirmed</th>
                                                     <th>Pending</th>
-                                                    <th>Rejected</th>
                                                     <th>&nbsp;</th>
                                                 </tr>
                                             </thead>
@@ -283,9 +282,6 @@ class Wallet extends Component<WalletProps, WalletState> {
                                                             <td className="warning">
                                                                 {balance.unConfirmed.toString()}
                                                             </td>
-                                                            <td className="danger">
-                                                                {balance.rejected.toString()}
-                                                            </td>
                                                             <td>
                                                                 <button
                                                                     disabled={balance.confirmed <= 0}
diff --git a/src/iota/api/models/IUnspentOutputsResponse.ts b/src/iota/api/models/IUnspentOutputsResponse.ts
index 34349c6..7f63c21 100644
--- a/src/iota/api/models/IUnspentOutputsResponse.ts
+++ b/src/iota/api/models/IUnspentOutputsResponse.ts
@@ -49,22 +49,10 @@ export interface IUnspentOutputsResponse extends IResponse {
             };
 
             /**
-             *  InclusionState represents the different states of an OutputID.
+             *  GradeOfFinality represents the confirmation level. 0 is not confirmed.
+             *  3 is the maximum confirmation level.
              */
-            inclusionState: {
-                /**
-                 * Is the output confirmed.
-                 */
-                confirmed?: boolean;
-                /**
-                 * Is the output rejected.
-                 */
-                rejected?: boolean;
-                /**
-                 * Is the output conflicting.
-                 */
-                conflicting?: boolean;
-            };
+            gradeOfFinality: number;
         }[];
     }[];
 }
diff --git a/src/models/ISettings.ts b/src/models/ISettings.ts
index df2ba24..715b101 100644
--- a/src/models/ISettings.ts
+++ b/src/models/ISettings.ts
@@ -28,4 +28,9 @@ export interface ISettings {
      * Access Mana Pledge ID.
      */
     consensusManaPledgeID: string;
+
+    /**
+     * Grade of Finality Confirmation threshold
+     */
+    gofConfThreshold: number;
 }
diff --git a/src/models/IWalletBalance.ts b/src/models/IWalletBalance.ts
index 0524904..99c5129 100644
--- a/src/models/IWalletBalance.ts
+++ b/src/models/IWalletBalance.ts
@@ -15,9 +15,4 @@ export interface IWalletBalance {
      * Unconfirmed Balance.
      */
     unConfirmed: bigint;
-
-    /**
-     * Rejected Balance.
-     */
-    rejected: bigint;
 }
diff --git a/src/models/IWalletOutput.ts b/src/models/IWalletOutput.ts
index f279b44..a89b658 100644
--- a/src/models/IWalletOutput.ts
+++ b/src/models/IWalletOutput.ts
@@ -13,7 +13,7 @@ export interface IWalletOutput {
     balances: IWalletOutputBalance[];
 
     /**
-     * Inclusion state.
+     * Grade of finality.
      */
-    inclusionState: IWalletOutputInclusionState;
+    gof: number;
 }
diff --git a/src/models/IWalletOutputInclusionState.ts b/src/models/IWalletOutputInclusionState.ts
index dfcd06f..0418ca3 100644
--- a/src/models/IWalletOutputInclusionState.ts
+++ b/src/models/IWalletOutputInclusionState.ts
@@ -6,11 +6,7 @@ export interface IWalletOutputInclusionState {
     /**
      * Is the output confirmed.
      */
-    confirmed?: boolean;
-    /**
-     * Is the output rejected.
-     */
-    rejected?: boolean;
+    gof?: number;
     /**
      * Is the output liked.
      */
diff --git a/src/services/settingsService.ts b/src/services/settingsService.ts
index 3c547e4..0fba142 100644
--- a/src/services/settingsService.ts
+++ b/src/services/settingsService.ts
@@ -3,6 +3,8 @@ import { ISettings } from "../models/ISettings";
 import { IJsonStorageService } from "../models/services/IJsonStorageService";
 import { ISettingsService } from "../models/services/ISettingsService";
 
+const defaultGofConfThreshold = 3;
+
 /**
  * Service to manage settings.
  */
@@ -40,7 +42,8 @@ export class SettingsService implements ISettingsService {
                 user: "",
                 password: "",
                 accessManaPledgeID: "",
-                consensusManaPledgeID: ""
+                consensusManaPledgeID: "",
+                gofConfThreshold: defaultGofConfThreshold
             };
         }
 
diff --git a/src/services/walletService.ts b/src/services/walletService.ts
index 8251e73..fda1e71 100644
--- a/src/services/walletService.ts
+++ b/src/services/walletService.ts
@@ -358,10 +358,10 @@ export class WalletService implements IWalletService {
 
             const version = 0;
             const time = Date.now();
-            const timestamp = BigInt(time * 1000000);
+            const timestamp = BigInt(time * 1_000_000);
 
             // Calculate the spending requirements
-            const consumedOutputs = this.determineOutputsToConsume(sendFundsOptions);
+            const consumedOutputs = this.determineOutputsToConsume(sendFundsOptions, settings.gofConfThreshold);
 
             const { inputs, consumedFunds } = this.buildInputs(consumedOutputs);
             const outputs = this.buildOutputs(sendFundsOptions, consumedFunds);
@@ -575,7 +575,7 @@ export class WalletService implements IWalletService {
                     outputs: uo.outputs.filter(o => o.output.type === "SigLockedColoredOutputType").map(uid => ({
                         id: uid.output.outputID.base58,
                         balances: this.mapToArray(uid.output.output.balances),
-                        inclusionState: uid.inclusionState
+                        gof: uid.gradeOfFinality
                     }))
                 })));
             } while (spentAddresses.length > BLOCK_COUNT - 2);
@@ -607,10 +607,11 @@ export class WalletService implements IWalletService {
 
     /**
      * From all the inputs determine which ones we need to consume.
-     * @param sendFundOptions The request funds.
+     * @param sendFundOptions The request funds options.
+     * @param gofConfThreshold the grade of finality needed to consider the outputs as approved
      * @returns The output that we need to consume.
      */
-    private determineOutputsToConsume(sendFundOptions: ISendFundsOptions): {
+    private determineOutputsToConsume(sendFundOptions: ISendFundsOptions, gofConfThreshold : number): {
         [address: string]: { [outputID: string]: IWalletOutput };
     } {
         const outputsToConsume: { [address: string]: { [outputID: string]: IWalletOutput } } = {};
@@ -637,9 +638,7 @@ export class WalletService implements IWalletService {
                 const confirmedUnspentOutputs = unspentOutput.outputs.filter(o =>
                     (!this._spentOutputTransactions ||
                         !this._spentOutputTransactions.includes(o.id)) &&
-                    o.inclusionState.confirmed);
-
-
+                    o.gof >= gofConfThreshold);
                 // scan the outputs on this address for required funds
                 for (const output of confirmedUnspentOutputs) {
                     // keeps track if the output contains any usable funds
@@ -895,6 +894,8 @@ export class WalletService implements IWalletService {
             const assetsMap: { [id: string]: IWalletAsset } = {};
             const addedAssets: IWalletAsset[] = [];
             const apiRegistryClient = await this.buildApiRegistryClient();
+            const settingsService = ServiceFactory.get<SettingsService>("settings");
+            const settings = await settingsService.get();
 
             for (let i = 0; i <= this._wallet.lastAddressIndex; i++) {
                 const addr = Seed.generateAddress(Base58.decode(this._wallet.seed), BigInt(i));
@@ -902,7 +903,7 @@ export class WalletService implements IWalletService {
                     index: BigInt(i),
                     address: addr,
                     isSpent: this._wallet &&
-                        this._wallet.spentAddresses.includes(addr) ? true : false
+                    this._wallet.spentAddresses.includes(addr) ? true : false
                 };
                 addressMap[address.address] = address;
                 this._addresses.push(address);
@@ -948,15 +949,13 @@ export class WalletService implements IWalletService {
                             colorMap[balance.color] = {
                                 asset: assetsMap[balance.color],
                                 confirmed: BigInt(0),
-                                unConfirmed: BigInt(0),
-                                rejected: BigInt(0)
+                                unConfirmed: BigInt(0)
                             };
                             this._balances.push(colorMap[balance.color]);
                         }
-                        if (output.inclusionState.confirmed) {
+
+                        if (output.gof >= settings.gofConfThreshold) {
                             colorMap[balance.color].confirmed += balance.value;
-                        } else if (output.inclusionState.rejected) {
-                            colorMap[balance.color].rejected += balance.value;
                         } else {
                             colorMap[balance.color].unConfirmed += balance.value;
                         }
@@ -1040,4 +1039,4 @@ export class WalletService implements IWalletService {
         const settings = await settingsService.get();
         return new ApiRegistryClient(settings.apiRegistryEndpoint);
     }
-}
+}
\ No newline at end of file