L1WalletClient

Optimism wallet client used for L2 interactions. Currently only supports OP and not other chains of the superchain. This implementation is not as robust as the Wallet implementation.

Signature

pub fn L1WalletClient(client_type: Clients) type

WithdrawalErrors

Set of possible errors when starting a withdrawal transaction.

EncodeErrors || PubClient.ClientType.BasicRequestErrors ||
            SerializeErrors || Signer.SigningErrors || error{ ExpectedOpStackContracts, UnableToFetchFeeInfoFromBlock, InvalidBlockNumber }

Init

Starts the wallet client. Init options depend on the client type. This has all the expected L2 actions. If you are looking for L1 actions consider using L1WalletClient

If the contracts are null it defaults to OP contracts. Caller must deinit after use.

Signature

pub fn init(priv_key: ?Hash, opts: PubClient.InitOpts) (PubClient.InitErrors || error{IdentityElement})!*L1Wallet

Deinit

Frees and destroys any allocated memory

Signature

pub fn deinit(self: *L1Wallet) void

EstimateInitiateWithdrawal

Estimates the gas cost for calling initiateWithdrawal

Signature

pub fn estimateInitiateWithdrawal(self: *L1Wallet, data: Hex) (PubClient.ClientType.BasicRequestErrors || error{ExpectedOpStackContracts})!RPCResponse(Gwei)

InitiateWithdrawal

Invokes the contract method to initiateWithdrawal. This will send a transaction to the network.

Signature

pub fn initiateWithdrawal(self: *L1Wallet, request: WithdrawalRequest) WithdrawalErrors!RPCResponse(Hash)

PrepareInitiateWithdrawal

Prepares the interaction with the contract method to initiateWithdrawal.

Signature

pub fn prepareInitiateWithdrawal(
    self: *L1Wallet,
    request: WithdrawalRequest,
) PubClient.ClientType.BasicRequestErrors!PreparedWithdrawal

SendTransaction

Sends a transaction envelope to the network. This serializes, hashes and signed before sending the transaction.

Signature

pub fn sendTransaction(
    self: *L1Wallet,
    envelope: LondonTransactionEnvelope,
) (Signer.SigningErrors || PubClient.ClientType.BasicRequestErrors || SerializeErrors)!RPCResponse(Hash)