Algorand TypeScript
    Preparing search index...

    Type Alias AbiMethodConfig<TContract>

    Configuration options for an abi method

    type AbiMethodConfig<TContract extends Contract> = {
        allowActions?: OnCompleteActionStr | OnCompleteActionStr[];
        defaultArguments?: Record<string, DefaultArgument<TContract>>;
        name?: string;
        onCreate?: CreateOptions;
        readonly?: boolean;
    }

    Type Parameters

    • TContract extends Contract

      the type of the contract this method is a part of

    Index

    Properties

    allowActions? defaultArguments? name? onCreate? readonly?

    Properties

    allowActions?: OnCompleteActionStr | OnCompleteActionStr[]

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

    'NoOp'
    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?: string

    Override the name used to generate the abi method selector

    onCreate?: CreateOptions

    Whether this method should be callable when creating the application.

    'disallow'
    readonly?: boolean

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

    false

    Settings

    Member Visibility

    On This Page

    Properties