Function StakeApiAxiosParamCreator

Returns {
    buildStakingOperation: ((buildStakingOperationRequest, options?) => Promise<RequestArgs>);
    fetchHistoricalStakingBalances: ((networkId, assetId, addressId, startTime, endTime, limit?, page?, options?) => Promise<RequestArgs>);
    fetchStakingRewards: ((fetchStakingRewardsRequest, limit?, page?, options?) => Promise<RequestArgs>);
    getExternalStakingOperation: ((networkId, addressId, stakingOperationId, options?) => Promise<RequestArgs>);
    getStakingContext: ((getStakingContextRequest, options?) => Promise<RequestArgs>);
    getValidator: ((networkId, assetId, validatorId, options?) => Promise<RequestArgs>);
    listValidators: ((networkId, assetId, status?, limit?, page?, options?) => Promise<RequestArgs>);
}

• buildStakingOperation: ((buildStakingOperationRequest, options?) => Promise<RequestArgs>)

  Build a new staking operation

  Summary

  Build a new staking operation

  Throws

  • • (buildStakingOperationRequest, options?): Promise<RequestArgs>

    • Parameters

      • buildStakingOperationRequest: BuildStakingOperationRequest
      • Optional options: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• fetchHistoricalStakingBalances: ((networkId, assetId, addressId, startTime, endTime, limit?, page?, options?) => Promise<RequestArgs>)

  Fetch historical staking balances for given address.

  Summary

  Fetch historical staking balances

  Throws

  • • (networkId, assetId, addressId, startTime, endTime, limit?, page?, options?): Promise<RequestArgs>

    • Parameters

      • networkId: string

        The ID of the blockchain network.
      • assetId: string

        The ID of the asset for which the historical staking balances are being fetched.
      • addressId: string

        The onchain address for which the historical staking balances are being fetched.
      • startTime: string

        The start time of this historical staking balance period.
      • endTime: string

        The end time of this historical staking balance period.
      • Optional limit: number

        A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 50.
      • Optional page: string

        A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
      • Optional options: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• fetchStakingRewards: ((fetchStakingRewardsRequest, limit?, page?, options?) => Promise<RequestArgs>)

  Fetch staking rewards for a list of addresses

  Summary

  Fetch staking rewards

  Throws

  • • (fetchStakingRewardsRequest, limit?, page?, options?): Promise<RequestArgs>

    • Parameters

      • fetchStakingRewardsRequest: FetchStakingRewardsRequest
      • Optional limit: number

        A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 50.
      • Optional page: string

        A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
      • Optional options: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getExternalStakingOperation: ((networkId, addressId, stakingOperationId, options?) => Promise<RequestArgs>)

  Get the latest state of a staking operation

  Summary

  Get the latest state of a staking operation

  Throws

  • • (networkId, addressId, stakingOperationId, options?): Promise<RequestArgs>

    • Parameters

      • networkId: string

        The ID of the blockchain network
      • addressId: string

        The ID of the address to fetch the staking operation for
      • stakingOperationId: string

        The ID of the staking operation
      • Optional options: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getStakingContext: ((getStakingContextRequest, options?) => Promise<RequestArgs>)

  Get staking context for an address

  Summary

  Get staking context

  Throws

  • • (getStakingContextRequest, options?): Promise<RequestArgs>

    • Parameters

      • getStakingContextRequest: GetStakingContextRequest
      • Optional options: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getValidator: ((networkId, assetId, validatorId, options?) => Promise<RequestArgs>)

  Get a validator belonging to the user for a given network, asset and id.

  Summary

  Get a validator belonging to the CDP project

  Throws

  • • (networkId, assetId, validatorId, options?): Promise<RequestArgs>

    • Parameters

      • networkId: string

        The ID of the blockchain network.
      • assetId: string

        The symbol of the asset to get the validator for.
      • validatorId: string

        The unique id of the validator to fetch details for.
      • Optional options: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• listValidators: ((networkId, assetId, status?, limit?, page?, options?) => Promise<RequestArgs>)

  List validators belonging to the user for a given network and asset.

  Summary

  List validators belonging to the CDP project

  Throws

  • • (networkId, assetId, status?, limit?, page?, options?): Promise<RequestArgs>

    • Parameters

      • networkId: string

        The ID of the blockchain network.
      • assetId: string

        The symbol of the asset to get the validators for.
      • Optional status: ValidatorStatus

        A filter to list validators based on a status.
      • Optional limit: number

        A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 50.
      • Optional page: string

        A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
      • Optional options: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>