Function VaultsApiAxiosParamCreator

  • VaultsApi - axios parameter creator

    Parameters

    Returns {
        asgard: ((height?, options?) => Promise<RequestArgs>);
        vault: ((pubkey, height?, options?) => Promise<RequestArgs>);
        vaultPubkeys: ((height?, options?) => Promise<RequestArgs>);
        yggdrasil: ((height?, options?) => Promise<RequestArgs>);
    }

    • asgard: ((height?, options?) => Promise<RequestArgs>)

      Returns current asgard vaults.

      Throws

        • (height?, options?): Promise<RequestArgs>
        • Parameters

          • Optional height: number

            optional block height, defaults to current tip

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • vault: ((pubkey, height?, options?) => Promise<RequestArgs>)

      Returns the vault for the provided pubkey.

      Throws

        • (pubkey, height?, options?): Promise<RequestArgs>
        • Parameters

          • pubkey: string
          • Optional height: number

            optional block height, defaults to current tip

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • vaultPubkeys: ((height?, options?) => Promise<RequestArgs>)

      Returns all pubkeys for current vaults.

      Throws

        • (height?, options?): Promise<RequestArgs>
        • Parameters

          • Optional height: number

            optional block height, defaults to current tip

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • yggdrasil: ((height?, options?) => Promise<RequestArgs>)

      Returns current yggdrasil vaults.

      Throws

        • (height?, options?): Promise<RequestArgs>
        • Parameters

          • Optional height: number

            optional block height, defaults to current tip

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    Export

Generated using TypeDoc