Merge pull request #39 from coinbase/marcin/const-updates

Create constants for suported network names
coinbase · Sep 30, 2024 · 9fde58d · 9fde58d
2 parents 25b0cce + d1cf75d
commit 9fde58d
Show file tree

Hide file tree

Showing 11 changed files with 33 additions and 23 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,7 @@
 # Coinbase Go SDK Changelog
 
 ## Unreleased
+- Added constants for supported network names
 
 ## [0.0.11] - 2024-09-23
 

diff --git a/examples/ethereum/list-staking-balances/main.go b/examples/ethereum/list-staking-balances/main.go
@@ -28,7 +28,7 @@ func main() {
 	}
 
 	address := coinbase.NewExternalAddress(
-		"ethereum-mainnet",
+		coinbase.EthereumMainnet,
 		os.Args[1],
 	)
 

diff --git a/examples/ethereum/list-staking-rewards/main.go b/examples/ethereum/list-staking-rewards/main.go
@@ -29,7 +29,7 @@ func main() {
 	}
 
 	address := coinbase.NewExternalAddress(
-		"ethereum-mainnet",
+		coinbase.EthereumMainnet,
 		os.Args[1],
 	)
 

diff --git a/examples/ethereum/shared-eth-stake/main.go b/examples/ethereum/shared-eth-stake/main.go
@@ -27,7 +27,10 @@ func main() {
 		log.Fatalf("error creating coinbase client: %v", err)
 	}
 
-	address := coinbase.NewExternalAddress("ethereum-holesky", os.Args[2])
+	address := coinbase.NewExternalAddress(
+		coinbase.EthereumHolesky,
+		os.Args[2],
+	)
 
 	stakeableBalance, err := client.GetStakeableBalance(ctx, coinbase.Eth, address, coinbase.WithStakingBalanceMode(coinbase.StakingOperationModePartial))
 	if err != nil {

diff --git a/examples/solana/claim-stake/main.go b/examples/solana/claim-stake/main.go
@@ -10,14 +10,13 @@ import (
 	"time"
 
 	"github.com/btcsuite/btcutil/base58"
-	"github.com/coinbase/coinbase-sdk-go/gen/client"
 	"github.com/coinbase/coinbase-sdk-go/pkg/coinbase"
 	"github.com/gagliardetto/solana-go"
 	"github.com/gagliardetto/solana-go/rpc"
 )
 
 var (
-	networkID = client.NETWORKIDENTIFIER_SOLANA_DEVNET
+	networkID = coinbase.SolanaDevnet
 	amount    = big.NewFloat(0.01)
 	rpcURL    = "https://api.devnet.solana.com"
 )
@@ -112,9 +111,9 @@ func decodePrivateKey(privateKeyString string) (*ed25519.PrivateKey, error) {
 }
 
 func getTxLink(networkID, signature string) string {
-	if networkID == "solana-mainnet" {
+	if networkID == coinbase.SolanaMainnet {
 		return fmt.Sprintf("https://explorer.solana.com/tx/%s", signature)
-	} else if networkID == "solana-devnet" {
+	} else if networkID == coinbase.SolanaDevnet {
 		return fmt.Sprintf("https://explorer.solana.com/tx/%s?cluster=devnet", signature)
 	}
 

diff --git a/examples/solana/list-staking-balances/main.go b/examples/solana/list-staking-balances/main.go
@@ -10,7 +10,7 @@ import (
 )
 
 var (
-	networkID = "solana-mainnet"
+	networkID = coinbase.SolanaMainnet
 )
 
 /*

diff --git a/examples/solana/list-staking-rewards/main.go b/examples/solana/list-staking-rewards/main.go
@@ -11,7 +11,7 @@ import (
 )
 
 var (
-	networkID = "solana-mainnet"
+	networkID = coinbase.SolanaMainnet
 )
 
 /*

diff --git a/examples/solana/stake/main.go b/examples/solana/stake/main.go
@@ -10,14 +10,13 @@ import (
 	"time"
 
 	"github.com/btcsuite/btcutil/base58"
-	"github.com/coinbase/coinbase-sdk-go/gen/client"
 	"github.com/coinbase/coinbase-sdk-go/pkg/coinbase"
 	"github.com/gagliardetto/solana-go"
 	"github.com/gagliardetto/solana-go/rpc"
 )
 
 var (
-	networkID = client.NETWORKIDENTIFIER_SOLANA_DEVNET
+	networkID = coinbase.SolanaDevnet
 	amount    = big.NewFloat(0.01)
 	rpcURL    = "https://api.devnet.solana.com"
 )
@@ -112,9 +111,9 @@ func decodePrivateKey(privateKeyString string) (*ed25519.PrivateKey, error) {
 }
 
 func getTxLink(networkID, signature string) string {
-	if networkID == "solana-mainnet" {
+	if networkID == coinbase.SolanaMainnet {
 		return fmt.Sprintf("https://explorer.solana.com/tx/%s", signature)
-	} else if networkID == "solana-devnet" {
+	} else if networkID == coinbase.SolanaDevnet {
 		return fmt.Sprintf("https://explorer.solana.com/tx/%s?cluster=devnet", signature)
 	}
 

diff --git a/examples/solana/unstake/main.go b/examples/solana/unstake/main.go
@@ -10,14 +10,13 @@ import (
 	"time"
 
 	"github.com/btcsuite/btcutil/base58"
-	"github.com/coinbase/coinbase-sdk-go/gen/client"
 	"github.com/coinbase/coinbase-sdk-go/pkg/coinbase"
 	"github.com/gagliardetto/solana-go"
 	"github.com/gagliardetto/solana-go/rpc"
 )
 
 var (
-	networkID = client.NETWORKIDENTIFIER_SOLANA_DEVNET
+	networkID = coinbase.SolanaDevnet
 	amount    = big.NewFloat(0.01)
 	rpcURL    = "https://api.devnet.solana.com"
 )
@@ -112,9 +111,9 @@ func decodePrivateKey(privateKeyString string) (*ed25519.PrivateKey, error) {
 }
 
 func getTxLink(networkID, signature string) string {
-	if networkID == "solana-mainnet" {
+	if networkID == coinbase.SolanaMainnet {
 		return fmt.Sprintf("https://explorer.solana.com/tx/%s", signature)
-	} else if networkID == "solana-devnet" {
+	} else if networkID == coinbase.SolanaDevnet {
 		return fmt.Sprintf("https://explorer.solana.com/tx/%s?cluster=devnet", signature)
 	}
 

diff --git a/pkg/coinbase/staking_operation_test.go b/pkg/coinbase/staking_operation_test.go
@@ -346,7 +346,7 @@ func (s *StakingOperationSuite) TestSign_SignTransactionFails() {
 
 func (s *StakingOperationSuite) TestReloadStakingOperation_ExistingTransactionsNotOverwritten() {
 	var (
-		networkID               = "ethereum-holesky"
+		networkID               = EthereumHolesky
 		addressID               = "0x14a34"
 		stakingOperationID      = "staking-operation-id"
 		stakingOperationStatus  = "pending"
@@ -410,7 +410,7 @@ func (s *StakingOperationSuite) TestReloadStakingOperation_ExistingTransactionsN
 
 func (s *StakingOperationSuite) TestReloadStakingOperation_ErrorFormatting() {
 	var (
-		networkID              = "ethereum-holesky"
+		networkID              = EthereumHolesky
 		addressID              = "0x14a34"
 		stakingOperationID     = "staking-operation-id"
 		stakingOperationStatus = "pending"
@@ -449,7 +449,7 @@ func (s *StakingOperationSuite) TestReloadStakingOperation_ErrorFormatting() {
 
 func (s *StakingOperationSuite) TestFetchStakingOperation_Success() {
 	var (
-		networkID              = "ethereum-holesky"
+		networkID              = EthereumHolesky
 		addressID              = "0x14a34"
 		stakingOperationID     = "staking-operation-id"
 		stakingOperationStatus = "pending"
@@ -493,7 +493,7 @@ func (s *StakingOperationSuite) TestFetchStakingOperation_Success() {
 
 func (s *StakingOperationSuite) TestFetchStakingOperation_Error() {
 	var (
-		networkID          = "ethereum-holesky"
+		networkID          = EthereumHolesky
 		addressID          = "0x14a34"
 		stakingOperationID = "staking-operation-id"
 		stakingAPIMock     = mocks.NewStakeAPI(s.T())

diff --git a/pkg/coinbase/utils.go b/pkg/coinbase/utils.go
@@ -1,18 +1,27 @@
 package coinbase
 
-import "strings"
+import (
+	"strings"
+
+	"github.com/coinbase/coinbase-sdk-go/gen/client"
+)
 
 const (
 	Eth          = "eth"
 	Wei          = "wei"
 	Gwei         = "gwei"
 	GweiDecimals = 9
 	Sol          = "sol"
-	Lamport      = "lamport"
 
 	StakingOperationModePartial = "partial"
 	StakingOperationModeDefault = "default"
 	StakingOperationModeNative  = "native"
+
+	EthereumHolesky = string(client.NETWORKIDENTIFIER_ETHEREUM_HOLESKY)
+	EthereumMainnet = string(client.NETWORKIDENTIFIER_ETHEREUM_MAINNET)
+
+	SolanaDevnet  = string(client.NETWORKIDENTIFIER_SOLANA_DEVNET)
+	SolanaMainnet = string(client.NETWORKIDENTIFIER_SOLANA_MAINNET)
 )
 
 func normalizeNetwork(network string) string {