Merge pull request #81 from relayprotocol/add-configs-api

feat: add configs api

Author: georgeroman

src/api/index.ts

@@ -12,6 +12,7 @@ import actionsSolverRefundsV1 from "./actions/solver-refunds/v1";
 import queriesBalanceLocksV1 from "./queries/balance-locks/v1";
 import queriesBalancesV1 from "./queries/balances/v1";
 import queriesChainsV1 from "./queries/chains/v1";
+import queriesConfigsV1 from "./queries/configs/v1";
 import queriesWithdrawalRequestsV1 from "./queries/withdrawal-requests/v1";
 
 // Requests
@@ -27,6 +28,7 @@ const endpoints = [
   queriesBalanceLocksV1,
   queriesBalancesV1,
   queriesChainsV1,
+  queriesConfigsV1,
   queriesWithdrawalRequestsV1,
   requestsUnlocksV1,
   requestsWithdrawalsV1,

src/api/queries/chains/v1.ts

@@ -6,7 +6,11 @@ import {
   FastifyReplyTypeBox,
   FastifyRequestTypeBox,
 } from "../../utils";
-import { getAllocatorForChain, getChains } from "../../../common/chains";
+import {
+  getChains,
+  getOffchainAllocatorForChain,
+  getOnchainAllocatorForChain,
+} from "../../../common/chains";
 
 const Schema = {
   response: {
@@ -34,6 +38,11 @@ const Schema = {
           allocator: Type.Optional(
             Type.String({ description: "The allocator address for the chain" })
           ),
+          allocatorMode: Type.Optional(
+            Type.Union([Type.Literal("offchain"), Type.Literal("onchain")], {
+              description: "The vm type of the chain",
+            })
+          ),
         }),
         {
           description: "A list of supported chains",
@@ -57,13 +66,19 @@ export default {
     return reply.status(200).send({
       chains: await Promise.all(
         Object.keys(chains).map(async (id) => {
+          const allocatorMode = chains[id].metadata.allocatorChainId
+            ? "onchain"
+            : "offchain";
           return {
             id,
             vmType: chains[id].vmType,
             depository: chains[id].depository,
             allocator: chains[id].depository
-              ? await getAllocatorForChain(id)
+              ? allocatorMode === "offchain"
+                ? await getOffchainAllocatorForChain(id)
+                : await getOnchainAllocatorForChain(id)
               : undefined,
+            allocatorMode,
           };
         })
       ),

src/api/queries/configs/v1.ts

@@ -0,0 +1,45 @@
+import { Type } from "@fastify/type-provider-typebox";
+
+import {
+  Endpoint,
+  ErrorResponse,
+  FastifyReplyTypeBox,
+  FastifyRequestTypeBox,
+} from "../../utils";
+import { getOnchainAllocator } from "../../../utils/onchain-allocator";
+
+const Schema = {
+  response: {
+    200: Type.Object({
+      configs: Type.Object(
+        {
+          onchainAllocatorSender: Type.String({
+            description: "The wallet sending onchain allocation requests",
+          }),
+        },
+        {
+          description: "Current configuration settings",
+        }
+      ),
+    }),
+    ...ErrorResponse,
+  },
+};
+
+export default {
+  method: "GET",
+  url: "/queries/configs/v1",
+  schema: Schema,
+  handler: async (
+    _req: FastifyRequestTypeBox<typeof Schema>,
+    reply: FastifyReplyTypeBox<typeof Schema>
+  ) => {
+    const { walletClient } = await getOnchainAllocator();
+
+    return reply.status(200).send({
+      configs: {
+        onchainAllocatorSender: walletClient.account.address.toLowerCase(),
+      },
+    });
+  },
+} as Endpoint;

src/api/queries/withdrawal-requests/v1.ts

@@ -6,8 +6,11 @@ import {
   FastifyReplyTypeBox,
   FastifyRequestTypeBox,
 } from "../../utils";
-import { getAllocatorForChain } from "../../../common/chains";
-import { getSignature, getSigner } from "../../../utils/onchain-allocator";
+import {
+  getOffchainAllocatorForChain,
+  getOnchainAllocatorForChain,
+} from "../../../common/chains";
+import { getSignature } from "../../../utils/onchain-allocator";
 import { getPendingWithdrawalRequestsByOwner } from "../../../models/withdrawal-requests";
 
 const Schema = {
@@ -67,11 +70,11 @@ export default {
           let signature: string | undefined;
           if (w.payloadId) {
             // Signed using "onchain" mode, signature might be available onchain
-            signer = await getSigner(w.chainId);
+            signer = await getOnchainAllocatorForChain(w.chainId);
             signature = await getSignature(w.id);
           } else {
             // Signed using "offchain" mode, signature already available
-            signer = await getAllocatorForChain(w.chainId);
+            signer = await getOffchainAllocatorForChain(w.chainId);
             signature = w.signature;
           }
 

src/common/aws.ts

@@ -1,5 +1,5 @@
-import { Signer } from '@aws-sdk/rds-signer';
-import { fromNodeProviderChain } from '@aws-sdk/credential-providers';
+import { Signer } from "@aws-sdk/rds-signer";
+import { fromNodeProviderChain } from "@aws-sdk/credential-providers";
 
 interface GetIamTokenParams {
   host: string;
@@ -8,19 +8,19 @@ interface GetIamTokenParams {
   region?: string;
 }
 
-export const getIamToken = async({
+export const getIamToken = async ({
   host,
   port = 5432,
   user,
-  region = 'us-east-1',
+  region = "us-east-1",
 }: GetIamTokenParams) => {
   const signer = new Signer({
     hostname: host,
     port,
     username: user,
     region,
-    credentials: fromNodeProviderChain()
+    credentials: fromNodeProviderChain(),
   });
 
   return signer.getAuthToken();
-}
+};

src/common/chains.ts

@@ -18,6 +18,7 @@ import TronWeb from "tronweb";
 import { db } from "./db";
 import { externalError } from "./error";
 import { config } from "../config";
+import * as onchainAllocator from "../utils/onchain-allocator";
 
 // Global chain metadata
 export type ChainMetadata = {
@@ -78,7 +79,11 @@ export const getChain = async (chainId: string) => {
   return chains[chainId];
 };
 
-export const getAllocatorForChain = async (chainId: string) => {
+export const getOnchainAllocatorForChain = async (chainId: string) => {
+  return onchainAllocator.getSigner(chainId);
+};
+
+export const getOffchainAllocatorForChain = async (chainId: string) => {
   const ecdsaPk = config.ecdsaPrivateKey;
   const ed25519Pk = config.ed25519PrivateKey;
 

src/services/request-handler/index.ts

@@ -26,7 +26,8 @@ import TronWeb from "tronweb";
 import {
   ChainMetadataEthereumVm,
   ChainMetadataTronVm,
-  getAllocatorForChain,
+  getOffchainAllocatorForChain,
+  getOnchainAllocatorForChain,
   getChain,
 } from "../../common/chains";
 import { db } from "../../common/db";
@@ -35,7 +36,6 @@ import { logger } from "../../common/logger";
 import {
   getOnchainAllocator,
   getSignature,
-  getSigner,
   handleOneTimeApproval,
   logBalance,
 } from "../../utils/onchain-allocator";
@@ -364,7 +364,7 @@ export class RequestHandlerService {
           // Start constructing the PSBT
           const psbt = new bitcoin.Psbt({ network: bitcoin.networks.bitcoin });
 
-          const allocator = await getAllocatorForChain(request.chainId);
+          const allocator = await getOffchainAllocatorForChain(request.chainId);
 
           // Add allocator input UTXOs
           for (const utxo of additionalData.allocatorUtxos) {
@@ -615,8 +615,8 @@ export class RequestHandlerService {
       signature,
       signer:
         request.mode === "onchain"
-          ? await getSigner(request.chainId)
-          : await getAllocatorForChain(request.chainId),
+          ? await getOnchainAllocatorForChain(request.chainId)
+          : await getOffchainAllocatorForChain(request.chainId),
     };
   }