Class WalletConnect

constructor

• new WalletConnect(
      signClient: SignClient,
      WalletConnectModal: WalletConnectModal,
  ): WalletConnect

  Parameters

  • signClient: SignClient
  • WalletConnectModal: WalletConnectModal

  Returns WalletConnect

signClient

configureWithExistingSessionKey

• configureWithExistingSessionKey(key: string): void

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

  Parameters

  • key: string

  Returns void

  Throws

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

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

getAccounts

• getAccounts(): string[]

  Return all connected accounts from the active session *

  Returns string[]

  Throws

  NotConnected if no active session

getActiveNetwork

• getActiveNetwork(): string

  Access the active network *

  Returns string

  Throws

  ActiveNetworkUnspecified thorwn when there are multiple Tezos netwroks in the session and none is set as the active one

getAllExistingSessionKeys

• getAllExistingSessionKeys(): string[]

  Access all existing sessions

  Returns string[]

  an array of strings which represent the session keys

getAvailablePairing

• getAvailablePairing(): Struct[]

  Access all existing active pairings

  Returns Struct[]

getNetworks

• getNetworks(): string[]

  Return all networks from the namespace of the active session *

  Returns string[]

  Throws

  NotConnected if no active session

getPeerMetadata

• getPeerMetadata(): Metadata

  Returns Metadata

getPK

• getPK(): Promise<string>

  Access the public key of the active account *

  Returns Promise<string>

  Throws

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

  Throws

  MissingRequiredScope is thrown if permission to get accounts was not granted *

  Throws

  PublicKeyRetrievalError is thrown if the public key is not found

getPKH

• getPKH(): Promise<string>

  Access the public key hash of the active account *

  Returns Promise<string>

  Throws

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

getSession

• getSession(): Struct

  Returns Struct

isActiveSession

• isActiveSession(): boolean

  Returns boolean

mapDelegateParamsToWalletParams

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

  Transform WalletDelegateParams into a format compliant with the underlying wallet

  Parameters

  • params: () => Promise<WalletDelegateParams>

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

mapFinalizeUnstakeParamsToWalletParams

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

  Transform WalletFinalizeUnstakeParams into a format compliant with the underlying wallet

  Parameters

  • params: () => Promise<WalletFinalizeUnstakeParams>

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

mapIncreasePaidStorageWalletParams

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

  Transform WalletIncreasePaidStorageParams into a format compliant with the underlying wallet

  Parameters

  • params: () => Promise<WalletIncreasePaidStorageParams>

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

mapOriginateParamsToWalletParams

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

  Transform WalletOriginateParams into a format compliant with the underlying wallet

  Parameters

  • params: () => Promise<WalletOriginateParams>

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

mapRegisterGlobalConstantParamsToWalletParams

• mapRegisterGlobalConstantParamsToWalletParams(
      params: () => Promise<WalletRegisterGlobalConstantParams>,
  ): Promise<
      | Partial<RPCTransferOperation>
      | Partial<RPCTransferTicketOperation>
      | Partial<RPCOriginationOperation>
      | Partial<RPCDelegateOperation>
      | Partial<RPCIncreasePaidStorageOperation>
      | Partial<RPCRegisterGlobalConstantOperation>,
  >

  Transform WalletRegisterGlobalConstantParams into a format compliant with the underlying wallet

  Parameters

  • params: () => Promise<WalletRegisterGlobalConstantParams>

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

mapStakeParamsToWalletParams

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

  Transform WalletStakeParams into a format compliant with the underlying wallet

  Parameters

  • params: () => Promise<WalletStakeParams>

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

mapTransferParamsToWalletParams

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

  Transform WalletTransferParams into a format compliant with the underlying wallet

  Parameters

  • params: () => Promise<WalletTransferParams>

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

mapTransferTicketParamsToWalletParams

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

  Transform WalletTransferTicketParams into a format compliant with the underlying wallet

  Parameters

  • params: () => Promise<WalletTransferTicketParams>

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

mapUnstakeParamsToWalletParams

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

  Transform WalletUnstakeParams into a format compliant with the underlying wallet

  Parameters

  • params: () => Promise<WalletUnstakeParams>

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

ping

• ping(): void

  Returns void

requestPermissions

• requestPermissions(
      connectParams: {
          pairingTopic?: string;
          permissionScope: PermissionScopeParam;
          registryUrl?: string;
      },
  ): Promise<void>

  Request permission for a new session and establish a connection.

  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>

  Throws

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

sendOperations

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

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

  Parameters

  • params: OperationParams[]

  Returns Promise<string>

  Throws

  MissingRequiredScope is thrown if permission to send operation was not granted

setActiveAccount

• setActiveAccount(pkh: string): void

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

  Parameters

  • pkh: string

    public key hash of the selected account *

  Returns void

  Throws

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

setActiveNetwork

• setActiveNetwork(network: NetworkType): void

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

  Parameters

  • network: NetworkType

    selected network *

  Returns void

  Throws

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

sign

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

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

  Parameters

  • bytes: string
  • Optionalwatermark: Uint8Array<ArrayBufferLike>

  Returns Promise<string>

  Throws

  MissingRequiredScope is thrown if permission to sign payload was not granted

Staticinit

• init(initParams: Options): Promise<WalletConnect>

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

  Parameters

  • initParams: Options

  Returns Promise<WalletConnect>

  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",
   },
  });
  Copy