Function VaultsApiFactory

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

• asgard:function

  • asgard(height?, options?): AxiosPromise<VaultsResponse>

  • Returns current asgard vaults.

    Parameters

    • Optional height: number

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

      Override http request option.

    Returns AxiosPromise<VaultsResponse>

    Throws

• vault:function

  • vault(pubkey, height?, options?): AxiosPromise<Vault>

  • Returns the vault for the provided pubkey.

    Parameters

    • pubkey: string
    • Optional height: number

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

      Override http request option.

    Returns AxiosPromise<Vault>

    Throws

• vaultPubkeys:function

  • vaultPubkeys(height?, options?): AxiosPromise<VaultPubkeysResponse>

  • Returns all pubkeys for current vaults.

    Parameters

    • Optional height: number

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

      Override http request option.

    Returns AxiosPromise<VaultPubkeysResponse>

    Throws

• yggdrasil:function

  • yggdrasil(height?, options?): AxiosPromise<VaultsResponse>

  • Returns current yggdrasil vaults.

    Parameters

    • Optional height: number

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

      Override http request option.

    Returns AxiosPromise<VaultsResponse>

    Throws