Testjam error fixes (#124)

* fixed Jorge worker error

* readme update for swagger UI for Docker Image

* added examples for end-points

Author: farhanW3

docs/UserGuide.md

@@ -21,6 +21,7 @@
 
 1. Create a `.env` file based off `.env.example` with all the variables filled in.
 2. Update the `THIRDWEB_API_SECRET_KEY` value on the `.env` file
+3. Update the `POSTGRES_CONNECTION_URL` value on the `.env` file
 
 ### PostgreSQL DB
 
@@ -79,9 +80,18 @@ For updates on your requests, you can either poll using the `get` (`/tranasction
 3. Run the below command
    <br />
    ```
-   docker run -e .env -p 3005:3005 thirdweb/web3-api:latest
+   docker run -e .env -p 3005:3005 thirdweb/web3-api:nightly
+   # check other images at https://hub.docker.com/r/thirdweb/web3-api/tags
    ```
 
+### Note:
+
+To access the Swagger UI locally on `http://localhost:3005/` when using the docker image, you need to update add the following to the `.env` file:
+
+```
+NODE_ENV=development
+```
+
 <details>
  <summary>Run on a Server (EC2 Instance/Google Compute/VM) </summary>
 
@@ -134,9 +144,8 @@ We use `docker-compose-infra.yml` to spin up the supporting infra services, a po
 
 1. Clone the Repo
 2. Check [Setup Instruction section](#setup-instructions) to update the `.env` file
-3. Check [Advance Setup : PostgreSQL DB](#advance-setup--postgresql-db) section to update the `.env` file
-4. Run: `yarn install`
-5. Run: `yarn dev:server & yarn dev:worker`
+3. Run: `yarn install`
+4. Run: `yarn dev:server & yarn dev:worker`
 
 The API defaults to `http://localhost:3005`
 
@@ -161,4 +170,14 @@ We use `docker-compose.yml` to spin up the API Server & Worker along with suppor
 
 The API defaults to `http://localhost:3005`
 
+To access the Swagger UI locally on `http://localhost:3005/` when using the docker image, you need to update add the following to the `.env` file:
+
+### Note:
+
+To access the Swagger UI locally on `http://localhost:3005/` when using the docker image, you need to update add the following to the `.env` file:
+
+```
+NODE_ENV=development
+```
+
 </details>

server/api/wallet/addWallet.ts

@@ -16,7 +16,7 @@ import { WalletConfigType } from "../../schemas/wallet";
 const requestBodySchema = Type.Object({
   walletType: Type.String({
     description: "Wallet Type",
-    examples: ["aws_kms", "gcp_kms"],
+    examples: ["aws_kms", "gcp_kms", "local"],
   }),
   awsKMS: Type.Optional(
     Type.Object({
@@ -46,6 +46,23 @@ const requestBodySchema = Type.Object({
   ),
 });
 
+requestBodySchema.examples = [
+  {
+    walletTye: "aws_kms",
+    awsKMS: {
+      keyId: "12345678-1234-1234-1234-123456789012",
+      arn: "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012",
+    },
+  },
+  {
+    walletTye: "gcp_kms",
+    gcpKMS: {
+      keyId: "12345678-1234-1234-1234-123456789012",
+      versionId: "1",
+    },
+  },
+];
+
 // OUTPUT
 const responseSchema = Type.Object({
   result: Type.Object({

server/api/wallet/createEOAWallet.ts

@@ -24,6 +24,15 @@ const requestBodySchema = Type.Object({
   }),
 });
 
+requestBodySchema.examples = [
+  {
+    walletType: "aws_kms",
+  },
+  {
+    walletType: "gcp_kms",
+  },
+];
+
 // OUTPUT
 const responseSchema = Type.Object({
   result: Type.Object({

worker/controller/processTransaction.ts

@@ -111,7 +111,7 @@ export const processTransaction = async (
           "errored",
           trx,
           undefined,
-          error.message,
+          { errorMessage: error.message },
         );
         await trx.commit();
         await trx.destroy();