API reference
Every name the package @loki-notfound/zephyr-ts exports, version 2.3.0-sec.2-ts.1, written from the package entry (src/main/ts/index.ts) and the declarations it ships (dist/src/main/ts/index.d.ts and the files it re-exports). The signatures are copied from those declarations, and bin/check_guide.sh checks that each one appears there and that this list matches the exports.
- Functions: the construction functions and the utilities.
- ZephyrWallet: the wallet class, every property and method.
- Types: configurations, results and their parts.
- Errors:
ZephyrWalletError, its codes and its diagnostics.
The package has named exports only. Types are exported with export type and exist at compile time only.
| Name | Kind | Reference |
|---|---|---|
ZephyrWallet | class | ZephyrWallet |
ZephyrWalletError | class | ZephyrWalletError |
createRandomWallet | function | createRandomWallet |
restoreWalletFromSeed | function | restoreWalletFromSeed |
restoreWalletFromKeys | function | restoreWalletFromKeys |
createKeysWallet | function | createKeysWallet |
openWalletData | function | openWalletData |
validateAddress | function | validateAddress |
setWorkerDistPath | function | setWorkerDistPath |
setWasmModuleUrl | function | setWasmModuleUrl |
terminateWorker | function | terminateWorker |
ZephyrNetworkTypeInput | type | ZephyrNetworkTypeInput |
ZephyrWalletData | type | ZephyrWalletData |
ZephyrWalletConstructionOptions | type | ZephyrWalletConstructionOptions |
ZephyrDaemonConnection | type | ZephyrDaemonConnection |
ZephyrWalletSyncResult | type | ZephyrWalletSyncResult |
ZephyrAssetBalances | type | ZephyrAssetBalances |
ZephyrAccountBalances | type | ZephyrAccountBalances |
ZephyrAccount | type | ZephyrAccount |
ZephyrSubaddress | type | ZephyrSubaddress |
ZephyrAddressIndex | type | ZephyrAddressIndex |
ZephyrAccountOptions | type | ZephyrAccountOptions |
ZephyrWalletTx | type | ZephyrWalletTx |
ZephyrWalletTransfer | type | ZephyrWalletTransfer |
ZephyrTransferDestination | type | ZephyrTransferDestination |
ZephyrTxConversion | type | ZephyrTxConversion |
ZephyrHistoryQuery | type | ZephyrHistoryQuery |
ZephyrTransferDirection | type | ZephyrTransferDirection |
ZephyrHistoryStatus | type | ZephyrHistoryStatus |
ZephyrTxPriority | type | ZephyrTxPriority |
ZephyrTransferDestinationInput | type | ZephyrTransferDestinationInput |
ZephyrTransferConfig | type | ZephyrTransferConfig |
ZephyrBuiltTx | type | ZephyrBuiltTx |
ZephyrTransferBuild | type | ZephyrTransferBuild |
ZephyrConversionDestinationInput | type | ZephyrConversionDestinationInput |
ZephyrConversionConfig | type | ZephyrConversionConfig |
ZephyrConversionBuild | type | ZephyrConversionBuild |
ZephyrPreparedTransfer | type | ZephyrPreparedTransfer |
ZephyrPreparedConversion | type | ZephyrPreparedConversion |
ZephyrRelayOutcome | type | ZephyrRelayOutcome |
ZephyrRelayedTx | type | ZephyrRelayedTx |
ZephyrRelayResult | type | ZephyrRelayResult |
ZephyrWalletErrorCode | type | ZephyrWalletErrorCode |
ZephyrWalletErrorDiagnostic | type | ZephyrWalletErrorDiagnostic |
The declarations also contain names that the entry does not export, such as createWallet and getNetworkGuardReport in the wallet module; they serve the repository's tests and are not part of the package's surface.