Interface: ApplicationApi
Defined in: api/index.ts:16
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
application | object | - | api/index.ts:17 |
application.addSeed | (opts) => Promise<string> | Adds an extra seed to the wallet. Remarks After the new seed is added, the application starts the restore process. Example await exodus.application.addSeed({ mnemonic: 'myMnemonic', compatibilityMode: 'metamask' }) | api/index.ts:172 |
application.changeLockTimer | (opts) => Promise<void> | Changes the auto lock timer TTL (time to live). Remarks This is used as part of the auto unlock functionality, the wallet will be considered locked after the timer expires. Example await exodus.application.changeLockTimer({ lockTimer: 1000 }) | api/index.ts:148 |
application.changePassphrase | (opts) => Promise<void> | Changes the passphrase of the wallet. Example await exodus.application.changePassphrase({ currentPassphrase: 'myCurrentPassphrase', newPassphrase: 'myNewPassphrase' }) | api/index.ts:136 |
application.create | (opts?) => Promise<void> | Creates a new wallet. Example await exodus.application.create() | api/index.ts:61 |
application.delete | (opts) => Promise<void> | Schedules a deletion of the current imported wallet, then restarts the application. Example await exodus.application.delete({ forgotPassphrase: true }) | api/index.ts:102 |
application.getMnemonic | (opts) => Promise<string> | Retrieves the current wallet mnemonic. Deprecated - use wallet.getMnemonicinstead See [Wallet.getMnemonic](https://github.com/ExodusMovement/exodus-hydra/blob/d5ff6266ce9eb752533df52996d05a7c0bed1cee/features/wallet/module/wallet.js#L239-L248 ) Remarks The wallet mnemonic contains a series of words that can be used to restore the wallet. It should be trated as very sensitive data. Example const mnemonic = await exodus.application.getMnemonic() | api/index.ts:117 |
application.import | (opts) => Promise<void> | Imports an existing wallet. Example “ Params opts - An object containing the mnemonic and passphrase, along with a set of optional flags. await exodus.application.import({ mnemonic: 'myMnemonic', passphrase: 'myPassphrase' }) | api/index.ts:93 |
application.load | () => Promise<void> | Loads the application. Example await exodus.application.load() | api/index.ts:43 |
application.lock | () => Promise<void> | Locks the wallet. Example await exodus.application.lock() | api/index.ts:70 |
application.removeSeed | (seedId) => Promise<void> | Removes a seed by its id. Example await exodus.application.removeSeed('seedId') | api/index.ts:182 |
application.restartAutoLockTimer | () => Promise<void> | Changess the auto lock timer. Remarks This is used as part of the auto unlock functionality, the wallet will be considered locked after the timer expires. Example await exodus.application.restartAutoLockTimer() | api/index.ts:160 |
application.restoreFromCurrentPhrase | (params?) => Promise<void> | Restores the wallet from the current phrase. Remarks This is useful when you need to trigger a restore for the existing primary seed, without adding it back again. In practical terms, it triggers an import event without adding the seed back. Example await exodus.application.restoreFromCurrentPhrase() // will use the passphrase cache | api/index.ts:196 |
application.setBackedUp | () => Promise<void> | Set a flag indicating that the wallet has been backed up. Example await exodus.application.setBackedUp() | api/index.ts:126 |
application.start | (__namedParameters) => Promise<void> | Kicks off the application lifecycle. Example await exodus.application.start() | api/index.ts:25 |
application.stop | () => Promise<void> | Attempts to gracefully shut down all application features. Example await exodus.application.stop() | api/index.ts:34 |
application.unload | () => Promise<void> | Unloads the application Example await exodus.application.unload() | api/index.ts:52 |
application.unlock | (opts?) => Promise<void> | Unlocks the wallet. Remarks After the wallet is unlocked, any pending migrations are executed. Example `await exodus.application.unlock({ passphrase: ‘myPassphrase’ })“ | api/index.ts:82 |