paj_ramp 1.0.0

package/dist/lib/resolveBankAccount.js

@@ -0,0 +1,24 @@
+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.
+ *
+ * Args:
+ *   bankId: The ID of the bank.
+ *   accountNumber: The bank account number to resolve.
+ *
+ * Returns:
+ *   An object containing accountName, accountNumber, and bank details (id, name, code, country).
+ *
+ * Raises:
+ *   Throws an error if the request fails.
+ */
+export const resolveBankAccount = async (bankId, accountNumber) => {
+    try {
+        return await get(`/pub/bankaccount/resolve/?bankId=${bankId}&accountNumber=${accountNumber}`);
+    }
+    catch (err) {
+        console.error('Error resolving bank account:', err);
+        throw err;
+    }
+};

package/dist/lib/switchWalletBankAccount.d.ts

@@ -0,0 +1,2 @@
+import { WalletType } from "./getWallet.js";
+export declare const switchWalletBankAccount: (apiKey: string, accountId: string, walletId: string, secretKey: Uint8Array) => Promise<WalletType>;

package/dist/lib/switchWalletBankAccount.js

@@ -0,0 +1,19 @@
+import { patch } from "../utils/api.js";
+import { getWalletBody } from "../utils/getWalletBody.js";
+export const switchWalletBankAccount = async (apiKey, accountId, walletId, secretKey) => {
+    try {
+        const body = await getWalletBody(accountId, secretKey);
+        if (!body) {
+            throw new Error("Failed to get wallet body");
+        }
+        console.log(body);
+        const response = await patch(`/pub/wallet/${walletId}`, body, {
+            Authorization: `Bearer ${apiKey}`,
+        });
+        return response;
+    }
+    catch (err) {
+        console.error("Error switching wallet bank account:", err);
+        throw err;
+    }
+};

package/dist/lib/verify.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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.
+ *
+ * Args:
+ *   email: The user's email address.
+ *   otp: The one-time password for verification.
+ *   deviceSignature: The device signature for additional security.
+ *
+ * Returns:
+ *   An object containing email, isActive, expiresAt, and token.
+ *
+ * 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;
+}>;

package/dist/lib/verify.js

@@ -0,0 +1,25 @@
+import { post } from '../utils/api.js';
+/**
+ * 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.
+ *
+ * Args:
+ *   email: The user's email address.
+ *   otp: The one-time password for verification.
+ *   deviceSignature: The device signature for additional security.
+ *
+ * Returns:
+ *   An object containing email, isActive, expiresAt, and token.
+ *
+ * Raises:
+ *   Throws an error if the request fails.
+ */
+export const verify = async (email, otp, deviceSignature) => {
+    try {
+        return await post('/pub/verify', { email, otp, deviceSignature }, { 'x-api-key': '3ada687e-78d1-45f3-933d-c992adcc2bbb' });
+    }
+    catch (err) {
+        console.error('Error verifying:', err);
+        throw err;
+    }
+};

package/dist/utils/api.d.ts

@@ -0,0 +1,80 @@
+/**
+ * Sends a GET request to the specified URL with optional query parameters and headers.
+ * Returns the response data of type T or throws an error if the request fails.
+ *
+ * Args:
+ *   url: The endpoint URL for the GET request.
+ *   params: Optional query parameters to include in the request.
+ *   headers: Optional headers to include in the request.
+ *
+ * Returns:
+ *   The response data of type T.
+ *
+ * Raises:
+ *   Throws the error response data or error message if the request fails.
+ */
+export declare function get<T>(url: string, params?: any, headers?: any): Promise<T>;
+/**
+ * Sends a POST request to the specified URL with optional data and headers.
+ * Returns the response data of type T or throws an error if the request fails.
+ *
+ * Args:
+ *   url: The endpoint URL for the POST request.
+ *   data: Optional data to include in the request body.
+ *   headers: Optional headers to include in the request.
+ *
+ * Returns:
+ *   The response data of type T.
+ *
+ * Raises:
+ *   Throws the error response data or error message if the request fails.
+ */
+export declare function post<T>(url: string, data?: any, headers?: any): Promise<T>;
+/**
+ * Sends a PUT request to the specified URL with optional data and headers.
+ * Returns the response data of type T or throws an error if the request fails.
+ *
+ * Args:
+ *   url: The endpoint URL for the PUT request.
+ *   data: Optional data to include in the request body.
+ *   headers: Optional headers to include in the request.
+ *
+ * Returns:
+ *   The response data of type T.
+ *
+ * Raises:
+ *   Throws the error response data or error message if the request fails.
+ */
+export declare function put<T>(url: string, data?: any, headers?: any): Promise<T>;
+/**
+ * Sends a PATCH request to the specified URL with optional data and headers.
+ * Returns the response data of type T or throws an error if the request fails.
+ *
+ * Args:
+ *   url: The endpoint URL for the PATCH request.
+ *   data: Optional data to include in the request body.
+ *   headers: Optional headers to include in the request.
+ *
+ * Returns:
+ *   The response data of type T.
+ *
+ * Raises:
+ *   Throws the error response data or error message if the request fails.
+ */
+export declare function patch<T>(url: string, data?: any, headers?: any): Promise<T>;
+/**
+ * Sends a DELETE request to the specified URL with optional data and headers.
+ * Returns the response data of type T or throws an error if the request fails.
+ *
+ * Args:
+ *   url: The endpoint URL for the DELETE request.
+ *   data: Optional data to include in the request body.
+ *   headers: Optional headers to include in the request.
+ *
+ * Returns:
+ *   The response data of type T.
+ *
+ * Raises:
+ *   Throws the error response data or error message if the request fails.
+ */
+export declare function del<T>(url: string, data?: any, headers?: any): Promise<T>;

package/dist/utils/api.js

@@ -0,0 +1,122 @@
+import api from './axios.js';
+/**
+ * Sends an HTTP request using the specified method, URL, and options.
+ * Returns the response data or throws an error if the request fails.
+ *
+ * Args:
+ *   method: The HTTP method to use ('get', 'post', 'put', 'patch', 'delete').
+ *   url: The endpoint URL for the request.
+ *   options: Optional configuration including data, params, and headers.
+ *
+ * Returns:
+ *   The response data of type T.
+ *
+ * Raises:
+ *   Throws the error response data or error message if the request fails.
+ */
+async function request(method, url, options = {}) {
+    try {
+        const response = await api.request({
+            method,
+            url,
+            data: options.data,
+            params: options.params,
+            headers: options.headers,
+        });
+        return response.data;
+    }
+    catch (error) {
+        throw error.response?.data || error.message;
+    }
+}
+// Named helper functions
+/**
+ * Sends a GET request to the specified URL with optional query parameters and headers.
+ * Returns the response data of type T or throws an error if the request fails.
+ *
+ * Args:
+ *   url: The endpoint URL for the GET request.
+ *   params: Optional query parameters to include in the request.
+ *   headers: Optional headers to include in the request.
+ *
+ * Returns:
+ *   The response data of type T.
+ *
+ * Raises:
+ *   Throws the error response data or error message if the request fails.
+ */
+export function get(url, params, headers) {
+    return request('get', url, { params, headers });
+}
+/**
+ * Sends a POST request to the specified URL with optional data and headers.
+ * Returns the response data of type T or throws an error if the request fails.
+ *
+ * Args:
+ *   url: The endpoint URL for the POST request.
+ *   data: Optional data to include in the request body.
+ *   headers: Optional headers to include in the request.
+ *
+ * Returns:
+ *   The response data of type T.
+ *
+ * Raises:
+ *   Throws the error response data or error message if the request fails.
+ */
+export function post(url, data, headers) {
+    return request('post', url, { data, headers });
+}
+/**
+ * Sends a PUT request to the specified URL with optional data and headers.
+ * Returns the response data of type T or throws an error if the request fails.
+ *
+ * Args:
+ *   url: The endpoint URL for the PUT request.
+ *   data: Optional data to include in the request body.
+ *   headers: Optional headers to include in the request.
+ *
+ * Returns:
+ *   The response data of type T.
+ *
+ * Raises:
+ *   Throws the error response data or error message if the request fails.
+ */
+export function put(url, data, headers) {
+    return request('put', url, { data, headers });
+}
+/**
+ * Sends a PATCH request to the specified URL with optional data and headers.
+ * Returns the response data of type T or throws an error if the request fails.
+ *
+ * Args:
+ *   url: The endpoint URL for the PATCH request.
+ *   data: Optional data to include in the request body.
+ *   headers: Optional headers to include in the request.
+ *
+ * Returns:
+ *   The response data of type T.
+ *
+ * Raises:
+ *   Throws the error response data or error message if the request fails.
+ */
+export function patch(url, data, headers) {
+    return request('patch', url, { data, headers });
+}
+/**
+ * Sends a DELETE request to the specified URL with optional data and headers.
+ * Returns the response data of type T or throws an error if the request fails.
+ *
+ * Args:
+ *   url: The endpoint URL for the DELETE request.
+ *   data: Optional data to include in the request body.
+ *   headers: Optional headers to include in the request.
+ *
+ * Returns:
+ *   The response data of type T.
+ *
+ * Raises:
+ *   Throws the error response data or error message if the request fails.
+ */
+export function del(url, data, headers) {
+    return request('delete', url, { data, headers });
+}

package/dist/utils/axios.d.ts

@@ -0,0 +1,2 @@
+declare const api: import("axios").AxiosInstance;
+export default api;

package/dist/utils/axios.js

@@ -0,0 +1,8 @@
+import axios from 'axios';
+const api = axios.create({
+    baseURL: 'https://api-staging.paj.cash',
+    headers: {
+        'Content-Type': 'application/json',
+    },
+});
+export default api;

package/dist/utils/generateSignature.d.ts

@@ -0,0 +1,12 @@
+import { Payload } from './verifySignature.js';
+/**
+ * Generates a signature for the given payload using the provided secret key.
+ * Returns the generated signature as a base58-encoded string.
+ *
+ * Returns:
+ *   The generated signature as a base58-encoded string.
+ *
+ * Raises:
+ *   Throws an error if the payload is invalid or if the signing process fails.
+ */
+export declare function generateSignature(payload: Payload, secretKey: Uint8Array): string;

package/dist/utils/generateSignature.js

@@ -0,0 +1,17 @@
+import bs58 from 'bs58';
+import nacl from 'tweetnacl';
+/**
+ * Generates a signature for the given payload using the provided secret key.
+ * Returns the generated signature as a base58-encoded string.
+ *
+ * Returns:
+ *   The generated signature as a base58-encoded string.
+ *
+ * Raises:
+ *   Throws an error if the payload is invalid or if the signing process fails.
+ */
+export function generateSignature(payload, secretKey) {
+    const message = JSON.stringify(payload);
+    const signature = nacl.sign.detached(new TextEncoder().encode(message), secretKey);
+    return bs58.encode(signature);
+}

package/dist/utils/getWalletBody.d.ts

@@ -0,0 +1,15 @@
+import { Payload } from '../utils/verifySignature.js';
+/**
+ * Generates a signature, verifies it and returns the wallet body.
+ * Returns an object containing the payload and signature.
+ *
+ * Returns:
+ *   An object containing the payload and signature.
+ *
+ * Raises:
+ *   Throws an error if the wallet file is not found or if the secret key is invalid.
+ */
+export declare const getWalletBody: (accountId: string, secretKey: Uint8Array) => Promise<{
+    payload: Payload;
+    signature: string;
+} | undefined>;

package/dist/utils/getWalletBody.js

@@ -0,0 +1,36 @@
+import { Keypair } from '@solana/web3.js';
+import { verifySignature } from '../utils/verifySignature.js';
+import { generateSignature } from '../utils/generateSignature.js';
+/**
+ * Generates a signature, verifies it and returns the wallet body.
+ * Returns an object containing the payload and signature.
+ *
+ * Returns:
+ *   An object containing the payload and signature.
+ *
+ * Raises:
+ *   Throws an error if the wallet file is not found or if the secret key is invalid.
+ */
+export const getWalletBody = async (accountId, secretKey) => {
+    try {
+        const keypair = Keypair.fromSecretKey(secretKey);
+        let timestamp = new Date().toISOString();
+        const payload = {
+            publicKey: keypair.publicKey.toString(),
+            accountId,
+            timestamp,
+        };
+        const signature = generateSignature(payload, keypair.secretKey);
+        const isValid = verifySignature(payload, signature, keypair.publicKey);
+        const body = {
+            payload,
+            signature,
+        };
+        if (isValid) {
+            return body;
+        }
+    }
+    catch (err) {
+        console.error('Error getting wallet body:', err);
+    }
+};

package/dist/utils/verifySignature.d.ts

@@ -0,0 +1,17 @@
+import { PublicKey } from '@solana/web3.js';
+export type Payload = {
+    publicKey: string;
+    accountId: string;
+    timestamp: string;
+};
+/**
+ * Verifies the signature of the given payload using the provided public key.
+ * Returns true if the signature is valid, false otherwise.
+ *
+ * Returns:
+ *   boolean - Indicates whether the signature is valid.
+ *
+ * Raises:
+ *   Throws an error if the payload is invalid or if the verification process fails.
+ */
+export declare function verifySignature(payload: Payload, signatureBase58: string, publicKey: PublicKey): boolean;

package/dist/utils/verifySignature.js

@@ -0,0 +1,18 @@
+import bs58 from 'bs58';
+import nacl from 'tweetnacl';
+/**
+ * Verifies the signature of the given payload using the provided public key.
+ * Returns true if the signature is valid, false otherwise.
+ *
+ * Returns:
+ *   boolean - Indicates whether the signature is valid.
+ *
+ * Raises:
+ *   Throws an error if the payload is invalid or if the verification process fails.
+ */
+export function verifySignature(payload, signatureBase58, publicKey) {
+    const messageBytes = new TextEncoder().encode(JSON.stringify(payload));
+    const signature = bs58.decode(signatureBase58);
+    const publicKeyBytes = publicKey.toBytes();
+    return nacl.sign.detached.verify(messageBytes, signature, publicKeyBytes);
+}

package/generateWallet.js

@@ -0,0 +1,8 @@
+import { Keypair } from '@solana/web3.js';
+import fs from 'fs';
+
+const keypair = Keypair.generate();
+const secretKey = Array.from(keypair.secretKey);
+
+fs.writeFileSync('wallet.json', JSON.stringify(secretKey));
+console.log('✅ wallet.json generated successfully');

package/index.ts

@@ -0,0 +1,20 @@
+//Web3.js - A JavaScript library for interacting with the Web3 ecosystem.
+
+//Wallet Info
+export { getTXPoolAddress } from './lib/getTXPoolAddress.js';
+export { getRate } from './lib/getRate.js';
+
+//Session Management
+export { initiate } from './lib/initiate.js';
+export { verify } from './lib/verify.js';
+
+//Banking Operations
+export { getBanks } from './lib/getBanks.js';
+export { resolveBankAccount } from './lib/resolveBankAccount.js';
+export { addBankAccount } from './lib/addBankAccount.js';
+export { getBankAccounts } from './lib/getBankAccounts.js';
+
+//Wallet Operations
+export { getWallet } from './lib/getWallet.js';
+export { addWallet } from './lib/addWallet.js';
+export { switchWalletBankAccount } from './lib/switchWalletBankAccount.js';

package/jest.config.js

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

package/lib/addBankAccount.ts

@@ -0,0 +1,39 @@
+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: string, bankId: string, accountNumber: string) => {
+  try {
+    return await post<{
+      id: string;
+      accountName: string;
+      accountNumber: string;
+      bank: string;
+    }>(
+      '/pub/bankAccount',
+      {
+        bankId,
+        accountNumber,
+      },
+      {
+        Authorization: `Bearer ${token}`,
+      }
+    );
+  } catch (err) {
+    console.error('Error adding bank account:', err);
+    throw err;
+  }
+};

package/lib/addWallet.ts

@@ -0,0 +1,33 @@
+import { post } from "../utils/api.js";
+import { getWalletBody } from "../utils/getWalletBody.js";
+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 const addWallet = async (
+  apiKey: string,
+  accountId: string,
+  secretKey: Uint8Array
+) => {
+  try {
+    const body = await getWalletBody(accountId, secretKey);
+    if (!body) {
+      throw new Error("Failed to get wallet body");
+    }
+
+    const response = await post<WalletType>("/pub/wallet", body, {
+      Authorization: `Bearer ${apiKey}`,
+    });
+  } catch (err) {
+    console.error("Error adding wallet:", err);
+    throw err;
+  }
+};

package/lib/getBankAccounts.ts

@@ -0,0 +1,33 @@
+import { get } from "../utils/api.js";
+
+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 const getBankAccounts = async (apiKey: string) => {
+  try {
+    return await get<GetBankAccountsType[]>(
+      `/pub/bankaccount`,
+      {},
+      {
+        Authorization: `Bearer ${apiKey}`,
+      }
+    );
+  } catch (err) {
+    console.error("Error fetching bank accounts:", err);
+    throw err;
+  }
+};

package/lib/getBanks.ts

@@ -0,0 +1,25 @@
+import { get } from '../utils/api.js';
+
+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 const getBanks = async () => {
+  try {
+    return await get<BankType[]>(`/pub/bank`);
+  } catch (err) {
+    console.error('Error fetching Banks:', err);
+    throw err;
+  }
+};

package/lib/getRate.ts

@@ -0,0 +1,35 @@
+import { get } from '../utils/api.js';
+
+type RateType = {
+  baseCurrency: string;
+  targetCurrency: string;
+  rate: number;
+  amounts: {
+    userTax: number;
+    merchantTax: number;
+    amountUSD: number;
+    userAmountFiat: number;
+  };
+};
+
+/**
+ * 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.
+ *
+ * Args:
+ *   amount: The amount for which to fetch the rate. If not provided or falsy, fetches the default rate.
+ *
+ * Returns:
+ *   An object with baseCurrency, targetCurrency, rate, and amounts (userTax, merchantTax, amountUSD, userAmountFiat).
+ *
+ * Raises:
+ *   Throws an error if the request fails.
+ */
+export const getRate = async (amount: number) => {
+  try {
+    return await get<RateType>(amount ? `/pub/rate/${amount}` : '/pub/rate');
+  } catch (err) {
+    console.error('Error fetching Rate:', err);
+    throw err;
+  }
+};

package/lib/getTXPoolAddress.ts

@@ -0,0 +1,22 @@
+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<{
+      address: string;
+    }>('/pub/txpool-address');
+  } catch (err) {
+    console.error('Error fetching TX Pool Address:', err);
+    throw err;
+  }
+};