Arc56Method
@algorandfoundation/algokit-utils / types/app-arc56 / Arc56Method
types/app-arc56.Arc56Method
Wrapper around algosdk.ABIMethod that represents an ARC-56 ABI method.
Hierarchy
Section titled “Hierarchy”-
ABIMethod↳
Arc56Method
Table of contents
Section titled “Table of contents”Constructors
Section titled “Constructors”Properties
Section titled “Properties”Methods
Section titled “Methods”Constructors
Section titled “Constructors”constructor
Section titled “constructor”• new Arc56Method(method): Arc56Method
Parameters
Section titled “Parameters”| Name | Type |
|---|---|
method | Method |
Returns
Section titled “Returns”Overrides
Section titled “Overrides”algosdk.ABIMethod.constructor
Defined in
Section titled “Defined in”Properties
Section titled “Properties”• Readonly args: { defaultValue?: { data: string ; source: "method" | "box" | "global" | "local" | "literal" ; type?: string } ; desc?: string ; name?: string ; struct?: string ; type: ABIArgumentType }[]
Overrides
Section titled “Overrides”algosdk.ABIMethod.args
Defined in
Section titled “Defined in”description
Section titled “description”• Optional Readonly description: string
Inherited from
Section titled “Inherited from”algosdk.ABIMethod.description
Defined in
Section titled “Defined in”node_modules/algosdk/dist/types/abi/method.d.ts:28
events
Section titled “events”• Optional Readonly events: ARC28Event[]
Inherited from
Section titled “Inherited from”algosdk.ABIMethod.events
Defined in
Section titled “Defined in”node_modules/algosdk/dist/types/abi/method.d.ts:38
method
Section titled “method”• method: Method
Defined in
Section titled “Defined in”• Readonly name: string
Inherited from
Section titled “Inherited from”algosdk.ABIMethod.name
Defined in
Section titled “Defined in”node_modules/algosdk/dist/types/abi/method.d.ts:27
readonly
Section titled “readonly”• Optional Readonly readonly: boolean
Inherited from
Section titled “Inherited from”algosdk.ABIMethod.readonly
Defined in
Section titled “Defined in”node_modules/algosdk/dist/types/abi/method.d.ts:39
returns
Section titled “returns”• Readonly returns: Object
Type declaration
Section titled “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
Section titled “Overrides”algosdk.ABIMethod.returns
Defined in
Section titled “Defined in”Methods
Section titled “Methods”getSelector
Section titled “getSelector”▸ getSelector(): Uint8Array
Returns
Section titled “Returns”Uint8Array
Inherited from
Section titled “Inherited from”algosdk.ABIMethod.getSelector
Defined in
Section titled “Defined in”node_modules/algosdk/dist/types/abi/method.d.ts:42
getSignature
Section titled “getSignature”▸ getSignature(): string
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”algosdk.ABIMethod.getSignature
Defined in
Section titled “Defined in”node_modules/algosdk/dist/types/abi/method.d.ts:41
toJSON
Section titled “toJSON”▸ toJSON(): Method
Returns
Section titled “Returns”Overrides
Section titled “Overrides”algosdk.ABIMethod.toJSON
Defined in
Section titled “Defined in”txnCount
Section titled “txnCount”▸ txnCount(): number
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”algosdk.ABIMethod.txnCount
Defined in
Section titled “Defined in”node_modules/algosdk/dist/types/abi/method.d.ts:43
fromSignature
Section titled “fromSignature”▸ fromSignature(signature): ABIMethod
Parameters
Section titled “Parameters”| Name | Type |
|---|---|
signature | string |
Returns
Section titled “Returns”ABIMethod
Inherited from
Section titled “Inherited from”algosdk.ABIMethod.fromSignature
Defined in
Section titled “Defined in”node_modules/algosdk/dist/types/abi/method.d.ts:45