feat(permit): refactor permit-utils package #3258

alfetopito · 2023-10-20T14:26:04Z

Summary

Refactoring permit fns into an isolated lib.

Removed all internal dependencies to have the lib isolated:

This lib is also to be published to npm in my personal account for now https://www.npmjs.com/package/alfetopito-permit-utils?activeTab=code

TODO:

Add GH action to publish libs - need devops/Anxo help with permissions, will be done in another PR

To Test

Permit should work as before

vercel · 2023-10-20T14:26:10Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
swap-dev	✅ Ready (Inspect)	Visit Preview	Oct 27, 2023 4:52pm

🌃 Cosmos ↗︎

socket-security · 2023-10-20T14:35:42Z

Updated dependencies detected. Learn more about Socket for GitHub ↗︎

Packages	Version	New capabilities	Transitives	Size	Publisher
@1inch/permit-signed-approvals-utils	1.4.8...1.4.10	None	`+48/-12`	18.6 MB	1inch-robot
@cowprotocol/app-data	1.1.0-RC.0...1.1.0	None	`+2/-1`	199 kB	cowprotocol_dev

alfetopito · 2023-10-20T16:27:50Z

libs/permit-utils/package.json

+  "name": "@cowprotocol/permit-utils",
+  "version": "0.0.1-RC.0",


These fields define the final npm package.

alfetopito · 2023-10-20T16:29:34Z

libs/permit-utils/project.json

+    "publish": {
+      "command": "node tools/scripts/publish.mjs permit-utils {args.tag} {args.otp}",
+      "dependsOn": ["build"]


Command used to publish:

npx nx run permit-utils:publish [--tag <tag>] [--otp <otp>]

Right now published to my personal account with a different package name https://www.npmjs.com/package/alfetopito-permit-utils?activeTab=code

alfetopito · 2023-10-20T16:29:56Z

libs/permit-utils/src/index.ts

+export { checkIsCallDataAValidPermit } from './lib/checkIsCallDataAValidPermit'
+export { generatePermitHook } from './lib/generatePermitHook'
+export { getPermitUtilsInstance } from './lib/getPermitUtilsInstance'
+export { getTokenPermitInfo } from './lib/getTokenPermitInfo'
+
+export type { PermitHookData, PermitHookParams, PermitInfo, PermitType, SupportedPermitInfo } from './types'


Lib interface

alfetopito · 2023-10-20T16:30:26Z

libs/permit-utils/src/lib/generatePermitHook.ts

@@ -1,11 +1,9 @@
-import { GP_VAULT_RELAYER } from '@cowprotocol/common-const'


Remove all internal cross dependencies

package.json

alfetopito · 2023-10-20T16:32:15Z

tools/scripts/publish.mjs

+// Fetch the version from "package.json" before publishing
+let version
+try {
+  const json = JSON.parse(readFileSync(`package.json`).toString())
+  version = json.version
+} catch (e) {
+  console.error(chalk.bold.red(`Error reading package.json file from library build output.`))
+  process.exit(1)
+}


Changed the default publish command to use the package's version rathern than updating it based on cli param

alfetopito · 2023-10-20T16:32:50Z

tools/scripts/publish.mjs


 // Execute "npm publish" to publish
-const publishCommand = `npm publish --access public --tag ${tag === 'undefined' ? 'next' : tag}`
+const publishCommand = `npm publish --access public --tag ${tag === 'undefined' ? 'next' : tag} ${otp? `--otp ${otp}`:''}`


Optional opt param, as I needed to publish it locally under my account.
Shouldn't be needed when moving this over to CI 🤞

project.json

tools/scripts/publish.mjs

package.json

libs/permit-utils/README.md

shoom3301

Haven't tested, but code looks good!

Generated using `nx g @nx/js:lib` command

… generated bundle

alfetopito · 2023-10-27T16:59:26Z

libs/permit-utils/package.json

+  "dependencies": {
+    "ethers": "^5.7.2",
+    "@1inch/permit-signed-approvals-utils": "^1.4.10",
+    "@cowprotocol/app-data": "^1.1.0",
+    "tslib": "^2.6.1"
+  },


Had to duplicate the dependencies here so package consumers install them too

alfetopito · 2023-10-27T17:00:17Z

libs/permit-utils/package.json

+  "module": "./index.js",
+  "main": "./index.cjs",
+  "exports": {
+    ".": {
+      "import": "./index.js",
+      "require": "./index.cjs"
+    }
+  }
+}


This is so package can be consumed either the ES way (index.js) or CommonJS way (index.cjs)

alfetopito · 2023-10-27T17:02:23Z

libs/permit-utils/vite.config.ts

+    },
+    rollupOptions: {
+      // External packages that should not be bundled into your library.
+      external: [/@1inch/, /@cowprotocol/, /@ethersproject/],


Explicitly removing third party dependencies to not have them included in the bundle.
They are instead added as part of package.json dependencies.

vercel bot deployed to Preview October 20, 2023 14:30 View deployment

vercel bot deployed to Preview October 20, 2023 16:15 View deployment

alfetopito commented Oct 20, 2023

View reviewed changes

vercel bot deployed to Preview October 20, 2023 16:48 View deployment

alfetopito self-assigned this Oct 23, 2023

alfetopito marked this pull request as ready for review October 23, 2023 15:51

alfetopito force-pushed the permit/export-package branch from 26955ed to 603a2d2 Compare October 23, 2023 15:52

alfetopito added the permit label Oct 23, 2023

alfetopito requested review from anxolin and a team and removed request for anxolin October 23, 2023 15:54

vercel bot deployed to Preview October 23, 2023 15:55 View deployment

vercel bot deployed to Preview October 25, 2023 10:22 View deployment

vercel bot deployed to Preview October 25, 2023 11:16 View deployment

anxolin approved these changes Oct 26, 2023

View reviewed changes

project.json Outdated Show resolved Hide resolved

shoom3301 reviewed Oct 26, 2023

View reviewed changes

tools/scripts/publish.mjs Outdated Show resolved Hide resolved

shoom3301 reviewed Oct 26, 2023

View reviewed changes

package.json Outdated Show resolved Hide resolved

shoom3301 reviewed Oct 26, 2023

View reviewed changes

libs/permit-utils/README.md Show resolved Hide resolved

vercel bot deployed to Preview October 26, 2023 10:23 View deployment

vercel bot deployed to Preview October 26, 2023 10:57 View deployment

alfetopito force-pushed the permit/export-package branch from 326664b to 23d60f6 Compare October 26, 2023 11:10

vercel bot deployed to Preview October 26, 2023 11:16 View deployment

vercel bot deployed to Preview October 26, 2023 11:20 View deployment

shoom3301 approved these changes Oct 26, 2023

View reviewed changes

vercel bot had a problem deploying to Preview October 27, 2023 15:44 Failure

alfetopito added 3 commits October 27, 2023 16:48

feat: add permit-utils lib

a6a8719

Generated using `nx g @nx/js:lib` command

chore: remove default files

dc787bd

feat: add utils to permit-utils package

4a196cc

alfetopito added 18 commits October 27, 2023 16:51

fix: must have macrosPlugin as part of vite.config

15c879a

chore: change provider type to JsonRpcProvider

fab62f9

chore: expose GetTokenPermitIntoResult

66804a6

chore: remove stuff added automatically which are not needed

774d442

fix: js code style

8e130c7

chore: remove commands which are not relevant in the NPM context

e0ad9a1

chore: add somewhat complete usage example

0ef4123

chore: remove another dep added automatically jest-environment-node

fd6fbd9

chore: import AbiInput from @1inch lib instead of directly from web3

0df4608

chore: remove @ethersproject/bignumber dep. Already part of ethers

100ee6d

refactor: removed extra comma

02140f7

refactor: remove dependency on @uniswap/core

d0d295e

chore: exclude all external dependencies from the build

0bdc35d

chore: change package type from commonjs to module

a15a83a

chore: add required dependencies to lib package.json

adbc37c

feat: set different entry points for different module styles

53b85f8

chore: update some package dependencies

a02a6dd

fix: exclusions MUST not be the whole /node_modules/ as it breaks the…

d1b55a2

… generated bundle

alfetopito force-pushed the permit/export-package branch from aca2086 to d1b55a2 Compare October 27, 2023 15:55

vercel bot had a problem deploying to Preview October 27, 2023 15:57 Failure

fix: no longer using Token type on permit-utils

9c80bee

vercel bot had a problem deploying to Preview October 27, 2023 16:28 Failure

vercel bot had a problem deploying to Preview October 27, 2023 16:43 Failure

fix: uploaded local registry path by mistake

b03b2f8

alfetopito force-pushed the permit/export-package branch from 11bc372 to b03b2f8 Compare October 27, 2023 16:46

vercel bot deployed to Preview October 27, 2023 16:52 View deployment

alfetopito commented Oct 27, 2023

View reviewed changes

alfetopito merged commit 28ea672 into develop Oct 27, 2023

github-actions bot locked and limited conversation to collaborators Oct 27, 2023

alfetopito deleted the permit/export-package branch October 30, 2023 09:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(permit): refactor permit-utils package #3258

feat(permit): refactor permit-utils package #3258

alfetopito commented Oct 20, 2023 •

edited

Loading

vercel bot commented Oct 20, 2023 •

edited by github-actions bot

Loading

socket-security bot commented Oct 20, 2023 •

edited

Loading

alfetopito Oct 20, 2023

alfetopito Oct 20, 2023

alfetopito Oct 20, 2023

alfetopito Oct 20, 2023

alfetopito Oct 20, 2023

alfetopito Oct 20, 2023

shoom3301 left a comment

alfetopito Oct 27, 2023

alfetopito Oct 27, 2023

alfetopito Oct 27, 2023

		"name": "@cowprotocol/permit-utils",
		"version": "0.0.1-RC.0",

		@@ -1,11 +1,9 @@
		import { GP_VAULT_RELAYER } from '@cowprotocol/common-const'

feat(permit): refactor permit-utils package #3258

feat(permit): refactor permit-utils package #3258

Conversation

alfetopito commented Oct 20, 2023 • edited Loading

Summary

TODO:

To Test

vercel bot commented Oct 20, 2023 • edited by github-actions bot Loading

socket-security bot commented Oct 20, 2023 • 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

shoom3301 left a 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

alfetopito commented Oct 20, 2023 •

edited

Loading

vercel bot commented Oct 20, 2023 •

edited by github-actions bot

Loading

socket-security bot commented Oct 20, 2023 •

edited

Loading