Cngn-typescript-library NPM

cngn-typescript-library

cngn-typescript-library is a TypeScript library for interacting with the cNGN API. It provides a simple interface for various operations such as checking balance, withdraw, depositing for redemption, creating virtual accounts, generating wallet addresses, and more.

Installation

To install cngn-typescript-library and its dependencies, run:

npm install cngn-typescript-library

Usage

First, import the necessary classes and types:

import {
  cNGNManager,
  WalletManager,
  Secrets,
  IWithdraw,
  RedeemAsset,
  CreateVirtualAccount,
  UpdateExternalAccount,
  Network,
  Swap
} from 'cngn-typescript-library';

Then, create an instance of cNGNManager with your secrets:

const secrets: Secrets = {
    apiKey: 'your-api-key',
    privateKey: 'your-private-key',
    encryptionKey: 'your-encryption-key'
};

const manager = new cNGNManager(secrets);

// Example: Get balance
manager.getBalance().then(balance => console.log(balance));

Networks

The library supports multiple blockchain networks:

Network.bsc - Binance Smart Chain
Network.atc - Asset Chain
Network.xbn - Bantu Chain
Network.eth - Ethereum
Network.matic - Polygon (Matic)
Network.trx - Tron
Network.base - Base

Available Methods

cNGNManager Methods

Get Balance

const balance = await manager.getBalance();

Get Transaction History

const page = 1;
const limit = 10;
const transactions = await manager.getTransactionHistory(page, limit);

Withdraw

const withdrawData: IWithdraw = {
    amount: 1000,
    address: '0x789...',
    network: Network.bsc,
    shouldSaveAddress: true
};
const withdrawResult = await manager.withdraw(withdrawData);

Verify Withdrawal Reference

const tnxRef: string = '123-456-789-789405';
const withdrawResult = await manager.verifyWithdrawal(tnxRef);

Redeem Asset

const redeemData: RedeemAsset = {
    amount: 1000,
    bankCode: '123',
    accountNumber: '1234567890',
    saveDetails: true
};
const redeemResult = await manager.redeemAsset(redeemData);

Create Virtual Account

const mintData: CreateVirtualAccount = {
    provider: 'korapay', // default provider
    bank_code: '011'
};
const virtualAccount = await manager.createVirtualAccount(mintData);

Swap Asset

const swapData: Swap = {
    destinationNetwork: Network.bsc,
    destinationAddress: '0x123...',
    originNetwork: Network.eth,
    callbackUrl: 'https://your-callback-url.com' // optional
};
const swapResult = await manager.swapAsset(swapData);

Update Business

const updateData: UpdateExternalAccount = {
    walletAddress: {
        bscAddress: '0x123...', //Note: Only one address can be updated at a time
    },
    bankDetails: {
        bankName: 'Test Bank',
        bankAccountName: 'Test Account',
        bankAccountNumber: '1234567890'
    }
};
const updateResult = await manager.updateExternalAccounts(updateData);

Get Banks

const banks = await manager.getBanks();

WalletManager Methods

Generate Wallet Address

const wallet = await WalletManager.generateWalletAddress(Network.bsc);

Response format:

interface GeneratedWalletAddress {
    mnemonic: string;
    address: string;
    network: Network;
    privateKey: string;
}

Testing

To run the tests:

Install dependencies:

npm install

Run tests:

npm test

Run tests with coverage:

npm test --coverage

Test files follow the naming convention: *.test.ts and are located in the __tests__ directory.

Error Handling

The library implements comprehensive error handling:

try {
    const result = await manager.getBalance();
} catch (error) {
    // Error will contain detailed message about the failure
    console.error(error.message);
}

Common error types: