@aere/sdk

Official AERE Network TypeScript SDK. Wraps ethers v6 with typed contract clients for every deployed AERE L1 contract — staking, lending, stablecoin, swap, bridge, identity (KYC), Lightning channels, ZK rollup, faucet.

Designed for Bank28-class neobank backends: a single AereClient gives you everything you need to integrate AERE as the on-chain layer of a regulated neobank.

Install

npm i @aere/sdk ethers

Quickstart

import { AereClient } from '@aere/sdk';
import { ethers } from 'ethers';

const aere = new AereClient({ privateKey: process.env.OPS_PRIVATE_KEY });

// Multi-asset balance for a user
const portfolio = await aere.getPortfolio('0xUser…');
console.log(ethers.formatEther(portfolio.aere), 'AERE');
console.log(ethers.formatEther(portfolio.aereUsd), 'AereUSD');

// Lock 100 AERE for 90 days at 15% APY (tier 1)
await aere.staking.lockTier90(ethers.parseEther('100'));

// Attest that the user cleared KYC tier 1 (writes to AereIdentity)
const oneYear = Math.floor(Date.now() / 1000) + 365 * 86400;
await aere.identity.addClaim(
  '0xUser…',
  'kyc-tier-1',
  ethers.keccak256(ethers.toUtf8Bytes('SUMSUB:applicant-id-12345')),
  oneYear,
);

// Watch for incoming AERE deposits — for a Bank28 webhook
const unsubscribe = await aere.watchTransfersTo('0xUser…', tx => {
  console.log(`User received ${ethers.formatEther(tx.value)} AERE in tx ${tx.hash}`);
  // → credit Bank28 user account, fire webhook to UI
});

What's in the box

• AereClient — top-level handle; pass a privateKey or signer.
• aere.staking — locked staking V2 (4 tiers, 10–30% APY).
• aere.stakingV1 — delegated 8% APY staking.
• aere.lending — supply / borrow against AERE collateral.
• aere.stable — AereUSD CDP-style stablecoin (AERE-collateralised, NOT USD-reserve-backed).
• aere.identity — KYC attestation registry (addClaim / revokeClaim / hasValidClaim).
• aere.bridge — federated lock-and-release to ETH/BSC/Polygon/etc.
• aere.swap — AMM (Uniswap V2 fork) with pair handles.
• aere.lightning — off-chain payment channels.
• aere.faucet — programmatic faucet (rarely needed in production).
• aere.waere — wrapped native AERE for DeFi.
• AERE_MAINNET — canonical address book + RPC URLs.

Network parameters

Chain ID	2800 (0xAF0)
RPC	https://rpc.aere.network
WSS	wss://wss.aere.network
Indexer	https://api.aere.network
Explorer	https://explorer.aere.network

Honest constraints

• Non-custodial. End users hold their own keys. For consumer neobanks use Privy / Magic / Web3Auth to provision wallets via email/social, then pass that signer into AereClient.
• No fiat rails. AERE is the crypto layer. For fiat IBANs / cards / SEPA / KYC ops you need a BaaS partner (Striga, Dipocket, Modulr, Solaris…).
• AereUSD is AERE-collateralised, not redeemable for fiat. For real USD on-chain, integrate USDC bridged from Ethereum.
• 3 validators today (path to 7 staged). 0-of-3 fault tolerance — production-but-fragile. Plan accordingly.

License

MIT