Class BeaconWallet

constructor

• new BeaconWallet(options): BeaconWallet

• Parameters

  • options: DAppClientOptions

  Returns BeaconWallet

client

clearActiveAccount

• clearActiveAccount(): Promise<void>

• Returns Promise<void>

  Description

  This method removes the active account from local storage by setting it to undefined.

disconnect

• disconnect(): Promise<void>

• Returns Promise<void>

  Description

  Removes all beacon values from the storage. After using this method, this instance is no longer usable. You will have to instantiate a new BeaconWallet.

formatParameters

• formatParameters(params): any

• Parameters

  • params: any

  Returns any

getPK

• getPK(): Promise<string>

• Returns Promise<string>

  Description

  Get the public key from the wallet

getPKH

• getPKH(): Promise<string>

• Returns Promise<string>

  Description

  Request the public key hash from the wallet

mapDelegateParamsToWalletParams

• mapDelegateParamsToWalletParams(params): Promise<any>

• Parameters

  • params: (() => Promise<WalletDelegateParams>)
    • • (): Promise<WalletDelegateParams>

      • Returns Promise<WalletDelegateParams>

  Returns Promise<any>

  Description

  Transform WalletDelegateParams into a format compliant with the underlying wallet

mapFinalizeUnstakeParamsToWalletParams

• mapFinalizeUnstakeParamsToWalletParams(params): Promise<any>

• Parameters

  • params: (() => Promise<WalletFinalizeUnstakeParams>)
    • • (): Promise<WalletFinalizeUnstakeParams>

      • Returns Promise<WalletFinalizeUnstakeParams>

  Returns Promise<any>

  Description

  Transform WalletFinalizeUnstakeParams into a format compliant with the underlying wallet

mapIncreasePaidStorageWalletParams

• mapIncreasePaidStorageWalletParams(params): Promise<any>

• Parameters

  • params: (() => Promise<WalletIncreasePaidStorageParams>)
    • • (): Promise<WalletIncreasePaidStorageParams>

      • Returns Promise<WalletIncreasePaidStorageParams>

  Returns Promise<any>

  Description

  Transform WalletIncreasePaidStorageParams into a format compliant with the underlying wallet

mapOriginateParamsToWalletParams

• mapOriginateParamsToWalletParams(params): Promise<any>

• Parameters

  • params: (() => Promise<WalletOriginateParams>)
    • • (): Promise<WalletOriginateParams>

      • Returns Promise<WalletOriginateParams>

  Returns Promise<any>

  Description

  Transform WalletOriginateParams into a format compliant with the underlying wallet

mapStakeParamsToWalletParams

• mapStakeParamsToWalletParams(params): Promise<any>

• Parameters

  • params: (() => Promise<WalletStakeParams>)
    • • (): Promise<WalletStakeParams>

      • Returns Promise<WalletStakeParams>

  Returns Promise<any>

  Description

  Transform WalletStakeParams into a format compliant with the underlying wallet

mapTransferParamsToWalletParams

• mapTransferParamsToWalletParams(params): Promise<any>

• Parameters

  • params: (() => Promise<WalletTransferParams>)
    • • (): Promise<WalletTransferParams>

      • Returns Promise<WalletTransferParams>

  Returns Promise<any>

  Description

  Transform WalletTransferParams into a format compliant with the underlying wallet

mapTransferTicketParamsToWalletParams

• mapTransferTicketParamsToWalletParams(params): Promise<any>

• Parameters

  • params: (() => Promise<WalletTransferTicketParams>)
    • • (): Promise<WalletTransferTicketParams>

      • Returns Promise<WalletTransferTicketParams>

  Returns Promise<any>

  Description

  Transform WalletTransferTicketParams into a format compliant with the underlying wallet

mapUnstakeParamsToWalletParams

• mapUnstakeParamsToWalletParams(params): Promise<any>

• Parameters

  • params: (() => Promise<WalletUnstakeParams>)
    • • (): Promise<WalletUnstakeParams>

      • Returns Promise<WalletUnstakeParams>

  Returns Promise<any>

  Description

  Transform WalletUnstakeParams into a format compliant with the underlying wallet

removeDefaultParams

• removeDefaultParams(params, operatedParams): any

• Parameters

  • params:
        | WalletTransferParams
        | WalletStakeParams
        | WalletUnstakeParams
        | WalletFinalizeUnstakeParams
        | WalletOriginateParams
        | WalletDelegateParams
  • operatedParams: any

  Returns any

requestPermissions

• requestPermissions(request?): Promise<void>

• Parameters

  • Optionalrequest: RequestPermissionInput

  Returns Promise<void>

sendOperations

• sendOperations(params): Promise<string>

• Parameters

  • params: any[]

  Returns Promise<string>

  Description

  Request the wallet to send an operation batch

sign

• sign(bytes, watermark?): Promise<string>

• Parameters

  • bytes: string
  • Optionalwatermark: Uint8Array

  Returns Promise<string>

  Description

  Request the wallet to sign a payload