Name	Type
`compiledContract`	`CompiledContract`
`account`	`any`
`casm?`	`CairoAssembly`
`classHash?`	`string`
`compiledClassHash?`	`string`
`abi?`	`Abi`
`contractOptions?`	`ContractOptions`

Defined in

src/contract/contractFactory.ts:15

WebSocketOptions

Ƭ WebSocketOptions: Object

Type declaration

Name	Type	Description
`nodeUrl?`	`string`	websocket node url address `Example` `ts 'ws://www.host.com/path'` `Default` `ts public websocket enabled starknet node`
`websocket?`	`WebSocket`	This parameter should be used when working in an environment without native WebSocket support by providing an equivalent WebSocket object that conforms to the protocol, e.g. from the 'isows' and/or 'ws' modules https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/WebSocket#protocols . https://www.rfc-editor.org/rfc/rfc6455.html#section-1 . `Default` `ts WebSocket`

Defined in

src/channel/ws_0_8.ts:28

BatchClientOptions

Ƭ BatchClientOptions: Object

Type declaration

Name	Type
`nodeUrl`	`string`
`headers`	`object`
`interval`	`number`
`baseFetch`	`NonNullable`<`RpcProviderOptions`[`"baseFetch"`]>

Defined in

src/utils/batch/index.ts:5

CairoEnumRaw

Ƭ CairoEnumRaw: Record<string, any>

Defined in

src/utils/calldata/enum/CairoCustomEnum.ts:3

CairoOptionVariant

Ƭ CairoOptionVariant: ValuesType<typeof CairoOptionVariant>

Defined in

src/utils/calldata/enum/CairoOption.ts:4

src/utils/calldata/enum/CairoOption.ts:9

CairoResultVariant

Ƭ CairoResultVariant: ValuesType<typeof CairoResultVariant>

Defined in

src/utils/calldata/enum/CairoResult.ts:4

src/utils/calldata/enum/CairoResult.ts:9

LogLevelIndex

Ƭ LogLevelIndex: ValuesType<typeof LogLevelIndex>

Defined in

src/global/logger.type.ts:3

src/global/logger.type.ts:12

LogLevel

Ƭ LogLevel: keyof typeof LogLevelIndex

Defined in

src/global/logger.type.ts:14

Variables

defaultPaymaster

• Const defaultPaymaster: PaymasterRpc

Defined in

src/paymaster/index.ts:6

defaultProvider

• Const defaultProvider: RpcProvider

Defined in

src/provider/index.ts:8

WSSubscriptions

• Const WSSubscriptions: Object

Type declaration

Name	Type
`NEW_HEADS`	`"newHeads"`
`EVENTS`	`"events"`
`TRANSACTION_STATUS`	`"transactionStatus"`
`PENDING_TRANSACTION`	`"pendingTransactions"`

Defined in

src/channel/ws_0_8.ts:21

UINT_128_MAX

• Const UINT_128_MAX: bigint

Defined in

src/utils/cairoDataTypes/uint256.ts:10

UINT_256_MAX

• Const UINT_256_MAX: bigint

Defined in

src/utils/cairoDataTypes/uint256.ts:11

UINT_256_MIN

• Const UINT_256_MIN: 0n

Defined in

src/utils/cairoDataTypes/uint256.ts:12

UINT_256_LOW_MAX

• Const UINT_256_LOW_MAX: 340282366920938463463374607431768211455n

Defined in

src/utils/cairoDataTypes/uint256.ts:13

UINT_256_HIGH_MAX

• Const UINT_256_HIGH_MAX: 340282366920938463463374607431768211455n

Defined in

src/utils/cairoDataTypes/uint256.ts:14

UINT_256_LOW_MIN

• Const UINT_256_LOW_MIN: 0n

Defined in

src/utils/cairoDataTypes/uint256.ts:15

UINT_256_HIGH_MIN

• Const UINT_256_HIGH_MIN: 0n

Defined in

src/utils/cairoDataTypes/uint256.ts:16

UINT_512_MAX

• Const UINT_512_MAX: bigint

Defined in

src/utils/cairoDataTypes/uint512.ts:11

UINT_512_MIN

• Const UINT_512_MIN: 0n

Defined in

src/utils/cairoDataTypes/uint512.ts:12

UINT_128_MIN

• Const UINT_128_MIN: 0n

Defined in

src/utils/cairoDataTypes/uint512.ts:13

CairoOptionVariant

• Const CairoOptionVariant: Object

Type declaration

Name	Type
`Some`	`0`
`None`	`1`

Defined in

src/utils/calldata/enum/CairoOption.ts:4

src/utils/calldata/enum/CairoOption.ts:9

CairoResultVariant

• Const CairoResultVariant: Object

Type declaration

Name	Type
`Ok`	`0`
`Err`	`1`

Defined in

src/utils/calldata/enum/CairoResult.ts:4

src/utils/calldata/enum/CairoResult.ts:9

config

• Const config: Configuration

Defined in

src/global/config.ts:69

logger

• Const logger: Logger

Logger instance, use for the system logging. Higher the logger level index, higher the LogLevel required to display log. Default should be INFO

DEBUG: 5, INFO: 4, WARN: 3, ERROR: 2, FATAL: 1,

Defined in

src/global/logger.ts:166

LogLevelIndex

• Const LogLevelIndex: Object

Type declaration

Name	Type
`DEBUG`	`number`
`INFO`	`number`
`WARN`	`number`
`ERROR`	`number`
`FATAL`	`number`
`OFF`	`number`

Defined in

src/global/logger.type.ts:3

src/global/logger.type.ts:12

Functions

getCalldata

▸ getCalldata(args, callback): Calldata

Parameters

Name	Type
`args`	`RawArgs`
`callback`	`Function`

Returns

Calldata

Defined in

src/contract/default.ts:96

fixStack

▸ fixStack(target, fn?): void

Parameters

Name	Type	Default value
`target`	`Error`	`undefined`
`fn`	`Function`	`target.constructor`

Returns

void

Defined in

src/utils/errors/index.ts:7

fixProto

▸ fixProto(target, prototype): void

Parameters

Name	Type
`target`	`Error`
`prototype`	`Object`

Returns

void

Defined in

src/utils/errors/index.ts:13

getLedgerPathBuffer111

▸ getLedgerPathBuffer111(accountId, applicationName?): Uint8Array

Format the Ledger wallet path to an Uint8Array for a Ledger Starknet DAPP v1.1.1.

EIP2645 path = 2645'/starknet/application/0/accountId/0

Parameters

Name	Type	Default value	Description
`accountId`	`number`	`undefined`	Id of account. < 2**31.
`applicationName?`	`string`	`'LedgerW'`	utf8 string of application name.

Returns

Uint8Array

an Uint8array of 24 bytes.

Example

const result = getLedgerPathBuffer111(0);
// result = Uint8Array(24) [
  128,   0,  10,  85,  71, 65, 233, 201,
   43, 206, 231, 219,   0,  0,   0,   0,
    0,   0,   0,   0,   0,  0,   0,   0
]

Defined in

src/signer/ledgerSigner111.ts:362

getLedgerPathBuffer221

▸ getLedgerPathBuffer221(accountId, applicationName?): Uint8Array

Format the Ledger wallet path to an Uint8Array. for a Ledger Starknet DAPP v2.2.0 EIP2645 path = 2645'/starknet'/application'/0'/accountId'/0

Parameters

Name	Type	Default value	Description
`accountId`	`number`	`undefined`	Id of account. < 2**31.
`applicationName?`	`string`	`'LedgerW'`	utf8 string of application name.

Returns

Uint8Array

an Uint8array of 24 bytes.

Example

const result = getLedgerPathBuffer211(0);
// result = Uint8Array(24) [
  128,   0,  10,  85, 199, 65, 233, 201,
  171, 206, 231, 219, 128,  0,   0,   0,
  128,   0,   0,   0,   0,  0,   0,   0
]

Defined in

src/signer/ledgerSigner221.ts:644

isV3Tx

▸ isV3Tx(details): details is V3TransactionDetails

Check if the given transaction details is a V3 transaction.

Parameters

Name	Type	Description
`details`	`InvocationsDetailsWithNonce`	The transaction details to be checked.

Returns

details is V3TransactionDetails

Returns true if the transaction is a V3 transaction, otherwise false.

Example

const invocation: InvocationsDetailsWithNonce = {
  nonce: 1,
  version: 3,
  maxFee: 10 ** 15,
  feeDataAvailabilityMode: RPC.EDataAvailabilityMode.L1,
  tip: 10 ** 13,
  paymasterData: [],
  resourceBounds: {
      l1_gas: { max_amount: num.toHex(10 ** 14), max_price_per_unit: num.toHex(50) },
      l2_gas: { max_amount: num.toHex(0), max_price_per_unit: num.toHex(0) }}};
const result = provider.isV3Tx(invocation);
// result = true

Defined in

src/utils/resolve.ts:35

isVersion

▸ isVersion(expected, provided): boolean

Determines if the provided version matches the specified version. Version must be formatted "major.minor.patch" using dot delimiters. Use wildcard or unspecified to match 'any' value on the position. ex. 7.3. == 7.3.15, * == 1.1.1, 0.8 == 0.8.5. '' != 0.8.5

Parameters

Name	Type	Description
`expected`	`string`	version.
`provided`	`string`	to check against the expected version.

Returns

boolean

True if the response matches the version, false otherwise.

Example

const result = provider.isVersion("0.7","0.7.1");
// result = true

Defined in

src/utils/resolve.ts:56

isSupportedSpecVersion

▸ isSupportedSpecVersion(version, options?): version is "0.7.1" | "0.8.1"

Define if provided version is SDK supported rpc specification version

Parameters

Name	Type
`version`	`string`
`options`	`Object`
`options.allowAnyPatchVersion`	`boolean`

Returns

version is "0.7.1" | "0.8.1"

Defined in

src/utils/resolve.ts:66

toAnyPatchVersion

▸ toAnyPatchVersion(version): string

Convert fixed version to any patch version. ex. 0.8.1 -> 0.8.*

Parameters

Name	Type
`version`	`string`

Returns

string

Defined in

src/utils/resolve.ts:79

isPendingBlock

▸ isPendingBlock(response): response is Object

Guard Pending Block

Parameters

Name	Type	Description
`response`	`GetBlockResponse`	answer of myProvider.getBlock()

Returns

response is Object

true if block is the pending block

Example

const block = await myProvider.getBlock("pending");
const result = provider.isPendingBlock(block);
// result = true

Defined in

src/utils/resolve.ts:98

isPendingTransaction

▸ isPendingTransaction(response): boolean

Guard Pending Transaction

Parameters

Name	Type	Description
`response`	`GetTransactionReceiptResponse`	transaction Receipt

Returns

boolean

true if the transaction is part of the pending block

Example

const block = await myProvider.getBlockWithTxs("pending");
const txR = await myProvider.getTransactionReceipt(block.transactions[0].transaction_hash);
const result = provider.isPendingTransaction(txR);
// result = true

Defined in

src/utils/resolve.ts:114

isPendingStateUpdate

▸ isPendingStateUpdate(response): response is Object

Guard Pending State Update

Parameters

Name	Type	Description
`response`	`StateUpdateResponse`	State of a block

Returns

response is Object

true if the block is pending

Example

const state: StateUpdateResponse = await myProvider.getStateUpdate("pending");
const result = provider.isPendingStateUpdate(state);
// result = true

Defined in

src/utils/resolve.ts:129

addAddressPadding

▸ addAddressPadding(address): string

Format a hex number to '0x' and 64 characters, adding leading zeros if necessary.

Parameters

Name	Type
`address`	`BigNumberish`

Returns

string

Hex string: 0x followed by 64 characters. No upper case characters in the response.

Example

const result = [31, 0x1f, '31', '0x1f', '0x90591d9fa3efc87067d95a643f8455e0b8190eb8cb7bfd39e4fb7571fdf'].map(addAddressPadding);
// result = [
//   '0x000000000000000000000000000000000000000000000000000000000000001f',
//   '0x000000000000000000000000000000000000000000000000000000000000001f',
//   '0x0000000000000000000000000000000000000000000000000000000000000031',
//   '0x000000000000000000000000000000000000000000000000000000000000001f',
//   '0x0000090591d9fa3efc87067d95a643f8455e0b8190eb8cb7bfd39e4fb7571fdf'
// ]

Defined in

src/utils/address.ts:28

validateAndParseAddress

▸ validateAndParseAddress(address): string

Check the validity of a Starknet address, and format it as a hex number: '0x' and 64 characters, adding leading zeros if necessary.

Parameters

Name	Type
`address`	`BigNumberish`

Returns

string

Hex string: 0x followed by 64 characters. No upper case characters in the response.

Throws

address argument must be a valid address inside the address range bound

Example

const result = [31, 0x1f, '31', '0x1f', '0x90591d9fa3efc87067d95a643f8455e0b8190eb8cb7bfd39e4fb7571fdf'].map(addAddressPadding);
// result = [
//   '0x000000000000000000000000000000000000000000000000000000000000001f',
//   '0x000000000000000000000000000000000000000000000000000000000000001f',
//   '0x0000000000000000000000000000000000000000000000000000000000000031',
//   '0x000000000000000000000000000000000000000000000000000000000000001f',
//   '0x0000090591d9fa3efc87067d95a643f8455e0b8190eb8cb7bfd39e4fb7571fdf'
// ]

Defined in

src/utils/address.ts:52

getChecksumAddress

▸ getChecksumAddress(address): string

Convert an address to her checksum representation which uses a specific pattern of uppercase and lowercase letters within a given address to reduce the risk of errors introduced from typing an address or cut and paste issues.

Parameters

Name	Type
`address`	`BigNumberish`

Returns

string

Hex string : 0x followed by 64 characters. Mix of uppercase and lowercase

Example

const address = "0x90591d9fa3efc87067d95a643f8455e0b8190eb8cb7bfd39e4fb7571fdf";
const result = getChecksumAddress(address);
// result = "0x0000090591D9fA3EfC87067d95a643f8455E0b8190eb8Cb7bFd39e4fb7571fDF"

Defined in

src/utils/address.ts:77

validateChecksumAddress

▸ validateChecksumAddress(address): boolean

If the casing of an address is mixed, it is a Checksum Address, which uses a specific pattern of uppercase and lowercase letters within a given address to reduce the risk of errors introduced from typing an address or cut and paste issues.

Parameters

Name	Type	Description
`address`	`string`	string

Returns

boolean

true if the ChecksumAddress is valid

Example

const address = "0x0000090591D9fA3EfC87067d95a643f8455E0b8190eb8Cb7bFd39e4fb7571fDF";
const result = validateChecksumAddress(address);
// result = true

Defined in

src/utils/address.ts:107

parseCalldataField

▸ parseCalldataField(argsIterator, input, structs, enums): string | string[]

Parse one field of the calldata by using input field from the abi for that method

Parameters

Name	Type	Description
`argsIterator`	`Iterator`<`any`, `any`, `undefined`>	Iterator for value of the field
`input`	`AbiEntry`	input(field) information from the abi that will be used to parse the data
`structs`	`AbiStructs`	structs from abi
`enums`	`AbiEnums`	enums from abi

Returns

string | string[]

parsed arguments in format that contract is expecting

Example

const abiEntry = { name: 'test', type: 'struct' };
const abiStructs: AbiStructs = {
 struct: {
   members: [
       {
         name: 'test_name',
         type: 'test_type',
         offset: 1,
       },
   ],
   size: 2,
   name: 'cairo__struct',
   type: 'struct',
  },
};

const abiEnums: AbiEnums = {
  enum: {
    variants: [
      {
        name: 'test_name',
        type: 'cairo_struct_variant',
        offset: 1,
      },
    ],
    size: 2,
    name: 'test_cairo',
    type: 'enum',
  },
};

const args = [{ test_name: 'test' }];
const argsIterator = args[Symbol.iterator]();
const parsedField = parseCalldataField(
  argsIterator,
  abiEntry,
  abiStructs,
  abiEnums
);
// parsedField === ['1952805748']

Defined in

src/utils/calldata/requestParser.ts:352

isSierra

▸ isSierra(contract): contract is CompiledSierra | SierraContractClass

Checks if a given contract is in Sierra (Safe Intermediate Representation) format.

Parameters

Name	Type	Description
`contract`	`string` \| `CairoContract`	The contract to check. Can be either a CairoContract object or a string representation of the contract.

Returns

contract is CompiledSierra | SierraContractClass

Returns true if the contract is a Sierra contract, otherwise false.

Example

const result = isSierra(contract);
// result = true | false

Defined in

src/utils/contract.ts:26

extractContractHashes

▸ extractContractHashes(payload): CompleteDeclareContractPayload

Extracts contract hashes from DeclareContractPayload.

Parameters

Name	Type	Description
`payload`	`DeclareContractPayload`	The payload containing contract information.

Returns

CompleteDeclareContractPayload

The CompleteDeclareContractPayload with extracted contract hashes.

Throws

If extraction of compiledClassHash or classHash fails.

Example

const result = extractContractHashes(contract);
// result = {
//   contract: ...,
//   classHash: ...,
//   casm: ...,
//   compiledClassHash: ...,
// }

Defined in

src/utils/contract.ts:50

contractClassResponseToLegacyCompiledContract

▸ contractClassResponseToLegacyCompiledContract(ccr): LegacyCompiledContract

Helper to redeclare response Cairo0 contract

Parameters

Name	Type
`ccr`	`ContractClassResponse`

Returns

LegacyCompiledContract

Defined in

src/utils/contract.ts:75

units

▸ units(amount, simbol?): string

Convert strk to fri or fri to strk

Parameters

Name	Type	Default value
`amount`	`string` \| `bigint`	`undefined`
`simbol`	`"fri"` \| `"strk"`	`'fri'`

Returns

string

Example

units(1000n, 'fri') // '0.000000000000001' strk
units('1', 'strk') // '1000000000000000000' fri

Defined in

src/utils/units.ts:11

Namespaces
Classes
References
Type Aliases
Variables
Functions

Namespaces​

Classes​

References​

RpcProvider​

LedgerSigner​

getLedgerPathBuffer​

RpcChannel​

RPC​

WeierstrassSignatureType​

ArraySignatureType​

Signature​

BigNumberish​

ByteArray​

Calldata​

Uint256​

Uint512​

RawCalldata​

HexCalldata​

AllowArray​

OptionalPayload​

RawArgs​

RawArgsObject​

RawArgsArray​

MultiType​

UniversalDeployerContractPayload​

DeployAccountContractPayload​

DeployAccountContractTransaction​

DeclareContractPayload​

ContractClassIdentifier​

CompleteDeclareContractPayload​

DeclareAndDeployContractPayload​

DeclareContractTransaction​

CallDetails​

Invocation​

Call​

CairoVersion​

CompilerVersion​

InvocationsDetails​

V3TransactionDetails​

Details​

InvocationsDetailsWithNonce​

TransactionType​

TransactionFinalityStatus​

TransactionExecutionStatus​

BlockStatus​

BlockTag​

BlockNumber​

BlockIdentifier​

SubscriptionBlockIdentifier​

AccountInvocationItem​

AccountInvocations​

Invocations​

Tupled​

Args​

ParsedStruct​

waitForTransactionOptions​

getSimulateTransactionOptions​

getContractVersionOptions​

getEstimateFeeBulkOptions​

ContractVersion​

ContractClass​

CompiledContract​

CairoContract​

EntryPointType​

Abi​

AbiEntry​

EventEntry​

FunctionAbi​

AbiStructs​

AbiStruct​

AbiInterfaces​

InterfaceAbi​

AbiEnums​

AbiEnum​

AbiEvents​

AbiEvent​

CairoEvent​

CairoEventDefinition​

CairoEventVariant​

LegacyEvent​

Namespaces

Classes

References

RpcProvider

LedgerSigner

getLedgerPathBuffer

RpcChannel

RPC

WeierstrassSignatureType

ArraySignatureType

Signature

BigNumberish

ByteArray

Calldata

Uint256

Uint512

RawCalldata

HexCalldata

AllowArray

OptionalPayload

RawArgs

RawArgsObject

RawArgsArray

MultiType

UniversalDeployerContractPayload

DeployAccountContractPayload

DeployAccountContractTransaction

DeclareContractPayload

ContractClassIdentifier

CompleteDeclareContractPayload

DeclareAndDeployContractPayload

DeclareContractTransaction

CallDetails

Invocation

Call

CairoVersion

CompilerVersion

InvocationsDetails

V3TransactionDetails

Details

InvocationsDetailsWithNonce

TransactionType

TransactionFinalityStatus

TransactionExecutionStatus

BlockStatus

BlockTag

BlockNumber

BlockIdentifier

SubscriptionBlockIdentifier

AccountInvocationItem

AccountInvocations

Invocations

Tupled

Args

ParsedStruct

waitForTransactionOptions

getSimulateTransactionOptions

getContractVersionOptions

getEstimateFeeBulkOptions

ContractVersion

ContractClass

CompiledContract

CairoContract

EntryPointType

Abi

AbiEntry

EventEntry

FunctionAbi

AbiStructs

AbiStruct

AbiInterfaces

InterfaceAbi

AbiEnums

AbiEnum

AbiEvents

AbiEvent

CairoEvent

CairoEventDefinition

CairoEventVariant

LegacyEvent