Wallets | bitgo

Hierarchy

Wallets

Index

Constructors

constructor

Methods

Constructors

constructor

new Wallets(bitgo: BitGo, baseCoin: BaseCoin): Wallets

- Defined in drone/src/modules/core/src/v2/wallets.ts:89
Parameters
- bitgo: BitGo
- baseCoin: BaseCoin
Returns Wallets

Methods

acceptShare

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

- Defined in drone/src/modules/core/src/v2/wallets.ts:564
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: AcceptShareOptions = {}
- Optional callback: NodeCallback<any>
Returns Bluebird<any>

add

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

- Defined in drone/src/modules/core/src/v2/wallets.ts:170
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: AddWalletOptions = {}
- Optional callback: NodeCallback<any>
Returns Bluebird<any>

cancelShare

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

- Defined in drone/src/modules/core/src/v2/wallets.ts:541
Cancel a wallet share

Parameters
- Default value params: object = {}
- Optional callback: NodeCallback<any>
Returns Bluebird<any>

generateWallet

generateWallet(params?: GenerateWalletOptions, callback?: NodeCallback<WalletWithKeychains>): Bluebird<WalletWithKeychains>

- Defined in drone/src/modules/core/src/v2/wallets.ts:275
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
- Default value params: GenerateWalletOptions = {}
- Optional callback: NodeCallback<WalletWithKeychains>
Returns Bluebird<WalletWithKeychains>

get

get(params?: GetWalletOptions, callback?: NodeCallback<Wallet>): Bluebird<Wallet>

- Defined in drone/src/modules/core/src/v2/wallets.ts:101
Get a wallet by ID (proxy for getWallet)

Parameters
- Default value params: GetWalletOptions = {}
- Optional callback: NodeCallback<Wallet>
Returns Bluebird<Wallet>

getShare

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

- Defined in drone/src/modules/core/src/v2/wallets.ts:491
Gets a wallet share information, including the encrypted sharing keychain. requires unlock if keychain is present.

Parameters
- Default value params: object = {}
- Optional callback: NodeCallback<any>
Returns Bluebird<any>

getTotalBalances

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

- Defined in drone/src/modules/core/src/v2/wallets.ts:697
For any given supported coin, get total balances for all wallets of that coin type on the account.

Parameters
- Default value params: __type = {}
- Optional callback: NodeCallback<any>
Returns Bluebird<any>

getWallet

getWallet(params?: GetWalletOptions, callback?: NodeCallback<Wallet>): Bluebird<Wallet>

- Defined in drone/src/modules/core/src/v2/wallets.ts:644
Get a wallet by its ID

Parameters
- Default value params: GetWalletOptions = {}
- Optional callback: NodeCallback<Wallet>
Returns Bluebird<Wallet>

getWalletByAddress

getWalletByAddress(params?: GetWalletByAddressOptions, callback?: NodeCallback<Wallet>): Bluebird<Wallet>

- Defined in drone/src/modules/core/src/v2/wallets.ts:676
Get a wallet by its address

Parameters
- Default value params: GetWalletByAddressOptions = {}
- Optional callback: NodeCallback<Wallet>
Returns Bluebird<Wallet>

list

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

- Defined in drone/src/modules/core/src/v2/wallets.ts:111
List a user's wallets

Parameters
- Default value params: ListWalletOptions = {}
- Optional callback: NodeCallback<object>
Returns Bluebird<object>

listShares

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

- Defined in drone/src/modules/core/src/v2/wallets.ts:478
List the user's wallet shares

Parameters
- Default value params: __type = {}
- Optional callback: NodeCallback<any>
Returns Bluebird<any>

resendShareInvite

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

- Defined in drone/src/modules/core/src/v2/wallets.ts:523
Resend a wallet share invitation email

Parameters
- Default value params: object = {}
- Optional callback: NodeCallback<any>
Returns Bluebird<any>

updateShare

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

- Defined in drone/src/modules/core/src/v2/wallets.ts:507
Update a wallet share

Parameters
- Default value params: UpdateShareOptions = {}
- Optional callback: NodeCallback<any>
Returns Bluebird<any>

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

bitgo: BitGo

baseCoin: BaseCoin

Returns Wallets

Methods

acceptShare

Parameters

Default value params: AcceptShareOptions = {}

Optional callback: NodeCallback<any>

Returns Bluebird<any>

add

Parameters

Default value params: AddWalletOptions = {}

Optional callback: NodeCallback<any>

Returns Bluebird<any>

cancelShare

Parameters

Default value params: object = {}

Optional callback: NodeCallback<any>

Returns Bluebird<any>

generateWallet

Parameters

Default value params: GenerateWalletOptions = {}

Optional callback: NodeCallback<WalletWithKeychains>

Returns Bluebird<WalletWithKeychains>

get

Parameters

Default value params: GetWalletOptions = {}

Optional callback: NodeCallback<Wallet>

Returns Bluebird<Wallet>

getShare

Parameters

Default value params: object = {}

Optional callback: NodeCallback<any>

Returns Bluebird<any>

getTotalBalances

Parameters

Default value params: __type = {}

Optional callback: NodeCallback<any>

Returns Bluebird<any>

getWallet

Parameters

Default value params: GetWalletOptions = {}

Optional callback: NodeCallback<Wallet>

Returns Bluebird<Wallet>

getWalletByAddress

Parameters

Default value params: GetWalletByAddressOptions = {}

Optional callback: NodeCallback<Wallet>

Returns Bluebird<Wallet>

list

Parameters

Default value params: ListWalletOptions = {}

Optional callback: NodeCallback<object>

Returns Bluebird<object>

listShares

Parameters

Default value params: __type = {}

Optional callback: NodeCallback<any>

Returns Bluebird<any>

resendShareInvite

Parameters

Default value params: object = {}

Optional callback: NodeCallback<any>

Returns Bluebird<any>

updateShare

Parameters

Default value params: UpdateShareOptions = {}

Optional callback: NodeCallback<any>

Returns Bluebird<any>