Class Wallet

Hierarchy

Wallet

Constructors

constructor

new Wallet(__namedParameters: { bitcoinPublicKeychain: string; chain: ChainID; configPrivateKey: string; encryptedBackupPhrase: string; firstBitcoinAddress: string; identities: Identity[]; identityAddresses: string[]; identityKeypairs: IdentityKeyPair[]; identityPublicKeychain: string; stacksPrivateKey: Buffer; walletConfig: undefined | WalletConfig }): Wallet

- Defined in packages/keychain/src/wallet/index.ts:75
Parameters
- __namedParameters: { bitcoinPublicKeychain: string; chain: ChainID; configPrivateKey: string; encryptedBackupPhrase: string; firstBitcoinAddress: string; identities: Identity[]; identityAddresses: string[]; identityKeypairs: IdentityKeyPair[]; identityPublicKeychain: string; stacksPrivateKey: Buffer; walletConfig: undefined | WalletConfig }
  - bitcoinPublicKeychain: string
  - chain: ChainID
  - configPrivateKey: string
  - encryptedBackupPhrase: string
  - firstBitcoinAddress: string
  - identities: Identity[]
  - identityAddresses: string[]
  - identityKeypairs: IdentityKeyPair[]
  - identityPublicKeychain: string
  - stacksPrivateKey: Buffer
  - walletConfig: undefined | WalletConfig
Returns Wallet

Properties

bitcoinPublicKeychain

bitcoinPublicKeychain: string

chain

chain: ChainID

configPrivateKey

configPrivateKey: string

encryptedBackupPhrase

encryptedBackupPhrase: string

firstBitcoinAddress

firstBitcoinAddress: string

identities

identities: Identity[]

identityAddresses

identityAddresses: string[]

identityKeypairs

identityKeypairs: IdentityKeyPair[]

identityPublicKeychain

identityPublicKeychain: string

stacksPrivateKey

stacksPrivateKey: Buffer

Optional walletConfig

walletConfig: WalletConfig

Methods

createGaiaConfig

createGaiaConfig(gaiaHubUrl: string): Promise<GaiaHubConfig>

- Defined in packages/keychain/src/wallet/index.ts:223
Parameters
- gaiaHubUrl: string
Returns Promise<GaiaHubConfig>

createNewIdentity

createNewIdentity(password: string): Promise<Identity>

- Defined in packages/keychain/src/wallet/index.ts:211
Parameters
- password: string
Returns Promise<Identity>

fetchConfig

fetchConfig(gaiaConfig: GaiaHubConfig): Promise<WalletConfig | null>

- Defined in packages/keychain/src/wallet/index.ts:227
Parameters
- gaiaConfig: GaiaHubConfig
Returns Promise<WalletConfig | null>

getOrCreateConfig

getOrCreateConfig(__namedParameters: { gaiaConfig: GaiaHubConfig; skipUpload: undefined | false | true }): Promise<WalletConfig>

- Defined in packages/keychain/src/wallet/index.ts:244
Parameters
- __namedParameters: { gaiaConfig: GaiaHubConfig; skipUpload: undefined | false | true }
  - gaiaConfig: GaiaHubConfig
  - skipUpload: undefined | false | true
Returns Promise<WalletConfig>

getSigner

getSigner(): WalletSigner

- Defined in packages/keychain/src/wallet/index.ts:322
Returns WalletSigner

restoreIdentities

restoreIdentities(__namedParameters: { gaiaReadURL: string; rootNode: BIP32Interface }): Promise<this>

- Defined in packages/keychain/src/wallet/index.ts:177
Restore all previously used identities. This is meant to be used when 'restoring' a wallet. First, it will check for a walletConfig. If present, then we use that to determine how many identities to generate, and auto-populate their username.

If walletConfig is empty, then this is being restored from an authenticator that doesn't support walletConfig. In that case, we will recursively generate identities, and check for on-chain names.

Parameters
- __namedParameters: { gaiaReadURL: string; rootNode: BIP32Interface }
  - gaiaReadURL: string
  - rootNode: BIP32Interface
Returns Promise<this>

updateConfig

updateConfig(gaiaConfig: GaiaHubConfig): Promise<void>

- Defined in packages/keychain/src/wallet/index.ts:272
Parameters
- gaiaConfig: GaiaHubConfig
Returns Promise<void>

updateConfigForReuseWarning

updateConfigForReuseWarning(__namedParameters: { gaiaConfig: GaiaHubConfig }): Promise<void>

- Defined in packages/keychain/src/wallet/index.ts:314
Parameters
- __namedParameters: { gaiaConfig: GaiaHubConfig }
  - gaiaConfig: GaiaHubConfig
Returns Promise<void>

updateConfigWithAuth

updateConfigWithAuth(__namedParameters: { app: ConfigApp; gaiaConfig: GaiaHubConfig; identityIndex: number }): Promise<void>

- Defined in packages/keychain/src/wallet/index.ts:278
Parameters
- __namedParameters: { app: ConfigApp; gaiaConfig: GaiaHubConfig; identityIndex: number }
  - app: ConfigApp
  - gaiaConfig: GaiaHubConfig
  - identityIndex: number
Returns Promise<void>

Static createAccount

createAccount(__namedParameters: { chain: ChainID; encryptedBackupPhrase: string; identitiesToGenerate: number; rootNode: BIP32Interface }): Promise<Wallet>

- Defined in packages/keychain/src/wallet/index.ts:138
Parameters
- __namedParameters: { chain: ChainID; encryptedBackupPhrase: string; identitiesToGenerate: number; rootNode: BIP32Interface }
  - chain: ChainID
  - encryptedBackupPhrase: string
  - identitiesToGenerate: number
  - rootNode: BIP32Interface
Returns Promise<Wallet>

Static generate

generate(password: string, chain: ChainID): Promise<Wallet>

- Defined in packages/keychain/src/wallet/index.ts:117
Parameters
- password: string
- chain: ChainID
Returns Promise<Wallet>

Static generateFactory

generateFactory(bitsEntropy: AllowedKeyEntropyBits): (Anonymous function)

- Defined in packages/keychain/src/wallet/index.ts:103
Parameters
- bitsEntropy: AllowedKeyEntropyBits
Returns (Anonymous function)

Static generateStrong

generateStrong(password: string, chain: ChainID): Promise<Wallet>

- Defined in packages/keychain/src/wallet/index.ts:121
Parameters
- password: string
- chain: ChainID
Returns Promise<Wallet>

Static restore

restore(password: string, seedPhrase: string, chain: ChainID): Promise<Wallet>

- Defined in packages/keychain/src/wallet/index.ts:125
Parameters
- password: string
- seedPhrase: string
- chain: ChainID
Returns Promise<Wallet>

Generated using TypeDoc