sequencerInboxActions
Type Aliases
SequencerInboxActions<TSequencerInbox, TChain>
type SequencerInboxActions<TSequencerInbox, TChain>: object;
Type parameters
| Type parameter | Value |
|---|---|
TSequencerInbox extends Address | undefined | - |
TChain extends Chain | undefined | Chain | undefined |
Type declaration
| Member | Type |
|---|---|
sequencerInboxPrepareTransactionRequest | <TFunctionName>(args: SequencerInboxPrepareTransactionRequestArgs<TSequencerInbox, TFunctionName>) => Promise<PrepareTransactionRequestReturnType<TChain> & object> |
sequencerInboxReadContract | <TFunctionName>(args: SequencerInboxReadContractArgs<TSequencerInbox, TFunctionName>) => Promise<SequencerInboxReadContractReturnType<TFunctionName>> |
Source
src/decorators/sequencerInboxActions.ts:31
Functions
sequencerInboxActions()
function sequencerInboxActions<TParams, TTransport, TChain>(sequencerInbox: TParams): (client: object) => SequencerInboxActions<TParams["sequencerInbox"], TChain>
Set of actions that can be performed on the sequencerInbox contract through wagmi public client
Type parameters
| Type parameter | Value |
|---|---|
TParams extends object | - |
TTransport extends Transport<string, Record<string, any>, EIP1193RequestFn<undefined>> | Transport<string, Record<string, any>, EIP1193RequestFn<undefined>> |
TChain extends undefined | Chain<undefined | ChainFormatters> | undefined | Chain<undefined | ChainFormatters> |
Parameters
| Parameter | Type | Description |
|---|---|---|
sequencerInbox | TParams | Address of the sequencerInbox core contract User can still overrides sequencerInbox address, by passing it as an argument to sequencerInboxReadContract/sequencerInboxPrepareTransactionRequest calls |
Returns
Function
sequencerInboxActionsWithSequencerInbox - Function passed to client.extends() to extend the public client
Parameters
| Parameter | Type |
|---|---|
client | object |
Returns
SequencerInboxActions<TParams["sequencerInbox"], TChain>
Example
const client = createPublicClient({
chain: arbitrumOne,
transport: http(),
}).extend(sequencerInboxActions(coreContracts.sequencerInbox));
// SequencerInbox is set to `coreContracts.sequencerInbox` for every call
client.sequencerInboxReadContract({
functionName: 'inboxAccs',
});
// Overriding sequencerInbox address for this call only
client.sequencerInboxReadContract({
functionName: 'inboxAccs',
sequencerInbox: contractAddress.anotherSequencerInbox
});