Class BeaconWallet

constructor

• new BeaconWallet(options: DAppClientOptions): BeaconWallet

  Parameters

  • options: DAppClientOptions

  Returns BeaconWallet

client

clearActiveAccount

• clearActiveAccount(): Promise<void>

  Clear the active account without destroying the Beacon session.

  This removes the active account reference from local storage but does not clear other Beacon state such as the cached relay node (beacon:matrix-selected-node) or peer data.

  Use this for switching between accounts within an active session. For a full logout that clears all Beacon storage, use disconnect instead.

  Returns Promise<void>

  See

  disconnect

disconnect

• disconnect(): Promise<void>

  Disconnect the wallet and clear the active Beacon session.

  This is the recommended way to end a user session (logout). It calls client.disconnect() under the hood, which notifies wallet peers, clears the active account, and tears down the active Beacon transports.

  After calling this method, the BeaconWallet instance can be used to reconnect through a new permission request.

  For switching accounts without a full logout, use clearActiveAccount instead.

  Returns Promise<void>

formatParameters

• formatParameters<T extends ParamsWithOptionalFees>(params: T): T

  Type Parameters

  • T extends ParamsWithOptionalFees

  Parameters

  • params: T

  Returns T

getPK

• getPK(): Promise<string>

  Request the public key from the wallet

  Returns Promise<string>

getPKH

• getPKH(): Promise<string>

  Request the public key hash from the wallet

  Returns Promise<string>

mapDelegateParamsToWalletParams

• mapDelegateParamsToWalletParams(
      params: () => Promise<WalletDelegateParams>,
  ): Promise<RPCOperationWithLimits>

  Transform WalletDelegateParams into a format compliant with the underlying wallet

  Parameters

  • params: () => Promise<WalletDelegateParams>

  Returns Promise<RPCOperationWithLimits>

mapFinalizeUnstakeParamsToWalletParams

• mapFinalizeUnstakeParamsToWalletParams(
      params: () => Promise<WalletFinalizeUnstakeParams>,
  ): Promise<RPCOperationWithLimits>

  Transform WalletFinalizeUnstakeParams into a format compliant with the underlying wallet

  Parameters

  • params: () => Promise<WalletFinalizeUnstakeParams>

  Returns Promise<RPCOperationWithLimits>

mapIncreasePaidStorageWalletParams

• mapIncreasePaidStorageWalletParams(
      params: () => Promise<WalletIncreasePaidStorageParams>,
  ): Promise<RPCOperationWithLimits>

  Transform WalletIncreasePaidStorageParams into a format compliant with the underlying wallet

  Parameters

  • params: () => Promise<WalletIncreasePaidStorageParams>

  Returns Promise<RPCOperationWithLimits>

mapOriginateParamsToWalletParams

• mapOriginateParamsToWalletParams(
      params: () => Promise<WalletOriginateParams>,
  ): Promise<RPCOperationWithLimits>

  Transform WalletOriginateParams into a format compliant with the underlying wallet

  Parameters

  • params: () => Promise<WalletOriginateParams>

  Returns Promise<RPCOperationWithLimits>

mapRegisterGlobalConstantParamsToWalletParams

• mapRegisterGlobalConstantParamsToWalletParams(
      params: () => Promise<WalletRegisterGlobalConstantParams>,
  ): Promise<RPCOperationWithLimits>

  Transform WalletRegisterGlobalConstantParams into a format compliant with the underlying wallet

  Parameters

  • params: () => Promise<WalletRegisterGlobalConstantParams>

  Returns Promise<RPCOperationWithLimits>

mapStakeParamsToWalletParams

• mapStakeParamsToWalletParams(
      params: () => Promise<WalletStakeParams>,
  ): Promise<RPCOperationWithLimits>

  Transform WalletStakeParams into a format compliant with the underlying wallet

  Parameters

  • params: () => Promise<WalletStakeParams>

  Returns Promise<RPCOperationWithLimits>

mapTransferParamsToWalletParams

• mapTransferParamsToWalletParams(
      params: () => Promise<WalletTransferParams>,
  ): Promise<RPCOperationWithLimits>

  Transform WalletTransferParams into a format compliant with the underlying wallet

  Parameters

  • params: () => Promise<WalletTransferParams>

  Returns Promise<RPCOperationWithLimits>

mapTransferTicketParamsToWalletParams

• mapTransferTicketParamsToWalletParams(
      params: () => Promise<WalletTransferTicketParams>,
  ): Promise<RPCOperationWithLimits>

  Transform WalletTransferTicketParams into a format compliant with the underlying wallet

  Parameters

  • params: () => Promise<WalletTransferTicketParams>

  Returns Promise<RPCOperationWithLimits>

mapUnstakeParamsToWalletParams

• mapUnstakeParamsToWalletParams(
      params: () => Promise<WalletUnstakeParams>,
  ): Promise<RPCOperationWithLimits>

  Transform WalletUnstakeParams into a format compliant with the underlying wallet

  Parameters

  • params: () => Promise<WalletUnstakeParams>

  Returns Promise<RPCOperationWithLimits>

removeDefaultParams

• removeDefaultParams(
      params:
          | WalletTransferParams
          | WalletStakeParams
          | WalletUnstakeParams
          | WalletFinalizeUnstakeParams
          | WalletOriginateParams
          | WalletDelegateParams
          | WalletRegisterGlobalConstantParams
          | WalletTransferTicketParams
          | WalletIncreasePaidStorageParams,
      operatedParams: RPCOperationWithLimits,
  ): RPCOperationWithLimits

  Parameters

  • params:
        | WalletTransferParams
        | WalletStakeParams
        | WalletUnstakeParams
        | WalletFinalizeUnstakeParams
        | WalletOriginateParams
        | WalletDelegateParams
        | WalletRegisterGlobalConstantParams
        | WalletTransferTicketParams
        | WalletIncreasePaidStorageParams
  • operatedParams: RPCOperationWithLimits

  Returns RPCOperationWithLimits

requestPermissions

• requestPermissions(request?: RequestPermissionInput): Promise<void>

  Parameters

  • Optionalrequest: RequestPermissionInput

  Returns Promise<void>

sendOperations

• sendOperations(params: any[]): Promise<string>

  Request the wallet to send an operation batch

  Parameters

  • params: any[]

  Returns Promise<string>

sign

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

  Request the wallet to sign a payload

  Parameters

  • bytes: string
  • Optionalwatermark: Uint8Array<ArrayBufferLike>

  Returns Promise<string>