feat: Tezos Provider #1

dianasavvatina · 2024-10-18T10:39:15Z

Adding Tezos Provider for WalletConnect SDK.
See README for usage examples.

Usage example: reown-com/web-examples#697

Testing:

yarn prettier
yarn lint
yarn test
yarn build

Moved tezosProvider from WalletConnect Monorepo, PR#5357

serjonya-trili · 2024-10-24T01:57:10Z

.prettierrc

@@ -0,0 +1,6 @@
+{
+  "tabWidth": 2,


it's more of an editorconfig thing

serjonya-trili · 2024-10-24T01:57:15Z

.prettierrc

@@ -0,0 +1,6 @@
+{
+  "tabWidth": 2,
+  "useTabs": false,


serjonya-trili · 2024-10-24T01:57:20Z

.prettierrc

+  "tabWidth": 2,
+  "useTabs": false,
+  "trailingComma": "all",
+  "printWidth": 100


serjonya-trili · 2024-10-24T01:59:01Z

eslint.config.mjs

+  },
+  files: ["**/*.ts"],
+  rules: {
+    "@typescript-eslint/ban-ts-ignore": ["off"],


are you confident of turning all of those off?

serjonya-trili · 2024-10-24T02:00:21Z

package.json

+  ],
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "tsup-node --dts",


you can puts the dts setting into the tsup config itself down below

serjonya-trili · 2024-10-24T02:20:30Z

src/TezosProvider.ts

+    return await this.tezosSend(op);
+  };
+
+  public tezosSendProposal = async (op: TezosProposalOperation): Promise<TezosSendResponse> => {


not sure if all those methods need the tezos prefix. it's obvious from the class name that it's tezos related

The operations contain the names of WalletConnect requests: tezos_send, tezos_sign, tezos_getaccounts.
I try to find a way to distinguish requests to peer (on top of these 3) and auxilary requests, like getBalance(), connect(), getContractAddress().
If you think, that it's not needed, I'll rename:

tezosSend -> send tezosSign -> sign tezosGetAccounts -> getAccounts

yeah, I don't think it adds much value

serjonya-trili · 2024-10-24T02:23:01Z

src/TezosProvider.ts

+    return await this.tezosSend(op);
+  };
+
+  public tezosSendIncreasePaidStorage = async (


there is no need to await unless you want to catch errors or something. so it should be

public async sendIncreasePaidStorage(op: PartialTezosIncreasePaidStorageOperation) { return this.tezosSend(op); }

serjonya-trili · 2024-10-24T02:24:36Z

package.json

+  },
+  "devDependencies": {
+    "@jest/globals": "^29.7.0",
+    "@swc/core": "^1.7.35",


so do you use swc or tsup in the end?

serjonya-trili · 2024-10-24T02:25:05Z

tsconfig.json

+    "ignoreDeprecations": "5.0"
+
+  },
+  "include": ["./src/**/*.ts", "./src"],


"include": ["src"]

serjonya-trili · 2024-10-24T02:25:19Z

tsconfig.json

+  "include": ["./src/**/*.ts", "./src"],
+  "exclude": [
+    "node_modules",
+    "test",


don't exclude test

serjonya-trili · 2024-11-20T11:04:57Z

tsconfig.json

+
+  },
+  "include": ["src"],
+  "exclude": [


serjonya-trili · 2024-11-20T11:05:42Z

tsconfig.json

+    "lib": ["ES2020", "DOM"],
+    "module": "ES2020",
+    "target": "ES2020",
+    "moduleResolution": "Node",


why node if that's a front-end app? 🤔

I used WalletConnect monorepo as a reference. There is a number of providers and all of them used main config:
https://github.com/WalletConnect/walletconnect-monorepo/blob/v2.0/tsconfig.json#L18

"lib": ["ES2020", "DOM"], "module": "ES2020", "target": "ES2020", "moduleResolution": "Node",

I try to keep my code aligned.

tsconfig.json

serjonya-trili · 2024-11-20T11:08:26Z

package.json

+    "package.json": "^2.0.1",
+    "rollup": "^4.24.0",
+    "typescript": "^5.6.3",
+    "yarn.lock": "^0.0.1-security"


serjonya-trili · 2024-11-20T11:09:59Z

package.json

+  "type": "module",
+  "main": "dist/index.cjs.js",
+  "module": "dist/index.es.js",
+  "unpkg": "dist/index.umd.js",


do you have it?

serjonya-trili · 2024-11-20T11:12:06Z

package.json

+    "test:pre": "rm -rf ./test/test.db",
+    "test:run": "jest",
+    "test": "yarn test:pre; yarn test:run",
+    "prettier": "prettier --check '{src,test}/**/*.{js,ts,jsx,tsx}' --write",


just prettier --write .

serjonya-trili · 2024-11-20T11:12:47Z

package.json

+    "test:run": "jest",
+    "test": "yarn test:pre; yarn test:run",
+    "prettier": "prettier --check '{src,test}/**/*.{js,ts,jsx,tsx}' --write",
+    "lint": "eslint -c 'eslint.config.mjs' --fix './src/**/*.ts'",


IIRC eslint 9 (which config you are using) has the list of files already.
no need to use quotes

serjonya-trili · 2024-11-20T11:14:18Z

package.json

+  },
+  "dependencies": {
+    "@airgap/beacon-types": "^4.2.2",
+    "@taquito/rpc": "~20.0.1",


outdated, use yarn upgrade-interactive to fix such things

fixed deps. Checked that lib is built in WalletConnect example for tezos provider

serjonya-trili · 2024-11-20T11:16:05Z

package.json

+    "@walletconnect/logger": "^2.1.2",
+    "@walletconnect/types": "2.13.3",
+    "@walletconnect/universal-provider": "^2.17.1",
+    "axios": "^1.7.7",


you use it in only 1 place. consider replacing with a built-in fetch. less dependencies -> smaller output

serjonya-trili · 2024-11-20T11:16:45Z

package.json

+  ],
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "tsup-node",


since it's a library, most likely you need to either us tsup or tsup-node + peerDependencies in the package.json

serjonya-trili · 2024-11-21T12:02:17Z

package.json

+    "@walletconnect/logger": "^2.1.2",
+    "@walletconnect/types": "^2.17.2",
+    "@walletconnect/universal-provider": "^2.17.2",
+    "i": "^0.3.7",


serjonya-trili · 2024-11-22T09:12:22Z

test/jest.setup.js

@@ -0,0 +1,3 @@
+global.fetch = jest.fn();
+
+jest.clearAllMocks();


put this into jest.config

serjonya-trili · 2024-11-22T09:13:32Z

test/index.spec.ts

+    } as TezosProviderOpts);
+    await provider.connect({ chains: [TezosChainDataMainnet] });
+
+    // mockRequest = jest.fn();


serjonya-trili · 2024-11-22T09:14:06Z

test/index.spec.ts

+  const mockRequest = jest.fn();
+
+  beforeEach(async () => {
+    (UniversalProvider.init as jest.Mock).mockResolvedValue({


jest.mocked(...) is a type safe version. please prefer it (and in other places too)

OKendigelyan

LGTM!

dianasavvatina requested a review from ajinkyaraj-23 October 18, 2024 10:40

dianasavvatina self-assigned this Oct 18, 2024

dianasavvatina mentioned this pull request Oct 18, 2024

feat: Tezos Provider trilitech/tezos-connect#4

Closed

dianasavvatina force-pushed the diana@tezos-provider branch 2 times, most recently from 1b4c23a to e5cfdec Compare October 18, 2024 13:31

dianasavvatina requested review from serjonya-trili and OKendigelyan October 21, 2024 14:19

serjonya-trili requested changes Oct 24, 2024

View reviewed changes

dianasavvatina force-pushed the diana@tezos-provider branch 3 times, most recently from f94006b to 630dc2f Compare November 14, 2024 16:33

feat: Tezos Provider

1b40b6f

dianasavvatina force-pushed the diana@tezos-provider branch from 630dc2f to 1b40b6f Compare November 14, 2024 16:56

dianasavvatina requested a review from serjonya-trili November 20, 2024 10:34

serjonya-trili reviewed Nov 20, 2024

View reviewed changes

dianasavvatina force-pushed the diana@tezos-provider branch from 22b88e9 to 8e6fc54 Compare November 21, 2024 12:01

serjonya-trili reviewed Nov 21, 2024

View reviewed changes

dianasavvatina force-pushed the diana@tezos-provider branch from 8e6fc54 to 8188e4c Compare November 21, 2024 13:55

fix: comments applied. renamed tezos calls

48319c8

dianasavvatina force-pushed the diana@tezos-provider branch from 8188e4c to 48319c8 Compare November 21, 2024 15:04

serjonya-trili reviewed Nov 22, 2024

View reviewed changes

dianasavvatina added 3 commits November 22, 2024 14:00

fix: dependencies

6582e15

fix: singleton with single chain

4d4835e

fix: optimized jest config and mocks

09debf4

dianasavvatina removed the request for review from ajinkyaraj-23 December 9, 2024 11:28

dianasavvatina force-pushed the diana@tezos-provider branch from d0598bc to feb596c Compare December 9, 2024 11:30

fix: v18, added lint checks

2155a0b

dianasavvatina force-pushed the diana@tezos-provider branch from feb596c to 2155a0b Compare December 9, 2024 16:35

OKendigelyan approved these changes Dec 16, 2024

View reviewed changes

dianasavvatina merged commit d61cf63 into main Dec 17, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Tezos Provider #1

feat: Tezos Provider #1

dianasavvatina commented Oct 18, 2024 •

edited

Loading

serjonya-trili Oct 24, 2024

serjonya-trili Oct 24, 2024

serjonya-trili Oct 24, 2024

serjonya-trili Oct 24, 2024

serjonya-trili Oct 24, 2024

serjonya-trili Oct 24, 2024

dianasavvatina Nov 13, 2024

serjonya-trili Nov 13, 2024

serjonya-trili Oct 24, 2024

serjonya-trili Oct 24, 2024

serjonya-trili Oct 24, 2024

serjonya-trili Oct 24, 2024

serjonya-trili Nov 20, 2024

serjonya-trili Nov 20, 2024

dianasavvatina Nov 21, 2024

serjonya-trili Nov 20, 2024

serjonya-trili Nov 20, 2024

serjonya-trili Nov 20, 2024

serjonya-trili Nov 20, 2024

serjonya-trili Nov 20, 2024

dianasavvatina Nov 22, 2024

serjonya-trili Nov 20, 2024

serjonya-trili Nov 20, 2024

serjonya-trili Nov 21, 2024

serjonya-trili Nov 22, 2024

serjonya-trili Nov 22, 2024 •

edited

Loading

serjonya-trili Nov 22, 2024 •

edited

Loading

OKendigelyan left a comment

		@@ -0,0 +1,3 @@
		global.fetch = jest.fn();

		jest.clearAllMocks();

feat: Tezos Provider #1

feat: Tezos Provider #1

Conversation

dianasavvatina commented Oct 18, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

serjonya-trili Nov 22, 2024 • edited Loading

Choose a reason for hiding this comment

serjonya-trili Nov 22, 2024 • edited Loading

Choose a reason for hiding this comment

OKendigelyan left a comment

Choose a reason for hiding this comment

dianasavvatina commented Oct 18, 2024 •

edited

Loading

serjonya-trili Nov 22, 2024 •

edited

Loading

serjonya-trili Nov 22, 2024 •

edited

Loading