relayer

Documentation

Index

• func MetaTxnStatusFromString(s string) sequence.MetaTxnStatus
• func NewRelayer(relayerURL string, projectAccessKey string, options ...Options) proto.RelayerClient
• type FeeQuote
  • func (q *FeeQuote) Message() ([]byte, error)
  • func (q *FeeQuote) Sign(wallet *ethwallet.Wallet, validFor time.Duration) error
  • func (q *FeeQuote) Verify(wallet *ethwallet.Wallet) error
  • func (q *FeeQuote) VerifySignedBy(expectedAddresses ...common.Address) error
• type LocalRelayer
  • func NewLocalRelayer(sender *ethwallet.Wallet, receiptListener *ethreceipts.ReceiptsListener) (*LocalRelayer, error)
  • func (r *LocalRelayer) Client() proto.RelayerClient
  • func (r *LocalRelayer) FeeOptions(ctx context.Context, signedTxs *sequence.SignedTransactions) ([]*sequence.RelayerFeeOption, *sequence.RelayerFeeQuote, error)
  • func (r *LocalRelayer) GetNonce(ctx context.Context, walletConfig core.WalletConfig, ...) (*big.Int, error)
  • func (r *LocalRelayer) GetProvider() *ethrpc.Provider
  • func (r *LocalRelayer) IsDeployTransaction(signedTxs *sequence.SignedTransactions) bool
  • func (r *LocalRelayer) Relay(ctx context.Context, signedTxs *sequence.SignedTransactions, ...) (sequence.MetaTxnID, *types.Transaction, ethtxn.WaitReceipt, error)
  • func (r *LocalRelayer) Simulate(ctx context.Context, wallet common.Address, transactions sequence.Transactions) ([]*sequence.SimulateResult, error)
  • func (r *LocalRelayer) Wait(ctx context.Context, metaTxnID sequence.MetaTxnID, optTimeout ...time.Duration) (sequence.MetaTxnStatus, *types.Receipt, error)
• type Options
• type RpcRelayer
  • func NewRpcRelayer(relayerURL string, projectAccessKey string, rpcProvider *ethrpc.Provider, ...) (*RpcRelayer, error)
  • func (r *RpcRelayer) Client() proto.RelayerClient
  • func (r *RpcRelayer) FeeOptions(ctx context.Context, signedTxs *sequence.SignedTransactions) ([]*sequence.RelayerFeeOption, *sequence.RelayerFeeQuote, error)
  • func (r *RpcRelayer) GetNonce(ctx context.Context, walletConfig core.WalletConfig, ...) (*big.Int, error)
  • func (r *RpcRelayer) GetProvider() *ethrpc.Provider
  • func (r *RpcRelayer) IsDeployTransaction(signedTxs *sequence.SignedTransactions) bool
  • func (r *RpcRelayer) Relay(ctx context.Context, signedTxs *sequence.SignedTransactions, ...) (sequence.MetaTxnID, *types.Transaction, ethtxn.WaitReceipt, error)
  • func (r *RpcRelayer) Simulate(ctx context.Context, wallet common.Address, transactions sequence.Transactions) ([]*sequence.SimulateResult, error)
  • func (r *RpcRelayer) Wait(ctx context.Context, metaTxnID sequence.MetaTxnID, optTimeout ...time.Duration) (sequence.MetaTxnStatus, *types.Receipt, error)

Functions

func MetaTxnStatusFromString

func MetaTxnStatusFromString(s string) sequence.MetaTxnStatus

func NewRelayer

func NewRelayer(relayerURL string, projectAccessKey string, options ...Options) proto.RelayerClient

NewRelayer creates a new Sequence Relayer client instance. See https://docs.sequence.xyz for a list of relayer urls, and please see https://sequence.build to get a `projectAccessKey`. TODO: rename this to NewRelayerClient ?

Types

type FeeQuote

type FeeQuote struct {
	TransactionDigest common.Hash
	IsWhitelisted     bool
	GasSponsor        *uint64
	GasTank           *uint64
	GasUsage          *uint64
	GasPrice          *big.Int
	NativePrice       *big.Int
	TokenPrices       map[string]*big.Int
	ExpiresAt         *time.Time
	Signature         []byte
}

func (*FeeQuote) Message

func (q *FeeQuote) Message() ([]byte, error)

func (*FeeQuote) Sign

func (q *FeeQuote) Sign(wallet *ethwallet.Wallet, validFor time.Duration) error

func (*FeeQuote) Verify

func (q *FeeQuote) Verify(wallet *ethwallet.Wallet) error

func (*FeeQuote) VerifySignedBy

func (q *FeeQuote) VerifySignedBy(expectedAddresses ...common.Address) error

VerifySignedBy verifies the quote against one or more expected signer addresses

type LocalRelayer

type LocalRelayer struct {
	Sender *ethwallet.Wallet
	// contains filtered or unexported fields
}

LocalRelayer is a simple implementation of a relayer which will dispatch meta transactions locally. This should only be used for testing / debugging, and never seriously in a real app.

func NewLocalRelayer

func NewLocalRelayer(sender *ethwallet.Wallet, receiptListener *ethreceipts.ReceiptsListener) (*LocalRelayer, error)

func (*LocalRelayer) Client

func (r *LocalRelayer) Client() proto.RelayerClient

func (*LocalRelayer) FeeOptions

func (r *LocalRelayer) FeeOptions(ctx context.Context, signedTxs *sequence.SignedTransactions) ([]*sequence.RelayerFeeOption, *sequence.RelayerFeeQuote, error)

func (*LocalRelayer) GetNonce

func (r *LocalRelayer) GetNonce(ctx context.Context, walletConfig core.WalletConfig, walletContext sequence.WalletContext, space *big.Int, blockNum *big.Int) (*big.Int, error)

func (*LocalRelayer) GetProvider

func (r *LocalRelayer) GetProvider() *ethrpc.Provider

func (*LocalRelayer) IsDeployTransaction

func (r *LocalRelayer) IsDeployTransaction(signedTxs *sequence.SignedTransactions) bool

func (*LocalRelayer) Relay

func (r *LocalRelayer) Relay(ctx context.Context, signedTxs *sequence.SignedTransactions, quote ...*sequence.RelayerFeeQuote) (sequence.MetaTxnID, *types.Transaction, ethtxn.WaitReceipt, error)

func (*LocalRelayer) Simulate

func (r *LocalRelayer) Simulate(ctx context.Context, wallet common.Address, transactions sequence.Transactions) ([]*sequence.SimulateResult, error)

func (*LocalRelayer) Wait

func (r *LocalRelayer) Wait(ctx context.Context, metaTxnID sequence.MetaTxnID, optTimeout ...time.Duration) (sequence.MetaTxnStatus, *types.Receipt, error)

type Options

type Options struct {
	HTTPClient   proto.HTTPClient
	JWTAuthToken string
}

type RpcRelayer

type RpcRelayer struct {
	proto.Relayer
	// contains filtered or unexported fields
}

func NewRpcRelayer

func NewRpcRelayer(relayerURL string, projectAccessKey string, rpcProvider *ethrpc.Provider, receiptListener *ethreceipts.ReceiptsListener, options ...Options) (*RpcRelayer, error)

NewRpcRelayer creates a new Sequence Relayer client instance. See https://docs.sequence.xyz for a list of relayer urls, and please see https://sequence.build to get a `projectAccessKey`. TODOXXX: move receiptListener to Options, as it is optional

func (*RpcRelayer) Client

func (r *RpcRelayer) Client() proto.RelayerClient

func (*RpcRelayer) FeeOptions

func (r *RpcRelayer) FeeOptions(ctx context.Context, signedTxs *sequence.SignedTransactions) ([]*sequence.RelayerFeeOption, *sequence.RelayerFeeQuote, error)

func (*RpcRelayer) GetNonce

func (r *RpcRelayer) GetNonce(ctx context.Context, walletConfig core.WalletConfig, walletContext sequence.WalletContext, space *big.Int, blockNum *big.Int) (*big.Int, error)

NOTE: nonce space is 160 bits wide

func (*RpcRelayer) GetProvider

func (r *RpcRelayer) GetProvider() *ethrpc.Provider

func (*RpcRelayer) IsDeployTransaction

func (r *RpcRelayer) IsDeployTransaction(signedTxs *sequence.SignedTransactions) bool

func (*RpcRelayer) Relay

func (r *RpcRelayer) Relay(ctx context.Context, signedTxs *sequence.SignedTransactions, quote ...*sequence.RelayerFeeQuote) (sequence.MetaTxnID, *types.Transaction, ethtxn.WaitReceipt, error)

Relay will submit the Sequence signed meta transaction to the relayer. The method will block until the relayer responds with the native transaction hash (*types.Transaction), which means the relayer has submitted the transaction request to the network. Clients can use WaitReceipt to wait until the metaTxnID has been mined.

func (*RpcRelayer) Simulate

func (r *RpcRelayer) Simulate(ctx context.Context, wallet common.Address, transactions sequence.Transactions) ([]*sequence.SimulateResult, error)

func (*RpcRelayer) Wait

func (r *RpcRelayer) Wait(ctx context.Context, metaTxnID sequence.MetaTxnID, optTimeout ...time.Duration) (sequence.MetaTxnStatus, *types.Receipt, error)

....