Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Wallets

Hierarchy

  • Wallets

Index

Constructors

Methods

Constructors

constructor

Methods

acceptShare

  • acceptShare(params?: any, callback?: NodeCallback<any>): Bluebird<any>

  • Accepts a wallet share, adding the wallet to the user's list Needs a user's password to decrypt the shared key

    Parameters

    • Default value params: any = {}
    • Optional callback: NodeCallback<any>

    Returns Bluebird<any>

add

  • add(params?: any, callback?: NodeCallback<any>): Bluebird<any>

  • add Add a new wallet (advanced mode). This allows you to manually submit the keys, type, m and n of the wallet Parameters include: "label": label of the wallet to be shown in UI "m": number of keys required to unlock wallet (2) "n": number of keys available on the wallet (3) "keys": array of keychain ids

    Parameters

    • Default value params: any = {}
    • Optional callback: NodeCallback<any>

    Returns Bluebird<any>

cancelShare

  • cancelShare(params?: any, callback?: NodeCallback<any>): Bluebird<any>

generateWallet

  • Generate a new wallet

    1. Creates the user keychain locally on the client, and encrypts it with the provided passphrase
    2. If no pub was provided, creates the backup keychain locally on the client, and encrypts it with the provided passphrase
    3. Uploads the encrypted user and backup keychains to BitGo
    4. Creates the BitGo key on the service
    5. Creates the wallet on BitGo with the 3 public keys above

    Parameters

    Returns Bluebird<WalletWithKeychains>

get

getShare

  • getShare(params?: any, callback?: NodeCallback<any>): Bluebird<any>

  • Gets a wallet share information, including the encrypted sharing keychain. requires unlock if keychain is present.

    Parameters

    • Default value params: any = {}
    • Optional callback: NodeCallback<any>

    Returns Bluebird<any>

getTotalBalances

  • getTotalBalances(params?: any, callback?: NodeCallback<any>): Bluebird<any>

  • For any given supported coin, get total balances for all wallets of that coin type on the account.

    Parameters

    • Default value params: any = {}
    • Optional callback: NodeCallback<any>

    Returns Bluebird<any>

getWallet

getWalletByAddress

list

  • list(params?: any, callback?: NodeCallback<object>): Bluebird<object>

  • List a user's wallets

    Parameters

    • Default value params: any = {}
    • Optional callback: NodeCallback<object>

    Returns Bluebird<object>

listShares

  • listShares(params?: any, callback?: NodeCallback<any>): Bluebird<any>

  • List the user's wallet shares

    Parameters

    • Default value params: any = {}
    • Optional callback: NodeCallback<any>

    Returns Bluebird<any>

resendShareInvite

  • resendShareInvite(params?: any, callback?: NodeCallback<any>): Bluebird<any>

  • Resend a wallet share invitation email

    Parameters

    • Default value params: any = {}
    • Optional callback: NodeCallback<any>

    Returns Bluebird<any>

updateShare

  • updateShare(params?: any, callback?: NodeCallback<any>): Bluebird<any>

Generated using TypeDoc