Switch wallet configuration to x-wallet-address (#126)

* Replace all server dbOperations with prisma

* Update all knex to prisma

* Fix sql

* getAll now returns all wallets, write uses x-wallet-address header

* Fix trigger

* checking out the different headers for write operations

* file storage

* force lowercase local wallet storage

* updating write functions with header value

* more write calls switching to txOverride

* fix some key names and add new writes

* way more writes

* more general improvements

* Fix nonce management

* Add import by private key, remove breaking tests

* Fix dbOperations

* Resolve merge conflicts

* Disable e2e testing temporarily

* Remove wallet type bug

* Update to run prisma commands on deploy

---------

Co-authored-by: furqanrydhan <furqan.rydhan@gmail.com>

Author: adam-maj

.dockerignore

@@ -5,9 +5,8 @@ Dockerfile
 .env
 yarn-error.log
 .husky
-scripts
 docker-compose*.yml
 Dockerfile
 .DS_Store
 swagger.yml
-e2e
+test

.env.benchmark.example

@@ -12,9 +12,10 @@
 
 THIRDWEB_API_SECRET_KEY = ""
 
-# At minimum, you need to configure a chain
+# At minimum, you need to configure a chain and a wallet address
 # ============================================================================= #
 BENCHMARK_CHAIN = "mumbai"
+BENCHMARK_WALLET_ADDRESS = ""
 
 # Then you can configure the contract address and function to call
 # NOTE: If you don't configure a contract address and function call, an ERC20

.github/workflows/e2eTest.yml

@@ -10,11 +10,12 @@ export POSTGRES_PASSWORD=postgres
 export POSTGRES_PORT=5432
 export POSTGRES_USE_SSL=false
 export WALLET_PRIVATE_KEY=0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
-export THIRDWEB_API_SECRET_KEY=klRsqmatrdlEpik_pHKgYy_q2YzGe3bTewO1VC26eY_H184Kc7xOVqKVj0mHwOOW2AOx2N-a3GqLCQ7Z9s9-sw
+# export THIRDWEB_API_SECRET_KEY=klRsqmatrdlEpik_pHKgYy_q2YzGe3bTewO1VC26eY_H184Kc7xOVqKVj0mHwOOW2AOx2N-a3GqLCQ7Z9s9-sw
 
 test-evm: FORCE
 	docker compose -f docker-compose-test.yml up -d
 	./test/e2e/hardhat/waitForHardhatNode.sh
+	yarn prisma:migrate
 	yarn test:all
 	docker compose -f docker-compose-test.yml down
 

Makefile

@@ -17,27 +17,3 @@ export const isValidHttpUrl = (urlString: string): boolean => {
 
   return url.protocol === "http:" || url.protocol === "https:";
 };
-
-export const getWalletType = (): string => {
-  if (WALLET_PRIVATE_KEY) {
-    return "ppk";
-  }
-
-  if (AWS_ACCESS_KEY_ID && AWS_SECRET_ACCESS_KEY && AWS_REGION) {
-    return "aws_kms";
-  }
-
-  if (
-    env.GOOGLE_APPLICATION_CREDENTIAL_EMAIL &&
-    env.GOOGLE_APPLICATION_CREDENTIAL_PRIVATE_KEY &&
-    env.GOOGLE_APPLICATION_PROJECT_ID &&
-    env.GOOGLE_KMS_KEY_RING_ID &&
-    env.GOOGLE_KMS_KEY_VERSION_ID &&
-    env.GOOGLE_KMS_LOCATION_ID
-  ) {
-    return "aws_kms";
-  }
-
-  // ToDo GCP KMS
-  return "local";
-};

core/helpers/index.ts

@@ -36,3 +36,9 @@ export const networkResponseSchema = Type.Object({
     description: "Chain slug",
   }),
 });
+
+export const walletAuthSchema = Type.Object({
+  "x-wallet-address": Type.String({
+    description: "Wallet address",
+  }),
+});

core/schema/index.ts

@@ -24,7 +24,7 @@ export class LocalFileStorage implements AsyncStorage {
 
   getKey(): string {
     if (this.walletAddress) {
-      return `localWallet-${this.walletAddress}`;
+      return `localWallet-${this.walletAddress.toLowerCase()}`;
     }
     throw new Error("Wallet Address not set");
   }
@@ -246,11 +246,14 @@ export const getSDK = async (
     //TODO get private key from encrypted file
     wallet = new LocalWallet({
       chain,
-      storage: new LocalFileStorage(walletAddress),
     });
+    console.log(
+      `Loading local wallet for address ${walletAddress} with key ${THIRDWEB_API_SECRET_KEY}`,
+    );
     await wallet.load({
       strategy: "encryptedJson",
       password: THIRDWEB_API_SECRET_KEY,
+      storage: new LocalFileStorage(walletAddress),
     });
     sdk = await ThirdwebSDK.fromWallet(wallet, chain, {
       secretKey: THIRDWEB_API_SECRET_KEY,

core/sdk/sdk.ts

@@ -9,12 +9,14 @@
   "scripts": {
     "docker": "docker compose --env-file ./.env up --remove-orphans",
     "docker:build": "docker compose build --no-cache",
-    "dev": "yarn dev:infra && yarn dev:server & sleep 10 && yarn dev:worker",
-    "dev:server": "nodemon --watch 'server/**/*.ts' --watch 'core/**/*.ts' --exec 'npx tsx ./server/index.ts' --files server/index.ts",
-    "dev:worker": "nodemon --watch 'worker/**/*.ts' --watch 'core/**/*.ts' --exec 'npx tsx ./worker/index.ts' --files worker/index.ts",
+    "dev": "yarn dev:infra && yarn prisma:init && yarn dev:server & sleep 10 && yarn dev:worker",
+    "dev:server": "yarn prisma:init && nodemon --watch 'server/**/*.ts' --watch 'core/**/*.ts' --exec 'npx tsx ./server/index.ts' --files server/index.ts",
+    "dev:worker": "yarn prisma:init && nodemon --watch 'worker/**/*.ts' --watch 'core/**/*.ts' --exec 'npx tsx ./worker/index.ts' --files worker/index.ts",
     "dev:infra": "docker compose -f ./docker-compose-infra.yml up -d",
     "build": "yarn && rm -rf dist && tsc -p ./tsconfig.json --outDir dist",
-    "start": "yarn start:server & sleep 20 && yarn start:worker",
+    "prisma:reset": "prisma migrate reset --force && prisma generate",
+    "prisma:init": "prisma migrate deploy && prisma generate",
+    "start": "yarn prisma:init && yarn start:server & sleep 20 && yarn start:worker",
     "start:server": "node --experimental-specifier-resolution=node ./dist/server/index.js",
     "start:worker": "node --experimental-specifier-resolution=node ./dist/worker/index.js",
     "start:docker": "docker compose build && docker compose --env-file ./.env up --remove-orphans",

package.json

@@ -2,13 +2,14 @@ import { Static, Type } from "@sinclair/typebox";
 import { FastifyInstance } from "fastify";
 import { StatusCodes } from "http-status-codes";
 import { getContractInstance } from "../../../../../../core";
+import { walletAuthSchema } from "../../../../../../core/schema";
 import { queueTx } from "../../../../../../src/db/transactions/queueTx";
 import {
   erc1155ContractParamSchema,
   standardResponseSchema,
   transactionWritesResponseSchema,
 } from "../../../../../helpers/sharedApiSchemas";
-import { web3APIOverridesForWriteRequest } from "../../../../../schemas/web3api-overrides";
+import { txOverridesForWriteRequest } from "../../../../../schemas/web3api-overrides";
 import { getChainIdFromChain } from "../../../../../utilities/chain";
 
 // INPUTS
@@ -28,7 +29,7 @@ const requestBodySchema = Type.Object({
       description: "Addresses and quantities to airdrop to",
     },
   ),
-  ...web3APIOverridesForWriteRequest.properties,
+  ...txOverridesForWriteRequest.properties,
 });
 
 requestBodySchema.examples = [
@@ -44,9 +45,6 @@ requestBodySchema.examples = [
         quantity: "1",
       },
     ],
-    web3api_overrides: {
-      from: "0x...",
-    },
   },
 ];
 
@@ -64,20 +62,22 @@ export async function erc1155airdrop(fastify: FastifyInstance) {
       operationId: "erc1155_airdrop",
       params: requestSchema,
       body: requestBodySchema,
+      headers: walletAuthSchema,
       response: {
         ...standardResponseSchema,
         [StatusCodes.OK]: transactionWritesResponseSchema,
       },
     },
     handler: async (request, reply) => {
       const { network, contract_address } = request.params;
-      const { token_id, addresses, web3api_overrides } = request.body;
+      const { token_id, addresses, tx_overrides } = request.body;
+      const walletAddress = request.headers["x-wallet-address"] as string;
       const chainId = getChainIdFromChain(network);
 
       const contract = await getContractInstance(
         network,
         contract_address,
-        web3api_overrides?.from,
+        walletAddress,
       );
       const tx = await contract.erc1155.airdrop.prepare(token_id, addresses);
       const queuedId = await queueTx({ tx, chainId, extension: "erc1155" });

server/api/contract/extensions/erc1155/write/airdrop.ts

@@ -2,13 +2,14 @@ import { Static, Type } from "@sinclair/typebox";
 import { FastifyInstance } from "fastify";
 import { StatusCodes } from "http-status-codes";
 import { getContractInstance } from "../../../../../../core";
+import { walletAuthSchema } from "../../../../../../core/schema";
 import { queueTx } from "../../../../../../src/db/transactions/queueTx";
 import {
   erc1155ContractParamSchema,
   standardResponseSchema,
   transactionWritesResponseSchema,
 } from "../../../../../helpers/sharedApiSchemas";
-import { web3APIOverridesForWriteRequest } from "../../../../../schemas/web3api-overrides";
+import { txOverridesForWriteRequest } from "../../../../../schemas/web3api-overrides";
 import { getChainIdFromChain } from "../../../../../utilities/chain";
 
 // INPUTS
@@ -20,16 +21,13 @@ const requestBodySchema = Type.Object({
   amount: Type.String({
     description: "The amount of tokens to burn",
   }),
-  ...web3APIOverridesForWriteRequest.properties,
+  ...txOverridesForWriteRequest.properties,
 });
 
 requestBodySchema.examples = [
   {
     token_id: "0",
     amount: "1",
-    web3api_overrides: {
-      from: "0x...",
-    },
   },
 ];
 
@@ -47,20 +45,22 @@ export async function erc1155burn(fastify: FastifyInstance) {
       operationId: "erc1155_burn",
       params: requestSchema,
       body: requestBodySchema,
+      headers: walletAuthSchema,
       response: {
         ...standardResponseSchema,
         [StatusCodes.OK]: transactionWritesResponseSchema,
       },
     },
     handler: async (request, reply) => {
       const { network, contract_address } = request.params;
-      const { token_id, amount, web3api_overrides } = request.body;
+      const { token_id, amount, tx_overrides } = request.body;
+      const walletAddress = request.headers["x-wallet-address"] as string;
       const chainId = getChainIdFromChain(network);
 
       const contract = await getContractInstance(
         network,
         contract_address,
-        web3api_overrides?.from,
+        walletAddress,
       );
       const tx = await contract.erc1155.burn.prepare(token_id, amount);
       const queuedId = await queueTx({ tx, chainId, extension: "erc1155" });