Class WalletHandler

traits

asymmetricDecrypt

• asymmetricDecrypt(toDecrypt): Buffer

• Decrypt value using signing WalletHandler instance private key. Half of an asymmetric keypair.

  Parameters

  • toDecrypt: string

    Value to decrypt.

  Returns Buffer

  • Decrypted value.

asymmetricEncrypt

• asymmetricEncrypt(toEncrypt, pubKey): string

• Encrypt value using public key from either findPubKey() or getPubkey(). Half of an asymmetric keypair.

  Parameters

  • toEncrypt: Buffer

    Value to encrypt.

  • pubKey: string

    Public key as hex value.

  Returns string

  • Encrypted value.

convertToFullWallet

• convertToFullWallet(config, session): Promise<void>

• Converts query-only WalletHandler instance to signing instance.

  Parameters

  • config: IWalletConfig

    Requires same object as trackWallet().

  • session: IMnemonicWallet

    IMnemonicWallet instance.

  Returns Promise<void>

findPubKey

• findPubKey(address): Promise<string>

• Retrieve asymmetric keypair public key from chain for specified jkl address.

  Parameters

  • address: string

    Jkl address to check.

  Returns Promise<string>

  • Target address' public key as hex value.

getAccounts

• getAccounts(): Promise<readonly AccountData[]>

• Expose signing WalletHandler instance Signer accounts.

  Returns Promise<readonly AccountData[]>

getAllBalances

• getAllBalances(): Promise<ICoin[]>

• Retrieve all signing WalletHandler instance tokens and balances for all supported chains.

  Returns Promise<ICoin[]>

  • All tokens and balances held by Signer.

getHexJackalAddress

• getHexJackalAddress(): Promise<string>

• Expose signing WalletHandler instance jkl address' hex value.

  Returns Promise<string>

  • Hashed and hexed jkl address.

getJackalAddress

• getJackalAddress(): string

• Expose signing WalletHandler instance jkl address.

  Returns string

  • Jkl address.

getJackalBalance

• getJackalBalance(): Promise<ICoin>

• Retrieve balance of $JKL in ujkl for signing WalletHandler instance.

  Returns Promise<ICoin>

  • Balance in ujkl.

getProtoHandler

• getProtoHandler(): IProtoHandler

• Expose signing WalletHandler instance ProtoHandler instance.

  Returns IProtoHandler

getPubkey

• getPubkey(): string

• Expose signing WalletHandler instance public key as hex value.

  Returns string

  • Public key as hex value.

getQueryHandler

• getQueryHandler(): IQueryHandler

• Expose query or signing WalletHandler instance QueryHandler instance.

  Returns IQueryHandler

getRnsInitStatus

• getRnsInitStatus(): boolean

• Check user's RNS initialization status.

  Returns boolean

  • Indicates if user's RNS has been initialized.

getSigner

• getSigner(): OfflineSigner

• Expose signing WalletHandler instance Signer.

  Returns OfflineSigner

getStorageInitStatus

• getStorageInitStatus(): boolean

• Check user's Storage initialization status.

  Returns boolean

  • Indicates if user's Storage has been initialized.

makeAbciHandler

• makeAbciHandler(): Promise<IAbciHandler>

• Create AbciHandler instance and link to query or signing WalletHandler instance.

  Returns Promise<IAbciHandler>

makeFileIoHandler

• makeFileIoHandler(versionFilter?): Promise<null | IFileIo>

• Create FileIo instance and link to signing WalletHandler instance.

  Parameters

  • Optional versionFilter: string | string[]

  Returns Promise<null | IFileIo>

  • Query WalletHandler instance returns null instead.

makeGovHandler

• makeGovHandler(): Promise<IGovHandler>

• Create GovHandler instance and link to query or signing WalletHandler instance.

  Returns Promise<IGovHandler>

makeNotificationHandler

• makeNotificationHandler(): Promise<INotificationHandler>

• Create NotificationHandler instance and link to query or signing WalletHandler instance.

  Returns Promise<INotificationHandler>

makeOracleHandler

• makeOracleHandler(): Promise<IOracleHandler>

• Create OracleHandler instance and link to query or signing WalletHandler instance.

  Returns Promise<IOracleHandler>

makeRnsHandler

• makeRnsHandler(): Promise<IRnsHandler>

• Create RnsHandler instance and link to query or signing WalletHandler instance.

  Returns Promise<IRnsHandler>

makeStorageHandler

• makeStorageHandler(): Promise<IStorageHandler>

• Create StorageHandler instance and link to query or signing WalletHandler instance.

  Returns Promise<IStorageHandler>

setRnsInitStatus

• setRnsInitStatus(status): void

• Save a RNS initialization status to the signing WalletHandler instance.

  Parameters

  • status: boolean

    RNS initialization status.

  Returns void

setStorageInitStatus

• setStorageInitStatus(status): void

• Save a Storage initialization status to the signing WalletHandler instance.

  Parameters

  • status: boolean

    Storage initialization status.

  Returns void

voidFullWallet

• voidFullWallet(): void

• Converts signing WalletHandler instance to query-only instance.

  Returns void

Static getAbitraryMerkle

• getAbitraryMerkle(path, item): Promise<string>

• Merkle items together, intended for arbitrary paths.

  Parameters

  • path: string

    Path to merkle.

  • item: string

    Target to merkle.

  Returns Promise<string>

  • Merkled result.

Static trackQueryWallet

• trackQueryWallet(queryUrl?): Promise<IWalletHandler>

• Creates query WalletHandler vs signing wallet from trackWallet().

  Parameters

  • Optional queryUrl: string

    URL to query api node.

  Returns Promise<IWalletHandler>

  • Query-only WalletHandler.

Static trackWallet

• trackWallet(config, session): Promise<IWalletHandler>

• Creates full WalletHandler vs query-only from trackQueryWallet().

  Parameters

  • config: IWalletConfig

    Config items needed to create a signing WalletHandler.

  • session: IMnemonicWallet

    IMnemonicWallet instance.

  Returns Promise<IWalletHandler>

  • Signing WalletHandler.