Class WalletConnect

Description

The WalletConnect class implements the WalletProvider interface, providing an alternative to BeaconWallet. This package enables dapps built with Taquito to connect to wallets via the WalletConnect/Reown protocol.

Note

Currently, a QR code is displayed to establish a connection with a wallet. As more Tezos wallets integrate with WalletConnect, we plan showing a list of available wallets alongside the QR code.

Implements

  • WalletProvider

Constructors

constructor

Properties

signClient

Methods

configureWithExistingSessionKey disconnect getAccounts getActiveNetwork getAllExistingSessionKeys getAvailablePairing getNetworks getPK getPKH getPeerMetadata getSession isActiveSession mapDelegateParamsToWalletParams mapFinalizeUnstakeParamsToWalletParams mapIncreasePaidStorageWalletParams mapOriginateParamsToWalletParams mapStakeParamsToWalletParams mapTransferParamsToWalletParams mapTransferTicketParamsToWalletParams mapUnstakeParamsToWalletParams ping requestPermissions sendOperations setActiveAccount setActiveNetwork sign init

Constructors

constructor

Properties

signClient

signClient: SignClient

Methods

configureWithExistingSessionKey

  • configureWithExistingSessionKey(key): void

  • Parameters

    • key: string

    Returns void

    Description

    Configure the Client with an existing session. The session is immediately restored without a prompt on the wallet to accept/decline it.

    Error

    InvalidSessionKey is thrown if the provided session key doesn't exist

disconnect

getAccounts

getActiveNetwork

getAllExistingSessionKeys

getAvailablePairing

getNetworks

getPK

  • getPK(): Promise<string>

  • Returns Promise<string>

    Description

    Access the public key of the active account

    Error

    ActiveAccountUnspecified thrown when there are multiple Tezos account in the session and none is set as the active one

    Error

    MissingRequiredScope is thrown if permission to get accounts was not granted

    Error

    PublicKeyRetrievalError is thrown if the public key is not found

getPKH

  • getPKH(): Promise<string>

  • Returns Promise<string>

    Description

    Access the public key hash of the active account

    Error

    ActiveAccountUnspecified thrown when there are multiple Tezos account in the session and none is set as the active one

getPeerMetadata

getSession

isActiveSession

mapDelegateParamsToWalletParams

  • mapDelegateParamsToWalletParams(params): Promise<
        | Partial<RPCTransferOperation>
        | Partial<RPCTransferTicketOperation>
        | Partial<RPCOriginationOperation>
        | Partial<RPCDelegateOperation>
        | Partial<RPCIncreasePaidStorageOperation>>

  • Parameters

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

        • Returns Promise<WalletDelegateParams>

    Returns Promise<
        | Partial<RPCTransferOperation>
        | Partial<RPCTransferTicketOperation>
        | Partial<RPCOriginationOperation>
        | Partial<RPCDelegateOperation>
        | Partial<RPCIncreasePaidStorageOperation>>

    Description

    Transform WalletDelegateParams into a format compliant with the underlying wallet

mapFinalizeUnstakeParamsToWalletParams

  • mapFinalizeUnstakeParamsToWalletParams(params): Promise<
        | Partial<RPCTransferOperation>
        | Partial<RPCTransferTicketOperation>
        | Partial<RPCOriginationOperation>
        | Partial<RPCDelegateOperation>
        | Partial<RPCIncreasePaidStorageOperation>>

  • Parameters

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

        • Returns Promise<WalletFinalizeUnstakeParams>

    Returns Promise<
        | Partial<RPCTransferOperation>
        | Partial<RPCTransferTicketOperation>
        | Partial<RPCOriginationOperation>
        | Partial<RPCDelegateOperation>
        | Partial<RPCIncreasePaidStorageOperation>>

    Description

    Transform WalletFinalizeUnstakeParams into a format compliant with the underlying wallet

mapIncreasePaidStorageWalletParams

  • mapIncreasePaidStorageWalletParams(params): Promise<
        | Partial<RPCTransferOperation>
        | Partial<RPCTransferTicketOperation>
        | Partial<RPCOriginationOperation>
        | Partial<RPCDelegateOperation>
        | Partial<RPCIncreasePaidStorageOperation>>

  • Parameters

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

        • Returns Promise<WalletIncreasePaidStorageParams>

    Returns Promise<
        | Partial<RPCTransferOperation>
        | Partial<RPCTransferTicketOperation>
        | Partial<RPCOriginationOperation>
        | Partial<RPCDelegateOperation>
        | Partial<RPCIncreasePaidStorageOperation>>

    Description

    Transform WalletIncreasePaidStorageParams into a format compliant with the underlying wallet

mapOriginateParamsToWalletParams

  • mapOriginateParamsToWalletParams(params): Promise<
        | Partial<RPCTransferOperation>
        | Partial<RPCTransferTicketOperation>
        | Partial<RPCOriginationOperation>
        | Partial<RPCDelegateOperation>
        | Partial<RPCIncreasePaidStorageOperation>>

  • Parameters

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

        • Returns Promise<WalletOriginateParams>

    Returns Promise<
        | Partial<RPCTransferOperation>
        | Partial<RPCTransferTicketOperation>
        | Partial<RPCOriginationOperation>
        | Partial<RPCDelegateOperation>
        | Partial<RPCIncreasePaidStorageOperation>>

    Description

    Transform WalletOriginateParams into a format compliant with the underlying wallet

mapStakeParamsToWalletParams

  • mapStakeParamsToWalletParams(params): Promise<
        | Partial<RPCTransferOperation>
        | Partial<RPCTransferTicketOperation>
        | Partial<RPCOriginationOperation>
        | Partial<RPCDelegateOperation>
        | Partial<RPCIncreasePaidStorageOperation>>

  • Parameters

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

        • Returns Promise<WalletStakeParams>

    Returns Promise<
        | Partial<RPCTransferOperation>
        | Partial<RPCTransferTicketOperation>
        | Partial<RPCOriginationOperation>
        | Partial<RPCDelegateOperation>
        | Partial<RPCIncreasePaidStorageOperation>>

    Description

    Transform WalletStakeParams into a format compliant with the underlying wallet

mapTransferParamsToWalletParams

  • mapTransferParamsToWalletParams(params): Promise<
        | Partial<RPCTransferOperation>
        | Partial<RPCTransferTicketOperation>
        | Partial<RPCOriginationOperation>
        | Partial<RPCDelegateOperation>
        | Partial<RPCIncreasePaidStorageOperation>>

  • Parameters

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

        • Returns Promise<WalletTransferParams>

    Returns Promise<
        | Partial<RPCTransferOperation>
        | Partial<RPCTransferTicketOperation>
        | Partial<RPCOriginationOperation>
        | Partial<RPCDelegateOperation>
        | Partial<RPCIncreasePaidStorageOperation>>

    Description

    Transform WalletTransferParams into a format compliant with the underlying wallet

mapTransferTicketParamsToWalletParams

  • mapTransferTicketParamsToWalletParams(params): Promise<
        | Partial<RPCTransferOperation>
        | Partial<RPCTransferTicketOperation>
        | Partial<RPCOriginationOperation>
        | Partial<RPCDelegateOperation>
        | Partial<RPCIncreasePaidStorageOperation>>

  • Parameters

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

        • Returns Promise<WalletTransferTicketParams>

    Returns Promise<
        | Partial<RPCTransferOperation>
        | Partial<RPCTransferTicketOperation>
        | Partial<RPCOriginationOperation>
        | Partial<RPCDelegateOperation>
        | Partial<RPCIncreasePaidStorageOperation>>

    Description

    Transform WalletTransferTicketParams into a format compliant with the underlying wallet

mapUnstakeParamsToWalletParams

  • mapUnstakeParamsToWalletParams(params): Promise<
        | Partial<RPCTransferOperation>
        | Partial<RPCTransferTicketOperation>
        | Partial<RPCOriginationOperation>
        | Partial<RPCDelegateOperation>
        | Partial<RPCIncreasePaidStorageOperation>>

  • Parameters

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

        • Returns Promise<WalletUnstakeParams>

    Returns Promise<
        | Partial<RPCTransferOperation>
        | Partial<RPCTransferTicketOperation>
        | Partial<RPCOriginationOperation>
        | Partial<RPCDelegateOperation>
        | Partial<RPCIncreasePaidStorageOperation>>

    Description

    Transform WalletUnstakeParams into a format compliant with the underlying wallet

ping

requestPermissions

  • requestPermissions(connectParams): Promise<void>

  • Parameters

    • connectParams: {
          pairingTopic?: string;
          permissionScope: PermissionScopeParam;
          registryUrl?: string;
      }
      • OptionalpairingTopic?: string

        Option to connect to an existing active pairing. If pairingTopic is defined, a prompt will appear in the corresponding wallet to accept or decline the session proposal. If no pairingTopic, a QR code modal will open in the dapp, allowing to connect to a wallet.

      • permissionScope: PermissionScopeParam

        The networks, methods, and events that will be granted permission

      • OptionalregistryUrl?: string

        Optional registry of wallet deep links to show in the Modal

    Returns Promise<void>

    Description

    Request permission for a new session and establish a connection.

    Error

    ConnectionFailed is thrown if no connection can be established with a wallet

sendOperations

  • sendOperations(params): Promise<string>

  • Parameters

    Returns Promise<string>

    Description

    Once the session is establish, send Tezos operations to be approved, signed and inject by the wallet.

    Error

    MissingRequiredScope is thrown if permission to send operation was not granted

setActiveAccount

  • setActiveAccount(pkh): void

  • Parameters

    • pkh: string

      public key hash of the selected account

    Returns void

    Description

    Set the active account. Must be called if there are multiple accounts in the session and every time the active account is switched

    Error

    InvalidAccount thrown if the pkh is not part of the active accounts in the session

setActiveNetwork

  • setActiveNetwork(network): void

  • Parameters

    Returns void

    Description

    Set the active network. Must be called if there are multiple network in the session and every time the active network is switched

    Error

    InvalidNetwork thrown if the network is not part of the active networks in the session

sign

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

  • Parameters

    • bytes: string
    • Optionalwatermark: Uint8Array

    Returns Promise<string>

    Description

    Once the session is establish, send payload to be signed by the wallet.

    Error

    MissingRequiredScope is thrown if permission to sign payload was not granted

Staticinit

  • init(initParams): Promise<WalletConnect>

  • Parameters

    • initParams: Options

    Returns Promise<WalletConnect>

    Description

    Initialize a WalletConnect provider (Initialize a WalletConnect client with persisted storage and a network connection)

    Example

    await WalletConnect.init({
     projectId: "YOUR_PROJECT_ID", // can get YOUR_PROJECT_ID from [Reown Cloud](https://cloud.reown.com)
     metadata: {
       name: "YOUR_DAPP_NAME",
       description: "YOUR_DAPP_DESCRIPTION",
       icons: ["ICON_URL"],
       url: "DAPP_URL",
     },
    });

Settings

Member Visibility

On This Page

Constructors
Properties
Methods