Arc56Method

@algorandfoundation/algokit-utils / types/app-arc56 / Arc56Method

types/app-arc56.Arc56Method

Wrapper around algosdk.ABIMethod that represents an ARC-56 ABI method.

Hierarchy

• ABIMethod

  ↳ Arc56Method

Table of contents

Constructors

• constructor

Properties

• args
• description
• events
• method
• name
• readonly
• returns

Methods

• getSelector
• getSignature
• toJSON
• txnCount
• fromSignature

Constructors

constructor

• new Arc56Method(method): Arc56Method

Parameters

Name	Type
method	Method

Returns

Arc56Method

Overrides

algosdk.ABIMethod.constructor

Defined in

src/types/app-arc56.ts:27

Properties

args

• Readonly args: { defaultValue?: { data: string ; source: "method" | "box" | "global" | "local" | "literal" ; type?: string } ; desc?: string ; name?: string ; struct?: string ; type: ABIArgumentType }[]

Overrides

algosdk.ABIMethod.args

Defined in

src/types/app-arc56.ts:24

---

description

• Optional Readonly description: string

Inherited from

algosdk.ABIMethod.description

Defined in

node_modules/algosdk/dist/types/abi/method.d.ts:28

---

events

• Optional Readonly events: ARC28Event[]

Inherited from

algosdk.ABIMethod.events

Defined in

node_modules/algosdk/dist/types/abi/method.d.ts:38

---

method

• method: Method

Defined in

src/types/app-arc56.ts:27

---

name

• Readonly name: string

Inherited from

algosdk.ABIMethod.name

Defined in

node_modules/algosdk/dist/types/abi/method.d.ts:27

---

readonly

• Optional Readonly readonly: boolean

Inherited from

algosdk.ABIMethod.readonly

Defined in

node_modules/algosdk/dist/types/abi/method.d.ts:39

---

returns

• Readonly returns: Object

Type declaration

Name	Type	Description
desc?	string	Optional, user-friendly description for the return value
struct?	string	If the type is a struct, the name of the struct
type	ABIReturnType	-

Overrides

algosdk.ABIMethod.returns

Defined in

src/types/app-arc56.ts:25

Methods

getSelector

▸ getSelector(): Uint8Array

Returns

Uint8Array

Inherited from

algosdk.ABIMethod.getSelector

Defined in

node_modules/algosdk/dist/types/abi/method.d.ts:42

---

getSignature

▸ getSignature(): string

Returns

string

Inherited from

algosdk.ABIMethod.getSignature

Defined in

node_modules/algosdk/dist/types/abi/method.d.ts:41

---

toJSON

▸ toJSON(): Method

Returns

Method

Overrides

algosdk.ABIMethod.toJSON

Defined in

src/types/app-arc56.ts:39

---

txnCount

▸ txnCount(): number

Returns

number

Inherited from

algosdk.ABIMethod.txnCount

Defined in

node_modules/algosdk/dist/types/abi/method.d.ts:43

---

fromSignature

▸ fromSignature(signature): ABIMethod

Parameters

Name	Type
signature	string

Returns

ABIMethod

Inherited from

algosdk.ABIMethod.fromSignature

Defined in

node_modules/algosdk/dist/types/abi/method.d.ts:45