Toronet SDK
Overview
The Toronet SDK is a TypeScript-based toolkit for interacting with the Toronet blockchain. It empowers developers to manage wallets, query blockchain data, handle fiat transactions, verify user identity, manage virtual wallets, bridge tokens from multiple chains (Solana, Base, Polygon, BSC, Arbitrum), and more โ all from a developer-friendly interface.
Features
-
Wallet Management
- Create wallets and set Toronet Naming System (TNS) names.
- Import wallet using private key and password.
- Verify wallet password integrity.
-
Blockchain Queries
- Get latest block data.
- Retrieve blockchain status.
- Fetch historical blocks and transactions.
- Query transaction, receipt, revert reason, and events.
-
Token Balance Queries
- Retrieve balances for NGN, USD, KSH, and ToroG tokens.
-
Fiat Deposits (Multi-Currency)
- Initialize and verify fiat deposits using whitelisted project credentials.
- Supported currencies: NGN, EUR, USD, GBP, KSH, ZAR.
-
KYC Verification
- Perform identity verification.
- Check if a wallet address is KYC verified.
-
Exchange Rate Queries
- Fetch exchange rates for supported fiat and crypto assets.
-
Comprehensive Query Endpoints
- Query address roles, balances, blocks, transactions, events, and more.
- Filter transactions by currency, address, or range.
-
Virtual Wallet System
- Generate, retrieve, update, and query virtual wallets by address or ID.
-
Address Validation Utility
- Validate if a string is a valid Toronet address.
-
Advanced Keystore Operations
- Update wallet password.
- Delete keystore from server.
-
Advanced TNS Operations
- Query name by address, address by name.
- Update and delete TNS names.
- Permission management (set, update, delete permissions).
- Admin TNS operations.
-
Role Management
- Admin, Super Admin, and Debugger role operations.
- Query roles, add/remove role members.
- Initialize role systems.
-
Token Operations
- Token metadata (name, symbol, decimals).
- Allowance queries (minimum, maximum, current).
- Transaction fee queries.
- Supply queries (reserve, total cap, circulating).
- Status checks (enrollment, frozen, feature flags).
-
Advanced Currency Operations
- Owner operations: enable/disable transfer, mint, burn.
- Admin operations: freeze/unfreeze, enroll, mint, burn, set allowances.
- Fee configuration.
-
Product Management
- Get project information.
- Create, read, update products.
-
Advanced Payment Operations
- Bank list queries (USD, NGN).
- Fiat withdrawal operations.
- Bank account verification (NGN).
- Date range queries for transactions and withdrawals.
-
Advanced Query Operations
- Address transactions with date range and token filtering.
- Pagination support.
-
Multi-Chain Bridge Support
- Bridge tokens from Solana, Base, Polygon, BSC, and Arbitrum to Toronet.
- Query balances and transactions on external chains.
- Transfer tokens on supported chains.
- Initialize crypto deposits from external blockchains.
- Get bridge fee estimates.
- Solana-specific operations (address creation, validation, SPL token transfers).
Installation
npm install torosdk
Configuration
Network Selection (Testnet/Mainnet)
The SDK supports both mainnet and testnet. You can configure the network when initializing:
import { initializeSDK } from "torosdk";
initializeSDK({ network: 'testnet' });
initializeSDK({ network: 'mainnet' });
initializeSDK({
network: 'mainnet',
baseURL: 'https://custom-toronet.org',
connectWURL: 'https://custom-connectw.com'
});
Note: If you don't configure the SDK, it defaults to mainnet. All API calls will automatically use the configured network.
Usage
๐ Create a Wallet
import { createWallet } from "torosdk";
const walletAddress = await createWallet({
username: "myuser123",
password: "securePassword123"
});
console.log("Wallet Address:", walletAddress);
๐ Import Wallet from Private Key
import { importWalletFromPrivateKeyAndPassword } from "torosdk";
const address = await importWalletFromPrivateKeyAndPassword({
pvKey: "yourPrivateKeyHere",
password: "yourPasswordHere"
});
console.log("Imported Wallet Address:", address);
๐ Verify Wallet Password
import { verifyWalletPassword } from "torosdk";
const isValid = await verifyWalletPassword({
address: "0xYourAddress",
password: "yourPassword"
});
console.log("Password is correct:", isValid);
๐ฆ Get Wallet Key
import { getWalletKey } from "torosdk";
const key = await getWalletKey({
address: "0xYourWalletAddress"
});
console.log("Wallet Key:", key);
๐ Blockchain Status & Latest Block
import { getBlockchainStatus, getLatestBlockData } from "torosdk";
const status = await getBlockchainStatus();
console.log("Blockchain Status:", status);
const block = await getLatestBlockData();
console.log("Latest Block:", block);
๐ฐ Get Token Balances
import { getBalance } from "torosdk";
const balances = await getBalance({
address: "0xYourWalletAddress"
});
console.log("Token Balances:", balances);
๐งพ KYC Verification
๐น Before using this feature, ensure that you have the correct admin credentials.
KYC is required for transactions.
import { performKYCForCustomer, isAddressKYCVerified } from "torosdk";
const kycparams = {
firstName: "John",
middleName: "Doe",
lastName: "Doe",
bvn: "123456789",
currency: "NGN",
phoneNumber: "08012345678",
dob: "1990-01-01",
address: "0xYourWalletAddress",
admin: "yourWhitelistedAdminAddress",
adminpwd: "yourAdminPassword",
};
const isKYCSuccessful = await performKYCForCustomer(kycparams);
console.log("KYC Successful:", isKYCSuccessful);
const isVerified = await isAddressKYCVerified({
address: "0xYourWalletAddress"
});
console.log("KYC Verified:", isVerified);
๐ธ Fiat Deposit (Multi-Currency)
๐น Before using this feature, you must register as a project at https://payments.connectw.com/ to get admin credentials.
import { depositFunds } from "torosdk";
import { Currency } from "torosdk/types";
const depositDetails = await depositFunds({
userAddress: "0xYourWalletAddress",
username: "testUser",
amount: "1000",
currency: Currency.Kenyan_Shilling,
admin: "adminAddr",
adminpwd: "@adminPassword"
}, {
payeraddress: "123 Main St",
payercity: "Lagos",
payerstate: "Lagos",
payercountry: "Nigeria",
payerzipcode: "100001",
payerphone: "+2348012345678",
description: "Initial deposit",
success_url: "https://example.com/success",
cancel_url: "https://example.com/cancel",
paymenttype: "deposit",
feetype: "1",
exchange: "72",
reusewallet: "0",
});
console.log("Deposit Info:", depositDetails);
๐ Blockchain & Query Endpoints
import {
getSupportedAssetsExchangeRates,
getBlocksData,
getBlockchainTransactions,
getAddressRole,
getAddressBalance,
getBlockById,
getTransactionById,
getTransactionReceiptById,
getEventById,
getAddressTransactions,
getTransactionsToroWrapper,
getAddressTransactionsToro,
getTransactionsDollarWrapper,
getAddressTransactionsDollar,
getTransactionsNairaWrapper,
getAddressTransactionsNaira,
getTransactionsEuroWrapper,
getAddressTransactionsEuro,
getTransactionsPoundWrapper,
getAddressTransactionsPound,
getTransactionsEGPWrapper,
getAddressTransactionsEGP,
getTransactionsKSHWrapper,
getAddressTransactionsKSH,
getTransactionsZARWrapper,
getAddressTransactionsZAR,
getTransactionsETHWrapper,
getAddressTransactionsETH,
getTransactionsRangeWrapper,
getAddressTransactionsAuth,
isAddressUtil
} from "torosdk";
const rates = await getSupportedAssetsExchangeRates();
console.log("Exchange Rates:", rates);
const blocks = await getBlocksData(5);
console.log("Blocks:", blocks);
const txs = await getBlockchainTransactions(10);
console.log("Transactions:", txs);
const addrRole = await getAddressRole("0xYourWalletAddress");
console.log("Address Role:", addrRole);
const addrBalance = await getAddressBalance("0xYourWalletAddress");
console.log("Address Balance:", addrBalance);
const blockById = await getBlockById("latest");
console.log("Block By ID:", blockById);
const txById = await getTransactionById("0xYourTxHash");
console.log("Transaction By ID:", txById);
const txReceiptById = await getTransactionReceiptById("0xYourTxHash");
console.log("Transaction Receipt By ID:", txReceiptById);
const eventById = await getEventById("event123");
console.log("Event By ID:", eventById);
const addrTxs = await getAddressTransactions("0xYourWalletAddress", 5);
console.log("Address Transactions:", addrTxs);
const txsToro = await getTransactionsToroWrapper(5);
console.log("Transactions Toro:", txsToro);
const addrTxsToro = await getAddressTransactionsToro("0xYourWalletAddress", 5);
console.log("Address Transactions Toro:", addrTxsToro);
const txsDollar = await getTransactionsDollarWrapper(5);
console.log("Transactions Dollar:", txsDollar);
const addrTxsDollar = await getAddressTransactionsDollar("0xYourWalletAddress", 5);
console.log("Address Transactions Dollar:", addrTxsDollar);
const txsNaira = await getTransactionsNairaWrapper(5);
console.log("Transactions Naira:", txsNaira);
const addrTxsNaira = await getAddressTransactionsNaira("0xYourWalletAddress", 5);
console.log("Address Transactions Naira:", addrTxsNaira);
const txsEuro = await getTransactionsEuroWrapper(5);
console.log("Transactions Euro:", txsEuro);
const addrTxsEuro = await getAddressTransactionsEuro("0xYourWalletAddress", 5);
console.log("Address Transactions Euro:", addrTxsEuro);
const txsPound = await getTransactionsPoundWrapper(5);
console.log("Transactions Pound:", txsPound);
const addrTxsPound = await getAddressTransactionsPound("0xYourWalletAddress", 5);
console.log("Address Transactions Pound:", addrTxsPound);
const txsEGP = await getTransactionsEGPWrapper(5);
console.log("Transactions EGP:", txsEGP);
const addrTxsEGP = await getAddressTransactionsEGP("0xYourWalletAddress", 5);
console.log("Address Transactions EGP:", addrTxsEGP);
const txsKSH = await getTransactionsKSHWrapper(5);
console.log("Transactions KSH:", txsKSH);
const addrTxsKSH = await getAddressTransactionsKSH("0xYourWalletAddress", 5);
console.log("Address Transactions KSH:", addrTxsKSH);
const txsZAR = await getTransactionsZARWrapper(5);
console.log("Transactions ZAR:", txsZAR);
const addrTxsZAR = await getAddressTransactionsZAR("0xYourWalletAddress", 5);
console.log("Address Transactions ZAR:", addrTxsZAR);
const txsETH = await getTransactionsETHWrapper(5);
console.log("Transactions ETH:", txsETH);
const addrTxsETH = await getAddressTransactionsETH("0xYourWalletAddress", 5);
console.log("Address Transactions ETH:", addrTxsETH);
const txsRange = await getTransactionsRangeWrapper(0, 10);
console.log("Transactions Range:", txsRange);
const addrTxsAuth = await getAddressTransactionsAuth("0xYourWalletAddress", 5);
console.log("Address Transactions Auth:", addrTxsAuth);
const isAddrValid = await isAddressUtil("0xYourWalletAddress");
console.log("Is Address Valid:", isAddrValid);
๐ฆ Virtual Wallets
import {
createVirtualWallet,
fetchVirtualWallet,
fetchVirtualWalletByAddress,
updateVirtualWalletTxs
} from "torosdk";
const virtualWallet = await createVirtualWallet({
address: "0xYourWalletAddress",
payername: "Demo User",
currency: Currency.Naira,
admin: "0xadminaddress",
adminpwd: "adminpassword",
});
console.log("Created Virtual Wallet:", virtualWallet);
const fetchedVirtualWallet = await fetchVirtualWallet({
virtualwallet: "8900610225",
admin: "0xadminaddress",
adminpwd: "adminpassword",
});
console.log("Fetched Virtual Wallet:", fetchedVirtualWallet);
const fetchedVirtualWalletByAddress = await fetchVirtualWalletByAddress({
address: "0xYourWalletAddress",
admin: "0xadminaddress",
adminpwd: "adminpassword",
});
console.log("Fetched Virtual Wallet By Address:", fetchedVirtualWalletByAddress);
const updatedVirtualWalletTxs = await updateVirtualWalletTxs({
walletaddress: "8900610225",
admin: "0xadminaddress",
adminpwd: "adminpassword",
});
console.log("Updated Virtual Wallet Transactions:", updatedVirtualWalletTxs);
๐ Update Wallet Password
import { updatePassword } from "torosdk";
const result = await updatePassword({
address: "0xYourWalletAddress",
oldPassword: "oldPassword123",
newPassword: "newPassword456"
});
console.log("Password updated:", result);
๐๏ธ Delete Wallet
import { deleteWallet } from "torosdk";
const result = await deleteWallet({
address: "0xYourWalletAddress",
password: "yourPassword"
});
console.log("Wallet deleted:", result);
๐ Advanced TNS Operations
import {
getName,
getAddr,
updateName,
deleteName,
isAddrAssigned,
adminSetName
} from "torosdk";
const name = await getName({ address: "0xAddress" });
const address = await getAddr({ name: "username" });
const isAssigned = await isAddrAssigned({ address: "0xAddress" });
await updateName({
address: "0xAddress",
password: "password",
username: "newusername"
});
await deleteName({
address: "0xAddress",
password: "password"
});
await adminSetName({
address: "0xAddress",
username: "newusername",
admin: "0xAdminAddress",
adminpwd: "adminPassword"
});
๐ฅ Role Management
import {
isAdmin,
addAdmin,
removeAdmin,
isSuperAdmin,
addSuperAdmin,
isDebugger
} from "torosdk";
const isAddrAdmin = await isAdmin({ address: "0xAddress" });
const isAddrSuperAdmin = await isSuperAdmin({ address: "0xAddress" });
const isAddrDebugger = await isDebugger({ address: "0xAddress" });
await addAdmin({
address: "0xSuperAdminAddress",
password: "superAdminPassword",
adminAddress: "0xNewAdminAddress"
});
await removeAdmin({
address: "0xSuperAdminAddress",
password: "superAdminPassword",
adminAddress: "0xAdminToRemove"
});
๐ช Token Operations
import {
getTokenName,
getTokenSymbol,
getTokenDecimal,
getTokenBalance,
getAllowance,
getTransactionFee,
isEnrolled,
isFrozen
} from "torosdk";
const name = await getTokenName();
const symbol = await getTokenSymbol();
const decimals = await getTokenDecimal();
const balance = await getTokenBalance({ address: "0xAddress" });
const allowance = await getAllowance({
owner: "0xOwnerAddress",
spender: "0xSpenderAddress"
});
const fee = await getTransactionFee({ amount: "1000" });
const enrolled = await isEnrolled({ address: "0xAddress" });
const frozen = await isFrozen({ address: "0xAddress" });
๐ฑ Advanced Currency Operations
import {
getCurrencyBalance,
transferCurrency,
allowTransfer,
freezeAddress,
enrollAddress,
mintCurrency,
burnCurrency
} from "torosdk";
const balance = await getCurrencyBalance({
currency: "NGN",
address: "0xAddress"
});
await transferCurrency({
currency: "NGN",
senderAddr: "0xSender",
senderPwd: "password",
receiverAddr: "0xReceiver",
amount: "1000"
});
await allowTransfer({
currency: "NGN",
address: "0xOwnerAddress",
password: "ownerPassword"
});
await freezeAddress({
currency: "NGN",
address: "0xAdminAddress",
admin: "0xAdminAddress",
adminpwd: "adminPassword",
targetAddress: "0xTargetAddress"
});
await mintCurrency({
currency: "NGN",
address: "0xAdminAddress",
admin: "0xAdminAddress",
adminpwd: "adminPassword",
targetAddress: "0xRecipientAddress",
amount: "1000"
});
๐ฆ Product Management
import {
getProject,
getProduct,
recordProduct,
updateProduct
} from "torosdk";
const project = await getProject({
admin: "0xAdminAddress",
getbalances: "true"
});
const product = await getProduct({
productId: "product123",
admin: "0xAdminAddress",
adminpwd: "adminPassword"
});
await recordProduct({
productId: "product123",
productName: "My Product",
description: "Product description",
productImage: "https://example.com/image.jpg",
admin: "0xAdminAddress",
adminpwd: "adminPassword"
});
๐ณ Advanced Payment Operations
import {
getBankListUSD,
getBankListNGN,
recordFiatWithdrawal,
verifyBankAccountNameNGN,
getFiatTransactionsAddressRange,
getFiatWithdrawalsAddressRange
} from "torosdk";
const usdBanks = await getBankListUSD({
admin: "0xAdminAddress",
adminpwd: "adminPassword"
});
const ngnBanks = await getBankListNGN({
admin: "0xAdminAddress",
adminpwd: "adminPassword"
});
await recordFiatWithdrawal({
address: "0xAddress",
password: "password",
currency: "NGN",
token: "NGN",
payername: "John Doe",
payeremail: "john@example.com",
description: "Withdrawal",
amount: "1000",
accounttype: "savings",
bankname: "Bank Name",
routingno: "123456",
accountno: "1234567890",
accountname: "John Doe",
admin: "0xAdminAddress",
adminpwd: "adminPassword"
});
const verification = await verifyBankAccountNameNGN({
destinationInstitutionCode: "058",
accountNumber: "1234567890",
admin: "0xAdminAddress",
adminpwd: "adminPassword"
});
const transactions = await getFiatTransactionsAddressRange({
address: "0xAddress",
startDate: "2024-01-01",
endDate: "2024-12-31",
currency: "NGN",
admin: "0xAdminAddress",
adminpwd: "adminPassword"
});
๐ Advanced Query Operations with Date Ranges
import { getAddrTransactionsRange } from "torosdk";
const transactions = await getAddrTransactionsRange({
address: "0xAddress",
startDate: "2024-01-01",
endDate: "2024-12-31",
token: "NGN",
count: 100,
start: 0
});
๐ Multi-Chain Bridge Operations
The SDK supports bridging tokens from multiple blockchain networks to Toronet. Supported chains include Solana, Base, Polygon, BSC, and Arbitrum.
Solana Bridge Operations
import {
getSolBalance,
getSolTokenBalance,
transferSolana,
transferSolToken,
bridgeTokenSol,
getBridgeTokenFeeSol,
isValidSolanaAddress,
BridgeNetwork
} from "torosdk";
const isValid = await isValidSolanaAddress("3uwR7HMDuK6dXwZAfx8jHwPcyXsYmFuHWJv3zvJxRE9w");
const solBalance = await getSolBalance({
address: "3uwR7HMDuK6dXwZAfx8jHwPcyXsYmFuHWJv3zvJxRE9w"
});
const usdcBalance = await getSolTokenBalance({
address: "3uwR7HMDuK6dXwZAfx8jHwPcyXsYmFuHWJv3zvJxRE9w",
contractaddress: "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v"
});
await bridgeTokenSol({
from: "0xYourToronetAddress",
pwd: "YourPassword",
network: BridgeNetwork.Solana,
contractaddress: "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
tokenname: "USDC",
amount: "100"
});
EVM Chain Bridge Operations (Base, Polygon, BSC, Arbitrum)
import {
getBalanceBase,
getTokenBalanceBase,
bridgeTokenBase,
getBalancePolygon,
getTokenBalancePolygon,
bridgeTokenPolygon,
getBalanceBSC,
getTokenBalanceBSC,
bridgeTokenBSC,
getBalanceArbitrum,
getTokenBalanceArbitrum,
bridgeTokenArbitrum,
BridgeNetwork
} from "torosdk";
const baseBalance = await getBalanceBase({
address: "0xff9602fd3a10038ac2b6d9b03277dc5c7d154ada"
});
const polyUSDC = await getTokenBalancePolygon({
address: "0xff9602fd3a10038ac2b6d9b03277dc5c7d154ada",
contractaddress: "0x3c499c542cEF5E3811e1192ce70d8cC03d5c3359",
tokenname: "USDC"
});
await bridgeTokenPolygon({
from: "0xYourToronetAddress",
pwd: "YourPassword",
network: BridgeNetwork.Polygon,
contractaddress: "0x3c499c542cEF5E3811e1192ce70d8cC03d5c3359",
tokenname: "USDC",
amount: "50"
});
await bridgeTokenBSC({
from: "0xYourToronetAddress",
pwd: "YourPassword",
network: BridgeNetwork.BSC,
contractaddress: "0x55d398326f99059ff775485246999027b3197955",
tokenname: "USDT",
amount: "100"
});
Using Generic Bridge Functions
import {
getBridgeBalance,
getBridgeTokenBalance,
getBridgeTransactions,
getBridgeTokenTransactions,
bridgeTokenFromChain,
getBridgeTokenFeeEstimate,
BridgeNetwork
} from "torosdk";
const balance = await getBridgeBalance(BridgeNetwork.Base, {
address: "0xff9602fd3a10038ac2b6d9b03277dc5c7d154ada"
});
const tokenBalance = await getBridgeTokenBalance(BridgeNetwork.Polygon, {
address: "0xff9602fd3a10038ac2b6d9b03277dc5c7d154ada",
contractaddress: "0x3c499c542cEF5E3811e1192ce70d8cC03d5c3359",
tokenname: "USDC"
});
const transactions = await getBridgeTransactions(BridgeNetwork.BSC, {
address: "0xff9602fd3a10038ac2b6d9b03277dc5c7d154ada"
});
await bridgeTokenFromChain(BridgeNetwork.Arbitrum, {
from: "0xYourToronetAddress",
pwd: "YourPassword",
network: BridgeNetwork.Arbitrum,
contractaddress: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
tokenname: "USDC",
amount: "75"
});
const fee = await getBridgeTokenFeeEstimate(BridgeNetwork.Base, {
network: BridgeNetwork.Base,
contractaddress: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
amount: "50"
});
Crypto Payment Initialization
import {
paymentInitializeCrypto,
recordCryptoPayment
} from "torosdk";
const deposit = await paymentInitializeCrypto({
address: "0xYourToronetAddress",
pwd: "YourPassword",
currency: "USDCSOL",
token: "TORO",
amount: "100",
paymenttype: "crypto"
}, "0xAdminAddress", "adminPassword");
await recordCryptoPayment({
currency: "USDCSOL",
txid: "3uwR7HMDuK6dXwZAfx8jHwPcyXsYmFuHWJv3zvJxRE9w_8e21df8325dc5e88"
}, "0xAdminAddress", "adminPassword");
For more detailed bridge examples, see CODE_SAMPLES.md.
Supported Currencies
export enum Currency {
Naira = "NGN",
Euro = "EUR",
Dollar = "USD",
Pound = "GBP",
Kenyan_Shilling = "KSH",
South_African_Rand = "ZAR",
}
Folder Structure
src/
โโโ api/
โ โโโ account.ts
โ โโโ balance.ts
โ โโโ blockchain.ts
โ โโโ keystore.ts
โ โโโ payments.ts
โ โโโ bridge/ # Multi-chain bridge operations
โ โ โโโ solana.ts # Solana bridge operations
โ โ โโโ base.ts # Base chain operations
โ โ โโโ polygon.ts # Polygon chain operations
โ โ โโโ bsc.ts # BSC chain operations
โ โ โโโ arbitrum.ts # Arbitrum chain operations
โ โ โโโ payments.ts # Crypto payment operations
โ โ โโโ index.ts
โ โโโ config.ts
โ
โโโ query/ # On-chain data queries
โ โโโ queries.ts
โ
โโโ services/ # Business logic
โ โโโ walletService.ts
โ โโโ balanceService.ts
โ โโโ paymentService.ts
โ โโโ bridge_service.ts # Bridge service wrappers
โ โโโ utils.ts
โ
โโโ virtualwallet/ # Virtual wallet business logic
โ โโโ virtualwallet.ts
โ
โโโ types/ # Global types and enums
โ โโโ bridge.ts # Bridge type definitions
โโโ utils/
โโโ index.ts # SDK entry
Contribution
We welcome contributions from the community!
- Fork the repo
- Create a feature branch
- Submit a PR with detailed explanation
License
MIT License โ see LICENSE file.
Support
Join our developer community on Discord.
---