Skip to main content
Version: Next

Namespace: API

RPC.RPCSPEC07.API

Namespaces​

Type Aliases​

Methods​

Ƭ Methods: ReadMethods & WriteMethods & TraceMethods

Defined in​

node_modules/starknet-types-07/dist/types/api/methods.d.ts:4


ABI​

Ƭ ABI: (FUNCTION | CONSTRUCTOR | L1_HANDLER | EVENT | STRUCT | ENUM | INTERFACE | IMPL)[]

TypeScript Representation of Cairo1 v2+ Starknet Contract ABI

starknet_metadata.json - tags/v0.5.0

'starknet-specs' (OpenRpc protocol types) https://github.com/starkware-libs/starknet-specs

Defined in​

node_modules/starknet-types-07/dist/types/api/contract.d.ts:9


FUNCTION​

Ƭ FUNCTION: Object

Type declaration​

NameType
type"function"
namestring
inputs{ name: string ; type: string }[]
outputs?{ type: string }[]
state_mutability"view" | "external"

Defined in​

node_modules/starknet-types-07/dist/types/api/contract.d.ts:10


CONSTRUCTOR​

Ƭ CONSTRUCTOR: Object

Type declaration​

NameType
type"constructor"
name"constructor"
inputs{ name: string ; type: string }[]

Defined in​

node_modules/starknet-types-07/dist/types/api/contract.d.ts:22


L1_HANDLER​

Ƭ L1_HANDLER: Object

Type declaration​

NameType
type"l1_handler"
namestring
inputs{ name: string ; type: string }[]
outputs?{ type: string }[]
state_mutability"view" | "external"

Defined in​

node_modules/starknet-types-07/dist/types/api/contract.d.ts:30


EVENT​

Ƭ EVENT: { type: "event" ; name: string } & ENUM_EVENT | STRUCT_EVENT

Defined in​

node_modules/starknet-types-07/dist/types/api/contract.d.ts:42


STRUCT_EVENT​

Ƭ STRUCT_EVENT: Object

Type declaration​

NameType
kind"struct"
membersEVENT_FIELD[]

Defined in​

node_modules/starknet-types-07/dist/types/api/contract.d.ts:46


ENUM_EVENT​

Ƭ ENUM_EVENT: Object

Type declaration​

NameType
kind"enum"
variantsEVENT_FIELD[]

Defined in​

node_modules/starknet-types-07/dist/types/api/contract.d.ts:50


STRUCT​

Ƭ STRUCT: Object

Type declaration​

NameType
type"struct"
namestring
members{ name: string ; type: string }[]

Defined in​

node_modules/starknet-types-07/dist/types/api/contract.d.ts:54


ENUM​

Ƭ ENUM: Object

Type declaration​

NameType
type"enum"
namestring
variants{ name: string ; type: string }[]

Defined in​

node_modules/starknet-types-07/dist/types/api/contract.d.ts:62


INTERFACE​

Ƭ INTERFACE: Object

Type declaration​

NameType
type"interface"
namestring
itemsFUNCTION[]

Defined in​

node_modules/starknet-types-07/dist/types/api/contract.d.ts:70


IMPL​

Ƭ IMPL: Object

Type declaration​

NameType
type"impl"
namestring
interface_namestring

Defined in​

node_modules/starknet-types-07/dist/types/api/contract.d.ts:75


EVENT_KIND​

Ƭ EVENT_KIND: "struct" | "enum"

Defined in​

node_modules/starknet-types-07/dist/types/api/contract.d.ts:80


EVENT_FIELD​

Ƭ EVENT_FIELD: Object

Type declaration​

NameType
namestring
typestring
kind"key" | "data" | "nested"

Defined in​

node_modules/starknet-types-07/dist/types/api/contract.d.ts:81


ContractClass​

Ƭ ContractClass: CONTRACT_CLASS | DEPRECATED_CONTRACT_CLASS

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:5


SimulateTransaction​

Ƭ SimulateTransaction: Object

Type declaration​

NameType
transaction_traceTRANSACTION_TRACE
fee_estimationFEE_ESTIMATE

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:6


SimulateTransactionResponse​

Ƭ SimulateTransactionResponse: SimulateTransaction[]

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:10


FeeEstimate​

Ƭ FeeEstimate: FEE_ESTIMATE

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:11


TransactionWithHash​

Ƭ TransactionWithHash: TXN & { transaction_hash: TXN_HASH }

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:12


BlockHashAndNumber​

Ƭ BlockHashAndNumber: Object

Type declaration​

NameType
block_hashBLOCK_HASH
block_numberBLOCK_NUMBER

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:15


BlockWithTxs​

Ƭ BlockWithTxs: BLOCK_WITH_TXS | PENDING_BLOCK_WITH_TXS

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:19


BlockWithTxHashes​

Ƭ BlockWithTxHashes: BLOCK_WITH_TX_HASHES | PENDING_BLOCK_WITH_TX_HASHES

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:20


BlockWithTxReceipts​

Ƭ BlockWithTxReceipts: BLOCK_WITH_RECEIPTS | PENDING_BLOCK_WITH_RECEIPTS

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:21


StateUpdate​

Ƭ StateUpdate: STATE_UPDATE | PENDING_STATE_UPDATE

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:22


BlockTransactionsTraces​

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

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:23


Syncing​

Ƭ Syncing: false | SYNC_STATUS

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:27


Events​

Ƭ Events: EVENTS_CHUNK

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:28


EmittedEvent​

Ƭ EmittedEvent: EMITTED_EVENT

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:29


Event​

Ƭ Event: EVENT

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:30


InvokedTransaction​

Ƭ InvokedTransaction: Object

Type declaration​

NameType
transaction_hashTXN_HASH

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:31


DeclaredTransaction​

Ƭ DeclaredTransaction: Object

Type declaration​

NameType
transaction_hashTXN_HASH
class_hashFELT

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:34


DeployedAccountTransaction​

Ƭ DeployedAccountTransaction: Object

Type declaration​

NameType
transaction_hashTXN_HASH
contract_addressFELT

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:38


ContractAddress​

Ƭ ContractAddress: ADDRESS

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:42


Felt​

Ƭ Felt: FELT

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:43


Nonce​

Ƭ Nonce: FELT

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:44


TransactionHash​

Ƭ TransactionHash: TXN_HASH

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:45


TransactionTrace​

Ƭ TransactionTrace: TRANSACTION_TRACE

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:46


BlockHash​

Ƭ BlockHash: BLOCK_HASH

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:47


TransactionReceipt​

Ƭ TransactionReceipt: TXN_RECEIPT_WITH_BLOCK_INFO

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:48


Receipt​

Ƭ Receipt: TXN_RECEIPT_WITH_BLOCK_INFO & BlockHashAndNumber

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:49


PendingReceipt​

Ƭ PendingReceipt: TXN_RECEIPT

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:50


EventFilter​

Ƭ EventFilter: EVENT_FILTER & RESULT_PAGE_REQUEST

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:51


SimulationFlags​

Ƭ SimulationFlags: SIMULATION_FLAG[]

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:52


L1Message​

Ƭ L1Message: MSG_FROM_L1

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:53


BaseTransaction​

Ƭ BaseTransaction: BROADCASTED_TXN

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:54


ChainId​

Ƭ ChainId: CHAIN_ID

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:55


Transaction​

Ƭ Transaction: TXN

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:56


TransactionStatus​

Ƭ TransactionStatus: Object

Type declaration​

NameType
finality_statusTXN_STATUS
execution_status?TXN_EXECUTION_STATUS

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:57


ResourceBounds​

Ƭ ResourceBounds: RESOURCE_BOUNDS_MAPPING

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:61


FeePayment​

Ƭ FeePayment: FEE_PAYMENT

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:62


PriceUnit​

Ƭ PriceUnit: PRICE_UNIT

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:63


StorageDiffs​

Ƭ StorageDiffs: CONTRACT_STORAGE_DIFF_ITEM[]

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:64


DeprecatedDeclaredClasses​

Ƭ DeprecatedDeclaredClasses: FELT[]

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:65


NonceUpdates​

Ƭ NonceUpdates: NONCE_UPDATE[]

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:66


ReplacedClasses​

Ƭ ReplacedClasses: REPLACED_CLASS[]

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:67


ETransactionType​

Ƭ ETransactionType: typeof ETransactionType[keyof typeof ETransactionType]

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:68

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:75


ESimulationFlag​

Ƭ ESimulationFlag: typeof ESimulationFlag[keyof typeof ESimulationFlag]

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:76

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:80


ETransactionStatus​

Ƭ ETransactionStatus: typeof ETransactionStatus[keyof typeof ETransactionStatus]

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:81

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:87


ETransactionFinalityStatus​

Ƭ ETransactionFinalityStatus: typeof ETransactionFinalityStatus[keyof typeof ETransactionFinalityStatus]

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:88

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:92


ETransactionExecutionStatus​

Ƭ ETransactionExecutionStatus: typeof ETransactionExecutionStatus[keyof typeof ETransactionExecutionStatus]

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:93

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:97


EBlockTag​

Ƭ EBlockTag: typeof EBlockTag[keyof typeof EBlockTag]

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:98

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:102


EDataAvailabilityMode​

Ƭ EDataAvailabilityMode: typeof EDataAvailabilityMode[keyof typeof EDataAvailabilityMode]

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:103

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:107


EDAMode​

Ƭ EDAMode: typeof EDAMode[keyof typeof EDAMode]

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:108

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:112


ETransactionVersion​

Ƭ ETransactionVersion: typeof ETransactionVersion[keyof typeof ETransactionVersion]

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:117

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:127


ETransactionVersion2​

Ƭ ETransactionVersion2: typeof ETransactionVersion2[keyof typeof ETransactionVersion2]

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:131

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:139


ETransactionVersion3​

Ƭ ETransactionVersion3: typeof ETransactionVersion3[keyof typeof ETransactionVersion3]

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:143

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:147

Variables​

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-types-07/dist/types/api/nonspec.d.ts:68

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:75


ESimulationFlag​

• Const ESimulationFlag: Object

Type declaration​

NameType
SKIP_VALIDATE"SKIP_VALIDATE"
SKIP_FEE_CHARGE"SKIP_FEE_CHARGE"

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:76

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:80


ETransactionStatus​

• Const ETransactionStatus: Object

Type declaration​

NameType
RECEIVED"RECEIVED"
REJECTED"REJECTED"
ACCEPTED_ON_L2"ACCEPTED_ON_L2"
ACCEPTED_ON_L1"ACCEPTED_ON_L1"

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:81

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:87


ETransactionFinalityStatus​

• Const ETransactionFinalityStatus: Object

Type declaration​

NameType
ACCEPTED_ON_L2"ACCEPTED_ON_L2"
ACCEPTED_ON_L1"ACCEPTED_ON_L1"

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:88

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:92


ETransactionExecutionStatus​

• Const ETransactionExecutionStatus: Object

Type declaration​

NameType
SUCCEEDED"SUCCEEDED"
REVERTED"REVERTED"

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:93

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:97


EBlockTag​

• Const EBlockTag: Object

Type declaration​

NameType
LATEST"latest"
PENDING"pending"

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:98

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:102


EDataAvailabilityMode​

• Const EDataAvailabilityMode: Object

Type declaration​

NameType
L1"L1"
L2"L2"

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:103

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:107


EDAMode​

• Const EDAMode: Object

Type declaration​

NameType
L10
L21

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:108

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:112


ETransactionVersion​

• Const ETransactionVersion: Object

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

Type declaration​

NameType
V0"0x0"
V1"0x1"
V2"0x2"
V3"0x3"
F0"0x100000000000000000000000000000000"
F1"0x100000000000000000000000000000001"
F2"0x100000000000000000000000000000002"
F3"0x100000000000000000000000000000003"

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:117

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:127


ETransactionVersion2​

• Const ETransactionVersion2: Object

Old Transaction Versions

Type declaration​

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

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:131

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:139


ETransactionVersion3​

• Const ETransactionVersion3: Object

V3 Transaction Versions

Type declaration​

NameType
V3"0x3"
F3"0x100000000000000000000000000000003"

Defined in​

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:143

node_modules/starknet-types-07/dist/types/api/nonspec.d.ts:147