ao-js-sdk - v0.0.9
    Preparing search index...

    Interface IStakingClient

    interface IStakingClient {
        stake(
            quantity: string,
            additionaForwardedlTags?: Tags,
        ): Promise<boolean>;
        unstake(data: string): Promise<boolean>;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Methods

    stake unstake

    Methods

    • Stakes tokens by transferring them with an X-Stake tag

      Parameters

      • quantity: string

        Amount of tokens to stake

      • OptionaladditionaForwardedlTags: Tags

      Returns Promise<boolean>

      Promise resolving to the boolean representation of staking success

    • Unstakes tokens for a provider

      Parameters

      • data: string

        optional data to pass when unstaking

      Returns Promise<boolean>

      Promise resolving to true if unstaking was successful, false if it failed

    Settings

    Member Visibility

    On This Page

    Methods