Skip to main content
Version: Next

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​

WeierstrassSignatureType​

Ƭ WeierstrassSignatureType: SignatureType

Defined in​

src/types/lib/index.ts:10


ArraySignatureType​

Ƭ ArraySignatureType: string[]

Defined in​

src/types/lib/index.ts:11


Signature​

Ƭ Signature: ArraySignatureType | WeierstrassSignatureType

Defined in​

src/types/lib/index.ts:12


BigNumberish​

Ƭ BigNumberish: string | number | bigint

Defined in​

src/types/lib/index.ts:14


ByteArray​

Ƭ ByteArray: Object

Type declaration​

NameType
dataBigNumberish[]
pending_wordBigNumberish
pending_word_lenBigNumberish

Defined in​

src/types/lib/index.ts:16


Calldata​

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

Compiled calldata ready to be sent

decimal-string array

Defined in​

src/types/lib/index.ts:27


RawCalldata​

Ƭ RawCalldata: BigNumberish[]

BigNumberish array

use CallData.compile() to convert to Calldata

Defined in​

src/types/lib/index.ts:56


HexCalldata​

Ƭ HexCalldata: string[]

Hexadecimal-string array

Defined in​

src/types/lib/index.ts:61


AllowArray​

Ƭ AllowArray<T>: T | T[]

Type parameters​

Name
T

Defined in​

src/types/lib/index.ts:63


OptionalPayload​

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

Type parameters​

Name
T

Defined in​

src/types/lib/index.ts:65


RawArgs​

Ƭ RawArgs: RawArgsObject | RawArgsArray

Defined in​

src/types/lib/index.ts:67


RawArgsObject​

Ƭ RawArgsObject: Object

Index signature​

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

Defined in​

src/types/lib/index.ts:69


RawArgsArray​

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

Defined in​

src/types/lib/index.ts:73


MultiType​

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

Defined in​

src/types/lib/index.ts:75


UniversalDeployerContractPayload​

Ƭ UniversalDeployerContractPayload: Object

Type declaration​

NameType
classHashBigNumberish
salt?string
unique?boolean
constructorCalldata?RawArgs

Defined in​

src/types/lib/index.ts:77


DeployAccountContractPayload​

Ƭ DeployAccountContractPayload: Object

Type declaration​

NameType
classHashstring
constructorCalldata?RawArgs
addressSalt?BigNumberish
contractAddress?string

Defined in​

src/types/lib/index.ts:84


DeployAccountContractTransaction​

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

Defined in​

src/types/lib/index.ts:91


DeclareContractPayload​

Ƭ DeclareContractPayload: Object

Type declaration​

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

Defined in​

src/types/lib/index.ts:98


ContractClassIdentifier​

Ƭ ContractClassIdentifier: DeclareContractPayload | { classHash: string }

DeclareContractPayload with classHash or contract defined

Defined in​

src/types/lib/index.ts:108


CompleteDeclareContractPayload​

Ƭ CompleteDeclareContractPayload: Object

Type declaration​

NameType
contractCompiledContract | string
classHashstring
casm?CompiledSierraCasm
compiledClassHash?string

Defined in​

src/types/lib/index.ts:110


DeclareAndDeployContractPayload​

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

Defined in​

src/types/lib/index.ts:117


DeclareContractTransaction​

Ƭ DeclareContractTransaction: Object

Type declaration​

NameType
contractContractClass
senderAddressstring
signature?Signature
compiledClassHash?string

Defined in​

src/types/lib/index.ts:120


CallDetails​

Ƭ CallDetails: Object

Type declaration​

NameType
contractAddressstring
calldata?RawArgs | Calldata
entrypoint?string

Defined in​

src/types/lib/index.ts:127


Invocation​

Ƭ Invocation: CallDetails & { signature?: Signature }

Defined in​

src/types/lib/index.ts:133


Call​

Ƭ Call: CallDetails & { entrypoint: string }

Defined in​

src/types/lib/index.ts:135


CairoVersion​

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

Defined in​

src/types/lib/index.ts:137


CompilerVersion​

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

Defined in​

src/types/lib/index.ts:138


InvocationsDetails​

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

Defined in​

src/types/lib/index.ts:140


V3TransactionDetails​

Ƭ V3TransactionDetails: Object

Type declaration​

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

Defined in​

src/types/lib/index.ts:146


Details​

Ƭ Details: Object

Contain all additional details params

Type declaration​

NameType
nonceBigNumberish
maxFeeBigNumberish
versionBigNumberish
chainIdStarknetChainId

Defined in​

src/types/lib/index.ts:160


InvocationsDetailsWithNonce​

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

Defined in​

src/types/lib/index.ts:167


TransactionType​

Ƭ TransactionType: ValuesType<typeof TransactionType>

Defined in​

src/types/lib/index.ts:171

src/types/lib/index.ts:178


TransactionFinalityStatus​

Ƭ TransactionFinalityStatus: ValuesType<typeof TransactionFinalityStatus>

Defined in​

src/types/lib/index.ts:195

src/types/lib/index.ts:202


TransactionExecutionStatus​

Ƭ TransactionExecutionStatus: ValuesType<typeof TransactionExecutionStatus>

Defined in​

src/types/lib/index.ts:204

src/types/lib/index.ts:210


BlockStatus​

Ƭ BlockStatus: ValuesType<typeof BlockStatus>

Defined in​

src/types/lib/index.ts:212

src/types/lib/index.ts:219


BlockTag​

Ƭ BlockTag: ValuesType<typeof BlockTag>

Defined in​

src/types/lib/index.ts:221

src/types/lib/index.ts:226


BlockNumber​

Ƭ BlockNumber: BlockTag | null | number

Defined in​

src/types/lib/index.ts:228


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:239


SubscriptionBlockIdentifier​

Ƭ SubscriptionBlockIdentifier: SUBSCRIPTION_BLOCK_TAG | string & {} | number | bigint

Defined in​

src/types/lib/index.ts:241


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:246


AccountInvocations​

Ƭ AccountInvocations: AccountInvocationItem[]

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

Defined in​

src/types/lib/index.ts:256


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:261


Tupled​

Ƭ Tupled: Object

Type declaration​

NameType
elementany
typestring

Defined in​

src/types/lib/index.ts:272


Args​

Ƭ Args: Object

Index signature​

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

Defined in​

src/types/lib/index.ts:274


ParsedStruct​

Ƭ ParsedStruct: Object

Index signature​

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

Defined in​

src/types/lib/index.ts:277


waitForTransactionOptions​

Ƭ waitForTransactionOptions: Object

Type declaration​

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

Defined in​

src/types/lib/index.ts:281


getSimulateTransactionOptions​

Ƭ getSimulateTransactionOptions: Object

Type declaration​

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

Defined in​

src/types/lib/index.ts:287


getContractVersionOptions​

Ƭ getContractVersionOptions: Object

Type declaration​

NameType
blockIdentifier?BlockIdentifier
compiler?boolean

Defined in​

src/types/lib/index.ts:294


getEstimateFeeBulkOptions​

Ƭ getEstimateFeeBulkOptions: Object

Type declaration​

NameType
blockIdentifier?BlockIdentifier
skipValidate?boolean

Defined in​

src/types/lib/index.ts:299


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:307


ContractClass​

Ƭ ContractClass: LegacyContractClass | SierraContractClass

format produced after compressing compiled contract

CompressedCompiledContract

Defined in​

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


CompiledContract​

Ƭ CompiledContract: LegacyCompiledContract | CompiledSierra

format produced after compile .cairo to .json

Defined in​

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


CairoContract​

Ƭ CairoContract: ContractClass | CompiledContract

Compressed or decompressed Cairo0 or Cairo1 Contract

Defined in​

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


EntryPointType​

Ƭ EntryPointType: ValuesType<typeof EntryPointType>

Defined in​

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

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


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*" | "event" | 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


FeeMarginPercentage​

Ƭ FeeMarginPercentage: Object

Type declaration​

NameType
boundsResourceBoundsOverhead
maxFeenumber

Defined in​

src/provider/types/configuration.type.ts:7


RpcProviderOptions​

Ƭ RpcProviderOptions: Object

Type declaration​

NameType
nodeUrl?string | NetworkName
retries?number
transactionRetryIntervalFallback?number
headers?object
blockIdentifier?BlockIdentifier
chainId?StarknetChainId
specVersion?SupportedRpcVersion
default?boolean
waitMode?boolean
baseFetch?WindowOrWorkerGlobalScope["fetch"]
feeMarginPercentage?FeeMarginPercentage
batch?false | number

Defined in​

src/provider/types/configuration.type.ts:12


Block​

Ƭ Block: Simplify<BLOCK_WITH_TX_HASHES>

Defined in​

src/provider/types/response.type.ts:31


PendingBlock​

Ƭ PendingBlock: Simplify<PENDING_BLOCK_WITH_TX_HASHES>

Defined in​

src/provider/types/response.type.ts:32


GetBlockResponse​

Ƭ GetBlockResponse: Simplify<BlockWithTxHashes>

Defined in​

src/provider/types/response.type.ts:33


GetTxReceiptResponseWithoutHelper​

Ƭ GetTxReceiptResponseWithoutHelper: TransactionReceipt

Defined in​

src/provider/types/response.type.ts:35


SuccessfulTransactionReceiptResponse​

Ƭ SuccessfulTransactionReceiptResponse: IsSucceeded<TransactionReceipt>

Defined in​

src/provider/types/response.type.ts:37


RevertedTransactionReceiptResponse​

Ƭ RevertedTransactionReceiptResponse: IsReverted<TransactionReceipt>

Defined in​

src/provider/types/response.type.ts:38


InvokeTransactionReceiptResponse​

Ƭ InvokeTransactionReceiptResponse: IsType<TransactionReceipt, "INVOKE">

Defined in​

src/provider/types/response.type.ts:39


DeployTransactionReceiptResponse​

Ƭ DeployTransactionReceiptResponse: InvokeTransactionReceiptResponse

Defined in​

src/provider/types/response.type.ts:40


DeclareTransactionReceiptResponse​

Ƭ DeclareTransactionReceiptResponse: IsType<TransactionReceipt, "DECLARE">

Defined in​

src/provider/types/response.type.ts:41


DeployAccountTransactionReceiptResponse​

Ƭ DeployAccountTransactionReceiptResponse: IsType<TransactionReceipt, "DEPLOY_ACCOUNT">

Defined in​

src/provider/types/response.type.ts:42


L1HandlerTransactionReceiptResponse​

Ƭ L1HandlerTransactionReceiptResponse: IsType<TransactionReceipt, "L1_HANDLER">

Defined in​

src/provider/types/response.type.ts:43


GetTransactionResponse​

Ƭ GetTransactionResponse: TransactionWithHash

Defined in​

src/provider/types/response.type.ts:45


EstimateFeeResponse​

Ƭ EstimateFeeResponse: Object

Type declaration​

NameType
overall_feebigint
unitPRICE_UNIT
l1_gas_consumedbigint
l1_gas_pricebigint
l2_gas_consumedbigint | undefined
l2_gas_pricebigint | undefined
l1_data_gas_consumedbigint
l1_data_gas_pricebigint
suggestedMaxFeebigint
resourceBoundsResourceBounds

Defined in​

src/provider/types/response.type.ts:47


EstimateFeeResponseBulk​

Ƭ EstimateFeeResponseBulk: EstimateFeeResponse[]

Defined in​

src/provider/types/response.type.ts:62


InvokeFunctionResponse​

Ƭ InvokeFunctionResponse: InvokedTransaction

Defined in​

src/provider/types/response.type.ts:64


DeclareContractResponse​

Ƭ DeclareContractResponse: DeclaredTransaction

Defined in​

src/provider/types/response.type.ts:66


CallContractResponse​

Ƭ CallContractResponse: string[]

Defined in​

src/provider/types/response.type.ts:68


Storage​

Ƭ Storage: FELT

Defined in​

src/provider/types/response.type.ts:70


Nonce​

Ƭ Nonce: string

Defined in​

src/provider/types/response.type.ts:72


SimulationFlags​

Ƭ SimulationFlags: SIMULATION_FLAG[]

Defined in​

src/provider/types/response.type.ts:75


SimulatedTransaction​

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

Defined in​

src/provider/types/response.type.ts:77


SimulateTransactionResponse​

Ƭ SimulateTransactionResponse: SimulatedTransaction[]

Defined in​

src/provider/types/response.type.ts:82


StateUpdateResponse​

Ƭ StateUpdateResponse: StateUpdate | PendingStateUpdate

Defined in​

src/provider/types/response.type.ts:84


StateUpdate​

Ƭ StateUpdate: STATE_UPDATE

Defined in​

src/provider/types/response.type.ts:85


PendingStateUpdate​

Ƭ PendingStateUpdate: PENDING_STATE_UPDATE

Defined in​

src/provider/types/response.type.ts:86


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/provider/types/response.type.ts:97


Simplify​

Ƭ Simplify<T>: { [K in keyof T]: T[K] } & {}

Type parameters​

Name
T

Defined in​

src/provider/types/spec.type.ts:9


RequiredKeysOf​

Ƭ RequiredKeysOf<T>: Exclude<{ [K in keyof T]: T extends Record<K, T[K]> ? K : never }[keyof T], undefined>

Type parameters​

NameType
Textends object

Defined in​

src/provider/types/spec.type.ts:12


ETransactionVersion​

Ƭ ETransactionVersion: ETransactionVersion

Defined in​

src/provider/types/spec.type.ts:57

src/provider/types/spec.type.ts:58


ETransactionVersion2​

Ƭ ETransactionVersion2: ETransactionVersion2

Defined in​

src/provider/types/spec.type.ts:60

src/provider/types/spec.type.ts:61


ETransactionVersion3​

Ƭ ETransactionVersion3: ETransactionVersion3

Defined in​

src/provider/types/spec.type.ts:63

src/provider/types/spec.type.ts:64


BLOCK_HASH​

Ƭ BLOCK_HASH: Merge<BLOCK_HASH, BLOCK_HASH>

Defined in​

src/provider/types/spec.type.ts:67


BLOCK_NUMBER​

Ƭ BLOCK_NUMBER: Merge<BLOCK_NUMBER, BLOCK_NUMBER>

Defined in​

src/provider/types/spec.type.ts:68


FELT​

Ƭ FELT: Merge<FELT, FELT>

Defined in​

src/provider/types/spec.type.ts:69


TXN_HASH​

Ƭ TXN_HASH: Merge<TXN_HASH, TXN_HASH>

Defined in​

src/provider/types/spec.type.ts:70


PRICE_UNIT​

Ƭ PRICE_UNIT: Merge<PRICE_UNIT, PRICE_UNIT>

Defined in​

src/provider/types/spec.type.ts:72


RESOURCE_PRICE​

Ƭ RESOURCE_PRICE: Merge<RESOURCE_PRICE, RESOURCE_PRICE>

Defined in​

src/provider/types/spec.type.ts:73


SIMULATION_FLAG​

Ƭ SIMULATION_FLAG: Merge<SIMULATION_FLAG, SIMULATION_FLAG>

Defined in​

src/provider/types/spec.type.ts:74


STATE_UPDATE​

Ƭ STATE_UPDATE: Merge<STATE_UPDATE, STATE_UPDATE>

Defined in​

src/provider/types/spec.type.ts:76


PENDING_STATE_UPDATE​

Ƭ PENDING_STATE_UPDATE: Merge<PENDING_STATE_UPDATE, PENDING_STATE_UPDATE>

Defined in​

src/provider/types/spec.type.ts:77


PENDING_INVOKE_TXN_RECEIPT​

Ƭ PENDING_INVOKE_TXN_RECEIPT: IsPending<IsType<TransactionReceipt, "INVOKE">>

Defined in​

src/provider/types/spec.type.ts:90


PENDING_DECLARE_TXN_RECEIPT​

Ƭ PENDING_DECLARE_TXN_RECEIPT: IsPending<IsType<TransactionReceipt, "DECLARE">>

Defined in​

src/provider/types/spec.type.ts:93


PENDING_DEPLOY_ACCOUNT_TXN_RECEIPT​

Ƭ PENDING_DEPLOY_ACCOUNT_TXN_RECEIPT: IsPending<IsType<TransactionReceipt, "DEPLOY_ACCOUNT">>

Defined in​

src/provider/types/spec.type.ts:96


PENDING_L1_HANDLER_TXN_RECEIPT​

Ƭ PENDING_L1_HANDLER_TXN_RECEIPT: IsPending<IsType<TransactionReceipt, "L1_HANDLER">>

Defined in​

src/provider/types/spec.type.ts:99


BlockWithTxHashes​

Ƭ BlockWithTxHashes: Merge<BlockWithTxHashes, BlockWithTxHashes>

Defined in​

src/provider/types/spec.type.ts:104


ContractClassPayload​

Ƭ ContractClassPayload: Merge<ContractClass, ContractClass>

Defined in​

src/provider/types/spec.type.ts:105


DeclaredTransaction​

Ƭ DeclaredTransaction: Merge<DeclaredTransaction, DeclaredTransaction>

Defined in​

src/provider/types/spec.type.ts:106


InvokedTransaction​

Ƭ InvokedTransaction: Merge<InvokedTransaction, InvokedTransaction>

Defined in​

src/provider/types/spec.type.ts:110


DeployedAccountTransaction​

Ƭ DeployedAccountTransaction: Merge<DeployedAccountTransaction, DeployedAccountTransaction>

Defined in​

src/provider/types/spec.type.ts:111


L1Message​

Ƭ L1Message: Merge<L1Message, L1Message>

Defined in​

src/provider/types/spec.type.ts:116


EventFilter​

Ƭ EventFilter: EventFilter

Defined in​

src/provider/types/spec.type.ts:117


L1_HANDLER_TXN​

Ƭ L1_HANDLER_TXN: L1_HANDLER_TXN

Defined in​

src/provider/types/spec.type.ts:118


EDataAvailabilityMode​

Ƭ EDataAvailabilityMode: EDataAvailabilityMode

Defined in​

src/provider/types/spec.type.ts:119

src/provider/types/spec.type.ts:120


EDAMode​

Ƭ EDAMode: EDAMode

Defined in​

src/provider/types/spec.type.ts:121

src/provider/types/spec.type.ts:122


EmittedEvent​

Ƭ EmittedEvent: Merge<EmittedEvent, EmittedEvent>

Defined in​

src/provider/types/spec.type.ts:123


Event​

Ƭ Event: Merge<Event, Event>

Defined in​

src/provider/types/spec.type.ts:124


PendingReceipt​

Ƭ PendingReceipt: Merge<TransactionReceiptPendingBlock, PendingReceipt>

Defined in​

src/provider/types/spec.type.ts:126


Receipt​

Ƭ Receipt: Merge<TransactionReceiptProductionBlock, Receipt>

Defined in​

src/provider/types/spec.type.ts:130


FeeEstimate​

Ƭ FeeEstimate: SimpleOneOf<FEE_ESTIMATE, FEE_ESTIMATE>

Defined in​

src/provider/types/spec.type.ts:133


ResourceBounds​

Ƭ ResourceBounds: Simplify<SimpleOneOf<ResourceBounds, ResourceBounds>>

Defined in​

src/provider/types/spec.type.ts:140


ResourceBoundsOverhead​

Ƭ ResourceBoundsOverhead: ResourceBoundsOverheadRPC08 | ResourceBoundsOverheadRPC07

overhead percentage on estimate fee

Defined in​

src/provider/types/spec.type.ts:151


ResourceBoundsOverheadRPC08​

Ƭ ResourceBoundsOverheadRPC08: Object

percentage overhead on estimated fee

Type declaration​

NameType
l1_gas{ max_amount: number ; max_price_per_unit: number }
l1_gas.max_amountnumber
l1_gas.max_price_per_unitnumber
l2_gas{ max_amount: number ; max_price_per_unit: number }
l2_gas.max_amountnumber
l2_gas.max_price_per_unitnumber
l1_data_gas{ max_amount: number ; max_price_per_unit: number }
l1_data_gas.max_amountnumber
l1_data_gas.max_price_per_unitnumber

Defined in​

src/provider/types/spec.type.ts:156


ResourceBoundsOverheadRPC07​

Ƭ ResourceBoundsOverheadRPC07: Object

Type declaration​

NameType
l1_gas{ max_amount: number ; max_price_per_unit: number }
l1_gas.max_amountnumber
l1_gas.max_price_per_unitnumber

Defined in​

src/provider/types/spec.type.ts:171


SimulateTransaction​

Ƭ SimulateTransaction: SimulateTransaction

Defined in​

src/provider/types/spec.type.ts:179


TransactionWithHash​

Ƭ TransactionWithHash: Merge<TransactionWithHash, TransactionWithHash>

Defined in​

src/provider/types/spec.type.ts:181


TransactionReceipt​

Ƭ TransactionReceipt: Merge<TransactionReceipt, TransactionReceipt>

Defined in​

src/provider/types/spec.type.ts:186


Methods​

Ƭ Methods: Methods

Defined in​

src/provider/types/spec.type.ts:187


TXN_STATUS​

Ƭ TXN_STATUS: Merge<TXN_STATUS, TXN_STATUS>

Defined in​

src/provider/types/spec.type.ts:188


TXN_EXECUTION_STATUS​

Ƭ TXN_EXECUTION_STATUS: Merge<TXN_EXECUTION_STATUS, TXN_EXECUTION_STATUS>

Defined in​

src/provider/types/spec.type.ts:189


TransactionStatus​

Ƭ TransactionStatus: Merge<TransactionStatus, TransactionStatus>

Defined in​

src/provider/types/spec.type.ts:193


ETransactionStatus​

Ƭ ETransactionStatus: ETransactionStatus

Defined in​

src/provider/types/spec.type.ts:194

src/provider/types/spec.type.ts:195


ETransactionExecutionStatus​

Ƭ ETransactionExecutionStatus: ETransactionExecutionStatus

Defined in​

src/provider/types/spec.type.ts:196

src/provider/types/spec.type.ts:197


TRANSACTION_TRACE​

Ƭ TRANSACTION_TRACE: Merge<TRANSACTION_TRACE, TRANSACTION_TRACE>

Defined in​

src/provider/types/spec.type.ts:198


FEE_ESTIMATE​

Ƭ FEE_ESTIMATE: Merge<FEE_ESTIMATE, FEE_ESTIMATE>

Defined in​

src/provider/types/spec.type.ts:202


EVENTS_CHUNK​

Ƭ EVENTS_CHUNK: Merge<EVENTS_CHUNK, EVENTS_CHUNK>

Defined in​

src/provider/types/spec.type.ts:203


UniversalSuggestedFee​

Ƭ UniversalSuggestedFee: Object

Type declaration​

NameType
maxFeeBigNumberish
resourceBoundsResourceBounds

Defined in​

src/types/account.ts:21


EstimateFeeBulk​

Ƭ EstimateFeeBulk: EstimateFee[]

Defined in​

src/types/account.ts:26


AccountInvocationsFactoryDetails​

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

Defined in​

src/types/account.ts:29


MultiDeployContractResponse​

Ƭ MultiDeployContractResponse: Object

Type declaration​

NameType
contract_addressstring[]
transaction_hashstring

Defined in​

src/types/account.ts:57


DeployContractUDCResponse​

Ƭ DeployContractUDCResponse: Object

Type declaration​

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

Defined in​

src/types/account.ts:62


DeclareDeployUDCResponse​

Ƭ DeclareDeployUDCResponse: Object

Type declaration​

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

Defined in​

src/types/account.ts:74


SimulateTransactionDetails​

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

Defined in​

src/types/account.ts:81


EstimateFeeAction​

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

Defined in​

src/types/account.ts:88


StarkProfile​

Ƭ StarkProfile: Object

Type declaration​

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

Defined in​

src/types/account.ts:106


CairoEnum​

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

Defined in​

src/types/cairoEnum.ts:3


ValidateType​

Ƭ ValidateType: ValuesType<typeof ValidateType>

Defined in​

src/types/calldata.ts:3

src/types/calldata.ts:9


Uint​

Ƭ Uint: ValuesType<typeof Uint>

Defined in​

src/types/calldata.ts:11

src/types/calldata.ts:21


Literal​

Ƭ Literal: ValuesType<typeof Literal>

Defined in​

src/types/calldata.ts:23

src/types/calldata.ts:30


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:13


ContractFunction​

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

Type declaration​

â–¸ (...args): any

Parameters​
NameType
...argsArgsOrCalldataWithOptions
Returns​

any

Defined in​

src/types/contract.ts:14


Result​

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

Defined in​

src/types/contract.ts:16


ArgsOrCalldata​

Ƭ ArgsOrCalldata: RawArgsArray | [Calldata] | Calldata

Defined in​

src/types/contract.ts:30


ArgsOrCalldataWithOptions​

Ƭ ArgsOrCalldataWithOptions: [...RawArgsArray] | [...RawArgsArray, ContractOptions] | [Calldata] | [Calldata, ContractOptions] | [...Calldata] | [...Calldata, ContractOptions]

Defined in​

src/types/contract.ts:41


ContractOptions​

Ƭ ContractOptions: Object

Type declaration​

NameTypeDescription
blockIdentifier?BlockIdentifier-
parseRequest?booleancompile and validate arguments
parseResponse?booleanParse elements of the response array and structuring them into response object
formatResponse?{ [key: string]: any; }Advance formatting used to get js types data as result Description https://starknetjs.com/docs/guides/define_call_message/#formatresponse Example typescript // assign custom or existing method to resulting data formatResponse: { balance: uint256ToBN }, Example typescript // define resulting data js types const formatAnswer = { id: 'number', description: 'string' };
maxFee?BigNumberish-
nonce?BigNumberish-
signature?Signature-
addressSalt?string-

Defined in​

src/types/contract.ts:57


CallOptions​

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

Defined in​

src/types/contract.ts:88


InvokeOptions​

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

Defined in​

src/types/contract.ts:93


ParsedEvent​

Ƭ ParsedEvent: { [name: string]: ParsedStruct; } & { block_hash?: BlockHash ; block_number?: BlockNumber ; transaction_hash?: TransactionHash }

Defined in​

src/types/contract.ts:98


ParsedEvents​

Ƭ ParsedEvents: ParsedEvent[]

Defined in​

src/types/contract.ts:104


RPC_ERROR_SET​

Ƭ RPC_ERROR_SET: Object

Type declaration​

NameType
FAILED_TO_RECEIVE_TXNFAILED_TO_RECEIVE_TXN
NO_TRACE_AVAILABLENO_TRACE_AVAILABLE
CONTRACT_NOT_FOUNDCONTRACT_NOT_FOUND
ENTRYPOINT_NOT_FOUNDENTRYPOINT_NOT_FOUND
BLOCK_NOT_FOUNDBLOCK_NOT_FOUND
INVALID_TXN_INDEXINVALID_TXN_INDEX
CLASS_HASH_NOT_FOUNDCLASS_HASH_NOT_FOUND
TXN_HASH_NOT_FOUNDTXN_HASH_NOT_FOUND
PAGE_SIZE_TOO_BIGPAGE_SIZE_TOO_BIG
NO_BLOCKSNO_BLOCKS
INVALID_CONTINUATION_TOKENINVALID_CONTINUATION_TOKEN
TOO_MANY_KEYS_IN_FILTERTOO_MANY_KEYS_IN_FILTER
CONTRACT_ERRORCONTRACT_ERROR
TRANSACTION_EXECUTION_ERRORTRANSACTION_EXECUTION_ERROR
STORAGE_PROOF_NOT_SUPPORTEDSTORAGE_PROOF_NOT_SUPPORTED
CLASS_ALREADY_DECLAREDCLASS_ALREADY_DECLARED
INVALID_TRANSACTION_NONCEINVALID_TRANSACTION_NONCE
INSUFFICIENT_RESOURCES_FOR_VALIDATEINSUFFICIENT_RESOURCES_FOR_VALIDATE
INSUFFICIENT_ACCOUNT_BALANCEINSUFFICIENT_ACCOUNT_BALANCE
VALIDATION_FAILUREVALIDATION_FAILURE
COMPILATION_FAILEDCOMPILATION_FAILED
CONTRACT_CLASS_SIZE_IS_TOO_LARGECONTRACT_CLASS_SIZE_IS_TOO_LARGE
NON_ACCOUNTNON_ACCOUNT
DUPLICATE_TXDUPLICATE_TX
COMPILED_CLASS_HASH_MISMATCHCOMPILED_CLASS_HASH_MISMATCH
UNSUPPORTED_TX_VERSIONUNSUPPORTED_TX_VERSION
UNSUPPORTED_CONTRACT_CLASS_VERSIONUNSUPPORTED_CONTRACT_CLASS_VERSION
UNEXPECTED_ERRORUNEXPECTED_ERROR
INVALID_SUBSCRIPTION_IDINVALID_SUBSCRIPTION_ID
TOO_MANY_ADDRESSES_IN_FILTERTOO_MANY_ADDRESSES_IN_FILTER
TOO_MANY_BLOCKS_BACKTOO_MANY_BLOCKS_BACK
COMPILATION_ERRORCOMPILATION_ERROR

Defined in​

src/types/errors.ts:4


RPC_ERROR​

Ƭ RPC_ERROR: RPC_ERROR_SET[keyof RPC_ERROR_SET]

Defined in​

src/types/errors.ts:39


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


LedgerPathCalculation​

Ƭ LedgerPathCalculation: (accountId: number, applicationName: string) => Uint8Array

Type declaration​

â–¸ (accountId, applicationName): Uint8Array

Parameters​
NameType
accountIdnumber
applicationNamestring
Returns​

Uint8Array

Defined in​

src/types/signer.ts:70


TransactionStatusReceiptSets​

Ƭ TransactionStatusReceiptSets: Object

Type declaration​

NameType
successSuccessfulTransactionReceiptResponse
revertedRevertedTransactionReceiptResponse
errorError

Defined in​

src/utils/transactionReceipt/transactionReceipt.type.ts:6


TransactionReceiptStatus​

Ƭ TransactionReceiptStatus: keyof TransactionStatusReceiptSets

Defined in​

src/utils/transactionReceipt/transactionReceipt.type.ts:12


TransactionReceiptValue​

Ƭ TransactionReceiptValue: TransactionStatusReceiptSets[TransactionReceiptStatus]

Defined in​

src/utils/transactionReceipt/transactionReceipt.type.ts:13


TransactionReceiptCallbacksDefined​

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

Defined in​

src/utils/transactionReceipt/transactionReceipt.type.ts:15


TransactionReceiptCallbacksDefault​

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

Defined in​

src/utils/transactionReceipt/transactionReceipt.type.ts:18


TransactionReceiptCallbacks​

Ƭ TransactionReceiptCallbacks: TransactionReceiptCallbacksDefined | TransactionReceiptCallbacksDefault

Defined in​

src/utils/transactionReceipt/transactionReceipt.type.ts:21


GetTransactionReceiptResponse​

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

Defined in​

src/utils/transactionReceipt/transactionReceipt.type.ts:25

Variables​

TransactionType​

• Const TransactionType: Object

Type declaration​

NameType
DECLARE"DECLARE"
DEPLOY"DEPLOY"
DEPLOY_ACCOUNT"DEPLOY_ACCOUNT"
INVOKE"INVOKE_FUNCTION"

Defined in​

src/types/lib/index.ts:171

src/types/lib/index.ts:178


TransactionFinalityStatus​

• Const TransactionFinalityStatus: Object

new statuses are defined by props: finality_status and execution_status to be #deprecated

Type declaration​

NameType
NOT_RECEIVED"NOT_RECEIVED"
RECEIVED"RECEIVED"
ACCEPTED_ON_L2"ACCEPTED_ON_L2"
ACCEPTED_ON_L1"ACCEPTED_ON_L1"

Defined in​

src/types/lib/index.ts:195

src/types/lib/index.ts:202


TransactionExecutionStatus​

• Const TransactionExecutionStatus: Object

Type declaration​

NameType
REJECTED"REJECTED"
REVERTED"REVERTED"
SUCCEEDED"SUCCEEDED"

Defined in​

src/types/lib/index.ts:204

src/types/lib/index.ts:210


BlockStatus​

• Const BlockStatus: Object

Type declaration​

NameType
PENDING"PENDING"
ACCEPTED_ON_L1"ACCEPTED_ON_L1"
ACCEPTED_ON_L2"ACCEPTED_ON_L2"
REJECTED"REJECTED"

Defined in​

src/types/lib/index.ts:212

src/types/lib/index.ts:219


BlockTag​

• Const BlockTag: Object

Type declaration​

NameType
PENDING"pending"
LATEST"latest"

Defined in​

src/types/lib/index.ts:221

src/types/lib/index.ts:226


EntryPointType​

• Const EntryPointType: Object

Type declaration​

NameType
EXTERNAL"EXTERNAL"
L1_HANDLER"L1_HANDLER"
CONSTRUCTOR"CONSTRUCTOR"

Defined in​

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

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


ETransactionVersion​

• ETransactionVersion: Object

Type declaration​

NameTypeDescription
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​

src/provider/types/spec.type.ts:57

src/provider/types/spec.type.ts:58


ETransactionVersion2​

• ETransactionVersion2: Object

Type declaration​

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

Defined in​

src/provider/types/spec.type.ts:60

src/provider/types/spec.type.ts:61


ETransactionVersion3​

• ETransactionVersion3: Object

Type declaration​

NameType
V3"0x3"
F3"0x100000000000000000000000000000003"

Defined in​

src/provider/types/spec.type.ts:63

src/provider/types/spec.type.ts:64


EDataAvailabilityMode​

• EDataAvailabilityMode: Object

Type declaration​

NameType
L1"L1"
L2"L2"

Defined in​

src/provider/types/spec.type.ts:119

src/provider/types/spec.type.ts:120


EDAMode​

• EDAMode: Object

Type declaration​

NameType
L10
L21

Defined in​

src/provider/types/spec.type.ts:121

src/provider/types/spec.type.ts:122


ETransactionStatus​

• ETransactionStatus: Object

Type declaration​

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

Defined in​

src/provider/types/spec.type.ts:194

src/provider/types/spec.type.ts:195


ETransactionExecutionStatus​

• ETransactionExecutionStatus: Object

Type declaration​

NameType
SUCCEEDED"SUCCEEDED"
REVERTED"REVERTED"

Defined in​

src/provider/types/spec.type.ts:196

src/provider/types/spec.type.ts:197


ValidateType​

• Const ValidateType: Object

Type declaration​

NameType
DEPLOY"DEPLOY"
CALL"CALL"
INVOKE"INVOKE"

Defined in​

src/types/calldata.ts:3

src/types/calldata.ts:9


Uint​

• Const Uint: Object

Type declaration​

NameType
u8"core::integer::u8"
u16"core::integer::u16"
u32"core::integer::u32"
u64"core::integer::u64"
u128"core::integer::u128"
u256"core::integer::u256"
u512"core::integer::u512"

Defined in​

src/types/calldata.ts:11

src/types/calldata.ts:21


Literal​

• Const Literal: Object

Type declaration​

NameType
ClassHash"core::starknet::class_hash::ClassHash"
ContractAddress"core::starknet::contract_address::ContractAddress"
Secp256k1Point"core::starknet::secp256k1::Secp256k1Point"
U96"core::internal::bounded_int::BoundedInt::<0, 79228162514264337593543950335>"

Defined in​

src/types/calldata.ts:23

src/types/calldata.ts:30


ETH_ADDRESS​

• Const ETH_ADDRESS: "core::starknet::eth_address::EthAddress"

Defined in​

src/types/calldata.ts:32


NON_ZERO_PREFIX​

• Const NON_ZERO_PREFIX: "core::zeroable::NonZero::"

Defined in​

src/types/calldata.ts:33


OutsideExecutionTypesV1​

• Const OutsideExecutionTypesV1: Object

Type declaration​

NameType
StarkNetDomain{ name: string = 'name'; type: string = 'felt' }[]
OutsideExecution{ name: string = 'caller'; type: string = 'felt' }[]
OutsideCall{ name: string = 'to'; type: string = 'felt' }[]

Defined in​

src/types/outsideExecution.ts:33


OutsideExecutionTypesV2​

• Const OutsideExecutionTypesV2: Object

Type declaration​

NameType
StarknetDomain{ name: string = 'name'; type: string = 'shortstring' }[]
OutsideExecution{ name: string = 'Caller'; type: string = 'ContractAddress' }[]
Call{ name: string = 'To'; type: string = 'ContractAddress' }[]

Defined in​

src/types/outsideExecution.ts:55

Functions​

isRPC08_FeeEstimate​

â–¸ isRPC08_FeeEstimate(entry): entry is FEE_ESTIMATE

Parameters​

NameType
entryFeeEstimate

Returns​

entry is FEE_ESTIMATE

Defined in​

src/provider/types/spec.type.ts:135


isRPC08_ResourceBounds​

â–¸ isRPC08_ResourceBounds(entry): entry is RESOURCE_BOUNDS_MAPPING

Parameters​

NameType
entryResourceBounds

Returns​

entry is RESOURCE_BOUNDS_MAPPING

Defined in​

src/provider/types/spec.type.ts:144