create_access_list table function

Example

Needs RPC · RPC required

WITH requests AS (

WITH erc20_abi AS (

SELECT '[{"type":"function","name":"balanceOf","inputs":[{"name":"account","type":"address"}],"outputs":[{"name":"balance","type":"uint256"}]}]'::JSON AS abi

)

SELECT

$client AS client,

'0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48'::ADDRESS AS to_address,

encode_function_data(

abi,

'balanceOf',

'0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045'::ADDRESS

) AS data,

25433824::BIGINT AS block_number,

'usdc-balance'::VARCHAR AS source_id,

'0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045'::ADDRESS AS from_address,

0::UINT256 AS value,

NULL::UBIGINT AS gas,

NULL::BYTES32 AS block_hash,

'{"on_error":"row"}'::JSON AS options

FROM erc20_abi

access_rows AS (

SELECT source_id, source_kind, state_kind, address, slot, rpc_status

FROM create_access_list((SELECT * FROM requests))

)

SELECT source_id, source_kind, state_kind, address, slot, rpc_status

FROM access_rows

WHERE rpc_status = 'ok' AND state_kind IN ('code', 'storage')

ORDER BY state_kind, address, slot;

Enable JavaScript to run this sample in the notebook. The SQL preview above is still available for reference.

API reference

Exact signatures with descriptions, requirements, inputs, returns, and examples.

create_access_list(CLIENT, ADDRESS, BYTES, BIGINT) # RPC required

Builds one access list from the required transaction fields at an exact block height.

Inputs

Name	Type	Use
`client`	CLIENT Attached live CLIENT for the chain and block used for the access-list request.	required positional
`to_address`	ADDRESS Contract or account that receives the simulated transaction.	required positional
`data`	BYTES Transaction input bytes, usually produced by encode_function_data.	required positional
`block_number`	BIGINT Exact block height used to discover accessed accounts and storage slots.	required positional

Input relation columns

Name	Type	Default
`client`	CLIENT Attached live client for eth_createAccessList. Required
`to_address`	ADDRESS Transaction target address. Required
`data`	BYTES Transaction call data. Required
`block_number`	BIGINT Block number for deterministic access-list discovery. Required
`source_id`	VARCHAR Stable caller-provided identifier for emitted rows. Optional

Showing fewer

One eth_createAccessList request per row. Optional columns may be omitted only from the trailing end.

Result columns

Name	Type
`source_kind`	VARCHAR Output row class: access_list_code, access_list_storage, or rpc_error.
`source_id`	VARCHAR Stable caller-provided source id, or a generated row id when omitted.
`state_kind`	VARCHAR State kind emitted for prefetch planning.
`address`	ADDRESS Account or contract address from the access list.
`slot`	BYTES32 Storage slot for storage-key rows, or zero for code/account rows.

Showing fewer

Access-list state rows plus RPC status. Returns one row per discovered account or storage key. With on_error set to row, failed requests emit an rpc_error row instead of failing the query.

Guidance

Choose error and canonicality behavior

The options JSON accepts on_error, require_canonical, retry_by_block_number_on_blockhash_error, and rpc_batch_size.

on_error="throw" fails the query; on_error="row" emits an rpc_error row.
require_canonical defaults to true when block_hash is supplied.
retry_by_block_number_on_blockhash_error defaults to true and retries with the corresponding block number.
rpc_batch_size limits requests grouped into one provider batch.

Local SQL

SELECT '{"on_error":"row","require_canonical":true,"retry_by_block_number_on_blockhash_error":true,"rpc_batch_size":100}'::JSON AS options;

Enable JavaScript to run this sample in the notebook. The SQL preview above is still available for reference.

Additional overloads

create_access_list(CLIENT, ADDRESS, BYTES, BIGINT, JSON) # RPC required

Builds one access list and applies the supplied error, canonicality, fallback, and batching options.

Inputs

Name	Type	Use
`client`	CLIENT Attached live CLIENT for the chain and block used for the access-list request.	required positional
`to_address`	ADDRESS Contract or account that receives the simulated transaction.	required positional
`data`	BYTES Transaction input bytes, usually produced by encode_function_data.	required positional
`block_number`	BIGINT Exact block height used to discover accessed accounts and storage slots.	required positional
`options`	JSON Caller-provided identifier copied to every result row for this request.	required positional

Input relation columns

Name	Type	Default
`client`	CLIENT Attached live client for eth_createAccessList. Required
`to_address`	ADDRESS Transaction target address. Required
`data`	BYTES Transaction call data. Required
`block_number`	BIGINT Block number for deterministic access-list discovery. Required
`source_id`	VARCHAR Stable caller-provided identifier for emitted rows. Optional

Showing fewer

One eth_createAccessList request per row. Optional columns may be omitted only from the trailing end.

Result columns

Name	Type
`source_kind`	VARCHAR Output row class: access_list_code, access_list_storage, or rpc_error.
`source_id`	VARCHAR Stable caller-provided source id, or a generated row id when omitted.
`state_kind`	VARCHAR State kind emitted for prefetch planning.
`address`	ADDRESS Account or contract address from the access list.
`slot`	BYTES32 Storage slot for storage-key rows, or zero for code/account rows.

Showing fewer

Access-list state rows plus RPC status. Returns one row per discovered account or storage key. With on_error set to row, failed requests emit an rpc_error row instead of failing the query.

create_access_list(CLIENT, ADDRESS, BYTES, BIGINT, VARCHAR, ADDRESS, UINT256, UBIGINT, BYTES32, JSON) # RPC required

Accepts a relation with full transaction context and returns correlated access-list rows for every request.

Inputs

Name	Type	Use
`client`	CLIENT Attached live CLIENT for the chain and block used for the access-list request.	requiredpositional
`to_address`	ADDRESS Contract or account that receives the simulated transaction.	requiredpositional
`data`	BYTES Transaction input bytes, usually produced by encode_function_data.	requiredpositional
`block_number`	BIGINT Exact block height used to discover accessed accounts and storage slots.	requiredpositional
`source_id`	VARCHAR Caller-provided identifier copied to every result row for this request.	requiredpositional

Showing fewer

Input relation columns

Name	Type	Default
`client`	CLIENT Attached live client for eth_createAccessList. Required
`to_address`	ADDRESS Transaction target address. Required
`data`	BYTES Transaction call data. Required
`block_number`	BIGINT Block number for deterministic access-list discovery. Required
`source_id`	VARCHAR Stable caller-provided identifier for emitted rows. Optional

Showing fewer

One eth_createAccessList request per row. Optional columns may be omitted only from the trailing end.

Result columns

Name	Type
`source_kind`	VARCHAR Output row class: access_list_code, access_list_storage, or rpc_error.
`source_id`	VARCHAR Stable caller-provided source id, or a generated row id when omitted.
`state_kind`	VARCHAR State kind emitted for prefetch planning.
`address`	ADDRESS Account or contract address from the access list.
`slot`	BYTES32 Storage slot for storage-key rows, or zero for code/account rows.

Showing fewer

Access-list state rows plus RPC status. Returns one row per discovered account or storage key. With on_error set to row, failed requests emit an rpc_error row instead of failing the query.

Category and tags

Category: Chain reads
Tag: EVM
Tag: RPC
Tag: Access List
Tag: Prefetch