Class Keychains

Hierarchy

Keychains

Index

Constructors

constructor

Methods

Constructors

constructor

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

- Defined in src/v2/keychains.ts:97
Parameters
- bitgo: BitGo
- baseCoin: BaseCoin
Returns Keychains

Methods

add

add(params?: AddKeychainOptions, callback?: NodeCallback<Keychain>): Bluebird<Keychain>

- Defined in src/v2/keychains.ts:263
Add a keychain to BitGo's records

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

create

create(params?: object): KeyPair

- Defined in src/v2/keychains.ts:254
Create a public/private key pair

Parameters
- Default value params: object = {}
Returns KeyPair

createBackup

createBackup(params?: CreateBackupOptions, callback?: NodeCallback<Keychain>): Bluebird<Keychain>

- Defined in src/v2/keychains.ts:311
Create a backup key

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

createBitGo

createBitGo(params?: CreateBitGoOptions, callback?: NodeCallback<Keychain>): Bluebird<Keychain>

- Defined in src/v2/keychains.ts:298
Create a BitGo key

Parameters
- Default value params: CreateBitGoOptions = {}
  
  (empty)
- Optional callback: NodeCallback<Keychain>
Returns Bluebird<Keychain>

get

get(params: GetKeychainOptions, callback?: NodeCallback<Keychain>): Bluebird<Keychain>

- Defined in src/v2/keychains.ts:113
Get a keychain by ID

Parameters
- params: GetKeychainOptions
- Optional callback: NodeCallback<Keychain>
Returns Bluebird<Keychain>

getKeysForSigning

getKeysForSigning(params?: GetKeysForSigningOptions, callback?: NodeCallback<Keychain[]>): Bluebird<Keychain[]>

- Defined in src/v2/keychains.ts:333
Gets keys for signing from a wallet

Parameters
- Default value params: GetKeysForSigningOptions = {}
- Optional callback: NodeCallback<Keychain[]>
Returns Bluebird<Keychain[]>

list

list(params?: ListKeychainOptions, callback?: NodeCallback<ListKeychainsResult>): Bluebird<ListKeychainsResult>

- Defined in src/v2/keychains.ts:137
list the users keychains

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

updatePassword

updatePassword(params: UpdatePasswordOptions, callback?: NodeCallback<ChangedKeychains>): Bluebird<ChangedKeychains>

- Defined in src/v2/keychains.ts:178
Change the decryption password for all possible keychains associated with a user.

This function iterates through all keys associated with the user, decrypts them with the old password and re-encrypts them with the new password.

This should be called when a user changes their login password, and are expecting that their wallet passwords are changed to match the new login password.

Parameters
- params: UpdatePasswordOptions
- Optional callback: NodeCallback<ChangedKeychains>
Returns Bluebird<ChangedKeychains>

changedKeys Object - e.g.: { xpub1: encryptedPrv, ... }

updateSingleKeychainPassword

updateSingleKeychainPassword(params?: UpdateSingleKeychainPasswordOptions): Keychain

- Defined in src/v2/keychains.ts:226
Update the password used to decrypt a single keychain

Parameters
- Default value params: UpdateSingleKeychainPasswordOptions = {}
Returns Keychain

Generated using TypeDoc