Skip to main content
Version: Next

Namespace: API

RPC.RPCSPEC010.API

Namespaces

Interfaces

Type Aliases

FELT

Ƭ FELT: string

A field element. represented by at most 63 hex digits

Pattern

^0x(0|[a-fA-F1-9]{1}[a-fA-F0-9]{0,62})$

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:7


ETH_ADDRESS

Ƭ ETH_ADDRESS: string

an ethereum address represented as 40 hex digits

Pattern

^0x[a-fA-F0-9]{40}$

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:12


STORAGE_KEY

Ƭ STORAGE_KEY: string

A storage key. Represented as up to 62 hex digits, 3 bits, and 5 leading zeroes.

Pattern

^0x(0|[0-7]{1}[a-fA-F0-9]{0,62}$)

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:17


ADDRESS

Ƭ ADDRESS: FELT

A contract address on Starknet

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:21


NUM_AS_HEX

Ƭ NUM_AS_HEX: string

string representing an unsigned integer number in prefixed hexadecimal format

Example

"0x.."

Pattern

^0x[a-fA-F0-9]+$

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:27


u64

Ƭ u64: string

64 bit unsigned integers, represented by hex string of length at most 16 "pattern": "^0x(0|[a-fA-F1-9]{1}[a-fA-F0-9]{0,15})$"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:32


u128

Ƭ u128: string

128 bit unsigned integers, represented by hex string of length at most 32 "pattern": "^0x(0|[a-fA-F1-9]{1}[a-fA-F0-9]{0,31})$"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:37


SIGNATURE

Ƭ SIGNATURE: FELT[]

A transaction signature

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:41


BLOCK_NUMBER

Ƭ BLOCK_NUMBER: number

The block number (height) in the blockchain

Minimum

0

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:46


BLOCK_HASH

Ƭ BLOCK_HASH: FELT

The hash of a block

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:50


TXN_HASH

Ƭ TXN_HASH: FELT

The hash of an Starknet transaction

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:54


L1_TXN_HASH

Ƭ L1_TXN_HASH: NUM_AS_HEX

The hash of an Ethereum transaction

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:58


CHAIN_ID

Ƭ CHAIN_ID: NUM_AS_HEX

The Starknet chain id, encoded in ASCII

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:62


STATE_MUTABILITY

Ƭ STATE_MUTABILITY: STATE_MUTABILITY_VIEW | STATE_MUTABILITY_EXTERNAL

The mutability of a function

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:66


FUNCTION_ABI_TYPE

Ƭ FUNCTION_ABI_TYPE: ABI_TYPE_FUNCTION | ABI_TYPE_L1_HANDLER | ABI_TYPE_CONSTRUCTOR

The type of an ABI function entry

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:70


ABI_NAME_AND_TYPE

Ƭ ABI_NAME_AND_TYPE: Object

common definition

Type declaration

NameType
namestring
typestring

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:74


ABI_TYPE

Ƭ ABI_TYPE: Object

common outputs

Type declaration

NameType
typestring

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:81


ENTRY_POINT_TYPE

Ƭ ENTRY_POINT_TYPE: Uppercase<STATE_MUTABILITY_EXTERNAL> | Uppercase<ABI_TYPE_L1_HANDLER> | Uppercase<ABI_TYPE_CONSTRUCTOR>

Represents the type of an entry point.

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:87


SIMULATION_FLAG

Ƭ SIMULATION_FLAG: typeof SKIP_VALIDATE | typeof SKIP_FEE_CHARGE

Flags that indicate how to simulate a given transaction. By default, the sequencer behavior is replicated locally (enough funds are expected to be in the account, and the fee will be deducted from the balance before the simulation of the next transaction). To skip the fee charge, use the SKIP_FEE_CHARGE flag.

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:91


DA_MODE

Ƭ DA_MODE: EDataAvailabilityMode

Data availability mode. Specifies a storage domain in Starknet. Each domain has different guarantees regarding availability

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:96


TXN_TYPE

Ƭ TXN_TYPE: TXN_TYPE_DECLARE | TXN_TYPE_DEPLOY | TXN_TYPE_DEPLOY_ACCOUNT | TXN_TYPE_INVOKE | Uppercase<ABI_TYPE_L1_HANDLER>

The type of the transaction

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:100


TXN_STATUS

Ƭ TXN_STATUS: STATUS_RECEIVED | STATUS_CANDIDATE | STATUS_PRE_CONFIRMED | STATUS_ACCEPTED_ON_L2 | STATUS_ACCEPTED_ON_L1

Represents the finality status of the transaction, including the case the txn is still in the mempool or failed validation during the block construction phase

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:104


TXN_FINALITY_STATUS

Ƭ TXN_FINALITY_STATUS: STATUS_PRE_CONFIRMED | STATUS_ACCEPTED_ON_L2 | STATUS_ACCEPTED_ON_L1

The finality status of the transaction

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:108


TXN_EXECUTION_STATUS

Ƭ TXN_EXECUTION_STATUS: STATUS_SUCCEEDED | STATUS_REVERTED

The execution status of the transaction

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:112


BLOCK_STATUS

Ƭ BLOCK_STATUS: EBlockStatus

The status of the block

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:116


BLOCK_ID

Ƭ BLOCK_ID: BLOCK_SELECTOR | BLOCK_TAG

A block identifier that can be either a block hash, block number, or a block tag

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:120


BLOCK_SELECTOR

Ƭ BLOCK_SELECTOR: SimpleOneOf<{ block_hash: BLOCK_HASH }, { block_number: BLOCK_NUMBER }>

A block selector that can be either a block hash or block number

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:124


BLOCK_TAG

Ƭ BLOCK_TAG: EBlockTag

A tag specifying a dynamic reference to a block. Tag l1_accepted refers to the latest Starknet block which was included in a state update on L1 and finalized by the consensus on L1. Tag latest refers to the latest Starknet block finalized by the consensus on L2. Tag pre_confirmed refers to the block which is currently being built by the block proposer in height latest + 1.

See

EBlockTag

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:136


TXN_STATUS_WITHOUT_L1

Ƭ TXN_STATUS_WITHOUT_L1: Exclude<TXN_STATUS, STATUS_ACCEPTED_ON_L1>

Transaction status excluding L1 acceptance

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:140


SUBSCRIPTION_ID

Ƭ SUBSCRIPTION_ID: string

An identifier for this subscription stream used to associate events with this subscription. Integer

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:145


NEW_TXN_STATUS

Ƭ NEW_TXN_STATUS: Object

New transaction status notification data

Type declaration

NameType
transaction_hashTXN_HASH
statusTXN_STATUS_RESULT

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:149


REORG_DATA

Ƭ REORG_DATA: Object

Data about reorganized blocks, starting and ending block number and hash

Type declaration

NameTypeDescription
starting_block_hashBLOCK_HASHHash of the first known block of the orphaned chain
starting_block_numberBLOCK_NUMBERNumber of the first known block of the orphaned chain
ending_block_hashBLOCK_HASHThe last known block of the orphaned chain
ending_block_numberBLOCK_NUMBERNumber of the last known block of the orphaned chain

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:156


NewHeadsEvent

Ƭ NewHeadsEvent: Object

Notification to the client of a new block header

Type declaration

NameType
subscription_idSUBSCRIPTION_ID
resultBLOCK_HEADER

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:177


StarknetEventsEvent

Ƭ StarknetEventsEvent: Object

Notification to the client of a new event. The event also includes the finality status of the transaction emitting the event

Type declaration

NameType
subscription_idSUBSCRIPTION_ID
resultEMITTED_EVENT & { finality_status: TXN_FINALITY_STATUS }

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:184


TransactionsStatusEvent

Ƭ TransactionsStatusEvent: Object

Notification to the client of a new transaction status update

Type declaration

NameTypeDescription
subscription_idSUBSCRIPTION_ID-
resultNEW_TXN_STATUSTransaction status result, including tx hash, finality status and execution status

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:193


NewTransactionReceiptsEvent

Ƭ NewTransactionReceiptsEvent: Object

Notification to the client of a new transaction receipt

Type declaration

NameType
subscription_idSUBSCRIPTION_ID
resultTXN_RECEIPT_WITH_BLOCK_INFO

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:203


NewTransactionEvent

Ƭ NewTransactionEvent: Object

Notification to the client of a new transaction, with its current finality status

Type declaration

NameTypeDescription
subscription_idSUBSCRIPTION_ID-
resultTXN_WITH_HASH & { finality_status: TXN_STATUS_WITHOUT_L1 }A transaction and its current finality status

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:210


ReorgEvent

Ƭ ReorgEvent: Object

Notification to the client of a chain reorganization

Type declaration

NameType
subscription_idSUBSCRIPTION_ID
resultREORG_DATA

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:222


EVENTS_CHUNK

Ƭ EVENTS_CHUNK: Object

Type declaration

NameTypeDescription
eventsEMITTED_EVENT[]Returns matching events
continuation_token?stringUse this token in a subsequent query to obtain the next page. Should not appear if there are no more pages.

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:226


RESULT_PAGE_REQUEST

Ƭ RESULT_PAGE_REQUEST: Object

Type declaration

NameTypeDescription
continuation_token?stringThe token returned from the previous query. If no token is provided the first page is returned.
chunk_sizenumberChunk size

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:236


EMITTED_EVENT

Ƭ EMITTED_EVENT: EVENT & { transaction_hash: TXN_HASH ; transaction_index: number ; event_index: number ; block_hash?: BLOCK_HASH ; block_number?: BLOCK_NUMBER }

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:246


EVENT

Ƭ EVENT: { from_address: ADDRESS } & EVENT_CONTENT

A StarkNet event

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:274


EVENT_CONTENT

Ƭ EVENT_CONTENT: Object

The content of an event

Type declaration

NameTypeDescription
keysFELT[]The keys of the event
dataFELT[]The data of the event

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:283


EVENT_KEYS

Ƭ EVENT_KEYS: FELT[][]

The keys to filter over. Per key (by position), designate the possible values to be matched for events to be returned. Empty array designates 'any' value.

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:297


EVENT_FILTER

Ƭ EVENT_FILTER: Object

An event filter used to query events

Type declaration

NameTypeDescription
from_block?BLOCK_IDThe block to start filtering from
to_block?BLOCK_IDThe block to filter up to
address?ADDRESSThe contract address to filter events from
keys?EVENT_KEYSThe event keys to filter

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:301


SUBSCRIPTION_BLOCK_ID

Ƭ SUBSCRIPTION_BLOCK_ID: Exclude<BLOCK_ID, "pre_confirmed" | "l1_accepted">

same as BLOCK_ID, but without 'pre_confirmed' and 'l1_accepted'

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:322


SYNC_STATUS

Ƭ SYNC_STATUS: Object

An object describing the node synchronization status

Type declaration

NameType
starting_block_hashBLOCK_HASH
starting_block_numBLOCK_NUMBER
current_block_hashBLOCK_HASH
current_block_numBLOCK_NUMBER
highest_block_hashBLOCK_HASH
highest_block_numBLOCK_NUMBER

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:326


NEW_CLASSES

Ƭ NEW_CLASSES: Object

The declared class hash and compiled class hash

Type declaration

NameType
class_hashFELT
compiled_class_hashFELT

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:337


REPLACED_CLASS

Ƭ REPLACED_CLASS: Object

The list of contracts whose class was replaced

Type declaration

NameType
class_hashFELT
contract_addressFELT

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:344


NONCE_UPDATE

Ƭ NONCE_UPDATE: Object

The updated nonce per contract address

Type declaration

NameType
contract_addressADDRESS
nonceFELT

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:351


STATE_DIFF

Ƭ STATE_DIFF: Object

The change in state applied in this block

Type declaration

NameTypeDescription
storage_diffsCONTRACT_STORAGE_DIFF_ITEM[]The changes in storage per contract address
deprecated_declared_classesFELT[]Deprecated classes declared in this block
declared_classesNEW_CLASSES[]New classes declared in this block, with their declared class hash and compiled class hash
deployed_contractsDEPLOYED_CONTRACT_ITEM[]A new contract deployed as part of the state update
replaced_classesREPLACED_CLASS[]The list of contracts whose class was replaced
noncesNONCE_UPDATE[]The updated nonce per contract address
migrated_compiled_classes?{ class_hash: FELT ; compiled_class_hash: FELT }[]The list of class hash and the new Blake-migrated compiled class hash pair

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:358


PRE_CONFIRMED_STATE_UPDATE

Ƭ PRE_CONFIRMED_STATE_UPDATE: Object

Pre-confirmed block state update

Type declaration

NameTypeDescription
state_diffSTATE_DIFFThe state diff of the pre-confirmed block
old_root?FELTThe previous global state root
block_hashnever-

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:394


STATE_UPDATE

Ƭ STATE_UPDATE: Object

The state update applied in a block

Type declaration

NameTypeDescription
block_hashBLOCK_HASHThe hash of the block
old_rootFELTThe previous global state root
new_rootFELTThe new global state root
state_diffSTATE_DIFFThe state diff of the block

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:408


BLOCK_BODY_WITH_TX_HASHES

Ƭ BLOCK_BODY_WITH_TX_HASHES: Object

The block body with transaction hashes only

Type declaration

NameTypeDescription
transactionsTXN_HASH[]The hashes of the transactions included in the block

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:429


BLOCK_BODY_WITH_TXS

Ƭ BLOCK_BODY_WITH_TXS: Object

The block body with full transactions

Type declaration

NameTypeDescription
transactionsTXN_WITH_HASH[]The transactions included in the block

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:438


BLOCK_BODY_WITH_RECEIPTS

Ƭ BLOCK_BODY_WITH_RECEIPTS: Object

The block body with full transactions and their receipts

Type declaration

NameTypeDescription
transactions{ transaction: TXN ; receipt: TXN_RECEIPT }[]The transactions and their receipts included in the block

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:447


BLOCK_HEADER

Ƭ BLOCK_HEADER: Object

Type declaration

NameTypeDescription
block_hashBLOCK_HASHThe hash of the block
parent_hashBLOCK_HASHThe hash of the block's parent
block_numberBLOCK_NUMBERThe block number
new_rootFELTThe new global state root
timestampnumberThe time in which the block was created, in seconds since Unix epoch
sequencer_addressFELTThe address of the sequencer who created the block
l1_gas_priceRESOURCE_PRICEThe price of L1 gas in the block
l2_gas_priceRESOURCE_PRICEThe price of L2 gas in the block
l1_data_gas_priceRESOURCE_PRICEThe price of L1 data gas in the block
l1_da_modeL1_DA_MODEThe mode of data availability for the block
starknet_versionstringSemver of the current Starknet protocol
event_commitmentFELTThe root of Merkle Patricia trie for events in the block. For (old) blocks where this data is not available value is 0x0
transaction_commitmentFELTThe root of Merkle Patricia trie for transactions in the block. For (old) blocks where this data is not available value is 0x0
receipt_commitmentFELTThe root of Merkle Patricia trie for receipts in the block. For (old) blocks where this data is not available value is 0x0
state_diff_commitmentFELTThe state diff commitment hash in the block. For (old) blocks where this data is not available value is 0x0
event_countnumberThe number of events in the block Minimum 0
transaction_countnumberThe number of transactions in the block Minimum 0
state_diff_lengthnumberThe length of the state diff in the block. For (old) blocks where this data is not available value is 0x0 Minimum 0

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:456


PRE_CONFIRMED_BLOCK_HEADER

Ƭ PRE_CONFIRMED_BLOCK_HEADER: Object

Type declaration

NameTypeDescription
block_numberBLOCK_NUMBERThe block number of the block that the proposer is currently building. Note that this is a local view of the node, whose accuracy depends on its polling interval length.
timestampnumberThe time in which the block was created, encoded in Unix time
sequencer_addressFELTThe StarkNet identity of the sequencer submitting this block
l1_gas_priceRESOURCE_PRICEThe price of l1 gas in the block
l2_gas_priceRESOURCE_PRICEThe price of l2 gas in the block
l1_data_gas_priceRESOURCE_PRICEThe price of l1 data gas in the block
l1_da_modeL1_DA_MODEspecifies whether the data of this block is published via blob data or calldata
starknet_versionstringSemver of the current Starknet protocol

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:538


BLOCK_WITH_TX_HASHES

Ƭ BLOCK_WITH_TX_HASHES: { status: BLOCK_STATUS } & BLOCK_HEADER & BLOCK_BODY_WITH_TX_HASHES

A block with transaction hashes

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:575


BLOCK_WITH_TXS

Ƭ BLOCK_WITH_TXS: { status: BLOCK_STATUS } & BLOCK_HEADER & BLOCK_BODY_WITH_TXS

A block with full transactions

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:581


BLOCK_WITH_RECEIPTS

Ƭ BLOCK_WITH_RECEIPTS: { status: BLOCK_STATUS } & BLOCK_HEADER & BLOCK_BODY_WITH_RECEIPTS

A block with full transactions and receipts

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:587


PRE_CONFIRMED_BLOCK_WITH_TX_HASHES

Ƭ PRE_CONFIRMED_BLOCK_WITH_TX_HASHES: BLOCK_BODY_WITH_TX_HASHES & PRE_CONFIRMED_BLOCK_HEADER

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:590


PRE_CONFIRMED_BLOCK_WITH_TXS

Ƭ PRE_CONFIRMED_BLOCK_WITH_TXS: BLOCK_BODY_WITH_TXS & PRE_CONFIRMED_BLOCK_HEADER

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:591


PRE_CONFIRMED_BLOCK_WITH_RECEIPTS

Ƭ PRE_CONFIRMED_BLOCK_WITH_RECEIPTS: BLOCK_BODY_WITH_RECEIPTS & PRE_CONFIRMED_BLOCK_HEADER

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:592


DEPLOYED_CONTRACT_ITEM

Ƭ DEPLOYED_CONTRACT_ITEM: Object

A new contract deployed as part of the state update

Type declaration

NameType
addressFELT
class_hashFELT

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:596


CONTRACT_STORAGE_DIFF_ITEM

Ƭ CONTRACT_STORAGE_DIFF_ITEM: Object

Type declaration

NameTypeDescription
addressFELTThe contract address for which the storage changed
storage_entriesStorageDiffItem[]The changes in the storage of the contract

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:600


StorageDiffItem

Ƭ StorageDiffItem: Object

Type declaration

NameTypeDescription
keyFELTThe key of the changed value
valueFELTThe new value applied to the given address

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:610


TXN

Ƭ TXN: INVOKE_TXN | L1_HANDLER_TXN | DECLARE_TXN | DEPLOY_TXN | DEPLOY_ACCOUNT_TXN

A Starknet transaction

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:623


TXN_WITH_HASH

Ƭ TXN_WITH_HASH: TXN & { transaction_hash: TXN_HASH }

A transaction with its hash

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:627


DECLARE_TXN

Ƭ DECLARE_TXN: DECLARE_TXN_V0 | DECLARE_TXN_V1 | DECLARE_TXN_V2 | DECLARE_TXN_V3

A declare transaction (all versions)

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:633


DECLARE_TXN_V0

Ƭ DECLARE_TXN_V0: Object

Deprecated

Starknet 0.14 will not support this transaction

Type declaration

NameType
typeTXN_TYPE_DECLARE
sender_addressADDRESS
max_feeFELT
versiontypeof V0 | typeof F0
signatureSIGNATURE
class_hashFELT

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:637


DECLARE_TXN_V1

Ƭ DECLARE_TXN_V1: Object

Deprecated

Starknet 0.14 will not support this transaction

Type declaration

NameType
typeTXN_TYPE_DECLARE
sender_addressADDRESS
max_feeFELT
versiontypeof V1 | typeof F1
signatureSIGNATURE
nonceFELT
class_hashFELT

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:648


DECLARE_TXN_V2

Ƭ DECLARE_TXN_V2: Object

Deprecated

Starknet 0.14 will not support this transaction

Type declaration

NameType
typeTXN_TYPE_DECLARE
sender_addressADDRESS
compiled_class_hashFELT
max_feeFELT
versiontypeof V2 | typeof F2
signatureSIGNATURE
nonceFELT
class_hashFELT

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:660


DECLARE_TXN_V3

Ƭ DECLARE_TXN_V3: Object

Type declaration

NameType
typeTXN_TYPE_DECLARE
sender_addressADDRESS
compiled_class_hashFELT
versiontypeof V3 | typeof F3
signatureSIGNATURE
nonceFELT
class_hashFELT
resource_boundsRESOURCE_BOUNDS_MAPPING
tipu64
paymaster_dataFELT[]
account_deployment_dataFELT[]
nonce_data_availability_modeDA_MODE
fee_data_availability_modeDA_MODE

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:670


BROADCASTED_TXN

Ƭ BROADCASTED_TXN: BROADCASTED_INVOKE_TXN | BROADCASTED_DECLARE_TXN | BROADCASTED_DEPLOY_ACCOUNT_TXN

A transaction to be broadcasted to the network

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:688


BROADCASTED_INVOKE_TXN

Ƭ BROADCASTED_INVOKE_TXN: INVOKE_TXN_V3

A broadcasted invoke transaction

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:692


BROADCASTED_DEPLOY_ACCOUNT_TXN

Ƭ BROADCASTED_DEPLOY_ACCOUNT_TXN: DEPLOY_ACCOUNT_TXN_V3

A broadcasted deploy account transaction

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:696


BROADCASTED_DECLARE_TXN

Ƭ BROADCASTED_DECLARE_TXN: BROADCASTED_DECLARE_TXN_V3

A broadcasted declare transaction

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:700


BROADCASTED_DECLARE_TXN_V3

Ƭ BROADCASTED_DECLARE_TXN_V3: Object

Type declaration

NameType
typeTXN_TYPE_DECLARE
sender_addressADDRESS
compiled_class_hashFELT
versiontypeof V3 | typeof F3
signatureSIGNATURE
nonceFELT
contract_classCONTRACT_CLASS
resource_boundsRESOURCE_BOUNDS_MAPPING
tipu64
paymaster_dataFELT[]
account_deployment_dataFELT[]
nonce_data_availability_modeDA_MODE
fee_data_availability_modeDA_MODE

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:701


DEPLOY_ACCOUNT_TXN

Ƭ DEPLOY_ACCOUNT_TXN: DEPLOY_ACCOUNT_TXN_V1 | DEPLOY_ACCOUNT_TXN_V3

A deploy account transaction (all versions)

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:719


DEPLOY_ACCOUNT_TXN_V1

Ƭ DEPLOY_ACCOUNT_TXN_V1: Object

Deprecated

Starknet 0.14 will not support this transaction

Type declaration

NameType
typeTXN_TYPE_DEPLOY_ACCOUNT
max_feeFELT
versiontypeof V1 | typeof F1
signatureSIGNATURE
nonceFELT
contract_address_saltFELT
constructor_calldataFELT[]
class_hashFELT

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:723


DEPLOY_ACCOUNT_TXN_V3

Ƭ DEPLOY_ACCOUNT_TXN_V3: Object

Type declaration

NameType
typeTXN_TYPE_DEPLOY_ACCOUNT
versiontypeof V3 | typeof F3
signatureSIGNATURE
nonceFELT
contract_address_saltFELT
constructor_calldataFELT[]
class_hashFELT
resource_boundsRESOURCE_BOUNDS_MAPPING
tipu64
paymaster_dataFELT[]
nonce_data_availability_modeDA_MODE
fee_data_availability_modeDA_MODE

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:733


DEPLOY_TXN

Ƭ DEPLOY_TXN: Object

A deploy transaction (legacy, no longer used for new deployments)

Type declaration

NameType
typeTXN_TYPE_DEPLOY
versionFELT
contract_address_saltFELT
constructor_calldataFELT[]
class_hashFELT

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:750


INVOKE_TXN

Ƭ INVOKE_TXN: INVOKE_TXN_V0 | INVOKE_TXN_V1 | INVOKE_TXN_V3

An invoke transaction (all versions)

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:760


INVOKE_TXN_V0

Ƭ INVOKE_TXN_V0: Object

Deprecated

Starknet 0.14 will not support this transaction

Type declaration

NameType
typeTXN_TYPE_INVOKE
max_feeFELT
versiontypeof V0 | typeof F0
signatureSIGNATURE
contract_addressADDRESS
entry_point_selectorFELT
calldataFELT[]

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:764


INVOKE_TXN_V1

Ƭ INVOKE_TXN_V1: Object

Deprecated

Starknet 0.14 will not support this transaction

Type declaration

NameType
typeTXN_TYPE_INVOKE
sender_addressADDRESS
calldataFELT[]
max_feeFELT
versiontypeof V1 | typeof F1
signatureSIGNATURE
nonceFELT

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:776


INVOKE_TXN_V3

Ƭ INVOKE_TXN_V3: Object

Type declaration

NameType
typeTXN_TYPE_INVOKE
sender_addressADDRESS
calldataFELT[]
versiontypeof V3 | typeof F3
signatureSIGNATURE
nonceFELT
resource_boundsRESOURCE_BOUNDS_MAPPING
tipu64
paymaster_dataFELT[]
account_deployment_dataFELT[]
nonce_data_availability_modeDA_MODE
fee_data_availability_modeDA_MODE

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:785


L1_HANDLER_TXN

Ƭ L1_HANDLER_TXN: { version: typeof V0 ; type: Uppercase<ABI_TYPE_L1_HANDLER> ; nonce: NUM_AS_HEX } & FUNCTION_CALL

An L1 handler transaction, triggered by a message from L1

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:802


COMMON_RECEIPT_PROPERTIES

Ƭ COMMON_RECEIPT_PROPERTIES: { transaction_hash: TXN_HASH ; actual_fee: FEE_PAYMENT ; finality_status: TXN_FINALITY_STATUS ; messages_sent: MSG_TO_L1[] ; events: EVENT[] ; execution_resources: EXECUTION_RESOURCES } & SimpleOneOf<SUCCESSFUL_COMMON_RECEIPT_PROPERTIES, REVERTED_COMMON_RECEIPT_PROPERTIES>

Common properties shared by all transaction receipts

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:810


INVOKE_TXN_RECEIPT

Ƭ INVOKE_TXN_RECEIPT: { type: TXN_TYPE_INVOKE } & COMMON_RECEIPT_PROPERTIES

A transaction receipt for an invoke transaction

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:834


DECLARE_TXN_RECEIPT

Ƭ DECLARE_TXN_RECEIPT: { type: TXN_TYPE_DECLARE } & COMMON_RECEIPT_PROPERTIES

A transaction receipt for a declare transaction

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:840


DEPLOY_ACCOUNT_TXN_RECEIPT

Ƭ DEPLOY_ACCOUNT_TXN_RECEIPT: { type: TXN_TYPE_DEPLOY_ACCOUNT ; contract_address: FELT } & COMMON_RECEIPT_PROPERTIES

A transaction receipt for a deploy account transaction

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:846


DEPLOY_TXN_RECEIPT

Ƭ DEPLOY_TXN_RECEIPT: { type: TXN_TYPE_DEPLOY ; contract_address: FELT } & COMMON_RECEIPT_PROPERTIES

A transaction receipt for a deploy transaction

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:853


L1_HANDLER_TXN_RECEIPT

Ƭ L1_HANDLER_TXN_RECEIPT: { type: Uppercase<ABI_TYPE_L1_HANDLER> ; message_hash: NUM_AS_HEX } & COMMON_RECEIPT_PROPERTIES

A transaction receipt for an L1 handler transaction

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:860


TXN_RECEIPT

Ƭ TXN_RECEIPT: INVOKE_TXN_RECEIPT | L1_HANDLER_TXN_RECEIPT | DECLARE_TXN_RECEIPT | DEPLOY_TXN_RECEIPT | DEPLOY_ACCOUNT_TXN_RECEIPT

All possible transaction receipt types

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:867


TXN_RECEIPT_WITH_BLOCK_INFO

Ƭ TXN_RECEIPT_WITH_BLOCK_INFO: TXN_RECEIPT & { block_number: BLOCK_NUMBER } & { block_hash: BLOCK_HASH } | { block_hash: never }

A transaction receipt with block information

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:871


MSG_TO_L1

Ƭ MSG_TO_L1: Object

A message sent from L2 to L1

Type declaration

NameType
from_addressFELT
to_addressFELT
payloadFELT[]

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:884


MSG_FROM_L1

Ƭ MSG_FROM_L1: Object

A message sent from L1 to L2

Type declaration

NameType
from_addressETH_ADDRESS
to_addressADDRESS
entry_point_selectorFELT
payloadFELT[]

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:892


FUNCTION_CALL

Ƭ FUNCTION_CALL: Object

Function call information

Type declaration

NameType
contract_addressADDRESS
entry_point_selectorFELT
calldataFELT[]

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:901


CONTRACT_CLASS

Ƭ CONTRACT_CLASS: Object

The definition of a StarkNet contract class

Type declaration

NameType
sierra_programFELT[]
contract_class_versionstring
entry_points_by_type{ CONSTRUCTOR: SIERRA_ENTRY_POINT[] ; EXTERNAL: SIERRA_ENTRY_POINT[] ; L1_HANDLER: SIERRA_ENTRY_POINT[] }
entry_points_by_type.CONSTRUCTORSIERRA_ENTRY_POINT[]
entry_points_by_type.EXTERNALSIERRA_ENTRY_POINT[]
entry_points_by_type.L1_HANDLERSIERRA_ENTRY_POINT[]
abistring

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:909


DEPRECATED_CONTRACT_CLASS

Ƭ DEPRECATED_CONTRACT_CLASS: Object

Type declaration

NameType
programstring
entry_points_by_type{ CONSTRUCTOR: DEPRECATED_CAIRO_ENTRY_POINT[] ; EXTERNAL: DEPRECATED_CAIRO_ENTRY_POINT[] ; L1_HANDLER: DEPRECATED_CAIRO_ENTRY_POINT[] }
entry_points_by_type.CONSTRUCTORDEPRECATED_CAIRO_ENTRY_POINT[]
entry_points_by_type.EXTERNALDEPRECATED_CAIRO_ENTRY_POINT[]
entry_points_by_type.L1_HANDLERDEPRECATED_CAIRO_ENTRY_POINT[]
abiCONTRACT_ABI

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:919


DEPRECATED_CAIRO_ENTRY_POINT

Ƭ DEPRECATED_CAIRO_ENTRY_POINT: Object

Type declaration

NameTypeDescription
offsetNUM_AS_HEX"The offset of the entry point in the program"
selectorFELTA unique identifier of the entry point (function) in the program

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:928


SIERRA_ENTRY_POINT

Ƭ SIERRA_ENTRY_POINT: Object

A Sierra contract entry point

Type declaration

NameTypeDescription
selectorFELTA unique identifier of the entry point (function) in the program
function_idxnumberThe index of the function in the program Minimum 0

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:941


CONTRACT_ABI

Ƭ CONTRACT_ABI: readonly CONTRACT_ABI_ENTRY[]

The ABI of a contract

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:955


CONTRACT_ABI_ENTRY

Ƭ CONTRACT_ABI_ENTRY: FUNCTION_ABI_ENTRY | EVENT_ABI_ENTRY | STRUCT_ABI_ENTRY

A single entry in a contract's ABI

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:959


STRUCT_ABI_ENTRY

Ƭ STRUCT_ABI_ENTRY: Object

Type declaration

NameTypeDescription
typeSTRUCT_ABI_TYPEStruct ABI type
namestringStruct name
sizenumber-
membersSTRUCT_MEMBER[]-

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:960


STRUCT_MEMBER

Ƭ STRUCT_MEMBER: TYPED_PARAMETER & { offset: number }

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:972


EVENT_ABI_ENTRY

Ƭ EVENT_ABI_ENTRY: Object

Type declaration

NameTypeDescription
typeEVENT_ABI_TYPEEvent ABI type
namestringEvent name
keysTYPED_PARAMETER[]-
dataTYPED_PARAMETER[]-

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:979


FUNCTION_STATE_MUTABILITY

Ƭ FUNCTION_STATE_MUTABILITY: STATE_MUTABILITY_VIEW

The state mutability of a function in an ABI

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:994


FUNCTION_ABI_ENTRY

Ƭ FUNCTION_ABI_ENTRY: Object

Type declaration

NameTypeDescription
typeFUNCTION_ABI_TYPEFunction ABI type
namestringFunction name
inputsTYPED_PARAMETER[]Typed parameter
outputsTYPED_PARAMETER[]Typed parameter
stateMutability?FUNCTION_STATE_MUTABILITYFunction state mutability

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:995


TYPED_PARAMETER

Ƭ TYPED_PARAMETER: Object

Type declaration

NameTypeDescription
namestringParameter name
typestringParameter type

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:1017


SIMULATION_FLAG_FOR_ESTIMATE_FEE

Ƭ SIMULATION_FLAG_FOR_ESTIMATE_FEE: typeof SKIP_VALIDATE

Simulation flags allowed for fee estimation

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:1030


PRICE_UNIT

Ƭ PRICE_UNIT: PRICE_UNIT_WEI | PRICE_UNIT_FRI

The unit of a price (WEI or FRI)

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:1034


FEE_ESTIMATE_COMMON

Ƭ FEE_ESTIMATE_COMMON: Object

Common properties for fee estimation

Type declaration

NameTypeDescription
l1_gas_consumedu64The Ethereum gas consumption of the transaction, charged for L1->L2 messages and, depending on the block's DA_MODE, state diffs. Prev. name gas_consumed
l1_gas_priceu128The gas price (in wei or fri, depending on the tx version) that was used in the cost estimation. Prev. name gas_price
l2_gas_consumedu64The L2 gas consumption of the transaction.
l2_gas_priceu128The L2 gas price (in wei or fri, depending on the tx version) that was used in the cost estimation.
l1_data_gas_consumedu64The Ethereum data gas consumption of the transaction. Prev. name data_gas_consumed
l1_data_gas_priceu128The data gas price (in wei or fri, depending on the tx version) that was used in the cost estimation. Prev. name data_gas_price
overall_feeu128The estimated fee for the transaction (in wei or fri, depending on the tx version), equals to l1_gas_consumedl1_gas_price + l1_data_gas_consumedl1_data_gas_price + l2_gas_consumed*l2_gas_price

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:1038


FEE_ESTIMATE

Ƭ FEE_ESTIMATE: FEE_ESTIMATE_COMMON & { unit: PRICE_UNIT_FRI }

Fee estimation result for a transaction

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:1075


MESSAGE_FEE_ESTIMATE

Ƭ MESSAGE_FEE_ESTIMATE: FEE_ESTIMATE_COMMON & { unit: PRICE_UNIT_WEI }

Message fee estimate

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:1084


FEE_PAYMENT

Ƭ FEE_PAYMENT: Object

Fee payment information

Type declaration

NameTypeDescription
amountFELTThe amount paid
unitPRICE_UNITThe unit of the fee (WEI or FRI)

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:1093


RESOURCE_BOUNDS_MAPPING

Ƭ RESOURCE_BOUNDS_MAPPING: Object

The resource bounds for a transaction

Type declaration

NameTypeDescription
l1_gasRESOURCE_BOUNDSThe max amount and max price per unit of L1 gas used in this tx
l1_data_gasRESOURCE_BOUNDSThe max amount and max price per unit of L1 blob gas used in this tx
l2_gasRESOURCE_BOUNDSThe max amount and max price per unit of L2 gas used in this tx

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:1106


RESOURCE_BOUNDS

Ƭ RESOURCE_BOUNDS: Object

The maximum resources a transaction can consume

Type declaration

NameTypeDescription
max_amountu64The max amount of the resource that can be used
max_price_per_unitu128The max price per unit of the resource

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:1123


RESOURCE_PRICE

Ƭ RESOURCE_PRICE: Object

The price of a resource in both FRI and WEI

Type declaration

NameTypeDescription
price_in_friFELTThe price in FRI (STRK's smallest unit)
price_in_weiFELTThe price in WEI (ETH's smallest unit)

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:1136


EXECUTION_RESOURCES

Ƭ EXECUTION_RESOURCES: Object

the resources consumed by the transaction

Type declaration

NameTypeDescription
l1_gasnumberl1 gas consumed by this transaction, used for l2-->l1 messages and state updates if blobs are not used. integer Minimum 0
l1_data_gasnumberdata gas consumed by this transaction, 0 if blobs are not used integer Minimum 0
l2_gasnumberl2 gas consumed by this transaction, used for computation and calldata Integer Minimum 0

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:1149


MERKLE_NODE

Ƭ MERKLE_NODE: SimpleOneOf<BINARY_NODE, EDGE_NODE>

a node in the Merkle-Patricia tree, can be a leaf, binary node, or an edge node

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:1172


BINARY_NODE

Ƭ BINARY_NODE: Object

an internal node whose both children are non-zero

Type declaration

NameTypeDescription
leftFELTthe hash of the left child
rightFELTthe hash of the right child

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:1176


EDGE_NODE

Ƭ EDGE_NODE: Object

represents a path to the highest non-zero descendant node

Type declaration

NameTypeDescription
pathNUM_AS_HEXan unsigned integer whose binary representation represents the path from the current node to its highest non-zero descendant (bounded by 2^251)
lengthnumberthe length of the path (bounded by 251) Minimum 0
childFELTthe hash of the unique non-zero maximal-height descendant node

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:1189


NODE_HASH_TO_NODE_MAPPING

Ƭ NODE_HASH_TO_NODE_MAPPING: { node_hash: FELT ; node: MERKLE_NODE }[]

a node_hash -> node mapping of all the nodes in the union of the paths between the requested leaves and the root

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:1207


CONTRACT_EXECUTION_ERROR

Ƭ CONTRACT_EXECUTION_ERROR: CONTRACT_EXECUTION_ERROR_INNER

structured error that can later be processed by wallets or sdks. error frame or the error raised during execution

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:1215


CONTRACT_EXECUTION_ERROR_INNER

Ƭ CONTRACT_EXECUTION_ERROR_INNER: { contract_address: ADDRESS ; class_hash: FELT ; selector: FELT ; error: CONTRACT_EXECUTION_ERROR } | string

structured error that can later be processed by wallets or sdks. error frame or the error raised during execution

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:1220


TRANSACTION_TRACE

Ƭ TRANSACTION_TRACE: INVOKE_TXN_TRACE | DECLARE_TXN_TRACE | DEPLOY_ACCOUNT_TXN_TRACE | L1_HANDLER_TXN_TRACE

A transaction trace including the execution details

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:1229


INVOKE_TXN_TRACE

Ƭ INVOKE_TXN_TRACE: Object

A transaction trace for an invoke transaction

Type declaration

NameTypeDescription
typeTXN_TYPE_INVOKE-
execute_invocationREVERTIBLE_FUNCTION_INVOCATIONThe trace of the execute call
validate_invocation?FUNCTION_INVOCATION-
fee_transfer_invocation?FUNCTION_INVOCATION-
state_diff?STATE_DIFF-
execution_resourcesEXECUTION_RESOURCES-

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:1233


DECLARE_TXN_TRACE

Ƭ DECLARE_TXN_TRACE: Object

A transaction trace for a declare transaction

Type declaration

NameType
typeTXN_TYPE_DECLARE
validate_invocation?FUNCTION_INVOCATION
fee_transfer_invocation?FUNCTION_INVOCATION
state_diff?STATE_DIFF
execution_resourcesEXECUTION_RESOURCES

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:1247


DEPLOY_ACCOUNT_TXN_TRACE

Ƭ DEPLOY_ACCOUNT_TXN_TRACE: Object

A transaction trace for a deploy account transaction

Type declaration

NameTypeDescription
typeTXN_TYPE_DEPLOY_ACCOUNT-
constructor_invocationFUNCTION_INVOCATIONThe trace of the constructor call
validate_invocation?FUNCTION_INVOCATION-
fee_transfer_invocation?FUNCTION_INVOCATION-
state_diff?STATE_DIFF-
execution_resourcesEXECUTION_RESOURCES-

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:1257


L1_HANDLER_TXN_TRACE

Ƭ L1_HANDLER_TXN_TRACE: Object

A transaction trace for an L1 handler transaction

Type declaration

NameTypeDescription
typeUppercase<ABI_TYPE_L1_HANDLER>-
function_invocationREVERTIBLE_FUNCTION_INVOCATIONThe trace of the L1 handler call
state_diff?STATE_DIFF-
execution_resourcesEXECUTION_RESOURCES-

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:1271


NESTED_CALL

Ƭ NESTED_CALL: FUNCTION_INVOCATION

Represents a nested function call.

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:1283


FUNCTION_INVOCATION

Ƭ FUNCTION_INVOCATION: FUNCTION_CALL & { caller_address: FELT ; class_hash: FELT ; entry_point_type: ENTRY_POINT_TYPE ; call_type: CALL_TYPE ; result: FELT[] ; calls: NESTED_CALL[] ; events: ORDERED_EVENT[] ; messages: ORDERED_MESSAGE[] ; execution_resources: INNER_CALL_EXECUTION_RESOURCES ; is_reverted: boolean }

Represents a function invocation along with its execution details.

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:1287


INNER_CALL_EXECUTION_RESOURCES

Ƭ INNER_CALL_EXECUTION_RESOURCES: Object

the resources consumed by an inner call (does not account for state diffs since data is squashed across the transaction)

Type declaration

NameTypeDescription
l1_gasnumberl1 gas consumed by this transaction, used for l2-->l1 messages and state updates if blobs are not used Minimum 0
l2_gasnumberl2 gas consumed by this transaction, used for computation and calldata Minimum 0

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:1326


REVERTIBLE_FUNCTION_INVOCATION

Ƭ REVERTIBLE_FUNCTION_INVOCATION: SimpleOneOf<FUNCTION_INVOCATION, { revert_reason: string }>

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:1338


ORDERED_EVENT

Ƭ ORDERED_EVENT: { order: number } & EVENT_CONTENT

Represents an ordered event alongside its order within the transaction.

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:1344


ORDERED_MESSAGE

Ƭ ORDERED_MESSAGE: Object

Represents an ordered message alongside its order within the transaction.

Type declaration

NameTypeDescription
ordernumberMinimum 0
messageMSG_TO_L1-

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:1353


TXN_STATUS_RESULT

Ƭ TXN_STATUS_RESULT: Object

Transaction status result, including finality status and execution status

Type declaration

NameTypeDescription
finality_statusTXN_STATUS-
execution_status?TXN_EXECUTION_STATUS-
failure_reason?stringThe failure reason, only appears if execution_status is REVERTED

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:1363


CONTRACT_STORAGE_KEYS

Ƭ CONTRACT_STORAGE_KEYS: Object

(contract_address, storage_keys) pairs

Type declaration

NameType
contract_addressADDRESS
storage_keysSTORAGE_KEY[]

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/components.d.ts:1374


STATUS_ACCEPTED_ON_L2

Ƭ STATUS_ACCEPTED_ON_L2: "ACCEPTED_ON_L2"

The transaction/block was accepted on L2 and included

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:4

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:5


STATUS_ACCEPTED_ON_L1

Ƭ STATUS_ACCEPTED_ON_L1: "ACCEPTED_ON_L1"

The transaction/block was accepted on Ethereum (L1)

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:9

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:10


STATUS_SUCCEEDED

Ƭ STATUS_SUCCEEDED: "SUCCEEDED"

The transaction was successfully executed

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:14

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:15


STATUS_REVERTED

Ƭ STATUS_REVERTED: "REVERTED"

The transaction passed validation but failed during execution by the sequencer, and is included in a block as reverted

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:19

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:20


STATUS_RECEIVED

Ƭ STATUS_RECEIVED: "RECEIVED"

The transaction was received by the sequencer

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:24

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:25


STATUS_CANDIDATE

Ƭ STATUS_CANDIDATE: "CANDIDATE"

The transaction is a candidate for inclusion in the next block

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:29

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:30


STATUS_PRE_CONFIRMED

Ƭ STATUS_PRE_CONFIRMED: "PRE_CONFIRMED"

The transaction/block was written to the feeder gateway's storage by a sequencer

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:34

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:35


STATUS_PRE_CONFIRMED_LOWERCASE

Ƭ STATUS_PRE_CONFIRMED_LOWERCASE: InferLowercaseString<typeof STATUS_PRE_CONFIRMED>

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:36

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:37


TXN_TYPE_DECLARE

Ƭ TXN_TYPE_DECLARE: "DECLARE"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:38

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:39


TXN_TYPE_DEPLOY

Ƭ TXN_TYPE_DEPLOY: "DEPLOY"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:40

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:41


TXN_TYPE_DEPLOY_ACCOUNT

Ƭ TXN_TYPE_DEPLOY_ACCOUNT: "DEPLOY_ACCOUNT"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:42

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:43


TXN_TYPE_INVOKE

Ƭ TXN_TYPE_INVOKE: "INVOKE"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:44

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:45


TXN_TYPE_L1_HANDLER

Ƭ TXN_TYPE_L1_HANDLER: "L1_HANDLER"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:46

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:47


STRUCT_ABI_TYPE

Ƭ STRUCT_ABI_TYPE: "struct"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:48

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:49


EVENT_ABI_TYPE

Ƭ EVENT_ABI_TYPE: "event"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:50

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:51


ABI_TYPE_FUNCTION

Ƭ ABI_TYPE_FUNCTION: "function"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:52

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:53


ABI_TYPE_CONSTRUCTOR

Ƭ ABI_TYPE_CONSTRUCTOR: "constructor"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:54

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:55


ABI_TYPE_L1_HANDLER

Ƭ ABI_TYPE_L1_HANDLER: "l1_handler"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:56

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:57


ABI_TYPE_ENUM

Ƭ ABI_TYPE_ENUM: "enum"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:58

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:59


STATE_MUTABILITY_VIEW

Ƭ STATE_MUTABILITY_VIEW: "view"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:60

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:61


STATE_MUTABILITY_EXTERNAL

Ƭ STATE_MUTABILITY_EXTERNAL: "external"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:62

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:63


PRICE_UNIT_WEI

Ƭ PRICE_UNIT_WEI: "WEI"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:64

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:65


PRICE_UNIT_FRI

Ƭ PRICE_UNIT_FRI: "FRI"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:66

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:67


L1_DA_MODE

Ƭ L1_DA_MODE: typeof L1_DA_MODE[keyof typeof L1_DA_MODE]

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:68

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:72


CALL_TYPE

Ƭ CALL_TYPE: typeof CALL_TYPE[keyof typeof CALL_TYPE]

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:76

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:81


ETransactionType

Ƭ ETransactionType: typeof ETransactionType[keyof typeof ETransactionType]

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:82

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:89


ESimulationFlag

Ƭ ESimulationFlag: typeof ESimulationFlag[keyof typeof ESimulationFlag]

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:90

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:94


ETransactionStatus

Ƭ ETransactionStatus: typeof ETransactionStatus[keyof typeof ETransactionStatus]

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:95

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:102


ETransactionFinalityStatus

Ƭ ETransactionFinalityStatus: typeof ETransactionFinalityStatus[keyof typeof ETransactionFinalityStatus]

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:103

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:108


ETransactionExecutionStatus

Ƭ ETransactionExecutionStatus: typeof ETransactionExecutionStatus[keyof typeof ETransactionExecutionStatus]

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:109

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:113


EBlockTag

Ƭ EBlockTag: typeof EBlockTag[keyof typeof EBlockTag]

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:118

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:132


EBlockStatus

Ƭ EBlockStatus: typeof EBlockStatus[keyof typeof EBlockStatus]

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:133

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:138


EDataAvailabilityMode

Ƭ EDataAvailabilityMode: typeof EDataAvailabilityMode[keyof typeof EDataAvailabilityMode]

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:139

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:143


EDAMode

Ƭ EDAMode: typeof EDAMode[keyof typeof EDAMode]

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:144

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:148


ETransactionVersion

Ƭ ETransactionVersion: typeof ETransactionVersion[keyof typeof ETransactionVersion]

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:153

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:181


ETransactionVersion2

Ƭ ETransactionVersion2: typeof ETransactionVersion2[keyof typeof ETransactionVersion2]

Deprecated

Starknet 0.14 will not support this transaction

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:188

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:199


ETransactionVersion3

Ƭ ETransactionVersion3: typeof ETransactionVersion3[keyof typeof ETransactionVersion3]

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:203

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:207


CASM_COMPILED_CONTRACT_CLASS

Ƭ CASM_COMPILED_CONTRACT_CLASS: Object

Starknet get compiled CASM result

Type declaration

NameTypeDescription
entry_points_by_type{ CONSTRUCTOR: CASM_ENTRY_POINT[] ; EXTERNAL: CASM_ENTRY_POINT[] ; L1_HANDLER: CASM_ENTRY_POINT[] }-
entry_points_by_type.CONSTRUCTORCASM_ENTRY_POINT[]-
entry_points_by_type.EXTERNALCASM_ENTRY_POINT[]-
entry_points_by_type.L1_HANDLERCASM_ENTRY_POINT[]-
bytecodeFELT[]-
primeNUM_AS_HEX-
compiler_versionstring-
hints[number | HINT[], number | HINT[]][]Array of 2-tuple of pc value and an array of hints to execute.
bytecode_segment_lengths?numbera list of sizes of segments in the bytecode, each segment is hashed individually when computing the bytecode hash. Integer

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/executable.d.ts:5


CASM_ENTRY_POINT

Ƭ CASM_ENTRY_POINT: Object

Type declaration

NameType
offsetnumber
selectorFELT
builtinsstring[]

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/executable.d.ts:24


CellRef

Ƭ CellRef: Object

Type declaration

NameType
register"AP" | "FP"
offsetnumber

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/executable.d.ts:29


Deref

Ƭ Deref: Object

Type declaration

NameType
DerefCellRef

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/executable.d.ts:33


DoubleDeref

Ƭ DoubleDeref: Object

Type declaration

NameTypeDescription
DoubleDeref[CellRef | number]A (CellRef, offset) tuple

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/executable.d.ts:36


Immediate

Ƭ Immediate: Object

Type declaration

NameType
ImmediateNUM_AS_HEX

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/executable.d.ts:42


BinOp

Ƭ BinOp: Object

Type declaration

NameType
BinOp{ op: "Add" | "Mul" ; a: CellRef ; b: Deref | Immediate }
BinOp.op"Add" | "Mul"
BinOp.aCellRef
BinOp.bDeref | Immediate

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/executable.d.ts:45


ResOperand

Ƭ ResOperand: Deref | DoubleDeref | Immediate | BinOp

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/executable.d.ts:52


HINT

Ƭ HINT: DEPRECATED_HINT | CORE_HINT | STARKNET_HINT

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/executable.d.ts:53


DEPRECATED_HINT

Ƭ DEPRECATED_HINT: "AssertCurrentAccessIndicesIsEmpty" | "AssertAllKeysUsed" | "AssertLeAssertThirdArcExcluded" | { AssertAllAccessesUsed: { n_used_accesses: CellRef } } | { AssertLtAssertValidInput: { a: ResOperand ; b: ResOperand } } | { Felt252DictRead: { dict_ptr: ResOperand ; key: ResOperand ; value_dst: CellRef } } | { Felt252DictWrite: { dict_ptr: ResOperand ; key: ResOperand ; value: ResOperand } }

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/executable.d.ts:54


CORE_HINT

Ƭ CORE_HINT: { AllocSegment: { dst: CellRef } } | { TestLessThan: { lhs: ResOperand ; rhs: ResOperand ; dst: CellRef } } | { TestLessThanOrEqual: { lhs: ResOperand ; rhs: ResOperand ; dst: CellRef } } | { TestLessThanOrEqualAddress: { lhs: ResOperand ; rhs: ResOperand ; dst: CellRef } } | { WideMul128: { lhs: ResOperand ; rhs: ResOperand ; high: CellRef ; low: CellRef } } | { DivMod: { lhs: ResOperand ; rhs: ResOperand ; quotient: CellRef ; remainder: CellRef } } | { Uint256DivMod: { dividend0: ResOperand ; dividend1: ResOperand ; divisor0: ResOperand ; divisor1: ResOperand ; quotient0: CellRef ; quotient1: CellRef ; remainder0: CellRef ; remainder1: CellRef } } | { Uint512DivModByUint256: { dividend0: ResOperand ; dividend1: ResOperand ; dividend2: ResOperand ; dividend3: ResOperand ; divisor0: ResOperand ; divisor1: ResOperand ; quotient0: CellRef ; quotient1: CellRef ; quotient2: CellRef ; quotient3: CellRef ; remainder0: CellRef ; remainder1: CellRef } } | { SquareRoot: { value: ResOperand ; dst: CellRef } } | { Uint256SquareRoot: { value_low: ResOperand ; value_high: ResOperand ; sqrt0: CellRef ; sqrt1: CellRef ; remainder_low: CellRef ; remainder_high: CellRef ; sqrt_mul_2_minus_remainder_ge_u128: CellRef } } | { LinearSplit: { value: ResOperand ; scalar: ResOperand ; max_x: ResOperand ; x: CellRef ; y: CellRef } } | { AllocFelt252Dict: { segment_arena_ptr: ResOperand } } | { Felt252DictEntryInit: { dict_ptr: ResOperand ; key: ResOperand } } | { Felt252DictEntryUpdate: { dict_ptr: ResOperand ; value: ResOperand } } | { GetSegmentArenaIndex: { dict_end_ptr: ResOperand ; dict_index: CellRef } } | { InitSquashData: { dict_accesses: ResOperand ; ptr_diff: ResOperand ; n_accesses: ResOperand ; big_keys: CellRef ; first_key: CellRef } } | { GetCurrentAccessIndex: { range_check_ptr: ResOperand } } | { ShouldSkipSquashLoop: { should_skip_loop: CellRef } } | { GetCurrentAccessDelta: { index_delta_minus1: CellRef } } | { ShouldContinueSquashLoop: { should_continue: CellRef } } | { GetNextDictKey: { next_key: CellRef } } | { AssertLeFindSmallArcs: { range_check_ptr: ResOperand ; a: ResOperand ; b: ResOperand } } | { AssertLeIsFirstArcExcluded: { skip_exclude_a_flag: CellRef } } | { AssertLeIsSecondArcExcluded: { skip_exclude_b_minus_a: CellRef } } | { RandomEcPoint: { x: CellRef ; y: CellRef } } | { FieldSqrt: { val: ResOperand ; sqrt: CellRef } } | { DebugPrint: { start: ResOperand ; end: ResOperand } } | { AllocConstantSize: { size: ResOperand ; dst: CellRef } } | { U256InvModN: { b0: ResOperand ; b1: ResOperand ; n0: ResOperand ; n1: ResOperand ; g0_or_no_inv: CellRef ; g1_option: CellRef ; s_or_r0: CellRef ; s_or_r1: CellRef ; t_or_k0: CellRef ; t_or_k1: CellRef } } | { EvalCircuit: { n_add_mods: ResOperand ; add_mod_builtin: ResOperand ; n_mul_mods: ResOperand ; mul_mod_builtin: ResOperand } }

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/executable.d.ts:76


STARKNET_HINT

Ƭ STARKNET_HINT: { SystemCall: { system: ResOperand } } | { Cheatcode: { selector: NUM_AS_HEX ; input_start: ResOperand ; input_end: ResOperand ; output_start: CellRef ; output_end: CellRef } }

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/executable.d.ts:263


IsPreConfirmed

Ƭ IsPreConfirmed<T>: Extract<T, { block_hash: never }>

Possible permutations of transaction. BLOCK TYPE TYPE OF TRANSACTION EXECUTION (Reverted or not) FINALITY (Rejected on not) Receipt do not have Rejected

Type parameters

Name
T

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/expansions/transactionReceipt.d.ts:8


IsInBlock

Ƭ IsInBlock<T>: T extends { block_hash: string ; block_number: number } ? T extends { block_hash: never } ? never : T : never

Type parameters

Name
T

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/expansions/transactionReceipt.d.ts:11


IsType

Ƭ IsType<T, ETransactionType>: Extract<T, { type: ETransactionType }>

Type parameters

Name
T
ETransactionType

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/expansions/transactionReceipt.d.ts:17


IsSucceeded

Ƭ IsSucceeded<T>: Extract<T, { execution_status: "SUCCEEDED" }>

Type parameters

Name
T

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/expansions/transactionReceipt.d.ts:20


IsReverted

Ƭ IsReverted<T>: Extract<T, { execution_status: "REVERTED" }>

Type parameters

Name
T

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/expansions/transactionReceipt.d.ts:23


Methods

Ƭ Methods: ReadMethods & WriteMethods & TraceMethods

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/methods.d.ts:6


WebSocketMethods

Ƭ WebSocketMethods: Object

Type declaration

NameTypeDescription
starknet_subscribeNewHeads{ params: { block_id?: SUBSCRIPTION_BLOCK_ID } ; result: SUBSCRIPTION_ID ; errors: TOO_MANY_BLOCKS_BACK | BLOCK_NOT_FOUND ; events: [NewHeadsEvent, ReorgEvent] }New block headers subscription. Creates a WebSocket stream which will fire events for new block headers.
starknet_subscribeNewHeads.params{ block_id?: SUBSCRIPTION_BLOCK_ID }-
starknet_subscribeNewHeads.params.block_id?SUBSCRIPTION_BLOCK_IDThe block to get notifications from, default is latest, limited to 1024 blocks back
starknet_subscribeNewHeads.resultSUBSCRIPTION_ID-
starknet_subscribeNewHeads.errorsTOO_MANY_BLOCKS_BACK | BLOCK_NOT_FOUND-
starknet_subscribeNewHeads.events[NewHeadsEvent, ReorgEvent]starknet_subscriptionNewHeads starknet_subscriptionReorg
starknet_subscribeEvents{ params: { from_address?: ADDRESS ; keys?: EVENT_KEYS ; block_id?: SUBSCRIPTION_BLOCK_ID ; finality_status?: Exclude<TXN_FINALITY_STATUS, STATUS_ACCEPTED_ON_L1> } ; result: SUBSCRIPTION_ID ; errors: TOO_MANY_KEYS_IN_FILTER | TOO_MANY_BLOCKS_BACK | BLOCK_NOT_FOUND ; events: [StarknetEventsEvent, ReorgEvent] }New events subscription. Creates a WebSocket stream which will fire events for new Starknet events from the specified block_id, up to the latest block.
starknet_subscribeEvents.params{ from_address?: ADDRESS ; keys?: EVENT_KEYS ; block_id?: SUBSCRIPTION_BLOCK_ID ; finality_status?: Exclude<TXN_FINALITY_STATUS, STATUS_ACCEPTED_ON_L1> }-
starknet_subscribeEvents.params.from_address?ADDRESSFilter events by from_address which emitted the event
starknet_subscribeEvents.params.keys?EVENT_KEYSThe keys to filter events by. If not provided, all events will be returned.
starknet_subscribeEvents.params.block_id?SUBSCRIPTION_BLOCK_IDThe block to get notifications from, default is latest, limited to 1024 blocks back
starknet_subscribeEvents.params.finality_status?Exclude<TXN_FINALITY_STATUS, STATUS_ACCEPTED_ON_L1>The finality status of the most recent events to include, default is ACCEPTED_ON_L2
starknet_subscribeEvents.resultSUBSCRIPTION_ID-
starknet_subscribeEvents.errorsTOO_MANY_KEYS_IN_FILTER | TOO_MANY_BLOCKS_BACK | BLOCK_NOT_FOUND-
starknet_subscribeEvents.events[StarknetEventsEvent, ReorgEvent]starknet_subscriptionEvents starknet_subscriptionReorg
starknet_subscribeTransactionStatus{ params: { transaction_hash: FELT } ; result: SUBSCRIPTION_ID ; events: [TransactionsStatusEvent, ReorgEvent] }New transaction status subscription. Creates a WebSocket stream which at first fires an event with the current known transaction status, followed by events for every transaction status update
starknet_subscribeTransactionStatus.params{ transaction_hash: FELT }-
starknet_subscribeTransactionStatus.params.transaction_hashFELT-
starknet_subscribeTransactionStatus.resultSUBSCRIPTION_ID-
starknet_subscribeTransactionStatus.events[TransactionsStatusEvent, ReorgEvent]starknet_subscriptionTransactionStatus starknet_subscriptionReorg
starknet_subscribeNewTransactionReceipts{ params: { finality_status?: Exclude<TXN_FINALITY_STATUS, STATUS_ACCEPTED_ON_L1>[] ; sender_address?: ADDRESS[] } ; result: SUBSCRIPTION_ID ; errors: TOO_MANY_ADDRESSES_IN_FILTER ; events: [NewTransactionReceiptsEvent, ReorgEvent] }Creates a WebSocket stream which will fire events when new transaction receipts are created. The endpoint receives a vector of finality statuses. An event is fired for each finality status update. It is possible for receipts for pre-confirmed transactions to be received multiple times, or not at all.
starknet_subscribeNewTransactionReceipts.params{ finality_status?: Exclude<TXN_FINALITY_STATUS, STATUS_ACCEPTED_ON_L1>[] ; sender_address?: ADDRESS[] }-
starknet_subscribeNewTransactionReceipts.params.finality_status?Exclude<TXN_FINALITY_STATUS, STATUS_ACCEPTED_ON_L1>[]A vector of finality statuses to receive updates for, default is [ACCEPTED_ON_L2]
starknet_subscribeNewTransactionReceipts.params.sender_address?ADDRESS[]Filter transaction receipts to only include transactions sent by the specified addresses
starknet_subscribeNewTransactionReceipts.resultSUBSCRIPTION_ID-
starknet_subscribeNewTransactionReceipts.errorsTOO_MANY_ADDRESSES_IN_FILTER-
starknet_subscribeNewTransactionReceipts.events[NewTransactionReceiptsEvent, ReorgEvent]starknet_subscriptionNewTransactionReceipts
starknet_subscribeNewTransactions{ params: { finality_status?: TXN_STATUS_WITHOUT_L1[] ; sender_address?: ADDRESS[] } ; result: SUBSCRIPTION_ID ; events: [NewTransactionEvent, ReorgEvent] }Creates a WebSocket stream which will fire events when new transaction are created. The endpoint receives a vector of finality statuses. An event is fired for each finality status update. It is possible for events for pre-confirmed and candidate transactions to be received multiple times, or not at all.
starknet_subscribeNewTransactions.params{ finality_status?: TXN_STATUS_WITHOUT_L1[] ; sender_address?: ADDRESS[] }-
starknet_subscribeNewTransactions.params.finality_status?TXN_STATUS_WITHOUT_L1[]A vector of finality statuses to receive updates for, default is [ACCEPTED_ON_L2]
starknet_subscribeNewTransactions.params.sender_address?ADDRESS[]Filter to only include transactions sent by the specified addresses
starknet_subscribeNewTransactions.resultSUBSCRIPTION_ID-
starknet_subscribeNewTransactions.events[NewTransactionEvent, ReorgEvent]starknet_subscriptionNewTransaction
starknet_unsubscribe{ params: { subscription_id: SUBSCRIPTION_ID } ; result: Boolean ; errors: INVALID_SUBSCRIPTION_ID }Close a previously opened ws stream, with the corresponding subscription id
starknet_unsubscribe.params{ subscription_id: SUBSCRIPTION_ID }-
starknet_unsubscribe.params.subscription_idSUBSCRIPTION_ID-
starknet_unsubscribe.resultBoolean-
starknet_unsubscribe.errorsINVALID_SUBSCRIPTION_ID-

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/methods.d.ts:281


ContractClass

Ƭ ContractClass: OneOf<[CONTRACT_CLASS, DEPRECATED_CONTRACT_CLASS]>

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:8


SimulateTransaction

Ƭ SimulateTransaction: Object

Type declaration

NameType
transaction_traceTRANSACTION_TRACE
fee_estimationFEE_ESTIMATE

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:9


SimulateTransactionResponse

Ƭ SimulateTransactionResponse: SimulateTransaction[]

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:13


FeeEstimate

Ƭ FeeEstimate: FEE_ESTIMATE

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:14


MessageFeeEstimate

Ƭ MessageFeeEstimate: MESSAGE_FEE_ESTIMATE

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:15


TransactionWithHash

Ƭ TransactionWithHash: TXN_WITH_HASH

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:16


BlockHashAndNumber

Ƭ BlockHashAndNumber: Object

Type declaration

NameType
block_hashBLOCK_HASH
block_numberBLOCK_NUMBER

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:17


BlockWithTxs

Ƭ BlockWithTxs: OneOf<[BLOCK_WITH_TXS, PRE_CONFIRMED_BLOCK_WITH_TXS]>

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:21


BlockWithTxHashes

Ƭ BlockWithTxHashes: OneOf<[BLOCK_WITH_TX_HASHES, PRE_CONFIRMED_BLOCK_WITH_TX_HASHES]>

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:22


BlockWithTxReceipts

Ƭ BlockWithTxReceipts: OneOf<[BLOCK_WITH_RECEIPTS, PRE_CONFIRMED_BLOCK_WITH_RECEIPTS]>

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:23


StateUpdate

Ƭ StateUpdate: OneOf<[STATE_UPDATE, PRE_CONFIRMED_STATE_UPDATE]>

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:24


BlockTransactionsTraces

Ƭ BlockTransactionsTraces: { transaction_hash: FELT ; trace_root: TRANSACTION_TRACE }[]

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:25


Syncing

Ƭ Syncing: false | SYNC_STATUS

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:29


Events

Ƭ Events: EVENTS_CHUNK

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:30


EmittedEvent

Ƭ EmittedEvent: EMITTED_EVENT

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:31


Event

Ƭ Event: EVENT

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:32


InvokedTransaction

Ƭ InvokedTransaction: Object

Type declaration

NameType
transaction_hashTXN_HASH

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:33


DeclaredTransaction

Ƭ DeclaredTransaction: Object

Type declaration

NameType
transaction_hashTXN_HASH
class_hashFELT

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:36


DeployedAccountTransaction

Ƭ DeployedAccountTransaction: Object

Type declaration

NameType
transaction_hashTXN_HASH
contract_addressFELT

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:40


L1L2MessagesStatus

Ƭ L1L2MessagesStatus: L1L2MessageStatus[]

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:44


StorageProof

Ƭ StorageProof: Object

Type declaration

NameType
classes_proofNODE_HASH_TO_NODE_MAPPING
contracts_proof{ nodes: NODE_HASH_TO_NODE_MAPPING ; contract_leaves_data: { nonce: FELT ; class_hash: FELT ; storage_root: FELT }[] }
contracts_proof.nodesNODE_HASH_TO_NODE_MAPPING
contracts_proof.contract_leaves_data{ nonce: FELT ; class_hash: FELT ; storage_root: FELT }[]
contracts_storage_proofsNODE_HASH_TO_NODE_MAPPING[]
global_roots{ contracts_tree_root: FELT ; classes_tree_root: FELT ; block_hash: FELT }
global_roots.contracts_tree_rootFELT
global_roots.classes_tree_rootFELT
global_roots.block_hashFELT

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:45


CompiledCasm

Ƭ CompiledCasm: CASM_COMPILED_CONTRACT_CLASS

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:71


ContractAddress

Ƭ ContractAddress: ADDRESS

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:72


Felt

Ƭ Felt: FELT

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:73


Nonce

Ƭ Nonce: FELT

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:74


TransactionHash

Ƭ TransactionHash: TXN_HASH

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:75


TransactionTrace

Ƭ TransactionTrace: TRANSACTION_TRACE

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:76


BlockHash

Ƭ BlockHash: BLOCK_HASH

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:77


TransactionReceipt

Ƭ TransactionReceipt: TXN_RECEIPT_WITH_BLOCK_INFO

All Type Transaction Receipt

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:81


TransactionReceiptProductionBlock

Ƭ TransactionReceiptProductionBlock: IsInBlock<TransactionReceipt>

All Type Transaction Receipt from production block

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:85


TransactionReceiptPreConfirmedBlock

Ƭ TransactionReceiptPreConfirmedBlock: IsPreConfirmed<TransactionReceipt>

All Type Transaction Receipt from pre confirmed block

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:89


EventFilter

Ƭ EventFilter: EVENT_FILTER & RESULT_PAGE_REQUEST

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:90


SimulationFlags

Ƭ SimulationFlags: SIMULATION_FLAG[]

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:91


L1Message

Ƭ L1Message: MSG_FROM_L1

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:92


BaseTransaction

Ƭ BaseTransaction: BROADCASTED_TXN

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:93


ChainId

Ƭ ChainId: CHAIN_ID

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:94


Transaction

Ƭ Transaction: TXN

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:95


TransactionStatus

Ƭ TransactionStatus: TXN_STATUS_RESULT

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:96


ResourceBounds

Ƭ ResourceBounds: RESOURCE_BOUNDS_MAPPING

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:97


FeePayment

Ƭ FeePayment: FEE_PAYMENT

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:98


PriceUnit

Ƭ PriceUnit: PRICE_UNIT

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:99


L1L2MessageStatus

Ƭ L1L2MessageStatus: Object

Ethereum l1_handler tx hash and status for L1 -> L2 messages sent by the l1 transaction

Type declaration

NameTypeDescription
transaction_hashTXN_HASHl1_handler tx hash
finality_statusTXN_FINALITY_STATUSfinality status of the L1 -> L2 messages sent by the l1 transaction
execution_statusTXN_EXECUTION_STATUSthe failure reason, only appears if finality_status is REJECTED
failure_reason?stringThe failure reason. Only appears if execution_status is REVERTED

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:103


StorageDiffs

Ƭ StorageDiffs: CONTRACT_STORAGE_DIFF_ITEM[]

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:121


DeprecatedDeclaredClasses

Ƭ DeprecatedDeclaredClasses: FELT[]

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:122


NonceUpdates

Ƭ NonceUpdates: NONCE_UPDATE[]

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:123


ReplacedClasses

Ƭ ReplacedClasses: REPLACED_CLASS[]

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/nonspec.d.ts:124

Variables

STATUS_ACCEPTED_ON_L2

STATUS_ACCEPTED_ON_L2: "ACCEPTED_ON_L2"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:4

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:5


STATUS_ACCEPTED_ON_L1

STATUS_ACCEPTED_ON_L1: "ACCEPTED_ON_L1"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:9

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:10


STATUS_SUCCEEDED

STATUS_SUCCEEDED: "SUCCEEDED"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:14

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:15


STATUS_REVERTED

STATUS_REVERTED: "REVERTED"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:19

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:20


STATUS_RECEIVED

STATUS_RECEIVED: "RECEIVED"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:24

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:25


STATUS_CANDIDATE

STATUS_CANDIDATE: "CANDIDATE"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:29

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:30


STATUS_PRE_CONFIRMED

STATUS_PRE_CONFIRMED: "PRE_CONFIRMED"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:34

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:35


STATUS_PRE_CONFIRMED_LOWERCASE

STATUS_PRE_CONFIRMED_LOWERCASE: "pre_confirmed"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:36

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:37


TXN_TYPE_DECLARE

TXN_TYPE_DECLARE: "DECLARE"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:38

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:39


TXN_TYPE_DEPLOY

TXN_TYPE_DEPLOY: "DEPLOY"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:40

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:41


TXN_TYPE_DEPLOY_ACCOUNT

TXN_TYPE_DEPLOY_ACCOUNT: "DEPLOY_ACCOUNT"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:42

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:43


TXN_TYPE_INVOKE

TXN_TYPE_INVOKE: "INVOKE"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:44

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:45


TXN_TYPE_L1_HANDLER

TXN_TYPE_L1_HANDLER: "L1_HANDLER"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:46

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:47


STRUCT_ABI_TYPE

STRUCT_ABI_TYPE: "struct"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:48

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:49


EVENT_ABI_TYPE

EVENT_ABI_TYPE: "event"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:50

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:51


ABI_TYPE_FUNCTION

ABI_TYPE_FUNCTION: "function"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:52

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:53


ABI_TYPE_CONSTRUCTOR

ABI_TYPE_CONSTRUCTOR: "constructor"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:54

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:55


ABI_TYPE_L1_HANDLER

ABI_TYPE_L1_HANDLER: "l1_handler"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:56

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:57


ABI_TYPE_ENUM

ABI_TYPE_ENUM: "enum"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:58

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:59


STATE_MUTABILITY_VIEW

STATE_MUTABILITY_VIEW: "view"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:60

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:61


STATE_MUTABILITY_EXTERNAL

STATE_MUTABILITY_EXTERNAL: "external"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:62

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:63


PRICE_UNIT_WEI

PRICE_UNIT_WEI: "WEI"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:64

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:65


PRICE_UNIT_FRI

PRICE_UNIT_FRI: "FRI"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:66

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:67


L1_DA_MODE

Const L1_DA_MODE: Object

Type declaration

NameType
BLOB"BLOB"
CALLDATA"CALLDATA"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:68

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:72


CALL_TYPE

Const CALL_TYPE: Object

Represents the type of a function call.

Type declaration

NameType
DELEGATE"DELEGATE"
LIBRARY_CALL"LIBRARY_CALL"
CALL"CALL"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:76

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:81


ETransactionType

Const ETransactionType: Object

Type declaration

NameType
DECLARE"DECLARE"
DEPLOY"DEPLOY"
DEPLOY_ACCOUNT"DEPLOY_ACCOUNT"
INVOKE"INVOKE"
L1_HANDLER"L1_HANDLER"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:82

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:89


ESimulationFlag

Const ESimulationFlag: Object

Type declaration

NameType
SKIP_VALIDATE"SKIP_VALIDATE"
SKIP_FEE_CHARGE"SKIP_FEE_CHARGE"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:90

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:94


ETransactionStatus

Const ETransactionStatus: Object

Type declaration

NameType
RECEIVED"RECEIVED"
CANDIDATE"CANDIDATE"
PRE_CONFIRMED"PRE_CONFIRMED"
ACCEPTED_ON_L2"ACCEPTED_ON_L2"
ACCEPTED_ON_L1"ACCEPTED_ON_L1"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:95

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:102


ETransactionFinalityStatus

Const ETransactionFinalityStatus: Object

Type declaration

NameType
PRE_CONFIRMED"PRE_CONFIRMED"
ACCEPTED_ON_L2"ACCEPTED_ON_L2"
ACCEPTED_ON_L1"ACCEPTED_ON_L1"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:103

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:108


ETransactionExecutionStatus

Const ETransactionExecutionStatus: Object

Type declaration

NameType
SUCCEEDED"SUCCEEDED"
REVERTED"REVERTED"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:109

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:113


EBlockTag

Const EBlockTag: Object

A tag specifying a dynamic reference to a block.

Type declaration

NameTypeDescription
LATEST"latest"Tag latest refers to the latest Starknet block finalized by the consensus on L2.
PRE_CONFIRMED"pre_confirmed"Tag pre_confirmed refers to the block which is currently being built by the block proposer in height latest + 1.
L1_ACCEPTED"l1_accepted"Tag l1_accepted refers to the latest Starknet block which was included in a state update on L1 and finalized by the consensus on L1.

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:118

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:132


EBlockStatus

Const EBlockStatus: Object

Type declaration

NameType
PRE_CONFIRMED"PRE_CONFIRMED"
ACCEPTED_ON_L2"ACCEPTED_ON_L2"
ACCEPTED_ON_L1"ACCEPTED_ON_L1"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:133

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:138


EDataAvailabilityMode

Const EDataAvailabilityMode: Object

Type declaration

NameType
L1"L1"
L2"L2"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:139

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:143


EDAMode

Const EDAMode: Object

Type declaration

NameType
L10
L21

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:144

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:148


ETransactionVersion

Const ETransactionVersion: Object

V Transaction versions HexString F Fee Transaction Versions HexString (2 ** 128 + TRANSACTION_VERSION)

Type declaration

NameTypeDescription
V0"0x0"Deprecated Starknet 0.14 will not support this transaction
V1"0x1"Deprecated Starknet 0.14 will not support this transaction
V2"0x2"Deprecated Starknet 0.14 will not support this transaction
V3"0x3"-
F0"0x100000000000000000000000000000000"Deprecated Starknet 0.14 will not support this transaction
F1"0x100000000000000000000000000000001"Deprecated Starknet 0.14 will not support this transaction
F2"0x100000000000000000000000000000002"Deprecated Starknet 0.14 will not support this transaction
F3"0x100000000000000000000000000000003"-

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:153

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:181


ETransactionVersion2

Const ETransactionVersion2: Object

Deprecated

Starknet 0.14 will not support this transaction

Type declaration

NameType
V0"0x0"
V1"0x1"
V2"0x2"
F0"0x100000000000000000000000000000000"
F1"0x100000000000000000000000000000001"
F2"0x100000000000000000000000000000002"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:188

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:199


ETransactionVersion3

Const ETransactionVersion3: Object

V3 Transaction Versions

Type declaration

NameType
V3"0x3"
F3"0x100000000000000000000000000000003"

Defined in

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:203

node_modules/@starknet-io/starknet-types-010/dist/types/api/constants.d.ts:207