paj_ramp 1.2.2 → 1.2.4

package/lib/off_ramp/getRate.ts

@@ -1,9 +1,28 @@
 import { get } from "../../utils/api.js";
 
-type RateType = {
-  baseCurrency: string;
-  targetCurrency: string;
-  rate: number;
+type AllRateResponseType = {
+  onRampRate: {
+    baseCurrency: "USD";
+    targetCurrency: "NGN";
+    isActive: true;
+    rate: 1510;
+    type: "onRamp";
+  };
+  offRampRate: {
+    baseCurrency: "USD";
+    targetCurrency: "NGN";
+    isActive: true;
+    rate: 1525;
+    type: "offRamp";
+  };
+};
+
+type RateByAmountType = {
+  rate: {
+    baseCurrency: string;
+    targetCurrency: string;
+    rate: number;
+  };
   amounts: {
     userTax: number;
     merchantTax: number;
@@ -12,24 +31,113 @@ type RateType = {
   };
 };
 
+type RateByRateTypeType = {
+  baseCurrency: "USD";
+  targetCurrency: "NGN";
+  isActive: true;
+  rate: 1525;
+  type: "offRamp";
+};
+
+export enum RateType {
+  onRamp = "onRamp",
+  offRamp = "offRamp",
+}
+
+/**
+ * Fetches rate information based on the provided parameter, which can be a number or a rate type.
+ * This function returns all rates, rates by amount, or rates by type depending on the input.
+ *
+ * Args:
+ *   param: A number representing the amount or a RateType enum value.
+ *
+ * Returns:
+ *   A promise resolving to the rate information relevant to the input parameter.
+ *
+ * Raises:
+ *   Throws an error if the rate information cannot be fetched.
+ */
+export const getRate = async (param: number | RateType) => {
+  try {
+    const url = "/pub/rate";
+
+    if (!param) {
+      return getAllRate(url);
+    } else if (typeof param === "number") {
+      return getRateByAmount(url, param);
+    } else {
+      return getRateByRateType(url, param);
+    }
+  } catch (err) {
+    console.error("Error fetching Rate:", err);
+    throw err;
+  }
+};
+
 /**
- * Fetches the exchange rate and related amounts for a given amount from the public API.
- * Returns an object containing currency information, rate, and detailed amounts, or throws an error if the request fails.
+ * Retrieves all available rate information for on-ramp and off-ramp transactions.
+ * This function returns a promise that resolves to the complete set of rate data.
  *
  * Args:
- *   amount: The amount for which to fetch the rate. If not provided or falsy, fetches the default rate.
+ *   url: The endpoint URL to fetch rate information from.
  *
  * Returns:
- *   An object with baseCurrency, targetCurrency, rate, and amounts (userTax, merchantTax, amountUSD, userAmountFiat).
+ *   A promise resolving to the full rate response data.
  *
  * Raises:
- *   Throws an error if the request fails.
+ *   Throws an error if the rate information cannot be fetched.
  */
-export const getRate = async (amount: number) => {
+const getAllRate = async (url: string) => {
   try {
-    return await get<RateType>(amount ? `/pub/rate/${amount}` : "/pub/rate");
+    return await get<AllRateResponseType>(url);
   } catch (err) {
     console.error("Error fetching Rate:", err);
     throw err;
   }
 };
+
+/**
+ * Retrieves rate information based on a specific amount for on-ramp or off-ramp transactions.
+ * This function returns a promise that resolves to the rate and associated amounts for the given value.
+ *
+ * Args:
+ *   url: The endpoint URL to fetch rate information from.
+ *   amount: The amount for which the rate information is requested.
+ *
+ * Returns:
+ *   A promise resolving to the rate and amount details for the specified value.
+ *
+ * Raises:
+ *   Throws an error if the rate information cannot be fetched.
+ */
+export const getRateByAmount = async (url: string, amount: number) => {
+  try {
+    return await get<RateByAmountType>(`/pub/rate/${amount}`);
+  } catch (err) {
+    console.error("Error fetching Rate by Amount:", err);
+    throw err;
+  }
+};
+
+/**
+ * Retrieves rate information based on a specific rate type for on-ramp or off-ramp transactions.
+ * This function returns a promise that resolves to the rate details for the given rate type.
+ *
+ * Args:
+ *   url: The endpoint URL to fetch rate information from.
+ *   rateType: The type of rate to retrieve, specified as a RateType enum value.
+ *
+ * Returns:
+ *   A promise resolving to the rate details for the specified rate type.
+ *
+ * Raises:
+ *   Throws an error if the rate information cannot be fetched.
+ */
+export const getRateByRateType = async (url: string, rateType: RateType) => {
+  try {
+    return await get<RateByRateTypeType>(`/pub/rate/${rateType}`);
+  } catch (err) {
+    console.error("Error fetching Rate by Rate Type:", err);
+    throw err;
+  }
+};

package/lib/off_ramp/initiate.ts

@@ -17,12 +17,12 @@ type InitiateResponse = {
  * Raises:
  *   Throws an error if the request fails.
  */
-export const initiate = async (email: string) => {
+export const initiate = async (email: string, apiKey: string) => {
   try {
     return await post<InitiateResponse>(
       "/pub/initiate",
       { email },
-      { "x-api-key": "3ada687e-78d1-45f3-933d-c992adcc2bbb" }
+      { "x-api-key": apiKey, "Content-Type": "application/json" }
     );
   } catch (err) {
     console.error("Error initiating:", err);

package/lib/off_ramp/resolveBankAccount.ts

@@ -1,4 +1,4 @@
-import { get } from "../../utils/api.js";
+import { get } from '../../utils/api.js';
 
 type ResolveBankAccountType = {
   accountName: string;
@@ -26,15 +26,20 @@ type ResolveBankAccountType = {
  *   Throws an error if the request fails.
  */
 export const resolveBankAccount = async (
+  token: string,
   bankId: string,
   accountNumber: string
 ) => {
   try {
     return await get<ResolveBankAccountType>(
-      `/pub/bankaccount/resolve/?bankId=${bankId}&accountNumber=${accountNumber}`
+      `/pub/bank-account/confirm/?bankId=${bankId}&accountNumber=${accountNumber}`,
+      {},
+      {
+        Authorization: `Bearer ${token}`,
+      }
     );
   } catch (err) {
-    console.error("Error resolving bank account:", err);
+    console.error('Error resolving bank account:', err);
     throw err;
   }
 };

package/lib/off_ramp/verify.ts

@@ -1,5 +1,20 @@
 import { post } from "../../utils/api.js";
 
+type VerifyType = {
+  email: string;
+  isActive: string;
+  expiresAt: string;
+  token: string;
+};
+
+type deviceSignatureType = {
+  uuid: string;
+  device: string;
+  os?: string;
+  browser?: string;
+  ip?: string;
+};
+
 /**
  * Verifies a user's identity using email, OTP, and device signature via the public API.
  * Returns verification details including email, activation status, expiration, and token, or throws an error if the request fails.
@@ -15,21 +30,22 @@ import { post } from "../../utils/api.js";
  * Raises:
  *   Throws an error if the request fails.
  */
+
 export const verify = async (
   email: string,
   otp: string,
-  deviceSignature: string
+  deviceSignature: deviceSignatureType,
+  apiKey: string
 ) => {
   try {
-    return await post<{
-      email: string;
-      isActive: string;
-      expiresAt: string;
-      token: string;
-    }>(
+    return await post<VerifyType>(
       "/pub/verify",
-      { email, otp, deviceSignature },
-      { "x-api-key": "3ada687e-78d1-45f3-933d-c992adcc2bbb" }
+      {
+        email,
+        otp,
+        device: deviceSignature,
+      },
+      { "x-api-key": apiKey }
     );
   } catch (err) {
     console.error("Error verifying:", err);

package/lib/on_ramp/createOrder.ts

@@ -6,11 +6,12 @@ type CreateOrderType = {
   recipient: string;
   mint: string;
   chain: string;
+  webhookURL: string;
   token?: string;
 };
 
 export const createOrder = async (options: CreateOrderType) => {
-  const { fiatAmount, currency, recipient, mint, chain, token } = options;
+  const { fiatAmount, currency, recipient, mint, chain, webhookURL, token } = options;
   try {
     return await post<CreateOrderType>(
       "/pub/onramp",
@@ -20,6 +21,7 @@ export const createOrder = async (options: CreateOrderType) => {
         recipient,
         mint,
         chain,
+        webhookURL
       },
       {
         Authorization: `Bearer ${token}`,

package/package.json

@@ -1,42 +1,42 @@
-{
-  "name": "paj_ramp",
-  "version": "1.2.2",
-  "description": "paj offramp service",
-  "main": "dist/sdk.js",
-  "types": "dist/sdk.d.ts",
-  "type": "module",
-  "scripts": {
-    "prelink": "npm run build",
-    "build": "tsc",
-    "test": "jest"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/paj-cash/paj_ramp.git"
-  },
-  "keywords": [
-    "PAJ"
-  ],
-  "author": "Ebube",
-  "license": "ISC",
-  "bugs": {
-    "url": "https://github.com/paj-cash/paj_ramp/issues"
-  },
-  "homepage": "https://github.com/paj-cash/paj_ramp#readme",
-  "devDependencies": {
-    "@types/node": "^22.15.24",
-    "typescript": "^5.8.3"
-  },
-  "dependencies": {
-    "@solana/web3.js": "^1.98.2",
-    "@types/jest": "^29.5.14",
-    "axios": "^1.9.0",
-    "bs58": "^6.0.0",
-    "dotenv": "^16.5.0",
-    "jest": "^30.0.0",
-    "socket.io-client": "^4.8.1",
-    "ts-jest": "^29.3.4",
-    "tsx": "4.20.3",
-    "tweetnacl": "^1.0.3"
-  }
-}
+{
+  "name": "paj_ramp",
+  "version": "1.2.4",
+  "description": "paj offramp/onramp service",
+  "main": "dist/sdk.js",
+  "types": "dist/sdk.d.ts",
+  "type": "module",
+  "scripts": {
+    "prelink": "npm run build",
+    "build": "tsc",
+    "test": "jest"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/paj-cash/paj_ramp.git"
+  },
+  "keywords": [
+    "PAJ"
+  ],
+  "author": "Ebube",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/paj-cash/paj_ramp/issues"
+  },
+  "homepage": "https://github.com/paj-cash/paj_ramp#readme",
+  "devDependencies": {
+    "@types/node": "^22.15.24",
+    "typescript": "^5.8.3"
+  },
+  "dependencies": {
+    "@solana/web3.js": "^1.98.2",
+    "@types/jest": "^29.5.14",
+    "axios": "^1.9.0",
+    "bs58": "^6.0.0",
+    "dotenv": "^16.5.0",
+    "jest": "^30.0.0",
+    "socket.io-client": "^4.8.1",
+    "ts-jest": "^29.3.4",
+    "tsx": "4.20.3",
+    "tweetnacl": "^1.0.3"
+  }
+}

package/sdk.ts

@@ -1,41 +1,44 @@
 // A JavaScript SDK for interacting with our offramp and onramp service.
 
 // Switch Environment: "staging" | "production"
-import { setBaseUrl } from "./utils/axios.js";
+import { setBaseUrl } from './utils/axios.js';
 
-export const initializeSDK = (env: "staging" | "production") => {
-  if (env === "staging") {
-    setBaseUrl("https://api-staging.paj.cash");
+export const initializeSDK = (env: 'staging' | 'production') => {
+  if (env === 'staging') {
+    setBaseUrl('https://api-staging.paj.cash');
   } else {
-    setBaseUrl("https://api.paj.cash");
+    setBaseUrl('https://api.paj.cash');
   }
 };
 
 // OFF RAMP
 
 // Wallet Info
-export { getTXPoolAddress } from "./lib/off_ramp/getTXPoolAddress.js";
-export { getRate } from "./lib/off_ramp/getRate.js";
+// export { getTXPoolAddress } from "./lib/off_ramp/getTXPoolAddress.js";
+export { getRate, RateType } from './lib/off_ramp/getRate.js';
 
 // Session Management
-export { initiate } from "./lib/off_ramp/initiate.js";
-export { verify } from "./lib/off_ramp/verify.js";
+export { initiate } from './lib/off_ramp/initiate.js';
+export { verify } from './lib/off_ramp/verify.js';
 
-// Banking Operations
+//  // Banking Operations
 export { getBanks } from "./lib/off_ramp/getBanks.js";
 export { resolveBankAccount } from "./lib/off_ramp/resolveBankAccount.js";
 export { addBankAccount } from "./lib/off_ramp/addBankAccount.js";
 export { getBankAccounts } from "./lib/off_ramp/getBankAccounts.js";
 
 // Wallet Operations
-export { getWallet } from "./lib/off_ramp/getWallet.js";
-export { addWallet } from "./lib/off_ramp/addWallet.js";
-export { switchWalletBankAccount } from "./lib/off_ramp/switchWalletBankAccount.js";
+// export { getWallet } from './lib/off_ramp/getWallet.js';
+// export { addWallet } from './lib/off_ramp/addWallet.js';
+// export { switchWalletBankAccount } from './lib/off_ramp/switchWalletBankAccount.js';
+
+// DIRECT OFF RAMP
+export { offRampCreateOrder } from './lib/direct_off_ramp/directCreateOrder.js';
 
 // ON RAMP
 
 // Create Order
-export { createOrder } from "./lib/on_ramp/createOrder.js";
+export { createOrder } from './lib/on_ramp/createOrder.js';
 
 // Observe Order Socket.IO
-export { observeOrder } from "./lib/on_ramp/observeOrder.js";
+export { observeOrder } from './lib/on_ramp/observeOrder.js';

package/test-protocol.js

@@ -0,0 +1,41 @@
+import axios from "axios";
+
+// Test both HTTP and HTTPS to see which one works
+async function testProtocols() {
+  const urls = [
+    "https://api-staging.paj.cash",
+    "http://api-staging.paj.cash",
+    "https://api.paj.cash",
+    "http://api.paj.cash"
+  ];
+
+  for (const url of urls) {
+    try {
+      console.log(`\n🔍 Testing: ${url}`);
+      
+      const response = await axios.get(`${url}/pub/rate`, {
+        timeout: 5000,
+        validateStatus: () => true // Don't throw on any status code
+      });
+      
+      console.log(`✅ SUCCESS: ${url}`);
+      console.log(`   Status: ${response.status}`);
+      console.log(`   Protocol: ${url.startsWith('https') ? 'HTTPS' : 'HTTP'}`);
+      
+    } catch (error) {
+      console.log(`❌ FAILED: ${url}`);
+      console.log(`   Error: ${error.message}`);
+      
+      if (error.code === 'ECONNREFUSED') {
+        console.log(`   Reason: Connection refused (server not running or wrong port)`);
+      } else if (error.message.includes('wrong version number')) {
+        console.log(`   Reason: Protocol mismatch (HTTPS client to HTTP server)`);
+      } else if (error.message.includes('ENOTFOUND')) {
+        console.log(`   Reason: Domain not found`);
+      }
+    }
+  }
+}
+
+console.log("🚀 Testing PAJ API protocols...");
+testProtocols().catch(console.error);