paj_ramp 1.2.2 → 1.2.4

package/dist/lib/direct_off_ramp/directCreateOrder.d.ts

@@ -0,0 +1,19 @@
+declare enum Currency {
+    NGN = "NGN"
+}
+type offRampCreateOrderResponse = {
+    amount: number;
+    expectedAmount: number;
+    mint: string;
+    decimals: number;
+    address: string;
+    walletId: string;
+    creatorId: string;
+    bankId: string;
+    accountNumber: string;
+    currency: Currency;
+    status: string;
+    webhookURL: string;
+};
+export declare const offRampCreateOrder: (token: string, bank: string, accountNumber: string, currency: Currency, amount: number, mint: string, webhookURL: string) => Promise<offRampCreateOrderResponse>;
+export {};

package/dist/lib/direct_off_ramp/directCreateOrder.js

@@ -0,0 +1,23 @@
+import { post } from '../../utils/api.js';
+var Currency;
+(function (Currency) {
+    Currency["NGN"] = "NGN";
+})(Currency || (Currency = {}));
+export const offRampCreateOrder = async (token, bank, accountNumber, currency, amount, mint, webhookURL) => {
+    try {
+        return await post('/pub/offramp', {
+            bank,
+            accountNumber,
+            currency,
+            amount,
+            mint,
+            webhookURL,
+        }, {
+            Authorization: `Bearer ${token}`,
+        });
+    }
+    catch (err) {
+        console.error('Error Creating Order', err);
+        throw err;
+    }
+};

package/dist/lib/off_ramp/addBankAccount.js

@@ -16,7 +16,7 @@ import { post } from "../../utils/api.js";
  */
 export const addBankAccount = async (token, bankId, accountNumber) => {
     try {
-        return await post("/pub/bankAccount", {
+        return await post('/pub/bank-account', {
             bankId,
             accountNumber,
         }, {

package/dist/lib/off_ramp/getBankAccounts.js

@@ -11,7 +11,7 @@ import { get } from "../../utils/api.js";
  */
 export const getBankAccounts = async (apiKey) => {
     try {
-        return await get(`/pub/bankaccount`, {}, {
+        return await get(`/pub/bank-account`, {}, {
             Authorization: `Bearer ${apiKey}`,
         });
     }

package/dist/lib/off_ramp/getBanks.d.ts

@@ -13,5 +13,5 @@ type BankType = {
  * Raises:
  *   Throws an error if the request fails.
  */
-export declare const getBanks: () => Promise<BankType[]>;
+export declare const getBanks: (token: string) => Promise<BankType[]>;
 export {};

package/dist/lib/off_ramp/getBanks.js

@@ -1,4 +1,4 @@
-import { get } from "../../utils/api.js";
+import { get } from '../../utils/api.js';
 /**
  * Fetches a list of banks from the public API endpoint.
  * Returns an array of bank objects or throws an error if the request fails.
@@ -9,12 +9,14 @@ import { get } from "../../utils/api.js";
  * Raises:
  *   Throws an error if the request fails.
  */
-export const getBanks = async () => {
+export const getBanks = async (token) => {
     try {
-        return await get(`/pub/bank`);
+        return await get(`/pub/bank`, {}, {
+            Authorization: `Bearer ${token}`,
+        });
     }
     catch (err) {
-        console.error("Error fetching Banks:", err);
+        console.error('Error fetching Banks:', err);
         throw err;
     }
 };

package/dist/lib/off_ramp/getRate.d.ts

@@ -1,7 +1,25 @@
-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;
@@ -9,18 +27,59 @@ type RateType = {
         userAmountFiat: number;
     };
 };
+type RateByRateTypeType = {
+    baseCurrency: "USD";
+    targetCurrency: "NGN";
+    isActive: true;
+    rate: 1525;
+    type: "offRamp";
+};
+export declare 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 declare const getRate: (param: number | RateType) => Promise<AllRateResponseType | RateByAmountType | RateByRateTypeType>;
+/**
+ * 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 declare const getRateByAmount: (url: string, amount: number) => Promise<RateByAmountType>;
 /**
- * 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 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:
- *   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.
+ *   rateType: The type of rate to retrieve, specified as a RateType enum value.
  *
  * Returns:
- *   An object with baseCurrency, targetCurrency, rate, and amounts (userTax, merchantTax, amountUSD, userAmountFiat).
+ *   A promise resolving to the rate details for the specified rate type.
  *
  * Raises:
- *   Throws an error if the request fails.
+ *   Throws an error if the rate information cannot be fetched.
  */
-export declare const getRate: (amount: number) => Promise<RateType>;
+export declare const getRateByRateType: (url: string, rateType: RateType) => Promise<RateByRateTypeType>;
 export {};

package/dist/lib/off_ramp/getRate.js

@@ -1,23 +1,105 @@
 import { get } from "../../utils/api.js";
+export var RateType;
+(function (RateType) {
+    RateType["onRamp"] = "onRamp";
+    RateType["offRamp"] = "offRamp";
+})(RateType || (RateType = {}));
 /**
- * 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.
+ * 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:
- *   amount: The amount for which to fetch the rate. If not provided or falsy, fetches the default rate.
+ *   param: A number representing the amount or a RateType enum value.
  *
  * Returns:
- *   An object with baseCurrency, targetCurrency, rate, and amounts (userTax, merchantTax, amountUSD, userAmountFiat).
+ *   A promise resolving to the rate information relevant to the input parameter.
  *
  * Raises:
- *   Throws an error if the request fails.
+ *   Throws an error if the rate information cannot be fetched.
  */
-export const getRate = async (amount) => {
+export const getRate = async (param) => {
     try {
-        return await get(amount ? `/pub/rate/${amount}` : "/pub/rate");
+        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;
     }
 };
+/**
+ * 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:
+ *   url: The endpoint URL to fetch rate information from.
+ *
+ * Returns:
+ *   A promise resolving to the full rate response data.
+ *
+ * Raises:
+ *   Throws an error if the rate information cannot be fetched.
+ */
+const getAllRate = async (url) => {
+    try {
+        return await get(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, amount) => {
+    try {
+        return await get(`/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, rateType) => {
+    try {
+        return await get(`/pub/rate/${rateType}`);
+    }
+    catch (err) {
+        console.error("Error fetching Rate by Rate Type:", err);
+        throw err;
+    }
+};

package/dist/lib/off_ramp/initiate.d.ts

@@ -14,5 +14,5 @@ type InitiateResponse = {
  * Raises:
  *   Throws an error if the request fails.
  */
-export declare const initiate: (email: string) => Promise<InitiateResponse>;
+export declare const initiate: (email: string, apiKey: string) => Promise<InitiateResponse>;
 export {};

package/dist/lib/off_ramp/initiate.js

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

package/dist/lib/off_ramp/resolveBankAccount.d.ts

@@ -22,5 +22,5 @@ type ResolveBankAccountType = {
  * Raises:
  *   Throws an error if the request fails.
  */
-export declare const resolveBankAccount: (bankId: string, accountNumber: string) => Promise<ResolveBankAccountType>;
+export declare const resolveBankAccount: (token: string, bankId: string, accountNumber: string) => Promise<ResolveBankAccountType>;
 export {};

package/dist/lib/off_ramp/resolveBankAccount.js

@@ -1,4 +1,4 @@
-import { get } from "../../utils/api.js";
+import { get } from '../../utils/api.js';
 /**
  * Resolves and fetches bank account details for a given bank ID and account number from the public API.
  * Returns the account name, account number, and bank details or throws an error if the request fails.
@@ -13,12 +13,14 @@ import { get } from "../../utils/api.js";
  * Raises:
  *   Throws an error if the request fails.
  */
-export const resolveBankAccount = async (bankId, accountNumber) => {
+export const resolveBankAccount = async (token, bankId, accountNumber) => {
     try {
-        return await get(`/pub/bankaccount/resolve/?bankId=${bankId}&accountNumber=${accountNumber}`);
+        return await get(`/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/dist/lib/off_ramp/verify.d.ts

@@ -1,3 +1,16 @@
+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.
@@ -13,9 +26,5 @@
  * Raises:
  *   Throws an error if the request fails.
  */
-export declare const verify: (email: string, otp: string, deviceSignature: string) => Promise<{
-    email: string;
-    isActive: string;
-    expiresAt: string;
-    token: string;
-}>;
+export declare const verify: (email: string, otp: string, deviceSignature: deviceSignatureType, apiKey: string) => Promise<VerifyType>;
+export {};

package/dist/lib/off_ramp/verify.js

@@ -14,9 +14,13 @@ import { post } from "../../utils/api.js";
  * Raises:
  *   Throws an error if the request fails.
  */
-export const verify = async (email, otp, deviceSignature) => {
+export const verify = async (email, otp, deviceSignature, apiKey) => {
     try {
-        return await post("/pub/verify", { email, otp, deviceSignature }, { "x-api-key": "3ada687e-78d1-45f3-933d-c992adcc2bbb" });
+        return await post("/pub/verify", {
+            email,
+            otp,
+            device: deviceSignature,
+        }, { "x-api-key": apiKey });
     }
     catch (err) {
         console.error("Error verifying:", err);

package/dist/lib/on_ramp/createOrder.d.ts

@@ -4,6 +4,7 @@ type CreateOrderType = {
     recipient: string;
     mint: string;
     chain: string;
+    webhookURL: string;
     token?: string;
 };
 export declare const createOrder: (options: CreateOrderType) => Promise<CreateOrderType>;

package/dist/lib/on_ramp/createOrder.js

@@ -1,6 +1,6 @@
 import { post } from "../../utils/api.js";
 export const createOrder = async (options) => {
-    const { fiatAmount, currency, recipient, mint, chain, token } = options;
+    const { fiatAmount, currency, recipient, mint, chain, webhookURL, token } = options;
     try {
         return await post("/pub/onramp", {
             fiatAmount,
@@ -8,6 +8,7 @@ export const createOrder = async (options) => {
             recipient,
             mint,
             chain,
+            webhookURL
         }, {
             Authorization: `Bearer ${token}`,
         });

package/dist/sdk.d.ts

@@ -1,14 +1,11 @@
 export declare const initializeSDK: (env: "staging" | "production") => void;
-export { getTXPoolAddress } from "./lib/off_ramp/getTXPoolAddress.js";
-export { getRate } from "./lib/off_ramp/getRate.js";
-export { initiate } from "./lib/off_ramp/initiate.js";
-export { verify } from "./lib/off_ramp/verify.js";
+export { getRate, RateType } from './lib/off_ramp/getRate.js';
+export { initiate } from './lib/off_ramp/initiate.js';
+export { verify } from './lib/off_ramp/verify.js';
 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";
-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 { createOrder } from "./lib/on_ramp/createOrder.js";
-export { observeOrder } from "./lib/on_ramp/observeOrder.js";
+export { offRampCreateOrder } from './lib/direct_off_ramp/directCreateOrder.js';
+export { createOrder } from './lib/on_ramp/createOrder.js';
+export { observeOrder } from './lib/on_ramp/observeOrder.js';

package/dist/sdk.js

@@ -1,32 +1,34 @@
 // 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) => {
-    if (env === "staging") {
-        setBaseUrl("https://api-staging.paj.cash");
+    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";
-// Banking Operations
+export { initiate } from './lib/off_ramp/initiate.js';
+export { verify } from './lib/off_ramp/verify.js';
+//  // 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/jest.config.js

@@ -1,8 +1,8 @@
-export default {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  transform: {
-    '^.+\\.tsx?$': 'ts-jest',
-  },
-  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
-};
+export default {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.tsx?$': 'ts-jest',
+  },
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
+};

package/lib/direct_off_ramp/directCreateOrder.ts

@@ -0,0 +1,60 @@
+import { post } from '../../utils/api.js';
+
+enum Currency {
+  NGN = 'NGN',
+}
+
+// type offRampCreateOrderType = {
+//   token?: string;
+//   bank: string;
+//   accountNumber: string;
+//   currency: Currency;
+//   amount: number;
+//   mint: string;
+//   webhookURL: string;
+// };
+
+type offRampCreateOrderResponse = {
+  amount: number;
+  expectedAmount: number;
+  mint: string;
+  decimals: number;
+  address: string;
+  walletId: string;
+  creatorId: string;
+  bankId: string;
+  accountNumber: string;
+  currency: Currency;
+  status: string;
+  webhookURL: string;
+};
+
+export const offRampCreateOrder = async (
+  token: string,
+  bank: string,
+  accountNumber: string,
+  currency: Currency,
+  amount: number,
+  mint: string,
+  webhookURL: string
+) => {
+  try {
+    return await post<offRampCreateOrderResponse>(
+      '/pub/offramp',
+      {
+        bank,
+        accountNumber,
+        currency,
+        amount,
+        mint,
+        webhookURL,
+      },
+      {
+        Authorization: `Bearer ${token}`,
+      }
+    );
+  } catch (err) {
+    console.error('Error Creating Order', err);
+    throw err;
+  }
+};

package/lib/off_ramp/addBankAccount.ts

@@ -29,7 +29,7 @@ export const addBankAccount = async (
 ) => {
   try {
     return await post<AddBankAccountType>(
-      "/pub/bankAccount",
+      '/pub/bank-account',
       {
         bankId,
         accountNumber,

package/lib/off_ramp/getBankAccounts.ts

@@ -20,7 +20,7 @@ type GetBankAccountsType = {
 export const getBankAccounts = async (apiKey: string) => {
   try {
     return await get<GetBankAccountsType[]>(
-      `/pub/bankaccount`,
+      `/pub/bank-account`,
       {},
       {
         Authorization: `Bearer ${apiKey}`,

package/lib/off_ramp/getBanks.ts

@@ -1,4 +1,4 @@
-import { get } from "../../utils/api.js";
+import { get } from '../../utils/api.js';
 
 type BankType = {
   id: string;
@@ -15,11 +15,17 @@ type BankType = {
  * Raises:
  *   Throws an error if the request fails.
  */
-export const getBanks = async () => {
+export const getBanks = async (token: string) => {
   try {
-    return await get<BankType[]>(`/pub/bank`);
+    return await get<BankType[]>(
+      `/pub/bank`,
+      {},
+      {
+        Authorization: `Bearer ${token}`,
+      }
+    );
   } catch (err) {
-    console.error("Error fetching Banks:", err);
+    console.error('Error fetching Banks:', err);
     throw err;
   }
 };