Skip to content

AbiMethodConfig

@algorandfoundation/algorand-typescript


@algorandfoundation/algorand-typescript / arc4 / AbiMethodConfig

Type Alias: AbiMethodConfig<TContract>

AbiMethodConfig<TContract>: object

Defined in: packages/algo-ts/src/arc4/index.ts:89

Configuration options for an abi method

Type Parameters

TContract extends Contract

the type of the contract this method is a part of

Type declaration

allowActions?

optional allowActions: OnCompleteActionStr | OnCompleteActionStr[]

Which on complete action(s) are allowed when invoking this method.

Default

'NoOp';

defaultArguments?

optional defaultArguments: Record<string, DefaultArgument<TContract>>

Specify default arguments that can be populated by clients calling this method.

A map of parameter names to the default argument source

name?

optional name: string

Override the name used to generate the abi method selector

onCreate?

optional onCreate: CreateOptions

Whether this method should be callable when creating the application.

Default

'disallow';

readonly?

optional readonly: boolean

Does the method only perform read operations (no mutation of chain state)

Default

false;