Namespace: API
Namespaces​
Interfaces​
- FAILED_TO_RECEIVE_TXN
- NO_TRACE_AVAILABLE
- CONTRACT_NOT_FOUND
- ENTRYPOINT_NOT_FOUND
- INVALID_CALL_DATA
- BLOCK_NOT_FOUND
- INVALID_BLOCK_HASH
- INVALID_TXN_INDEX
- CLASS_HASH_NOT_FOUND
- TXN_HASH_NOT_FOUND
- PAGE_SIZE_TOO_BIG
- NO_BLOCKS
- INVALID_CONTINUATION_TOKEN
- TOO_MANY_KEYS_IN_FILTER
- CONTRACT_ERROR
- TRANSACTION_EXECUTION_ERROR
- STORAGE_PROOF_NOT_SUPPORTED
- CLASS_ALREADY_DECLARED
- INVALID_TRANSACTION_NONCE
- INSUFFICIENT_RESOURCES_FOR_VALIDATE
- INSUFFICIENT_ACCOUNT_BALANCE
- VALIDATION_FAILURE
- COMPILATION_FAILED
- CONTRACT_CLASS_SIZE_IS_TOO_LARGE
- NON_ACCOUNT
- DUPLICATE_TX
- COMPILED_CLASS_HASH_MISMATCH
- UNSUPPORTED_TX_VERSION
- UNSUPPORTED_CONTRACT_CLASS_VERSION
- UNEXPECTED_ERROR
- INVALID_SUBSCRIPTION_ID
- TOO_MANY_ADDRESSES_IN_FILTER
- TOO_MANY_BLOCKS_BACK
- COMPILATION_ERROR
Type Aliases​
Methods​
Ƭ Methods: ReadMethods & WriteMethods & TraceMethods
Defined in​
node_modules/starknet-types-08/dist/types/api/methods.d.ts:5
WebSocketMethods​
Ƭ WebSocketMethods: Object
Type declaration​
| Name | Type | Description |
|---|---|---|
starknet_subscribeNewHeads | { params: { block_id?: SUBSCRIPTION_BLOCK_ID } ; result: SUBSCRIPTION_ID ; errors: TOO_MANY_BLOCKS_BACK | BLOCK_NOT_FOUND ; events: ["starknet_subscriptionNewHeads", "starknet_subscriptionReorg"] } | 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_ID | The block to get notifications from, default is latest, limited to 1024 blocks back |
starknet_subscribeNewHeads.result | SUBSCRIPTION_ID | - |
starknet_subscribeNewHeads.errors | TOO_MANY_BLOCKS_BACK | BLOCK_NOT_FOUND | - |
starknet_subscribeNewHeads.events | ["starknet_subscriptionNewHeads", "starknet_subscriptionReorg"] | - |
starknet_subscribeEvents | { params: { from_address?: ADDRESS ; keys?: EVENT_KEYS ; block_id?: SUBSCRIPTION_BLOCK_ID } ; result: SUBSCRIPTION_ID ; errors: TOO_MANY_KEYS_IN_FILTER | TOO_MANY_BLOCKS_BACK | BLOCK_NOT_FOUND ; events: ["starknet_subscriptionEvents", "starknet_subscriptionReorg"] } | New events subscription. Creates a WebSocket stream which will fire events for new Starknet events with applied filters. |
starknet_subscribeEvents.params | { from_address?: ADDRESS ; keys?: EVENT_KEYS ; block_id?: SUBSCRIPTION_BLOCK_ID } | - |
starknet_subscribeEvents.params.from_address? | ADDRESS | Filter events by from_address which emitted the event |
starknet_subscribeEvents.params.keys? | EVENT_KEYS | - |
starknet_subscribeEvents.params.block_id? | SUBSCRIPTION_BLOCK_ID | The block to get notifications from, default is latest, limited to 1024 blocks back |
starknet_subscribeEvents.result | SUBSCRIPTION_ID | - |
starknet_subscribeEvents.errors | TOO_MANY_KEYS_IN_FILTER | TOO_MANY_BLOCKS_BACK | BLOCK_NOT_FOUND | - |
starknet_subscribeEvents.events | ["starknet_subscriptionEvents", "starknet_subscriptionReorg"] | - |
starknet_subscribeTransactionStatus | { params: { transaction_hash: FELT } ; result: SUBSCRIPTION_ID ; events: ["starknet_subscriptionTransactionStatus", "starknet_subscriptionReorg"] } | 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_hash | FELT | - |
starknet_subscribeTransactionStatus.result | SUBSCRIPTION_ID | - |
starknet_subscribeTransactionStatus.events | ["starknet_subscriptionTransactionStatus", "starknet_subscriptionReorg"] | - |
starknet_subscribePendingTransactions | { params: { transaction_details?: Boolean ; sender_address?: ADDRESS[] } ; result: SUBSCRIPTION_ID ; errors: TOO_MANY_ADDRESSES_IN_FILTER ; events: ["starknet_subscriptionPendingTransactions"] } | New Pending Transactions subscription. Creates a WebSocket stream which will fire events when a new pending transaction is added. While there is no mempool, this notifies of transactions in the pending block. |
starknet_subscribePendingTransactions.params | { transaction_details?: Boolean ; sender_address?: ADDRESS[] } | - |
starknet_subscribePendingTransactions.params.transaction_details? | Boolean | "Get all transaction details, and not only the hash. If not provided, only hash is returned. Default is false" |
starknet_subscribePendingTransactions.params.sender_address? | ADDRESS[] | Filter transactions to only receive notification from address list |
starknet_subscribePendingTransactions.result | SUBSCRIPTION_ID | - |
starknet_subscribePendingTransactions.errors | TOO_MANY_ADDRESSES_IN_FILTER | - |
starknet_subscribePendingTransactions.events | ["starknet_subscriptionPendingTransactions"] | - |
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_id | SUBSCRIPTION_ID | - |
starknet_unsubscribe.result | Boolean | - |
starknet_unsubscribe.errors | INVALID_SUBSCRIPTION_ID | - |
Defined in​
node_modules/starknet-types-08/dist/types/api/methods.d.ts:283
WebSocketEvents​
Ƭ WebSocketEvents: Object
Server -> Client events over WebSockets
Type declaration​
| Name | Type |
|---|---|
starknet_subscriptionReorg | SubscriptionReorgResponse |
starknet_subscriptionNewHeads | SubscriptionNewHeadsResponse |
starknet_subscriptionEvents | SubscriptionEventsResponse |
starknet_subscriptionTransactionStatus | SubscriptionTransactionsStatusResponse |
starknet_subscriptionPendingTransactions | SubscriptionPendingTransactionsResponse |
Defined in​
node_modules/starknet-types-08/dist/types/api/methods.d.ts:363
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-types-08/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-types-08/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-types-08/dist/types/api/components.d.ts:17
ADDRESS​
Ƭ ADDRESS: FELT
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:18
NUM_AS_HEX​
Ƭ NUM_AS_HEX: string
string representing an integer number in prefixed hexadecimal format
Example
"0x.."
Pattern
^0x[a-fA-F0-9]+$
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:24
u64​
Ƭ u64: string
64 bit 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-types-08/dist/types/api/components.d.ts:29
u128​
Ƭ u128: string
128 bit 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-types-08/dist/types/api/components.d.ts:34
SIGNATURE​
Ƭ SIGNATURE: FELT[]
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:35
BLOCK_NUMBER​
Ƭ BLOCK_NUMBER: number
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:36
BLOCK_HASH​
Ƭ BLOCK_HASH: FELT
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:37
TXN_HASH​
Ƭ TXN_HASH: FELT
The hash of an Starknet transaction
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:41
L1_TXN_HASH​
Ƭ L1_TXN_HASH: NUM_AS_HEX
The hash of an Ethereum transaction
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:45
CHAIN_ID​
Ƭ CHAIN_ID: NUM_AS_HEX
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:46
STATE_MUTABILITY​
Ƭ STATE_MUTABILITY: STATE_MUTABILITY_VIEW | STATE_MUTABILITY_EXTERNAL
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:47
FUNCTION_ABI_TYPE​
Ƭ FUNCTION_ABI_TYPE: ABI_TYPE_FUNCTION | ABI_TYPE_L1_HANDLER | ABI_TYPE_CONSTRUCTOR
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:48
ABI_NAME_AND_TYPE​
Ƭ ABI_NAME_AND_TYPE: Object
common definition
Type declaration​
| Name | Type |
|---|---|
name | string |
type | string |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:52
ABI_TYPE​
Ƭ ABI_TYPE: Object
common outputs
Type declaration​
| Name | Type |
|---|---|
type | string |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:59
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-types-08/dist/types/api/components.d.ts:65
TXN_STATUS​
Ƭ TXN_STATUS: STATUS_RECEIVED | STATUS_REJECTED | 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-types-08/dist/types/api/components.d.ts:69
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-types-08/dist/types/api/components.d.ts:73
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-types-08/dist/types/api/components.d.ts:78
TXN_TYPE​
Ƭ TXN_TYPE: TXN_TYPE_DECLARE | TXN_TYPE_DEPLOY | TXN_TYPE_DEPLOY_ACCOUNT | TXN_TYPE_INVOKE | Uppercase<ABI_TYPE_L1_HANDLER>
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:79
TXN_FINALITY_STATUS​
Ƭ TXN_FINALITY_STATUS: STATUS_ACCEPTED_ON_L2 | STATUS_ACCEPTED_ON_L1
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:80
TXN_EXECUTION_STATUS​
Ƭ TXN_EXECUTION_STATUS: STATUS_SUCCEEDED | STATUS_REVERTED
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:81
BLOCK_STATUS​
Ƭ BLOCK_STATUS: STATUS_PENDING | STATUS_ACCEPTED_ON_L2 | STATUS_ACCEPTED_ON_L1 | STATUS_REJECTED
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:82
BLOCK_SELECTOR​
Ƭ BLOCK_SELECTOR: SimpleOneOf<{ block_hash: BLOCK_HASH }, { block_number: BLOCK_NUMBER }>
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:83
BLOCK_TAG​
Ƭ BLOCK_TAG: EBlockTag
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:88
SUBSCRIPTION_BLOCK_TAG​
Ƭ SUBSCRIPTION_BLOCK_TAG: "latest"
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:89
SUBSCRIPTION_ID​
Ƭ SUBSCRIPTION_ID: number
An identifier for this subscription stream used to associate events with this subscription. Integer
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:94
NEW_TXN_STATUS​
Ƭ NEW_TXN_STATUS: Object
Type declaration​
| Name | Type |
|---|---|
transaction_hash | TXN_HASH |
status | TXN_STATUS_RESULT |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:95
REORG_DATA​
Ƭ REORG_DATA: Object
Data about reorganized blocks, starting and ending block number and hash
Type declaration​
| Name | Type | Description |
|---|---|---|
starting_block_hash | BLOCK_HASH | Hash of the first known block of the orphaned chain |
starting_block_number | BLOCK_NUMBER | Number of the first known block of the orphaned chain |
ending_block_hash | BLOCK_HASH | The last known block of the orphaned chain |
ending_block_number | BLOCK_NUMBER | Number of the last known block of the orphaned chain |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:102
SubscriptionNewHeadsResponse​
Ƭ SubscriptionNewHeadsResponse: Object
Type declaration​
| Name | Type |
|---|---|
subscription_id | SUBSCRIPTION_ID |
result | BLOCK_HEADER |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:120
SubscriptionEventsResponse​
Ƭ SubscriptionEventsResponse: Object
Type declaration​
| Name | Type |
|---|---|
subscription_id | SUBSCRIPTION_ID |
result | EMITTED_EVENT |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:124
SubscriptionTransactionsStatusResponse​
Ƭ SubscriptionTransactionsStatusResponse: Object
Type declaration​
| Name | Type |
|---|---|
subscription_id | SUBSCRIPTION_ID |
result | NEW_TXN_STATUS |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:128
SubscriptionPendingTransactionsResponse​
Ƭ SubscriptionPendingTransactionsResponse: Object
Type declaration​
| Name | Type |
|---|---|
subscription_id | SUBSCRIPTION_ID |
result | TXN_HASH | TXN_WITH_HASH |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:132
SubscriptionReorgResponse​
Ƭ SubscriptionReorgResponse: Object
Type declaration​
| Name | Type |
|---|---|
subscription_id | SUBSCRIPTION_ID |
result | REORG_DATA |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:136
EVENTS_CHUNK​
Ƭ EVENTS_CHUNK: Object
Type declaration​
| Name | Type | Description |
|---|---|---|
events | EMITTED_EVENT[] | Returns matching events |
continuation_token? | string | Use 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-types-08/dist/types/api/components.d.ts:140
RESULT_PAGE_REQUEST​
Ƭ RESULT_PAGE_REQUEST: Object
Type declaration​
| Name | Type | Description |
|---|---|---|
continuation_token? | string | The token returned from the previous query. If no token is provided the first page is returned. |
chunk_size | number | Chunk size |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:150
EMITTED_EVENT​
Ƭ EMITTED_EVENT: EVENT & { block_hash: BLOCK_HASH ; block_number: BLOCK_NUMBER ; transaction_hash: TXN_HASH }
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:160
EVENT​
Ƭ EVENT: { from_address: ADDRESS } & EVENT_CONTENT
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:165
EVENT_CONTENT​
Ƭ EVENT_CONTENT: Object
Type declaration​
| Name | Type |
|---|---|
keys | FELT[] |
data | FELT[] |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:168
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-types-08/dist/types/api/components.d.ts:176
EVENT_FILTER​
Ƭ EVENT_FILTER: Object
Type declaration​
| Name | Type |
|---|---|
from_block? | BLOCK_ID |
to_block? | BLOCK_ID |
address? | ADDRESS |
keys? | EVENT_KEYS |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:177
BLOCK_ID​
Ƭ BLOCK_ID: BLOCK_SELECTOR | BLOCK_TAG
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:183
SUBSCRIPTION_BLOCK_ID​
Ƭ SUBSCRIPTION_BLOCK_ID: BLOCK_SELECTOR | SUBSCRIPTION_BLOCK_TAG
same as BLOCK_ID, but without 'pending'
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:187
SYNC_STATUS​
Ƭ SYNC_STATUS: Object
Type declaration​
| Name | Type |
|---|---|
starting_block_hash | BLOCK_HASH |
starting_block_num | BLOCK_NUMBER |
current_block_hash | BLOCK_HASH |
current_block_num | BLOCK_NUMBER |
highest_block_hash | BLOCK_HASH |
highest_block_num | BLOCK_NUMBER |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:188
NEW_CLASSES​
Ƭ NEW_CLASSES: Object
Type declaration​
| Name | Type |
|---|---|
class_hash | FELT |
compiled_class_hash | FELT |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:196
REPLACED_CLASS​
Ƭ REPLACED_CLASS: Object
Type declaration​
| Name | Type |
|---|---|
class_hash | FELT |
contract_address | FELT |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:200
NONCE_UPDATE​
Ƭ NONCE_UPDATE: Object
Type declaration​
| Name | Type |
|---|---|
contract_address | ADDRESS |
nonce | FELT |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:204
STATE_DIFF​
Ƭ STATE_DIFF: Object
Type declaration​
| Name | Type |
|---|---|
storage_diffs | CONTRACT_STORAGE_DIFF_ITEM[] |
deprecated_declared_classes | FELT[] |
declared_classes | NEW_CLASSES[] |
deployed_contracts | DEPLOYED_CONTRACT_ITEM[] |
replaced_classes | REPLACED_CLASS[] |
nonces | NONCE_UPDATE[] |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:208
PENDING_STATE_UPDATE​
Ƭ PENDING_STATE_UPDATE: Object
Type declaration​
| Name | Type |
|---|---|
old_root | FELT |
state_diff | STATE_DIFF |
block_hash | never |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:216
STATE_UPDATE​
Ƭ STATE_UPDATE: Object
Type declaration​
| Name | Type |
|---|---|
block_hash | BLOCK_HASH |
old_root | FELT |
new_root | FELT |
state_diff | STATE_DIFF |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:221
BLOCK_BODY_WITH_TX_HASHES​
Ƭ BLOCK_BODY_WITH_TX_HASHES: Object
Type declaration​
| Name | Type |
|---|---|
transactions | TXN_HASH[] |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:227
BLOCK_BODY_WITH_TXS​
Ƭ BLOCK_BODY_WITH_TXS: Object
Type declaration​
| Name | Type |
|---|---|
transactions | TXN_WITH_HASH[] |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:230
BLOCK_BODY_WITH_RECEIPTS​
Ƭ BLOCK_BODY_WITH_RECEIPTS: Object
Type declaration​
| Name | Type |
|---|---|
transactions | { transaction: TXN ; receipt: TXN_RECEIPT }[] |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:233
BLOCK_HEADER​
Ƭ BLOCK_HEADER: Object
Type declaration​
| Name | Type |
|---|---|
block_hash | BLOCK_HASH |
parent_hash | BLOCK_HASH |
block_number | BLOCK_NUMBER |
new_root | FELT |
timestamp | number |
sequencer_address | FELT |
l1_gas_price | RESOURCE_PRICE |
l2_gas_price | RESOURCE_PRICE |
l1_data_gas_price | RESOURCE_PRICE |
l1_da_mode | L1_DA_MODE |
starknet_version | string |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:239
PENDING_BLOCK_HEADER​
Ƭ PENDING_BLOCK_HEADER: Object
Type declaration​
| Name | Type |
|---|---|
parent_hash | BLOCK_HASH |
timestamp | number |
sequencer_address | FELT |
l1_gas_price | RESOURCE_PRICE |
l2_gas_price | RESOURCE_PRICE |
l1_data_gas_price | RESOURCE_PRICE |
l1_da_mode | L1_DA_MODE |
starknet_version | string |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:252
BLOCK_WITH_TX_HASHES​
Ƭ BLOCK_WITH_TX_HASHES: { status: BLOCK_STATUS } & BLOCK_HEADER & BLOCK_BODY_WITH_TX_HASHES
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:262
BLOCK_WITH_TXS​
Ƭ BLOCK_WITH_TXS: { status: BLOCK_STATUS } & BLOCK_HEADER & BLOCK_BODY_WITH_TXS
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:265
BLOCK_WITH_RECEIPTS​
Ƭ BLOCK_WITH_RECEIPTS: { status: BLOCK_STATUS } & BLOCK_HEADER & BLOCK_BODY_WITH_RECEIPTS
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:268
PENDING_BLOCK_WITH_TX_HASHES​
Ƭ PENDING_BLOCK_WITH_TX_HASHES: BLOCK_BODY_WITH_TX_HASHES & PENDING_BLOCK_HEADER
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:271
PENDING_BLOCK_WITH_TXS​
Ƭ PENDING_BLOCK_WITH_TXS: BLOCK_BODY_WITH_TXS & PENDING_BLOCK_HEADER
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:272
PENDING_BLOCK_WITH_RECEIPTS​
Ƭ PENDING_BLOCK_WITH_RECEIPTS: BLOCK_BODY_WITH_RECEIPTS & PENDING_BLOCK_HEADER
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:273
DEPLOYED_CONTRACT_ITEM​
Ƭ DEPLOYED_CONTRACT_ITEM: Object
Type declaration​
| Name | Type |
|---|---|
address | FELT |
class_hash | FELT |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:274
CONTRACT_STORAGE_DIFF_ITEM​
Ƭ CONTRACT_STORAGE_DIFF_ITEM: Object
Type declaration​
| Name | Type | Description |
|---|---|---|
address | FELT | The contract address for which the storage changed |
storage_entries | StorageDiffItem[] | The changes in the storage of the contract |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:278
StorageDiffItem​
Ƭ StorageDiffItem: Object
Type declaration​
| Name | Type | Description |
|---|---|---|
key | FELT | The key of the changed value |
value | FELT | The new value applied to the given address |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:288
TXN​
Ƭ TXN: INVOKE_TXN | L1_HANDLER_TXN | DECLARE_TXN | DEPLOY_TXN | DEPLOY_ACCOUNT_TXN
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:298
TXN_WITH_HASH​
Ƭ TXN_WITH_HASH: TXN & { transaction_hash: TXN_HASH }
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:299
DECLARE_TXN​
Ƭ DECLARE_TXN: DECLARE_TXN_V0 | DECLARE_TXN_V1 | DECLARE_TXN_V2 | DECLARE_TXN_V3
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:302
DECLARE_TXN_V0​
Ƭ DECLARE_TXN_V0: Object
Deprecated
Starknet 0.14 will not support this transaction
Type declaration​
| Name | Type |
|---|---|
type | TXN_TYPE_DECLARE |
sender_address | ADDRESS |
max_fee | FELT |
version | typeof V0 | typeof F0 |
signature | SIGNATURE |
class_hash | FELT |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:306
DECLARE_TXN_V1​
Ƭ DECLARE_TXN_V1: Object
Deprecated
Starknet 0.14 will not support this transaction
Type declaration​
| Name | Type |
|---|---|
type | TXN_TYPE_DECLARE |
sender_address | ADDRESS |
max_fee | FELT |
version | typeof V1 | typeof F1 |
signature | SIGNATURE |
nonce | FELT |
class_hash | FELT |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:317
DECLARE_TXN_V2​
Ƭ DECLARE_TXN_V2: Object
Deprecated
Starknet 0.14 will not support this transaction
Type declaration​
| Name | Type |
|---|---|
type | TXN_TYPE_DECLARE |
sender_address | ADDRESS |
compiled_class_hash | FELT |
max_fee | FELT |
version | typeof V2 | typeof F2 |
signature | SIGNATURE |
nonce | FELT |
class_hash | FELT |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:329
DECLARE_TXN_V3​
Ƭ DECLARE_TXN_V3: Object
Type declaration​
| Name | Type |
|---|---|
type | TXN_TYPE_DECLARE |
sender_address | ADDRESS |
compiled_class_hash | FELT |
version | typeof V3 | typeof F3 |
signature | SIGNATURE |
nonce | FELT |
class_hash | FELT |
resource_bounds | RESOURCE_BOUNDS_MAPPING |
tip | u64 |
paymaster_data | FELT[] |
account_deployment_data | FELT[] |
nonce_data_availability_mode | DA_MODE |
fee_data_availability_mode | DA_MODE |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:339
BROADCASTED_TXN​
Ƭ BROADCASTED_TXN: BROADCASTED_INVOKE_TXN | BROADCASTED_DECLARE_TXN | BROADCASTED_DEPLOY_ACCOUNT_TXN
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:354
BROADCASTED_INVOKE_TXN​
Ƭ BROADCASTED_INVOKE_TXN: INVOKE_TXN_V3
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:355
BROADCASTED_DEPLOY_ACCOUNT_TXN​
Ƭ BROADCASTED_DEPLOY_ACCOUNT_TXN: DEPLOY_ACCOUNT_TXN_V3
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:356
BROADCASTED_DECLARE_TXN​
Ƭ BROADCASTED_DECLARE_TXN: BROADCASTED_DECLARE_TXN_V3
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:357
BROADCASTED_DECLARE_TXN_V3​
Ƭ BROADCASTED_DECLARE_TXN_V3: Object
Type declaration​
| Name | Type |
|---|---|
type | TXN_TYPE_DECLARE |
sender_address | ADDRESS |
compiled_class_hash | FELT |
version | typeof V3 | typeof F3 |
signature | SIGNATURE |
nonce | FELT |
contract_class | CONTRACT_CLASS |
resource_bounds | RESOURCE_BOUNDS_MAPPING |
tip | u64 |
paymaster_data | FELT[] |
account_deployment_data | FELT[] |
nonce_data_availability_mode | DA_MODE |
fee_data_availability_mode | DA_MODE |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:358
DEPLOY_ACCOUNT_TXN​
Ƭ DEPLOY_ACCOUNT_TXN: DEPLOY_ACCOUNT_TXN_V1 | DEPLOY_ACCOUNT_TXN_V3
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:373
DEPLOY_ACCOUNT_TXN_V1​
Ƭ DEPLOY_ACCOUNT_TXN_V1: Object
Deprecated
Starknet 0.14 will not support this transaction
Type declaration​
| Name | Type |
|---|---|
type | TXN_TYPE_DEPLOY_ACCOUNT |
max_fee | FELT |
version | typeof V1 | typeof F1 |
signature | SIGNATURE |
nonce | FELT |
contract_address_salt | FELT |
constructor_calldata | FELT[] |
class_hash | FELT |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:377
DEPLOY_ACCOUNT_TXN_V3​
Ƭ DEPLOY_ACCOUNT_TXN_V3: Object
Type declaration​
| Name | Type |
|---|---|
type | TXN_TYPE_DEPLOY_ACCOUNT |
version | typeof V3 | typeof F3 |
signature | SIGNATURE |
nonce | FELT |
contract_address_salt | FELT |
constructor_calldata | FELT[] |
class_hash | FELT |
resource_bounds | RESOURCE_BOUNDS_MAPPING |
tip | u64 |
paymaster_data | FELT[] |
nonce_data_availability_mode | DA_MODE |
fee_data_availability_mode | DA_MODE |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:387
DEPLOY_TXN​
Ƭ DEPLOY_TXN: Object
Type declaration​
| Name | Type |
|---|---|
type | TXN_TYPE_DEPLOY |
version | FELT |
contract_address_salt | FELT |
constructor_calldata | FELT[] |
class_hash | FELT |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:401
INVOKE_TXN​
Ƭ INVOKE_TXN: INVOKE_TXN_V0 | INVOKE_TXN_V1 | INVOKE_TXN_V3
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:408
INVOKE_TXN_V0​
Ƭ INVOKE_TXN_V0: Object
Deprecated
Starknet 0.14 will not support this transaction
Type declaration​
| Name | Type |
|---|---|
type | TXN_TYPE_INVOKE |
max_fee | FELT |
version | typeof V0 | typeof F0 |
signature | SIGNATURE |
contract_address | ADDRESS |
entry_point_selector | FELT |
calldata | FELT[] |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:412
INVOKE_TXN_V1​
Ƭ INVOKE_TXN_V1: Object
Deprecated
Starknet 0.14 will not support this transaction
Type declaration​
| Name | Type |
|---|---|
type | TXN_TYPE_INVOKE |
sender_address | ADDRESS |
calldata | FELT[] |
max_fee | FELT |
version | typeof V1 | typeof F1 |
signature | SIGNATURE |
nonce | FELT |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:424
INVOKE_TXN_V3​
Ƭ INVOKE_TXN_V3: Object
Type declaration​
| Name | Type |
|---|---|
type | TXN_TYPE_INVOKE |
sender_address | ADDRESS |
calldata | FELT[] |
version | typeof V3 | typeof F3 |
signature | SIGNATURE |
nonce | FELT |
resource_bounds | RESOURCE_BOUNDS_MAPPING |
tip | u64 |
paymaster_data | FELT[] |
account_deployment_data | FELT[] |
nonce_data_availability_mode | DA_MODE |
fee_data_availability_mode | DA_MODE |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:433
L1_HANDLER_TXN​
Ƭ L1_HANDLER_TXN: { version: typeof V0 ; type: Uppercase<ABI_TYPE_L1_HANDLER> ; nonce: NUM_AS_HEX } & FUNCTION_CALL
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:447
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>
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:452
INVOKE_TXN_RECEIPT​
Ƭ INVOKE_TXN_RECEIPT: { type: TXN_TYPE_INVOKE } & COMMON_RECEIPT_PROPERTIES
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:467
DECLARE_TXN_RECEIPT​
Ƭ DECLARE_TXN_RECEIPT: { type: TXN_TYPE_DECLARE } & COMMON_RECEIPT_PROPERTIES
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:470
DEPLOY_ACCOUNT_TXN_RECEIPT​
Ƭ DEPLOY_ACCOUNT_TXN_RECEIPT: { type: TXN_TYPE_DEPLOY_ACCOUNT ; contract_address: FELT } & COMMON_RECEIPT_PROPERTIES
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:473
DEPLOY_TXN_RECEIPT​
Ƭ DEPLOY_TXN_RECEIPT: { type: TXN_TYPE_DEPLOY ; contract_address: FELT } & COMMON_RECEIPT_PROPERTIES
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:477
L1_HANDLER_TXN_RECEIPT​
Ƭ L1_HANDLER_TXN_RECEIPT: { type: Uppercase<ABI_TYPE_L1_HANDLER> ; message_hash: NUM_AS_HEX } & COMMON_RECEIPT_PROPERTIES
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:481
TXN_RECEIPT​
Ƭ TXN_RECEIPT: INVOKE_TXN_RECEIPT | L1_HANDLER_TXN_RECEIPT | DECLARE_TXN_RECEIPT | DEPLOY_TXN_RECEIPT | DEPLOY_ACCOUNT_TXN_RECEIPT
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:485
TXN_RECEIPT_WITH_BLOCK_INFO​
Ƭ TXN_RECEIPT_WITH_BLOCK_INFO: TXN_RECEIPT & { block_hash: BLOCK_HASH ; block_number: BLOCK_NUMBER } | { block_hash: never ; block_number: never }
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:486
MSG_TO_L1​
Ƭ MSG_TO_L1: Object
Type declaration​
| Name | Type |
|---|---|
from_address | FELT |
to_address | FELT |
payload | FELT[] |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:505
MSG_FROM_L1​
Ƭ MSG_FROM_L1: Object
Type declaration​
| Name | Type |
|---|---|
from_address | ETH_ADDRESS |
to_address | ADDRESS |
entry_point_selector | FELT |
payload | FELT[] |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:510
FUNCTION_CALL​
Ƭ FUNCTION_CALL: Object
Type declaration​
| Name | Type |
|---|---|
contract_address | ADDRESS |
entry_point_selector | FELT |
calldata | FELT[] |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:516
CONTRACT_CLASS​
Ƭ CONTRACT_CLASS: Object
Type declaration​
| Name | Type |
|---|---|
sierra_program | FELT[] |
contract_class_version | string |
entry_points_by_type | { CONSTRUCTOR: SIERRA_ENTRY_POINT[] ; EXTERNAL: SIERRA_ENTRY_POINT[] ; L1_HANDLER: SIERRA_ENTRY_POINT[] } |
entry_points_by_type.CONSTRUCTOR | SIERRA_ENTRY_POINT[] |
entry_points_by_type.EXTERNAL | SIERRA_ENTRY_POINT[] |
entry_points_by_type.L1_HANDLER | SIERRA_ENTRY_POINT[] |
abi | string |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:521
DEPRECATED_CONTRACT_CLASS​
Ƭ DEPRECATED_CONTRACT_CLASS: Object
Type declaration​
| Name | Type |
|---|---|
program | string |
entry_points_by_type | { CONSTRUCTOR: DEPRECATED_CAIRO_ENTRY_POINT[] ; EXTERNAL: DEPRECATED_CAIRO_ENTRY_POINT[] ; L1_HANDLER: DEPRECATED_CAIRO_ENTRY_POINT[] } |
entry_points_by_type.CONSTRUCTOR | DEPRECATED_CAIRO_ENTRY_POINT[] |
entry_points_by_type.EXTERNAL | DEPRECATED_CAIRO_ENTRY_POINT[] |
entry_points_by_type.L1_HANDLER | DEPRECATED_CAIRO_ENTRY_POINT[] |
abi | CONTRACT_ABI |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:531
DEPRECATED_CAIRO_ENTRY_POINT​
Ƭ DEPRECATED_CAIRO_ENTRY_POINT: Object
Type declaration​
| Name | Type | Description |
|---|---|---|
offset | NUM_AS_HEX | "The offset of the entry point in the program" |
selector | FELT | A unique identifier of the entry point (function) in the program |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:540
SIERRA_ENTRY_POINT​
Ƭ SIERRA_ENTRY_POINT: Object
Type declaration​
| Name | Type |
|---|---|
selector | FELT |
function_idx | number |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:550
CONTRACT_ABI​
Ƭ CONTRACT_ABI: readonly CONTRACT_ABI_ENTRY[]
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:554
CONTRACT_ABI_ENTRY​
Ƭ CONTRACT_ABI_ENTRY: FUNCTION_ABI_ENTRY | EVENT_ABI_ENTRY | STRUCT_ABI_ENTRY
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:555
STRUCT_ABI_ENTRY​
Ƭ STRUCT_ABI_ENTRY: Object
Type declaration​
| Name | Type | Description |
|---|---|---|
type | STRUCT_ABI_TYPE | Struct ABI type |
name | string | Struct name |
size | number | - |
members | STRUCT_MEMBER[] | - |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:556
STRUCT_MEMBER​
Ƭ STRUCT_MEMBER: TYPED_PARAMETER & { offset: number }
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:568
EVENT_ABI_ENTRY​
Ƭ EVENT_ABI_ENTRY: Object
Type declaration​
| Name | Type | Description |
|---|---|---|
type | EVENT_ABI_TYPE | Event ABI type |
name | string | Event name |
keys | TYPED_PARAMETER[] | - |
data | TYPED_PARAMETER[] | - |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:574
FUNCTION_STATE_MUTABILITY​
Ƭ FUNCTION_STATE_MUTABILITY: STATE_MUTABILITY_VIEW
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:586
FUNCTION_ABI_ENTRY​
Ƭ FUNCTION_ABI_ENTRY: Object
Type declaration​
| Name | Type | Description |
|---|---|---|
type | FUNCTION_ABI_TYPE | Function ABI type |
name | string | Function name |
inputs | TYPED_PARAMETER[] | Typed parameter |
outputs | TYPED_PARAMETER[] | Typed parameter |
stateMutability? | FUNCTION_STATE_MUTABILITY | Function state mutability |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:587
TYPED_PARAMETER​
Ƭ TYPED_PARAMETER: Object
Type declaration​
| Name | Type | Description |
|---|---|---|
name | string | Parameter name |
type | string | Parameter type |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:609
SIMULATION_FLAG_FOR_ESTIMATE_FEE​
Ƭ SIMULATION_FLAG_FOR_ESTIMATE_FEE: typeof SKIP_VALIDATE
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:619
PRICE_UNIT​
Ƭ PRICE_UNIT: PRICE_UNIT_WEI | PRICE_UNIT_FRI
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:620
FEE_ESTIMATE​
Ƭ FEE_ESTIMATE: Object
Type declaration​
| Name | Type | Description |
|---|---|---|
l1_gas_consumed | FELT | The 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_price | FELT | The gas price (in wei or fri, depending on the tx version) that was used in the cost estimation. Prev. name gas_price |
l2_gas_consumed | FELT | The L2 gas consumption of the transaction. |
l2_gas_price | FELT | The L2 gas price (in wei or fri, depending on the tx version) that was used in the cost estimation. |
l1_data_gas_consumed | FELT | The Ethereum data gas consumption of the transaction. Prev. name data_gas_consumed |
l1_data_gas_price | FELT | The 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_fee | FELT | - |
unit | PRICE_UNIT | - |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:621
FEE_PAYMENT​
Ƭ FEE_PAYMENT: Object
Type declaration​
| Name | Type |
|---|---|
amount | FELT |
unit | PRICE_UNIT |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:653
RESOURCE_BOUNDS_MAPPING​
Ƭ RESOURCE_BOUNDS_MAPPING: Object
Type declaration​
| Name | Type | Description |
|---|---|---|
l1_gas | RESOURCE_BOUNDS | The max amount and max price per unit of L1 gas used in this tx |
l1_data_gas | RESOURCE_BOUNDS | The max amount and max price per unit of L1 blob gas used in this tx |
l2_gas | RESOURCE_BOUNDS | The max amount and max price per unit of L2 gas used in this tx |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:657
RESOURCE_BOUNDS​
Ƭ RESOURCE_BOUNDS: Object
Type declaration​
| Name | Type |
|---|---|
max_amount | u64 |
max_price_per_unit | u128 |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:671
RESOURCE_PRICE​
Ƭ RESOURCE_PRICE: Object
Type declaration​
| Name | Type |
|---|---|
price_in_fri | FELT |
price_in_wei | FELT |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:675
EXECUTION_RESOURCES​
Ƭ EXECUTION_RESOURCES: Object
the resources consumed by the transaction
Type declaration​
| Name | Type | Description |
|---|---|---|
l1_gas | number | l1 gas consumed by this transaction, used for l2-->l1 messages and state updates if blobs are not used. integer |
l1_data_gas | number | data gas consumed by this transaction, 0 if blobs are not used integer |
l2_gas | number | l2 gas consumed by this transaction, used for computation and calldata Integer |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:682
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-types-08/dist/types/api/components.d.ts:702
BINARY_NODE​
Ƭ BINARY_NODE: Object
an internal node whose both children are non-zero
Type declaration​
| Name | Type | Description |
|---|---|---|
left | FELT | the hash of the left child |
right | FELT | the hash of the right child |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:706
EDGE_NODE​
Ƭ EDGE_NODE: Object
represents a path to the highest non-zero descendant node
Type declaration​
| Name | Type | Description |
|---|---|---|
path | NUM_AS_HEX | an integer whose binary representation represents the path from the current node to its highest non-zero descendant (bounded by 2^251) |
length | number | the length of the path (bounded by 251) |
child | FELT | the hash of the unique non-zero maximal-height descendant node |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:719
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-types-08/dist/types/api/components.d.ts:736
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-types-08/dist/types/api/components.d.ts:744
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-types-08/dist/types/api/components.d.ts:749
TRANSACTION_TRACE​
Ƭ TRANSACTION_TRACE: INVOKE_TXN_TRACE | DECLARE_TXN_TRACE | DEPLOY_ACCOUNT_TXN_TRACE | L1_HANDLER_TXN_TRACE
Represents a transaction trace including the execution details.
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:758
INVOKE_TXN_TRACE​
Ƭ INVOKE_TXN_TRACE: Object
Represents a transaction trace for an invoke transaction.
Type declaration​
| Name | Type |
|---|---|
type | TXN_TYPE_INVOKE |
execute_invocation | SimpleOneOf<FUNCTION_INVOCATION, { revert_reason: string }> |
validate_invocation? | FUNCTION_INVOCATION |
fee_transfer_invocation? | FUNCTION_INVOCATION |
state_diff? | STATE_DIFF |
execution_resources | EXECUTION_RESOURCES |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:762
DECLARE_TXN_TRACE​
Ƭ DECLARE_TXN_TRACE: Object
Represents a transaction trace for a declare transaction.
Type declaration​
| Name | Type |
|---|---|
type | TXN_TYPE_DECLARE |
validate_invocation? | FUNCTION_INVOCATION |
fee_transfer_invocation? | FUNCTION_INVOCATION |
state_diff? | STATE_DIFF |
execution_resources | EXECUTION_RESOURCES |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:775
DEPLOY_ACCOUNT_TXN_TRACE​
Ƭ DEPLOY_ACCOUNT_TXN_TRACE: Object
Represents a transaction trace for a deploy account transaction.
Type declaration​
| Name | Type |
|---|---|
type | TXN_TYPE_DEPLOY_ACCOUNT |
constructor_invocation | FUNCTION_INVOCATION |
validate_invocation? | FUNCTION_INVOCATION |
fee_transfer_invocation? | FUNCTION_INVOCATION |
state_diff? | STATE_DIFF |
execution_resources | EXECUTION_RESOURCES |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:785
L1_HANDLER_TXN_TRACE​
Ƭ L1_HANDLER_TXN_TRACE: Object
Represents a transaction trace for an L1 handler transaction.
Type declaration​
| Name | Type |
|---|---|
type | Uppercase<ABI_TYPE_L1_HANDLER> |
function_invocation | FUNCTION_INVOCATION |
state_diff? | STATE_DIFF |
execution_resources | EXECUTION_RESOURCES |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:796
NESTED_CALL​
Ƭ NESTED_CALL: FUNCTION_INVOCATION
Represents a nested function call.
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:805
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-types-08/dist/types/api/components.d.ts:809
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​
| Name | Type | Description |
|---|---|---|
l1_gas | number | l1 gas consumed by this transaction, used for l2-->l1 messages and state updates if blobs are not used |
l2_gas | number | l2 gas consumed by this transaction, used for computation and calldata |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:848
ORDERED_EVENT​
Ƭ ORDERED_EVENT: Object
Represents an ordered event alongside its order within the transaction.
Type declaration​
| Name | Type |
|---|---|
order | number |
event | EVENT |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:861
ORDERED_MESSAGE​
Ƭ ORDERED_MESSAGE: Object
Represents an ordered message alongside its order within the transaction.
Type declaration​
| Name | Type |
|---|---|
order | number |
message | MSG_TO_L1 |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:868
TXN_STATUS_RESULT​
Ƭ TXN_STATUS_RESULT: Object
Transaction status result, including finality status and execution status
Type declaration​
| Name | Type | Description |
|---|---|---|
finality_status | TXN_STATUS | - |
execution_status? | TXN_EXECUTION_STATUS | - |
failure_reason? | string | the failure reason, only appears if finality_status is REJECTED or execution_status is REVERTED |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:875
CONTRACT_STORAGE_KEYS​
Ƭ CONTRACT_STORAGE_KEYS: Object
(contract_address, storage_keys) pairs
Type declaration​
| Name | Type |
|---|---|
contract_address | ADDRESS |
storage_keys | FELT[] |
Defined in​
node_modules/starknet-types-08/dist/types/api/components.d.ts:886
ContractClass​
Ƭ ContractClass: OneOf<[CONTRACT_CLASS, DEPRECATED_CONTRACT_CLASS]>
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:8
SimulateTransaction​
Ƭ SimulateTransaction: Object
Type declaration​
| Name | Type |
|---|---|
transaction_trace | TRANSACTION_TRACE |
fee_estimation | FEE_ESTIMATE |
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:9
SimulateTransactionResponse​
Ƭ SimulateTransactionResponse: SimulateTransaction[]
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:13
FeeEstimate​
Ƭ FeeEstimate: FEE_ESTIMATE
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:14
TransactionWithHash​
Ƭ TransactionWithHash: TXN_WITH_HASH
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:15
BlockHashAndNumber​
Ƭ BlockHashAndNumber: Object
Type declaration​
| Name | Type |
|---|---|
block_hash | BLOCK_HASH |
block_number | BLOCK_NUMBER |
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:16
BlockWithTxs​
Ƭ BlockWithTxs: OneOf<[BLOCK_WITH_TXS, PENDING_BLOCK_WITH_TXS]>
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:20
BlockWithTxHashes​
Ƭ BlockWithTxHashes: OneOf<[BLOCK_WITH_TX_HASHES, PENDING_BLOCK_WITH_TX_HASHES]>
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:21
BlockWithTxReceipts​
Ƭ BlockWithTxReceipts: OneOf<[BLOCK_WITH_RECEIPTS, PENDING_BLOCK_WITH_RECEIPTS]>
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:22
StateUpdate​
Ƭ StateUpdate: OneOf<[STATE_UPDATE, PENDING_STATE_UPDATE]>
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:23
BlockTransactionsTraces​
Ƭ BlockTransactionsTraces: { transaction_hash: FELT ; trace_root: TRANSACTION_TRACE }[]
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:24
Syncing​
Ƭ Syncing: false | SYNC_STATUS
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:28
Events​
Ƭ Events: EVENTS_CHUNK
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:29
EmittedEvent​
Ƭ EmittedEvent: EMITTED_EVENT
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:30
Event​
Ƭ Event: EVENT
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:31
InvokedTransaction​
Ƭ InvokedTransaction: Object
Type declaration​
| Name | Type |
|---|---|
transaction_hash | TXN_HASH |
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:32
DeclaredTransaction​
Ƭ DeclaredTransaction: Object
Type declaration​
| Name | Type |
|---|---|
transaction_hash | TXN_HASH |
class_hash | FELT |
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:35
DeployedAccountTransaction​
Ƭ DeployedAccountTransaction: Object
Type declaration​
| Name | Type |
|---|---|
transaction_hash | TXN_HASH |
contract_address | FELT |
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:39
L1L2MessagesStatus​
Ƭ L1L2MessagesStatus: L1L2MessageStatus[]
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:43
StorageProof​
Ƭ StorageProof: Object
Type declaration​
| Name | Type |
|---|---|
classes_proof | NODE_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.nodes | NODE_HASH_TO_NODE_MAPPING |
contracts_proof.contract_leaves_data | { nonce: FELT ; class_hash: FELT ; storage_root: FELT }[] |
contracts_storage_proofs | NODE_HASH_TO_NODE_MAPPING[] |
global_roots | { contracts_tree_root: FELT ; classes_tree_root: FELT ; block_hash: FELT } |
global_roots.contracts_tree_root | FELT |
global_roots.classes_tree_root | FELT |
global_roots.block_hash | FELT |
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:44
CompiledCasm​
Ƭ CompiledCasm: CASM_COMPILED_CONTRACT_CLASS
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:70
ContractAddress​
Ƭ ContractAddress: ADDRESS
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:71
Felt​
Ƭ Felt: FELT
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:72
Nonce​
Ƭ Nonce: FELT
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:73
TransactionHash​
Ƭ TransactionHash: TXN_HASH
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:74
TransactionTrace​
Ƭ TransactionTrace: TRANSACTION_TRACE
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:75
BlockHash​
Ƭ BlockHash: BLOCK_HASH
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:76
TransactionReceipt​
Ƭ TransactionReceipt: TXN_RECEIPT_WITH_BLOCK_INFO
All Type Transaction Receipt
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:80
TransactionReceiptProductionBlock​
Ƭ TransactionReceiptProductionBlock: IsInBlock<TransactionReceipt>
All Type Transaction Receipt from production block
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:84
TransactionReceiptPendingBlock​
Ƭ TransactionReceiptPendingBlock: IsPending<TransactionReceipt>
All Type Transaction Receipt from pending block
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:88
EventFilter​
Ƭ EventFilter: EVENT_FILTER & RESULT_PAGE_REQUEST
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:89
SimulationFlags​
Ƭ SimulationFlags: SIMULATION_FLAG[]
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:90
L1Message​
Ƭ L1Message: MSG_FROM_L1
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:91
BaseTransaction​
Ƭ BaseTransaction: BROADCASTED_TXN
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:92
ChainId​
Ƭ ChainId: CHAIN_ID
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:93
Transaction​
Ƭ Transaction: TXN
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:94
TransactionStatus​
Ƭ TransactionStatus: TXN_STATUS_RESULT
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:95
ResourceBounds​
Ƭ ResourceBounds: RESOURCE_BOUNDS_MAPPING
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:96
FeePayment​
Ƭ FeePayment: FEE_PAYMENT
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:97
PriceUnit​
Ƭ PriceUnit: PRICE_UNIT
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:98
L1L2MessageStatus​
Ƭ L1L2MessageStatus: Object
Ethereum l1_handler tx hash and status for L1 -> L2 messages sent by the l1 transaction
Type declaration​
| Name | Type | Description |
|---|---|---|
transaction_hash | TXN_HASH | l1_handler tx hash |
finality_status | TXN_STATUS | finality status of the L1 -> L2 messages sent by the l1 transaction |
failure_reason? | string | the failure reason, only appears if finality_status is REJECTED |
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:102
StorageDiffs​
Ƭ StorageDiffs: CONTRACT_STORAGE_DIFF_ITEM[]
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:116
DeprecatedDeclaredClasses​
Ƭ DeprecatedDeclaredClasses: FELT[]
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:117
NonceUpdates​
Ƭ NonceUpdates: NONCE_UPDATE[]
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:118
ReplacedClasses​
Ƭ ReplacedClasses: REPLACED_CLASS[]
Defined in​
node_modules/starknet-types-08/dist/types/api/nonspec.d.ts:119
STATUS_ACCEPTED_ON_L2​
Ƭ STATUS_ACCEPTED_ON_L2: "ACCEPTED_ON_L2"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:1
node_modules/starknet-types-08/dist/types/api/constants.d.ts:2
STATUS_ACCEPTED_ON_L1​
Ƭ STATUS_ACCEPTED_ON_L1: "ACCEPTED_ON_L1"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:3
node_modules/starknet-types-08/dist/types/api/constants.d.ts:4
STATUS_SUCCEEDED​
Ƭ STATUS_SUCCEEDED: "SUCCEEDED"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:5
node_modules/starknet-types-08/dist/types/api/constants.d.ts:6
STATUS_REVERTED​
Ƭ STATUS_REVERTED: "REVERTED"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:7
node_modules/starknet-types-08/dist/types/api/constants.d.ts:8
STATUS_PENDING​
Ƭ STATUS_PENDING: "PENDING"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:9
node_modules/starknet-types-08/dist/types/api/constants.d.ts:10
STATUS_REJECTED​
Ƭ STATUS_REJECTED: "REJECTED"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:11
node_modules/starknet-types-08/dist/types/api/constants.d.ts:12
STATUS_RECEIVED​
Ƭ STATUS_RECEIVED: "RECEIVED"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:13
node_modules/starknet-types-08/dist/types/api/constants.d.ts:14
TXN_TYPE_DECLARE​
Ƭ TXN_TYPE_DECLARE: "DECLARE"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:15
node_modules/starknet-types-08/dist/types/api/constants.d.ts:16
TXN_TYPE_DEPLOY​
Ƭ TXN_TYPE_DEPLOY: "DEPLOY"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:17
node_modules/starknet-types-08/dist/types/api/constants.d.ts:18
TXN_TYPE_DEPLOY_ACCOUNT​
Ƭ TXN_TYPE_DEPLOY_ACCOUNT: "DEPLOY_ACCOUNT"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:19
node_modules/starknet-types-08/dist/types/api/constants.d.ts:20
TXN_TYPE_INVOKE​
Ƭ TXN_TYPE_INVOKE: "INVOKE"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:21
node_modules/starknet-types-08/dist/types/api/constants.d.ts:22
TXN_TYPE_L1_HANDLER​
Ƭ TXN_TYPE_L1_HANDLER: "L1_HANDLER"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:23
node_modules/starknet-types-08/dist/types/api/constants.d.ts:24
STRUCT_ABI_TYPE​
Ƭ STRUCT_ABI_TYPE: "struct"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:25
node_modules/starknet-types-08/dist/types/api/constants.d.ts:26
EVENT_ABI_TYPE​
Ƭ EVENT_ABI_TYPE: "event"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:27
node_modules/starknet-types-08/dist/types/api/constants.d.ts:28
ABI_TYPE_FUNCTION​
Ƭ ABI_TYPE_FUNCTION: "function"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:29
node_modules/starknet-types-08/dist/types/api/constants.d.ts:30
ABI_TYPE_CONSTRUCTOR​
Ƭ ABI_TYPE_CONSTRUCTOR: "constructor"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:31
node_modules/starknet-types-08/dist/types/api/constants.d.ts:32
ABI_TYPE_L1_HANDLER​
Ƭ ABI_TYPE_L1_HANDLER: "l1_handler"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:33
node_modules/starknet-types-08/dist/types/api/constants.d.ts:34
ABI_TYPE_ENUM​
Ƭ ABI_TYPE_ENUM: "enum"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:35
node_modules/starknet-types-08/dist/types/api/constants.d.ts:36
STATE_MUTABILITY_VIEW​
Ƭ STATE_MUTABILITY_VIEW: "view"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:37
node_modules/starknet-types-08/dist/types/api/constants.d.ts:38
STATE_MUTABILITY_EXTERNAL​
Ƭ STATE_MUTABILITY_EXTERNAL: "external"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:39
node_modules/starknet-types-08/dist/types/api/constants.d.ts:40
PRICE_UNIT_WEI​
Ƭ PRICE_UNIT_WEI: "WEI"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:41
node_modules/starknet-types-08/dist/types/api/constants.d.ts:42
PRICE_UNIT_FRI​
Ƭ PRICE_UNIT_FRI: "FRI"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:43
node_modules/starknet-types-08/dist/types/api/constants.d.ts:44
L1_DA_MODE​
Ƭ L1_DA_MODE: typeof L1_DA_MODE[keyof typeof L1_DA_MODE]
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:45
node_modules/starknet-types-08/dist/types/api/constants.d.ts:49
CALL_TYPE​
Ƭ CALL_TYPE: typeof CALL_TYPE[keyof typeof CALL_TYPE]
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:53
node_modules/starknet-types-08/dist/types/api/constants.d.ts:58
ETransactionType​
Ƭ ETransactionType: typeof ETransactionType[keyof typeof ETransactionType]
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:59
node_modules/starknet-types-08/dist/types/api/constants.d.ts:66
ESimulationFlag​
Ƭ ESimulationFlag: typeof ESimulationFlag[keyof typeof ESimulationFlag]
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:67
node_modules/starknet-types-08/dist/types/api/constants.d.ts:71
ETransactionStatus​
Ƭ ETransactionStatus: typeof ETransactionStatus[keyof typeof ETransactionStatus]
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:72
node_modules/starknet-types-08/dist/types/api/constants.d.ts:78
ETransactionFinalityStatus​
Ƭ ETransactionFinalityStatus: typeof ETransactionFinalityStatus[keyof typeof ETransactionFinalityStatus]
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:79
node_modules/starknet-types-08/dist/types/api/constants.d.ts:83
ETransactionExecutionStatus​
Ƭ ETransactionExecutionStatus: typeof ETransactionExecutionStatus[keyof typeof ETransactionExecutionStatus]
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:84
node_modules/starknet-types-08/dist/types/api/constants.d.ts:88
EBlockTag​
Ƭ EBlockTag: typeof EBlockTag[keyof typeof EBlockTag]
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:89
node_modules/starknet-types-08/dist/types/api/constants.d.ts:93
EDataAvailabilityMode​
Ƭ EDataAvailabilityMode: typeof EDataAvailabilityMode[keyof typeof EDataAvailabilityMode]
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:94
node_modules/starknet-types-08/dist/types/api/constants.d.ts:98
EDAMode​
Ƭ EDAMode: typeof EDAMode[keyof typeof EDAMode]
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:99
node_modules/starknet-types-08/dist/types/api/constants.d.ts:103
ETransactionVersion​
Ƭ ETransactionVersion: typeof ETransactionVersion[keyof typeof ETransactionVersion]
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:108
node_modules/starknet-types-08/dist/types/api/constants.d.ts:136
ETransactionVersion2​
Ƭ ETransactionVersion2: typeof ETransactionVersion2[keyof typeof ETransactionVersion2]
Deprecated
Starknet 0.14 will not support this transaction
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:143
node_modules/starknet-types-08/dist/types/api/constants.d.ts:154
ETransactionVersion3​
Ƭ ETransactionVersion3: typeof ETransactionVersion3[keyof typeof ETransactionVersion3]
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:158
node_modules/starknet-types-08/dist/types/api/constants.d.ts:162
CASM_COMPILED_CONTRACT_CLASS​
Ƭ CASM_COMPILED_CONTRACT_CLASS: Object
Starknet get compiled CASM result
Type declaration​
| Name | Type | Description |
|---|---|---|
entry_points_by_type | { CONSTRUCTOR: CASM_ENTRY_POINT[] ; EXTERNAL: CASM_ENTRY_POINT[] ; L1_HANDLER: CASM_ENTRY_POINT[] } | - |
entry_points_by_type.CONSTRUCTOR | CASM_ENTRY_POINT[] | - |
entry_points_by_type.EXTERNAL | CASM_ENTRY_POINT[] | - |
entry_points_by_type.L1_HANDLER | CASM_ENTRY_POINT[] | - |
bytecode | FELT[] | - |
prime | NUM_AS_HEX | - |
compiler_version | string | - |
hints | [number | HINT[], number | HINT[]][] | Array of 2-tuple of pc value and an array of hints to execute. |
bytecode_segment_lengths? | number | a list of sizes of segments in the bytecode, each segment is hashed individually when computing the bytecode hash. Integer |
Defined in​
node_modules/starknet-types-08/dist/types/api/executable.d.ts:5
CASM_ENTRY_POINT​
Ƭ CASM_ENTRY_POINT: DEPRECATED_CAIRO_ENTRY_POINT & { builtins: string[] }
Defined in​
node_modules/starknet-types-08/dist/types/api/executable.d.ts:24
CellRef​
Ƭ CellRef: Object
Type declaration​
| Name | Type |
|---|---|
register | "AP" | "FP" |
offset | number |
Defined in​
node_modules/starknet-types-08/dist/types/api/executable.d.ts:27
Deref​
Ƭ Deref: Object
Type declaration​
| Name | Type |
|---|---|
Deref | CellRef |
Defined in​
node_modules/starknet-types-08/dist/types/api/executable.d.ts:31
DoubleDeref​
Ƭ DoubleDeref: Object
Type declaration​
| Name | Type | Description |
|---|---|---|
DoubleDeref | [CellRef | number] | A (CellRef, offset) tuple |
Defined in​
node_modules/starknet-types-08/dist/types/api/executable.d.ts:34
Immediate​
Ƭ Immediate: Object
Type declaration​
| Name | Type |
|---|---|
Immediate | NUM_AS_HEX |
Defined in​
node_modules/starknet-types-08/dist/types/api/executable.d.ts:40
BinOp​
Ƭ BinOp: Object
Type declaration​
| Name | Type |
|---|---|
BinOp | { op: "Add" | "Mul" ; a: CellRef ; b: Deref | Immediate } |
BinOp.op | "Add" | "Mul" |
BinOp.a | CellRef |
BinOp.b | Deref | Immediate |
Defined in​
node_modules/starknet-types-08/dist/types/api/executable.d.ts:43
ResOperand​
Ƭ ResOperand: Deref | DoubleDeref | Immediate | BinOp
Defined in​
node_modules/starknet-types-08/dist/types/api/executable.d.ts:50
HINT​
Ƭ HINT: DEPRECATED_HINT | CORE_HINT | STARKNET_HINT
Defined in​
node_modules/starknet-types-08/dist/types/api/executable.d.ts:51
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-types-08/dist/types/api/executable.d.ts:52
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-types-08/dist/types/api/executable.d.ts:74
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-types-08/dist/types/api/executable.d.ts:261
IsPending​
Ƭ IsPending<T>: Extract<T, { block_hash: never ; block_number: 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-types-08/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-types-08/dist/types/api/expansions/transactionReceipt.d.ts:12
IsType​
Ƭ IsType<T, ETransactionType>: Extract<T, { type: ETransactionType }>
Type parameters​
| Name |
|---|
T |
ETransactionType |
Defined in​
node_modules/starknet-types-08/dist/types/api/expansions/transactionReceipt.d.ts:18
IsSucceeded​
Ƭ IsSucceeded<T>: Extract<T, { execution_status: "SUCCEEDED" }>
Type parameters​
| Name |
|---|
T |
Defined in​
node_modules/starknet-types-08/dist/types/api/expansions/transactionReceipt.d.ts:21
IsReverted​
Ƭ IsReverted<T>: Extract<T, { execution_status: "REVERTED" }>
Type parameters​
| Name |
|---|
T |
Defined in​
node_modules/starknet-types-08/dist/types/api/expansions/transactionReceipt.d.ts:24
Variables​
STATUS_ACCEPTED_ON_L2​
• STATUS_ACCEPTED_ON_L2: "ACCEPTED_ON_L2"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:1
node_modules/starknet-types-08/dist/types/api/constants.d.ts:2
STATUS_ACCEPTED_ON_L1​
• STATUS_ACCEPTED_ON_L1: "ACCEPTED_ON_L1"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:3
node_modules/starknet-types-08/dist/types/api/constants.d.ts:4
STATUS_SUCCEEDED​
• STATUS_SUCCEEDED: "SUCCEEDED"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:5
node_modules/starknet-types-08/dist/types/api/constants.d.ts:6
STATUS_REVERTED​
• STATUS_REVERTED: "REVERTED"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:7
node_modules/starknet-types-08/dist/types/api/constants.d.ts:8
STATUS_PENDING​
• STATUS_PENDING: "PENDING"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:9
node_modules/starknet-types-08/dist/types/api/constants.d.ts:10
STATUS_REJECTED​
• STATUS_REJECTED: "REJECTED"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:11
node_modules/starknet-types-08/dist/types/api/constants.d.ts:12
STATUS_RECEIVED​
• STATUS_RECEIVED: "RECEIVED"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:13
node_modules/starknet-types-08/dist/types/api/constants.d.ts:14
TXN_TYPE_DECLARE​
• TXN_TYPE_DECLARE: "DECLARE"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:15
node_modules/starknet-types-08/dist/types/api/constants.d.ts:16
TXN_TYPE_DEPLOY​
• TXN_TYPE_DEPLOY: "DEPLOY"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:17
node_modules/starknet-types-08/dist/types/api/constants.d.ts:18
TXN_TYPE_DEPLOY_ACCOUNT​
• TXN_TYPE_DEPLOY_ACCOUNT: "DEPLOY_ACCOUNT"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:19
node_modules/starknet-types-08/dist/types/api/constants.d.ts:20
TXN_TYPE_INVOKE​
• TXN_TYPE_INVOKE: "INVOKE"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:21
node_modules/starknet-types-08/dist/types/api/constants.d.ts:22
TXN_TYPE_L1_HANDLER​
• TXN_TYPE_L1_HANDLER: "L1_HANDLER"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:23
node_modules/starknet-types-08/dist/types/api/constants.d.ts:24
STRUCT_ABI_TYPE​
• STRUCT_ABI_TYPE: "struct"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:25
node_modules/starknet-types-08/dist/types/api/constants.d.ts:26
EVENT_ABI_TYPE​
• EVENT_ABI_TYPE: "event"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:27
node_modules/starknet-types-08/dist/types/api/constants.d.ts:28
ABI_TYPE_FUNCTION​
• ABI_TYPE_FUNCTION: "function"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:29
node_modules/starknet-types-08/dist/types/api/constants.d.ts:30
ABI_TYPE_CONSTRUCTOR​
• ABI_TYPE_CONSTRUCTOR: "constructor"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:31
node_modules/starknet-types-08/dist/types/api/constants.d.ts:32
ABI_TYPE_L1_HANDLER​
• ABI_TYPE_L1_HANDLER: "l1_handler"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:33
node_modules/starknet-types-08/dist/types/api/constants.d.ts:34
ABI_TYPE_ENUM​
• ABI_TYPE_ENUM: "enum"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:35
node_modules/starknet-types-08/dist/types/api/constants.d.ts:36
STATE_MUTABILITY_VIEW​
• STATE_MUTABILITY_VIEW: "view"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:37
node_modules/starknet-types-08/dist/types/api/constants.d.ts:38
STATE_MUTABILITY_EXTERNAL​
• STATE_MUTABILITY_EXTERNAL: "external"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:39
node_modules/starknet-types-08/dist/types/api/constants.d.ts:40
PRICE_UNIT_WEI​
• PRICE_UNIT_WEI: "WEI"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:41
node_modules/starknet-types-08/dist/types/api/constants.d.ts:42
PRICE_UNIT_FRI​
• PRICE_UNIT_FRI: "FRI"
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:43
node_modules/starknet-types-08/dist/types/api/constants.d.ts:44
L1_DA_MODE​
• Const L1_DA_MODE: Object
Type declaration​
| Name | Type |
|---|---|
BLOB | "BLOB" |
CALLDATA | "CALLDATA" |
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:45
node_modules/starknet-types-08/dist/types/api/constants.d.ts:49
CALL_TYPE​
• Const CALL_TYPE: Object
Represents the type of a function call.
Type declaration​
| Name | Type |
|---|---|
DELEGATE | "DELEGATE" |
LIBRARY_CALL | "LIBRARY_CALL" |
CALL | "CALL" |
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:53
node_modules/starknet-types-08/dist/types/api/constants.d.ts:58
ETransactionType​
• Const ETransactionType: Object
Type declaration​
| Name | Type |
|---|---|
DECLARE | "DECLARE" |
DEPLOY | "DEPLOY" |
DEPLOY_ACCOUNT | "DEPLOY_ACCOUNT" |
INVOKE | "INVOKE" |
L1_HANDLER | "L1_HANDLER" |
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:59
node_modules/starknet-types-08/dist/types/api/constants.d.ts:66
ESimulationFlag​
• Const ESimulationFlag: Object
Type declaration​
| Name | Type |
|---|---|
SKIP_VALIDATE | "SKIP_VALIDATE" |
SKIP_FEE_CHARGE | "SKIP_FEE_CHARGE" |
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:67
node_modules/starknet-types-08/dist/types/api/constants.d.ts:71
ETransactionStatus​
• Const ETransactionStatus: Object
Type declaration​
| Name | Type |
|---|---|
RECEIVED | "RECEIVED" |
REJECTED | "REJECTED" |
ACCEPTED_ON_L2 | "ACCEPTED_ON_L2" |
ACCEPTED_ON_L1 | "ACCEPTED_ON_L1" |
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:72
node_modules/starknet-types-08/dist/types/api/constants.d.ts:78
ETransactionFinalityStatus​
• Const ETransactionFinalityStatus: Object
Type declaration​
| Name | Type |
|---|---|
ACCEPTED_ON_L2 | "ACCEPTED_ON_L2" |
ACCEPTED_ON_L1 | "ACCEPTED_ON_L1" |
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:79
node_modules/starknet-types-08/dist/types/api/constants.d.ts:83
ETransactionExecutionStatus​
• Const ETransactionExecutionStatus: Object
Type declaration​
| Name | Type |
|---|---|
SUCCEEDED | "SUCCEEDED" |
REVERTED | "REVERTED" |
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:84
node_modules/starknet-types-08/dist/types/api/constants.d.ts:88
EBlockTag​
• Const EBlockTag: Object
Type declaration​
| Name | Type |
|---|---|
LATEST | "latest" |
PENDING | "pending" |
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:89
node_modules/starknet-types-08/dist/types/api/constants.d.ts:93
EDataAvailabilityMode​
• Const EDataAvailabilityMode: Object
Type declaration​
| Name | Type |
|---|---|
L1 | "L1" |
L2 | "L2" |
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:94
node_modules/starknet-types-08/dist/types/api/constants.d.ts:98
EDAMode​
• Const EDAMode: Object
Type declaration​
| Name | Type |
|---|---|
L1 | 0 |
L2 | 1 |
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:99
node_modules/starknet-types-08/dist/types/api/constants.d.ts:103
ETransactionVersion​
• Const ETransactionVersion: Object
V Transaction versions HexString F Fee Transaction Versions HexString (2 ** 128 + TRANSACTION_VERSION)
Type declaration​
| Name | Type | Description |
|---|---|---|
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-types-08/dist/types/api/constants.d.ts:108
node_modules/starknet-types-08/dist/types/api/constants.d.ts:136
ETransactionVersion2​
• Const ETransactionVersion2: Object
Deprecated
Starknet 0.14 will not support this transaction
Type declaration​
| Name | Type |
|---|---|
V0 | "0x0" |
V1 | "0x1" |
V2 | "0x2" |
F0 | "0x100000000000000000000000000000000" |
F1 | "0x100000000000000000000000000000001" |
F2 | "0x100000000000000000000000000000002" |
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:143
node_modules/starknet-types-08/dist/types/api/constants.d.ts:154
ETransactionVersion3​
• Const ETransactionVersion3: Object
V3 Transaction Versions
Type declaration​
| Name | Type |
|---|---|
V3 | "0x3" |
F3 | "0x100000000000000000000000000000003" |
Defined in​
node_modules/starknet-types-08/dist/types/api/constants.d.ts:158
node_modules/starknet-types-08/dist/types/api/constants.d.ts:162