Class: CallData

Constructors

constructor

• new CallData(abi): CallData

Parameters

Name	Type
abi	Abi

Returns

CallData

Defined in

src/utils/calldata/index.ts:52

Properties

abi

• abi: Abi

Defined in

src/utils/calldata/index.ts:44

---

parser

• parser: AbiParserInterface

Defined in

src/utils/calldata/index.ts:46

---

structs

• Protected Readonly structs: AbiStructs

Defined in

src/utils/calldata/index.ts:48

---

enums

• Protected Readonly enums: AbiEnums

Defined in

src/utils/calldata/index.ts:50

Methods

compile

▸ compile(rawArgs): Calldata

Compile contract callData without abi

Parameters

Name	Type	Description
rawArgs	RawArgs	RawArgs representing cairo method arguments or string array of compiled data

Returns

Calldata

Calldata

Defined in

src/utils/calldata/index.ts:165

---

getAbiStruct

▸ getAbiStruct(abi): AbiStructs

Helper to extract structs from abi

Parameters

Name	Type	Description
abi	Abi	Abi

Returns

AbiStructs

AbiStructs - structs from abi

Defined in

src/utils/calldata/index.ts:283

---

getAbiEnum

▸ getAbiEnum(abi): AbiEnums

Helper to extract enums from abi

Parameters

Name	Type	Description
abi	Abi	Abi

Returns

AbiEnums

AbiEnums - enums from abi

Defined in

src/utils/calldata/index.ts:300

---

toCalldata

▸ toCalldata(rawCalldata?): Calldata

Helper: Compile HexCalldata | RawCalldata | RawArgs

Parameters

Name	Type	Default value	Description
rawCalldata	RawArgs	[]	HexCalldata | RawCalldata | RawArgs

Returns

Calldata

Calldata

Defined in

src/utils/calldata/index.ts:319

---

toHex

▸ toHex(raw?): HexCalldata

Helper: Convert raw to HexCalldata

Parameters

Name	Type	Default value	Description
raw	RawArgs	[]	HexCalldata | RawCalldata | RawArgs

Returns

HexCalldata

HexCalldata

Defined in

src/utils/calldata/index.ts:328

---

validate

▸ validate(type, method, args?): void

Validate arguments passed to the method as corresponding to the ones in the abi

Parameters

Name	Type	Default value	Description
type	"DEPLOY" | "INVOKE" | "CALL"	undefined	ValidateType - type of the method
method	string	undefined	string - name of the method
args	ArgsOrCalldata	[]	ArgsOrCalldata - arguments that are passed to the method

Returns

void

Defined in

src/utils/calldata/index.ts:65

---

compile

▸ compile(method, argsCalldata): Calldata

Compile contract callData with abi Parse the calldata by using input fields from the abi for that method

Parameters

Name	Type	Description
method	string	string - method name
argsCalldata	RawArgs	RawArgs - arguments passed to the method. Can be an array of arguments (in the order of abi definition), or an object constructed in conformity with abi (in this case, the parameter can be in a wrong order).

Returns

Calldata

Calldata - parsed arguments in format that contract is expecting

Example

const calldata = myCallData.compile("constructor", ["0x34a", [1, 3n]]);

const calldata2 = myCallData.compile("constructor", {list:[1, 3n], balance:"0x34"}); // wrong order is valid

Defined in

src/utils/calldata/index.ts:118

---

parse

▸ parse(method, response): CallResult

Parse elements of the response array and structuring them into response object

Parameters

Name	Type	Description
method	string	string - method name
response	string[]	string[] - response from the method

Returns

CallResult

Result - parsed response corresponding to the abi

Defined in

src/utils/calldata/index.ts:249

---

format

▸ format(method, response, format): CallResult

Format cairo method response data to native js values based on provided format schema

Parameters

Name	Type	Description
method	string	string - cairo method name
response	string[]	string[] - cairo method response
format	object	object - formatter object schema

Returns

CallResult

Result - parsed and formatted response object

Defined in

src/utils/calldata/index.ts:273

---

decodeParameters

▸ decodeParameters(typeCairo, response): AllowArray<CallResult>

Parse the elements of a contract response and structure them into one or several Result. In Cairo 0, arrays are not supported.

Parameters

Name	Type	Description
typeCairo	AllowArray<string>	string or string[] - Cairo type name, ex : "hello::hello::UserData"
response	string[]	string[] - serialized data corresponding to typeCairo.

Returns

AllowArray<CallResult>

Result or Result[] - parsed response corresponding to typeData.

Example

const res2=helloCallData.decodeParameters("hello::hello::UserData",["0x123456","0x1"]);
result = { address: 1193046n, is_claimed: true }

Defined in

src/utils/calldata/index.ts:343