Skip to main content
zephyr-ts

TypeScript wallet library for Zephyr, a lateo project

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.

NameKindReference
ZephyrWalletclassZephyrWallet
ZephyrWalletErrorclassZephyrWalletError
createRandomWalletfunctioncreateRandomWallet
restoreWalletFromSeedfunctionrestoreWalletFromSeed
restoreWalletFromKeysfunctionrestoreWalletFromKeys
createKeysWalletfunctioncreateKeysWallet
openWalletDatafunctionopenWalletData
validateAddressfunctionvalidateAddress
setWorkerDistPathfunctionsetWorkerDistPath
setWasmModuleUrlfunctionsetWasmModuleUrl
terminateWorkerfunctionterminateWorker
ZephyrNetworkTypeInputtypeZephyrNetworkTypeInput
ZephyrWalletDatatypeZephyrWalletData
ZephyrWalletConstructionOptionstypeZephyrWalletConstructionOptions
ZephyrDaemonConnectiontypeZephyrDaemonConnection
ZephyrWalletSyncResulttypeZephyrWalletSyncResult
ZephyrAssetBalancestypeZephyrAssetBalances
ZephyrAccountBalancestypeZephyrAccountBalances
ZephyrAccounttypeZephyrAccount
ZephyrSubaddresstypeZephyrSubaddress
ZephyrAddressIndextypeZephyrAddressIndex
ZephyrAccountOptionstypeZephyrAccountOptions
ZephyrWalletTxtypeZephyrWalletTx
ZephyrWalletTransfertypeZephyrWalletTransfer
ZephyrTransferDestinationtypeZephyrTransferDestination
ZephyrTxConversiontypeZephyrTxConversion
ZephyrHistoryQuerytypeZephyrHistoryQuery
ZephyrTransferDirectiontypeZephyrTransferDirection
ZephyrHistoryStatustypeZephyrHistoryStatus
ZephyrTxPrioritytypeZephyrTxPriority
ZephyrTransferDestinationInputtypeZephyrTransferDestinationInput
ZephyrTransferConfigtypeZephyrTransferConfig
ZephyrBuiltTxtypeZephyrBuiltTx
ZephyrTransferBuildtypeZephyrTransferBuild
ZephyrConversionDestinationInputtypeZephyrConversionDestinationInput
ZephyrConversionConfigtypeZephyrConversionConfig
ZephyrConversionBuildtypeZephyrConversionBuild
ZephyrPreparedTransfertypeZephyrPreparedTransfer
ZephyrPreparedConversiontypeZephyrPreparedConversion
ZephyrRelayOutcometypeZephyrRelayOutcome
ZephyrRelayedTxtypeZephyrRelayedTx
ZephyrRelayResulttypeZephyrRelayResult
ZephyrWalletErrorCodetypeZephyrWalletErrorCode
ZephyrWalletErrorDiagnostictypeZephyrWalletErrorDiagnostic

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.