Merge pull request #58 from tokenbound/jw/create_account_chainid

Added chainId parameter to account functions
tokenbound · Nov 30, 2023 · 2c362fc · 2c362fc
2 parents e1b62da + f847c13
commit 2c362fc
Show file tree

Hide file tree

Showing 11 changed files with 198 additions and 151 deletions.
diff --git a/README.md b/README.md
diff --git a/examples/vite-wagmi-ethers-rainbowkit/package.json b/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.19.9",
+    "viem": "^1.19.11",
     "wagmi": "^1.4.7"
   },
   "devDependencies": {

diff --git a/examples/vite-wagmi-ethers/package.json b/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.19.9",
+    "viem": "^1.19.11",
     "wagmi": "^1.4.7"
   },
   "devDependencies": {

diff --git a/examples/vite-wagmi-ethers6/package.json b/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.19.9",
+    "viem": "^1.19.11",
     "wagmi": "^1.4.7"
   },
   "devDependencies": {

diff --git a/examples/vite-wagmi-viem/package.json b/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.19.9",
+    "viem": "^1.19.11",
     "wagmi": "^1.4.7"
   },
   "devDependencies": {

diff --git a/packages/sdk/package.json b/packages/sdk/package.json
@@ -25,7 +25,7 @@
     "wagmi": "wagmi generate"
   },
   "dependencies": {
-    "viem": "^1.19.9"
+    "viem": "^1.19.11"
   },
   "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.19.9",
+    "viem": "^1.19.11",
     "wagmi": "^1.4.7",
     "@viem/anvil": "^0.0.6",
     "vite": "^4.4.9",

diff --git a/packages/sdk/src/TokenboundClient.ts b/packages/sdk/src/TokenboundClient.ts
@@ -169,14 +169,14 @@ class TokenboundClient {
    * @returns The tokenbound account address.
    */
   public getAccount(params: GetAccountParams): `0x${string}` {
-    const { tokenContract, tokenId, salt = 0 } = params
+    const { tokenContract, tokenId, salt = 0, chainId = this.chainId } = params
 
     try {
       const getAcct = this.supportsV3 ? getTokenboundV3Account : computeAccount
       return getAcct(
         tokenContract,
         tokenId,
-        this.chainId,
+        chainId,
         this.implementationAddress,
         this.registryAddress,
         salt
@@ -200,14 +200,14 @@ class TokenboundClient {
         data: `0x${string}`
       }
   > {
-    const { tokenContract, tokenId, salt = 0, appendedCalls = [] } = params
+    const { tokenContract, tokenId, salt = 0, chainId = this.chainId, appendedCalls = [] } = params
 
     const getAcct = this.supportsV3 ? getTokenboundV3Account : computeAccount
 
     const computedAcct = getAcct(
       tokenContract,
       tokenId,
-      this.chainId,
+      chainId,
       this.implementationAddress,
       this.registryAddress,
       salt
@@ -225,7 +225,7 @@ class TokenboundClient {
     const preparedBasicCreateAccount = await prepareBasicCreateAccount(
       tokenContract,
       tokenId,
-      this.chainId,
+      chainId,
       this.implementationAddress,
       this.registryAddress,
       salt
@@ -283,7 +283,7 @@ class TokenboundClient {
   public async createAccount(
     params: CreateAccountParams
   ): Promise<{ account: `0x${string}`; txHash: `0x${string}` }> {
-    const { tokenContract, tokenId, salt = 0, appendedCalls = [] } = params
+    const { tokenContract, tokenId, salt = 0, chainId = this.chainId, appendedCalls = [] } = params
 
     try {
       let txHash: `0x${string}` | undefined
@@ -293,7 +293,7 @@ class TokenboundClient {
       const computedAcct = getAcct(
         tokenContract,
         tokenId,
-        this.chainId,
+        chainId,
         this.implementationAddress,
         this.registryAddress,
         salt
@@ -302,6 +302,7 @@ class TokenboundClient {
       const preparedCreateAccount = await this.prepareCreateAccount({
         tokenContract,
         tokenId,
+        chainId,
         salt,
         appendedCalls,
       })
@@ -323,7 +324,8 @@ class TokenboundClient {
               this.walletClient,
               this.implementationAddress,
               this.registryAddress,
-              salt
+              salt,
+              chainId
             )
       }
 

diff --git a/packages/sdk/src/functions/viemV2.ts b/packages/sdk/src/functions/viemV2.ts
@@ -121,7 +121,8 @@ export async function createAccount(
   client: WalletClient,
   implementationAddress?: `0x${string}`,
   registryAddress?: `0x${string}`,
-  salt?: number
+  salt?: number,
+  chainId?: number
 ): Promise<`0x${string}`> {
   salt = salt ?? 0
   const implementation = implementationAddress
@@ -137,7 +138,7 @@ export async function createAccount(
     walletClient: client,
   })
 
-  const chainId = await client.getChainId()
+  const _chainId = chainId || (await client.getChainId())
 
   const initData = encodeFunctionData({
     abi: [
@@ -154,7 +155,7 @@ export async function createAccount(
 
   return registry.write.createAccount([
     implementation,
-    chainId,
+    _chainId,
     tokenContract,
     tokenId,
     salt,

diff --git a/packages/sdk/src/test/TestAll.test.ts b/packages/sdk/src/test/TestAll.test.ts
@@ -19,9 +19,9 @@ import {
   getContract,
   encodeAbiParameters,
   parseAbiParameters,
+  isAddress,
 } from 'viem'
 import { privateKeyToAccount } from 'viem/accounts'
-import { CreateAccountParams, TokenboundClient } from '@tokenbound/sdk'
 import {
   ADDRESS_REGEX,
   ANVIL_ACCOUNTS,
@@ -43,6 +43,7 @@ import { ERC_6551_DEFAULT, ERC_6551_LEGACY_V2 } from '../constants'
 import { Call3, TBImplementationVersion, TBVersion } from '../types'
 import { JsonRpcSigner, JsonRpcProvider } from 'ethers6'
 import { erc20ABI } from 'wagmi'
+import { CreateAccountParams, TokenboundClient } from '@tokenbound/sdk'
 
 export const pool = Number(process.env.VITEST_POOL_ID ?? 1)
 
@@ -69,7 +70,7 @@ type TestConfig = {
   version?: TBImplementationVersion
 }
 
-const ENABLED_TESTS: Array<TestConfig> = [
+export const ENABLED_TESTS: Array<TestConfig> = [
   {
     testName: 'viem v2',
     walletClient,
@@ -286,6 +287,38 @@ describe.each(ENABLED_TESTS)(
       TIMEOUT
     )
 
+    it(
+      'can createAccount with a custom chainId',
+      async () => {
+        const HARDHAT_CHAIN_ID = 31337
+
+        const { account, txHash } = await tokenboundClient.createAccount({
+          ...NFT_IN_EOA,
+          chainId: HARDHAT_CHAIN_ID,
+        })
+        console.log('CREATED ACCT WITH CUSTOM CHAIN ID', account)
+
+        const createdAccountTxReceipt = await publicClient.waitForTransactionReceipt({
+          hash: txHash,
+        })
+
+        const bytecode = await tokenboundClient.deconstructBytecode({
+          accountAddress: account,
+        })
+
+        if (!bytecode) return false
+
+        const { chainId } = bytecode
+
+        console.log('CHAINID OF CREATED ACCT', chainId)
+
+        expect(isAddress(account)).toEqual(true)
+        expect(createdAccountTxReceipt.status).toBe('success')
+        expect(chainId).toBe(HARDHAT_CHAIN_ID)
+      },
+      TIMEOUT
+    )
+
     v3OnlyIt(
       'can createAccount and append multicall transaction(s) that use the deployed TBA',
       async () => {

diff --git a/packages/sdk/src/types/params.ts b/packages/sdk/src/types/params.ts
@@ -76,7 +76,11 @@ type Custom6551Implementation = Prettify<{
   salt?: number
 }>
 
-export type TBAccountParams = NFTParams
+export type TBAccountParams = Prettify<
+  NFTParams & {
+    chainId?: number
+  }
+>
 
 export type GetAccountParams = Prettify<
   TBAccountParams & Partial<Custom6551Implementation>