Version: Next

Class: Provider

Hierarchy

RpcProvider<this> & StarknetId<this>
↳ Provider
↳↳ Account

Constructors

constructor

• new Provider(optionsOrProvider?): Provider

Parameters

Name	Type
`optionsOrProvider?`	`RpcProviderOptions` \| `ProviderInterface` \| `RpcProvider`

Returns

Provider

Inherited from

Mixin(BaseRpcProvider, StarknetId).constructor

Defined in

src/provider/rpc.ts:69

• new Provider(): Provider

Returns

Provider

Inherited from

Mixin(BaseRpcProvider, StarknetId).constructor

Properties

responseParser

• responseParser: RPCResponseParser

Inherited from

Mixin(BaseRpcProvider, StarknetId).responseParser

Defined in

src/provider/rpc.ts:65

channel

• channel: RpcChannel | RpcChannel

Inherited from

Mixin(BaseRpcProvider, StarknetId).channel

Defined in

src/provider/rpc.ts:67

getStateUpdate

• getStateUpdate: () => Promise<{ block_hash: never ; old_root: string ; state_diff: { storage_diffs: { address: string; storage_entries: { key: string; value: string; }[]; }[]; deprecated_declared_classes: string[]; declared_classes: { class_hash: string; compiled_class_hash: string; }[]; deployed_contracts: { address: string; class_hash: string; }[]; replaced_classes: { contract_address: string; class_hash: string; }[]; nonces: { nonce: string; contract_address: string; }[]; } }>(blockIdentifier: "pending") => Promise<{ block_hash: never ; old_root: string ; state_diff: { storage_diffs: { address: string; storage_entries: { key: string; value: string; }[]; }[]; deprecated_declared_classes: string[]; declared_classes: { class_hash: string; compiled_class_hash: string; }[]; deployed_contracts: { address: string; class_hash: string; }[]; replaced_classes: { contract_address: string; class_hash: string; }[]; nonces: { nonce: string; contract_address: string; }[]; } }>(blockIdentifier: "latest") => Promise<{ block_hash: string ; new_root: string ; old_root: string ; state_diff: { storage_diffs: { address: string; storage_entries: { key: string; value: string; }[]; }[]; deprecated_declared_classes: string[]; declared_classes: { class_hash: string; compiled_class_hash: string; }[]; deployed_contracts: { address: string; class_hash: string; }[]; replaced_classes: { contract_address: string; class_hash: string; }[]; nonces: { nonce: string; contract_address: string; }[]; } }>(blockIdentifier?: BlockIdentifier) => Promise<StateUpdateResponse>

Type declaration

▸ (): Promise<{ block_hash: never ; old_root: string ; state_diff: { storage_diffs: { address: string; storage_entries: { key: string; value: string; }[]; }[]; deprecated_declared_classes: string[]; declared_classes: { class_hash: string; compiled_class_hash: string; }[]; deployed_contracts: { address: string; class_hash: string; }[]; replaced_classes: { contract_address: string; class_hash: string; }[]; nonces: { nonce: string; contract_address: string; }[]; } }>

Returns

Promise<{ block_hash: never ; old_root: string ; state_diff: { storage_diffs: { address: string; storage_entries: { key: string; value: string; }[]; }[]; deprecated_declared_classes: string[]; declared_classes: { class_hash: string; compiled_class_hash: string; }[]; deployed_contracts: { address: string; class_hash: string; }[]; replaced_classes: { contract_address: string; class_hash: string; }[]; nonces: { nonce: string; contract_address: string; }[]; } }>

▸ (blockIdentifier): Promise<{ block_hash: never ; old_root: string ; state_diff: { storage_diffs: { address: string; storage_entries: { key: string; value: string; }[]; }[]; deprecated_declared_classes: string[]; declared_classes: { class_hash: string; compiled_class_hash: string; }[]; deployed_contracts: { address: string; class_hash: string; }[]; replaced_classes: { contract_address: string; class_hash: string; }[]; nonces: { nonce: string; contract_address: string; }[]; } }>

Parameters

Name	Type
`blockIdentifier`	`"pending"`

Returns

▸ (blockIdentifier): Promise<{ block_hash: string ; new_root: string ; old_root: string ; state_diff: { storage_diffs: { address: string; storage_entries: { key: string; value: string; }[]; }[]; deprecated_declared_classes: string[]; declared_classes: { class_hash: string; compiled_class_hash: string; }[]; deployed_contracts: { address: string; class_hash: string; }[]; replaced_classes: { contract_address: string; class_hash: string; }[]; nonces: { nonce: string; contract_address: string; }[]; } }>

Parameters

Name	Type
`blockIdentifier`	`"latest"`

Returns

Promise<{ block_hash: string ; new_root: string ; old_root: string ; state_diff: { storage_diffs: { address: string; storage_entries: { key: string; value: string; }[]; }[]; deprecated_declared_classes: string[]; declared_classes: { class_hash: string; compiled_class_hash: string; }[]; deployed_contracts: { address: string; class_hash: string; }[]; replaced_classes: { contract_address: string; class_hash: string; }[]; nonces: { nonce: string; contract_address: string; }[]; } }>

▸ (blockIdentifier?): Promise<StateUpdateResponse>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<StateUpdateResponse>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getStateUpdate

Defined in

src/provider/rpc.ts:268

Methods

create

▸ create<T>(this, optionsOrProvider?): Promise<T>

auto configure channel based on provided node leave space for other async before constructor

Type parameters

Name	Type
`T`	extends `RpcProvider`<`T`>

Parameters

Name	Type
`this`	(...`args`: [optionsOrProvider?: RpcProviderOptions \| ProviderInterface \| RpcProvider]) => `T`
`optionsOrProvider?`	`RpcProviderOptions`

Returns

Promise<T>

Inherited from

Mixin(BaseRpcProvider, StarknetId).create

Defined in

src/provider/rpc.ts:101

getStarkName

▸ getStarkName(provider, address, StarknetIdContract?): Promise<string>

Parameters

Name	Type
`provider`	`ProviderInterface`
`address`	`BigNumberish`
`StarknetIdContract?`	`string`

Returns

Promise<string>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getStarkName

Defined in

src/provider/extensions/starknetId.ts:62

getAddressFromStarkName

▸ getAddressFromStarkName(provider, name, StarknetIdContract?): Promise<string>

Parameters

Name	Type
`provider`	`ProviderInterface`
`name`	`string`
`StarknetIdContract?`	`string`

Returns

Promise<string>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getAddressFromStarkName

Defined in

src/provider/extensions/starknetId.ts:96

getStarkProfile

▸ getStarkProfile(provider, address, StarknetIdContract?, StarknetIdIdentityContract?, StarknetIdVerifierContract?, StarknetIdPfpContract?, StarknetIdPopContract?, StarknetIdMulticallContract?): Promise<StarkProfile>

Parameters

Name	Type
`provider`	`ProviderInterface`
`address`	`BigNumberish`
`StarknetIdContract?`	`string`
`StarknetIdIdentityContract?`	`string`
`StarknetIdVerifierContract?`	`string`
`StarknetIdPfpContract?`	`string`
`StarknetIdPopContract?`	`string`
`StarknetIdMulticallContract?`	`string`

Returns

Promise<StarkProfile>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getStarkProfile

Defined in

src/provider/extensions/starknetId.ts:128

fetch

▸ fetch(method, params?, id?): Promise<Response>

Parameters

Name	Type	Default value
`method`	`string`	`undefined`
`params?`	`object`	`undefined`
`id`	`string` \| `number`	`0`

Returns

Promise<Response>

Inherited from

Mixin(BaseRpcProvider, StarknetId).fetch

Defined in

src/provider/rpc.ts:131

getChainId

▸ getChainId(): Promise<"0x534e5f4d41494e" | "0x534e5f5345504f4c4941">

Returns

Promise<"0x534e5f4d41494e" | "0x534e5f5345504f4c4941">

Inherited from

Mixin(BaseRpcProvider, StarknetId).getChainId

Defined in

src/provider/rpc.ts:135

readSpecVersion

▸ readSpecVersion(): undefined | "0.7.1" | "0.8.1"

read channel spec version

Returns

undefined | "0.7.1" | "0.8.1"

Inherited from

Mixin(BaseRpcProvider, StarknetId).readSpecVersion

Defined in

src/provider/rpc.ts:142

getSpecVersion

▸ getSpecVersion(): Promise<string>

get channel spec version

Returns

Promise<string>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getSpecVersion

Defined in

src/provider/rpc.ts:149

setUpSpecVersion

▸ setUpSpecVersion(): Promise<"0.7.1" | "0.8.1">

setup channel spec version and return it

Returns

Promise<"0.7.1" | "0.8.1">

Inherited from

Mixin(BaseRpcProvider, StarknetId).setUpSpecVersion

Defined in

src/provider/rpc.ts:156

getNonceForAddress

▸ getNonceForAddress(contractAddress, blockIdentifier?): Promise<string>

Parameters

Name	Type
`contractAddress`	`BigNumberish`
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<string>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getNonceForAddress

Defined in

src/provider/rpc.ts:160

getBlock

▸ getBlock(): Promise<{ transactions: string[] ; parent_hash: string ; timestamp: number ; sequencer_address: string ; l1_gas_price: RESOURCE_PRICE ; l2_gas_price: RESOURCE_PRICE ; l1_data_gas_price: RESOURCE_PRICE ; l1_da_mode: L1_DA_MODE ; starknet_version: string }>

Returns

Promise<{ transactions: string[] ; parent_hash: string ; timestamp: number ; sequencer_address: string ; l1_gas_price: RESOURCE_PRICE ; l2_gas_price: RESOURCE_PRICE ; l1_data_gas_price: RESOURCE_PRICE ; l1_da_mode: L1_DA_MODE ; starknet_version: string }>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getBlock

Defined in

src/provider/rpc.ts:167

▸ getBlock(blockIdentifier): Promise<{ transactions: string[] ; parent_hash: string ; timestamp: number ; sequencer_address: string ; l1_gas_price: RESOURCE_PRICE ; l2_gas_price: RESOURCE_PRICE ; l1_data_gas_price: RESOURCE_PRICE ; l1_da_mode: L1_DA_MODE ; starknet_version: string }>

Parameters

Name	Type
`blockIdentifier`	`"pending"`

Returns

Inherited from

Mixin(BaseRpcProvider, StarknetId).getBlock

Defined in

src/provider/rpc.ts:168

▸ getBlock(blockIdentifier): Promise<{ status: BLOCK_STATUS ; block_hash: string ; parent_hash: string ; block_number: number ; new_root: string ; timestamp: number ; sequencer_address: string ; l1_gas_price: RESOURCE_PRICE ; l2_gas_price: RESOURCE_PRICE ; l1_data_gas_price: RESOURCE_PRICE ; l1_da_mode: L1_DA_MODE ; starknet_version: string ; transactions: string[] }>

Parameters

Name	Type
`blockIdentifier`	`"latest"`

Returns

Promise<{ status: BLOCK_STATUS ; block_hash: string ; parent_hash: string ; block_number: number ; new_root: string ; timestamp: number ; sequencer_address: string ; l1_gas_price: RESOURCE_PRICE ; l2_gas_price: RESOURCE_PRICE ; l1_data_gas_price: RESOURCE_PRICE ; l1_da_mode: L1_DA_MODE ; starknet_version: string ; transactions: string[] }>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getBlock

Defined in

src/provider/rpc.ts:169

▸ getBlock(blockIdentifier?): Promise<GetBlockResponse>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<GetBlockResponse>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getBlock

Defined in

src/provider/rpc.ts:170

getBlockLatestAccepted

▸ getBlockLatestAccepted(): Promise<BlockHashAndNumber>

Get the most recent accepted block hash and number

Returns

Promise<BlockHashAndNumber>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getBlockLatestAccepted

Defined in

src/provider/rpc.ts:180

getBlockNumber

▸ getBlockNumber(): Promise<number>

Get the most recent accepted block number redundant use getBlockLatestAccepted();

Returns

Promise<number>

Number of the latest block

Inherited from

Mixin(BaseRpcProvider, StarknetId).getBlockNumber

Defined in

src/provider/rpc.ts:189

getBlockWithTxHashes

▸ getBlockWithTxHashes(blockIdentifier?): Promise<BlockWithTxHashes>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<BlockWithTxHashes>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getBlockWithTxHashes

Defined in

src/provider/rpc.ts:193

getBlockWithTxs

▸ getBlockWithTxs(blockIdentifier?): Promise<BlockWithTxs>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<BlockWithTxs>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getBlockWithTxs

Defined in

src/provider/rpc.ts:197

waitForBlock

▸ waitForBlock(blockIdentifier?, retryInterval?): Promise<void>

Pause the execution of the script until a specified block is created.

Parameters

Name	Type	Default value	Description
`blockIdentifier`	`BlockIdentifier`	`'pending'`	bloc number (BigNumberish) or 'pending' or 'latest'. Use of 'latest" or of a block already created will generate no pause.
`retryInterval?`	`number`	`5000`	number of milliseconds between 2 requests to the node

Returns

Promise<void>

Example

await myProvider.waitForBlock();
// wait the creation of the pending block

Inherited from

Mixin(BaseRpcProvider, StarknetId).waitForBlock

Defined in

src/provider/rpc.ts:212

getL1GasPrice

▸ getL1GasPrice(blockIdentifier?): Promise<string>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<string>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getL1GasPrice

Defined in

src/provider/rpc.ts:242

getL1MessageHash

▸ getL1MessageHash(l2TxHash): Promise<string>

Parameters

Name	Type
`l2TxHash`	`BigNumberish`

Returns

Promise<string>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getL1MessageHash

Defined in

src/provider/rpc.ts:248

getBlockWithReceipts

▸ getBlockWithReceipts(blockIdentifier?): Promise<OnlyFirst<BLOCK_WITH_RECEIPTS, { status: BLOCK_STATUS } & BLOCK_HEADER & BLOCK_BODY_WITH_RECEIPTS & PENDING_BLOCK_HEADER> | OnlyFirst<PENDING_BLOCK_WITH_RECEIPTS, { status: BLOCK_STATUS } & BLOCK_HEADER & BLOCK_BODY_WITH_RECEIPTS & PENDING_BLOCK_HEADER> | BlockWithTxReceipts>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<OnlyFirst<BLOCK_WITH_RECEIPTS, { status: BLOCK_STATUS } & BLOCK_HEADER & BLOCK_BODY_WITH_RECEIPTS & PENDING_BLOCK_HEADER> | OnlyFirst<PENDING_BLOCK_WITH_RECEIPTS, { status: BLOCK_STATUS } & BLOCK_HEADER & BLOCK_BODY_WITH_RECEIPTS & PENDING_BLOCK_HEADER> | BlockWithTxReceipts>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getBlockWithReceipts

Defined in

src/provider/rpc.ts:264

getBlockStateUpdate

▸ getBlockStateUpdate(): Promise<{ block_hash: never ; old_root: string ; state_diff: { storage_diffs: { address: string; storage_entries: { key: string; value: string; }[]; }[]; deprecated_declared_classes: string[]; declared_classes: { class_hash: string; compiled_class_hash: string; }[]; deployed_contracts: { address: string; class_hash: string; }[]; replaced_classes: { contract_address: string; class_hash: string; }[]; nonces: { nonce: string; contract_address: string; }[]; } }>

Returns

Inherited from

Mixin(BaseRpcProvider, StarknetId).getBlockStateUpdate

Defined in

src/provider/rpc.ts:270

▸ getBlockStateUpdate(blockIdentifier): Promise<{ block_hash: never ; old_root: string ; state_diff: { storage_diffs: { address: string; storage_entries: { key: string; value: string; }[]; }[]; deprecated_declared_classes: string[]; declared_classes: { class_hash: string; compiled_class_hash: string; }[]; deployed_contracts: { address: string; class_hash: string; }[]; replaced_classes: { contract_address: string; class_hash: string; }[]; nonces: { nonce: string; contract_address: string; }[]; } }>

Parameters

Name	Type
`blockIdentifier`	`"pending"`

Returns

Inherited from

Mixin(BaseRpcProvider, StarknetId).getBlockStateUpdate

Defined in

src/provider/rpc.ts:271

▸ getBlockStateUpdate(blockIdentifier): Promise<{ block_hash: string ; new_root: string ; old_root: string ; state_diff: { storage_diffs: { address: string; storage_entries: { key: string; value: string; }[]; }[]; deprecated_declared_classes: string[]; declared_classes: { class_hash: string; compiled_class_hash: string; }[]; deployed_contracts: { address: string; class_hash: string; }[]; replaced_classes: { contract_address: string; class_hash: string; }[]; nonces: { nonce: string; contract_address: string; }[]; } }>

Parameters

Name	Type
`blockIdentifier`	`"latest"`

Returns

Inherited from

Mixin(BaseRpcProvider, StarknetId).getBlockStateUpdate

Defined in

src/provider/rpc.ts:272

▸ getBlockStateUpdate(blockIdentifier?): Promise<StateUpdateResponse>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<StateUpdateResponse>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getBlockStateUpdate

Defined in

src/provider/rpc.ts:273

getBlockTransactionsTraces

▸ getBlockTransactionsTraces(blockIdentifier?): Promise<BlockTransactionsTraces | BlockTransactionsTraces>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<BlockTransactionsTraces | BlockTransactionsTraces>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getBlockTransactionsTraces

Defined in

src/provider/rpc.ts:278

getBlockTransactionCount

▸ getBlockTransactionCount(blockIdentifier?): Promise<number>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<number>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getBlockTransactionCount

Defined in

src/provider/rpc.ts:282

getTransaction

▸ getTransaction(txHash): Promise<TransactionWithHash>

Parameters

Name	Type
`txHash`	`BigNumberish`

Returns

Promise<TransactionWithHash>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getTransaction

Defined in

src/provider/rpc.ts:286

getTransactionByHash

▸ getTransactionByHash(txHash): Promise<TransactionWithHash>

Parameters

Name	Type
`txHash`	`BigNumberish`

Returns

Promise<TransactionWithHash>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getTransactionByHash

Defined in

src/provider/rpc.ts:290

getTransactionByBlockIdAndIndex

▸ getTransactionByBlockIdAndIndex(blockIdentifier, index): Promise<TransactionWithHash>

Parameters

Name	Type
`blockIdentifier`	`BlockIdentifier`
`index`	`number`

Returns

Promise<TransactionWithHash>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getTransactionByBlockIdAndIndex

Defined in

src/provider/rpc.ts:294

getTransactionReceipt

▸ getTransactionReceipt(txHash): Promise<GetTransactionReceiptResponse>

Parameters

Name	Type
`txHash`	`BigNumberish`

Returns

Promise<GetTransactionReceiptResponse>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getTransactionReceipt

Defined in

src/provider/rpc.ts:298

getTransactionTrace

▸ getTransactionTrace(txHash): Promise<TRANSACTION_TRACE>

Parameters

Name	Type
`txHash`	`BigNumberish`

Returns

Promise<TRANSACTION_TRACE>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getTransactionTrace

Defined in

src/provider/rpc.ts:305

getTransactionStatus

▸ getTransactionStatus(transactionHash): Promise<TransactionStatus>

Get the status of a transaction

Parameters

Name	Type
`transactionHash`	`BigNumberish`

Returns

Promise<TransactionStatus>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getTransactionStatus

Defined in

src/provider/rpc.ts:312

getSimulateTransaction

▸ getSimulateTransaction(invocations, options?): Promise<SimulateTransactionResponse>

Parameters

Name	Type	Description
`invocations`	`AccountInvocations`	AccountInvocations
`options?`	`getSimulateTransactionOptions`	blockIdentifier and flags to skip validation and fee charge - blockIdentifier - skipValidate (default false) - skipFeeCharge (default true)

Returns

Promise<SimulateTransactionResponse>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getSimulateTransaction

Defined in

src/provider/rpc.ts:323

waitForTransaction

▸ waitForTransaction(txHash, options?): Promise<GetTransactionReceiptResponse>

Parameters

Name	Type
`txHash`	`BigNumberish`
`options?`	`waitForTransactionOptions`

Returns

Promise<GetTransactionReceiptResponse>

Inherited from

Mixin(BaseRpcProvider, StarknetId).waitForTransaction

Defined in

src/provider/rpc.ts:333

getStorageAt

▸ getStorageAt(contractAddress, key, blockIdentifier?): Promise<string>

Parameters

Name	Type
`contractAddress`	`BigNumberish`
`key`	`BigNumberish`
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<string>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getStorageAt

Defined in

src/provider/rpc.ts:345

getClassHashAt

▸ getClassHashAt(contractAddress, blockIdentifier?): Promise<string>

Parameters

Name	Type
`contractAddress`	`BigNumberish`
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<string>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getClassHashAt

Defined in

src/provider/rpc.ts:353

getClassByHash

▸ getClassByHash(classHash): Promise<LegacyContractClass | Omit<CompiledSierra, "sierra_program_debug_info">>

Parameters

Name	Type
`classHash`	`BigNumberish`

Returns

Promise<LegacyContractClass | Omit<CompiledSierra, "sierra_program_debug_info">>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getClassByHash

Defined in

src/provider/rpc.ts:357

getClass

▸ getClass(classHash, blockIdentifier?): Promise<LegacyContractClass | Omit<CompiledSierra, "sierra_program_debug_info">>

Parameters

Name	Type
`classHash`	`BigNumberish`
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<LegacyContractClass | Omit<CompiledSierra, "sierra_program_debug_info">>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getClass

Defined in

src/provider/rpc.ts:361

getClassAt

▸ getClassAt(contractAddress, blockIdentifier?): Promise<LegacyContractClass | Omit<CompiledSierra, "sierra_program_debug_info">>

Parameters

Name	Type
`contractAddress`	`BigNumberish`
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<LegacyContractClass | Omit<CompiledSierra, "sierra_program_debug_info">>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getClassAt

Defined in

src/provider/rpc.ts:367

getContractVersion

▸ getContractVersion(contractAddress, classHash?, options?): Promise<ContractVersion>

Parameters

Name	Type
`contractAddress`	`BigNumberish`
`classHash?`	`undefined`
`options?`	`getContractVersionOptions`

Returns

Promise<ContractVersion>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getContractVersion

Defined in

src/provider/rpc.ts:373

▸ getContractVersion(contractAddress, classHash, options?): Promise<ContractVersion>

Parameters

Name	Type
`contractAddress`	`undefined`
`classHash`	`BigNumberish`
`options?`	`getContractVersionOptions`

Returns

Promise<ContractVersion>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getContractVersion

Defined in

src/provider/rpc.ts:378

getInvokeEstimateFee

▸ getInvokeEstimateFee(invocation, invocationDetails, blockIdentifier?, skipValidate?): Promise<EstimateFeeResponse>

Parameters

Name	Type
`invocation`	`Invocation`
`invocationDetails`	`InvocationsDetailsWithNonce`
`blockIdentifier?`	`BlockIdentifier`
`skipValidate?`	`boolean`

Returns

Promise<EstimateFeeResponse>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getInvokeEstimateFee

Defined in

src/provider/rpc.ts:411

getDeclareEstimateFee

▸ getDeclareEstimateFee(invocation, details, blockIdentifier?, skipValidate?): Promise<EstimateFeeResponse>

Parameters

Name	Type
`invocation`	`DeclareContractTransaction`
`details`	`InvocationsDetailsWithNonce`
`blockIdentifier?`	`BlockIdentifier`
`skipValidate?`	`boolean`

Returns

Promise<EstimateFeeResponse>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getDeclareEstimateFee

Defined in

src/provider/rpc.ts:431

getDeployAccountEstimateFee

▸ getDeployAccountEstimateFee(invocation, details, blockIdentifier?, skipValidate?): Promise<EstimateFeeResponse>

Parameters

Name	Type
`invocation`	`DeployAccountContractTransaction`
`details`	`InvocationsDetailsWithNonce`
`blockIdentifier?`	`BlockIdentifier`
`skipValidate?`	`boolean`

Returns

Promise<EstimateFeeResponse>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getDeployAccountEstimateFee

Defined in

src/provider/rpc.ts:451

getEstimateFeeBulk

▸ getEstimateFeeBulk(invocations, options): Promise<EstimateFeeResponseBulk>

Parameters

Name	Type
`invocations`	`AccountInvocations`
`options`	`getEstimateFeeBulkOptions`

Returns

Promise<EstimateFeeResponseBulk>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getEstimateFeeBulk

Defined in

src/provider/rpc.ts:471

invokeFunction

▸ invokeFunction(functionInvocation, details): Promise<{ transaction_hash: string }>

Parameters

Name	Type
`functionInvocation`	`Invocation`
`details`	`InvocationsDetailsWithNonce`

Returns

Promise<{ transaction_hash: string }>

Inherited from

Mixin(BaseRpcProvider, StarknetId).invokeFunction

Defined in

src/provider/rpc.ts:480

declareContract

▸ declareContract(transaction, details): Promise<{ class_hash: string ; transaction_hash: string }>

Parameters

Name	Type
`transaction`	`DeclareContractTransaction`
`details`	`InvocationsDetailsWithNonce`

Returns

Promise<{ class_hash: string ; transaction_hash: string }>

Inherited from

Mixin(BaseRpcProvider, StarknetId).declareContract

Defined in

src/provider/rpc.ts:487

deployAccountContract

▸ deployAccountContract(transaction, details): Promise<{ contract_address: string ; transaction_hash: string }>

Parameters

Name	Type
`transaction`	`DeployAccountContractTransaction`
`details`	`InvocationsDetailsWithNonce`

Returns

Promise<{ contract_address: string ; transaction_hash: string }>

Inherited from

Mixin(BaseRpcProvider, StarknetId).deployAccountContract

Defined in

src/provider/rpc.ts:494

callContract

▸ callContract(call, blockIdentifier?): Promise<string[]>

Parameters

Name	Type
`call`	`Call`
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<string[]>

Inherited from

Mixin(BaseRpcProvider, StarknetId).callContract

Defined in

src/provider/rpc.ts:501

estimateMessageFee

▸ estimateMessageFee(message, blockIdentifier?): Promise<{ unit: "WEI" | "FRI" ; overall_fee: string | number ; l1_gas_price: undefined | number ; l2_gas_price: undefined | number ; l1_data_gas_price: undefined | number ; l1_gas_consumed: undefined | number ; l2_gas_consumed: undefined | number ; l1_data_gas_consumed: undefined | number ; gas_consumed: undefined | string ; gas_price: undefined | string ; data_gas_consumed: undefined | string ; data_gas_price: undefined | string }>

NEW: Estimate the fee for a message from L1

Parameters

Name	Type	Description
`message`	`Object`	Message From L1
`message.entry_point_selector`	`string`	-
`message.from_address`	`string`	-
`message.to_address`	`string`	-
`message.payload`	`string`[]	-
`blockIdentifier?`	`BlockIdentifier`	-

Returns

Promise<{ unit: "WEI" | "FRI" ; overall_fee: string | number ; l1_gas_price: undefined | number ; l2_gas_price: undefined | number ; l1_data_gas_price: undefined | number ; l1_gas_consumed: undefined | number ; l2_gas_consumed: undefined | number ; l1_data_gas_consumed: undefined | number ; gas_consumed: undefined | string ; gas_price: undefined | string ; data_gas_consumed: undefined | string ; data_gas_price: undefined | string }>

Inherited from

Mixin(BaseRpcProvider, StarknetId).estimateMessageFee

Defined in

src/provider/rpc.ts:509

getSyncingStats

▸ getSyncingStats(): Promise<Syncing>

Returns an object about the sync status, or false if the node is not synching

Returns

Promise<Syncing>

Object with the stats data

Inherited from

Mixin(BaseRpcProvider, StarknetId).getSyncingStats

Defined in

src/provider/rpc.ts:520

getEvents

▸ getEvents(eventFilter): Promise<{ events: { keys: string[]; data: string[]; block_number: number; block_hash: string; transaction_hash: string; from_address: string; }[] ; continuation_token: undefined | string }>

Returns all events matching the given filter

Parameters

Name	Type
`eventFilter`	`EventFilter`

Returns

Promise<{ events: { keys: string[]; data: string[]; block_number: number; block_hash: string; transaction_hash: string; from_address: string; }[] ; continuation_token: undefined | string }>

events and the pagination of the events

Inherited from

Mixin(BaseRpcProvider, StarknetId).getEvents

Defined in

src/provider/rpc.ts:528

verifyMessageInStarknet

▸ verifyMessageInStarknet(message, signature, accountAddress, signatureVerificationFunctionName?, signatureVerificationResponse?): Promise<boolean>

Verify in Starknet a signature of a TypedData object or of a given hash.

Parameters

Name	Type	Description
`message`	`TypedData` \| `BigNumberish`	TypedData object to be verified, or message hash to be verified.
`signature`	`Signature`	signature of the message.
`accountAddress`	`BigNumberish`	address of the account that has signed the message.
`signatureVerificationFunctionName?`	`string`	if account contract with non standard account verification function name.
`signatureVerificationResponse?`	`Object`	if account contract with non standard response of verification function.
`signatureVerificationResponse.okResponse`	`string`[]	-
`signatureVerificationResponse.nokResponse`	`string`[]	-
`signatureVerificationResponse.error`	`string`[]	-

Returns

Promise<boolean>

const myTypedMessage: TypedMessage = .... ;
const messageHash = typedData.getMessageHash(myTypedMessage,accountAddress);
const sign: WeierstrassSignatureType = ec.starkCurve.sign(messageHash, privateKey);
const accountAddress = "0x43b7240d227aa2fb8434350b3321c40ac1b88c7067982549e7609870621b535";
const result1 = myRpcProvider.verifyMessageInStarknet(myTypedMessage, sign, accountAddress);
const result2 = myRpcProvider.verifyMessageInStarknet(messageHash, sign, accountAddress);
// result1 = result2 = true

Inherited from

Mixin(BaseRpcProvider, StarknetId).verifyMessageInStarknet

Defined in

src/provider/rpc.ts:550

isClassDeclared

▸ isClassDeclared(contractClassIdentifier, blockIdentifier?): Promise<boolean>

Test if class is already declared from ContractClassIdentifier Helper method using getClass

Parameters

Name	Type
`contractClassIdentifier`	`ContractClassIdentifier`
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<boolean>

Inherited from

Mixin(BaseRpcProvider, StarknetId).isClassDeclared

Defined in

src/provider/rpc.ts:636

prepareInvocations

▸ prepareInvocations(invocations): Promise<Invocations>

Build bulk invocations with auto-detect declared class

Test if class is declared if not declare it preventing already declared class error and not declared class errors
Order declarations first

Parameters

Name	Type
`invocations`	`Invocations`

Returns

Promise<Invocations>

Inherited from

Mixin(BaseRpcProvider, StarknetId).prepareInvocations

Defined in

src/provider/rpc.ts:667

getL1MessagesStatus

▸ getL1MessagesStatus(transactionHash): Promise<L1L2MessagesStatus>

Given an l1 tx hash, returns the associated l1_handler tx hashes and statuses for all L1 -> L2 messages sent by the l1 transaction, ordered by the l1 tx sending order

Parameters

Name	Type
`transactionHash`	`BigNumberish`

Returns

Promise<L1L2MessagesStatus>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getL1MessagesStatus

Defined in

src/provider/rpc.ts:691

getStorageProof

▸ getStorageProof(classHashes, contractAddresses, contractsStorageKeys, blockIdentifier?): Promise<StorageProof>

Get merkle paths in one of the state tries: global state, classes, individual contract

Parameters

Name	Type
`classHashes`	`BigNumberish`[]
`contractAddresses`	`BigNumberish`[]
`contractsStorageKeys`	`CONTRACT_STORAGE_KEYS`[]
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<StorageProof>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getStorageProof

Defined in

src/provider/rpc.ts:702

getCompiledCasm

▸ getCompiledCasm(classHash): Promise<CASM_COMPILED_CONTRACT_CLASS>

Get the contract class definition in the given block associated with the given hash

Parameters

Name	Type
`classHash`	`BigNumberish`

Returns

Promise<CASM_COMPILED_CONTRACT_CLASS>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getCompiledCasm

Defined in

src/provider/rpc.ts:723

getStarkName

▸ getStarkName(address, StarknetIdContract?): Promise<string>

Parameters

Name	Type
`address`	`BigNumberish`
`StarknetIdContract?`	`string`

Returns

Promise<string>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getStarkName

Defined in

src/provider/extensions/starknetId.ts:22

getAddressFromStarkName

▸ getAddressFromStarkName(name, StarknetIdContract?): Promise<string>

Parameters

Name	Type
`name`	`string`
`StarknetIdContract?`	`string`

Returns

Promise<string>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getAddressFromStarkName

Defined in

src/provider/extensions/starknetId.ts:31

getStarkProfile

▸ getStarkProfile(address, StarknetIdContract?, StarknetIdIdentityContract?, StarknetIdVerifierContract?, StarknetIdPfpContract?, StarknetIdPopContract?, StarknetIdMulticallContract?): Promise<StarkProfile>

Parameters

Name	Type
`address`	`BigNumberish`
`StarknetIdContract?`	`string`
`StarknetIdIdentityContract?`	`string`
`StarknetIdVerifierContract?`	`string`
`StarknetIdPfpContract?`	`string`
`StarknetIdPopContract?`	`string`
`StarknetIdMulticallContract?`	`string`

Returns

Promise<StarkProfile>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getStarkProfile

Defined in

src/provider/extensions/starknetId.ts:40

Hierarchy​

Constructors​

constructor​

Parameters​

Returns​

Inherited from​

Defined in​

Returns​

Inherited from​

Properties​

responseParser​

Inherited from​

Defined in​

channel​

Inherited from​

Defined in​

getStateUpdate​

Type declaration​

Returns​

Parameters​

Returns​

Parameters​

Returns​

Parameters​

Returns​

Inherited from​

Defined in​

Methods​

create​

Type parameters​

Parameters​

Returns​

Inherited from​

Defined in​

getStarkName​

Parameters​

Returns​

Inherited from​

Defined in​

getAddressFromStarkName​

Parameters​

Returns​

Inherited from​

Defined in​

getStarkProfile​

Parameters​

Returns​

Inherited from​

Defined in​

fetch​

Parameters​

Returns​

Inherited from​

Defined in​

getChainId​

Returns​

Inherited from​

Defined in​

readSpecVersion​

Returns​

Inherited from​

Defined in​

getSpecVersion​

Returns​

Inherited from​

Defined in​

setUpSpecVersion​

Returns​

Inherited from​

Defined in​

getNonceForAddress​

Parameters​

Returns​

Inherited from​

Defined in​

getBlock​

Returns​

Inherited from​

Defined in​

Parameters​

Hierarchy

Constructors

constructor

Parameters

Returns

Inherited from

Defined in

Returns

Inherited from

Properties

responseParser

Inherited from

Defined in

channel

Inherited from

Defined in

getStateUpdate

Type declaration

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Inherited from

Defined in

Methods

create

Type parameters

Parameters

Returns

Inherited from

Defined in

getStarkName

Parameters

Returns

Inherited from

Defined in

getAddressFromStarkName

Parameters

Returns

Inherited from

Defined in

getStarkProfile

Parameters

Returns

Inherited from

Defined in

fetch

Parameters

Returns

Inherited from

Defined in

getChainId

Returns

Inherited from

Defined in

readSpecVersion

Returns

Inherited from

Defined in

getSpecVersion

Returns

Inherited from

Defined in

setUpSpecVersion

Returns

Inherited from

Defined in

getNonceForAddress

Parameters

Returns

Inherited from

Defined in

getBlock

Returns

Inherited from

Defined in

Parameters