​

primitives/CallData

​

Classes

​

InvalidCallDataLengthError

​

Extends

• Error

​

Constructors

Constructor

new InvalidCallDataLengthError(message, options?): InvalidCallDataLengthError

Parameters

message

options?

expected?

value?

Returns

Overrides

​

Properties

code

readonly code: "INVALID_CALLDATA_LENGTH" = "INVALID_CALLDATA_LENGTH"

expected

readonly expected: string

value

readonly value: unknown

​

InvalidHexFormatError

​

Extends

• Error

​

Constructors

Constructor

new InvalidHexFormatError(message): InvalidHexFormatError

Parameters

message

Returns

Overrides

​

Properties

code

readonly code: "INVALID_HEX_FORMAT" = "INVALID_HEX_FORMAT"

​

InvalidValueError

​

Extends

• Error

​

Constructors

Constructor

new InvalidValueError(message, options?): InvalidValueError

Parameters

message

options?

expected?

value?

Returns

Overrides

​

Properties

code

readonly code: "INVALID_VALUE" = "INVALID_VALUE"

expected?

readonly optional expected: string

value

readonly value: unknown

​

Interfaces

​

BaseCallData

​

Extends

• CallDataType

​

Indexable

​

Properties

[brand]

readonly [brand]: "CallData"

Inherited from

​

Methods

equals()

equals(other): boolean

Parameters

other

Returns

getSelector()

getSelector(): Uint8Array

Returns

hasSelector()

hasSelector(selector): boolean

Parameters

selector

Returns

toBytes()

toBytes(): Uint8Array

Returns

toHex()

toHex(): string

Returns

Overrides

​

Type Aliases

​

CallDataType

CallDataType = Uint8Array & object

​

Type Declaration

[brand]

readonly [brand]: "CallData"

​

Variables

​

decode()

const decode: (calldata, abi) => CallDataDecoded = BrandedCallData.decode

​

Parameters

calldata

abi

​

Returns

​

Throws

​

Example

const abi = [{
  name: "transfer",
  type: "function",
  inputs: [
    { name: "to", type: "address" },
    { name: "amount", type: "uint256" }
  ]
}];

const decoded = CallData.decode(calldata, abi);
console.log(decoded.signature); // "transfer(address,uint256)"
console.log(decoded.parameters[0]); // "0x..."
console.log(decoded.parameters[1]); // bigint

​

encode()

const encode: (signature, params) => CallDataType = CallData.encode

​

Parameters

signature

params

​

Returns

​

equals()

const equals: (a, b) => boolean = BrandedCallData.equals

​

Parameters

a

b

​

Returns

​

Example

const calldata1 = CallData.from("0xa9059cbb...");
const calldata2 = CallData.from("0xa9059cbb...");
console.log(CallData.equals(calldata1, calldata2)); // true

​

from()

const from: (value) => CallDataType = CallData.from

​

Parameters

value

​

Returns

​

fromBytes()

const fromBytes: (value) => CallDataType = CallData.fromBytes

​

Parameters

value

​

Returns

​

fromHex()

const fromHex: (value) => CallDataType = CallData.fromHex

​

Parameters

value

​

Returns

​

getSelector()

const getSelector: (calldata) => Uint8Array<ArrayBufferLike> = BrandedCallData.getSelector

​

Parameters

calldata

​

Returns

​

Example

const calldata = CallData.from("0xa9059cbb...");
const selector = CallData.getSelector(calldata);
console.log(selector); // Uint8Array [0xa9, 0x05, 0x9c, 0xbb]

​

hasSelector()

const hasSelector: (calldata, selector) => boolean = BrandedCallData.hasSelector

​

Parameters

calldata

selector

​

Returns

​

Example

const calldata = CallData.from("0xa9059cbb...");

// Check with hex string
CallData.hasSelector(calldata, "0xa9059cbb"); // true

// Check with bytes
CallData.hasSelector(calldata, new Uint8Array([0xa9, 0x05, 0x9c, 0xbb])); // true

​

is()

const is: (value) => value is CallDataType = BrandedCallData.is

​

Parameters

value

​

Returns

​

Example

if (CallData.is(value)) {
  // value is CallDataType here (type narrowed)
  const selector = CallData.getSelector(value);
}

​

isValid()

const isValid: (value) => boolean = BrandedCallData.isValid

​

Parameters

value

​

Returns

​

Example

CallData.isValid("0xa9059cbb"); // true (valid 4-byte selector)
CallData.isValid("0x1234"); // false (only 2 bytes)
CallData.isValid("0xGGGG"); // false (invalid hex)
CallData.isValid(null); // false

​

MIN_SIZE

const MIN_SIZE: number = 4

​

SELECTOR_SIZE

const SELECTOR_SIZE: number = 4

​

toBytes()

const toBytes: (calldata) => Uint8Array<ArrayBufferLike> = BrandedCallData.toBytes

​

Parameters

calldata

​

Returns

​

Example

const calldata = CallData.from("0xa9059cbb");
const bytes = CallData.toBytes(calldata);
console.log(bytes.length); // 4

​

toHex()

const toHex: (calldata) => HexType = BrandedCallData.toHex

​

Parameters

calldata

​

Returns

​

Example

const calldata = CallData.fromBytes(new Uint8Array([0xa9, 0x05, 0x9c, 0xbb]));
console.log(CallData.toHex(calldata)); // "0xa9059cbb"

​

Functions

​

CallData()

CallData(value): BaseCallData

​

Parameters

value

​

Returns

​

See

​

Since

​

Throws

​

Example

import { CallData } from './primitives/CallData/index.js';
const calldata = CallData('0xa9059cbb...');
console.log(calldata.toHex());

​

References

​

default