createAccessList

Callable

• createAccessList<ReturnFormat>(web3Context: Web3Context<EthExecutionAPI, any>, transaction: TransactionForAccessList, blockNumber?: BlockNumberOrTag, returnFormat: ReturnFormat): Promise<{ accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; gasUsed?: NumberTypes[ReturnFormat[number]] }>

---

• This function generates access list for a transaction.

  ---

  Type parameters

  • ReturnFormat: DataFormat

  Parameters

  • web3Context: Web3Context<EthExecutionAPI, any>

    (Web3Context) Web3 configuration object that contains things such as the provider, request manager, wallet, etc.

  • transaction: TransactionForAccessList

    A transaction object where all properties are optional except from, however it’s also recommended to include the to property.

  • blockNumber: BlockNumberOrTag = web3Context.defaultBlock

    (BlockNumberOrTag defaults to Web3Eth.defaultBlock) - Specifies what block to use as the current state of the blockchain while sending this request.

  • returnFormat: ReturnFormat

    (DataFormat defaults to DEFAULT_RETURN_FORMAT) - Specifies how the return data should be formatted.

  Returns Promise<{ accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[]; gasUsed?: NumberTypes[ReturnFormat[number]] }>

  The returned data of the createAccessList, e.g. The generated access list for transaction.