Replace GoF with confirmation state

client/evilwallet/connector.go

@@ -5,10 +5,10 @@ import (
 	"time"
 
 	"github.com/iotaledger/hive.go/identity"
+	"github.com/iotaledger/hive.go/types/confirmation"
 
 	"github.com/iotaledger/goshimmer/client"
 	"github.com/iotaledger/goshimmer/client/wallet"
-	"github.com/iotaledger/goshimmer/packages/consensus/gof"
 	"github.com/iotaledger/goshimmer/packages/jsonmodels"
 	"github.com/iotaledger/goshimmer/packages/ledger/utxo"
 	"github.com/iotaledger/goshimmer/packages/ledger/vm/devnetvm"
@@ -179,12 +179,12 @@ type Client interface {
 	GetUnspentOutputForAddress(addr devnetvm.Address) *jsonmodels.WalletOutput
 	// GetAddressUnspentOutputs gets the unspent outputs of an address.
 	GetAddressUnspentOutputs(address string) (outputIDs []utxo.OutputID, err error)
-	// GetTransactionGoF returns the GoF of a given transaction ID.
-	GetTransactionGoF(txID string) gof.GradeOfFinality
+	// GetTransactionConfirmationState returns the ConfirmationState of a given transaction ID.
+	GetTransactionConfirmationState(txID string) confirmation.State
 	// GetOutput gets the output of a given outputID.
 	GetOutput(outputID utxo.OutputID) devnetvm.Output
-	// GetOutputGoF gets the first unspent outputs of a given address.
-	GetOutputGoF(outputID utxo.OutputID) gof.GradeOfFinality
+	// GetOutputConfirmationState gets the first unspent outputs of a given address.
+	GetOutputConfirmationState(outputID utxo.OutputID) confirmation.State
 	// BroadcastFaucetRequest requests funds from the faucet and returns the faucet request message ID.
 	BroadcastFaucetRequest(address string) error
 	// GetTransactionOutputs returns the outputs the transaction created.
@@ -288,14 +288,14 @@ func (c *WebClient) GetUnspentOutputForAddress(addr devnetvm.Address) *jsonmodel
 	return nil
 }
 
-// GetOutputGoF gets the first unspent outputs of a given address.
-func (c *WebClient) GetOutputGoF(outputID utxo.OutputID) gof.GradeOfFinality {
+// GetOutputConfirmationState gets the first unspent outputs of a given address.
+func (c *WebClient) GetOutputConfirmationState(outputID utxo.OutputID) confirmation.State {
 	res, err := c.api.GetOutputMetadata(outputID.Base58())
 	if err != nil {
-		return gof.None
+		return confirmation.Pending
 	}
 
-	return res.GradeOfFinality
+	return res.ConfirmationState
 }
 
 // GetOutput gets the output of a given outputID.
@@ -308,13 +308,13 @@ func (c *WebClient) GetOutput(outputID utxo.OutputID) devnetvm.Output {
 	return output
 }
 
-// GetTransactionGoF returns the GoF of a given transaction ID.
-func (c *WebClient) GetTransactionGoF(txID string) gof.GradeOfFinality {
+// GetTransactionConfirmationState returns the ConfirmationState of a given transaction ID.
+func (c *WebClient) GetTransactionConfirmationState(txID string) confirmation.State {
 	resp, err := c.api.GetTransactionMetadata(txID)
 	if err != nil {
-		return gof.None
+		return confirmation.Pending
 	}
-	return resp.GradeOfFinality
+	return resp.ConfirmationState
 }
 
 // GetTransactionOutputs returns the outputs the transaction created.

client/evilwallet/output_manager.go

@@ -241,7 +241,7 @@ func (o *OutputManager) AwaitOutputToBeConfirmed(outputID utxo.OutputID, waitFor
 	clt := o.connector.GetClient()
 	confirmed = false
 	for ; time.Since(s) < waitFor; time.Sleep(awaitConfirmationSleep) {
-		gof := clt.GetOutputGoF(outputID)
+		gof := clt.GetOutputConfirmationState(outputID)
 		if gof == GoFConfirmed {
 			confirmed = true
 			break
@@ -279,7 +279,7 @@ func (o *OutputManager) AwaitTransactionToBeConfirmed(txID string, waitFor time.
 	clt := o.connector.GetClient()
 	var confirmed bool
 	for ; time.Since(s) < waitFor; time.Sleep(awaitConfirmationSleep) {
-		if gof := clt.GetTransactionGoF(txID); gof == GoFConfirmed {
+		if gof := clt.GetTransactionConfirmationState(txID); gof == GoFConfirmed {
 			confirmed = true
 			break
 		}

client/wallet/connector.go

@@ -1,8 +1,9 @@
 package wallet
 
 import (
+	"github.com/iotaledger/hive.go/types/confirmation"
+
 	"github.com/iotaledger/goshimmer/client/wallet/packages/address"
-	"github.com/iotaledger/goshimmer/packages/consensus/gof"
 	"github.com/iotaledger/goshimmer/packages/ledger/utxo"
 	"github.com/iotaledger/goshimmer/packages/ledger/vm/devnetvm"
 	"github.com/iotaledger/goshimmer/packages/mana"
@@ -15,6 +16,6 @@ type Connector interface {
 	SendTransaction(transaction *devnetvm.Transaction) (err error)
 	RequestFaucetFunds(address address.Address, powTarget int) (err error)
 	GetAllowedPledgeIDs() (pledgeIDMap map[mana.Type][]string, err error)
-	GetTransactionGoF(txID utxo.TransactionID) (gradeOfFinality gof.GradeOfFinality, err error)
+	GetTransactionConfirmationState(txID utxo.TransactionID) (confirmationState confirmation.State, err error)
 	GetUnspentAliasOutput(address *devnetvm.AliasAddress) (output *devnetvm.AliasOutput, err error)
 }

client/wallet/output.go

@@ -10,10 +10,10 @@ import (
 
 // Output is a wallet specific representation of an output in the IOTA network.
 type Output struct {
-	Address                address.Address
-	Object                 devnetvm.Output
-	Metadata               OutputMetadata
-	GradeOfFinalityReached bool
+	Address                  address.Address
+	Object                   devnetvm.Output
+	Metadata                 OutputMetadata
+	ConfirmationStateReached bool
 	// Spent is a local wallet-only property that gets set once an output is spent from within the same wallet.
 	Spent bool
 }

client/wallet/output_manager.go

@@ -100,7 +100,7 @@ func (o *OutputManager) getOutputs(includePending bool, addresses ...address.Add
 				continue
 			}
 			// discard non-confirmed if includePending is false
-			if !includePending && !output.GradeOfFinalityReached {
+			if !includePending && !output.ConfirmationStateReached {
 				continue
 			}
 

client/wallet/wallet.go

@@ -10,6 +10,7 @@ import (
 	"github.com/iotaledger/hive.go/generics/lo"
 	"github.com/iotaledger/hive.go/identity"
 	"github.com/iotaledger/hive.go/marshalutil"
+	"github.com/iotaledger/hive.go/types/confirmation"
 	"golang.org/x/crypto/blake2b"
 
 	"github.com/iotaledger/goshimmer/client/wallet/packages/address"
@@ -24,7 +25,6 @@ import (
 	"github.com/iotaledger/goshimmer/client/wallet/packages/sweepnftownedoptions"
 	"github.com/iotaledger/goshimmer/client/wallet/packages/transfernftoptions"
 	"github.com/iotaledger/goshimmer/client/wallet/packages/withdrawfromnftoptions"
-	"github.com/iotaledger/goshimmer/packages/consensus/gof"
 	"github.com/iotaledger/goshimmer/packages/ledger/utxo"
 	"github.com/iotaledger/goshimmer/packages/ledger/vm/devnetvm"
 	"github.com/iotaledger/goshimmer/packages/mana"
@@ -1412,7 +1412,7 @@ func (wallet *Wallet) Balance(refresh ...bool) (confirmedBalance, pendingBalance
 		for _, output := range outputsOnAddress {
 			// determine target map
 			var targetMap map[devnetvm.Color]uint64
-			if output.GradeOfFinalityReached {
+			if output.ConfirmationStateReached {
 				targetMap = confirmedBalance
 			} else {
 				targetMap = pendingBalance
@@ -1503,7 +1503,7 @@ func (wallet *Wallet) AvailableBalance(refresh ...bool) (confirmedBalance, pendi
 		for _, output := range outputsOnAddress {
 			// determine target map
 			var targetMap map[devnetvm.Color]uint64
-			if output.GradeOfFinalityReached {
+			if output.ConfirmationStateReached {
 				targetMap = confirmedBalance
 			} else {
 				targetMap = pendingBalance
@@ -1571,7 +1571,7 @@ func (wallet *Wallet) TimelockedBalances(refresh ...bool) (confirmed, pending Ti
 					Balance: casted.Balances().Map(),
 					Time:    casted.TimeLock(),
 				}
-				if output.GradeOfFinalityReached {
+				if output.ConfirmationStateReached {
 					confirmed = append(confirmed, tBal)
 				} else {
 					pending = append(pending, tBal)
@@ -1618,7 +1618,7 @@ func (wallet *Wallet) ConditionalBalances(refresh ...bool) (confirmed, pending T
 					Balance: casted.Balances().Map(),
 					Time:    fallbackDeadline,
 				}
-				if output.GradeOfFinalityReached {
+				if output.ConfirmationStateReached {
 					confirmed = append(confirmed, cBal)
 				} else {
 					pending = append(pending, cBal)
@@ -1666,7 +1666,7 @@ func (wallet *Wallet) AliasBalance(refresh ...bool) (
 			}
 			// target maps
 			var governedAliases, stateControlledAliases map[devnetvm.AliasAddress]*devnetvm.AliasOutput
-			if output.GradeOfFinalityReached {
+			if output.ConfirmationStateReached {
 				governedAliases = confirmedGovernedAliases
 				stateControlledAliases = confirmedStateControlledAliases
 			} else {
@@ -1764,7 +1764,7 @@ func (wallet *Wallet) DelegatedAliasBalance(refresh ...bool) (
 			}
 			// target maps
 			var delegatedAliases map[devnetvm.AliasAddress]*devnetvm.AliasOutput
-			if output.GradeOfFinalityReached {
+			if output.ConfirmationStateReached {
 				delegatedAliases = confirmedDelegatedAliases
 			} else {
 				delegatedAliases = pendingDelegatedAliases
@@ -1821,11 +1821,11 @@ func (wallet *Wallet) WaitForTxConfirmation(txID utxo.TransactionID) (err error)
 	for {
 		time.Sleep(wallet.ConfirmationPollInterval)
 		timeoutCounter += wallet.ConfirmationPollInterval
-		finality, fetchErr := wallet.connector.GetTransactionGoF(txID)
+		confirmationState, fetchErr := wallet.connector.GetTransactionConfirmationState(txID)
 		if fetchErr != nil {
 			return fetchErr
 		}
-		if finality == gof.High {
+		if confirmationState >= confirmation.Accepted {
 			return
 		}
 		if timeoutCounter > wallet.ConfirmationTimeout {

client/wallet/webconnector.go

@@ -2,10 +2,10 @@ package wallet
 
 import (
 	"github.com/cockroachdb/errors"
+	"github.com/iotaledger/hive.go/types/confirmation"
 
 	"github.com/iotaledger/goshimmer/client"
 	"github.com/iotaledger/goshimmer/client/wallet/packages/address"
-	"github.com/iotaledger/goshimmer/packages/consensus/gof"
 	"github.com/iotaledger/goshimmer/packages/ledger/utxo"
 	"github.com/iotaledger/goshimmer/packages/ledger/vm/devnetvm"
 	"github.com/iotaledger/goshimmer/packages/mana"
@@ -83,10 +83,10 @@ func (webConnector WebConnector) UnspentOutputs(addresses ...address.Address) (u
 			}
 			// build output
 			walletOutput := &Output{
-				Address:                addr,
-				Object:                 lOutput,
-				GradeOfFinalityReached: output.GradeOfFinality == gof.High,
-				Spent:                  false,
+				Address:                  addr,
+				Object:                   lOutput,
+				ConfirmationStateReached: output.ConfirmationState >= confirmation.Accepted,
+				Spent:                    false,
 				Metadata: OutputMetadata{
 					Timestamp: output.Metadata.Timestamp,
 				},
@@ -118,14 +118,13 @@ func (webConnector WebConnector) SendTransaction(tx *devnetvm.Transaction) (err
 	return
 }
 
-// GetTransactionGoF fetches the GoF of the transaction.
-func (webConnector WebConnector) GetTransactionGoF(txID utxo.TransactionID) (gradeOfFinality gof.GradeOfFinality, err error) {
+// GetTransactionConfirmationState fetches the ConfirmationState of the transaction.
+func (webConnector WebConnector) GetTransactionConfirmationState(txID utxo.TransactionID) (confirmationState confirmation.State, err error) {
 	txmeta, err := webConnector.client.GetTransactionMetadata(txID.Base58())
 	if err != nil {
 		return
 	}
-	gradeOfFinality = txmeta.GradeOfFinality
-	return
+	return txmeta.ConfirmationState, nil
 }
 
 // GetAllowedPledgeIDs gets the list of nodeIDs that the node accepts as pledgeIDs in a transaction.

documentation/docs/apis/ledgerstate.md

@@ -271,7 +271,7 @@ if err != nil {
 }
 fmt.Println("branch ID: ", resp.ID)
 fmt.Println("branch type: ", resp.Type)
-fmt.Println("branch inclusion state: ", resp.InclusionState)
+fmt.Println("branch inclusion state: ", resp.ConfirmationState)
 fmt.Println("branch parents IDs: ", resp.Parents)
 fmt.Println("branch conflicts IDs: ", resp.ConflictIDs)
 fmt.Printf("liked: %v, finalized: %v, monotonically liked: %v", resp.Liked, resp.Finalized, resp.MonotonicallyLiked)
@@ -290,7 +290,7 @@ fmt.Printf("liked: %v, finalized: %v, monotonically liked: %v", resp.Liked, resp
     "liked": false,
     "monotonicallyLiked": false,
     "finalized": false,
-    "inclusionState": "InclusionState(Pending)"
+    "confirmationState": "ConfirmationState(Pending)"
 }
 ```
 
@@ -304,7 +304,7 @@ fmt.Printf("liked: %v, finalized: %v, monotonically liked: %v", resp.Liked, resp
 | `liked`       | bool | The boolean indicator if branch is liked.   |
 | `monotonicallyLiked`   | bool | The boolean indicator if branch is monotonically liked.   |
 | `finalized`   | bool | The boolean indicator if branch is finalized.   |
-| `inclusionState`   | string | Inclusion state of a branch.   |
+| `confirmationState`   | string | Inclusion state of a branch.   |
 
 
 
@@ -1066,7 +1066,7 @@ for _, outputs := range resp.UnspentOutputs {
                             "address": "1Z4t5KEKU65fbeQCbNdztYTB1B4Cdxys1XRzTFrmvAf3"
                         }
                     },
-                    "inclusionState": {
+                    "confirmationState": {
                         "confirmed": true,
                         "rejected": false,
                         "conflicting": false
@@ -1105,7 +1105,7 @@ for _, outputs := range resp.UnspentOutputs {
 |Field | Type | Description|
 |:-----|:------|:------|
 | `output`  | Output | The unspent output.   |
-| `inclusionState`| InclusionState   | The inclusion state of the transaction containing the output.  |
+| `confirmationState`| ConfirmationState   | The inclusion state of the transaction containing the output.  |
 | `metadata`| WalletOutputMetadata   | The metadata of the output for the wallet lib.  |
 
 #### Type `Output`
@@ -1124,7 +1124,7 @@ for _, outputs := range resp.UnspentOutputs {
 | `transactionID`   | string | The transaction identifier encoded with base58.     |
 | `outputIndex`   | int | The index of an output.     |
 
-#### Type `InclusionState`
+#### Type `ConfirmationState`
 
 |Field | Type | Description|
 |:-----|:------|:------|

documentation/docs/tutorials/send_transaction.md

@@ -50,7 +50,7 @@ If we use a wallet, this information will be available along with the wallet bal
 ```Go
 resp, _ := goshimAPI.PostAddressUnspentOutputs([]string{myAddr.Base58()}) // ignoring error
 for _, output := range resp.UnspentOutputs[0].Outputs {
-		fmt.Println("outputID:", output.Output.OutputID.Base58, "confirmed:", output.InclusionState.Confirmed)
+		fmt.Println("outputID:", output.Output.OutputID.Base58, "confirmed:", output.ConfirmationState.Confirmed)
 }
 ```
 

go.mod

@@ -12,7 +12,7 @@ require (
 	github.com/gin-gonic/gin v1.7.0
 	github.com/go-resty/resty/v2 v2.6.0
 	github.com/gorilla/websocket v1.5.0
-	github.com/iotaledger/hive.go v0.0.0-20220617100616-12bd6f35b4a1
+	github.com/iotaledger/hive.go v0.0.0-20220623114907-44ff3c086a76
 	github.com/labstack/echo v3.3.10+incompatible
 	github.com/labstack/gommon v0.3.0
 	github.com/libp2p/go-libp2p v0.15.0

go.sum

@@ -477,6 +477,8 @@ github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANyt
 github.com/influxdata/influxdb1-client v0.0.0-20191209144304-8bf82d3c094d/go.mod h1:qj24IKcXYK6Iy9ceXlo3Tc+vtHo9lIhSX5JddghvEPo=
 github.com/iotaledger/hive.go v0.0.0-20220617100616-12bd6f35b4a1 h1:7eOS9j+1K2M66OLgL/7tYafQIP9d0MMmyn0e72AmRUA=
 github.com/iotaledger/hive.go v0.0.0-20220617100616-12bd6f35b4a1/go.mod h1:8f9U7qHFby0W3cxv/nKnz9LHn9BbwWU0tMsWDnfqzRI=
+github.com/iotaledger/hive.go v0.0.0-20220623114907-44ff3c086a76 h1:FpDyFynhKHzWg+4zKgvhn10OOajgw+59SctnrDx5JUQ=
+github.com/iotaledger/hive.go v0.0.0-20220623114907-44ff3c086a76/go.mod h1:8f9U7qHFby0W3cxv/nKnz9LHn9BbwWU0tMsWDnfqzRI=
 github.com/ipfs/go-cid v0.0.1/go.mod h1:GHWU/WuQdMPmIosc4Yn1bcCT7dSeX4lBafM7iqUPQvM=
 github.com/ipfs/go-cid v0.0.2/go.mod h1:GHWU/WuQdMPmIosc4Yn1bcCT7dSeX4lBafM7iqUPQvM=
 github.com/ipfs/go-cid v0.0.3/go.mod h1:GHWU/WuQdMPmIosc4Yn1bcCT7dSeX4lBafM7iqUPQvM=