Namespace: types

Namespaces

• RPC

Interfaces

• Uint256
• Uint512
• Program
• ProviderOptions
• EstimateFee
• UniversalDetails
• PaymasterDetails
• EstimateFeeDetails
• DeployContractResponse
• OutsideExecutionOptions
• OutsideCall
• OutsideExecution
• OutsideTransaction
• PaymasterOptions
• TokenData
• PaymasterTimeBounds

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

Name	Type
data	BigNumberish[]
pending_word	BigNumberish
pending_word_len	BigNumberish

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

Name	Type
classHash	BigNumberish
salt?	string
unique?	boolean
constructorCalldata?	RawArgs

Defined in

src/types/lib/index.ts:77

---

DeployAccountContractPayload

Ƭ DeployAccountContractPayload: Object

Type declaration

Name	Type
classHash	string
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

Name	Type
contract	CompiledContract | 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

Name	Type
contract	CompiledContract | string
classHash	string
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

Name	Type
contract	ContractClass
senderAddress	string
signature?	Signature
compiledClassHash?	string

Defined in

src/types/lib/index.ts:120

---

CallDetails

Ƭ CallDetails: Object

Type declaration

Name	Type
contractAddress	string
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

Name	Type
nonce	BigNumberish
version	BigNumberish
resourceBounds	ResourceBounds
tip	BigNumberish
paymasterData	BigNumberish[]
accountDeploymentData	BigNumberish[]
nonceDataAvailabilityMode	EDataAvailabilityMode
feeDataAvailabilityMode	EDataAvailabilityMode

Defined in

src/types/lib/index.ts:146

---

Details

Ƭ Details: Object

Contain all additional details params

Type declaration

Name	Type
nonce	BigNumberish
maxFee	BigNumberish
version	BigNumberish
chainId	StarknetChainId

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

Name	Type
element	any
type	string

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

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

Defined in

src/types/lib/index.ts:281

---

getSimulateTransactionOptions

Ƭ getSimulateTransactionOptions: Object

Type declaration

Name	Type
blockIdentifier?	BlockIdentifier
skipValidate?	boolean
skipExecute?	boolean
skipFeeCharge?	boolean

Defined in

src/types/lib/index.ts:287

---

getContractVersionOptions

Ƭ getContractVersionOptions: Object

Type declaration

Name	Type
blockIdentifier?	BlockIdentifier
compiler?	boolean

Defined in

src/types/lib/index.ts:294

---

getEstimateFeeBulkOptions

Ƭ getEstimateFeeBulkOptions: Object

Type declaration

Name	Type
blockIdentifier?	BlockIdentifier
skipValidate?	boolean

Defined in

src/types/lib/index.ts:299

---

ContractVersion

Ƭ ContractVersion: Object

Represent Contract version

Type declaration

Name	Type	Description
cairo	CairoVersion	version of the cairo language
compiler	CompilerVersion	version 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

Name	Type
name	string
type	"felt" | "felt*" | "event" | string

Defined in

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

---

EventEntry

Ƭ EventEntry: Object

Type declaration

Name	Type
name	string
type	"felt" | "felt*" | string
kind	"key" | "data"

Defined in

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

---

FunctionAbi

Ƭ FunctionAbi: Object

Type declaration

Name	Type
inputs	AbiEntry[]
name	string
outputs	AbiEntry[]
stateMutability?	"view"
state_mutability?	string
type	FunctionAbiType

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

Name	Type
members	AbiEntry & { offset: number }[]
name	string
size	number
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

Name	Type
items	FunctionAbi[]
name	string
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

Name	Type
variants	AbiEntry & { offset: number }[]
name	string
size	number
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

Name	Type
name	string
type	"event"
data	EVENT_FIELD[]
keys	EVENT_FIELD[]

Defined in

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

---

LegacyContractClass

Ƭ LegacyContractClass: Object

format produced after compressing 'program' property

Type declaration

Name	Type
program	CompressedProgram
entry_points_by_type	EntryPointsByType
abi	Abi

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

---

Hint

Ƭ Hint: Record<string, unknown>

Defined in

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

---

EntryPointsByType

Ƭ EntryPointsByType: Object

Type declaration

Name	Type
CONSTRUCTOR	ContractEntryPointFields[]
EXTERNAL	ContractEntryPointFields[]
L1_HANDLER	ContractEntryPointFields[]

Defined in

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

---

ContractEntryPointFields

Ƭ ContractEntryPointFields: Object

Type declaration

Name	Type
selector	string
offset	string | number
builtins?	Builtins

Defined in

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

---

CairoAssembly

Ƭ CairoAssembly: Object

SYSTEM TYPES

Type declaration

Name	Type
prime	string
compiler_version	string
bytecode	ByteCode
hints	any[]
pythonic_hints?	PythonicHints
bytecode_segment_lengths?	number[]
entry_points_by_type	EntryPointsByType

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

Name	Type
sierra_program	ByteCode
sierra_program_debug_info?	SierraProgramDebugInfo
contract_class_version	string
entry_points_by_type	SierraEntryPointsByType
abi	Abi

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

Name	Type
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

Name	Type
CONSTRUCTOR	SierraContractEntryPointFields[]
EXTERNAL	SierraContractEntryPointFields[]
L1_HANDLER	SierraContractEntryPointFields[]

Defined in

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

---

SierraContractEntryPointFields

Ƭ SierraContractEntryPointFields: Object

Type declaration

Name	Type
selector	string
function_idx	number

Defined in

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

---

FeeMarginPercentage

Ƭ FeeMarginPercentage: Object

Type declaration

Name	Type
bounds	ResourceBoundsOverhead
maxFee	number

Defined in

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

---

RpcProviderOptions

Ƭ RpcProviderOptions: Object

Type declaration

Name	Type
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

Name	Type
overall_fee	bigint
unit	PRICE_UNIT
l1_gas_consumed	bigint
l1_gas_price	bigint
l2_gas_consumed	bigint | undefined
l2_gas_price	bigint | undefined
l1_data_gas_consumed	bigint
l1_data_gas_price	bigint
suggestedMaxFee	bigint
resourceBounds	ResourceBounds

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

Name	Type
T	extends 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

Name	Type
l1_gas	{ max_amount: number ; max_price_per_unit: number }
l1_gas.max_amount	number
l1_gas.max_price_per_unit	number
l2_gas	{ max_amount: number ; max_price_per_unit: number }
l2_gas.max_amount	number
l2_gas.max_price_per_unit	number
l1_data_gas	{ max_amount: number ; max_price_per_unit: number }
l1_data_gas.max_amount	number
l1_data_gas.max_price_per_unit	number

Defined in

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

---

ResourceBoundsOverheadRPC07

Ƭ ResourceBoundsOverheadRPC07: Object

Type declaration

Name	Type
l1_gas	{ max_amount: number ; max_price_per_unit: number }
l1_gas.max_amount	number
l1_gas.max_price_per_unit	number

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

Name	Type
maxFee	BigNumberish
resourceBounds	ResourceBounds

Defined in

src/types/account.ts:22

---

EstimateFeeBulk

Ƭ EstimateFeeBulk: EstimateFee[]

Defined in

src/types/account.ts:27

---

AccountInvocationsFactoryDetails

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

Defined in

src/types/account.ts:30

---

MultiDeployContractResponse

Ƭ MultiDeployContractResponse: Object

Type declaration

Name	Type
contract_address	string[]
transaction_hash	string

Defined in

src/types/account.ts:67

---

DeployContractUDCResponse

Ƭ DeployContractUDCResponse: Object

Type declaration

Name	Type
contract_address	string
transaction_hash	string
address	string
deployer	string
unique	string
classHash	string
calldata_len	string
calldata	string[]
salt	string

Defined in

src/types/account.ts:72

---

DeclareDeployUDCResponse

Ƭ DeclareDeployUDCResponse: Object

Type declaration

Name	Type
declare	{ class_hash: BigNumberish } & Partial<DeclareTransactionReceiptResponse>
deploy	DeployContractUDCResponse

Defined in

src/types/account.ts:84

---

SimulateTransactionDetails

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

Defined in

src/types/account.ts:91

---

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

---

StarkProfile

Ƭ StarkProfile: Object

Type declaration

Name	Type
name?	string
profilePicture?	string
discord?	string
twitter?	string
github?	string
proofOfPersonhood?	boolean

Defined in

src/types/account.ts:116

---

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

Name	Type
T	any

Type declaration

▸ (...args): Promise<T>

Parameters

Name	Type
...args	ArgsOrCalldataWithOptions

Returns

Promise<T>

Defined in

src/types/contract.ts:13

---

ContractFunction

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

Type declaration

▸ (...args): any

Parameters

Name	Type
...args	ArgsOrCalldataWithOptions

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: { blockIdentifier?: BlockIdentifier ; parseRequest?: boolean ; parseResponse?: boolean ; formatResponse?: { [key: string]: any; } ; signature?: Signature ; addressSalt?: string } & Partial<UniversalDetails>

Defined in

src/types/contract.ts:57

---

CallOptions

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

Defined in

src/types/contract.ts:86

---

InvokeOptions

Ƭ InvokeOptions: ContractOptions

Defined in

src/types/contract.ts:91

---

ParsedEvent

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

Defined in

src/types/contract.ts:93

---

ParsedEvents

Ƭ ParsedEvents: ParsedEvent[]

Defined in

src/types/contract.ts:99

---

RPC_ERROR_SET

Ƭ RPC_ERROR_SET: Object

Type declaration

Name	Type
FAILED_TO_RECEIVE_TXN	FAILED_TO_RECEIVE_TXN
NO_TRACE_AVAILABLE	NO_TRACE_AVAILABLE
CONTRACT_NOT_FOUND	CONTRACT_NOT_FOUND
ENTRYPOINT_NOT_FOUND	ENTRYPOINT_NOT_FOUND
BLOCK_NOT_FOUND	BLOCK_NOT_FOUND
INVALID_TXN_INDEX	INVALID_TXN_INDEX
CLASS_HASH_NOT_FOUND	CLASS_HASH_NOT_FOUND
TXN_HASH_NOT_FOUND	TXN_HASH_NOT_FOUND
PAGE_SIZE_TOO_BIG	PAGE_SIZE_TOO_BIG
NO_BLOCKS	NO_BLOCKS
INVALID_CONTINUATION_TOKEN	INVALID_CONTINUATION_TOKEN
TOO_MANY_KEYS_IN_FILTER	TOO_MANY_KEYS_IN_FILTER
CONTRACT_ERROR	CONTRACT_ERROR
TRANSACTION_EXECUTION_ERROR	TRANSACTION_EXECUTION_ERROR
STORAGE_PROOF_NOT_SUPPORTED	STORAGE_PROOF_NOT_SUPPORTED
CLASS_ALREADY_DECLARED	CLASS_ALREADY_DECLARED
INVALID_TRANSACTION_NONCE	INVALID_TRANSACTION_NONCE
INSUFFICIENT_RESOURCES_FOR_VALIDATE	INSUFFICIENT_RESOURCES_FOR_VALIDATE
INSUFFICIENT_ACCOUNT_BALANCE	INSUFFICIENT_ACCOUNT_BALANCE
VALIDATION_FAILURE	VALIDATION_FAILURE
COMPILATION_FAILED	COMPILATION_FAILED
CONTRACT_CLASS_SIZE_IS_TOO_LARGE	CONTRACT_CLASS_SIZE_IS_TOO_LARGE
NON_ACCOUNT	NON_ACCOUNT
DUPLICATE_TX	DUPLICATE_TX
COMPILED_CLASS_HASH_MISMATCH	COMPILED_CLASS_HASH_MISMATCH
UNSUPPORTED_TX_VERSION	UNSUPPORTED_TX_VERSION
UNSUPPORTED_CONTRACT_CLASS_VERSION	UNSUPPORTED_CONTRACT_CLASS_VERSION
UNEXPECTED_ERROR	UNEXPECTED_ERROR
INVALID_SUBSCRIPTION_ID	INVALID_SUBSCRIPTION_ID
TOO_MANY_ADDRESSES_IN_FILTER	TOO_MANY_ADDRESSES_IN_FILTER
TOO_MANY_BLOCKS_BACK	TOO_MANY_BLOCKS_BACK
COMPILATION_ERROR	COMPILATION_ERROR
INVALID_ADDRESS	INVALID_ADDRESS
TOKEN_NOT_SUPPORTED	TOKEN_NOT_SUPPORTED
INVALID_SIGNATURE	INVALID_SIGNATURE
MAX_AMOUNT_TOO_LOW	MAX_AMOUNT_TOO_LOW
CLASS_HASH_NOT_SUPPORTED	CLASS_HASH_NOT_SUPPORTED
PAYMASTER_TRANSACTION_EXECUTION_ERROR	TRANSACTION_EXECUTION_ERROR
INVALID_TIME_BOUNDS	INVALID_TIME_BOUNDS
INVALID_DEPLOYMENT_DATA	INVALID_DEPLOYMENT_DATA
INVALID_CLASS_HASH	INVALID_CLASS_HASH
INVALID_ID	INVALID_ID
UNKNOWN_ERROR	UNKNOWN_ERROR

Defined in

src/types/errors.ts:5

---

RPC_ERROR

Ƭ RPC_ERROR: RPC_ERROR_SET[keyof RPC_ERROR_SET]

Defined in

src/types/errors.ts:51

---

OutsideExecutionVersion

Ƭ OutsideExecutionVersion: ValuesType<typeof OutsideExecutionVersion>

Defined in

src/types/outsideExecution.ts:78

src/types/outsideExecution.ts:83

---

InvocationsSignerDetails

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

Defined in

src/types/signer.ts:11

---

V2InvocationsSignerDetails

Ƭ V2InvocationsSignerDetails: Object

Type declaration

Name	Type
walletAddress	string
cairoVersion	CairoVersion
chainId	StarknetChainId
nonce	BigNumberish
maxFee	BigNumberish
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

Name	Type
accountId	number
applicationName	string

Returns

Uint8Array

Defined in

src/types/signer.ts:70

---

TransactionStatusReceiptSets

Ƭ TransactionStatusReceiptSets: Object

Type declaration

Name	Type
success	SuccessfulTransactionReceiptResponse
reverted	RevertedTransactionReceiptResponse
error	Error

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<T>: { statusReceipt: T ; value: TransactionStatusReceiptSets[T] ; match: (callbacks: TransactionReceiptCallbacks) => void } & { [key in `is${Capitalize<TransactionReceiptStatus>}`]: Function }

Type parameters

Name	Type
T	extends TransactionReceiptStatus = TransactionReceiptStatus

Defined in

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

---

PaymasterRpcOptions

Ƭ PaymasterRpcOptions: Object

Type declaration

Name	Type
nodeUrl?	string | NetworkName
default?	boolean
headers?	object
baseFetch?	WindowOrWorkerGlobalScope["fetch"]

Defined in

src/types/paymaster/configuration.ts:5

---

PaymasterFeeEstimate

Ƭ PaymasterFeeEstimate: Object

Type declaration

Name	Type
gas_token_price_in_strk	BigNumberish
estimated_fee_in_strk	BigNumberish
estimated_fee_in_gas_token	BigNumberish
suggested_max_fee_in_strk	BigNumberish
suggested_max_fee_in_gas_token	BigNumberish

Defined in

src/types/paymaster/response.ts:9

---

PreparedDeployTransaction

Ƭ PreparedDeployTransaction: Object

Type declaration

Name	Type
type	"deploy"
deployment	ACCOUNT_DEPLOYMENT_DATA
parameters	ExecutionParameters
fee	PaymasterFeeEstimate

Defined in

src/types/paymaster/response.ts:17

---

PreparedInvokeTransaction

Ƭ PreparedInvokeTransaction: Object

Type declaration

Name	Type
type	"invoke"
typed_data	OutsideExecutionTypedData
parameters	ExecutionParameters
fee	PaymasterFeeEstimate

Defined in

src/types/paymaster/response.ts:23

---

PreparedDeployAndInvokeTransaction

Ƭ PreparedDeployAndInvokeTransaction: Object

Type declaration

Name	Type
type	"deploy_and_invoke"
deployment	ACCOUNT_DEPLOYMENT_DATA
typed_data	OutsideExecutionTypedData
parameters	ExecutionParameters
fee	PaymasterFeeEstimate

Defined in

src/types/paymaster/response.ts:29

---

PreparedTransaction

Ƭ PreparedTransaction: PreparedDeployTransaction | PreparedInvokeTransaction | PreparedDeployAndInvokeTransaction

Defined in

src/types/paymaster/response.ts:36

---

DeployTransaction

Ƭ DeployTransaction: Object

Type declaration

Name	Type
type	"deploy"
deployment	ACCOUNT_DEPLOYMENT_DATA

Defined in

src/types/paymaster/response.ts:47

---

InvokeTransaction

Ƭ InvokeTransaction: Object

Type declaration

Name	Type
type	"invoke"
invoke	UserInvoke

Defined in

src/types/paymaster/response.ts:51

---

UserInvoke

Ƭ UserInvoke: Object

Type declaration

Name	Type
userAddress	string
calls	Call[]

Defined in

src/types/paymaster/response.ts:55

---

DeployAndInvokeTransaction

Ƭ DeployAndInvokeTransaction: Object

Type declaration

Name	Type
type	"deploy_and_invoke"
deployment	ACCOUNT_DEPLOYMENT_DATA
invoke	UserInvoke

Defined in

src/types/paymaster/response.ts:59

---

UserTransaction

Ƭ UserTransaction: DeployTransaction | InvokeTransaction | DeployAndInvokeTransaction

Defined in

src/types/paymaster/response.ts:64

---

ExecutableDeployTransaction

Ƭ ExecutableDeployTransaction: Object

Type declaration

Name	Type
type	"deploy"
deployment	ACCOUNT_DEPLOYMENT_DATA

Defined in

src/types/paymaster/response.ts:66

---

ExecutableInvokeTransaction

Ƭ ExecutableInvokeTransaction: Object

Type declaration

Name	Type
type	"invoke"
invoke	ExecutableUserInvoke

Defined in

src/types/paymaster/response.ts:70

---

ExecutableUserInvoke

Ƭ ExecutableUserInvoke: Object

Type declaration

Name	Type
userAddress	string
typedData	OutsideExecutionTypedData
signature	string[]

Defined in

src/types/paymaster/response.ts:74

---

ExecutableDeployAndInvokeTransaction

Ƭ ExecutableDeployAndInvokeTransaction: Object

Type declaration

Name	Type
type	"deploy_and_invoke"
deployment	ACCOUNT_DEPLOYMENT_DATA
invoke	ExecutableUserInvoke

Defined in

src/types/paymaster/response.ts:79

---

ExecutableUserTransaction

Ƭ ExecutableUserTransaction: ExecutableDeployTransaction | ExecutableInvokeTransaction | ExecutableDeployAndInvokeTransaction

Defined in

src/types/paymaster/response.ts:84

---

FeeMode

Ƭ FeeMode: { mode: "sponsored" } | { mode: "default" ; gasToken: string }

Defined in

src/types/paymaster/response.ts:89

---

ExecutionParameters

Ƭ ExecutionParameters: Object

Type declaration

Name	Type
version	"0x1"
feeMode	FeeMode
timeBounds?	PaymasterTimeBounds

Defined in

src/types/paymaster/response.ts:90

Variables

TransactionType

• Const TransactionType: Object

Type declaration

Name	Type
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

Name	Type
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

Name	Type
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

Name	Type
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

Name	Type
PENDING	"pending"
LATEST	"latest"

Defined in

src/types/lib/index.ts:221

src/types/lib/index.ts:226

---

EntryPointType

• Const EntryPointType: Object

Type declaration

Name	Type
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

Name	Type	Description
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

Name	Type
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

Name	Type
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

Name	Type
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

Name	Type
L1	0
L2	1

Defined in

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

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

---

ETransactionStatus

• ETransactionStatus: Object

Type declaration

Name	Type
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

Name	Type
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

Name	Type
DEPLOY	"DEPLOY"
CALL	"CALL"
INVOKE	"INVOKE"

Defined in

src/types/calldata.ts:3

src/types/calldata.ts:9

---

Uint

• Const Uint: Object

Type declaration

Name	Type
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

Name	Type
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

Name	Type
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:34

---

OutsideExecutionTypesV2

• Const OutsideExecutionTypesV2: Object

Type declaration

Name	Type
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:56

---

OutsideExecutionVersion

• Const OutsideExecutionVersion: Object

Type declaration

Name	Type
UNSUPPORTED	"0"
V1	"1"
V2	"2"

Defined in

src/types/outsideExecution.ts:78

src/types/outsideExecution.ts:83

Functions

isRPC08_FeeEstimate

▸ isRPC08_FeeEstimate(entry): entry is FEE_ESTIMATE

Parameters

Name	Type
entry	FeeEstimate

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

Name	Type
entry	ResourceBounds

Returns

entry is RESOURCE_BOUNDS_MAPPING

Defined in

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