@taquito/wallet-connect 20.2.0-beta.0

package/dist/taquito-wallet-connect.umd.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"taquito-wallet-connect.umd.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/types/errors.d.ts

@@ -0,0 +1,103 @@
+import { PermissionScopeMethods } from './types';
+/**
+ *  @category Error
+ *  @description Error that indicates missing required permission scopes
+ */
+export declare class MissingRequiredScope extends Error {
+    requiredScopes: PermissionScopeMethods | string;
+    name: string;
+    constructor(requiredScopes: PermissionScopeMethods | string);
+}
+/**
+ *  @category Error
+ *  @description Error that indicates the wallet returned an invalid namespace
+ */
+export declare class InvalidReceivedSessionNamespace extends Error {
+    messageWc: string;
+    codeWc: number;
+    data?: (string | string[]) | undefined;
+    name: string;
+    constructor(messageWc: string, codeWc: number, type: 'invalid' | 'incomplete', data?: (string | string[]) | undefined);
+}
+/**
+ *  @category Error
+ *  @description Error that indicates an invalid session key being passed
+ */
+export declare class InvalidSessionKey extends Error {
+    key: string;
+    name: string;
+    constructor(key: string);
+}
+/**
+ *  @category Error
+ *  @description Error that indicates the pkh is not part of the active accounts in the session
+ */
+export declare class InvalidAccount extends Error {
+    pkh: string;
+    name: string;
+    constructor(pkh: string);
+}
+/**
+ *  @category Error
+ *  @description Error that indicates the network is not part of the active networks in the session
+ */
+export declare class InvalidNetwork extends Error {
+    network: string;
+    name: string;
+    constructor(network: string);
+}
+/**
+ *  @category Error
+ *  @description Error that indicates the combinaison pkh-network is not part of the active session
+ */
+export declare class InvalidNetworkOrAccount extends Error {
+    network: string;
+    pkh: string;
+    name: string;
+    constructor(network: string, pkh: string);
+}
+/**
+ *  @category Error
+ *  @description Error that indicates the connection could not be established
+ */
+export declare class ConnectionFailed extends Error {
+    originalError: any;
+    name: string;
+    constructor(originalError: any);
+}
+/**
+ *  @category Error
+ *  @description Error that indicates there is no active session
+ */
+export declare class NotConnected extends Error {
+    name: string;
+    constructor();
+}
+/**
+ *  @category Error
+ *  @description Error that indicates the active account is not specified
+ */
+export declare class ActiveAccountUnspecified extends Error {
+    name: string;
+    constructor();
+}
+/**
+ *  @category Error
+ *  @description Error that indicates the active network is not specified
+ */
+export declare class ActiveNetworkUnspecified extends Error {
+    name: string;
+    constructor();
+}
+/**
+ *  @category Error
+ *  @description Error that indicates the session is invalid
+ */
+export declare class InvalidSession extends Error {
+    name: string;
+    constructor(message: string);
+}
+export declare class PublicKeyRetrievalError extends Error {
+    name: string;
+    constructor();
+}

package/dist/types/taquito-wallet-connect.d.ts

@@ -0,0 +1,147 @@
+/**
+ * @packageDocumentation
+ * @module @taquito/wallet-connect
+ */
+import Client from '@walletconnect/sign-client';
+import { SignClientTypes, SessionTypes, PairingTypes } from '@walletconnect/types';
+import { RPCDelegateOperation, RPCOriginationOperation, RPCTransferOperation, RPCTransferTicketOperation, RPCIncreasePaidStorageOperation, WalletDelegateParams, WalletOriginateParams, WalletProvider, WalletTransferParams, WalletTransferTicketParams, WalletStakeParams, WalletUnstakeParams, WalletFinalizeUnstakeParams, WalletIncreasePaidStorageParams } from '@taquito/taquito';
+import { NetworkType, OperationParams, PermissionScopeParam } from './types';
+export { SignClientTypes, PairingTypes };
+export * from './errors';
+export * from './types';
+/**
+ * @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.
+ */
+export declare class WalletConnect implements WalletProvider {
+    signClient: Client;
+    private session;
+    private activeAccount;
+    private activeNetwork;
+    constructor(signClient: Client);
+    /**
+     * @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",
+     *  },
+     * });
+     * ```
+     */
+    static init(initParams: SignClientTypes.Options): Promise<WalletConnect>;
+    /**
+     * @description Request permission for a new session and establish a connection.
+     *
+     * @param connectParams.permissionScope The networks, methods, and events that will be granted permission
+     * @param connectParams.pairingTopic 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.
+     * @param connectParams.registryUrl Optional registry of wallet deep links to show in the Modal
+     * @error ConnectionFailed is thrown if no connection can be established with a wallet
+     */
+    requestPermissions(connectParams: {
+        permissionScope: PermissionScopeParam;
+        pairingTopic?: string;
+        registryUrl?: string;
+    }): Promise<void>;
+    /**
+     * @description Access all existing active pairings
+     */
+    getAvailablePairing(): PairingTypes.Struct[];
+    /**
+     * @description Access all existing sessions
+     * @return an array of strings which represent the session keys
+     */
+    getAllExistingSessionKeys(): string[];
+    /**
+     * @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
+     */
+    configureWithExistingSessionKey(key: string): void;
+    disconnect(): Promise<void>;
+    getPeerMetadata(): import("@walletconnect/types").CoreTypes.Metadata;
+    /**
+     * @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
+     */
+    sendOperations(params: OperationParams[]): 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
+     */
+    sign(bytes: string, watermark?: Uint8Array): Promise<string>;
+    /**
+     * @description Return all connected accounts from the active session
+     * @error NotConnected if no active session
+     */
+    getAccounts(): string[];
+    /**
+     * @description Set the active account.
+     * Must be called if there are multiple accounts in the session and every time the active account is switched
+     * @param pkh public key hash of the selected account
+     * @error InvalidAccount thrown if the pkh is not part of the active accounts in the session
+     */
+    setActiveAccount(pkh: string): void;
+    /**
+     * @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
+     */
+    getPKH(): 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
+     */
+    getPK(): Promise<string>;
+    /**
+     * @description Return all networks from the namespace of the active session
+     * @error NotConnected if no active session
+     */
+    getNetworks(): string[];
+    /**
+     * @description Set the active network.
+     * Must be called if there are multiple network in the session and every time the active network is switched
+     * @param network selected network
+     * @error InvalidNetwork thrown if the network is not part of the active networks in the session
+     */
+    setActiveNetwork(network: NetworkType): void;
+    /**
+     * @description Access the active network
+     * @error ActiveNetworkUnspecified thorwn when there are multiple Tezos netwroks in the session and none is set as the active one
+     */
+    getActiveNetwork(): string;
+    private setDefaultAccountAndNetwork;
+    private clearState;
+    getSession(): SessionTypes.Struct;
+    isActiveSession(): boolean;
+    ping(): void;
+    private validateReceivedNamespace;
+    private validateMethods;
+    private validateEvents;
+    private validateAccounts;
+    private getTezosNamespace;
+    private getTezosRequiredNamespace;
+    private validateNetworkAndAccount;
+    private getPermittedMethods;
+    private getPermittedNetwork;
+    private formatParameters;
+    private removeDefaultLimits;
+    mapTransferParamsToWalletParams(params: () => Promise<WalletTransferParams>): Promise<Partial<RPCTransferOperation> | Partial<RPCTransferTicketOperation> | Partial<RPCOriginationOperation> | Partial<RPCDelegateOperation> | Partial<RPCIncreasePaidStorageOperation>>;
+    mapTransferTicketParamsToWalletParams(params: () => Promise<WalletTransferTicketParams>): Promise<Partial<RPCTransferOperation> | Partial<RPCTransferTicketOperation> | Partial<RPCOriginationOperation> | Partial<RPCDelegateOperation> | Partial<RPCIncreasePaidStorageOperation>>;
+    mapStakeParamsToWalletParams(params: () => Promise<WalletStakeParams>): Promise<Partial<RPCTransferOperation> | Partial<RPCTransferTicketOperation> | Partial<RPCOriginationOperation> | Partial<RPCDelegateOperation> | Partial<RPCIncreasePaidStorageOperation>>;
+    mapUnstakeParamsToWalletParams(params: () => Promise<WalletUnstakeParams>): Promise<Partial<RPCTransferOperation> | Partial<RPCTransferTicketOperation> | Partial<RPCOriginationOperation> | Partial<RPCDelegateOperation> | Partial<RPCIncreasePaidStorageOperation>>;
+    mapFinalizeUnstakeParamsToWalletParams(params: () => Promise<WalletFinalizeUnstakeParams>): Promise<Partial<RPCTransferOperation> | Partial<RPCTransferTicketOperation> | Partial<RPCOriginationOperation> | Partial<RPCDelegateOperation> | Partial<RPCIncreasePaidStorageOperation>>;
+    mapOriginateParamsToWalletParams(params: () => Promise<WalletOriginateParams>): Promise<Partial<RPCTransferOperation> | Partial<RPCTransferTicketOperation> | Partial<RPCOriginationOperation> | Partial<RPCDelegateOperation> | Partial<RPCIncreasePaidStorageOperation>>;
+    mapDelegateParamsToWalletParams(params: () => Promise<WalletDelegateParams>): Promise<Partial<RPCTransferOperation> | Partial<RPCTransferTicketOperation> | Partial<RPCOriginationOperation> | Partial<RPCDelegateOperation> | Partial<RPCIncreasePaidStorageOperation>>;
+    mapIncreasePaidStorageWalletParams(params: () => Promise<WalletIncreasePaidStorageParams>): Promise<Partial<RPCTransferOperation> | Partial<RPCTransferTicketOperation> | Partial<RPCOriginationOperation> | Partial<RPCDelegateOperation> | Partial<RPCIncreasePaidStorageOperation>>;
+}

package/dist/types/types.d.ts

@@ -0,0 +1,63 @@
+import { RPCDelegateOperation, RPCRegisterGlobalConstantOperation, RPCOriginationOperation, RPCRevealOperation, RPCTransferOperation, RPCTransferTicketOperation, RPCIncreasePaidStorageOperation, RPCBallotOperation, RPCUpdateConsensusKeyOperation, RPCDrainDelegateOperation, RPCProposalsOperation, RPCSmartRollupAddMessagesOperation, RPCSmartRollupOriginateOperation, RPCSmartRollupOutboxMessageOperation, RPCFailingNoopOperation } from '@taquito/taquito';
+export declare enum NetworkType {
+    MAINNET = "mainnet",
+    GHOSTNET = "ghostnet",
+    WEEKLYNET = "weeklynet",
+    OXFORDNET = "oxfordnet",
+    PARISNET = "parisnet"
+}
+export interface PermissionScopeParam {
+    networks: NetworkType[];
+    methods: PermissionScopeMethods[];
+    events?: PermissionScopeEvents[];
+}
+export declare enum PermissionScopeMethods {
+    TEZOS_GET_ACCOUNTS = "tezos_getAccounts",
+    TEZOS_SEND = "tezos_send",
+    TEZOS_SIGN = "tezos_sign"
+}
+export declare enum PermissionScopeEvents {
+    CHAIN_CHANGED = "chainChanged",
+    ACCOUNTS_CHANGED = "accountsChanged"
+}
+export declare enum SigningType {
+    RAW = "raw",
+    OPERATION = "operation",
+    MICHELINE = "micheline"
+}
+export interface TezosAccount {
+    algo: string;
+    address: string;
+    pubkey: string;
+}
+type WalletDefinedFields = 'source' | 'gas_limit' | 'storage_limit' | 'fee';
+interface WalletOptionalFields {
+    gas_limit?: string;
+    storage_limit?: string;
+    fee?: string;
+}
+export interface TransferParams extends Omit<RPCTransferOperation, WalletDefinedFields>, WalletOptionalFields {
+}
+export interface OriginateParams extends Omit<RPCOriginationOperation, WalletDefinedFields>, WalletOptionalFields {
+}
+export interface RevealParams extends Omit<RPCRevealOperation, WalletDefinedFields>, WalletOptionalFields {
+}
+export interface DelegateParams extends Omit<RPCDelegateOperation, WalletDefinedFields>, WalletOptionalFields {
+}
+export interface RegisterGlobalConstantParams extends Omit<RPCRegisterGlobalConstantOperation, WalletDefinedFields>, WalletOptionalFields {
+}
+export interface TransferTicketParams extends Omit<RPCTransferTicketOperation, WalletDefinedFields>, WalletOptionalFields {
+}
+export interface IncreasePaidStorageParams extends Omit<RPCIncreasePaidStorageOperation, WalletDefinedFields>, WalletOptionalFields {
+}
+export interface UpdateConsensusKeyParams extends Omit<RPCUpdateConsensusKeyOperation, WalletDefinedFields>, WalletOptionalFields {
+}
+export type BallotParams = Omit<RPCBallotOperation, WalletDefinedFields>;
+export type DrainDelegateParams = Omit<RPCDrainDelegateOperation, WalletDefinedFields>;
+export type ProposalsParams = Omit<RPCProposalsOperation, WalletDefinedFields>;
+export type SmartRollupAddMessagesParams = Omit<RPCSmartRollupAddMessagesOperation, WalletDefinedFields>;
+export type SmartRollupOriginateParams = Omit<RPCSmartRollupOriginateOperation, WalletDefinedFields>;
+export type SmartRollupExecuteOutboxMessageParams = Omit<RPCSmartRollupOutboxMessageOperation, WalletDefinedFields>;
+export type FailingNoopParams = Omit<RPCFailingNoopOperation, WalletDefinedFields>;
+export type OperationParams = TransferParams | BallotParams | IncreasePaidStorageParams | UpdateConsensusKeyParams | OriginateParams | RevealParams | DelegateParams | RegisterGlobalConstantParams | DrainDelegateParams | ProposalsParams | SmartRollupAddMessagesParams | SmartRollupOriginateParams | SmartRollupExecuteOutboxMessageParams | FailingNoopParams | TransferTicketParams;
+export {};

package/dist/types/version.d.ts

@@ -0,0 +1,4 @@
+export declare const VERSION: {
+    commitHash: string;
+    version: string;
+};

package/package.json

@@ -0,0 +1,106 @@
+{
+  "name": "@taquito/wallet-connect",
+  "version": "20.2.0-beta.0",
+  "description": "Walletconnect provider",
+  "keywords": [
+    "tezos",
+    "blockchain",
+    "websocket"
+  ],
+  "main": "dist/taquito-wallet-connect.umd.js",
+  "module": "dist/taquito-wallet-connect.es6.js",
+  "typings": "dist/types/taquito-wallet-connect.d.ts",
+  "files": [
+    "signature.json",
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "Roxane Letourneau <roxane@ecadlabs.com>",
+  "repository": {
+    "type": "git",
+    "url": ""
+  },
+  "license": "Apache-2.0",
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "test": "jest --coverage",
+    "test:watch": "jest --coverage --watch",
+    "test:prod": "npm run lint && npm run test -- --no-cache",
+    "lint": "eslint --ext .js,.ts .",
+    "precommit": "lint-staged",
+    "prebuild": "rimraf dist",
+    "version-stamp": "node ../taquito/version-stamping.js",
+    "build": "tsc --project ./tsconfig.prod.json --module commonjs && rollup -c rollup.config.ts --bundleConfigAsCjs",
+    "start": "rollup -c rollup.config.ts --bundleConfigAsCjs -w"
+  },
+  "lint-staged": {
+    "{src,test}/**/*.ts": [
+      "prettier --write",
+      "eslint --fix"
+    ]
+  },
+  "jest": {
+    "transform": {
+      ".(ts|tsx)": "ts-jest"
+    },
+    "testEnvironment": "node",
+    "testRegex": "(/__tests__/.*|\\.(test|spec))\\.(ts|tsx|js)$",
+    "moduleFileExtensions": [
+      "ts",
+      "tsx",
+      "js"
+    ],
+    "moduleNameMapper": {
+      "^@taquito/taquito$": "<rootDir>/../taquito/src/taquito.ts"
+    },
+    "coveragePathIgnorePatterns": [
+      "/node_modules/",
+      "/test/"
+    ],
+    "collectCoverageFrom": [
+      "src/**/*.{js,ts}"
+    ]
+  },
+  "dependencies": {
+    "@taquito/taquito": "^20.2.0-beta.0",
+    "@walletconnect/legacy-modal": "^2.0.0",
+    "@walletconnect/sign-client": "^2.16.2",
+    "@walletconnect/types": "^2.16.2",
+    "@walletconnect/utils": "^2.16.2"
+  },
+  "devDependencies": {
+    "@types/bluebird": "^3.5.42",
+    "@types/chrome": "0.0.171",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^22",
+    "@types/pino": "^7.0.5",
+    "@types/ws": "^8.5.12",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "@typescript-eslint/parser": "^6.21.0",
+    "colors": "^1.4.0",
+    "coveralls": "^3.1.1",
+    "cross-env": "^7.0.3",
+    "eslint": "^8.57.0",
+    "jest": "^29.7.0",
+    "jest-config": "^29.7.0",
+    "lint-staged": "^15.2.7",
+    "lodash.camelcase": "^4.3.0",
+    "prettier": "^3.3.3",
+    "prompt": "^1.3.0",
+    "replace-in-file": "^8.1.0",
+    "rimraf": "^6.0.1",
+    "rollup": "^4.19.1",
+    "rollup-plugin-json": "^4.0.0",
+    "rollup-plugin-typescript2": "^0.36.0",
+    "shelljs": "^0.8.5",
+    "ts-jest": "^29.2.3",
+    "ts-node": "^10.9.2",
+    "ts-toolbelt": "^9.6.0",
+    "typescript": "~5.5.4"
+  },
+  "gitHead": "de49571826b30682dd74d3ebc17a0e191128c617"
+}