Namespace: API
Namespaces
Interfaces
- FAILED_TO_RECEIVE_TXN
- NO_TRACE_AVAILABLE
- CONTRACT_NOT_FOUND
- ENTRYPOINT_NOT_FOUND
- BLOCK_NOT_FOUND
- 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-io/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-io/starknet-types-08/dist/types/api/methods.d.ts:280
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 |