paj_ramp 1.2.9 → 1.3.0

package/README.md

@@ -186,6 +186,57 @@ const accounts = await getBankAccounts('token');
 // Response: [ { id: string, accountName: string, accountNumber: string, bank: string } ]
 ```
 
+### Transaction History:
+
+**_Get All Transactions_**
+
+```typescript
+import { getAllTransactions } from 'paj_ramp';
+
+const transactions = await getAllTransactions('token_from_verification');
+/* Response: [{
+id: string;
+address: string;
+mint: string;
+currency: Currency;
+amount: number;
+usdcAmount: number;
+fiatAmount: number;
+sender: string;
+receipiant: string;
+rate: number;
+status: TransactionStatus;
+transactionType: TransactionType;
+createdAt: string | Date;
+}]*/
+```
+
+**_Get Transaction_**
+
+```typescript
+import { getTransaction } from 'paj_ramp';
+
+const transactions = await getTransaction(
+  'token_from_verification',
+  'transaction_id'
+);
+/* Response: {
+id: string;
+address: string;
+mint: string;
+currency: Currency;
+amount: number;
+usdcAmount: number;
+fiatAmount: number;
+sender: string;
+receipiant: string;
+rate: number;
+status: TransactionStatus;
+transactionType: TransactionType;
+createdAt: string | Date;
+}*/
+```
+
 ## Offramp Webhook (Direct Offramp)
 
 ### Usage Example
@@ -202,7 +253,21 @@ const createOrder = await offRampCreateOrder(
   'token_mint_address'
   'webhook_url'
 );
-// Response: { id: string, address: string, signature?: string, mint: string, currency: Currency, amount: number, usdcAmount: number, fiatAmount: number, sender: string, receipiant: string, rate: number, status: TransactionStatus, transactionType: TransactionType }
+/* Response: {
+id: string,
+address: string,
+signature?: string,
+mint: string,
+currency: Currency,
+amount: number,
+usdcAmount: number,
+fiatAmount: number,
+sender: string,
+receipiant: string,
+rate: number,
+status: TransactionStatus,
+transactionType: TransactionType
+}*/
 ```
 
 ## Onramp Webhook: Creates a new onramp order and sends status to the webhook url.
@@ -224,6 +289,39 @@ const order = await createOrder({
 // Response: { id: string, accountNumber: string, accountName: string, fiatAmount: number, bank: string }
 ```
 
+## Webhook Response Data Structure
+
+### For both onramp and offramp
+
+```typescript
+{
+  id: string;
+  address: string;
+  signature?: string;
+  mint: string;
+  currency: Currency; // eg. NGN, USD
+  amount: number;
+  usdcAmount: number;
+  fiatAmount: number;
+  sender: string;
+  receipiant: string;
+  rate: number;
+  status: TransactionStatus; // eg. INIT, PAID, COMPLETED
+  transactionType: TransactionType; // ON_RAMP or OFF_RAMP
+}
+```
+
+## Other types
+
+```typescript
+import {
+  // Chain, // SOLANA, etc
+  TransactionStatus, // INIT<, etc
+  TransactionType, // ON_RAMP, etc
+  Currency, // NGN
+} from 'paj_ramp';
+```
+
 <!--
 ## Quick Start
 

package/dist/lib/core/addBankAccount.d.ts

@@ -0,0 +1,23 @@
+type AddBankAccountType = {
+    id: string;
+    accountName: string;
+    accountNumber: string;
+    bank: string;
+};
+/**
+ * Adds a new bank account by sending the provided token, bank ID, and account number to the public API.
+ * Returns the added bank account details or throws an error if the request fails.
+ *
+ * Args:
+ *   token: The authentication token for the request.
+ *   bankId: The ID of the bank.
+ *   accountNumber: The bank account number to add.
+ *
+ * Returns:
+ *   An object containing the new bank account's id, accountName, accountNumber, and bank.
+ *
+ * Raises:
+ *   Throws an error if the request fails.
+ */
+export declare const addBankAccount: (token: string, bankId: string, accountNumber: string) => Promise<AddBankAccountType>;
+export {};

package/dist/lib/core/addBankAccount.js

@@ -0,0 +1,30 @@
+import { post } from "../../utils/api.js";
+/**
+ * Adds a new bank account by sending the provided token, bank ID, and account number to the public API.
+ * Returns the added bank account details or throws an error if the request fails.
+ *
+ * Args:
+ *   token: The authentication token for the request.
+ *   bankId: The ID of the bank.
+ *   accountNumber: The bank account number to add.
+ *
+ * Returns:
+ *   An object containing the new bank account's id, accountName, accountNumber, and bank.
+ *
+ * Raises:
+ *   Throws an error if the request fails.
+ */
+export const addBankAccount = async (token, bankId, accountNumber) => {
+    try {
+        return await post('/pub/bank-account', {
+            bankId,
+            accountNumber,
+        }, {
+            Authorization: `Bearer ${token}`,
+        });
+    }
+    catch (err) {
+        console.error("Error adding bank account:", err);
+        throw err;
+    }
+};

package/dist/lib/core/addWallet.d.ts

@@ -0,0 +1,12 @@
+import { WalletType } from "./getWallet.js";
+/**
+ * Adds a new wallet for the user.
+ * Returns the added wallet object or throws an error if the request fails.
+ *
+ * Returns:
+ *   An object containing id, accountName, accountNumber, and bank of the bank account.
+ *
+ * Raises:
+ *   Throws an error if the wallet file is not found or if the secret key is invalid.
+ */
+export declare const addWallet: (apiKey: string, accountId: string, secretKey: Uint8Array) => Promise<WalletType>;

package/dist/lib/core/addWallet.js

@@ -0,0 +1,27 @@
+import { post } from "../../utils/api.js";
+import { getWalletBody } from "../../utils/getWalletBody.js";
+/**
+ * Adds a new wallet for the user.
+ * Returns the added wallet object or throws an error if the request fails.
+ *
+ * Returns:
+ *   An object containing id, accountName, accountNumber, and bank of the bank account.
+ *
+ * Raises:
+ *   Throws an error if the wallet file is not found or if the secret key is invalid.
+ */
+export const addWallet = async (apiKey, accountId, secretKey) => {
+    try {
+        const body = await getWalletBody(accountId, secretKey);
+        if (!body) {
+            throw new Error("Failed to get wallet body");
+        }
+        return await post("/pub/wallet", body, {
+            Authorization: `Bearer ${apiKey}`,
+        });
+    }
+    catch (err) {
+        console.error("Error adding wallet:", err);
+        throw err;
+    }
+};

package/dist/lib/core/getAllRate.d.ts

@@ -0,0 +1,27 @@
+type AllRateResponseType = {
+    onRampRate: {
+        baseCurrency: string;
+        targetCurrency: string;
+        isActive: boolean;
+        rate: number;
+        type: string;
+    };
+    offRampRate: {
+        baseCurrency: string;
+        targetCurrency: string;
+        isActive: boolean;
+        rate: number;
+        type: string;
+    };
+};
+/**
+ * This TypeScript function asynchronously fetches all rates from a specified URL and handles any
+ * errors that may occur.
+ * @returns The `getAllRate` function is returning the result of the `get<AllRateResponseType>(url)`
+ * function call, which is fetching rate data from the specified URL '/pub/rate'. The function is using
+ * async/await syntax to handle asynchronous operations and is catching any errors that occur during
+ * the fetch operation. If successful, the function will return the rate data, and if an error occurs,
+ * it
+ */
+export declare const getAllRate: () => Promise<AllRateResponseType>;
+export {};

package/dist/lib/core/getAllRate.js

@@ -0,0 +1,20 @@
+import { get } from '../../utils/api.js';
+/**
+ * This TypeScript function asynchronously fetches all rates from a specified URL and handles any
+ * errors that may occur.
+ * @returns The `getAllRate` function is returning the result of the `get<AllRateResponseType>(url)`
+ * function call, which is fetching rate data from the specified URL '/pub/rate'. The function is using
+ * async/await syntax to handle asynchronous operations and is catching any errors that occur during
+ * the fetch operation. If successful, the function will return the rate data, and if an error occurs,
+ * it
+ */
+export const getAllRate = async () => {
+    const url = '/pub/rate';
+    try {
+        return await get(url);
+    }
+    catch (err) {
+        console.error('Error fetching Rate:', err);
+        throw err;
+    }
+};

package/dist/lib/core/getAllTransactions.d.ts

@@ -0,0 +1,12 @@
+import { TransactionResponse } from './getTransaction.js';
+type TransactionsResponse = TransactionResponse[];
+/**
+ * The function getAllTransactions fetches all transactions from a specified endpoint and handles any
+ * errors that occur.
+ * @returns The `getAllTransactions` function is returning the result of the `get` function called with
+ * the '/pub/transactions' endpoint. The result is expected to be of type `TransactionsResponse`. If
+ * successful, the function will return the transactions data. If an error occurs during the API call,
+ * it will be caught, logged to the console, and rethrown.
+ */
+export declare const getAllTransactions: (token: string) => Promise<TransactionsResponse>;
+export {};

package/dist/lib/core/getAllTransactions.js

@@ -0,0 +1,20 @@
+import { get } from '../../utils/api.js';
+/**
+ * The function getAllTransactions fetches all transactions from a specified endpoint and handles any
+ * errors that occur.
+ * @returns The `getAllTransactions` function is returning the result of the `get` function called with
+ * the '/pub/transactions' endpoint. The result is expected to be of type `TransactionsResponse`. If
+ * successful, the function will return the transactions data. If an error occurs during the API call,
+ * it will be caught, logged to the console, and rethrown.
+ */
+export const getAllTransactions = async (token) => {
+    try {
+        return await get('/pub/transactions', {}, {
+            Authorization: `Bearer ${token}`,
+        });
+    }
+    catch (err) {
+        console.error('Error fetching Transactions:', err);
+        throw err;
+    }
+};

package/dist/lib/core/getAllTranstions.d.ts

@@ -0,0 +1,12 @@
+import { TransactionResponse } from './getTransaction.js';
+type TransactionsResponse = TransactionResponse[];
+/**
+ * The function getAllTransactions fetches all transactions from a specified endpoint and handles any
+ * errors that occur.
+ * @returns The `getAllTransactions` function is returning the result of the `get` function called with
+ * the '/pub/transactions' endpoint. The result is expected to be of type `TransactionsResponse`. If
+ * successful, the function will return the transactions data. If an error occurs during the API call,
+ * it will be caught, logged to the console, and rethrown.
+ */
+export declare const getAllTransactions: () => Promise<TransactionsResponse>;
+export {};

package/dist/lib/core/getAllTranstions.js

@@ -0,0 +1,18 @@
+import { get } from '../../utils/api.js';
+/**
+ * The function getAllTransactions fetches all transactions from a specified endpoint and handles any
+ * errors that occur.
+ * @returns The `getAllTransactions` function is returning the result of the `get` function called with
+ * the '/pub/transactions' endpoint. The result is expected to be of type `TransactionsResponse`. If
+ * successful, the function will return the transactions data. If an error occurs during the API call,
+ * it will be caught, logged to the console, and rethrown.
+ */
+export const getAllTransactions = async () => {
+    try {
+        return await get('/pub/transactions');
+    }
+    catch (err) {
+        console.error('Error fetching Transactions:', err);
+        throw err;
+    }
+};

package/dist/lib/core/getBankAccounts.d.ts

@@ -0,0 +1,18 @@
+type GetBankAccountsType = {
+    id: string;
+    accountName: string;
+    accountNumber: string;
+    bank: string;
+};
+/**
+ * Fetches a list of added bank accounts from the public API endpoint.
+ * Returns an array of bank account objects or throws an error if the request fails.
+ *
+ * Returns:
+ *   An array of objects, each containing id, accountName, accountNumber, and bank of a bank account.
+ *
+ * Raises:
+ *   Throws an error if the request fails.
+ */
+export declare const getBankAccounts: (apiKey: string) => Promise<GetBankAccountsType[]>;
+export {};

package/dist/lib/core/getBankAccounts.js

@@ -0,0 +1,22 @@
+import { get } from "../../utils/api.js";
+/**
+ * Fetches a list of added bank accounts from the public API endpoint.
+ * Returns an array of bank account objects or throws an error if the request fails.
+ *
+ * Returns:
+ *   An array of objects, each containing id, accountName, accountNumber, and bank of a bank account.
+ *
+ * Raises:
+ *   Throws an error if the request fails.
+ */
+export const getBankAccounts = async (apiKey) => {
+    try {
+        return await get(`/pub/bank-account`, {}, {
+            Authorization: `Bearer ${apiKey}`,
+        });
+    }
+    catch (err) {
+        console.error("Error fetching bank accounts:", err);
+        throw err;
+    }
+};

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

@@ -0,0 +1,17 @@
+type BankType = {
+    id: string;
+    name: string;
+    country: string;
+};
+/**
+ * Fetches a list of banks from the public API endpoint.
+ * Returns an array of bank objects or throws an error if the request fails.
+ *
+ * Returns:
+ *   An array of objects, each containing id, name, and country of a bank.
+ *
+ * Raises:
+ *   Throws an error if the request fails.
+ */
+export declare const getBanks: (token: string) => Promise<BankType[]>;
+export {};

package/dist/lib/core/getBanks.js

@@ -0,0 +1,22 @@
+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.
+ *
+ * Returns:
+ *   An array of objects, each containing id, name, and country of a bank.
+ *
+ * Raises:
+ *   Throws an error if the request fails.
+ */
+export const getBanks = async (token) => {
+    try {
+        return await get(`/pub/bank`, {}, {
+            Authorization: `Bearer ${token}`,
+        });
+    }
+    catch (err) {
+        console.error('Error fetching Banks:', err);
+        throw err;
+    }
+};

package/dist/lib/core/getRateByAmount.d.ts

@@ -0,0 +1,27 @@
+type RateByAmountType = {
+    rate: {
+        baseCurrency: string;
+        targetCurrency: string;
+        rate: number;
+    };
+    amounts: {
+        userTax: number;
+        merchantTax: number;
+        amountUSD: number;
+        userAmountFiat: number;
+    };
+};
+/**
+ * The function `getRateByAmount` fetches a rate based on a specified amount asynchronously.
+ * @param {number} amount - The `amount` parameter in the `getRateByAmount` function is a number
+ * representing the amount for which you want to retrieve the rate. This function makes an asynchronous
+ * request to the `/pub/rate` endpoint with the specified amount to fetch the rate information. If
+ * successful, it returns the rate
+ * @returns The `getRateByAmount` function is returning a Promise that resolves to the rate for a
+ * specific amount. The rate is fetched from the specified URL endpoint `/pub/rate` with the provided
+ * amount as a parameter. If the rate is successfully fetched, it will be returned. If there is an
+ * error during the fetching process, an error message will be logged to the console and the error will
+ * be
+ */
+export declare const getRateByAmount: (amount: number) => Promise<RateByAmountType>;
+export {};

package/dist/lib/core/getRateByAmount.js

@@ -0,0 +1,23 @@
+import { get } from '../../utils/api.js';
+/**
+ * The function `getRateByAmount` fetches a rate based on a specified amount asynchronously.
+ * @param {number} amount - The `amount` parameter in the `getRateByAmount` function is a number
+ * representing the amount for which you want to retrieve the rate. This function makes an asynchronous
+ * request to the `/pub/rate` endpoint with the specified amount to fetch the rate information. If
+ * successful, it returns the rate
+ * @returns The `getRateByAmount` function is returning a Promise that resolves to the rate for a
+ * specific amount. The rate is fetched from the specified URL endpoint `/pub/rate` with the provided
+ * amount as a parameter. If the rate is successfully fetched, it will be returned. If there is an
+ * error during the fetching process, an error message will be logged to the console and the error will
+ * be
+ */
+export const getRateByAmount = async (amount) => {
+    const url = '/pub/rate';
+    try {
+        return await get(`${url}/${amount}`);
+    }
+    catch (err) {
+        console.error('Error fetching Rate by Amount:', err);
+        throw err;
+    }
+};

package/dist/lib/core/getRateByType.d.ts

@@ -0,0 +1,18 @@
+import { RateType } from '../../utils/enums.js';
+type RateByType = {
+    baseCurrency: string;
+    targetCurrency: string;
+    isActive: true;
+    rate: number;
+    type: string;
+};
+/**
+ * This function fetches a rate based on a specified rate type asynchronously.
+ * @param {RateType} rateType - RateType is a type that specifies the type of rate being requested,
+ * such as 'standard', 'premium', 'discount', etc.
+ * @returns The `getRateByType` function is returning a Promise that resolves to a `RateByType` object
+ * fetched from the specified URL based on the `rateType` parameter. If an error occurs during the
+ * fetching process, the function will log an error message and rethrow the error.
+ */
+export declare const getRateByType: (rateType: RateType) => Promise<RateByType>;
+export {};

package/dist/lib/core/getRateByType.js

@@ -0,0 +1,19 @@
+import { get } from '../../utils/api.js';
+/**
+ * This function fetches a rate based on a specified rate type asynchronously.
+ * @param {RateType} rateType - RateType is a type that specifies the type of rate being requested,
+ * such as 'standard', 'premium', 'discount', etc.
+ * @returns The `getRateByType` function is returning a Promise that resolves to a `RateByType` object
+ * fetched from the specified URL based on the `rateType` parameter. If an error occurs during the
+ * fetching process, the function will log an error message and rethrow the error.
+ */
+export const getRateByType = async (rateType) => {
+    const url = '/pub/rate';
+    try {
+        return await get(`${url}/${rateType}`);
+    }
+    catch (err) {
+        console.error('Error fetching Rate by Rate Type:', err);
+        throw err;
+    }
+};

package/dist/lib/core/getTXPoolAddress.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Fetches the transaction pool address from the public API endpoint.
+ * Returns the address as a string or throws an error if the request fails.
+ *
+ * Returns:
+ *   The transaction pool address as a string.
+ *
+ * Raises:
+ *   Throws an error if the request fails.
+ */
+export declare const getTXPoolAddress: () => Promise<{
+    address: string;
+}>;

package/dist/lib/core/getTXPoolAddress.js

@@ -0,0 +1,20 @@
+import { get } from "../../utils/api.js";
+/**
+ * Fetches the transaction pool address from the public API endpoint.
+ * Returns the address as a string or throws an error if the request fails.
+ *
+ * Returns:
+ *   The transaction pool address as a string.
+ *
+ * Raises:
+ *   Throws an error if the request fails.
+ */
+export const getTXPoolAddress = async () => {
+    try {
+        return await get("/pub/txpool-address");
+    }
+    catch (err) {
+        console.error("Error fetching TX Pool Address:", err);
+        throw err;
+    }
+};

package/dist/lib/core/getTokenValue.d.ts

@@ -0,0 +1,20 @@
+type TokenValueType = {
+    amount: number;
+    usdcValue: number;
+    mint: string;
+};
+/**
+ * The function `getTokenValue` asynchronously fetches the value of a token based on the specified
+ * amount and token mint.
+ * @param {number} amount - The `amount` parameter is a number representing the quantity of tokens for
+ * which you want to retrieve the value.
+ * @param {string} mint_token - The `mint_token` parameter in the `getTokenValue` function represents
+ * the unique identifier for a specific token. It is used to specify which token you are interested in
+ * when fetching its value.
+ * @returns The `getTokenValue` function is returning the result of the `get` function call with the
+ * URL `/value?amount=&mint=` as its argument. The `get` function is likely
+ * making an HTTP request to fetch the token value based on the provided amount and mint token. If
+ * successful, the function will return the token value. If there is an error during
+ */
+export declare const getTokenValue: (amount: number, mint_token: string) => Promise<TokenValueType>;
+export {};

package/dist/lib/core/getTokenValue.js

@@ -0,0 +1,24 @@
+import { get } from '../../utils/api.js';
+/**
+ * The function `getTokenValue` asynchronously fetches the value of a token based on the specified
+ * amount and token mint.
+ * @param {number} amount - The `amount` parameter is a number representing the quantity of tokens for
+ * which you want to retrieve the value.
+ * @param {string} mint_token - The `mint_token` parameter in the `getTokenValue` function represents
+ * the unique identifier for a specific token. It is used to specify which token you are interested in
+ * when fetching its value.
+ * @returns The `getTokenValue` function is returning the result of the `get` function call with the
+ * URL `/value?amount=&mint=` as its argument. The `get` function is likely
+ * making an HTTP request to fetch the token value based on the provided amount and mint token. If
+ * successful, the function will return the token value. If there is an error during
+ */
+export const getTokenValue = async (amount, mint_token) => {
+    const url = '/pub/rate';
+    try {
+        return await get(`${url}/value?amount=${amount}&mint=${mint_token}`);
+    }
+    catch (err) {
+        console.log('Error fetching Token Value:', err);
+        throw err;
+    }
+};

package/dist/lib/core/getTransaction.d.ts

@@ -0,0 +1,26 @@
+import { Currency, TransactionStatus, TransactionType } from '../../utils/enums.js';
+export type TransactionResponse = {
+    id: string;
+    address: string;
+    mint: string;
+    currency: Currency;
+    amount: number;
+    usdcAmount: number;
+    fiatAmount: number;
+    sender: string;
+    receipiant: string;
+    rate: number;
+    status: TransactionStatus;
+    transactionType: TransactionType;
+    createdAt: string | Date;
+};
+/**
+ * The function `getTransaction` asynchronously fetches a transaction with a specified ID and handles
+ * any errors that may occur.
+ * @param {string} id - The `id` parameter in the `getTransaction` function is a string representing
+ * the unique identifier of the transaction that you want to retrieve.
+ * @returns The `getTransaction` function is returning the result of the `get` function called with the
+ * endpoint `/pub/transactions/`. This function is fetching transaction data based on the provided
+ * `id`.
+ */
+export declare const getTransaction: (token: string, id: string) => Promise<TransactionResponse>;

package/dist/lib/core/getTransaction.js

@@ -0,0 +1,21 @@
+import { get } from '../../utils/api.js';
+/**
+ * The function `getTransaction` asynchronously fetches a transaction with a specified ID and handles
+ * any errors that may occur.
+ * @param {string} id - The `id` parameter in the `getTransaction` function is a string representing
+ * the unique identifier of the transaction that you want to retrieve.
+ * @returns The `getTransaction` function is returning the result of the `get` function called with the
+ * endpoint `/pub/transactions/`. This function is fetching transaction data based on the provided
+ * `id`.
+ */
+export const getTransaction = async (token, id) => {
+    try {
+        return await get(`/pub/transactions/${id}`, {}, {
+            Authorization: `Bearer ${token}`,
+        });
+    }
+    catch (err) {
+        console.error('Error fetching Transaction:', err);
+        throw err;
+    }
+};

package/dist/lib/core/getWallet.d.ts

@@ -0,0 +1,24 @@
+export type WalletType = {
+    id: string;
+    publicKey: string;
+    bankAccount: {
+        id: string;
+        accountName: string;
+        accountNumber: string;
+        bank: string;
+    };
+};
+/**
+ * Fetches wallet details for a given public key from the public API endpoint.
+ * Returns the wallet information including bank account details or throws an error if the request fails.
+ *
+ * Args:
+ *   publicKey: The public key of the wallet to fetch.
+ *
+ * Returns:
+ *   An object containing wallet id, publicKey, and associated bank account details.
+ *
+ * Raises:
+ *   Throws an error if the request fails.
+ */
+export declare const getWallet: (publicKey: string) => Promise<WalletType>;