Merge pull request #18 from icon-project/feature/ci-hooks

ci: add GitHub Actions workflow

Author: CyrusVorwald

.github/workflows/go.yml

@@ -0,0 +1,95 @@
+name: Go
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Go
+      uses: actions/setup-go@v3
+      with:
+        go-version: '1.23'
+
+    - name: golangci-lint
+      uses: golangci/golangci-lint-action@v3
+      with:
+        version: latest
+
+  build:
+    runs-on: ubuntu-latest
+    needs: lint
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Go
+      uses: actions/setup-go@v3
+      with:
+        go-version: '1.23'
+
+    - name: Cache Go modules
+      uses: actions/cache@v3
+      with:
+        path: ~/go/pkg/mod
+        key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+        restore-keys: |
+          ${{ runner.os }}-go-
+
+    - name: Build
+      run: go build -v ./...
+
+  unit-tests:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Go
+      uses: actions/setup-go@v3
+      with:
+        go-version: '1.23'
+
+    - name: Cache Go modules
+      uses: actions/cache@v3
+      with:
+        path: ~/go/pkg/mod
+        key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+        restore-keys: |
+          ${{ runner.os }}-go-
+
+    - name: Run Unit Tests with Coverage
+      run: go test -v -coverprofile=coverage.txt ./pkg/...
+
+    - name: Upload results to Codecov
+      uses: codecov/codecov-action@v4
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+
+  integration-tests:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Go
+      uses: actions/setup-go@v3
+      with:
+        go-version: '1.23'
+
+    - name: Cache Go modules
+      uses: actions/cache@v3
+      with:
+        path: ~/go/pkg/mod
+        key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+        restore-keys: |
+          ${{ runner.os }}-go-
+
+    - name: Run Integration Tests
+      run: go test -v ./test/integration/...

README.md

@@ -1,3 +1,5 @@
+[![codecov](https://codecov.io/gh/icon-project/stacks-go-sdk/graph/badge.svg?token=CvLaGibygJ)](https://codecov.io/gh/icon-project/stacks-go-sdk)
+
 # Unofficial Stacks Blockchain SDK for Go
 
 Send tokens and call Clarity smart contracts on the Stacks blockchain with Golang.

go.mod

@@ -1,6 +1,6 @@
 module github.com/icon-project/stacks-go-sdk
 
-go 1.22.5
+go 1.23
 
 require (
 	github.com/btcsuite/btcd/btcec/v2 v2.3.4

pkg/crypto/signature.go

@@ -8,6 +8,7 @@ import (
 	"errors"
 	"fmt"
 
+	// nolint:staticcheck // SA1019: RIPEMD-160 is required for compatibility
 	"golang.org/x/crypto/ripemd160"
 
 	"github.com/btcsuite/btcd/btcec/v2"

pkg/stacks/network.go

@@ -43,6 +43,10 @@ func (n *StacksNetwork) GetTransactionFeeEstimateAPIURL() string {
 	return fmt.Sprintf("%s/v2/fees/transaction", n.coreAPIURL)
 }
 
+func (n *StacksNetwork) GetNonceAPIURL(address string) string {
+	return fmt.Sprintf("%s/extended/v1/address/%s/nonces", n.coreAPIURL, address)
+}
+
 func (n *StacksNetwork) FetchFn(url string) (*http.Response, error) {
 	return http.Get(url)
 }

pkg/transaction/builder.go

@@ -27,6 +27,13 @@ func (e *CustomError) Error() string {
 	return e.Message
 }
 
+type NonceInfo struct {
+	LastExecutedTxNonce   *int64  `json:"last_executed_tx_nonce"`
+	LastMempoolTxNonce    *int64  `json:"last_mempool_tx_nonce"`
+	PossibleNextNonce     int64   `json:"possible_next_nonce"`
+	DetectedMissingNonces []int64 `json:"detected_missing_nonces"`
+}
+
 func makeRequest(url string, method string, payload interface{}) ([]byte, error) {
 	client := resty.New()
 	var resp *resty.Response
@@ -55,23 +62,25 @@ func makeRequest(url string, method string, payload interface{}) ([]byte, error)
 	return resp.Body(), nil
 }
 
-func getNonce(address string, network stacks.StacksNetwork) (*big.Int, error) {
-	url := network.GetAccountAPIURL(address)
+func getNextNonce(address string, network stacks.StacksNetwork) (*big.Int, error) {
+	url := network.GetNonceAPIURL(address)
+
 	body, err := makeRequest(url, "GET", nil)
 	if err != nil {
-		return nil, &CustomError{Message: "Error fetching nonce", Err: err}
+		return nil, &CustomError{Message: "Error fetching nonce info", Err: err}
 	}
 
-	var result struct {
-		Nonce uint64 `json:"nonce"`
+	var nonceInfo NonceInfo
+	err = json.Unmarshal(body, &nonceInfo)
+	if err != nil {
+		return nil, &CustomError{Message: "Error parsing nonce info", Err: err}
 	}
 
-	err = json.Unmarshal(body, &result)
-	if err != nil {
-		return nil, &CustomError{Message: "Error parsing JSON response", Err: err}
+	if len(nonceInfo.DetectedMissingNonces) > 0 {
+		fmt.Printf("Warning: Detected missing nonces: %v\n", nonceInfo.DetectedMissingNonces)
 	}
 
-	return big.NewInt(int64(result.Nonce)), nil
+	return big.NewInt(nonceInfo.PossibleNextNonce), nil
 }
 
 func estimateTransactionFee(tx StacksTransaction, network stacks.StacksNetwork) (*big.Int, error) {
@@ -154,7 +163,7 @@ func createAndSignTransaction(tx StacksTransaction, network stacks.StacksNetwork
 	}
 
 	if nonce == nil {
-		nonce, err = getNonce(senderAddress, network)
+		nonce, err = getNextNonce(senderAddress, network)
 		if err != nil {
 			return &CustomError{Message: "Failed to fetch nonce", Err: err}
 		}
@@ -254,7 +263,6 @@ func BroadcastTransaction(tx StacksTransaction, network *stacks.StacksNetwork) (
 		SetHeader("Content-Type", "application/octet-stream").
 		SetBody(serializedTx).
 		Post(url)
-
 	if err != nil {
 		return "", &CustomError{Message: "Failed to send transaction", Err: err}
 	}

pkg/transaction/builder_test.go

@@ -15,12 +15,11 @@ func TestMakeSTXTokenTransfer(t *testing.T) {
 	amount := big.NewInt(1000000) // 1 STX
 	memo := "Test transfer"
 	network := stacks.NewStacksTestnet()
-	senderAddress := "ST2CY5V39NHDPWSXMW9QDT3HC3GD6Q6XX4CFRK9AG"
+	senderAddress := "ST15C893XJFJ6FSKM020P9JQDB5T7X6MQTXMBPAVH"
 	senderKeyHex := "c1d5bb638aa70862621667f9997711fce692cad782694103f8d9561f62e9f19701"
 	senderKey, _ := hex.DecodeString(senderKeyHex)
 
 	tx, err := MakeSTXTokenTransfer(recipient, *amount, memo, *network, senderAddress, senderKey, nil, nil)
-
 	if err != nil {
 		t.Fatalf("makeSTXTokenTransfer failed: %v", err)
 	}
@@ -63,7 +62,6 @@ func TestMakeSTXTokenTransfer(t *testing.T) {
 	specifiedFee := big.NewInt(180)
 	specifiedNonce := big.NewInt(3)
 	tx2, err := MakeSTXTokenTransfer(recipient, *amount, memo, *network, senderAddress, senderKey, specifiedFee, specifiedNonce)
-
 	if err != nil {
 		t.Fatalf("makeSTXTokenTransfer with specified fee and nonce failed: %v", err)
 	}

pkg/transaction/transaction.go

@@ -96,7 +96,8 @@ func NewContractCallTransaction(
 	nonce uint64,
 	fee uint64,
 	anchorMode stacks.AnchorMode,
-	postConditionMode stacks.PostConditionMode) (*ContractCallTransaction, error) {
+	postConditionMode stacks.PostConditionMode,
+) (*ContractCallTransaction, error) {
 	payload, err := NewContractCallPayload(contractAddress, contractName, functionName, functionArgs)
 	if err != nil {
 		return nil, err
@@ -200,11 +201,10 @@ func (t *TokenTransferTransaction) Deserialize(data []byte) error {
 	}
 	offset++
 
-	payloadLen, err := t.Payload.Deserialize(data[offset:])
+	_, err = t.Payload.Deserialize(data[offset:])
 	if err != nil {
 		return fmt.Errorf("failed to deserialize token transfer payload: %w", err)
 	}
-	offset += payloadLen
 
 	return nil
 }
@@ -286,11 +286,10 @@ func (t *ContractCallTransaction) Deserialize(data []byte) error {
 	}
 	offset++
 
-	payloadLen, err := t.Payload.Deserialize(data[offset:])
+	_, err = t.Payload.Deserialize(data[offset:])
 	if err != nil {
 		return fmt.Errorf("failed to deserialize contract call payload: %w", err)
 	}
-	offset += payloadLen
 
 	return nil
 }
@@ -345,19 +344,17 @@ func DeserializeTransaction(data []byte) (StacksTransaction, error) {
 	switch payloadType {
 	case stacks.PayloadTypeTokenTransfer:
 		tokenTx := &TokenTransferTransaction{BaseTransaction: baseTx}
-		payloadLen, err := tokenTx.Payload.Deserialize(data[offset:])
+		_, err := tokenTx.Payload.Deserialize(data[offset:])
 		if err != nil {
 			return nil, fmt.Errorf("failed to deserialize token transfer payload: %w", err)
 		}
-		offset += payloadLen
 		tx = tokenTx
 	case stacks.PayloadTypeContractCall:
 		contractTx := &ContractCallTransaction{BaseTransaction: baseTx}
-		payloadLen, err := contractTx.Payload.Deserialize(data[offset:])
+		_, err := contractTx.Payload.Deserialize(data[offset:])
 		if err != nil {
 			return nil, fmt.Errorf("failed to deserialize contract call payload: %w", err)
 		}
-		offset += payloadLen
 		tx = contractTx
 	default:
 		return nil, fmt.Errorf("unsupported payload type: %d", payloadType)

pkg/transaction/transaction_test.go

@@ -287,7 +287,8 @@ func assertTokenTransferTransactionFields(t *testing.T, tx *TokenTransferTransac
 	fee               uint64
 	anchorMode        stacks.AnchorMode
 	postConditionMode stacks.PostConditionMode
-}) {
+},
+) {
 	assert.Equal(t, expected.version, tx.Version)
 	assert.Equal(t, expected.chainID, tx.ChainID)
 	assert.Equal(t, expected.signer, tx.Auth.OriginAuth.Signer)

test/integration/transaction_test.go

@@ -19,7 +19,7 @@ func TestBroadcastSTXTokenTransferTransaction(t *testing.T) {
 		t.Fatalf("Failed to derive private key: %v", err)
 	}
 
-	senderAddress := "ST2CY5V39NHDPWSXMW9QDT3HC3GD6Q6XX4CFRK9AG"
+	senderAddress := "ST15C893XJFJ6FSKM020P9JQDB5T7X6MQTXMBPAVH"
 	senderPublicKey := crypto.GetPublicKeyFromPrivate(privateKey)
 	var signerArray [20]byte
 	copy(signerArray[:], crypto.Hash160(senderPublicKey))
@@ -53,7 +53,7 @@ func TestBroadcastContractCallTransaction(t *testing.T) {
 		t.Fatalf("Failed to derive private key: %v", err)
 	}
 
-	senderAddress := "ST2CY5V39NHDPWSXMW9QDT3HC3GD6Q6XX4CFRK9AG"
+	senderAddress := "ST15C893XJFJ6FSKM020P9JQDB5T7X6MQTXMBPAVH"
 	senderPublicKey := crypto.GetPublicKeyFromPrivate(privateKey)
 	var signerArray [20]byte
 	copy(signerArray[:], crypto.Hash160(senderPublicKey))