ABIAddressType
Defined in: packages/abi/src/abi-type.ts:285
An Algorand address ABI type.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ABIAddressType():
ABIAddressType
Returns
Section titled “Returns”ABIAddressType
Inherited from
Section titled “Inherited from”Accessors
Section titled “Accessors”displayName
Section titled “displayName”Get Signature
Section titled “Get Signature”get displayName():
string
Defined in: packages/abi/src/abi-type.ts:49
Returns a user-friendly display name for this type.
Returns
Section titled “Returns”string
The display name for this type
Inherited from
Section titled “Inherited from”Get Signature
Section titled “Get Signature”get name():
string
Defined in: packages/abi/src/abi-type.ts:286
Returns the ARC-4 type name string representation.
Returns
Section titled “Returns”string
The ARC-4 type string
Overrides
Section titled “Overrides”Methods
Section titled “Methods”byteLen()
Section titled “byteLen()”byteLen():
number
Defined in: packages/abi/src/abi-type.ts:298
Gets the byte length of the encoded type for static types.
Returns
Section titled “Returns”number
The number of bytes needed to encode this type
Throws
Section titled “Throws”Error if the type is dynamic
Overrides
Section titled “Overrides”decode()
Section titled “decode()”decode(
bytes):string
Defined in: packages/abi/src/abi-type.ts:318
Decodes bytes according to this ABI type.
Parameters
Section titled “Parameters”Uint8Array
The bytes to decode
Returns
Section titled “Returns”string
The decoded value
Overrides
Section titled “Overrides”encode()
Section titled “encode()”encode(
value):Uint8Array
Defined in: packages/abi/src/abi-type.ts:302
Encodes a value according to this ABI type.
Parameters
Section titled “Parameters”The value to encode
Returns
Section titled “Returns”Uint8Array
The encoded bytes
Overrides
Section titled “Overrides”equals()
Section titled “equals()”equals(
other):boolean
Defined in: packages/abi/src/abi-type.ts:290
Checks if this ABI type is equal to another.
Parameters
Section titled “Parameters”The other ABI type to compare with
Returns
Section titled “Returns”boolean
True if the types are equal, false otherwise
Overrides
Section titled “Overrides”isDynamic()
Section titled “isDynamic()”isDynamic():
boolean
Defined in: packages/abi/src/abi-type.ts:294
Checks if this ABI type is dynamic (variable-length).
Returns
Section titled “Returns”boolean
True if the type is dynamic, false otherwise
Overrides
Section titled “Overrides”toString()
Section titled “toString()”toString():
string
Defined in: packages/abi/src/abi-type.ts:57
Returns the ARC-4 type name string representation.
Returns
Section titled “Returns”string
The ARC-4 type string
Inherited from
Section titled “Inherited from”from()
Section titled “from()”
staticfrom(str):ABIType
Defined in: packages/abi/src/abi-type.ts:100
Creates an ABI type from an ARC-4 type string.
Parameters
Section titled “Parameters”string
The ARC-4 type string (e.g., “uint256”, “bool”, “(uint8,address)“)
Returns
Section titled “Returns”The corresponding ABI type