@octaflowlabs/onchain-sdk 1.4.2 → 1.5.1

package/dist/constants/NETWORKS_REGISTRY.js

@@ -30,10 +30,10 @@ export const NETWORKS_REGISTRY = [
                 id: 'polygon-mainnet',
                 name: 'polygon-mainnet',
                 nameForDisplay: 'Polygon Mainnet',
-                iconUrl: 'https://assets.coingecko.com/coins/images/4713/large/matic-token-icon.png',
                 chainId: 137,
                 rpcUrl: 'https://polygon.publicnode.com',
                 explorerUrl: 'https://polygonscan.com',
+                iconUrl: 'https://assets.coingecko.com/coins/images/4713/large/matic-token-icon.png',
                 symbol: 'POL',
                 failoverRpcUrl: 'https://polygon.llamarpc.com',
                 blockTime: 2,
@@ -50,6 +50,161 @@ export const NETWORKS_REGISTRY = [
                 failoverRpcUrl: 'https://arb.llamarpc.com',
                 blockTime: 1,
             },
+            {
+                id: 'optimism-mainnet',
+                name: 'op-mainnet',
+                nameForDisplay: 'Optimism Mainnet',
+                chainId: 10,
+                rpcUrl: 'https://mainnet.optimism.io',
+                explorerUrl: 'https://optimistic.etherscan.io',
+                iconUrl: 'https://assets.coingecko.com/coins/images/25244/large/Optimism.png',
+                symbol: 'ETH',
+                failoverRpcUrl: 'https://optimism.llamarpc.com',
+                blockTime: 2,
+            },
+            {
+                id: 'base-mainnet',
+                name: 'base-mainnet',
+                nameForDisplay: 'Base Mainnet',
+                chainId: 8453,
+                rpcUrl: 'https://mainnet.base.org',
+                explorerUrl: 'https://basescan.org',
+                iconUrl: 'https://assets.coingecko.com/coins/images/32480/large/base.png',
+                symbol: 'ETH',
+                failoverRpcUrl: 'https://base.llamarpc.com',
+                blockTime: 2,
+            },
+            {
+                id: 'avalanche-mainnet',
+                name: 'avax-mainnet',
+                nameForDisplay: 'Avalanche C-Chain',
+                chainId: 43114,
+                rpcUrl: 'https://api.avax.network/ext/bc/C/rpc',
+                explorerUrl: 'https://snowtrace.io',
+                iconUrl: 'https://assets.coingecko.com/coins/images/12559/large/Avalanche_Circle_RedWhite_Trans.png',
+                symbol: 'AVAX',
+                failoverRpcUrl: 'https://avalanche.llamarpc.com',
+                blockTime: 2,
+            },
+            {
+                id: 'hyperevm-mainnet',
+                name: 'hyperevm-mainnet',
+                nameForDisplay: 'HyperEVM',
+                chainId: 999,
+                rpcUrl: 'https://hyperliquid-mainnet.g.alchemy.com/v2/YOUR_KEY',
+                explorerUrl: 'https://purrsec.com',
+                iconUrl: 'https://assets.coingecko.com/coins/images/52510/large/hyperliquid.png',
+                symbol: 'HYPE',
+                failoverRpcUrl: 'https://rpc.hyperliquid.xyz/evm',
+                blockTime: 1,
+            },
+            {
+                id: 'unichain-mainnet',
+                name: 'unichain-mainnet',
+                nameForDisplay: 'Unichain Mainnet',
+                chainId: 130,
+                rpcUrl: 'https://mainnet.unichain.org',
+                explorerUrl: 'https://uniscan.xyz',
+                iconUrl: 'https://assets.coingecko.com/coins/images/25244/large/Optimism.png',
+                symbol: 'ETH',
+                failoverRpcUrl: 'https://unichain.llamarpc.com',
+                blockTime: 1,
+            },
+            {
+                id: 'gnosis-mainnet',
+                name: 'gnosis-mainnet',
+                nameForDisplay: 'Gnosis Chain',
+                chainId: 100,
+                rpcUrl: 'https://rpc.gnosischain.com',
+                explorerUrl: 'https://gnosisscan.io',
+                iconUrl: 'https://assets.coingecko.com/coins/images/662/large/logo_square_simple_300px.png',
+                symbol: 'xDAI',
+                failoverRpcUrl: 'https://gnosis.llamarpc.com',
+                blockTime: 5,
+            },
+            {
+                id: 'mantle-mainnet',
+                name: 'mantle-mainnet',
+                nameForDisplay: 'Mantle Mainnet',
+                chainId: 5000,
+                rpcUrl: 'https://rpc.mantle.xyz',
+                explorerUrl: 'https://mantlescan.xyz',
+                iconUrl: 'https://assets.coingecko.com/coins/images/30980/large/token-logo.png',
+                symbol: 'MNT',
+                failoverRpcUrl: 'https://mantle.llamarpc.com',
+                blockTime: 2,
+            },
+            {
+                id: 'celo-mainnet',
+                name: 'celo-mainnet',
+                nameForDisplay: 'Celo Mainnet',
+                chainId: 42220,
+                rpcUrl: 'https://forno.celo.org',
+                explorerUrl: 'https://celoscan.io',
+                iconUrl: 'https://assets.coingecko.com/coins/images/11090/large/InjXBNx9_400x400.jpg',
+                symbol: 'CELO',
+                failoverRpcUrl: 'https://celo.llamarpc.com',
+                blockTime: 5,
+            },
+            {
+                id: 'blast-mainnet',
+                name: 'blast-mainnet',
+                nameForDisplay: 'Blast Mainnet',
+                chainId: 81457,
+                rpcUrl: 'https://rpc.blast.io',
+                explorerUrl: 'https://blastscan.io',
+                iconUrl: 'https://assets.coingecko.com/coins/images/35494/large/Blast.jpg',
+                symbol: 'ETH',
+                failoverRpcUrl: 'https://blast.llamarpc.com',
+                blockTime: 2,
+            },
+            {
+                id: 'berachain-mainnet',
+                name: 'berachain-mainnet',
+                nameForDisplay: 'Berachain Mainnet',
+                chainId: 80094,
+                rpcUrl: 'https://rpc.berachain.com',
+                explorerUrl: 'https://berascan.com',
+                iconUrl: 'https://assets.coingecko.com/coins/images/36417/large/bera.png',
+                symbol: 'BERA',
+                failoverRpcUrl: 'https://berachain.llamarpc.com',
+                blockTime: 2,
+            },
+            {
+                id: 'linea-mainnet',
+                name: 'linea-mainnet',
+                nameForDisplay: 'Linea Mainnet',
+                chainId: 59144,
+                rpcUrl: 'https://rpc.linea.build',
+                explorerUrl: 'https://lineascan.build',
+                iconUrl: 'https://assets.coingecko.com/coins/images/32234/large/linea.png',
+                symbol: 'ETH',
+                failoverRpcUrl: 'https://linea.llamarpc.com',
+                blockTime: 2,
+            },
+            {
+                id: 'scroll-mainnet',
+                name: 'scroll-mainnet',
+                nameForDisplay: 'Scroll Mainnet',
+                chainId: 534352,
+                rpcUrl: 'https://rpc.scroll.io',
+                explorerUrl: 'https://scrollscan.com',
+                iconUrl: 'https://assets.coingecko.com/coins/images/32760/large/scroll.png',
+                symbol: 'ETH',
+                failoverRpcUrl: 'https://scroll.llamarpc.com',
+                blockTime: 3,
+            },
+            {
+                id: 'plasma-mainnet',
+                name: 'plasma-mainnet',
+                nameForDisplay: 'Plasma Mainnet',
+                chainId: 9745,
+                rpcUrl: 'https://rpc.plasma.to',
+                explorerUrl: 'https://plasmascan.to',
+                iconUrl: '',
+                symbol: 'XPL',
+                blockTime: 1,
+            },
         ],
     },
     {

package/dist/constants/STABLECOINS_REGISTRY.d.ts

@@ -0,0 +1,13 @@
+export type StablecoinSymbol = 'USDC' | 'USDT' | 'OSC';
+export interface StablecoinContractData {
+    chainId: number;
+    symbol: StablecoinSymbol;
+    name: string;
+    address: string;
+    decimals: number;
+}
+export type StablecoinContractsByChainId = Readonly<Record<number, readonly StablecoinContractData[]>>;
+export declare const STABLECOIN_CONTRACTS_BY_CHAIN_ID: StablecoinContractsByChainId;
+export declare const getStablecoinContractsByChainId: (chainId: number | null | undefined) => readonly StablecoinContractData[];
+export declare const getStablecoinContractBySymbolAndChainId: (symbol: StablecoinSymbol, chainId: number | null | undefined) => StablecoinContractData | null;
+export declare const isAllowedStablecoinContract: (chainId: number | null | undefined, contractAddress: string | null | undefined) => boolean;

package/dist/constants/STABLECOINS_REGISTRY.js

@@ -0,0 +1,95 @@
+/** local imports */
+import { normalizeEvmAddress } from '../utils/normalizeAddress';
+export const STABLECOIN_CONTRACTS_BY_CHAIN_ID = {
+    1: [
+        {
+            chainId: 1,
+            symbol: 'USDC',
+            name: 'USD Coin',
+            address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
+            decimals: 6,
+        },
+        {
+            chainId: 1,
+            symbol: 'USDT',
+            name: 'Tether USD',
+            address: '0xdac17f958d2ee523a2206206994597c13d831ec7',
+            decimals: 6,
+        },
+    ],
+    56: [
+        {
+            chainId: 56,
+            symbol: 'USDC',
+            name: 'USD Coin',
+            address: '0x8ac76a51cc950d9822d68b83fe1ad97b32cd580d',
+            decimals: 18,
+        },
+        {
+            chainId: 56,
+            symbol: 'USDT',
+            name: 'Tether USD',
+            address: '0x55d398326f99059ff775485246999027b3197955',
+            decimals: 18,
+        },
+    ],
+    137: [
+        {
+            chainId: 137,
+            symbol: 'USDC',
+            name: 'USD Coin Bridged',
+            address: '0x2791bca1f2de4661ed88a30c99a7a9449aa84174',
+            decimals: 6,
+        },
+        {
+            chainId: 137,
+            symbol: 'USDC',
+            name: 'USD Coin',
+            address: '0x3c499c542cef5e3811e1192ce70d8cc03d5c3359',
+            decimals: 6,
+        },
+        {
+            chainId: 137,
+            symbol: 'USDT',
+            name: 'Tether USD',
+            address: '0xc2132d05d31c914a87c6611c10748aeb04b58e8f',
+            decimals: 6,
+        },
+    ],
+    11155111: [
+        {
+            chainId: 11155111,
+            symbol: 'USDC',
+            name: 'Sepolia USDC',
+            address: '0x1c7d4b196cb0c7b01d743fbc6116a902379c7238',
+            decimals: 6,
+        },
+        {
+            chainId: 11155111,
+            symbol: 'OSC',
+            name: 'OSC Test Stablecoin',
+            address: '0x4357555de1c8ed60218dd42b0b4f404e31b6d744',
+            decimals: 6,
+        },
+    ],
+};
+export const getStablecoinContractsByChainId = (chainId) => {
+    if (chainId == null)
+        return [];
+    return STABLECOIN_CONTRACTS_BY_CHAIN_ID[chainId] || [];
+};
+export const getStablecoinContractBySymbolAndChainId = (symbol, chainId) => {
+    const contracts = getStablecoinContractsByChainId(chainId);
+    return contracts.find((contract) => contract.symbol === symbol) || null;
+};
+export const isAllowedStablecoinContract = (chainId, contractAddress) => {
+    if (chainId == null)
+        return false;
+    const normalizedAddress = normalizeEvmAddress(contractAddress);
+    if (!normalizedAddress)
+        return false;
+    const allowedContracts = getStablecoinContractsByChainId(chainId);
+    if (!allowedContracts.length)
+        return false;
+    return allowedContracts.some((contract) => contract.address === normalizedAddress);
+};

package/dist/index.d.ts

@@ -5,6 +5,7 @@ export { ERC20_TOKEN_CONTRACT_ABI };
 export { GAS_LIMIT_PER_TX_TYPE, MULTICALL3_ADDRESS } from './constants/constants';
 export { NetworkField, NetworkRegistry, NETWORKS_REGISTRY } from './constants/NETWORKS_REGISTRY';
 export { BASIC_TOKENS_BY_CHAIN, BasicTokenData, BasicTokenSymbol, ChainTokenDataMap, } from './constants/BASIC_TOKENS_REGISTRY';
+export { STABLECOIN_CONTRACTS_BY_CHAIN_ID, getStablecoinContractBySymbolAndChainId, getStablecoinContractsByChainId, isAllowedStablecoinContract, StablecoinContractData, StablecoinContractsByChainId, StablecoinSymbol, } from './constants/STABLECOINS_REGISTRY';
 /** basic blockchain exports */
 export { buildBaseUnsignedTransferTx, buildMaxNativeTransferTx, buildUnsignedTransferTx, } from './blockchain/buildUnsignedTransferTx';
 export { broadcastTransaction } from './blockchain/broadcastTransaction';
@@ -26,8 +27,10 @@ import NATIVE_TOKENS from './utils/tokens';
 export { NATIVE_TOKENS };
 export { formattedAmountForDisplay, parsedAmount } from './utils/formatAmount';
 export { handleErrorMessages, errorMessagesForBroadcast, errorMessagesForGasLimitEstimation, } from './utils/handleErrorMessages';
-export { normalizeAddress } from './utils/normalizeAddress';
+export { normalizeAddress, normalizeEvmAddress } from './utils/normalizeAddress';
 export { toGwei, tryParseGweiToWei, parseGasLimit } from './utils/parseGasFees';
 export { getFeePresets, calcReserve, estimateSeconds, getBlockTime, BLOCK_TIME_BY_CHAIN, } from './utils/feePresets';
+/** webhook exports */
+export { extractPoolInboundStablecoinEvents } from './webhooks/alchemyAddressActivity';
 /** types exports */
 export { BroadcastTransactionOptions, BuildMaxNativeTransferTxOptions, BuildUnsignedTransferTxOptions, EstimateGasLimitFromProviderProps, GasEstimateResult, TxStatusOptions, BuildBaseUnsignedTransferTxParams, TxStatusResponse, EstimateTransactionOptions, EstimateTransactionResult, PrepareTransactionParams, PrepareTransactionResult, FormatAmountOptions, TransactionRequest, GetBalanceParams, GetBalancesParams, GetBalancesChainRequest, GetBalanceResult, ChainBalances, TokenBalance, ChainGroup, FeePreset, FeePresetLabel, FeeEstimateSeconds, ResolvedFees, EIP1559Fees, LegacyFees, FeeModel, FeeHistoryData, FeeDataInput, } from './types/common';

package/dist/index.js

@@ -5,6 +5,7 @@ export { ERC20_TOKEN_CONTRACT_ABI };
 export { GAS_LIMIT_PER_TX_TYPE, MULTICALL3_ADDRESS } from './constants/constants';
 export { NETWORKS_REGISTRY } from './constants/NETWORKS_REGISTRY';
 export { BASIC_TOKENS_BY_CHAIN, } from './constants/BASIC_TOKENS_REGISTRY';
+export { STABLECOIN_CONTRACTS_BY_CHAIN_ID, getStablecoinContractBySymbolAndChainId, getStablecoinContractsByChainId, isAllowedStablecoinContract, } from './constants/STABLECOINS_REGISTRY';
 /** basic blockchain exports */
 export { buildBaseUnsignedTransferTx, buildMaxNativeTransferTx, buildUnsignedTransferTx, } from './blockchain/buildUnsignedTransferTx';
 export { broadcastTransaction } from './blockchain/broadcastTransaction';
@@ -25,6 +26,8 @@ import NATIVE_TOKENS from './utils/tokens';
 export { NATIVE_TOKENS };
 export { formattedAmountForDisplay, parsedAmount } from './utils/formatAmount';
 export { handleErrorMessages, errorMessagesForBroadcast, errorMessagesForGasLimitEstimation, } from './utils/handleErrorMessages';
-export { normalizeAddress } from './utils/normalizeAddress';
+export { normalizeAddress, normalizeEvmAddress } from './utils/normalizeAddress';
 export { toGwei, tryParseGweiToWei, parseGasLimit } from './utils/parseGasFees';
 export { getFeePresets, calcReserve, estimateSeconds, getBlockTime, BLOCK_TIME_BY_CHAIN, } from './utils/feePresets';
+/** webhook exports */
+export { extractPoolInboundStablecoinEvents } from './webhooks/alchemyAddressActivity';

package/dist/utils/activityDedupe.d.ts

@@ -0,0 +1,7 @@
+export interface TransactionActivityDedupeInput {
+    hash?: string | null;
+    log?: {
+        logIndex?: string | null;
+    } | null;
+}
+export declare const getTransactionActivityDedupeKey: (activity: TransactionActivityDedupeInput) => string | null;

package/dist/utils/activityDedupe.js

@@ -0,0 +1,7 @@
+export const getTransactionActivityDedupeKey = (activity) => {
+    const hash = activity.hash?.trim();
+    if (!hash)
+        return null;
+    const logIndex = activity.log?.logIndex?.trim();
+    return logIndex ? `${hash}:${logIndex}` : hash;
+};

package/dist/utils/normalizeAddress.d.ts

@@ -1 +1,2 @@
 export declare const normalizeAddress: (address: string) => string;
+export declare const normalizeEvmAddress: (address: string | null | undefined) => string | null;

package/dist/utils/normalizeAddress.js

@@ -9,3 +9,13 @@ export const normalizeAddress = (address) => {
         throw new Error('Error normalizing address: ' + (e instanceof Error ? e.message : String(e)));
     }
 };
+export const normalizeEvmAddress = (address) => {
+    if (!address || typeof address !== 'string')
+        return null;
+    try {
+        return normalizeAddress(address.trim()).toLowerCase();
+    }
+    catch {
+        return null;
+    }
+};

package/dist/webhooks/alchemyAddressActivity.d.ts

@@ -0,0 +1,39 @@
+export interface AlchemyAddressActivity {
+    category?: string;
+    asset?: string;
+    value?: number | null;
+    fromAddress?: string | null;
+    toAddress?: string | null;
+    hash?: string | null;
+    erc721TokenId?: string | number | null;
+    rawContract?: {
+        address?: string | null;
+    } | null;
+    log?: {
+        removed?: boolean;
+        logIndex?: string | null;
+    } | null;
+}
+export interface AlchemyAddressActivityPayload {
+    id?: string;
+    webhookId?: string;
+    type?: string;
+    event?: {
+        network?: string;
+        activity?: AlchemyAddressActivity[];
+    };
+}
+export interface PoolInboundStablecoinEvent {
+    webhookDeliveryId?: string;
+    webhookId?: string;
+    alchemyNetwork: string;
+    chainId: number | null;
+    txHash: string;
+    fromAddress: string;
+    toAddress: string;
+    amount: number;
+    asset: string;
+    tokenContractAddress?: string | null;
+    dedupeKey: string;
+}
+export declare function extractPoolInboundStablecoinEvents(payload: AlchemyAddressActivityPayload, poolAddress: string | null | undefined): PoolInboundStablecoinEvent[];

package/dist/webhooks/alchemyAddressActivity.js

@@ -0,0 +1,72 @@
+/** local imports */
+import { isAllowedStablecoinContract } from '../constants/STABLECOINS_REGISTRY';
+import { getTransactionActivityDedupeKey } from '../utils/activityDedupe';
+import { normalizeEvmAddress } from '../utils/normalizeAddress';
+const CHAIN_ID_TO_ALCHEMY_NETWORK = {
+    1: 'ETH_MAINNET',
+    56: 'BNB_MAINNET',
+    137: 'MATIC_MAINNET',
+    11155111: 'ETH_SEPOLIA',
+};
+const ALCHEMY_NETWORK_TO_CHAIN_ID = Object.fromEntries(Object.entries(CHAIN_ID_TO_ALCHEMY_NETWORK).map(([chainId, network]) => [
+    network,
+    Number(chainId),
+]));
+function chainIdFromAlchemyNetwork(network) {
+    if (!network)
+        return null;
+    const chainId = ALCHEMY_NETWORK_TO_CHAIN_ID[network];
+    return chainId === undefined ? null : chainId;
+}
+export function extractPoolInboundStablecoinEvents(payload, poolAddress) {
+    const poolAddressLower = normalizeEvmAddress(poolAddress);
+    if (!poolAddressLower)
+        return [];
+    if (payload.type !== 'ADDRESS_ACTIVITY')
+        return [];
+    const network = payload.event?.network;
+    const chainId = chainIdFromAlchemyNetwork(network);
+    const activity = payload.event?.activity;
+    if (!activity?.length)
+        return [];
+    const out = [];
+    for (const item of activity) {
+        if (item.category !== 'token')
+            continue;
+        if (item.log?.removed === true)
+            continue;
+        if (item.erc721TokenId != null && item.erc721TokenId !== '')
+            continue;
+        if (!isAllowedStablecoinContract(chainId, item.rawContract?.address))
+            continue;
+        const value = item.value;
+        if (value === undefined || value === null || typeof value !== 'number' || !(value > 0))
+            continue;
+        const to = normalizeEvmAddress(item.toAddress);
+        const from = normalizeEvmAddress(item.fromAddress);
+        if (!to || !from)
+            continue;
+        if (to !== poolAddressLower)
+            continue;
+        const txHash = item.hash?.trim();
+        if (!txHash)
+            continue;
+        const dedupeKey = getTransactionActivityDedupeKey(item);
+        if (!dedupeKey)
+            continue;
+        out.push({
+            webhookDeliveryId: payload.id,
+            webhookId: payload.webhookId,
+            alchemyNetwork: network || 'UNKNOWN',
+            chainId,
+            txHash,
+            fromAddress: from,
+            toAddress: to,
+            amount: value,
+            asset: item.asset || '',
+            tokenContractAddress: item.rawContract?.address,
+            dedupeKey,
+        });
+    }
+    return out;
+}

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "@octaflowlabs/onchain-sdk",
-  "version": "1.4.2",
+  "version": "1.5.1",
   "description": "onchain methods for web3",
-  "repository": {"type": "git", "url": "git+https://github.com/octaflowlabs/onchain-sdk.git"},
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/octaflowlabs/onchain-sdk.git"
+  },
   "license": "MIT",
   "main": "dist/cjs/index.js",
   "module": "dist/index.js",