feat: matic support (#7)

src/constants.ts

@@ -331,6 +331,10 @@ export const ethereumGatewayUrl = new URL(
   process.env.ETHEREUM_GATEWAY || "https://cloudflare-eth.com/"
 );
 
+export const maticGatewayUrl = new URL(
+  process.env.MATIC_GATEWAY || "https://polygon-mainnet.infura.io/"
+);
+
 export const solanaGatewayUrl = new URL(
   process.env.SOLANA_GATEWAY || "https://api.mainnet-beta.solana.com/"
 );

src/database/dbTypes.ts

@@ -51,6 +51,7 @@ export const userAddressTypes = [
   "solana",
   "ethereum",
   "kyve",
+  "matic"
 ] as const;
 export type UserAddressType = (typeof userAddressTypes)[number];
 

src/gateway/gateway.ts

@@ -29,6 +29,7 @@ export const supportedPaymentTokens = [
   "ethereum",
   "solana",
   "kyve",
+  "matic"
 ] as const;
 export type TokenType = (typeof supportedPaymentTokens)[number];
 export function isSupportedPaymentToken(token: string): token is TokenType {

src/gateway/index.ts

@@ -20,3 +20,4 @@ export * from "./kyve";
 export * from "./solana";
 export * from "./ethereum";
 export * from "./arweave";
+export * from './matic';

src/gateway/matic.ts

@@ -0,0 +1,93 @@
+/**
+ * Copyright (C) 2022-2024 Permanent Data Solutions, Inc. All Rights Reserved.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+import BigNumber from "bignumber.js";
+import { ethers } from "ethers";
+
+import { maticGatewayUrl } from "../constants";
+import { PaymentTransactionNotFound } from "../database/errors";
+import logger from "../logger";
+import { TransactionId } from "../types";
+import {
+  Gateway,
+  GatewayParams,
+  TransactionInfo,
+  TransactionStatus,
+} from "./gateway";
+
+type MaticGatewayParams = GatewayParams;
+
+export class MaticGateway extends Gateway {
+  public endpoint: URL;
+  private provider: ethers.JsonRpcProvider;
+
+  constructor({
+    endpoint = maticGatewayUrl,
+    paymentTxPollingWaitTimeMs,
+    pendingTxMaxAttempts,
+    minConfirmations = +(process.env.MATIC_MIN_CONFIRMATIONS || 5),
+  }: MaticGatewayParams = {}) {
+    super({
+      paymentTxPollingWaitTimeMs,
+      pendingTxMaxAttempts,
+      minConfirmations,
+    });
+    this.endpoint = endpoint;
+    this.provider = new ethers.JsonRpcProvider(endpoint.toString());
+  }
+
+  public async getTransactionStatus(
+    transactionId: TransactionId
+  ): Promise<TransactionStatus> {
+    logger.debug("Getting transaction status...", { transactionId });
+    const statusResponse = await this.provider.getTransactionReceipt(
+      transactionId
+    );
+    if (statusResponse === null) {
+      logger.debug("Transaction not found...", { transactionId });
+      return { status: "not found" };
+    }
+
+    if ((await statusResponse.confirmations()) >= this.minConfirmations) {
+      return {
+        status: "confirmed",
+        blockHeight: statusResponse.blockNumber,
+      };
+    }
+
+    return { status: "pending" };
+  }
+
+  public async getTransaction(
+    transactionId: TransactionId
+  ): Promise<TransactionInfo> {
+    return this.pollGatewayForTx(async () => {
+      logger.debug("Getting transaction...", { transactionId });
+      const txResponse = await this.provider.getTransaction(transactionId);
+      if (txResponse === null) {
+        throw new PaymentTransactionNotFound(transactionId);
+      }
+
+      const tx = {
+        transactionQuantity: BigNumber(txResponse.value.toString()),
+        transactionSenderAddress: txResponse.from,
+        transactionRecipientAddress: txResponse.to ?? "",
+      };
+
+      return tx;
+    }, transactionId);
+  }
+}

src/jobs/creditPendingTx.ts

@@ -21,6 +21,7 @@ import {
   EthereumGateway,
   KyveGateway,
   SolanaGateway,
+  MaticGateway,
 } from "../gateway";
 import globalLogger from "../logger";
 
@@ -39,6 +40,7 @@ export async function creditPendingTransactionsHandler({
     ethereum: new EthereumGateway(),
     solana: new SolanaGateway(),
     kyve: new KyveGateway(),
+    matic: new MaticGateway()
   },
   paymentDatabase = new PostgresDatabase(),
   logger = globalLogger.child({ job: "credit-pending-transactions-job" }),

src/pricing/oracles/tokenToFiatOracle.ts

@@ -32,6 +32,7 @@ const coinGeckoTokenNames = [
   "ethereum",
   "solana",
   "kyve-network",
+  "matic-network"
 ] as const;
 
 type CoinGeckoTokenName = (typeof coinGeckoTokenNames)[number];
@@ -41,6 +42,7 @@ const tokenNameToCoinGeckoTokenName: Record<TokenType, CoinGeckoTokenName> = {
   ethereum: "ethereum",
   solana: "solana",
   kyve: "kyve-network",
+  matic: "matic-network"
 };
 
 type CoinGeckoResponse = Record<

src/pricing/pricing.ts

@@ -792,6 +792,10 @@ export function weiToEth(wei: BigNumber.Value): BigNumber {
   return BigNumber(wei).shiftedBy(-18);
 }
 
+export function baseToMatic(base: BigNumber.Value): BigNumber {
+  return BigNumber(base).shiftedBy(-18);
+}
+
 export function lamportsToSol(lamports: BigNumber.Value): BigNumber {
   return BigNumber(lamports).shiftedBy(-9);
 }
@@ -813,6 +817,8 @@ export function baseAmountToTokenAmount(
       return lamportsToSol(amount);
     case "kyve":
       return ukyveToKyve(amount);
+    case "matic":
+      return baseToMatic(amount);
     default:
       return BigNumber(amount);
   }

src/server.ts

@@ -35,6 +35,7 @@ import {
   GatewayMap,
   KyveGateway,
   SolanaGateway,
+  MaticGateway
 } from "./gateway";
 import logger from "./logger";
 import { MetricRegistry } from "./metricRegistry";
@@ -99,6 +100,7 @@ export async function createServer(
     ethereum: new EthereumGateway(),
     solana: new SolanaGateway(),
     kyve: new KyveGateway(),
+    matic: new MaticGateway()
   };
 
   const emailProvider = (() => {

src/utils/base64.ts

@@ -62,6 +62,11 @@ export function isValidEthAddress(address: string) {
   return ethAddressRegex.test(address);
 }
 
+export function isValidMaticAddress(address: string) {
+  const maticAddressRegex = new RegExp("^0x[a-fA-F0-9]{40}$");
+  return maticAddressRegex.test(address);
+}
+
 export function isValidKyveAddress(address: string) {
   const kyveAddressRegex = new RegExp("^kyve[a-zA-Z0-9]{39}$");
   return kyveAddressRegex.test(address);
@@ -80,6 +85,8 @@ export function isValidUserAddress(
       return isValidEthAddress(address);
     case "kyve":
       return isValidKyveAddress(address);
+    case "matic":
+      return isValidMaticAddress(address);
     default:
       return false;
   }

tests/helpers/stubs.ts

@@ -346,6 +346,19 @@ export const expectedTokenPrices = {
     hkd: 0.181921,
     brl: 0.126463,
   },
+  "matic-network": {
+    usd: 0.368571,
+    jpy: 52.83,
+    eur: 0.331564,
+    gbp: 0.279491,
+    inr: 30.93,
+    aud: 0.546444,
+    sgd: 0.478965,
+    cad: 0.497505,
+    hkd: 2.87,
+    brl: 2.05,
+  }
+}
 };
 
 // TODO: we could make this a function and apply it against the arweave rates above using the turboPercentageFee constant

tests/helpers/testHelpers.ts

@@ -27,6 +27,7 @@ import {
   EthereumGateway,
   KyveGateway,
   SolanaGateway,
+  MaticGateway,
 } from "../../src/gateway";
 import {
   ArweaveBytesToWinstonOracle,
@@ -150,6 +151,9 @@ export const gatewayMap = {
   kyve: new KyveGateway({
     paymentTxPollingWaitTimeMs: 0,
   }),
+  matic: new MaticGateway({
+    paymentTxPollingWaitTimeMs: 0,
+  })
 };
 
 export const testAddress = "-kYy3_LcYeKhtqNNXDN6xTQ7hW8S5EV0jgq_6j8a830"; // cspell:disable-line

tests/router.int.test.ts

@@ -2197,7 +2197,7 @@ describe("Router tests", () => {
     expect(data).to.deep.equal({ winc: "1000000000", balance: "1000000000" });
   });
 
-  const tokens = ["arweave", "ethereum", "solana", "kyve"] as const;
+  const tokens = ["arweave", "ethereum", "solana", "kyve", "matic"] as const;
 
   for (const token of tokens) {
     it(`GET /account/balance/${token} returns 200 for valid params`, async () => {