Skip to main content
Version: 6.11.0

Namespace: types

Namespaces​

Enumerations​

Interfaces​

References​

TypedDataRevision​

Re-exports TypedDataRevision


StarknetEnumType​

Re-exports StarknetEnumType


StarknetMerkleType​

Re-exports StarknetMerkleType


StarknetType​

Re-exports StarknetType


StarknetDomain​

Re-exports StarknetDomain


TypedData​

Re-exports TypedData

Type Aliases​

EstimateFeeBulk​

Ƭ EstimateFeeBulk: EstimateFee[]

Defined in​

src/types/account.ts:17


AccountInvocationsFactoryDetails​

Ƭ AccountInvocationsFactoryDetails: { versions: `${ETransactionVersion}`[] ; nonce?: BigNumberish ; blockIdentifier?: BlockIdentifier ; skipValidate?: boolean } & Partial<V3TransactionDetails>

Defined in​

src/types/account.ts:20


MultiDeployContractResponse​

Ƭ MultiDeployContractResponse: Object

Type declaration​

NameType
contract_addressstring[]
transaction_hashstring

Defined in​

src/types/account.ts:48


DeployContractUDCResponse​

Ƭ DeployContractUDCResponse: Object

Type declaration​

NameType
contract_addressstring
transaction_hashstring
addressstring
deployerstring
uniquestring
classHashstring
calldata_lenstring
calldatastring[]
saltstring

Defined in​

src/types/account.ts:53


DeclareDeployUDCResponse​

Ƭ DeclareDeployUDCResponse: Object

Type declaration​

NameType
declare{ class_hash: BigNumberish } & Partial<DeclareTransactionReceiptResponse>
deployDeployContractUDCResponse

Defined in​

src/types/account.ts:65


SimulateTransactionDetails​

Ƭ SimulateTransactionDetails: { nonce?: BigNumberish ; blockIdentifier?: BlockIdentifier ; skipValidate?: boolean ; skipExecute?: boolean } & Partial<V3TransactionDetails>

Defined in​

src/types/account.ts:72


EstimateFeeAction​

Ƭ EstimateFeeAction: { type: INVOKE ; payload: AllowArray<Call> } | { type: DECLARE ; payload: DeclareContractPayload } | { type: DEPLOY_ACCOUNT ; payload: DeployAccountContractPayload } | { type: DEPLOY ; payload: UniversalDeployerContractPayload }

Defined in​

src/types/account.ts:79


StarkProfile​

Ƭ StarkProfile: Object

Type declaration​

NameType
name?string
profilePicture?string
discord?string
twitter?string
github?string
proofOfPersonhood?boolean

Defined in​

src/types/account.ts:97


AsyncContractFunction​

Ƭ AsyncContractFunction<T>: (...args: ArgsOrCalldataWithOptions) => Promise<T>

Type parameters​

NameType
Tany

Type declaration​

â–¸ (...args): Promise<T>

Parameters​
NameType
...argsArgsOrCalldataWithOptions
Returns​

Promise<T>

Defined in​

src/types/contract.ts:11


ContractFunction​

Ƭ ContractFunction: (...args: ArgsOrCalldataWithOptions) => any

Type declaration​

â–¸ (...args): any

Parameters​
NameType
...argsArgsOrCalldataWithOptions
Returns​

any

Defined in​

src/types/contract.ts:12


Result​

Ƭ Result: { [key: string]: any; } | Result[] | bigint | string | boolean | CairoEnum

Defined in​

src/types/contract.ts:14


ArgsOrCalldata​

Ƭ ArgsOrCalldata: RawArgsArray | [Calldata] | Calldata

Defined in​

src/types/contract.ts:24


ArgsOrCalldataWithOptions​

Ƭ ArgsOrCalldataWithOptions: ArgsOrCalldata & ContractOptions

Defined in​

src/types/contract.ts:25


ContractOptions​

Ƭ ContractOptions: Object

Type declaration​

NameType
blockIdentifier?BlockIdentifier
parseRequest?boolean
parseResponse?boolean
formatResponse?{ [key: string]: any; }
maxFee?BigNumberish
nonce?BigNumberish
signature?Signature
addressSalt?string

Defined in​

src/types/contract.ts:26


CallOptions​

Ƭ CallOptions: Pick<ContractOptions, "blockIdentifier" | "parseRequest" | "parseResponse" | "formatResponse">

Defined in​

src/types/contract.ts:37


InvokeOptions​

Ƭ InvokeOptions: Pick<ContractOptions, "maxFee" | "nonce" | "signature" | "parseRequest">

Defined in​

src/types/contract.ts:42


ParsedEvent​

Ƭ ParsedEvent: Object

Index signature​

â–ª [name: string]: ParsedStruct

Defined in​

src/types/contract.ts:47


ParsedEvents​

Ƭ ParsedEvents: ParsedEvent[]

Defined in​

src/types/contract.ts:49


WeierstrassSignatureType​

Ƭ WeierstrassSignatureType: SignatureType

Defined in​

src/types/lib/index.ts:7


ArraySignatureType​

Ƭ ArraySignatureType: string[]

Defined in​

src/types/lib/index.ts:8


Signature​

Ƭ Signature: ArraySignatureType | WeierstrassSignatureType

Defined in​

src/types/lib/index.ts:9


BigNumberish​

Ƭ BigNumberish: string | number | bigint

Defined in​

src/types/lib/index.ts:11


ByteArray​

Ƭ ByteArray: Object

Type declaration​

NameType
dataBigNumberish[]
pending_wordBigNumberish
pending_word_lenBigNumberish

Defined in​

src/types/lib/index.ts:13


Calldata​

Ƭ Calldata: string[] & { __compiled__?: true }

Compiled calldata ready to be sent

decimal-string array

Defined in​

src/types/lib/index.ts:24


RawCalldata​

Ƭ RawCalldata: BigNumberish[]

BigNumberish array

use CallData.compile() to convert to Calldata

Defined in​

src/types/lib/index.ts:53


HexCalldata​

Ƭ HexCalldata: string[]

Hexadecimal-string array

Defined in​

src/types/lib/index.ts:58


AllowArray​

Ƭ AllowArray<T>: T | T[]

Type parameters​

Name
T

Defined in​

src/types/lib/index.ts:60


OptionalPayload​

Ƭ OptionalPayload<T>: { payload: T } | T

Type parameters​

Name
T

Defined in​

src/types/lib/index.ts:62


RawArgs​

Ƭ RawArgs: RawArgsObject | RawArgsArray

Defined in​

src/types/lib/index.ts:64


RawArgsObject​

Ƭ RawArgsObject: Object

Index signature​

â–ª [inputName: string]: MultiType | MultiType[] | RawArgs

Defined in​

src/types/lib/index.ts:66


RawArgsArray​

Ƭ RawArgsArray: (MultiType | MultiType[] | RawArgs)[]

Defined in​

src/types/lib/index.ts:70


MultiType​

Ƭ MultiType: BigNumberish | Uint256 | object | boolean | CairoEnum

Defined in​

src/types/lib/index.ts:72


UniversalDeployerContractPayload​

Ƭ UniversalDeployerContractPayload: Object

Type declaration​

NameType
classHashBigNumberish
salt?string
unique?boolean
constructorCalldata?RawArgs

Defined in​

src/types/lib/index.ts:74


DeployAccountContractPayload​

Ƭ DeployAccountContractPayload: Object

Type declaration​

NameType
classHashstring
constructorCalldata?RawArgs
addressSalt?BigNumberish
contractAddress?string

Defined in​

src/types/lib/index.ts:81


DeployAccountContractTransaction​

Ƭ DeployAccountContractTransaction: Omit<DeployAccountContractPayload, "contractAddress"> & { signature?: Signature }

Defined in​

src/types/lib/index.ts:88


DeclareContractPayload​

Ƭ DeclareContractPayload: Object

Type declaration​

NameType
contractCompiledContract | string
classHash?string
casm?CompiledSierraCasm
compiledClassHash?string

Defined in​

src/types/lib/index.ts:95


CompleteDeclareContractPayload​

Ƭ CompleteDeclareContractPayload: Object

Type declaration​

NameType
contractCompiledContract | string
classHashstring
casm?CompiledSierraCasm
compiledClassHash?string

Defined in​

src/types/lib/index.ts:102


DeclareAndDeployContractPayload​

Ƭ DeclareAndDeployContractPayload: Omit<UniversalDeployerContractPayload, "classHash"> & DeclareContractPayload

Defined in​

src/types/lib/index.ts:109


DeclareContractTransaction​

Ƭ DeclareContractTransaction: Object

Type declaration​

NameType
contractContractClass
senderAddressstring
signature?Signature
compiledClassHash?string

Defined in​

src/types/lib/index.ts:112


CallDetails​

Ƭ CallDetails: Object

Type declaration​

NameType
contractAddressstring
calldata?RawArgs | Calldata
entrypoint?string

Defined in​

src/types/lib/index.ts:119


Invocation​

Ƭ Invocation: CallDetails & { signature?: Signature }

Defined in​

src/types/lib/index.ts:125


Call​

Ƭ Call: CallDetails & { entrypoint: string }

Defined in​

src/types/lib/index.ts:127


CairoVersion​

Ƭ CairoVersion: "0" | "1" | undefined

Defined in​

src/types/lib/index.ts:129


CompilerVersion​

Ƭ CompilerVersion: "0" | "1" | "2" | undefined

Defined in​

src/types/lib/index.ts:130


InvocationsDetails​

Ƭ InvocationsDetails: { nonce?: BigNumberish ; maxFee?: BigNumberish ; version?: BigNumberish } & Partial<V3TransactionDetails>

Defined in​

src/types/lib/index.ts:132


V3TransactionDetails​

Ƭ V3TransactionDetails: Object

Type declaration​

NameType
nonceBigNumberish
versionBigNumberish
resourceBoundsResourceBounds
tipBigNumberish
paymasterDataBigNumberish[]
accountDeploymentDataBigNumberish[]
nonceDataAvailabilityModeEDataAvailabilityMode
feeDataAvailabilityModeEDataAvailabilityMode

Defined in​

src/types/lib/index.ts:138


Details​

Ƭ Details: Object

Contain all additional details params

Type declaration​

NameType
nonceBigNumberish
maxFeeBigNumberish
versionBigNumberish
chainIdStarknetChainId

Defined in​

src/types/lib/index.ts:152


InvocationsDetailsWithNonce​

Ƭ InvocationsDetailsWithNonce: InvocationsDetails & { nonce: BigNumberish } | V3TransactionDetails

Defined in​

src/types/lib/index.ts:159


BlockNumber​

Ƭ BlockNumber: BlockTag | null | number

Defined in​

src/types/lib/index.ts:208


BlockIdentifier​

Ƭ BlockIdentifier: BlockNumber | BigNumberish

hex string and BigInt are detected as block hashes

decimal string and number are detected as block numbers

text string are detected as block tag

null return 'pending' block tag

Defined in​

src/types/lib/index.ts:219


AccountInvocationItem​

Ƭ AccountInvocationItem: { type: typeof DECLARE } & DeclareContractTransaction | { type: typeof DEPLOY_ACCOUNT } & DeployAccountContractTransaction | { type: typeof INVOKE } & Invocation & InvocationsDetailsWithNonce

items used by AccountInvocations

Defined in​

src/types/lib/index.ts:224


AccountInvocations​

Ƭ AccountInvocations: AccountInvocationItem[]

Complete invocations array with account details (internal type from account -> provider)

Defined in​

src/types/lib/index.ts:234


Invocations​

Ƭ Invocations: ({ type: typeof DECLARE } & OptionalPayload<DeclareContractPayload> | { type: typeof DEPLOY } & OptionalPayload<AllowArray<UniversalDeployerContractPayload>> | { type: typeof DEPLOY_ACCOUNT } & OptionalPayload<DeployAccountContractPayload> | { type: typeof INVOKE } & OptionalPayload<AllowArray<Call>>)[]

Invocations array user provide to bulk method (simulate)

Defined in​

src/types/lib/index.ts:239


Tupled​

Ƭ Tupled: Object

Type declaration​

NameType
elementany
typestring

Defined in​

src/types/lib/index.ts:250


Args​

Ƭ Args: Object

Index signature​

â–ª [inputName: string]: BigNumberish | BigNumberish[] | ParsedStruct | ParsedStruct[]

Defined in​

src/types/lib/index.ts:252


ParsedStruct​

Ƭ ParsedStruct: Object

Index signature​

â–ª [key: string]: BigNumberish | BigNumberish[] | ParsedStruct | Uint256

Defined in​

src/types/lib/index.ts:255


waitForTransactionOptions​

Ƭ waitForTransactionOptions: Object

Type declaration​

NameType
retryInterval?number
successStates?(TransactionFinalityStatus | TransactionExecutionStatus)[]
errorStates?(TransactionFinalityStatus | TransactionExecutionStatus)[]

Defined in​

src/types/lib/index.ts:259


getSimulateTransactionOptions​

Ƭ getSimulateTransactionOptions: Object

Type declaration​

NameType
blockIdentifier?BlockIdentifier
skipValidate?boolean
skipExecute?boolean
skipFeeCharge?boolean

Defined in​

src/types/lib/index.ts:265


getContractVersionOptions​

Ƭ getContractVersionOptions: Object

Type declaration​

NameType
blockIdentifier?BlockIdentifier
compiler?boolean

Defined in​

src/types/lib/index.ts:272


getEstimateFeeBulkOptions​

Ƭ getEstimateFeeBulkOptions: Object

Type declaration​

NameType
blockIdentifier?BlockIdentifier
skipValidate?boolean

Defined in​

src/types/lib/index.ts:277


ContractVersion​

Ƭ ContractVersion: Object

Represent Contract version

Type declaration​

NameTypeDescription
cairoCairoVersionversion of the cairo language
compilerCompilerVersionversion of the cairo compiler used to compile the contract

Defined in​

src/types/lib/index.ts:291


ContractClass​

Ƭ ContractClass: LegacyContractClass | SierraContractClass

format produced after compressing compiled contract

CompressedCompiledContract

Defined in​

src/types/lib/contract/index.ts:10


CompiledContract​

Ƭ CompiledContract: LegacyCompiledContract | CompiledSierra

format produced after compile .cairo to .json

Defined in​

src/types/lib/contract/index.ts:15


CairoContract​

Ƭ CairoContract: ContractClass | CompiledContract

Compressed or decompressed Cairo0 or Cairo1 Contract

Defined in​

src/types/lib/contract/index.ts:20


Abi​

Ƭ Abi: ReadonlyArray<FunctionAbi | AbiEvent | AbiStruct | InterfaceAbi | any>

ABI

Defined in​

src/types/lib/contract/abi.ts:4


AbiEntry​

Ƭ AbiEntry: Object

Type declaration​

NameType
namestring
type"felt" | "felt*" | string

Defined in​

src/types/lib/contract/abi.ts:7


EventEntry​

Ƭ EventEntry: Object

Type declaration​

NameType
namestring
type"felt" | "felt*" | string
kind"key" | "data"

Defined in​

src/types/lib/contract/abi.ts:9


FunctionAbi​

Ƭ FunctionAbi: Object

Type declaration​

NameType
inputsAbiEntry[]
namestring
outputsAbiEntry[]
stateMutability?"view"
state_mutability?string
typeFunctionAbiType

Defined in​

src/types/lib/contract/abi.ts:14


AbiStructs​

Ƭ AbiStructs: Object

Index signature​

â–ª [name: string]: AbiStruct

Defined in​

src/types/lib/contract/abi.ts:23


AbiStruct​

Ƭ AbiStruct: Object

Type declaration​

NameType
membersAbiEntry & { offset: number }[]
namestring
sizenumber
type"struct"

Defined in​

src/types/lib/contract/abi.ts:25


AbiInterfaces​

Ƭ AbiInterfaces: Object

Index signature​

â–ª [name: string]: InterfaceAbi

Defined in​

src/types/lib/contract/abi.ts:32


InterfaceAbi​

Ƭ InterfaceAbi: Object

Type declaration​

NameType
itemsFunctionAbi[]
namestring
type"interface"

Defined in​

src/types/lib/contract/abi.ts:33


AbiEnums​

Ƭ AbiEnums: Object

Index signature​

â–ª [name: string]: AbiEnum

Defined in​

src/types/lib/contract/abi.ts:39


AbiEnum​

Ƭ AbiEnum: Object

Type declaration​

NameType
variantsAbiEntry & { offset: number }[]
namestring
sizenumber
type"enum"

Defined in​

src/types/lib/contract/abi.ts:40


AbiEvents​

Ƭ AbiEvents: Object

Index signature​

â–ª [hash: string]: AbiEvent

Defined in​

src/types/lib/contract/abi.ts:53


AbiEvent​

Ƭ AbiEvent: CairoEvent | LegacyEvent

Defined in​

src/types/lib/contract/abi.ts:57


CairoEvent​

Ƭ CairoEvent: CairoEventDefinition | AbiEvents

Defined in​

src/types/lib/contract/abi.ts:60


CairoEventDefinition​

Ƭ CairoEventDefinition: STRUCT_EVENT & { name: string ; type: "event" }

Defined in​

src/types/lib/contract/abi.ts:62


CairoEventVariant​

Ƭ CairoEventVariant: ENUM_EVENT & { name: string ; type: string }

Defined in​

src/types/lib/contract/abi.ts:67


LegacyEvent​

Ƭ LegacyEvent: Object

Type declaration​

NameType
namestring
type"event"
dataEVENT_FIELD[]
keysEVENT_FIELD[]

Defined in​

src/types/lib/contract/abi.ts:72


LegacyContractClass​

Ƭ LegacyContractClass: Object

format produced after compressing 'program' property

Type declaration​

NameType
programCompressedProgram
entry_points_by_typeEntryPointsByType
abiAbi

Defined in​

src/types/lib/contract/legacy.ts:7


LegacyCompiledContract​

Ƭ LegacyCompiledContract: Omit<LegacyContractClass, "program"> & { program: Program }

format produced after compiling .cairo to .json

Defined in​

src/types/lib/contract/legacy.ts:16


Builtins​

Ƭ Builtins: string[]

SUBTYPES

Defined in​

src/types/lib/contract/legacy.ts:21


CompressedProgram​

Ƭ CompressedProgram: string

Defined in​

src/types/lib/contract/legacy.ts:22


EntryPointsByType​

Ƭ EntryPointsByType: Object

Type declaration​

NameType
CONSTRUCTORContractEntryPointFields[]
EXTERNALContractEntryPointFields[]
L1_HANDLERContractEntryPointFields[]

Defined in​

src/types/lib/contract/legacy.ts:24


ContractEntryPointFields​

Ƭ ContractEntryPointFields: Object

Type declaration​

NameType
selectorstring
offsetstring | number
builtins?Builtins

Defined in​

src/types/lib/contract/legacy.ts:30


CairoAssembly​

Ƭ CairoAssembly: Object

SYSTEM TYPES

Type declaration​

NameType
primestring
compiler_versionstring
bytecodeByteCode
hintsany[]
pythonic_hints?PythonicHints
bytecode_segment_lengths?number[]
entry_points_by_typeEntryPointsByType

Defined in​

src/types/lib/contract/sierra.ts:5


CompiledSierra​

Ƭ CompiledSierra: Object

format produced after starknet-compile .cairo to .json

sierra_program is hex array

Type declaration​

NameType
sierra_programByteCode
sierra_program_debug_info?SierraProgramDebugInfo
contract_class_versionstring
entry_points_by_typeSierraEntryPointsByType
abiAbi

Defined in​

src/types/lib/contract/sierra.ts:21


SierraContractClass​

Ƭ SierraContractClass: Omit<CompiledSierra, "abi" | "sierra_program_debug_info"> & { sierra_program: string ; abi: string }

format produced after compressing 'sierra_program', stringifies 'abi' property and omit sierra_program_debug_info

CompressedCompiledSierra

Defined in​

src/types/lib/contract/sierra.ts:34


CompiledSierraCasm​

Ƭ CompiledSierraCasm: CairoAssembly

Defined in​

src/types/lib/contract/sierra.ts:38


ByteCode​

Ƭ ByteCode: string[]

SUBTYPES

Defined in​

src/types/lib/contract/sierra.ts:41


PythonicHints​

Ƭ PythonicHints: [number, string[]][]

Defined in​

src/types/lib/contract/sierra.ts:42


SierraProgramDebugInfo​

Ƭ SierraProgramDebugInfo: Object

Type declaration​

NameType
type_names[number, string][]
libfunc_names[number, string][]
user_func_names[number, string][]

Defined in​

src/types/lib/contract/sierra.ts:44


SierraEntryPointsByType​

Ƭ SierraEntryPointsByType: Object

Type declaration​

NameType
CONSTRUCTORSierraContractEntryPointFields[]
EXTERNALSierraContractEntryPointFields[]
L1_HANDLERSierraContractEntryPointFields[]

Defined in​

src/types/lib/contract/sierra.ts:50


SierraContractEntryPointFields​

Ƭ SierraContractEntryPointFields: Object

Type declaration​

NameType
selectorstring
function_idxnumber

Defined in​

src/types/lib/contract/sierra.ts:56


RpcProviderOptions​

Ƭ RpcProviderOptions: Object

Type declaration​

NameType
nodeUrl?string | NetworkName
retries?number
transactionRetryIntervalFallback?number
headers?object
blockIdentifier?BlockIdentifier
chainId?StarknetChainId
specVersion?string
default?boolean
waitMode?boolean
feeMarginPercentage?{ l1BoundMaxAmount: number ; l1BoundMaxPricePerUnit: number ; maxFee: number }
feeMarginPercentage.l1BoundMaxAmountnumber
feeMarginPercentage.l1BoundMaxPricePerUnitnumber
feeMarginPercentage.maxFeenumber

Defined in​

src/types/provider/configuration.ts:6


BlockWithTxHashes​

Ƭ BlockWithTxHashes: Merge<BlockWithTxHashes, BlockWithTxHashes>

Defined in​

src/types/provider/spec.ts:101


ContractClassPayload​

Ƭ ContractClassPayload: Merge<ContractClass, ContractClass>

Defined in​

src/types/provider/spec.ts:102


FeeEstimate​

Ƭ FeeEstimate: Merge<FEE_ESTIMATE, FEE_ESTIMATE>

Defined in​

src/types/provider/spec.ts:104


TransactionReceipt​

Ƭ TransactionReceipt: Merge<TransactionReceipt, TransactionReceipt>

Defined in​

src/types/provider/spec.ts:110


GetBlockResponse​

Ƭ GetBlockResponse: PendingBlock | Block

Defined in​

src/types/provider/response.ts:42


PendingBlock​

Ƭ PendingBlock: Object

Type declaration​

NameType
status"PENDING"
parent_hashBLOCK_HASH
timestampnumber
sequencer_addressFELT
l1_gas_priceRESOURCE_PRICE
starknet_versionstring
transactionsTXN_HASH[]

Defined in​

src/types/provider/response.ts:44


Block​

Ƭ Block: Object

Type declaration​

NameType
status"ACCEPTED_ON_L2" | "ACCEPTED_ON_L1" | "REJECTED"
block_hashBLOCK_HASH
parent_hashBLOCK_HASH
block_numberBLOCK_NUMBER
new_rootFELT
timestampnumber
sequencer_addressFELT
l1_gas_priceRESOURCE_PRICE
starknet_versionstring
transactionsTXN_HASH[]

Defined in​

src/types/provider/response.ts:54


RevertedTransactionReceiptResponse​

Ƭ RevertedTransactionReceiptResponse: Object

Type declaration​

NameType
type?TransactionType | any
execution_statusREVERTED | any
finality_statusTransactionFinalityStatus | any
status?TransactionStatus
actual_feestring
block_hash?string
block_number?BlockNumber
transaction_hashstring
transaction_index?number
messages_sentMessageToL1[]
eventsany[]
revert_reason?string

Defined in​

src/types/provider/response.ts:72


RejectedTransactionReceiptResponse​

Ƭ RejectedTransactionReceiptResponse: Object

Type declaration​

NameType
status`${REJECTED}`
transaction_failure_reason{ code: string ; error_message: string }
transaction_failure_reason.codestring
transaction_failure_reason.error_messagestring

Defined in​

src/types/provider/response.ts:87


GetTxReceiptResponseWithoutHelper​

Ƭ GetTxReceiptResponseWithoutHelper: SuccessfulTransactionReceiptResponse | RevertedTransactionReceiptResponse | RejectedTransactionReceiptResponse

Defined in​

src/types/provider/response.ts:95


SuccessfulTransactionReceiptResponse​

Ƭ SuccessfulTransactionReceiptResponse: InvokeTransactionReceiptResponse | DeployTransactionReceiptResponse | DeclareTransactionReceiptResponse

Defined in​

src/types/provider/response.ts:100


GetTransactionResponse​

Ƭ GetTransactionResponse: TransactionWithHash

Defined in​

src/types/provider/response.ts:105


InvokeTransactionReceiptResponse​

Ƭ InvokeTransactionReceiptResponse: INVOKE_TXN_RECEIPT | PENDING_INVOKE_TXN_RECEIPT

Defined in​

src/types/provider/response.ts:107


DeclareTransactionReceiptResponse​

Ƭ DeclareTransactionReceiptResponse: DECLARE_TXN_RECEIPT | PENDING_DECLARE_TXN_RECEIPT

Defined in​

src/types/provider/response.ts:108


DeployTransactionReceiptResponse​

Ƭ DeployTransactionReceiptResponse: InvokeTransactionReceiptResponse

Defined in​

src/types/provider/response.ts:109


DeployAccountTransactionReceiptResponse​

Ƭ DeployAccountTransactionReceiptResponse: DEPLOY_ACCOUNT_TXN_RECEIPT | PENDING_DEPLOY_ACCOUNT_TXN_RECEIPT

Defined in​

src/types/provider/response.ts:110


L1HandlerTransactionReceiptResponse​

Ƭ L1HandlerTransactionReceiptResponse: L1_HANDLER_TXN_RECEIPT | PENDING_L1_HANDLER_TXN_RECEIPT

Defined in​

src/types/provider/response.ts:113


EstimateFeeResponseBulk​

Ƭ EstimateFeeResponseBulk: EstimateFeeResponse[]

Defined in​

src/types/provider/response.ts:128


InvokeFunctionResponse​

Ƭ InvokeFunctionResponse: InvokedTransaction

Defined in​

src/types/provider/response.ts:130


DeclareContractResponse​

Ƭ DeclareContractResponse: DeclaredTransaction

Defined in​

src/types/provider/response.ts:132


CallContractResponse​

Ƭ CallContractResponse: string[]

Defined in​

src/types/provider/response.ts:134


Storage​

Ƭ Storage: FELT

Defined in​

src/types/provider/response.ts:136


Nonce​

Ƭ Nonce: string

Defined in​

src/types/provider/response.ts:138


SIMULATION_FLAG​

Ƭ SIMULATION_FLAG: Merge<SIMULATION_FLAG, SIMULATION_FLAG>

Defined in​

src/types/provider/spec.ts:60


SimulationFlags​

Ƭ SimulationFlags: SIMULATION_FLAG[]

Defined in​

src/types/provider/response.ts:141


SimulatedTransaction​

Ƭ SimulatedTransaction: SimulateTransaction & { suggestedMaxFee: bigint ; resourceBounds: ResourceBounds }

Defined in​

src/types/provider/response.ts:143


SimulateTransactionResponse​

Ƭ SimulateTransactionResponse: SimulatedTransaction[]

Defined in​

src/types/provider/response.ts:148


StateUpdateResponse​

Ƭ StateUpdateResponse: StateUpdate | PendingStateUpdate

Defined in​

src/types/provider/response.ts:150


StateUpdate​

Ƭ StateUpdate: STATE_UPDATE

Defined in​

src/types/provider/response.ts:151


PendingStateUpdate​

Ƭ PendingStateUpdate: PENDING_STATE_UPDATE

Defined in​

src/types/provider/response.ts:152


ContractClassResponse​

Ƭ ContractClassResponse: LegacyContractClass | Omit<CompiledSierra, "sierra_program_debug_info">

Standardized type

Cairo0 program compressed and Cairo1 sierra_program decompressed

abi Abi

CompiledSierra without '.sierra_program_debug_info'

Defined in​

src/types/provider/response.ts:163


InvocationsSignerDetails​

Ƭ InvocationsSignerDetails: V2InvocationsSignerDetails | V3InvocationsSignerDetails & { version: `${ETransactionVersion}` ; skipValidate?: boolean }

Defined in​

src/types/signer.ts:11


V2InvocationsSignerDetails​

Ƭ V2InvocationsSignerDetails: Object

Type declaration​

NameType
walletAddressstring
cairoVersionCairoVersion
chainIdStarknetChainId
nonceBigNumberish
maxFeeBigNumberish
version`${ETransactionVersion2}`

Defined in​

src/types/signer.ts:16


V3InvocationsSignerDetails​

Ƭ V3InvocationsSignerDetails: V3TransactionDetails & { walletAddress: string ; cairoVersion: CairoVersion ; chainId: StarknetChainId ; version: `${ETransactionVersion3}` }

Defined in​

src/types/signer.ts:25


DeclareSignerDetails​

Ƭ DeclareSignerDetails: V3DeclareSignerDetails | V2DeclareSignerDetails & { version: `${ETransactionVersion}` }

Defined in​

src/types/signer.ts:32


V2DeclareSignerDetails​

Ƭ V2DeclareSignerDetails: Required<InvocationsDetails> & { classHash: string ; compiledClassHash?: string ; senderAddress: string ; chainId: StarknetChainId ; version: `${ETransactionVersion2}` }

Defined in​

src/types/signer.ts:36


V3DeclareSignerDetails​

Ƭ V3DeclareSignerDetails: V3TransactionDetails & { classHash: string ; compiledClassHash: string ; senderAddress: string ; chainId: StarknetChainId ; version: `${ETransactionVersion3}` }

Defined in​

src/types/signer.ts:44


DeployAccountSignerDetails​

Ƭ DeployAccountSignerDetails: V2DeployAccountSignerDetails | V3DeployAccountSignerDetails

Defined in​

src/types/signer.ts:52


V2DeployAccountSignerDetails​

Ƭ V2DeployAccountSignerDetails: Required<DeployAccountContractPayload> & Required<InvocationsDetails> & { contractAddress: BigNumberish ; chainId: StarknetChainId ; version: `${ETransactionVersion2}` }

Defined in​

src/types/signer.ts:56


V3DeployAccountSignerDetails​

Ƭ V3DeployAccountSignerDetails: Required<DeployAccountContractPayload> & V3TransactionDetails & { contractAddress: BigNumberish ; chainId: StarknetChainId ; version: `${ETransactionVersion3}` }

Defined in​

src/types/signer.ts:63


CairoEnum​

Ƭ CairoEnum: CairoCustomEnum | CairoOption<any> | CairoResult<any, any>

Defined in​

src/types/cairoEnum.ts:3


TransactionStatusReceiptSets​

Ƭ TransactionStatusReceiptSets: Object

Type declaration​

NameType
successSuccessfulTransactionReceiptResponse
revertedRevertedTransactionReceiptResponse
rejectedRejectedTransactionReceiptResponse
errorError

Defined in​

src/types/transactionReceipt.ts:7


TransactionReceiptStatus​

Ƭ TransactionReceiptStatus: keyof TransactionStatusReceiptSets

Defined in​

src/types/transactionReceipt.ts:13


TransactionReceiptValue​

Ƭ TransactionReceiptValue: TransactionStatusReceiptSets[TransactionReceiptStatus]

Defined in​

src/types/transactionReceipt.ts:14


TransactionReceiptCallbacksDefined​

Ƭ TransactionReceiptCallbacksDefined: { [key in TransactionReceiptStatus]: Function }

Defined in​

src/types/transactionReceipt.ts:16


TransactionReceiptCallbacksDefault​

Ƭ TransactionReceiptCallbacksDefault: Partial<TransactionReceiptCallbacksDefined> & { _: () => void }

Defined in​

src/types/transactionReceipt.ts:19


TransactionReceiptCallbacks​

Ƭ TransactionReceiptCallbacks: TransactionReceiptCallbacksDefined | TransactionReceiptCallbacksDefault

Defined in​

src/types/transactionReceipt.ts:22


TransactionReceiptUtilityInterface​

Ƭ TransactionReceiptUtilityInterface: { statusReceipt: TransactionReceiptStatus ; value: TransactionReceiptValue ; match: (callbacks: TransactionReceiptCallbacks) => void } & { [key in `is${Capitalize<TransactionReceiptStatus>}`]: Function }

Defined in​

src/types/transactionReceipt.ts:26