Wallet | bitgo

Hierarchy

Wallet

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Wallet(bitgo: BitGo, baseCoin: BaseCoin, walletData: any): Wallet

- Defined in src/v2/wallet.ts:111
Parameters
- bitgo: BitGo
- baseCoin: BaseCoin
- walletData: any
Returns Wallet

Properties

baseCoin

baseCoin: BaseCoin

bitgo

bitgo: BitGo

Methods

accelerateTransaction

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

- Defined in src/v2/wallet.ts:1420
Accelerate a transaction's confirmation using Child-Pays-For-Parent (CPFP)

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

addWebhook

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

- Defined in src/v2/wallet.ts:992
Add a webhook to this wallet

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

addresses

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

- Defined in src/v2/wallet.ts:724
List the addresses for a given wallet

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

approvalsRequired

approvalsRequired(): number

- Defined in src/v2/wallet.ts:142
Get the number of approvals required for spending funds from this wallet

Returns number

balance

balance(): number

- Defined in src/v2/wallet.ts:149
Get the current balance of this wallet

Returns number

balanceString

balanceString(): string

- Defined in src/v2/wallet.ts:172
Get a string representation of the balance of this wallet

This is useful when balances have the potential to overflow standard javascript numbers

Returns string

changeFee

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

- Defined in src/v2/wallet.ts:1648
Change the fee on the pending transaction that corresponds to the given txid to the given new fee

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

The transaction ID of the new transaction that contains the new fee rate

coin

coin(): string

- Defined in src/v2/wallet.ts:197
Get the coin identifier for the type of coin this wallet holds

Returns string

coinSpecific

coinSpecific(): CoinSpecific | undefined

- Defined in src/v2/wallet.ts:246
Get wallet properties which are specific to certain coin implementations

Returns CoinSpecific | undefined

confirmedBalance

confirmedBalance(): number

- Defined in src/v2/wallet.ts:156
Get the confirmed balance of this wallet

Returns number

confirmedBalanceString

confirmedBalanceString(): string

- Defined in src/v2/wallet.ts:181
Get a string representation of the confirmed balance of this wallet

This is useful when balances have the potential to overflow standard javascript numbers

Returns string

consolidateUnspents

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

- Defined in src/v2/wallet.ts:535
Consolidate unspents on a wallet

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

txHex {String} the txHex of the incomplete transaction that needs to be signed by the user in the SDK

createAddress

createAddress(__namedParameters?: object, callback?: NodeCallback<any>): Bluebird<any>

- Defined in src/v2/wallet.ts:822
Create one or more new address(es) for use with this wallet.

If the count field is defined and greater than 1, an object with a single array property named addresses containing count address objects will be returned. Otherwise, a single address object is returned.

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

createPolicyRule

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

- Defined in src/v2/wallet.ts:1705
Create a policy rule

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

createShare

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

- Defined in src/v2/wallet.ts:1091
Send an encrypted wallet share to BitGo.

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

downloadKeycard

downloadKeycard(params?: any): void

- Defined in src/v2/wallet.ts:1806
Creates and downloads PDF keycard for wallet (requires response from wallets.generateWallet)

Note: this is example code and is not the version used on bitgo.com

Parameters
- Default value params: any = {}
  - jsPDF - an instance of the jsPDF library
  - QRCode - an instance of the QRious library
  - userKeychain - a wallet's private user keychain
  - backupKeychain - a wallet's private backup keychain
  - bitgoKeychain - a wallet's private bitgo keychain
  - passphrase - the wallet passphrase
  - passcodeEncryptionCode - the encryption secret used for Box D
  - activationCode - a randomly generated six-digit activation code
  - walletKeyID - the Key ID used for deriving a cold wallet's signing key
  - backupKeyID - the Key ID used for deriving a cold wallet's backup key
Returns void

fanoutUnspents

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

- Defined in src/v2/wallet.ts:579
Fanout unspents for a wallet

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

txHex {String} the txHex of the incomplete transaction that needs to be signed by the user in the SDK

freeze

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

- Defined in src/v2/wallet.ts:688
Freeze a given wallet

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

getAddress

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

- Defined in src/v2/wallet.ts:787
Get a single wallet address by its id

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

getEncryptedUserKeychain

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

- Defined in src/v2/wallet.ts:1023
Gets the user key chain for this wallet

The user key chain is the first keychain of the wallet and usually has the encrypted prv stored on BitGo. Useful when trying to get the users' keychain from the server before decrypting to sign a transaction.

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

getFirstPendingTransaction

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

- Defined in src/v2/wallet.ts:1632
Get transaction metadata for the oldest transaction that is still pending or attempted

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

Object with txid, walletId, tx, and fee (if supported for coin)

getPaymentInfo

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

- Defined in src/v2/wallet.ts:1666
Fetch info from merchant server

Parameters
- Default value params: any = {}
  
  The params passed into the function
- Optional callback: NodeCallback<any>
Returns Bluebird<any>

The info returned from the merchant server

getPrv

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

- Defined in src/v2/wallet.ts:1050
Gets the unencrypted private key for this wallet (be careful!) Requires wallet passphrase

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

getTransaction

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

- Defined in src/v2/wallet.ts:308
List the transactions for a given wallet

Parameters
- Default value params: object = {}
  - txHash the transaction hash to search for
- Optional callback: NodeCallback<any>
Returns Bluebird<any>

getTransfer

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

- Defined in src/v2/wallet.ts:450
Get transfers on this wallet

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

getUserPrv

getUserPrv(params?: GetUserPrvOptions): string

- Defined in src/v2/wallet.ts:1306
Get the user private key from either a derivation or an encrypted keychain

Parameters
- Default value params: GetUserPrvOptions = {}
Returns string

id

id(): string

- Defined in src/v2/wallet.ts:135
Get this wallet's id

Returns string

keyIds

keyIds(): string[]

- Defined in src/v2/wallet.ts:211
Get the public object ids for the keychains on this wallet.

Returns string[]

label

label(): string

- Defined in src/v2/wallet.ts:204
Get the label (name) for this wallet

Returns string

listWebhooks

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

- Defined in src/v2/wallet.ts:930
List webhooks on this wallet

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

maximumSpendable

maximumSpendable(params?: MaximumSpendableOptions, callback?: NodeCallback<MaximumSpendable>): Bluebird<MaximumSpendable>

- Defined in src/v2/wallet.ts:488
Get the maximum amount you can spend in a single transaction

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

NOTE : feeTxConfirmTarget omitted on purpose because gauging the maximum spendable amount with dynamic fees does not make sense

migratedFrom

migratedFrom(): string | undefined

- Defined in src/v2/wallet.ts:228
Get the wallet id of the wallet that this wallet was migrated from.

For example, if this is a BCH wallet that was created from a BTC wallet, the BCH wallet migrated from field would have the BTC wallet id.

Returns string | undefined

pendingApprovals

pendingApprovals(): PendingApproval[]

- Defined in src/v2/wallet.ts:253
Get all pending approvals on this wallet

Returns PendingApproval[]

prebuildAndSignTransaction

prebuildAndSignTransaction(params?: PrebuildAndSignTransactionOptions, callback?: NodeCallback<SignedTransaction>): Bluebird<SignedTransaction>

- Defined in src/v2/wallet.ts:1338
Get a transaction prebuild from BitGo, validate it, and then decrypt the user key and sign the transaction

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

prebuildTransaction

prebuildTransaction(params?: PrebuildTransactionOptions, callback?: NodeCallback<PrebuildTransactionResult>): Bluebird<PrebuildTransactionResult>

- Defined in src/v2/wallet.ts:1233
Fetch a transaction prebuild (unsigned transaction) from BitGo

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

receiveAddress

receiveAddress(): string

- Defined in src/v2/wallet.ts:218
Get a receive address for this wallet

Returns string

recoverToken

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

- Defined in src/v2/wallet.ts:1611
Recover an unsupported token from a BitGo multisig wallet params are validated in Eth.prototype.recoverToken

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

refresh

refresh(params?: __type, callback?: NodeCallback<Wallet>): Bluebird<Wallet>

- Defined in src/v2/wallet.ts:265
Refresh the wallet object by syncing with the back-end

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

remove

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

- Defined in src/v2/wallet.ts:1774
Remove this wallet

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

removePolicyRule

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

- Defined in src/v2/wallet.ts:1757
Remove Policy Rule

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

removeUser

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

- Defined in src/v2/wallet.ts:1193
Remove user from wallet

Parameters
- Default value params: any = {}
  - userId Id of the user to remove
- Optional callback: NodeCallback<any>
Returns Bluebird<any>

removeWebhook

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

- Defined in src/v2/wallet.ts:1006
Remove a webhook from this wallet

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

send

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

- Defined in src/v2/wallet.ts:1508
Send coins to a recipient

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

sendMany

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

- Defined in src/v2/wallet.ts:1564
Send money to multiple recipients
1. Gets the user keychain by checking the wallet for a key which has an encrypted prv
2. Decrypts user key
3. Creates the transaction with default fee
4. Signs transaction with decrypted user key
5. Sends the transaction to BitGo
Parameters
- Default value params: any = {}
- Optional callback: NodeCallback<any>
Returns Bluebird<any>

sendPaymentResponse

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

- Defined in src/v2/wallet.ts:1688
Send json payment response

Parameters
- Default value params: any = {}
  
  The params passed into the function
- Optional callback: NodeCallback<any>
Returns Bluebird<any>

The info returned from the merchant server Payment Ack

setPolicyRule

setPolicyRule(params?: any, callback?: NodeCallback<any>): any

- Defined in src/v2/wallet.ts:1732
Update a policy rule

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

shareWallet

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

- Defined in src/v2/wallet.ts:1112
Share this wallet with another BitGo user.

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

signTransaction

signTransaction(params?: WalletSignTransactionOptions, callback?: NodeCallback<SignedTransaction>): Bluebird<SignedTransaction>

- Defined in src/v2/wallet.ts:1284
Sign a transaction

Parameters
- Default value params: WalletSignTransactionOptions = {}
  - txPrebuild
  - [keychain / key] (object) or prv (string)
  - walletPassphrase
- Optional callback: NodeCallback<SignedTransaction>
Returns Bluebird<SignedTransaction>

simulateWebhook

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

- Defined in src/v2/wallet.ts:961
Simulate wallet webhook, currently for webhooks of type transfer and pending approval

Parameters
- Default value params: any = {}
  - webhookId (required) id of the webhook to be simulated
  - transferId (optional but required for transfer webhooks) id of the simulated transfer
  - pendingApprovalId (optional but required for pending approval webhooks) id of the simulated pending approval
- Optional callback: NodeCallback<any>
Returns Bluebird<any>

spendableBalance

spendableBalance(): number

- Defined in src/v2/wallet.ts:163
Get the spendable balance of this wallet

Returns number

spendableBalanceString

spendableBalanceString(): string

- Defined in src/v2/wallet.ts:190
Get a string representation of the spendable balance of this wallet

This is useful when balances have the potential to overflow standard javascript numbers

Returns string

submitTransaction

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

- Defined in src/v2/wallet.ts:1480
Submit a half-signed transaction to BitGo

Parameters
- Default value params: any = {}
  - txHex: transaction hex to submit
  - halfSigned: object containing transaction (txHex or txBase64) to submit
- Optional callback: NodeCallback<any>
Returns Bluebird<any>

sweep

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

- Defined in src/v2/wallet.ts:637
Sweep funds for a wallet

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

txHex {String} the txHex of the signed transaction

toTradingAccount

toTradingAccount(): TradingAccount

- Defined in src/v2/wallet.ts:1781
Create a trading account from this wallet

Returns TradingAccount

tokenFlushThresholds

tokenFlushThresholds(): any

- Defined in src/v2/wallet.ts:236
Return the token flush thresholds for this wallet

Returns any

pairs of { [tokenName]: thresholds } base units

transactions

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

- Defined in src/v2/wallet.ts:279
List the transactions for a given wallet

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

transferBySequenceId

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

- Defined in src/v2/wallet.ts:463
Get a transaction by sequence id for a given wallet

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

transferComment

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

- Defined in src/v2/wallet.ts:709
Update comment of a transfer

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

transfers

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

- Defined in src/v2/wallet.ts:338
List the transfers for a given wallet

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

unspents

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

- Defined in src/v2/wallet.ts:508
List the unspents for a given wallet

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

updateAddress

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

- Defined in src/v2/wallet.ts:913
Update properties on an address

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

updateTokenFlushThresholds

updateTokenFlushThresholds(thresholds?: any, callback?: NodeCallback<any>): Bluebird<any>

- Defined in src/v2/wallet.ts:610
Set the token flush thresholds for the wallet. Updates the wallet. Tokens will only be flushed from forwarder contracts if the balance is greater than the threshold defined here.

Parameters
- Default value thresholds: any = {}
  
  pairs of { [tokenName]: threshold } (base units)
- Optional callback: NodeCallback<any>
Returns Bluebird<any>

url

url(extra?: string): string

- Defined in src/v2/wallet.ts:128
Build a URL using this wallet's id which can be used for BitGo API operations

Parameters
- Default value extra: string = ""
  
  API specific string to append to the wallet id
Returns string

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

bitgo: BitGo

baseCoin: BaseCoin

walletData: any

Returns Wallet

Properties

baseCoin

bitgo

Methods

accelerateTransaction

Parameters

Default value params: any = {}

Optional callback: NodeCallback<any>

Returns Bluebird<any>

addWebhook

Parameters

Default value params: any = {}

Optional callback: NodeCallback<any>

Returns Bluebird<any>

addresses

Parameters

Default value params: any = {}

Optional callback: NodeCallback<any>

Returns Bluebird<any>

approvalsRequired

Returns number

balance

Returns number

balanceString

Returns string

changeFee

Parameters

Default value params: any = {}

Optional callback: NodeCallback<any>

Returns Bluebird<any>

coin

Returns string

coinSpecific

Returns CoinSpecific | undefined

confirmedBalance

Returns number

confirmedBalanceString

Returns string

consolidateUnspents

Parameters

Default value params: any = {}

Optional callback: NodeCallback<any>

Returns Bluebird<any>

createAddress

Parameters

Default value __namedParameters: object = {}

Optional callback: NodeCallback<any>

Returns Bluebird<any>

createPolicyRule

Parameters

Default value params: any = {}

Optional callback: NodeCallback<any>

Returns Bluebird<any>

createShare

Parameters

Default value params: any = {}

Optional callback: NodeCallback<any>

Returns Bluebird<any>

downloadKeycard

Parameters

Default value params: any = {}

Returns void

fanoutUnspents

Parameters

Default value params: any = {}

Optional callback: NodeCallback<any>

Returns Bluebird<any>

freeze