Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement Wait For Transaction Receipt in accounts #389

Merged
merged 5 commits into from
Oct 5, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions account/account.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package account
import (
"context"
"errors"
"time"

"github.com/NethermindEth/juno/core/felt"
starknetgo "github.com/NethermindEth/starknet.go"
Expand Down Expand Up @@ -35,6 +36,7 @@ type AccountInterface interface {
SignDeployAccountTransaction(ctx context.Context, tx *rpc.DeployAccountTxn, precomputeAddress *felt.Felt) error
SignDeclareTransaction(ctx context.Context, tx *rpc.DeclareTxnV2) error
PrecomputeAddress(deployerAddress *felt.Felt, salt *felt.Felt, classHash *felt.Felt, constructorCalldata []*felt.Felt) (*felt.Felt, error)
WaitForTransactionReceipt(ctx context.Context, transactionHash *felt.Felt, pollInterval time.Duration) (*rpc.TransactionReceipt, error)
}

var _ AccountInterface = &Account{}
Expand Down Expand Up @@ -293,6 +295,27 @@ func (account *Account) PrecomputeAddress(deployerAddress *felt.Felt, salt *felt

}

// WaitForTransactionReceipt waits for the transaction to succeed or fail
func (account *Account) WaitForTransactionReceipt(ctx context.Context, transactionHash *felt.Felt, pollInterval time.Duration) (*rpc.TransactionReceipt, error) {
t := time.NewTicker(pollInterval)
for {
select {
case <-ctx.Done():
return nil, ctx.Err()
case <-t.C:
receipt, err := account.TransactionReceipt(ctx, transactionHash)
if err != nil {
if err.Error() == rpc.ErrHashNotFound.Error() {
continue
rianhughes marked this conversation as resolved.
Show resolved Hide resolved
} else {
return nil, err
}
}
return &receipt, nil
}
}
}

// BuildInvokeTx formats the calldata and signs the transaction
func (account *Account) BuildInvokeTx(ctx context.Context, invokeTx *rpc.InvokeTxnV1, fnCall *[]rpc.FunctionCall) error {
invokeTx.Calldata = FmtCalldata(*fnCall)
Expand Down
47 changes: 47 additions & 0 deletions account/account_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@ package account_test

import (
"context"
"errors"
"flag"
"fmt"
"math/big"
"os"
"testing"
"time"

"github.com/NethermindEth/juno/core/felt"
starknetgo "github.com/NethermindEth/starknet.go"
Expand Down Expand Up @@ -530,6 +532,51 @@ func TestTransactionHashDeclare(t *testing.T) {
require.Equal(t, expectedHash.String(), hash.String(), "TransactionHashDeclare not what expected")
}

func TestWaitForTransactionReceiptMOCK(t *testing.T) {
rianhughes marked this conversation as resolved.
Show resolved Hide resolved
mockCtrl := gomock.NewController(t)
t.Cleanup(mockCtrl.Finish)
mockRpcProvider := mocks.NewMockRpcProvider(mockCtrl)

mockRpcProvider.EXPECT().ChainID(context.Background()).Return("SN_GOERLI", nil)
acnt, err := account.NewAccount(mockRpcProvider, &felt.Zero, "", starknetgo.NewMemKeystore())
require.NoError(t, err, "error returned from account.NewAccount()")

type testSetType struct {
Hash *felt.Felt
ExpectedErr error
ExpectedReceipt rpc.TransactionReceipt
}
testSet := map[string][]testSetType{
"mock": {
{
Hash: new(felt.Felt).SetUint64(1),
ExpectedReceipt: nil,
ExpectedErr: errors.New("UnExpectedErr"),
},
{
Hash: new(felt.Felt).SetUint64(2),
ExpectedReceipt: rpc.InvokeTransactionReceipt{
TransactionHash: new(felt.Felt).SetUint64(2),
ExecutionStatus: rpc.TxnExecutionStatusSUCCEEDED,
},
ExpectedErr: nil,
},
},
}[testEnv]

for _, test := range testSet {
mockRpcProvider.EXPECT().TransactionReceipt(context.Background(), test.Hash).Return(test.ExpectedReceipt, test.ExpectedErr)
resp, err := acnt.WaitForTransactionReceipt(context.Background(), test.Hash, 2*time.Second)

if err != nil {
require.Equal(t, test.ExpectedErr, err)
} else {
require.Equal(t, test.ExpectedReceipt.GetExecutionStatus(), (*resp).GetExecutionStatus())
rianhughes marked this conversation as resolved.
Show resolved Hide resolved
}
}

}

func newDevnet(t *testing.T, url string) ([]test.TestAccount, error) {
devnet := test.NewDevNet(url)
acnts, err := devnet.Accounts()
Expand Down
22 changes: 0 additions & 22 deletions rpc/transaction.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ import (
"encoding/json"
"errors"
"fmt"
"time"

"github.com/NethermindEth/juno/core/felt"
)
Expand Down Expand Up @@ -107,24 +106,3 @@ func (provider *Provider) TransactionReceipt(ctx context.Context, transactionHas
}
return receipt.TransactionReceipt, nil
}

// WaitForTransaction waits for the transaction to succeed or fail
func (provider *Provider) WaitForTransaction(ctx context.Context, transactionHash *felt.Felt, pollInterval time.Duration) (TxnExecutionStatus, error) {
t := time.NewTicker(pollInterval)
for {
select {
case <-ctx.Done():
return "", ctx.Err()
case <-t.C:
_, err := provider.TransactionByHash(ctx, transactionHash)
if err != nil {
break
}
receipt, err := provider.TransactionReceipt(ctx, transactionHash)
if err != nil {
continue
}
return receipt.GetExecutionStatus(), nil
}
}
}
Loading