aptos

func (AccountInfo) AuthenticationKey ¶

func (ai AccountInfo) AuthenticationKey() ([]byte, error)

AuthenticationKey Hex decode of AuthenticationKeyHex

func (AccountInfo) SequenceNumber ¶

func (ai AccountInfo) SequenceNumber() (uint64, error)

SequenceNumber ParseUint of SequenceNumberStr

func (*AccountResourceRecord) MarshalBCS ¶

func (aar *AccountResourceRecord) MarshalBCS(ser *bcs.Serializer)

func (*AccountResourceRecord) UnmarshalBCS ¶

func (aar *AccountResourceRecord) UnmarshalBCS(des *bcs.Deserializer)

func (*AddressTag) GetType ¶ added in v0.2.0

func (xt *AddressTag) GetType() TypeTagVariant

func (*AddressTag) MarshalBCS ¶ added in v0.2.0

func (xt *AddressTag) MarshalBCS(_ *bcs.Serializer)

region AddressTag bcs.Struct

func (*AddressTag) String ¶ added in v0.2.0

func (xt *AddressTag) String() string

region AddressTag TypeTagImpl

func (*AddressTag) UnmarshalBCS ¶ added in v0.2.0

func (xt *AddressTag) UnmarshalBCS(_ *bcs.Deserializer)

func (*BoolTag) GetType ¶

func (xt *BoolTag) GetType() TypeTagVariant

func (*BoolTag) MarshalBCS ¶

func (xt *BoolTag) MarshalBCS(_ *bcs.Serializer)

region BoolTag bcs.struct

func (*BoolTag) String ¶

func (xt *BoolTag) String() string

region BoolTag TypeTagImpl

func (*BoolTag) UnmarshalBCS ¶

func (xt *BoolTag) UnmarshalBCS(_ *bcs.Deserializer)

func (*Client) Account ¶

func (client *Client) Account(address AccountAddress, ledgerVersion ...uint64) (AccountInfo, error)

Account Retrieves information about the account such as SequenceNumber and crypto.AuthenticationKey

func (*Client) AccountAPTBalance ¶ added in v0.2.0

func (client *Client) AccountAPTBalance(address AccountAddress, ledgerVersion ...uint64) (uint64, error)

AccountAPTBalance retrieves the APT balance in the account

func (*Client) AccountModule ¶ added in v1.6.0

func (client *Client) AccountModule(address AccountAddress, moduleName string, ledgerVersion ...uint64) (*api.MoveBytecode, error)

func (*Client) AccountResource ¶

func (client *Client) AccountResource(address AccountAddress, resourceType string, ledgerVersion ...uint64) (map[string]any, error)

AccountResource Retrieves a single resource given its struct name.

address := AccountOne
dataMap, _ := client.AccountResource(address, "0x1::coin::CoinStore")

Can also fetch at a specific ledger version

address := AccountOne
dataMap, _ := client.AccountResource(address, "0x1::coin::CoinStore", 1)

func (*Client) AccountResources ¶

func (client *Client) AccountResources(address AccountAddress, ledgerVersion ...uint64) ([]AccountResourceInfo, error)

AccountResources fetches resources for an account into a JSON-like map[string]any in AccountResourceInfo.Data For fetching raw Move structs as BCS, See #AccountResourcesBCS

address := AccountOne
dataMap, _ := client.AccountResources(address)

Can also fetch at a specific ledger version

address := AccountOne
dataMap, _ := client.AccountResource(address, 1)

func (*Client) AccountResourcesBCS ¶

func (client *Client) AccountResourcesBCS(address AccountAddress, ledgerVersion ...uint64) ([]AccountResourceRecord, error)

AccountResourcesBCS fetches account resources as raw Move struct BCS blobs in AccountResourceRecord.Data []byte

func (*Client) AccountTransactions ¶ added in v1.0.0

func (client *Client) AccountTransactions(address AccountAddress, start *uint64, limit *uint64) ([]*api.CommittedTransaction, error)

AccountTransactions Get transactions associated with an account. Start is a version number. Nil for most recent transactions. Limit is a number of transactions to return. 'about a hundred' by default.

client.AccountTransactions(AccountOne, 0, 2)   // Returns 2 transactions for 0x1
client.AccountTransactions(AccountOne, 1, 100) // Returns 100 transactions for 0x1

func (*Client) BatchSubmitTransaction ¶ added in v0.6.0

func (client *Client) BatchSubmitTransaction(signedTxns []*SignedTransaction) (*api.BatchSubmitTransactionResponse, error)

BatchSubmitTransaction submits a collection of signed transactions to the network in a single request

It will return the responses in the same order as the input transactions that failed. If the response is empty, then all transactions succeeded.

sender := NewEd25519Account()
txnPayload := TransactionPayload{
	Payload: &EntryFunction{
		Module: ModuleId{
			Address: AccountOne,
			Name: "aptos_account",
		},
		Function: "transfer",
		ArgTypes: []TypeTag{},
		Args: [][]byte{
			dest[:],
			amountBytes,
		},
	}
}
rawTxn, _ := client.BuildTransaction(sender.AccountAddress(), txnPayload)
signedTxn, _ := sender.SignTransaction(rawTxn)
submitResponse, err := client.BatchSubmitTransaction([]*SignedTransaction{signedTxn})

func (*Client) BlockByHeight ¶ added in v0.2.0

func (client *Client) BlockByHeight(blockHeight uint64, withTransactions bool) (*api.Block, error)

BlockByHeight fetches a block by height

block, _ := client.BlockByHeight(1, false)

Can also fetch with transactions

block, _ := client.BlockByHeight(1, true)

func (*Client) BlockByVersion ¶ added in v0.2.0

func (client *Client) BlockByVersion(ledgerVersion uint64, withTransactions bool) (*api.Block, error)

BlockByVersion fetches a block by ledger version

block, _ := client.BlockByVersion(123, false)

Can also fetch with transactions

block, _ := client.BlockByVersion(123, true)

func (*Client) BuildSignAndSubmitTransaction ¶

func (client *Client) BuildSignAndSubmitTransaction(sender TransactionSigner, payload TransactionPayload, options ...any) (*api.SubmitTransactionResponse, error)

BuildSignAndSubmitTransaction Convenience function to do all three in one for more configuration, please use them separately

sender := NewEd25519Account()
txnPayload := TransactionPayload{
	Payload: &EntryFunction{
		Module: ModuleId{
			Address: AccountOne,
			Name: "aptos_account",
		},
		Function: "transfer",
		ArgTypes: []TypeTag{},
		Args: [][]byte{
			dest[:],
			amountBytes,
		},
	}
}
submitResponse, err := client.BuildSignAndSubmitTransaction(sender, txnPayload)

func (*Client) BuildSignAndSubmitTransactions ¶ added in v0.6.0

func (client *Client) BuildSignAndSubmitTransactions(
	sender TransactionSigner,
	payloads chan TransactionBuildPayload,
	responses chan TransactionSubmissionResponse,
	buildOptions ...any,
)

BuildSignAndSubmitTransactions starts up a goroutine to process transactions for a single [TransactionSender] Closes output chan `responses` on completion of input chan `payloads`.

func (*Client) BuildSignAndSubmitTransactionsWithSignFunction ¶ added in v0.6.0

func (client *Client) BuildSignAndSubmitTransactionsWithSignFunction(
	sender AccountAddress,
	payloads chan TransactionBuildPayload,
	responses chan TransactionSubmissionResponse,
	sign func(rawTxn RawTransactionImpl) (*SignedTransaction, error),
	buildOptions ...any,
)

BuildSignAndSubmitTransactionsWithSignFunction allows for signing with a custom function

Closes output chan `responses` on completion of input chan `payloads`.

This enables the ability to do fee payer, and other approaches while staying concurrent

func Example() {
	client := NewNodeClient()

	sender := NewEd25519Account()
	feePayer := NewEd25519Account()

	payloads := make(chan TransactionBuildPayload)
	responses := make(chan TransactionSubmissionResponse)

	signingFunc := func(rawTxn RawTransactionImpl) (*SignedTransaction, error) {
		switch rawTxn.(type) {
		case *RawTransaction:
			return nil, fmt.Errorf("only fee payer supported")
		case *RawTransactionWithData:
			rawTxnWithData := rawTxn.(*RawTransactionWithData)
			switch rawTxnWithData.Variant {
			case MultiAgentRawTransactionWithDataVariant:
				return nil, fmt.Errorf("multi agent not supported, please provide a fee payer function")
			case MultiAgentWithFeePayerRawTransactionWithDataVariant:
				rawTxnWithData.Sign(sender)
				txn, ok := rawTxnWithData.ToFeePayerTransaction()
			default:
				return nil, fmt.Errorf("unsupported rawTransactionWithData type")
			}
		default:
			return nil, fmt.Errorf("unsupported rawTransactionImpl type")
		}
	}

	// startup worker
	go client.BuildSignAndSubmitTransactionsWithSignFunction(
		sender,
		payloads,
		responses,
		signingFunc
	)

	// Here add payloads, and wiating on resposnes

}

func (*Client) BuildTransaction ¶

func (client *Client) BuildTransaction(sender AccountAddress, payload TransactionPayload, options ...any) (*RawTransaction, error)

BuildTransaction Builds a raw transaction from the payload and fetches any necessary information from on-chain

sender := NewEd25519Account()
txnPayload := TransactionPayload{
	Payload: &EntryFunction{
		Module: ModuleId{
			Address: AccountOne,
			Name: "aptos_account",
		},
		Function: "transfer",
		ArgTypes: []TypeTag{},
		Args: [][]byte{
			dest[:],
			amountBytes,
		},
	}
}
rawTxn, err := client.BuildTransaction(sender.AccountAddress(), txnPayload)

func (*Client) BuildTransactionMultiAgent ¶ added in v0.5.0

func (client *Client) BuildTransactionMultiAgent(sender AccountAddress, payload TransactionPayload, options ...any) (*RawTransactionWithData, error)

BuildTransactionMultiAgent Builds a raw transaction for MultiAgent or FeePayer from the payload and fetches any necessary information from on-chain

sender := NewEd25519Account()
txnPayload := TransactionPayload{
	Payload: &EntryFunction{
		Module: ModuleId{
			Address: AccountOne,
			Name: "aptos_account",
		},
		Function: "transfer",
		ArgTypes: []TypeTag{},
		Args: [][]byte{
			dest[:],
			amountBytes,
		},
	}
}
rawTxn, err := client.BuildTransactionMultiAgent(sender.AccountAddress(), txnPayload, FeePayer(AccountZero))

func (*Client) BuildTransactions ¶ added in v0.6.0

func (client *Client) BuildTransactions(sender AccountAddress, payloads chan TransactionBuildPayload, responses chan TransactionBuildResponse, setSequenceNumber chan uint64, options ...any)

BuildTransactions start a goroutine to process TransactionPayload and spit out RawTransactionImpl.

func (*Client) EntryFunctionWithArgs ¶ added in v1.6.0

func (client *Client) EntryFunctionWithArgs(address AccountAddress, moduleName string, functionName string, typeArgs []any, args []any, options ...any) (*EntryFunction, error)

func (*Client) EstimateGasPrice ¶ added in v0.2.0

func (client *Client) EstimateGasPrice() (EstimateGasInfo, error)

EstimateGasPrice Retrieves the gas estimate from the network.

func (*Client) EventsByCreationNumber ¶ added in v1.8.0

func (client *Client) EventsByCreationNumber(account AccountAddress, creationNumber string, start *uint64, limit *uint64) ([]*api.Event, error)

EventsByCreationNumber Get events by creation number for an account. Start is a sequence number. Nil for most recent events. Limit is a number of events to return, 100 by default.

client.EventsByCreationNumber(AccountOne, "123", nil, 2)   // Returns 2 events
client.EventsByCreationNumber(AccountOne, "123", 1, 100) // Returns 100 events

func (*Client) EventsByHandle ¶ added in v1.6.0

func (client *Client) EventsByHandle(account AccountAddress, eventHandle string, fieldName string, start *uint64, limit *uint64) ([]*api.Event, error)

EventsByHandle Get events by handle and field name for an account. Start is a sequence number. Nil for most recent events. Limit is a number of events to return, 100 by default.

client.EventsByHandle(AccountOne, "0x2", "transfer", 0, 2)   // Returns 2 events
client.EventsByHandle(AccountOne, "0x2", "transfer", 1, 100) // Returns 100 events

func (*Client) FetchNextMultisigAddress ¶ added in v0.2.0

func (client *Client) FetchNextMultisigAddress(address AccountAddress) (*AccountAddress, error)

FetchNextMultisigAddress retrieves the next multisig address to be created from the given account

func (*Client) Fund ¶

func (client *Client) Fund(address AccountAddress, amount uint64) error

Fund Uses the faucet to fund an address, only applies to non-production networks

func (*Client) GetChainId ¶

func (client *Client) GetChainId() (uint8, error)

GetChainId Retrieves the ChainId of the network Note this will be cached forever, or taken directly from the config

func (*Client) GetCoinBalances ¶ added in v0.2.0

func (client *Client) GetCoinBalances(address AccountAddress) ([]CoinBalance, error)

GetCoinBalances gets the balances of all coins associated with a given address

func (*Client) GetProcessorStatus ¶ added in v0.2.0

func (client *Client) GetProcessorStatus(processorName string) (uint64, error)

GetProcessorStatus returns the ledger version up to which the processor has processed

func (*Client) Info ¶

func (client *Client) Info() (NodeInfo, error)

Info Retrieves the node info about the network and it's current state

func (*Client) NodeAPIHealthCheck ¶ added in v0.5.0

func (client *Client) NodeAPIHealthCheck(durationSecs ...uint64) (api.HealthCheckResponse, error)

NodeAPIHealthCheck checks if the node is within durationSecs of the current time, if not provided the node default is used

func (*Client) PollForTransaction ¶ added in v1.6.0

func (client *Client) PollForTransaction(hash string, options ...any) (*api.UserTransaction, error)

PollForTransaction Waits up to 10 seconds for as single transaction to be done, polling at 10Hz

func (*Client) PollForTransactions ¶

func (client *Client) PollForTransactions(txnHashes []string, options ...any) error

PollForTransactions Waits up to 10 seconds for transactions to be done, polling at 10Hz Accepts options PollPeriod and PollTimeout which should wrap time.Duration values.

hashes := []string{"0x1234", "0x4567"}
err := client.PollForTransactions(hashes)

Can additionally configure different options

hashes := []string{"0x1234", "0x4567"}
err := client.PollForTransactions(hashes, PollPeriod(500 * time.Milliseconds), PollTimeout(5 * time.Seconds))

func (*Client) QueryIndexer ¶ added in v0.2.0

func (client *Client) QueryIndexer(query any, variables map[string]any, options ...graphql.Option) error

QueryIndexer queries the indexer using GraphQL to fill the `query` struct with data. See examples in the indexer client on how to make queries

var out []CoinBalance
var q struct {
	Current_coin_balances []struct {
		CoinType     string `graphql:"coin_type"`
		Amount       uint64
		OwnerAddress string `graphql:"owner_address"`
	} `graphql:"current_coin_balances(where: {owner_address: {_eq: $address}})"`
}
variables := map[string]any{
	"address": address.StringLong(),
}
err := client.QueryIndexer(&q, variables)
if err != nil {
	return nil, err
}

for _, coin := range q.Current_coin_balances {
	out = append(out, CoinBalance{
		CoinType: coin.CoinType,
		Amount:   coin.Amount,
})
}

return out, nil

func (*Client) RemoveHeader ¶ added in v0.6.0

func (client *Client) RemoveHeader(key string)

RemoveHeader removes the header from being automatically set all future requests.

client.RemoveHeader("Authorization")

func (*Client) SetHeader ¶ added in v0.6.0

func (client *Client) SetHeader(key string, value string)

SetHeader sets the header for all future requests

client.SetHeader("Authorization", "Bearer abcde")

func (*Client) SetTimeout ¶

func (client *Client) SetTimeout(timeout time.Duration)

SetTimeout adjusts the HTTP client timeout

client.SetTimeout(5 * time.Millisecond)

func (*Client) SimulateTransaction ¶ added in v0.4.0

func (client *Client) SimulateTransaction(rawTxn *RawTransaction, sender TransactionSigner, options ...any) ([]*api.UserTransaction, error)

SimulateTransaction Simulates a raw transaction without sending it to the blockchain

sender := NewEd25519Account()
txnPayload := TransactionPayload{
	Payload: &EntryFunction{
		Module: ModuleId{
			Address: AccountOne,
			Name: "aptos_account",
		},
		Function: "transfer",
		ArgTypes: []TypeTag{},
		Args: [][]byte{
			dest[:],
			amountBytes,
		},
	}
}
rawTxn, _ := client.BuildTransaction(sender.AccountAddress(), txnPayload)
simResponse, err := client.SimulateTransaction(rawTxn, sender)

func (*Client) SimulateTransactionMultiAgent ¶ added in v1.6.0

func (client *Client) SimulateTransactionMultiAgent(rawTxn *RawTransactionWithData, sender TransactionSigner, options ...any) ([]*api.UserTransaction, error)

SimulateTransactionMultiAgent simulates a transaction as fee payer or multi agent

func (*Client) SubmitTransaction ¶

func (client *Client) SubmitTransaction(signedTransaction *SignedTransaction) (*api.SubmitTransactionResponse, error)

SubmitTransaction Submits an already signed transaction to the blockchain

sender := NewEd25519Account()
txnPayload := TransactionPayload{
	Payload: &EntryFunction{
		Module: ModuleId{
			Address: AccountOne,
			Name: "aptos_account",
		},
		Function: "transfer",
		ArgTypes: []TypeTag{},
		Args: [][]byte{
			dest[:],
			amountBytes,
		},
	}
}
rawTxn, _ := client.BuildTransaction(sender.AccountAddress(), txnPayload)
signedTxn, _ := sender.SignTransaction(rawTxn)
submitResponse, err := client.SubmitTransaction(signedTxn)

func (*Client) SubmitTransactions ¶ added in v0.6.0

func (client *Client) SubmitTransactions(requests chan TransactionSubmissionRequest, responses chan TransactionSubmissionResponse)

SubmitTransactions consumes signed transactions, submits to aptos-node, yields responses. closes output chan `responses` when input chan `signedTxns` is closed.

func (*Client) TransactionByHash ¶

func (client *Client) TransactionByHash(txnHash string) (*api.Transaction, error)

TransactionByHash gets info on a transaction The transaction may be pending or recently committed.

data, err := client.TransactionByHash("0xabcd")
if err != nil {
	if httpErr, ok := err.(aptos.HttpError) {
		if httpErr.StatusCode == 404 {
			// if we're sure this has been submitted, assume it is still pending elsewhere in the mempool
		}
	}
} else {
	if data["type"] == "pending_transaction" {
		// known to local mempool, but not committed yet
	}
}

func (*Client) TransactionByVersion ¶

func (client *Client) TransactionByVersion(version uint64) (*api.CommittedTransaction, error)

TransactionByVersion gets info on a transaction from its LedgerVersion. It must have been committed to have a ledger version

data, err := client.TransactionByVersion("0xabcd")
if err != nil {
	if httpErr, ok := err.(aptos.HttpError) {
		if httpErr.StatusCode == 404 {
			// if we're sure this has been submitted, the full node might not be caught up to this version yet
		}
	}
}

func (*Client) Transactions ¶

func (client *Client) Transactions(start *uint64, limit *uint64) ([]*api.CommittedTransaction, error)

Transactions Get recent transactions. Start is a version number. Nil for most recent transactions. Limit is a number of transactions to return. 'about a hundred' by default.

client.Transactions(0, 2)   // Returns 2 transactions
client.Transactions(1, 100) // Returns 100 transactions

func (*Client) View ¶

func (client *Client) View(payload *ViewPayload, ledgerVersion ...uint64) ([]any, error)

View Runs a view function on chain returning a list of return values.

 address := AccountOne
	payload := &ViewPayload{
		Module: ModuleId{
			Address: AccountOne,
			Name:    "coin",
		},
		Function: "balance",
		ArgTypes: []TypeTag{AptosCoinTypeTag},
		Args:     [][]byte{address[:]},
	}
	vals, err := client.aptosClient.View(payload)
	balance := StrToU64(vals.(any[])[0].(string))

func (*Client) WaitForTransaction ¶

func (client *Client) WaitForTransaction(txnHash string, options ...any) (*api.UserTransaction, error)

WaitForTransaction Do a long-GET for one transaction and wait for it to complete

data, err := client.WaitForTransaction("0x1234")

func (*Client) WaitTransactionByHash ¶ added in v1.6.0

func (client *Client) WaitTransactionByHash(txnHash string) (*api.Transaction, error)

WaitTransactionByHash waits for a transaction to complete and returns it's data when finished.

func (*Ed25519TransactionAuthenticator) MarshalBCS ¶ added in v0.2.0

func (ea *Ed25519TransactionAuthenticator) MarshalBCS(ser *bcs.Serializer)

region Ed25519TransactionAuthenticator bcs.Struct

func (*Ed25519TransactionAuthenticator) UnmarshalBCS ¶ added in v0.2.0

func (ea *Ed25519TransactionAuthenticator) UnmarshalBCS(des *bcs.Deserializer)

func (*Ed25519TransactionAuthenticator) Verify ¶ added in v0.2.0

func (ea *Ed25519TransactionAuthenticator) Verify(msg []byte) bool

region Ed25519TransactionAuthenticator TransactionAuthenticatorImpl

func (*EntryFunction) ExecutableType ¶ added in v1.10.0

func (sf *EntryFunction) ExecutableType() TransactionExecutableVariant

func (*EntryFunction) MarshalBCS ¶

func (sf *EntryFunction) MarshalBCS(ser *bcs.Serializer)

region EntryFunction bcs.Struct

func (*EntryFunction) PayloadType ¶ added in v0.2.0

func (sf *EntryFunction) PayloadType() TransactionPayloadVariant

region EntryFunction TransactionPayloadImpl

func (*EntryFunction) UnmarshalBCS ¶

func (sf *EntryFunction) UnmarshalBCS(des *bcs.Deserializer)

func (*FaucetClient) Fund ¶

func (faucetClient *FaucetClient) Fund(address AccountAddress, amount uint64) error

Fund account with the given amount of AptosCoin

func (*FeePayerTransactionAuthenticator) MarshalBCS ¶ added in v0.2.0

func (ea *FeePayerTransactionAuthenticator) MarshalBCS(ser *bcs.Serializer)

region FeePayerTransactionAuthenticator bcs.Struct

func (*FeePayerTransactionAuthenticator) UnmarshalBCS ¶ added in v0.2.0

func (ea *FeePayerTransactionAuthenticator) UnmarshalBCS(des *bcs.Deserializer)

func (*FeePayerTransactionAuthenticator) Verify ¶ added in v0.2.0

func (ea *FeePayerTransactionAuthenticator) Verify(msg []byte) bool

region FeePayerTransactionAuthenticator bcs.Struct

func (*FungibleAssetClient) Balance ¶

func (client *FungibleAssetClient) Balance(storeAddress *AccountAddress, ledgerVersion ...uint64) (uint64, error)

Balance returns the balance of the store

func (*FungibleAssetClient) Decimals ¶

func (client *FungibleAssetClient) Decimals() (uint8, error)

Decimals returns the number of decimal places for the fungible asset

func (*FungibleAssetClient) IconUri ¶ added in v1.1.0

func (client *FungibleAssetClient) IconUri() (string, error)

IconUri returns the URI of the icon for the fungible asset

func (*FungibleAssetClient) IsFrozen ¶

func (client *FungibleAssetClient) IsFrozen(storeAddress *AccountAddress, ledgerVersion ...uint64) (bool, error)

IsFrozen returns true if the store is frozen

func (*FungibleAssetClient) IsUntransferable ¶ added in v1.1.0

func (client *FungibleAssetClient) IsUntransferable(storeAddress *AccountAddress, ledgerVersion ...uint64) (bool, error)

IsUntransferable returns true if the store can't be transferred

func (*FungibleAssetClient) Maximum ¶

func (client *FungibleAssetClient) Maximum(ledgerVersion ...uint64) (*big.Int, error)

Maximum returns the maximum possible supply of the fungible asset

func (*FungibleAssetClient) Name ¶

func (client *FungibleAssetClient) Name() (string, error)

Name returns the name of the fungible asset

func (*FungibleAssetClient) PrimaryBalance ¶

func (client *FungibleAssetClient) PrimaryBalance(owner *AccountAddress, ledgerVersion ...uint64) (uint64, error)

PrimaryBalance returns the balance of the primary store for the owner

func (*FungibleAssetClient) PrimaryIsFrozen ¶

func (client *FungibleAssetClient) PrimaryIsFrozen(owner *AccountAddress, ledgerVersion ...uint64) (bool, error)

PrimaryIsFrozen returns true if the primary store for the owner is frozen

func (*FungibleAssetClient) PrimaryStoreAddress ¶

func (client *FungibleAssetClient) PrimaryStoreAddress(owner *AccountAddress) (*AccountAddress, error)

PrimaryStoreAddress returns the AccountAddress of the primary store for the owner

Note that the primary store may not exist at the address. Use FungibleAssetClient.PrimaryStoreExists to check.

func (*FungibleAssetClient) PrimaryStoreExists ¶

func (client *FungibleAssetClient) PrimaryStoreExists(owner *AccountAddress) (bool, error)

PrimaryStoreExists returns true if the primary store for the owner exists

func (*FungibleAssetClient) ProjectUri ¶ added in v1.1.0

func (client *FungibleAssetClient) ProjectUri() (string, error)

ProjectUri returns the URI of the project for the fungible asset

func (*FungibleAssetClient) StoreExists ¶

func (client *FungibleAssetClient) StoreExists(storeAddress *AccountAddress, ledgerVersion ...uint64) (bool, error)

StoreExists returns true if the store exists

func (*FungibleAssetClient) StoreMetadata ¶

func (client *FungibleAssetClient) StoreMetadata(storeAddress *AccountAddress, ledgerVersion ...uint64) (*AccountAddress, error)

StoreMetadata returns the AccountAddress of the metadata for the store

func (*FungibleAssetClient) Supply ¶

func (client *FungibleAssetClient) Supply(ledgerVersion ...uint64) (*big.Int, error)

Supply returns the total supply of the fungible asset

func (*FungibleAssetClient) Symbol ¶

func (client *FungibleAssetClient) Symbol() (string, error)

Symbol returns the symbol of the fungible asset

func (*FungibleAssetClient) Transfer ¶

func (client *FungibleAssetClient) Transfer(sender TransactionSigner, senderStore AccountAddress, receiverStore AccountAddress, amount uint64, options ...any) (*SignedTransaction, error)

Transfer sends amount of the fungible asset from senderStore to receiverStore

func (*FungibleAssetClient) TransferPrimaryStore ¶

func (client *FungibleAssetClient) TransferPrimaryStore(sender TransactionSigner, receiverAddress AccountAddress, amount uint64, options ...any) (*SignedTransaction, error)

TransferPrimaryStore sends amount of the fungible asset from the primary store of the sender to receiverAddress

func (*GenericTag) GetType ¶ added in v1.6.0

func (xt *GenericTag) GetType() TypeTagVariant

func (*GenericTag) MarshalBCS ¶ added in v1.6.0

func (xt *GenericTag) MarshalBCS(_ *bcs.Serializer)

TODO: Do we need a proper serialization here

func (*GenericTag) String ¶ added in v1.6.0

func (xt *GenericTag) String() string

region GenericTag TypeTagImpl

func (*GenericTag) UnmarshalBCS ¶ added in v1.6.0

func (xt *GenericTag) UnmarshalBCS(_ *bcs.Deserializer)

func (*HttpError) Error ¶

func (he *HttpError) Error() string

Error returns a string representation of the HttpError

Implements:

• [Error]

func (*IndexerClient) GetCoinBalances ¶ added in v0.2.0

func (ic *IndexerClient) GetCoinBalances(address AccountAddress) ([]CoinBalance, error)

GetCoinBalances retrieve the coin balances for all coins owned by the address

func (*IndexerClient) GetProcessorStatus ¶ added in v0.2.0

func (ic *IndexerClient) GetProcessorStatus(processorName string) (uint64, error)

GetProcessorStatus tells the most updated version of the transaction processor. This helps to determine freshness of data.

func (*IndexerClient) QueryIndexer ¶ added in v1.6.0

func (ic *IndexerClient) QueryIndexer(query any, variables map[string]any, options ...graphql.Option) error

QueryIndexer is a generic function for making any GraphQL query against the indexer

func (*IndexerClient) WaitOnIndexer ¶ added in v0.2.0

func (ic *IndexerClient) WaitOnIndexer(processorName string, requestedVersion uint64) error

WaitOnIndexer waits for the indexer processorName specified to catch up to the requestedVersion

func (*ModuleBundle) MarshalBCS ¶

func (txn *ModuleBundle) MarshalBCS(ser *bcs.Serializer)

func (*ModuleBundle) PayloadType ¶ added in v0.2.0

func (txn *ModuleBundle) PayloadType() TransactionPayloadVariant

func (*ModuleBundle) UnmarshalBCS ¶

func (txn *ModuleBundle) UnmarshalBCS(des *bcs.Deserializer)

func (*ModuleId) MarshalBCS ¶

func (mod *ModuleId) MarshalBCS(ser *bcs.Serializer)

func (*ModuleId) UnmarshalBCS ¶

func (mod *ModuleId) UnmarshalBCS(des *bcs.Deserializer)

func (*MultiAgentRawTransactionWithData) MarshalBCS ¶ added in v0.2.0

func (txn *MultiAgentRawTransactionWithData) MarshalBCS(ser *bcs.Serializer)

region MultiAgentRawTransactionWithData bcs.Struct

func (*MultiAgentRawTransactionWithData) UnmarshalBCS ¶ added in v0.2.0

func (txn *MultiAgentRawTransactionWithData) UnmarshalBCS(des *bcs.Deserializer)

func (*MultiAgentTransactionAuthenticator) MarshalBCS ¶ added in v0.2.0

func (ea *MultiAgentTransactionAuthenticator) MarshalBCS(ser *bcs.Serializer)

region MultiAgentTransactionAuthenticator bcs.Struct

func (*MultiAgentTransactionAuthenticator) UnmarshalBCS ¶ added in v0.2.0

func (ea *MultiAgentTransactionAuthenticator) UnmarshalBCS(des *bcs.Deserializer)

func (*MultiAgentTransactionAuthenticator) Verify ¶ added in v0.2.0

func (ea *MultiAgentTransactionAuthenticator) Verify(msg []byte) bool

region MultiAgentTransactionAuthenticator TransactionAuthenticatorImpl

func (*MultiAgentWithFeePayerRawTransactionWithData) MarshalBCS ¶ added in v0.2.0

func (txn *MultiAgentWithFeePayerRawTransactionWithData) MarshalBCS(ser *bcs.Serializer)

region MultiAgentWithFeePayerRawTransactionWithData bcs.Struct

func (*MultiAgentWithFeePayerRawTransactionWithData) UnmarshalBCS ¶ added in v0.2.0

func (txn *MultiAgentWithFeePayerRawTransactionWithData) UnmarshalBCS(des *bcs.Deserializer)

func (*MultiEd25519TransactionAuthenticator) MarshalBCS ¶ added in v0.2.0

func (ea *MultiEd25519TransactionAuthenticator) MarshalBCS(ser *bcs.Serializer)

region MultiEd25519TransactionAuthenticator bcs.Struct

func (*MultiEd25519TransactionAuthenticator) UnmarshalBCS ¶ added in v0.2.0

func (ea *MultiEd25519TransactionAuthenticator) UnmarshalBCS(des *bcs.Deserializer)

func (*MultiEd25519TransactionAuthenticator) Verify ¶ added in v0.2.0

func (ea *MultiEd25519TransactionAuthenticator) Verify(msg []byte) bool

region Ed25519TransactionAuthenticator TransactionAuthenticatorImpl

func (*Multisig) MarshalBCS ¶ added in v0.2.0

func (sf *Multisig) MarshalBCS(ser *bcs.Serializer)

region Multisig bcs.Struct

func (*Multisig) PayloadType ¶ added in v0.2.0

func (sf *Multisig) PayloadType() TransactionPayloadVariant

region Multisig TransactionPayloadImpl

func (*Multisig) UnmarshalBCS ¶ added in v0.2.0

func (sf *Multisig) UnmarshalBCS(des *bcs.Deserializer)

func (*MultisigTransactionPayload) MarshalBCS ¶ added in v0.2.0

func (sf *MultisigTransactionPayload) MarshalBCS(ser *bcs.Serializer)

region MultisigTransactionPayload bcs.Struct

func (*MultisigTransactionPayload) UnmarshalBCS ¶ added in v0.2.0

func (sf *MultisigTransactionPayload) UnmarshalBCS(des *bcs.Deserializer)

func (*NodeClient) Account ¶

func (rc *NodeClient) Account(address AccountAddress, ledgerVersion ...uint64) (AccountInfo, error)

Account gets information about an account for a given address

Optionally, a ledgerVersion can be given to get the account state at a specific ledger version

func (*NodeClient) AccountAPTBalance ¶ added in v0.2.0

func (rc *NodeClient) AccountAPTBalance(account AccountAddress, ledgerVersion ...uint64) (uint64, error)

AccountAPTBalance fetches the balance of an account of APT. Response is in octas or 1/10^8 APT.

func (*NodeClient) AccountModule ¶ added in v1.6.0

func (rc *NodeClient) AccountModule(address AccountAddress, moduleName string, ledgerVersion ...uint64) (*api.MoveBytecode, error)

AccountModule fetches a single account module's bytecode and ABI from on-chain state.

func (*NodeClient) AccountResource ¶

func (rc *NodeClient) AccountResource(address AccountAddress, resourceType string, ledgerVersion ...uint64) (map[string]any, error)

AccountResource fetches a resource for an account into a JSON-like map[string]any. Optionally, a ledgerVersion can be given to get the account state at a specific ledger version

For fetching raw Move structs as BCS, See #AccountResourceBCS

func (*NodeClient) AccountResources ¶

func (rc *NodeClient) AccountResources(address AccountAddress, ledgerVersion ...uint64) ([]AccountResourceInfo, error)

AccountResources fetches resources for an account into a JSON-like map[string]any in AccountResourceInfo.Data Optionally, a ledgerVersion can be given to get the account state at a specific ledger version For fetching raw Move structs as BCS, See #AccountResourcesBCS

func (*NodeClient) AccountResourcesBCS ¶

func (rc *NodeClient) AccountResourcesBCS(address AccountAddress, ledgerVersion ...uint64) ([]AccountResourceRecord, error)

AccountResourcesBCS fetches account resources as raw Move struct BCS blobs in AccountResourceRecord.Data []byte Optionally, a ledgerVersion can be given to get the account state at a specific ledger version

func (*NodeClient) AccountTransactions ¶ added in v1.0.0

func (rc *NodeClient) AccountTransactions(account AccountAddress, start *uint64, limit *uint64) ([]*api.CommittedTransaction, error)

AccountTransactions Get recent transactions for an account

Arguments:

• start is a version number. Nil for most recent transactions.
• limit is a number of transactions to return. 'about a hundred' by default.

func (*NodeClient) BatchSubmitTransaction ¶ added in v0.6.0

func (rc *NodeClient) BatchSubmitTransaction(signedTxns []*SignedTransaction) (*api.BatchSubmitTransactionResponse, error)

BatchSubmitTransaction submits a collection of signed transactions to the network in a single request

It will return the responses in the same order as the input transactions that failed. If the response is empty, then all transactions succeeded.

func (*NodeClient) BatchSubmitTransactions ¶ added in v0.6.0

func (rc *NodeClient) BatchSubmitTransactions(requests chan TransactionSubmissionRequest, responses chan TransactionSubmissionResponse)

BatchSubmitTransactions consumes signed transactions, submits to aptos-node, yields responses. closes output chan `responses` when input chan `signedTxns` is closed.

func (*NodeClient) BlockByHeight ¶ added in v0.2.0

func (rc *NodeClient) BlockByHeight(blockHeight uint64, withTransactions bool) (*api.Block, error)

BlockByHeight gets a block by block height

The function will fetch all transactions in the block if withTransactions is true.

func (*NodeClient) BlockByVersion ¶ added in v0.2.0

func (rc *NodeClient) BlockByVersion(ledgerVersion uint64, withTransactions bool) (*api.Block, error)

BlockByVersion gets a block by a transaction's version number

Note that this is not the same as a block's height.

The function will fetch all transactions in the block if withTransactions is true.

func (*NodeClient) BuildSignAndSubmitTransaction ¶

func (rc *NodeClient) BuildSignAndSubmitTransaction(sender TransactionSigner, payload TransactionPayload, options ...any) (*api.SubmitTransactionResponse, error)

BuildSignAndSubmitTransaction builds, signs, and submits a transaction to the network

func (*NodeClient) BuildSignAndSubmitTransactions ¶ added in v0.4.0

func (rc *NodeClient) BuildSignAndSubmitTransactions(
	sender TransactionSigner,
	payloads chan TransactionBuildPayload,
	responses chan TransactionSubmissionResponse,
	buildOptions ...any,
)

BuildSignAndSubmitTransactions starts up a goroutine to process transactions for a single [TransactionSender] Closes output chan `responses` on completion of input chan `payloads`.

func (*NodeClient) BuildSignAndSubmitTransactionsWithSignFnAndWorkerPool ¶ added in v1.6.0

func (rc *NodeClient) BuildSignAndSubmitTransactionsWithSignFnAndWorkerPool(
	sender AccountAddress,
	payloads chan TransactionBuildPayload,
	responses chan TransactionSubmissionResponse,
	sign func(rawTxn RawTransactionImpl) (*SignedTransaction, error),
	workerPoolConfig WorkerPoolConfig,
	buildOptions ...any,
)

BuildSignAndSubmitTransactionsWithSignFnAndWorkerPool processes transactions using a fixed-size worker pool. It coordinates three stages of the pipeline: 1. Building transactions (BuildTransactions) 2. Signing transactions (worker pool) 3. Submitting transactions (SubmitTransactions)

func (*NodeClient) BuildSignAndSubmitTransactionsWithSignFunction ¶ added in v0.4.0

func (rc *NodeClient) BuildSignAndSubmitTransactionsWithSignFunction(
	sender AccountAddress,
	payloads chan TransactionBuildPayload,
	responses chan TransactionSubmissionResponse,
	sign func(rawTxn RawTransactionImpl) (*SignedTransaction, error),
	buildOptions ...any,
)

BuildSignAndSubmitTransactionsWithSignFunction allows for signing with a custom function

Closes output chan `responses` on completion of input chan `payloads`.

This enables the ability to do fee payer, and other approaches while staying concurrent

func Example() {
	client := NewNodeClient()

	sender := NewEd25519Account()
	feePayer := NewEd25519Account()

	payloads := make(chan TransactionBuildPayload)
	responses := make(chan TransactionSubmissionResponse)

	signingFunc := func(rawTxn RawTransactionImpl) (*SignedTransaction, error) {
		switch rawTxn.(type) {
		case *RawTransaction:
			return nil, fmt.Errorf("only fee payer supported")
		case *RawTransactionWithData:
			rawTxnWithData := rawTxn.(*RawTransactionWithData)
			switch rawTxnWithData.Variant {
			case MultiAgentRawTransactionWithDataVariant:
				return nil, fmt.Errorf("multi agent not supported, please provide a fee payer function")
			case MultiAgentWithFeePayerRawTransactionWithDataVariant:
				rawTxnWithData.Sign(sender)
				txn, ok := rawTxnWithData.ToFeePayerTransaction()
			default:
				return nil, fmt.Errorf("unsupported rawTransactionWithData type")
			}
		default:
			return nil, fmt.Errorf("unsupported rawTransactionImpl type")
		}
	}

	// startup worker
	go client.BuildSignAndSubmitTransactionsWithSignFunction(
		sender,
		payloads,
		responses,
		signingFunc
	)

	// Here add payloads, and wiating on resposnes

}

func (*NodeClient) BuildTransaction ¶

func (rc *NodeClient) BuildTransaction(sender AccountAddress, payload TransactionPayload, options ...any) (*RawTransaction, error)

BuildTransaction builds a raw transaction for signing for a single signer

For MultiAgent and FeePayer transactions use NodeClient.BuildTransactionMultiAgent

Accepts options:

• MaxGasAmount
• GasUnitPrice
• ExpirationSeconds
• SequenceNumber
• ChainIdOption

func (*NodeClient) BuildTransactionMultiAgent ¶ added in v0.2.0

func (rc *NodeClient) BuildTransactionMultiAgent(sender AccountAddress, payload TransactionPayload, options ...any) (*RawTransactionWithData, error)

BuildTransactionMultiAgent builds a raw transaction for signing with fee payer or multi-agent

For single signer transactions use NodeClient.BuildTransaction

Accepts options:

• MaxGasAmount
• GasUnitPrice
• ExpirationSeconds
• SequenceNumber
• ChainIdOption
• FeePayer
• AdditionalSigners

func (*NodeClient) BuildTransactions ¶ added in v0.4.0

func (rc *NodeClient) BuildTransactions(sender AccountAddress, payloads chan TransactionBuildPayload, responses chan TransactionBuildResponse, setSequenceNumber chan uint64, options ...any)

BuildTransactions start a goroutine to process TransactionPayload and spit out RawTransactionImpl.

func (*NodeClient) EntryFunctionWithArgs ¶ added in v1.6.0

func (rc *NodeClient) EntryFunctionWithArgs(moduleAddress AccountAddress, moduleName string, functionName string, typeArgs []any, args []any, options ...any) (*EntryFunction, error)

EntryFunctionWithArgs generates an EntryFunction from on-chain Module ABI, and converts simple inputs to BCS encoded ones.

func (*NodeClient) EstimateGasPrice ¶ added in v0.2.0

func (rc *NodeClient) EstimateGasPrice() (EstimateGasInfo, error)

EstimateGasPrice estimates the gas price given on-chain data TODO: add caching for some period of time

func (*NodeClient) EventsByCreationNumber ¶ added in v1.8.0

func (rc *NodeClient) EventsByCreationNumber(
	account AccountAddress,
	creationNumber string,
	start *uint64,
	limit *uint64,
) ([]*api.Event, error)

EventsByCreationNumber retrieves events by creation number for a given account.

Arguments:

• account - The account address to get events for
• creationNumber - The creation number of the event
• start - The starting sequence number. nil for most recent events
• limit - The number of events to return, 100 by default

func (*NodeClient) EventsByHandle ¶ added in v1.6.0

func (rc *NodeClient) EventsByHandle(
	account AccountAddress,
	eventHandle string,
	fieldName string,
	start *uint64,
	limit *uint64,
) ([]*api.Event, error)

EventsByHandle retrieves events by event handle and field name for a given account.

Arguments:

• account - The account address to get events for
• eventHandle - The event handle struct tag
• fieldName - The field in the event handle struct
• start - The starting sequence number. nil for most recent events
• limit - The number of events to return, 100 by default

func (*NodeClient) GetBCS ¶

func (rc *NodeClient) GetBCS(getUrl string) ([]byte, error)

GetBCS makes a GET request to the endpoint and parses the response into the given type with BCS

func (*NodeClient) GetChainId ¶

func (rc *NodeClient) GetChainId() (uint8, error)

GetChainId gets the chain ID of the network

func (*NodeClient) Info ¶

func (rc *NodeClient) Info() (NodeInfo, error)

Info gets general information about the blockchain

func (*NodeClient) NodeAPIHealthCheck ¶ added in v1.5.0

func (rc *NodeClient) NodeAPIHealthCheck(durationSecs ...uint64) (api.HealthCheckResponse, error)

NodeAPIHealthCheck performs a health check on the node

Returns a HealthCheckResponse if successful, returns error if not.

func (*NodeClient) PollForTransaction ¶ added in v0.2.0

func (rc *NodeClient) PollForTransaction(hash string, options ...any) (*api.UserTransaction, error)

PollForTransaction waits up to 10 seconds for a transaction to be done, polling at 10Hz Accepts options PollPeriod and PollTimeout which should wrap time.Duration values. Not just a degenerate case of PollForTransactions, it may return additional information for the single transaction polled.

func (*NodeClient) PollForTransactions ¶

func (rc *NodeClient) PollForTransactions(txnHashes []string, options ...any) error

PollForTransactions waits up to 10 seconds for transactions to be done, polling at 10Hz Accepts options PollPeriod and PollTimeout which should wrap time.Duration values.

func (*NodeClient) RemoveHeader ¶ added in v0.6.0

func (rc *NodeClient) RemoveHeader(key string)

RemoveHeader removes the header from being automatically set all future requests.

client.RemoveHeader("Authorization")

func (*NodeClient) SetHeader ¶ added in v0.6.0

func (rc *NodeClient) SetHeader(key string, value string)

SetHeader sets the header for all future requests

client.SetHeader("Authorization", "Bearer abcde")

func (*NodeClient) SetTimeout ¶ added in v0.6.0

func (rc *NodeClient) SetTimeout(timeout time.Duration)

SetTimeout adjusts the HTTP client timeout

client.SetTimeout(5 * time.Millisecond)

func (*NodeClient) SimulateTransaction ¶ added in v0.4.0

func (rc *NodeClient) SimulateTransaction(rawTxn *RawTransaction, sender TransactionSigner, options ...any) ([]*api.UserTransaction, error)

SimulateTransaction simulates a transaction

func (*NodeClient) SimulateTransactionMultiAgent ¶ added in v1.6.0

func (rc *NodeClient) SimulateTransactionMultiAgent(rawTxn *RawTransactionWithData, sender TransactionSigner, options ...any) ([]*api.UserTransaction, error)

SimulateTransactionMultiAgent simulates a transaction as fee payer or multi agent

func (*NodeClient) SubmitTransaction ¶

func (rc *NodeClient) SubmitTransaction(signedTxn *SignedTransaction) (*api.SubmitTransactionResponse, error)

SubmitTransaction submits a signed transaction to the network

func (*NodeClient) SubmitTransactions ¶ added in v0.4.0

func (rc *NodeClient) SubmitTransactions(requests chan TransactionSubmissionRequest, responses chan TransactionSubmissionResponse)

SubmitTransactions consumes signed transactions, submits to aptos-node, yields responses. closes output chan `responses` when input chan `signedTxns` is closed.

func (*NodeClient) TransactionByHash ¶

func (rc *NodeClient) TransactionByHash(txnHash string) (*api.Transaction, error)

TransactionByHash gets info on a transaction The transaction may be pending or recently committed. If the transaction is a api.PendingTransaction, then it is still in the mempool. If the transaction is any other type, it has been committed.

data, err := c.TransactionByHash("0xabcd")
if err != nil {
	if httpErr, ok := err.(aptos.HttpError) {
		if httpErr.StatusCode == 404 {
			// if we're sure this has been submitted, assume it is still pending elsewhere in the mempool
		}
	}
} else {
	if data["type"] == "pending_transaction" {
		// known to local mempool, but not committed yet
	}
}

func (*NodeClient) TransactionByVersion ¶

func (rc *NodeClient) TransactionByVersion(version uint64) (*api.CommittedTransaction, error)

TransactionByVersion gets info on a transaction by version number The transaction will have been committed. The response will not be of the type api.PendingTransaction.

func (*NodeClient) Transactions ¶

func (rc *NodeClient) Transactions(start *uint64, limit *uint64) ([]*api.CommittedTransaction, error)

Transactions Get recent transactions.

Arguments:

• start is a version number. Nil for most recent transactions.
• limit is a number of transactions to return. 'about a hundred' by default.

func (*NodeClient) View ¶

func (rc *NodeClient) View(payload *ViewPayload, ledgerVersion ...uint64) ([]any, error)

View calls a view function on the blockchain and returns the return value of the function

func (*NodeClient) WaitForTransaction ¶

func (rc *NodeClient) WaitForTransaction(txnHash string, options ...any) (*api.UserTransaction, error)

WaitForTransaction does a long-GET for one transaction and wait for it to complete. Initially poll at 10 Hz for up to 1 second if node replies with 404 (wait for txn to propagate).

Optional arguments:

• PollPeriod: time.Duration, how often to poll for the transaction. Default 100ms.
• PollTimeout: time.Duration, how long to wait for the transaction. Default 10s.

func (*NodeClient) WaitTransactionByHash ¶ added in v1.6.0

func (rc *NodeClient) WaitTransactionByHash(txnHash string) (*api.Transaction, error)

WaitTransactionByHash waits for a transaction to be confirmed by its hash. This function allows you to monitor the status of a transaction until it is finalized.

func (NodeInfo) BlockHeight ¶

func (info NodeInfo) BlockHeight() uint64

BlockHeight the newest block available on the full node (by the time you call this there's already a new one!)

func (NodeInfo) Epoch ¶

func (info NodeInfo) Epoch() uint64

Epoch the current epoch of the network. On Mainnet, this is usually every 2 hours.

func (NodeInfo) LedgerTimestamp ¶ added in v0.2.0

func (info NodeInfo) LedgerTimestamp() uint64

LedgerTimestamp is the timestamp the block was committed

func (NodeInfo) LedgerVersion ¶

func (info NodeInfo) LedgerVersion() uint64

LedgerVersion the newest transaction available on the full node

func (NodeInfo) OldestBlockHeight ¶

func (info NodeInfo) OldestBlockHeight() uint64

OldestBlockHeight the oldest block note pruned on the full node

func (NodeInfo) OldestLedgerVersion ¶

func (info NodeInfo) OldestLedgerVersion() uint64

OldestLedgerVersion the oldest ledger version not pruned on the full node

func (*RawTransaction) MarshalBCS ¶

func (txn *RawTransaction) MarshalBCS(ser *bcs.Serializer)

region RawTransaction bcs.Struct

func (*RawTransaction) Sign ¶

func (txn *RawTransaction) Sign(signer crypto.Signer) (*crypto.AccountAuthenticator, error)

region RawTransaction Signer

func (*RawTransaction) SignedTransaction ¶ added in v0.2.0

func (txn *RawTransaction) SignedTransaction(sender crypto.Signer) (*SignedTransaction, error)

func (*RawTransaction) SignedTransactionWithAuthenticator ¶ added in v0.2.0

func (txn *RawTransaction) SignedTransactionWithAuthenticator(auth *crypto.AccountAuthenticator) (*SignedTransaction, error)

SignedTransactionWithAuthenticator signs the sender only signed transaction

func (*RawTransaction) SigningMessage ¶ added in v0.2.0

func (txn *RawTransaction) SigningMessage() ([]byte, error)

SigningMessage generates the bytes needed to be signed by a signer

func (*RawTransaction) String ¶ added in v1.10.0

func (txn *RawTransaction) String() string

String returns a JSON formatted string representation of the RawTransaction

func (*RawTransaction) UnmarshalBCS ¶

func (txn *RawTransaction) UnmarshalBCS(des *bcs.Deserializer)

func (*RawTransactionWithData) MarshalBCS ¶ added in v0.2.0

func (txn *RawTransactionWithData) MarshalBCS(ser *bcs.Serializer)

region RawTransactionWithData bcs.Struct

func (*RawTransactionWithData) MarshalTypeScriptBCS ¶ added in v1.10.0

func (txn *RawTransactionWithData) MarshalTypeScriptBCS(ser *bcs.Serializer)

MarshalTypeScriptBCS converts to RawTransactionWithData to the TypeScript type MultiAgentTransaction

func (*RawTransactionWithData) SetFeePayer ¶ added in v0.5.0

func (txn *RawTransactionWithData) SetFeePayer(
	feePayer AccountAddress,
) bool

func (*RawTransactionWithData) Sign ¶ added in v0.2.0

func (txn *RawTransactionWithData) Sign(signer crypto.Signer) (*crypto.AccountAuthenticator, error)

region RawTransactionWithData Signer

func (*RawTransactionWithData) SigningMessage ¶ added in v0.2.0

func (txn *RawTransactionWithData) SigningMessage() ([]byte, error)

region RawTransactionWithData MessageSigner

func (*RawTransactionWithData) String ¶ added in v1.10.0

func (txn *RawTransactionWithData) String() string

String returns a JSON formatted string representation of the RawTransactionWithData

func (*RawTransactionWithData) ToFeePayerSignedTransaction ¶ added in v0.2.0

func (txn *RawTransactionWithData) ToFeePayerSignedTransaction(
	sender *crypto.AccountAuthenticator,
	feePayerAuthenticator *crypto.AccountAuthenticator,
	additionalSigners []crypto.AccountAuthenticator,
) (*SignedTransaction, bool)

func (*RawTransactionWithData) ToMultiAgentSignedTransaction ¶ added in v0.2.0

func (txn *RawTransactionWithData) ToMultiAgentSignedTransaction(
	sender *crypto.AccountAuthenticator,
	additionalSigners []crypto.AccountAuthenticator,
) (*SignedTransaction, bool)

func (*RawTransactionWithData) UnmarshalBCS ¶ added in v0.2.0

func (txn *RawTransactionWithData) UnmarshalBCS(des *bcs.Deserializer)

func (*RawTransactionWithData) UnmarshalTypeScriptBCS ¶ added in v1.10.0

func (txn *RawTransactionWithData) UnmarshalTypeScriptBCS(des *bcs.Deserializer)

UnmarshalTypeScriptBCS converts to RawTransactionWithData from the TypeScript type MultiAgentTransaction

func (*ReferenceTag) GetType ¶ added in v1.6.0

func (xt *ReferenceTag) GetType() TypeTagVariant

func (*ReferenceTag) MarshalBCS ¶ added in v1.6.0

func (xt *ReferenceTag) MarshalBCS(_ *bcs.Serializer)

TODO: Do we need a proper serialization here

func (*ReferenceTag) String ¶ added in v1.6.0

func (xt *ReferenceTag) String() string

region ReferenceTag TypeTagImpl

func (*ReferenceTag) UnmarshalBCS ¶ added in v1.6.0

func (xt *ReferenceTag) UnmarshalBCS(_ *bcs.Deserializer)

func (*Script) ExecutableType ¶ added in v1.10.0

func (s *Script) ExecutableType() TransactionExecutableVariant

func (*Script) MarshalBCS ¶

func (s *Script) MarshalBCS(ser *bcs.Serializer)

region Script bcs.Struct

func (*Script) PayloadType ¶ added in v0.2.0

func (s *Script) PayloadType() TransactionPayloadVariant

region Script TransactionPayloadImpl

func (*Script) UnmarshalBCS ¶

func (s *Script) UnmarshalBCS(des *bcs.Deserializer)

func (*ScriptArgument) MarshalBCS ¶

func (sa *ScriptArgument) MarshalBCS(ser *bcs.Serializer)

func (*ScriptArgument) UnmarshalBCS ¶

func (sa *ScriptArgument) UnmarshalBCS(des *bcs.Deserializer)

func (*SignedTransaction) Hash ¶ added in v0.2.0

func (txn *SignedTransaction) Hash() (string, error)

Hash takes the hash of the SignedTransaction

Note: At the moment, this assumes that the transaction is a UserTransaction

func (*SignedTransaction) MarshalBCS ¶

func (txn *SignedTransaction) MarshalBCS(ser *bcs.Serializer)

region SignedTransaction bcs.Struct

func (*SignedTransaction) UnmarshalBCS ¶

func (txn *SignedTransaction) UnmarshalBCS(des *bcs.Deserializer)

func (*SignedTransaction) Verify ¶

func (txn *SignedTransaction) Verify() error

Verify checks a signed transaction's signature

func (*SignerTag) GetType ¶ added in v0.2.0

func (xt *SignerTag) GetType() TypeTagVariant

func (*SignerTag) MarshalBCS ¶ added in v0.2.0

func (xt *SignerTag) MarshalBCS(_ *bcs.Serializer)

region SignerTag bcs.Struct

func (*SignerTag) String ¶ added in v0.2.0

func (xt *SignerTag) String() string

region SignerTag TypeTagImpl

func (*SignerTag) UnmarshalBCS ¶ added in v0.2.0

func (xt *SignerTag) UnmarshalBCS(_ *bcs.Deserializer)

func (*SingleSenderTransactionAuthenticator) MarshalBCS ¶ added in v0.2.0

func (ea *SingleSenderTransactionAuthenticator) MarshalBCS(ser *bcs.Serializer)

region SingleSenderTransactionAuthenticator bcs.Struct

func (*SingleSenderTransactionAuthenticator) UnmarshalBCS ¶ added in v0.2.0

func (ea *SingleSenderTransactionAuthenticator) UnmarshalBCS(des *bcs.Deserializer)

func (*SingleSenderTransactionAuthenticator) Verify ¶ added in v0.2.0

func (ea *SingleSenderTransactionAuthenticator) Verify(msg []byte) bool

region SingleSenderTransactionAuthenticator TransactionAuthenticatorImpl

func (*StructTag) GetType ¶

func (xt *StructTag) GetType() TypeTagVariant

region StructTag TypeTagImpl

func (*StructTag) MarshalBCS ¶

func (xt *StructTag) MarshalBCS(ser *bcs.Serializer)

region StructTag bcs.Struct

func (*StructTag) String ¶

func (xt *StructTag) String() string

String outputs to the form address::module::name<type1, type2> e.g. 0x1::string::String or 0x42::my_mod::MultiType<u8,0x1::string::String>

func (*StructTag) UnmarshalBCS ¶

func (xt *StructTag) UnmarshalBCS(des *bcs.Deserializer)

func (*TransactionAuthenticator) MarshalBCS ¶ added in v0.2.0

func (ea *TransactionAuthenticator) MarshalBCS(ser *bcs.Serializer)

region TransactionAuthenticator bcs.Struct

func (*TransactionAuthenticator) UnmarshalBCS ¶ added in v0.2.0

func (ea *TransactionAuthenticator) UnmarshalBCS(des *bcs.Deserializer)

func (*TransactionAuthenticator) Verify ¶ added in v0.2.0

func (ea *TransactionAuthenticator) Verify(msg []byte) bool

region TransactionAuthenticator TransactionAuthenticatorImpl

func (*TransactionExecutable) MarshalBCS ¶ added in v1.10.0

func (txn *TransactionExecutable) MarshalBCS(ser *bcs.Serializer)

func (*TransactionExecutable) UnmarshalBCS ¶ added in v1.10.0

func (txn *TransactionExecutable) UnmarshalBCS(des *bcs.Deserializer)

func (*TransactionExecutableEmpty) ExecutableType ¶ added in v1.10.0

func (txn *TransactionExecutableEmpty) ExecutableType() TransactionExecutableVariant

func (*TransactionExecutableEmpty) MarshalBCS ¶ added in v1.10.0

func (txn *TransactionExecutableEmpty) MarshalBCS(*bcs.Serializer)

func (*TransactionExecutableEmpty) UnmarshalBCS ¶ added in v1.10.0

func (txn *TransactionExecutableEmpty) UnmarshalBCS(*bcs.Deserializer)

func (*TransactionExtraConfig) MarshalBCS ¶ added in v1.10.0

func (txn *TransactionExtraConfig) MarshalBCS(ser *bcs.Serializer)

func (*TransactionExtraConfig) UnmarshalBCS ¶ added in v1.10.0

func (txn *TransactionExtraConfig) UnmarshalBCS(des *bcs.Deserializer)

func (*TransactionExtraConfigV1) ConfigType ¶ added in v1.10.0

func (txn *TransactionExtraConfigV1) ConfigType() TransactionExtraConfigVariant

func (*TransactionExtraConfigV1) MarshalBCS ¶ added in v1.10.0

func (txn *TransactionExtraConfigV1) MarshalBCS(ser *bcs.Serializer)

func (*TransactionExtraConfigV1) UnmarshalBCS ¶ added in v1.10.0

func (txn *TransactionExtraConfigV1) UnmarshalBCS(des *bcs.Deserializer)

func (*TransactionInnerPayload) MarshalBCS ¶ added in v1.10.0

func (txn *TransactionInnerPayload) MarshalBCS(ser *bcs.Serializer)

func (*TransactionInnerPayload) PayloadType ¶ added in v1.10.0

func (txn *TransactionInnerPayload) PayloadType() TransactionPayloadVariant

func (*TransactionInnerPayload) UnmarshalBCS ¶ added in v1.10.0

func (txn *TransactionInnerPayload) UnmarshalBCS(des *bcs.Deserializer)

func (*TransactionInnerPayloadV1) InnerPayloadType ¶ added in v1.10.0

func (txn *TransactionInnerPayloadV1) InnerPayloadType() TransactionInnerPayloadVariant

func (*TransactionInnerPayloadV1) MarshalBCS ¶ added in v1.10.0

func (txn *TransactionInnerPayloadV1) MarshalBCS(ser *bcs.Serializer)

func (*TransactionInnerPayloadV1) UnmarshalBCS ¶ added in v1.10.0

func (txn *TransactionInnerPayloadV1) UnmarshalBCS(des *bcs.Deserializer)

func (*TransactionPayload) MarshalBCS ¶

func (txn *TransactionPayload) MarshalBCS(ser *bcs.Serializer)

region TransactionPayload bcs.Struct

func (*TransactionPayload) UnmarshalBCS ¶

func (txn *TransactionPayload) UnmarshalBCS(des *bcs.Deserializer)

func (*TypeTag) MarshalBCS ¶

func (tt *TypeTag) MarshalBCS(ser *bcs.Serializer)

MarshalBCS serializes the TypeTag to bytes

Implements:

• bcs.Marshaler

func (*TypeTag) String ¶

func (tt *TypeTag) String() string

String gives the canonical TypeTag string value used in Move

func (*TypeTag) UnmarshalBCS ¶

func (tt *TypeTag) UnmarshalBCS(des *bcs.Deserializer)

UnmarshalBCS deserializes the TypeTag from bytes

Implements:

• bcs.Unmarshaler

func (*U128Tag) GetType ¶ added in v0.2.0

func (xt *U128Tag) GetType() TypeTagVariant

func (*U128Tag) MarshalBCS ¶ added in v0.2.0

func (xt *U128Tag) MarshalBCS(_ *bcs.Serializer)

region U128Tag bcs.Struct

func (*U128Tag) String ¶ added in v0.2.0

func (xt *U128Tag) String() string

region U128Tag TypeTagImpl

func (*U128Tag) UnmarshalBCS ¶ added in v0.2.0

func (xt *U128Tag) UnmarshalBCS(_ *bcs.Deserializer)

func (*U16Tag) GetType ¶

func (xt *U16Tag) GetType() TypeTagVariant

func (*U16Tag) MarshalBCS ¶

func (xt *U16Tag) MarshalBCS(_ *bcs.Serializer)

region U16Tag bcs.Struct

func (*U16Tag) String ¶

func (xt *U16Tag) String() string

region U16Tag TypeTagImpl

func (*U16Tag) UnmarshalBCS ¶

func (xt *U16Tag) UnmarshalBCS(_ *bcs.Deserializer)

func (*U256Tag) GetType ¶ added in v0.2.0

func (xt *U256Tag) GetType() TypeTagVariant

func (*U256Tag) MarshalBCS ¶ added in v0.2.0

func (xt *U256Tag) MarshalBCS(_ *bcs.Serializer)

region U256Tag bcs.Struct

func (*U256Tag) String ¶ added in v0.2.0

func (xt *U256Tag) String() string

region U256Tag TypeTagImpl

func (*U256Tag) UnmarshalBCS ¶ added in v0.2.0

func (xt *U256Tag) UnmarshalBCS(_ *bcs.Deserializer)

func (*U32Tag) GetType ¶

func (xt *U32Tag) GetType() TypeTagVariant

func (*U32Tag) MarshalBCS ¶

func (xt *U32Tag) MarshalBCS(_ *bcs.Serializer)

region U32Tag bcs.Struct

func (*U32Tag) String ¶

func (xt *U32Tag) String() string

region U32Tag TypeTagImpl

func (*U32Tag) UnmarshalBCS ¶

func (xt *U32Tag) UnmarshalBCS(_ *bcs.Deserializer)

func (*U64Tag) GetType ¶

func (xt *U64Tag) GetType() TypeTagVariant

func (*U64Tag) MarshalBCS ¶

func (xt *U64Tag) MarshalBCS(_ *bcs.Serializer)

region U64Tag bcs.Struct

func (*U64Tag) String ¶

func (xt *U64Tag) String() string

region U64Tag TypeTagImpl

func (*U64Tag) UnmarshalBCS ¶

func (xt *U64Tag) UnmarshalBCS(_ *bcs.Deserializer)

func (*U8Tag) GetType ¶

func (xt *U8Tag) GetType() TypeTagVariant

func (*U8Tag) MarshalBCS ¶

func (xt *U8Tag) MarshalBCS(_ *bcs.Serializer)

region U8Tag bcs.Struct

func (*U8Tag) String ¶

func (xt *U8Tag) String() string

region U8Tag TypeTagImpl

func (*U8Tag) UnmarshalBCS ¶

func (xt *U8Tag) UnmarshalBCS(_ *bcs.Deserializer)

func (*VectorTag) GetType ¶ added in v0.2.0

func (xt *VectorTag) GetType() TypeTagVariant

region VectorTag TypeTagImpl

func (*VectorTag) MarshalBCS ¶ added in v0.2.0

func (xt *VectorTag) MarshalBCS(ser *bcs.Serializer)

region TypeTagVector bcs.Struct

func (*VectorTag) String ¶ added in v0.2.0

func (xt *VectorTag) String() string

func (*VectorTag) UnmarshalBCS ¶ added in v0.2.0

func (xt *VectorTag) UnmarshalBCS(des *bcs.Deserializer)

func (*ViewPayload) MarshalBCS ¶

func (vp *ViewPayload) MarshalBCS(ser *bcs.Serializer)