Support tuple types for thirdweb deploy (#436)

* support tuples in constructor params

* better function sig for tuples

Author: joaquim-verges

etc/sdk.api.md

@@ -1785,6 +1785,10 @@ export enum EventType {
 export function extractConstructorParams(predeployMetadataUri: string, storage: IStorage): Promise<{
     [x: string]: any;
     stateMutability?: string | undefined;
+    components?: {
+        name: string;
+        type: string;
+    }[] | undefined;
     name: string;
     type: string;
 }[]>;
@@ -1795,6 +1799,10 @@ export function extractConstructorParams(predeployMetadataUri: string, storage:
 export function extractConstructorParamsFromAbi(abi: z.input<typeof AbiSchema>): {
     [x: string]: any;
     stateMutability?: string | undefined;
+    components?: {
+        name: string;
+        type: string;
+    }[] | undefined;
     name: string;
     type: string;
 }[];

src/common/feature-detection.ts

@@ -4,6 +4,7 @@ import { IStorage } from "../core";
 import {
   AbiFunction,
   AbiSchema,
+  AbiTypeSchema,
   PreDeployMetadata,
   PreDeployMetadataFetched,
   PublishedMetadata,
@@ -90,11 +91,10 @@ export function extractFunctionsFromAbi(
   const parsed = [];
   for (const f of functions) {
     const args =
-      f.inputs
-        ?.map((i) => `${i.name || "key"}: ${toJSType(i.type)}`)
-        ?.join(", ") || "";
+      f.inputs?.map((i) => `${i.name || "key"}: ${toJSType(i)}`)?.join(", ") ||
+      "";
     const fargs = args ? `, ${args}` : "";
-    const out = f.outputs?.map((o) => toJSType(o.type, true))?.join(", ");
+    const out = f.outputs?.map((o) => toJSType(o, true))?.join(", ");
     const promise = out ? `: Promise<${out}>` : `: Promise<TransactionResult>`;
     const signature = `contract.call("${f.name}"${fargs})${promise}`;
     parsed.push({
@@ -108,23 +108,42 @@ export function extractFunctionsFromAbi(
   return parsed;
 }
 
-function toJSType(contractType: string, isReturnType = false): string {
-  let jsType = contractType;
-  if (contractType.startsWith("bytes")) {
+function toJSType(
+  contractType: z.input<typeof AbiTypeSchema>,
+  isReturnType = false,
+  withName = false,
+): string {
+  let jsType = contractType.type;
+  let isArray = false;
+  if (jsType.endsWith("[]")) {
+    isArray = true;
+    jsType = jsType.slice(0, -2);
+  }
+  if (jsType.startsWith("bytes")) {
     jsType = "BytesLike";
   }
-  if (contractType.startsWith("uint") || contractType.startsWith("int")) {
+  if (jsType.startsWith("uint") || jsType.startsWith("int")) {
     jsType = isReturnType ? "BigNumber" : "BigNumberish";
   }
-  if (contractType === "bool") {
+  if (jsType.startsWith("bool")) {
     jsType = "boolean";
   }
-  if (contractType === "address") {
+  if (jsType === "address") {
     jsType = "string";
   }
-  if (contractType.endsWith("[]")) {
+  if (jsType === "tuple") {
+    if (contractType.components) {
+      jsType = `{ ${contractType.components
+        .map((a) => toJSType(a, false, true))
+        .join(", ")} }`;
+    }
+  }
+  if (isArray) {
     jsType += "[]";
   }
+  if (withName) {
+    jsType = `${contractType.name}: ${jsType}`;
+  }
   return jsType;
 }
 

src/contracts/smart-contract.ts

@@ -203,7 +203,6 @@ export class SmartContract<
    * ********************/
 
   private detectRoyalties() {
-    // TODO (byoc) change to ThirdwebContract
     if (
       detectContractFeature<IRoyalty & ThirdwebContract>(
         this.contractWrapper,

src/core/classes/contract-publisher.ts

@@ -276,7 +276,7 @@ export class ContractPublisher extends RPCConnectionHandler {
       throw Error("Passed the wrong number of constructor arguments");
     }
     return constructorParamTypes.map((p, index) => {
-      if (p.endsWith("[]")) {
+      if (p === "tuple" || p.endsWith("[]")) {
         if (typeof constructorParamValues[index] === "string") {
           return JSON.parse(constructorParamValues[index]);
         } else {

src/schema/contracts/custom.ts

@@ -69,13 +69,18 @@ export type PreDeployMetadataFetched = {
 /**
  * @internal
  */
-export const AbiTypeSchema = z
-  .object({
-    type: z.string(),
-    name: z.string(),
-    stateMutability: z.string().optional(),
-  })
-  .catchall(z.any());
+const AbiTypeBaseSchema = z.object({
+  type: z.string(),
+  name: z.string(),
+});
+
+/**
+ * @internal
+ */
+export const AbiTypeSchema = AbiTypeBaseSchema.extend({
+  stateMutability: z.string().optional(),
+  components: z.array(AbiTypeBaseSchema).optional(),
+}).catchall(z.any());
 
 /**
  * @internal

test/publisher.test.ts

@@ -5,6 +5,7 @@ import { IpfsStorage, isFeatureEnabled, ThirdwebSDK } from "../src";
 import { SignerWithAddress } from "@nomiclabs/hardhat-ethers/signers";
 import invariant from "tiny-invariant";
 import { DropERC721__factory, TokenERC721__factory } from "../typechain";
+import { ethers } from "ethers";
 
 global.fetch = require("cross-fetch");
 
@@ -134,7 +135,6 @@ describe("Publishing", async () => {
     const all = await publisher.getAll(bobWallet.address);
     expect(all.length).to.be.eq(1);
   });
-
   it("should publish batch contracts", async () => {
     const publisher = await sdk.getPublisher();
     const tx = await publisher.publishBatch([
@@ -188,4 +188,30 @@ describe("Publishing", async () => {
     const all = await c.nft.query.all();
     expect(all.length).to.eq(1);
   });
+
+  it("Constructor params with tuples", async () => {
+    const realSDK = new ThirdwebSDK(adminWallet);
+    const pub = await realSDK.getPublisher();
+    const ipfsUri = "ipfs://QmZQa56Cj1gFnZgKSkvGE5uzhaQrQV3nU6upDWDusCaCwY/0";
+    const addr = await pub.deployContract(ipfsUri, [
+      "0x1234",
+      "123",
+      JSON.stringify(["0x1234", "0x4567"]),
+      JSON.stringify([
+        213,
+        ethers.utils.hexZeroPad("0x1234", 32),
+        [adminWallet.address, samWallet.address],
+      ]),
+    ]);
+    const c = await sdk.getContract(addr);
+    const uri = await c.call("contractUri");
+    expect(uri).to.eq(ethers.utils.hexZeroPad("0x1234", 32));
+
+    const tx = await c.call("updateStruct", {
+      aNumber: 123,
+      aString: ethers.utils.hexZeroPad("0x1234", 32),
+      anArray: [adminWallet.address, samWallet.address],
+    });
+    expect(tx).to.not.eq(undefined);
+  });
 });