Merge pull request #37 from tokenbound/bj/debug-large-package

Eliminate non-deployed chains from build

.changeset/yellow-pigs-stare.md

@@ -0,0 +1,5 @@
+---
+'@tokenbound/sdk': patch
+---
+
+Eliminate non-deployed chains from build

.github/workflows/on-create-release.yml

@@ -29,7 +29,10 @@ jobs:
       - name: Change to package directory
         run: cd packages/sdk
 
-      - name: Install dependencies and build 🔧
+      - name: Install dependencies
+        run: npm install
+
+      - name: Clean install and build 🔧
         run: npm ci && npm build
         # run: pnpm ci && pnpm build // pnpm ci not yet implemented: https://github.com/pnpm/pnpm/issues/6100
 

examples/vite-wagmi-ethers-rainbowkit/package.json

@@ -17,7 +17,7 @@
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "util": "^0.12.5",
-    "viem": "^1.15.1",
+    "viem": "^1.16.2",
     "wagmi": "^1.4.3"
   },
   "devDependencies": {

examples/vite-wagmi-ethers/package.json

@@ -17,7 +17,7 @@
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "util": "^0.12.5",
-    "viem": "^1.15.1",
+    "viem": "^1.16.2",
     "wagmi": "^1.4.3"
   },
   "devDependencies": {

examples/vite-wagmi-ethers6/package.json

@@ -17,7 +17,7 @@
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "util": "^0.12.5",
-    "viem": "^1.15.1",
+    "viem": "^1.16.2",
     "wagmi": "^1.4.3"
   },
   "devDependencies": {

examples/vite-wagmi-viem/package.json

@@ -17,7 +17,7 @@
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "util": "^0.12.5",
-    "viem": "^1.15.1",
+    "viem": "^1.16.2",
     "wagmi": "^1.4.3"
   },
   "devDependencies": {

package.json

@@ -10,6 +10,9 @@
   "keywords": [],
   "author": "",
   "license": "ISC",
+  "publishConfig.directory": {
+    "directory": "packages/sdk"
+  },
   "devDependencies": {
     "@changesets/cli": "^2.26.2",
     "eslint": "^8.50.0",

packages/sdk/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tokenbound/sdk",
-  "version": "0.3.9",
+  "version": "0.3.11",
   "type": "module",
   "files": [
     "dist"
@@ -25,7 +25,7 @@
     "wagmi": "wagmi generate"
   },
   "dependencies": {
-    "viem": "^1.14.0"
+    "viem": "^1.16.2"
   },
   "devDependencies": {
     "@tanstack/react-query": "4.29.1",
@@ -45,7 +45,7 @@
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "typescript": "^5.2.2",
-    "viem": "^1.15.1",
+    "viem": "^1.16.2",
     "@viem/anvil": "^0.0.6",
     "vite": "^4.4.9",
     "vite-plugin-dts": "^3.5.1",

packages/sdk/src/TokenboundClient.ts

@@ -67,6 +67,7 @@ class TokenboundClient {
   constructor(options: TokenboundClientOptions) {
     const {
       chainId,
+      chain,
       signer,
       walletClient,
       publicClient,
@@ -75,8 +76,8 @@ class TokenboundClient {
       publicClientRPCUrl,
     } = options
 
-    if (!chainId) {
-      throw new Error('chainId is required.')
+    if (!chainId && !chain) {
+      throw new Error('chain or chainId required.')
     }
 
     if (signer && walletClient) {
@@ -93,7 +94,7 @@ class TokenboundClient {
       throw new Error('`publicClient` cannot be provided when using Ethers `signer`.')
     }
 
-    this.chainId = chainId
+    this.chainId = chainId ?? chain!.id
 
     if (signer) {
       this.signer = signer
@@ -108,11 +109,10 @@ class TokenboundClient {
       this.registryAddress = registryAddress
     }
 
-    //
     this.publicClient =
       publicClient ??
       createPublicClient({
-        chain: chainIdToChain(this.chainId),
+        chain: chain ?? chainIdToChain(this.chainId),
         transport: http(publicClientRPCUrl ?? undefined),
       })
 

packages/sdk/src/test/TestAll.test.ts

@@ -1,6 +1,7 @@
 // This test suite is for testing the SDK methods with
 // viem walletClient + publicClient and with Ethers 5/6.
 
+import { zora } from 'viem/chains'
 import { describe, expect, it, vi } from 'vitest'
 import { providers } from 'ethers'
 import { waitFor } from './mockWallet'
@@ -768,7 +769,7 @@ function runTxTests({
   })
 }
 
-describe('Custom publicClient RPC URL', () => {
+describe('Custom client configurations', () => {
   it('can use a custom publicClient RPC URL', async () => {
     const customPublicClientRPCUrl = 'https://cloudflare-eth.com'
     const tokenboundClient = new TokenboundClient({
@@ -781,4 +782,16 @@ describe('Custom publicClient RPC URL', () => {
       expect(tokenboundClient.publicClient?.transport?.url).toBe(customPublicClientRPCUrl)
     })
   })
+  it('can use a custom chain as parameter', async () => {
+    const ZORA_CHAIN_ID = 7777777
+
+    const tokenboundClient = new TokenboundClient({
+      walletClient,
+      chain: zora,
+    })
+
+    await waitFor(() => {
+      expect(tokenboundClient.publicClient?.chain?.id).toBe(ZORA_CHAIN_ID)
+    })
+  })
 })

packages/sdk/src/types/params.ts

@@ -1,4 +1,4 @@
-import { WalletClient, PublicClient } from 'viem'
+import { WalletClient, PublicClient, Chain } from 'viem'
 import { Prettify } from './prettify'
 import { UniversalSignableMessage } from './messages'
 import { PossibleENSAddress } from './addresses'
@@ -48,7 +48,8 @@ export type ERC20TransferParams = Prettify<{
 }>
 
 export type TokenboundClientOptions = Prettify<{
-  chainId: number
+  chainId?: number
+  chain?: Chain
   signer?: any
   walletClient?: WalletClient
   publicClient?: PublicClient

packages/sdk/src/utils/chainIdToChain.ts

@@ -1,17 +1,40 @@
-import * as allChains from "viem/chains"
-import { Chain } from "viem"
+import { Chain } from 'viem'
+import {
+  mainnet,
+  goerli,
+  polygon,
+  polygonMumbai,
+  sepolia,
+  optimism,
+  arbitrum,
+  base,
+  gnosis,
+} from 'viem/chains'
+
+const allChains = {
+  mainnet,
+  goerli,
+  polygon,
+  polygonMumbai,
+  sepolia,
+  optimism,
+  arbitrum,
+  base,
+  gnosis,
+}
 
 /**
  * Gets the chain object for the given chain id.
  * @param chainId - Chain id of the target EVM chain.
  * @returns Viem's chain object.
  */
+
 export function chainIdToChain(chainId: number): Chain {
   for (const chain of Object.values(allChains)) {
     if (chain.id === chainId) {
       return chain
     }
   }
-  
+
   throw new Error(`Chain with id ${chainId} not found`)
-}
+}