Class Wallet

Hierarchy

Wallet

Constructors

constructor

new Wallet(__namedParameters: ConstructorOptions): Wallet

- Defined in packages/keychain/src/wallet/index.ts:76
Parameters
- __namedParameters: ConstructorOptions
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:224
Parameters
- gaiaHubUrl: string
Returns Promise<GaiaHubConfig>

createNewIdentity

createNewIdentity(password: string): Promise<Identity>

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

fetchConfig

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

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

getOrCreateConfig

getOrCreateConfig(__namedParameters: { gaiaConfig: GaiaHubConfig; skipUpload?: boolean }): Promise<WalletConfig>

- Defined in packages/keychain/src/wallet/index.ts:245
Parameters
- __namedParameters: { gaiaConfig: GaiaHubConfig; skipUpload?: boolean }
  - gaiaConfig: GaiaHubConfig
  - Optional skipUpload?: boolean
Returns Promise<WalletConfig>

getSigner

getSigner(): WalletSigner

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

restoreIdentities

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

- Defined in packages/keychain/src/wallet/index.ts:178
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<Wallet>

updateConfig

updateConfig(gaiaConfig: GaiaHubConfig): Promise<void>

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

updateConfigForReuseWarning

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

- Defined in packages/keychain/src/wallet/index.ts:315
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:279
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:139
Parameters
- __namedParameters: { chain: ChainID; encryptedBackupPhrase: string; identitiesToGenerate?: number; rootNode: BIP32Interface }
  - chain: ChainID
  - encryptedBackupPhrase: string
  - Optional identitiesToGenerate?: number
  - rootNode: BIP32Interface
Returns Promise<Wallet>

Static generate

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

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

Static generateFactory

generateFactory(bitsEntropy: AllowedKeyEntropyBits): (password: string, chain: ChainID) => Promise<Wallet>

- Defined in packages/keychain/src/wallet/index.ts:104
Parameters
- bitsEntropy: AllowedKeyEntropyBits
Returns (password: string, chain: ChainID) => Promise<Wallet>
- - (password: string, chain: ChainID): Promise<Wallet>
  - Parameters
    - password: string
    - chain: ChainID
    Returns Promise<Wallet>

Static generateStrong

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

- Defined in packages/keychain/src/wallet/index.ts:122
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:126
Parameters
- password: string
- seedPhrase: string
- chain: ChainID
Returns Promise<Wallet>

Generated using TypeDoc