Function VaultsApiFp

Returns {
    asgard(height?, options?): Promise<((axios?, basePath?) => AxiosPromise<VaultsResponse>)>;
    vault(pubkey, height?, options?): Promise<((axios?, basePath?) => AxiosPromise<Vault>)>;
    vaultPubkeys(height?, options?): Promise<((axios?, basePath?) => AxiosPromise<VaultPubkeysResponse>)>;
    yggdrasil(height?, options?): Promise<((axios?, basePath?) => AxiosPromise<VaultsResponse>)>;
}

• asgard:function

  • asgard(height?, options?): Promise<((axios?, basePath?) => AxiosPromise<VaultsResponse>)>

  • Returns current asgard vaults.

    Parameters

    • Optional height: number

      optional block height, defaults to current tip
    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<VaultsResponse>)>

    Throws

• vault:function

  • vault(pubkey, height?, options?): Promise<((axios?, basePath?) => AxiosPromise<Vault>)>

  • Returns the vault for the provided pubkey.

    Parameters

    • pubkey: string
    • Optional height: number

      optional block height, defaults to current tip
    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<Vault>)>

    Throws

• vaultPubkeys:function

  • vaultPubkeys(height?, options?): Promise<((axios?, basePath?) => AxiosPromise<VaultPubkeysResponse>)>

  • Returns all pubkeys for current vaults.

    Parameters

    • Optional height: number

      optional block height, defaults to current tip
    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<VaultPubkeysResponse>)>

    Throws

• yggdrasil:function

  • yggdrasil(height?, options?): Promise<((axios?, basePath?) => AxiosPromise<VaultsResponse>)>

  • Returns current yggdrasil vaults.

    Parameters

    • Optional height: number

      optional block height, defaults to current tip
    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<VaultsResponse>)>

    Throws