Pub (#7)

* update jest lib

* adding increment and toHexNonce methods and tests, adding more readme

* updating for distribution

* updating package

* clean types

* adding needed lib for github actions build

* removing explicit chain id

Author: StoyanD

README.md

@@ -4,7 +4,11 @@ This utility library exists to create and work with 2D nonces as discribed in th
 
 This lib has been checked against what is currently deployed by Eth-Infinitism which is [Release v0.6](https://github.com/eth-infinitism/account-abstraction/releases/tag/v0.6.0) on ethereum at [0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789](https://optimistic.etherscan.io/address/0x5ff137d4b0fdcd49dca30c7cf57e578a026d2789#code)
 
-To use the library, install it.
+To use the library, install it:
+
+```
+  yarn add @beamnetwork/nonce-2d
+```
 
 The 2D nonce is devided into 2 parts. It is 256 bits long, with 192 bits reserved for a key and 64 reserved for numerical sequence that increments for each tx.
 

package.json

@@ -1,9 +1,15 @@
 {
-  "name": "nonce-2d",
-  "version": "0.0.1",
+  "name": "@beamnetwork/nonce-2d",
+  "version": "0.0.5",
   "description": "",
-  "main": "index.js",
-  "types": "index.d.ts",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "package.json",
+    "README.md"
+  ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/eco/nonce-2d.git"
@@ -31,12 +37,18 @@
     "prettier:fix": "prettier . --write",
     "format": "yarn lint:fix && yarn prettier:fix",
     "format:check": "yarn lint && yarn prettier",
-    "build": "npx tsc",
-    "clean": "rm -rf ./dist",
-    "buildLib": "build",
-    "publish": "npm publish --access public"
+    "build": "tsup",
+    "clean": "rm -rf ./dist"
+  },
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs",
+      "types": "./dist/index.d.ts"
+    }
   },
   "devDependencies": {
+    "@swc/core": "^1.3.105",
     "@types/jest": "^29.5.11",
     "@typescript-eslint/eslint-plugin": "^6.14.0",
     "@typescript-eslint/parser": "^6.14.0",
@@ -56,6 +68,7 @@
     "prettier": "^3.1.1",
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.2",
+    "tsup": "^8.0.1",
     "typescript": "^5.3.3"
   },
   "dependencies": {},

index.ts src/index.ts

@@ -16,12 +16,6 @@ export const NONCE_2D_KEY_CHAIN_BIT_LENGTH = 32 // 4*8
 // Radix for hex
 const HEX_RADIS = 16
 
-export enum ChainID {
-  EthereumMainnet = 1,
-  EthereumGoerli = 5,
-  Optimism = 10,
-  OptimismGoerli = 420,
-}
 /**
  * The structure of the Nonce2D, [key, seq] == [192|64] == 256 bits
  * @param key The key as a hex string
@@ -81,10 +75,10 @@ export class Nonce2D {
    * Generates a sequence number for a given hex key and sequence number
    *
    * @param hexKey the 192 bit hex key containing the chain and address
-   * @param seq the 64 bit sequence number or 1 if not provided
+   * @param seq the 64 bit sequence number or defaults to 0 if not provided
    * @returns
    */
-  static fromHexKey(hexKey: string, seq: number = 1): Nonce2D {
+  static fromHexKey(hexKey: string, seq: number = 0): Nonce2D {
     const hexNonce = hexKey + hexPad(seq.toString(HEX_RADIS), 16)
     return new Nonce2D(hexNonce)
   }
@@ -94,12 +88,12 @@ export class Nonce2D {
    * to look up the full nonce on-chain for the wallet.
    *
    * @param ethAddress the destination address in the key(not the address of the 4337 wallet)
-   * @param chain the destination chain in the key
+   * @param chainID the destination chain id in the key
    * @returns the 192 bit hex key for the destination address-chain pair
    */
-  static getHexKeyForDestination(ethAddress: string, chain: ChainID): string {
+  static getHexKeyForDestination(ethAddress: string, chainID: number): string {
     ethAddress = stripOx(ethAddress)
-    return ('0x' + chain.toString(HEX_RADIS) + ethAddress).toLocaleLowerCase()
+    return ('0x' + chainID.toString(HEX_RADIS) + ethAddress).toLocaleLowerCase()
   }
 
   /**

test/index.spec.ts

@@ -1,4 +1,12 @@
-import { ChainID, Nonce2D } from '../index'
+import { Nonce2D } from '../src/index'
+
+enum ChainID {
+  EthereumMainnet = 1,
+  EthereumGoerli = 5,
+  Optimism = 10,
+  OptimismGoerli = 420,
+}
+
 // Test chain id
 const testChain = ChainID.EthereumGoerli
 // 256 bit nonce = 32 bytes
@@ -31,7 +39,7 @@ describe('Nonce2D tests', () => {
 
   describe('fromHexKey tests', () => {
     it('should create a Nonce2D object from a valid key', () => {
-      const n = Nonce2D.fromHexKey(testsKey)
+      const n = Nonce2D.fromHexKey(testsKey, 1)
       expect(Number(n.chain)).toBe(testChain)
       expect(n.address).toBe(testsAddress)
       expect(n.seq).toBe(testsSeq)

tsconfig.json

@@ -7,6 +7,6 @@
     "strict": true
   },
   "types": ["jest"],
-  "include": ["index.ts"],
+  "include": ["src/index.ts"],
   "exclude": ["node_modules", "dist"]
 }

tsup.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from 'tsup'
+
+export default defineConfig({
+  entry: ['src/index.ts'],
+  format: ['cjs', 'esm'], // Build for commonJS and ESmodules
+  dts: true, // Generate declaration file (.d.ts)
+  splitting: false,
+  sourcemap: true,
+  clean: true,
+})