Skip to main content
Version: Next

Namespace: Sequencer

Interfaces

Type Aliases

DeclareTransaction

Ƭ DeclareTransaction: Object

Type declaration

NameType
type"DECLARE"
sender_addressstring
contract_classContractClass
signature?string[]
nonceBigNumberish
max_fee?BigNumberish
version?BigNumberish
compiled_class_hash?string

Defined in

src/types/api/sequencer.ts:81


DeployTransaction

Ƭ DeployTransaction: Object

Type declaration

NameType
type"DEPLOY"
contract_definitionContractClass
contract_address_saltBigNumberish
constructor_calldatastring[]
nonce?BigNumberish

Defined in

src/types/api/sequencer.ts:92


DeployAccountTransaction

Ƭ DeployAccountTransaction: Object

Type declaration

NameType
type"DEPLOY_ACCOUNT"
class_hashstring
contract_address_saltBigNumberish
constructor_calldatastring[]
signature?string[]
max_fee?BigNumberish
version?BigNumberish
nonce?BigNumberish

Defined in

src/types/api/sequencer.ts:100


InvokeFunctionTransaction

Ƭ InvokeFunctionTransaction: Object

Type declaration

NameType
type"INVOKE_FUNCTION"
sender_addressstring
signature?string[]
entry_point_type?EXTERNAL
calldata?RawCalldata
nonceBigNumberish
max_fee?BigNumberish
version?BigNumberish

Defined in

src/types/api/sequencer.ts:111


Transaction

Ƭ Transaction: DeclareTransaction | DeployTransaction | InvokeFunctionTransaction | DeployAccountTransaction

Defined in

src/types/api/sequencer.ts:122


AddTransactionResponse

Ƭ AddTransactionResponse: Object

Type declaration

NameType
transaction_hashstring
code?"TRANSACTION_RECEIVED"
address?string
class_hash?string

Defined in

src/types/api/sequencer.ts:128


GetCodeResponse

Ƭ GetCodeResponse: Object

Type declaration

NameType
bytecodeByteCode
abiAbi

Defined in

src/types/api/sequencer.ts:135


TransactionResponse

Ƭ TransactionResponse: DeclareTransaction | DeployTransaction | InvokeFunctionTransactionResponse

Defined in

src/types/api/sequencer.ts:145


SuccessfulTransactionResponse

Ƭ SuccessfulTransactionResponse: Object

Type declaration

NameType
statusStatus
transactionTransactionResponse
block_hashstring
block_numberBlockNumber
transaction_indexnumber

Defined in

src/types/api/sequencer.ts:150


FailedTransactionResponse

Ƭ FailedTransactionResponse: Object

Type declaration

NameType
status"REJECTED"
transaction_failure_reason{ code: string ; error_message: string }
transaction_failure_reason.codestring
transaction_failure_reason.error_messagestring
transactionTransactionResponse

Defined in

src/types/api/sequencer.ts:158


GetTransactionResponse

Ƭ GetTransactionResponse: SuccessfulTransactionResponse | FailedTransactionResponse

Defined in

src/types/api/sequencer.ts:167


TransactionReceiptResponse

Ƭ TransactionReceiptResponse: SuccessfulTransactionReceiptResponse | FailedTransactionReceiptResponse

Defined in

src/types/api/sequencer.ts:169


SuccessfulTransactionReceiptResponse

Ƭ SuccessfulTransactionReceiptResponse: Object

Type declaration

NameType
statusStatus
transaction_hashstring
transaction_indexnumber
block_hashstring
block_numberBlockNumber
l2_to_l1_messagesstring[]
eventsstring[]
actual_feestring
execution_resourcesExecutionResources

Defined in

src/types/api/sequencer.ts:173


FailedTransactionReceiptResponse

Ƭ FailedTransactionReceiptResponse: Object

Type declaration

NameType
status"REJECTED"
transaction_failure_reason{ code: string ; error_message: string }
transaction_failure_reason.codestring
transaction_failure_reason.error_messagestring
transaction_hashstring
l2_to_l1_messagesstring[]
eventsstring[]

Defined in

src/types/api/sequencer.ts:185


GetBlockResponse

Ƭ GetBlockResponse: Object

Type declaration

NameType
block_numbernumber
state_rootstring
block_hashstring
transactions{ [txHash: string]: TransactionResponse; }
timestampnumber
transaction_receipts{ [txHash: string]: { block_hash: string ; transaction_hash: string ; l2_to_l1_messages: { to_address: string ; payload: string[] ; from_address: string }[] ; block_number: BlockNumber ; status: Status ; transaction_index: number }; }
parent_block_hashstring
statusStatus
gas_pricestring
sequencer_addressstring
starknet_versionstring

Defined in

src/types/api/sequencer.ts:196


CallContractTransaction

Ƭ CallContractTransaction: { calldata?: RawCalldata ; max_fee?: BigNumberish ; version?: BigNumberish ; entry_point_selector: string } & { sender_address: string ; signature: string[] } | { contract_address: string ; signature?: never }

Defined in

src/types/api/sequencer.ts:225


CallContractResponse

Ƭ CallContractResponse: Object

Type declaration

NameType
resultstring[]

Defined in

src/types/api/sequencer.ts:241


InvokeEstimateFee

Ƭ InvokeEstimateFee: Omit<InvokeFunctionTransaction, "max_fee" | "entry_point_type">

Defined in

src/types/api/sequencer.ts:245


DeclareEstimateFee

Ƭ DeclareEstimateFee: Omit<DeclareTransaction, "max_fee">

Defined in

src/types/api/sequencer.ts:246


DeployAccountEstimateFee

Ƭ DeployAccountEstimateFee: Omit<DeployAccountTransaction, "max_fee">

Defined in

src/types/api/sequencer.ts:247


DeployEstimateFee

Ƭ DeployEstimateFee: DeployTransaction

Defined in

src/types/api/sequencer.ts:248


EstimateFeeRequest

Ƭ EstimateFeeRequest: InvokeEstimateFee | DeclareEstimateFee | DeployEstimateFee | DeployAccountEstimateFee

Defined in

src/types/api/sequencer.ts:250


TransactionSimulationResponse

Ƭ TransactionSimulationResponse: Object

Type declaration

NameType
traceTransactionTraceResponse
fee_estimationEstimateFeeResponse

Defined in

src/types/api/sequencer.ts:256


SimulateTransaction

Ƭ SimulateTransaction: Omit<InvokeFunctionTransaction, "entry_point_type">

Defined in

src/types/api/sequencer.ts:261


EstimateFeeRequestBulk

Ƭ EstimateFeeRequestBulk: AllowArray<InvokeEstimateFee | DeclareEstimateFee | DeployEstimateFee | DeployAccountEstimateFee>

Defined in

src/types/api/sequencer.ts:263


EstimateFeeResponse

Ƭ EstimateFeeResponse: { overall_fee: number ; gas_price: number ; gas_usage: number ; uint: string } | { amount: bigint ; unit: string }

Defined in

src/types/api/sequencer.ts:268


EstimateFeeResponseBulk

Ƭ EstimateFeeResponseBulk: AllowArray<EstimateFeeResponse>

Defined in

src/types/api/sequencer.ts:280


BlockTransactionTracesResponse

Ƭ BlockTransactionTracesResponse: Object

Type declaration

NameType
tracesTransactionTraceResponse & { transaction_hash: string }[]

Defined in

src/types/api/sequencer.ts:282


Storage

Ƭ Storage: string

Defined in

src/types/api/sequencer.ts:286


StateUpdateResponse

Ƭ StateUpdateResponse: Object

Type declaration

NameType
block_hashstring
new_rootstring
old_rootstring
state_diff{ storage_diffs: StorageDiffs ; nonces: Nonces ; deployed_contracts: DeployedContractItem[] ; old_declared_contracts: OldDeclaredContracts ; declared_classes: DeclaredClasses ; replaced_classes: ReplacedClasses }
state_diff.storage_diffsStorageDiffs
state_diff.noncesNonces
state_diff.deployed_contractsDeployedContractItem[]
state_diff.old_declared_contractsOldDeclaredContracts
state_diff.declared_classesDeclaredClasses
state_diff.replaced_classesReplacedClasses

Defined in

src/types/api/sequencer.ts:288


StorageDiffs

Ƭ StorageDiffs: Object

Index signature

[address: string]: StateDiffItem[]

Defined in

src/types/api/sequencer.ts:302


StateDiffItem

Ƭ StateDiffItem: Object

Type declaration

NameType
keystring
valuestring

Defined in

src/types/api/sequencer.ts:304


Nonces

Ƭ Nonces: Object

Index signature

[address: string]: Nonce

Defined in

src/types/api/sequencer.ts:306


Nonce

Ƭ Nonce: string

Defined in

src/types/api/sequencer.ts:308


DeployedContracts

Ƭ DeployedContracts: DeployedContractItem[]

Defined in

src/types/api/sequencer.ts:310


OldDeclaredContracts

Ƭ OldDeclaredContracts: string[]

Defined in

src/types/api/sequencer.ts:312


DeclaredClasses

Ƭ DeclaredClasses: DeclaredClass[]

Defined in

src/types/api/sequencer.ts:314


DeclaredClass

Ƭ DeclaredClass: Object

Type declaration

NameType
class_hashstring
compiled_class_hashstring

Defined in

src/types/api/sequencer.ts:316


ReplacedClasses

Ƭ ReplacedClasses: string[]

Defined in

src/types/api/sequencer.ts:318


Endpoints

Ƭ Endpoints: Object

Type declaration

NameType
get_contract_addresses{ QUERY: never ; REQUEST: never ; RESPONSE: GetContractAddressesResponse }
get_contract_addresses.QUERYnever
get_contract_addresses.REQUESTnever
get_contract_addresses.RESPONSEGetContractAddressesResponse
add_transaction{ QUERY: never ; REQUEST: Transaction ; RESPONSE: AddTransactionResponse }
add_transaction.QUERYnever
add_transaction.REQUESTTransaction
add_transaction.RESPONSEAddTransactionResponse
get_transaction{ QUERY: { transactionHash: string } ; REQUEST: never ; RESPONSE: GetTransactionResponse }
get_transaction.QUERY{ transactionHash: string }
get_transaction.QUERY.transactionHashstring
get_transaction.REQUESTnever
get_transaction.RESPONSEGetTransactionResponse
get_transaction_status{ QUERY: { transactionHash: string } ; REQUEST: never ; RESPONSE: GetTransactionStatusResponse }
get_transaction_status.QUERY{ transactionHash: string }
get_transaction_status.QUERY.transactionHashstring
get_transaction_status.REQUESTnever
get_transaction_status.RESPONSEGetTransactionStatusResponse
get_transaction_trace{ QUERY: { transactionHash: string } ; REQUEST: never ; RESPONSE: TransactionTraceResponse }
get_transaction_trace.QUERY{ transactionHash: string }
get_transaction_trace.QUERY.transactionHashstring
get_transaction_trace.REQUESTnever
get_transaction_trace.RESPONSETransactionTraceResponse
get_transaction_receipt{ QUERY: { transactionHash: string } ; REQUEST: never ; RESPONSE: TransactionReceiptResponse }
get_transaction_receipt.QUERY{ transactionHash: string }
get_transaction_receipt.QUERY.transactionHashstring
get_transaction_receipt.REQUESTnever
get_transaction_receipt.RESPONSETransactionReceiptResponse
get_nonce{ QUERY: { contractAddress: string ; blockIdentifier: BlockIdentifier } ; REQUEST: never ; RESPONSE: Nonce }
get_nonce.QUERY{ contractAddress: string ; blockIdentifier: BlockIdentifier }
get_nonce.QUERY.contractAddressstring
get_nonce.QUERY.blockIdentifierBlockIdentifier
get_nonce.REQUESTnever
get_nonce.RESPONSENonce
get_storage_at{ QUERY: { contractAddress: string ; key: BigNumberish ; blockIdentifier: BlockIdentifier } ; REQUEST: never ; RESPONSE: Storage }
get_storage_at.QUERY{ contractAddress: string ; key: BigNumberish ; blockIdentifier: BlockIdentifier }
get_storage_at.QUERY.contractAddressstring
get_storage_at.QUERY.keyBigNumberish
get_storage_at.QUERY.blockIdentifierBlockIdentifier
get_storage_at.REQUESTnever
get_storage_at.RESPONSEStorage
get_code{ QUERY: { contractAddress: string ; blockIdentifier: BlockIdentifier } ; REQUEST: never ; RESPONSE: GetCodeResponse }
get_code.QUERY{ contractAddress: string ; blockIdentifier: BlockIdentifier }
get_code.QUERY.contractAddressstring
get_code.QUERY.blockIdentifierBlockIdentifier
get_code.REQUESTnever
get_code.RESPONSEGetCodeResponse
get_block{ QUERY: { blockIdentifier: BlockIdentifier } ; REQUEST: never ; RESPONSE: GetBlockResponse }
get_block.QUERY{ blockIdentifier: BlockIdentifier }
get_block.QUERY.blockIdentifierBlockIdentifier
get_block.REQUESTnever
get_block.RESPONSEGetBlockResponse
call_contract{ QUERY: { blockIdentifier: BlockIdentifier } ; REQUEST: CallContractTransaction ; RESPONSE: CallContractResponse }
call_contract.QUERY{ blockIdentifier: BlockIdentifier }
call_contract.QUERY.blockIdentifierBlockIdentifier
call_contract.REQUESTCallContractTransaction
call_contract.RESPONSECallContractResponse
estimate_fee{ QUERY: { blockIdentifier: BlockIdentifier ; skipValidate: boolean } ; REQUEST: EstimateFeeRequest ; RESPONSE: EstimateFeeResponse }
estimate_fee.QUERY{ blockIdentifier: BlockIdentifier ; skipValidate: boolean }
estimate_fee.QUERY.blockIdentifierBlockIdentifier
estimate_fee.QUERY.skipValidateboolean
estimate_fee.REQUESTEstimateFeeRequest
estimate_fee.RESPONSEEstimateFeeResponse
get_class_by_hash{ QUERY: { classHash: string ; blockIdentifier?: BlockIdentifier } ; REQUEST: never ; RESPONSE: CompiledContract }
get_class_by_hash.QUERY{ classHash: string ; blockIdentifier?: BlockIdentifier }
get_class_by_hash.QUERY.classHashstring
get_class_by_hash.QUERY.blockIdentifier?BlockIdentifier
get_class_by_hash.REQUESTnever
get_class_by_hash.RESPONSECompiledContract
get_class_hash_at{ QUERY: { contractAddress: string ; blockIdentifier?: BlockIdentifier } ; REQUEST: never ; RESPONSE: string }
get_class_hash_at.QUERY{ contractAddress: string ; blockIdentifier?: BlockIdentifier }
get_class_hash_at.QUERY.contractAddressstring
get_class_hash_at.QUERY.blockIdentifier?BlockIdentifier
get_class_hash_at.REQUESTnever
get_class_hash_at.RESPONSEstring
get_state_update{ QUERY: { blockHash?: string ; blockNumber?: BlockNumber } ; REQUEST: never ; RESPONSE: StateUpdateResponse }
get_state_update.QUERY{ blockHash?: string ; blockNumber?: BlockNumber }
get_state_update.QUERY.blockHash?string
get_state_update.QUERY.blockNumber?BlockNumber
get_state_update.REQUESTnever
get_state_update.RESPONSEStateUpdateResponse
get_full_contract{ QUERY: { contractAddress: string ; blockIdentifier?: BlockIdentifier } ; REQUEST: never ; RESPONSE: CompiledContract }
get_full_contract.QUERY{ contractAddress: string ; blockIdentifier?: BlockIdentifier }
get_full_contract.QUERY.contractAddressstring
get_full_contract.QUERY.blockIdentifier?BlockIdentifier
get_full_contract.REQUESTnever
get_full_contract.RESPONSECompiledContract
estimate_message_fee{ QUERY: any ; REQUEST: any ; RESPONSE: EstimateFeeResponse }
estimate_message_fee.QUERYany
estimate_message_fee.REQUESTany
estimate_message_fee.RESPONSEEstimateFeeResponse
simulate_transaction{ QUERY: { blockIdentifier: BlockIdentifier ; skipValidate: boolean } ; REQUEST: SimulateTransaction ; RESPONSE: TransactionSimulationResponse }
simulate_transaction.QUERY{ blockIdentifier: BlockIdentifier ; skipValidate: boolean }
simulate_transaction.QUERY.blockIdentifierBlockIdentifier
simulate_transaction.QUERY.skipValidateboolean
simulate_transaction.REQUESTSimulateTransaction
simulate_transaction.RESPONSETransactionSimulationResponse
estimate_fee_bulk{ QUERY: { blockIdentifier: BlockIdentifier } ; REQUEST: EstimateFeeRequestBulk ; RESPONSE: EstimateFeeResponseBulk }
estimate_fee_bulk.QUERY{ blockIdentifier: BlockIdentifier }
estimate_fee_bulk.QUERY.blockIdentifierBlockIdentifier
estimate_fee_bulk.REQUESTEstimateFeeRequestBulk
estimate_fee_bulk.RESPONSEEstimateFeeResponseBulk
get_block_traces{ QUERY: { blockHash?: string ; blockNumber?: BlockNumber } ; REQUEST: never ; RESPONSE: BlockTransactionTracesResponse }
get_block_traces.QUERY{ blockHash?: string ; blockNumber?: BlockNumber }
get_block_traces.QUERY.blockHash?string
get_block_traces.QUERY.blockNumber?BlockNumber
get_block_traces.REQUESTnever
get_block_traces.RESPONSEBlockTransactionTracesResponse
get_compiled_class_by_class_hash{ QUERY: { classHash: string ; blockIdentifier?: BlockIdentifier } ; REQUEST: any ; RESPONSE: CairoAssembly }
get_compiled_class_by_class_hash.QUERY{ classHash: string ; blockIdentifier?: BlockIdentifier }
get_compiled_class_by_class_hash.QUERY.classHashstring
get_compiled_class_by_class_hash.QUERY.blockIdentifier?BlockIdentifier
get_compiled_class_by_class_hash.REQUESTany
get_compiled_class_by_class_hash.RESPONSECairoAssembly

Defined in

src/types/api/sequencer.ts:320