Skip to main content
Version: 5.24.3

Namespace: cairo

Functions

isCairo1Abi

isCairo1Abi(abi): boolean

Test if an ABI comes from a Cairo 1 contract

Example

const isCairo1: boolean = isCairo1Abi(myAbi: Abi);

Parameters

NameTypeDescription
abiAbirepresenting the interface of a Cairo contract

Returns

boolean

TRUE if it is an ABI from a Cairo1 contract

Defined in

src/utils/calldata/cairo.ts:53


getAbiContractVersion

getAbiContractVersion(abi): ContractVersion

Return ContractVersion (Abi version) based on Abi or undefined for unknown version

Parameters

NameType
abiAbi

Returns

ContractVersion

string

Defined in

src/utils/calldata/cairo.ts:67


felt

felt(it): string

Create felt Cairo type (cairo type helper)

Parameters

NameType
itBigNumberish

Returns

string

format: felt-string

Defined in

src/utils/calldata/cairo.ts:127


isLen

isLen(name): boolean

Parameters

NameType
namestring

Returns

boolean

Defined in

src/utils/calldata/cairo.ts:16


isTypeFelt

isTypeFelt(type): boolean

Parameters

NameType
typestring

Returns

boolean

Defined in

src/utils/calldata/cairo.ts:17


isTypeArray

isTypeArray(type): boolean

Parameters

NameType
typestring

Returns

boolean

Defined in

src/utils/calldata/cairo.ts:18


isTypeTuple

isTypeTuple(type): boolean

Parameters

NameType
typestring

Returns

boolean

Defined in

src/utils/calldata/cairo.ts:22


isTypeNamedTuple

isTypeNamedTuple(type): boolean

Parameters

NameType
typestring

Returns

boolean

Defined in

src/utils/calldata/cairo.ts:23


isTypeStruct

isTypeStruct(type, structs): boolean

Parameters

NameType
typestring
structsAbiStructs

Returns

boolean

Defined in

src/utils/calldata/cairo.ts:24


isTypeEnum

isTypeEnum(type, enums): boolean

Parameters

NameType
typestring
enumsAbiEnums

Returns

boolean

Defined in

src/utils/calldata/cairo.ts:25


isTypeOption

isTypeOption(type): boolean

Parameters

NameType
typestring

Returns

boolean

Defined in

src/utils/calldata/cairo.ts:26


isTypeResult

isTypeResult(type): boolean

Parameters

NameType
typestring

Returns

boolean

Defined in

src/utils/calldata/cairo.ts:27


isTypeUint

isTypeUint(type): boolean

Parameters

NameType
typestring

Returns

boolean

Defined in

src/utils/calldata/cairo.ts:28


isTypeLitteral

isTypeLitteral(type): boolean

Parameters

NameType
typestring

Returns

boolean

Defined in

src/utils/calldata/cairo.ts:29


isTypeUint256

isTypeUint256(type): boolean

Parameters

NameType
typestring

Returns

boolean

Defined in

src/utils/calldata/cairo.ts:30


isTypeBool

isTypeBool(type): boolean

Parameters

NameType
typestring

Returns

boolean

Defined in

src/utils/calldata/cairo.ts:31


isTypeContractAddress

isTypeContractAddress(type): boolean

Parameters

NameType
typestring

Returns

boolean

Defined in

src/utils/calldata/cairo.ts:32


isTypeEthAddress

isTypeEthAddress(type): boolean

Parameters

NameType
typestring

Returns

boolean

Defined in

src/utils/calldata/cairo.ts:34


isCairo1Type

isCairo1Type(type): boolean

Parameters

NameType
typestring

Returns

boolean

Defined in

src/utils/calldata/cairo.ts:36


getArrayType

getArrayType(type): string

Parameters

NameType
typestring

Returns

string

Defined in

src/utils/calldata/cairo.ts:37


uint256

uint256(it): Uint256

Create Uint256 Cairo type (helper for common struct type)

Example

uint256('892349863487563453485768723498');

Parameters

NameType
itBigNumberish

Returns

Uint256

Defined in

src/utils/calldata/cairo.ts:101


tuple

tuple(...args): Record<number, boolean | object | BigNumberish>

Create unnamed tuple Cairo type (helper same as common struct type)

Example

tuple(1, '0x101', 16);

Parameters

NameType
...args(boolean | object | BigNumberish)[]

Returns

Record<number, boolean | object | BigNumberish>

Defined in

src/utils/calldata/cairo.ts:119