Updates: Schemas, Naming, Tx Override, Packages (#536)

* updated backend-wallet end-point to not accept xAccountAddress

* updates to help with build issue & vulnerability

* updates: casing, schema def, txOverrides usage

* Updated types which fixes SDK too

* Readme updates

* updated wallet schema naming

Author: farhanW3

README.md

@@ -40,6 +40,10 @@ Engine is an open-source, backend HTTP server that provides a production-ready i
 
 ## Get Engine
 
+### Cloud-host
+
+[Get Engine hosted and managed by thirdweb](https://thirdweb.com/dashboard/engine?requestCloudHosted).
+
 ### Self-host
 
 Host Engine on your own instructure for free. [View self-host instructions](https://portal.thirdweb.com/engine/self-host).
@@ -48,10 +52,6 @@ Other deployment options:
 
 [![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/fcEVay)
 
-### Cloud-host
-
-[Get Engine hosted and managed by thirdweb](https://thirdweb.com/dashboard/engine?requestCloudHosted).
-
 ## Contributing
 
 We welcome contributions! See [How to contribute](./contributing.md).

src/server/routes/auth/access-tokens/create.ts

@@ -11,11 +11,11 @@ import { env } from "../../../../utils/env";
 import { standardResponseSchema } from "../../../schemas/sharedApiSchemas";
 import { AccessTokenSchema } from "./getAll";
 
-const BodySchema = Type.Object({
+const requestBodySchema = Type.Object({
   label: Type.Optional(Type.String()),
 });
 
-const ReplySchema = Type.Object({
+const responseBodySchema = Type.Object({
   result: Type.Composite([
     AccessTokenSchema,
     Type.Object({
@@ -26,8 +26,8 @@ const ReplySchema = Type.Object({
 
 export async function createAccessToken(fastify: FastifyInstance) {
   fastify.route<{
-    Body: Static<typeof BodySchema>;
-    Reply: Static<typeof ReplySchema>;
+    Body: Static<typeof requestBodySchema>;
+    Reply: Static<typeof responseBodySchema>;
   }>({
     method: "POST",
     url: "/auth/access-tokens/create",
@@ -36,10 +36,10 @@ export async function createAccessToken(fastify: FastifyInstance) {
       description: "Create a new access token",
       tags: ["Access Tokens"],
       operationId: "create",
-      body: BodySchema,
+      body: requestBodySchema,
       response: {
         ...standardResponseSchema,
-        [StatusCodes.OK]: ReplySchema,
+        [StatusCodes.OK]: responseBodySchema,
       },
     },
     handler: async (req, res) => {

src/server/routes/auth/access-tokens/getAll.ts

@@ -13,13 +13,13 @@ export const AccessTokenSchema = Type.Object({
   label: Type.Union([Type.String(), Type.Null()]),
 });
 
-const ReplySchema = Type.Object({
+const responseBodySchema = Type.Object({
   result: Type.Array(AccessTokenSchema),
 });
 
 export async function getAllAccessTokens(fastify: FastifyInstance) {
   fastify.route<{
-    Reply: Static<typeof ReplySchema>;
+    Reply: Static<typeof responseBodySchema>;
   }>({
     method: "GET",
     url: "/auth/access-tokens/get-all",
@@ -30,7 +30,7 @@ export async function getAllAccessTokens(fastify: FastifyInstance) {
       operationId: "getAll",
       response: {
         ...standardResponseSchema,
-        [StatusCodes.OK]: ReplySchema,
+        [StatusCodes.OK]: responseBodySchema,
       },
     },
     handler: async (req, res) => {

src/server/routes/auth/access-tokens/revoke.ts

@@ -5,20 +5,20 @@ import { revokeToken } from "../../../../db/tokens/revokeToken";
 import { accessTokenCache } from "../../../../utils/cache/accessToken";
 import { standardResponseSchema } from "../../../schemas/sharedApiSchemas";
 
-const BodySchema = Type.Object({
+const requestBodySchema = Type.Object({
   id: Type.String(),
 });
 
-const ReplySchema = Type.Object({
+const responseBodySchema = Type.Object({
   result: Type.Object({
     success: Type.Boolean(),
   }),
 });
 
 export async function revokeAccessToken(fastify: FastifyInstance) {
   fastify.route<{
-    Body: Static<typeof BodySchema>;
-    Reply: Static<typeof ReplySchema>;
+    Body: Static<typeof requestBodySchema>;
+    Reply: Static<typeof responseBodySchema>;
   }>({
     method: "POST",
     url: "/auth/access-tokens/revoke",
@@ -27,10 +27,10 @@ export async function revokeAccessToken(fastify: FastifyInstance) {
       description: "Revoke an access token",
       tags: ["Access Tokens"],
       operationId: "revoke",
-      body: BodySchema,
+      body: requestBodySchema,
       response: {
         ...standardResponseSchema,
-        [StatusCodes.OK]: ReplySchema,
+        [StatusCodes.OK]: responseBodySchema,
       },
     },
     handler: async (req, res) => {

src/server/routes/auth/access-tokens/update.ts

@@ -5,21 +5,21 @@ import { updateToken } from "../../../../db/tokens/updateToken";
 import { accessTokenCache } from "../../../../utils/cache/accessToken";
 import { standardResponseSchema } from "../../../schemas/sharedApiSchemas";
 
-const BodySchema = Type.Object({
+const requestBodySchema = Type.Object({
   id: Type.String(),
   label: Type.Optional(Type.String()),
 });
 
-const ReplySchema = Type.Object({
+const responseBodySchema = Type.Object({
   result: Type.Object({
     success: Type.Boolean(),
   }),
 });
 
 export async function updateAccessToken(fastify: FastifyInstance) {
   fastify.route<{
-    Body: Static<typeof BodySchema>;
-    Reply: Static<typeof ReplySchema>;
+    Body: Static<typeof requestBodySchema>;
+    Reply: Static<typeof responseBodySchema>;
   }>({
     method: "POST",
     url: "/auth/access-tokens/update",
@@ -28,10 +28,10 @@ export async function updateAccessToken(fastify: FastifyInstance) {
       description: "Update an access token",
       tags: ["Access Tokens"],
       operationId: "update",
-      body: BodySchema,
+      body: requestBodySchema,
       response: {
         ...standardResponseSchema,
-        [StatusCodes.OK]: ReplySchema,
+        [StatusCodes.OK]: responseBodySchema,
       },
     },
     handler: async (req, res) => {

src/server/routes/auth/keypair/add.ts

@@ -12,7 +12,7 @@ import {
 } from "../../../schemas/keypairs";
 import { standardResponseSchema } from "../../../schemas/sharedApiSchemas";
 
-const BodySchema = Type.Object({
+const requestBodySchema = Type.Object({
   publicKey: Type.String({
     description:
       "The public key of your keypair beginning with '-----BEGIN PUBLIC KEY-----'.",
@@ -21,16 +21,16 @@ const BodySchema = Type.Object({
   label: Type.Optional(Type.String()),
 });
 
-const ReplySchema = Type.Object({
+const responseBodySchema = Type.Object({
   result: Type.Object({
     keypair: KeypairSchema,
   }),
 });
 
 export async function addKeypair(fastify: FastifyInstance) {
   fastify.route<{
-    Body: Static<typeof BodySchema>;
-    Reply: Static<typeof ReplySchema>;
+    Body: Static<typeof requestBodySchema>;
+    Reply: Static<typeof responseBodySchema>;
   }>({
     method: "POST",
     url: "/auth/keypair/add",
@@ -39,10 +39,10 @@ export async function addKeypair(fastify: FastifyInstance) {
       description: "Add the public key for a keypair",
       tags: ["Keypair"],
       operationId: "add",
-      body: BodySchema,
+      body: requestBodySchema,
       response: {
         ...standardResponseSchema,
-        [StatusCodes.OK]: ReplySchema,
+        [StatusCodes.OK]: responseBodySchema,
       },
     },
     handler: async (req, res) => {

src/server/routes/auth/keypair/list.ts

@@ -5,13 +5,13 @@ import { listKeypairs } from "../../../../db/keypair/list";
 import { KeypairSchema, toKeypairSchema } from "../../../schemas/keypairs";
 import { standardResponseSchema } from "../../../schemas/sharedApiSchemas";
 
-const ReplySchema = Type.Object({
+const responseBodySchema = Type.Object({
   result: Type.Array(KeypairSchema),
 });
 
 export async function listPublicKeys(fastify: FastifyInstance) {
   fastify.route<{
-    Reply: Static<typeof ReplySchema>;
+    Reply: Static<typeof responseBodySchema>;
   }>({
     method: "GET",
     url: "/auth/keypair/get-all",
@@ -22,7 +22,7 @@ export async function listPublicKeys(fastify: FastifyInstance) {
       operationId: "list",
       response: {
         ...standardResponseSchema,
-        [StatusCodes.OK]: ReplySchema,
+        [StatusCodes.OK]: responseBodySchema,
       },
     },
     handler: async (req, res) => {

src/server/routes/auth/keypair/remove.ts

@@ -5,20 +5,20 @@ import { deleteKeypair } from "../../../../db/keypair/delete";
 import { keypairCache } from "../../../../utils/cache/keypair";
 import { standardResponseSchema } from "../../../schemas/sharedApiSchemas";
 
-const BodySchema = Type.Object({
+const requestBodySchema = Type.Object({
   hash: Type.String(),
 });
 
-const ReplySchema = Type.Object({
+const responseBodySchema = Type.Object({
   result: Type.Object({
     success: Type.Boolean(),
   }),
 });
 
 export async function removePublicKey(fastify: FastifyInstance) {
   fastify.route<{
-    Body: Static<typeof BodySchema>;
-    Reply: Static<typeof ReplySchema>;
+    Body: Static<typeof requestBodySchema>;
+    Reply: Static<typeof responseBodySchema>;
   }>({
     method: "POST",
     url: "/auth/keypair/remove",
@@ -27,10 +27,10 @@ export async function removePublicKey(fastify: FastifyInstance) {
       description: "Remove the public key for a keypair",
       tags: ["Keypair"],
       operationId: "remove",
-      body: BodySchema,
+      body: requestBodySchema,
       response: {
         ...standardResponseSchema,
-        [StatusCodes.OK]: ReplySchema,
+        [StatusCodes.OK]: responseBodySchema,
       },
     },
     handler: async (req, res) => {

src/server/routes/auth/permissions/getAll.ts

@@ -4,7 +4,7 @@ import { StatusCodes } from "http-status-codes";
 import { prisma } from "../../../../db/client";
 import { standardResponseSchema } from "../../../schemas/sharedApiSchemas";
 
-const ReplySchema = Type.Object({
+const responseBodySchema = Type.Object({
   result: Type.Array(
     Type.Object({
       walletAddress: Type.String(),
@@ -16,7 +16,7 @@ const ReplySchema = Type.Object({
 
 export async function getAllPermissions(fastify: FastifyInstance) {
   fastify.route<{
-    Reply: Static<typeof ReplySchema>;
+    Reply: Static<typeof responseBodySchema>;
   }>({
     method: "GET",
     url: "/auth/permissions/get-all",
@@ -27,7 +27,7 @@ export async function getAllPermissions(fastify: FastifyInstance) {
       operationId: "getAll",
       response: {
         ...standardResponseSchema,
-        [StatusCodes.OK]: ReplySchema,
+        [StatusCodes.OK]: responseBodySchema,
       },
     },
     handler: async (req, res) => {

src/server/routes/auth/permissions/grant.ts

@@ -2,25 +2,25 @@ import { Static, Type } from "@sinclair/typebox";
 import { FastifyInstance } from "fastify";
 import { StatusCodes } from "http-status-codes";
 import { updatePermissions } from "../../../../db/permissions/updatePermissions";
-import { PermissionsSchema } from "../../../schemas/auth";
+import { permissionsSchema } from "../../../schemas/auth";
 import { standardResponseSchema } from "../../../schemas/sharedApiSchemas";
 
-const BodySchema = Type.Object({
+const requestBodySchema = Type.Object({
   walletAddress: Type.String(),
-  permissions: PermissionsSchema,
+  permissions: permissionsSchema,
   label: Type.Optional(Type.String()),
 });
 
-const ReplySchema = Type.Object({
+const responseBodySchema = Type.Object({
   result: Type.Object({
     success: Type.Boolean(),
   }),
 });
 
 export async function grantPermissions(fastify: FastifyInstance) {
   fastify.route<{
-    Body: Static<typeof BodySchema>;
-    Reply: Static<typeof ReplySchema>;
+    Body: Static<typeof requestBodySchema>;
+    Reply: Static<typeof responseBodySchema>;
   }>({
     method: "POST",
     url: "/auth/permissions/grant",
@@ -29,10 +29,10 @@ export async function grantPermissions(fastify: FastifyInstance) {
       description: "Grant permissions to a user",
       tags: ["Permissions"],
       operationId: "grant",
-      body: BodySchema,
+      body: requestBodySchema,
       response: {
         ...standardResponseSchema,
-        [StatusCodes.OK]: ReplySchema,
+        [StatusCodes.OK]: responseBodySchema,
       },
     },
     handler: async (req, res) => {