Skip to content

feat: add new chains #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maksympanchyshyn-tatum merged 1 commit into from
Aug 24, 2026
Merged

feat: add new chains #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ await client.sendAssets({
});
```

Chain fields (`chain` / `chainId` on sign, sendAssets, evaluate, and the `{chain}` path on build-transaction) take the `WalletChain` enum rather than raw strings. Each value is the chain's CAIP-2 id, and `WALLET_CHAINS[chain]` / `getWalletChainConfig(chain)` expose its `curve` and `requiresRpcUrl`. Primary chains: Monad, Ethereum, Solana, Stellar, Tron, Bitcoin, Arbitrum, Avalanche, Base, Optimism, Polygon, Celo, BSC (all `_MAINNET`), plus the testnets `ETHEREUM_SEPOLIA`, `SOLANA_DEVNET`, `BITCOIN_TESTNET`, `ARBITRUM_SEPOLIA`, `BASE_SEPOLIA`, `OPTIMISM_SEPOLIA`, `POLYGON_AMOY`, `BSC_TESTNET`, and `TRON_NILE`.
Chain fields (`chain` / `chainId` on sign, sendAssets, evaluate, and the `{chain}` path on build-transaction) take the `WalletChain` enum rather than raw strings. Each value is the chain's CAIP-2 id, and `WALLET_CHAINS[chain]` / `getWalletChainConfig(chain)` expose its `curve` and `requiresRpcUrl`. Primary chains: Monad, Ethereum, Solana, Stellar, Tron, Bitcoin, Arbitrum, Arbitrum Nova, Avalanche, Base, Optimism, Polygon, Celo, BSC, Gnosis, Fantom, Rootstock, zkSync, Chiliz, Cronos, Ronin, Lisk, Litecoin (all `_MAINNET`), plus the testnets `ETHEREUM_SEPOLIA`, `SOLANA_DEVNET`, `STELLAR_TESTNET`, `BITCOIN_TESTNET`, `ARBITRUM_SEPOLIA`, `BASE_SEPOLIA`, `OPTIMISM_SEPOLIA`, `POLYGON_AMOY`, `BSC_TESTNET`, `MONAD_TESTNET`, `AVALANCHE_FUJI`, `GNOSIS_CHIADO`, `ROOTSTOCK_TESTNET`, `ZKSYNC_SEPOLIA`, `CHILIZ_TESTNET`, `TRON_NILE`, and `TRON_SHASTA`. See `docs/USAGE.md` for the full table.

### Signing

Expand Down
69 changes: 45 additions & 24 deletions docs/USAGE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,30 +143,51 @@ const cfg = getWalletChainConfig(WalletChain.SOLANA_MAINNET);
// → { chainId, curve: 'ED25519', requiresRpcUrl: false, tatumNetwork: 'solana-mainnet' }
```

| `WalletChain` | CAIP-2 id | Curve | `requiresRpcUrl` |
| ------------------- | ------------------------------------------------ | --------- | ---------------- |
| `ETHEREUM_MAINNET` | `eip155:1` | SECP256K1 | false |
| `ETHEREUM_SEPOLIA` | `eip155:11155111` | SECP256K1 | false |
| `MONAD_MAINNET` | `eip155:143` | SECP256K1 | false |
| `ARBITRUM_MAINNET` | `eip155:42161` | SECP256K1 | false |
| `ARBITRUM_SEPOLIA` | `eip155:421614` | SECP256K1 | false |
| `AVALANCHE_MAINNET` | `eip155:43114` | SECP256K1 | false |
| `BASE_MAINNET` | `eip155:8453` | SECP256K1 | false |
| `BASE_SEPOLIA` | `eip155:84532` | SECP256K1 | false |
| `OPTIMISM_MAINNET` | `eip155:10` | SECP256K1 | false |
| `OPTIMISM_SEPOLIA` | `eip155:11155420` | SECP256K1 | false |
| `POLYGON_MAINNET` | `eip155:137` | SECP256K1 | false |
| `POLYGON_AMOY` | `eip155:80002` | SECP256K1 | false |
| `CELO_MAINNET` | `eip155:42220` | SECP256K1 | true |
| `BSC_MAINNET` | `eip155:56` | SECP256K1 | false |
| `BSC_TESTNET` | `eip155:97` | SECP256K1 | false |
| `BITCOIN_MAINNET` | `bip122:000000000019d6689c085ae165831e93-p2wpkh` | SECP256K1 | true |
| `BITCOIN_TESTNET` | `bip122:000000000933ea01ad0ee984209779ba-p2wpkh` | SECP256K1 | true |
| `TRON_MAINNET` | `tron:mainnet` | SECP256K1 | true |
| `TRON_NILE` | `tron:nile` | SECP256K1 | true |
| `SOLANA_MAINNET` | `solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp` | ED25519 | false |
| `SOLANA_DEVNET` | `solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1` | ED25519 | false |
| `STELLAR_MAINNET` | `stellar:pubnet` | ED25519 | true |
| `WalletChain` | CAIP-2 id | Curve | `requiresRpcUrl` |
| ----------------------- | ------------------------------------------------ | --------- | ---------------- |
| `ETHEREUM_MAINNET` | `eip155:1` | SECP256K1 | false |
| `ETHEREUM_SEPOLIA` | `eip155:11155111` | SECP256K1 | false |
| `MONAD_MAINNET` | `eip155:143` | SECP256K1 | false |
| `ARBITRUM_MAINNET` | `eip155:42161` | SECP256K1 | false |
| `ARBITRUM_SEPOLIA` | `eip155:421614` | SECP256K1 | false |
| `AVALANCHE_MAINNET` | `eip155:43114` | SECP256K1 | false |
| `BASE_MAINNET` | `eip155:8453` | SECP256K1 | false |
| `BASE_SEPOLIA` | `eip155:84532` | SECP256K1 | false |
| `OPTIMISM_MAINNET` | `eip155:10` | SECP256K1 | false |
| `OPTIMISM_SEPOLIA` | `eip155:11155420` | SECP256K1 | false |
| `POLYGON_MAINNET` | `eip155:137` | SECP256K1 | false |
| `POLYGON_AMOY` | `eip155:80002` | SECP256K1 | false |
| `CELO_MAINNET` | `eip155:42220` | SECP256K1 | true |
| `BSC_MAINNET` | `eip155:56` | SECP256K1 | false |
| `BSC_TESTNET` | `eip155:97` | SECP256K1 | false |
| `BITCOIN_MAINNET` | `bip122:000000000019d6689c085ae165831e93-p2wpkh` | SECP256K1 | true |
| `BITCOIN_TESTNET` | `bip122:000000000933ea01ad0ee984209779ba-p2wpkh` | SECP256K1 | true |
| `TRON_MAINNET` | `tron:mainnet` | SECP256K1 | true |
| `TRON_NILE` | `tron:nile` | SECP256K1 | true |
| `SOLANA_MAINNET` | `solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp` | ED25519 | false |
| `SOLANA_DEVNET` | `solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1` | ED25519 | false |
| `STELLAR_MAINNET` | `stellar:pubnet` | ED25519 | true |
| `STELLAR_TESTNET` | `stellar:testnet` | ED25519 | true |
| `ARBITRUM_NOVA_MAINNET` | `eip155:42170` | SECP256K1 | false |
| `AVALANCHE_FUJI` | `eip155:43113` | SECP256K1 | false |
| `MONAD_TESTNET` | `eip155:10143` | SECP256K1 | false |
| `GNOSIS_MAINNET` | `eip155:100` | SECP256K1 | false |
| `GNOSIS_CHIADO` | `eip155:10200` | SECP256K1 | false |
| `FANTOM_MAINNET` | `eip155:250` | SECP256K1 | false |
| `ROOTSTOCK_MAINNET` | `eip155:30` | SECP256K1 | false |
| `ROOTSTOCK_TESTNET` | `eip155:31` | SECP256K1 | false |
| `ZKSYNC_MAINNET` | `eip155:324` | SECP256K1 | false |
| `ZKSYNC_SEPOLIA` | `eip155:300` | SECP256K1 | false |
| `CHILIZ_MAINNET` | `eip155:88888` | SECP256K1 | true |
| `CHILIZ_TESTNET` | `eip155:88882` | SECP256K1 | true |
| `CRONOS_MAINNET` | `eip155:25` | SECP256K1 | true |
| `RONIN_MAINNET` | `eip155:2020` | SECP256K1 | true |
| `LISK_MAINNET` | `eip155:1135` | SECP256K1 | true |
| `LITECOIN_MAINNET` | `bip122:12a765e31ffd4059bada1e25190f6e9` | SECP256K1 | true |
| `TRON_SHASTA` | `tron:shasta` | SECP256K1 | true |

`LITECOIN_MAINNET` is not a well-formed CAIP-2 id — Portal's registry key uses a
31-character genesis hash and no `-p2wpkh` suffix, and the SDK passes it through verbatim.

`requiresRpcUrl` only signals whether the chain _needs_ an RPC URL for enclave operations —
the SDK supplies one automatically regardless (see below). `WALLET_CHAINS[chain]` returns the
Expand Down
131 changes: 131 additions & 0 deletions src/chains.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,29 @@ export enum WalletChain {
CELO_MAINNET = 'eip155:42220',
BSC_MAINNET = 'eip155:56',
BSC_TESTNET = 'eip155:97',
ARBITRUM_NOVA_MAINNET = 'eip155:42170',
AVALANCHE_FUJI = 'eip155:43113',
MONAD_TESTNET = 'eip155:10143',
GNOSIS_MAINNET = 'eip155:100',
GNOSIS_CHIADO = 'eip155:10200',
FANTOM_MAINNET = 'eip155:250',
ROOTSTOCK_MAINNET = 'eip155:30',
ROOTSTOCK_TESTNET = 'eip155:31',
ZKSYNC_MAINNET = 'eip155:324',
ZKSYNC_SEPOLIA = 'eip155:300',
CHILIZ_MAINNET = 'eip155:88888',
CHILIZ_TESTNET = 'eip155:88882',
CRONOS_MAINNET = 'eip155:25',
RONIN_MAINNET = 'eip155:2020',
LISK_MAINNET = 'eip155:1135',
/**
* Litecoin. Portal's registry key uses a 31-character genesis hash and no
* `-p2wpkh` suffix (unlike its Bitcoin ids), so it is not a well-formed CAIP-2
* string. Kept verbatim — it is the value Portal's API matches on.
*/
LITECOIN_MAINNET = 'bip122:12a765e31ffd4059bada1e25190f6e9',
STELLAR_TESTNET = 'stellar:testnet',
TRON_SHASTA = 'tron:shasta',
}

export interface WalletChainConfig {
Expand Down Expand Up @@ -181,6 +204,114 @@ export const WALLET_CHAINS: Record<WalletChain, WalletChainConfig> = {
requiresRpcUrl: false,
tatumNetwork: 'bsc-testnet',
},
[WalletChain.ARBITRUM_NOVA_MAINNET]: {
chainId: WalletChain.ARBITRUM_NOVA_MAINNET,
curve: 'SECP256K1',
requiresRpcUrl: false,
tatumNetwork: 'arbitrum-nova-mainnet',
},
[WalletChain.AVALANCHE_FUJI]: {
chainId: WalletChain.AVALANCHE_FUJI,
curve: 'SECP256K1',
requiresRpcUrl: false,
tatumNetwork: 'avalanche-testnet',
},
[WalletChain.MONAD_TESTNET]: {
chainId: WalletChain.MONAD_TESTNET,
curve: 'SECP256K1',
requiresRpcUrl: false,
tatumNetwork: 'monad-testnet',
},
[WalletChain.GNOSIS_MAINNET]: {
chainId: WalletChain.GNOSIS_MAINNET,
curve: 'SECP256K1',
requiresRpcUrl: false,
tatumNetwork: 'gnosis-mainnet',
},
[WalletChain.GNOSIS_CHIADO]: {
chainId: WalletChain.GNOSIS_CHIADO,
curve: 'SECP256K1',
requiresRpcUrl: false,
tatumNetwork: 'gnosis-testnet',
},
[WalletChain.FANTOM_MAINNET]: {
chainId: WalletChain.FANTOM_MAINNET,
curve: 'SECP256K1',
requiresRpcUrl: false,
tatumNetwork: 'fantom-mainnet',
},
[WalletChain.ROOTSTOCK_MAINNET]: {
chainId: WalletChain.ROOTSTOCK_MAINNET,
curve: 'SECP256K1',
requiresRpcUrl: false,
tatumNetwork: 'rootstock-mainnet',
},
[WalletChain.ROOTSTOCK_TESTNET]: {
chainId: WalletChain.ROOTSTOCK_TESTNET,
curve: 'SECP256K1',
requiresRpcUrl: false,
tatumNetwork: 'rootstock-testnet',
},
[WalletChain.ZKSYNC_MAINNET]: {
chainId: WalletChain.ZKSYNC_MAINNET,
curve: 'SECP256K1',
requiresRpcUrl: false,
tatumNetwork: 'zksync-mainnet',
},
[WalletChain.ZKSYNC_SEPOLIA]: {
chainId: WalletChain.ZKSYNC_SEPOLIA,
curve: 'SECP256K1',
requiresRpcUrl: false,
tatumNetwork: 'zksync-sepolia',
},
[WalletChain.CHILIZ_MAINNET]: {
chainId: WalletChain.CHILIZ_MAINNET,
curve: 'SECP256K1',
requiresRpcUrl: true,
tatumNetwork: 'chiliz-mainnet',
},
[WalletChain.CHILIZ_TESTNET]: {
chainId: WalletChain.CHILIZ_TESTNET,
curve: 'SECP256K1',
requiresRpcUrl: true,
tatumNetwork: 'chiliz-testnet',
},
[WalletChain.CRONOS_MAINNET]: {
chainId: WalletChain.CRONOS_MAINNET,
curve: 'SECP256K1',
requiresRpcUrl: true,
tatumNetwork: 'cronos-mainnet',
},
[WalletChain.RONIN_MAINNET]: {
chainId: WalletChain.RONIN_MAINNET,
curve: 'SECP256K1',
requiresRpcUrl: true,
tatumNetwork: 'ronin-mainnet',
},
[WalletChain.LISK_MAINNET]: {
chainId: WalletChain.LISK_MAINNET,
curve: 'SECP256K1',
requiresRpcUrl: true,
tatumNetwork: 'lisk-mainnet',
},
[WalletChain.LITECOIN_MAINNET]: {
chainId: WalletChain.LITECOIN_MAINNET,
curve: 'SECP256K1',
requiresRpcUrl: true,
tatumNetwork: 'litecoin-mainnet',
},
[WalletChain.STELLAR_TESTNET]: {
chainId: WalletChain.STELLAR_TESTNET,
curve: 'ED25519',
requiresRpcUrl: true,
tatumNetwork: 'stellar-testnet',
},
[WalletChain.TRON_SHASTA]: {
chainId: WalletChain.TRON_SHASTA,
curve: 'SECP256K1',
requiresRpcUrl: true,
tatumNetwork: 'tron-shasta',
},
};

/** Resolve the configuration for a supported chain. */
Expand Down
47 changes: 46 additions & 1 deletion test/portal.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -463,7 +463,7 @@ describe('Portal-backed Tatum Wallets SDK', () => {
describe('WalletChain primary-chain mapping', () => {
it('exposes a Portal config for every primary chain, with the enum value as the chainId', () => {
const chains = Object.values(WalletChain);
expect(chains).toHaveLength(22);
expect(chains).toHaveLength(40);

for (const chain of chains) {
const config = getWalletChainConfig(chain);
Expand Down Expand Up @@ -541,6 +541,51 @@ describe('WalletChain primary-chain mapping', () => {
requiresRpcUrl: true,
tatumNetwork: 'bitcoin-testnet',
});
// Chains cross-checked against Portal's Core Feature Support table
// (`requiresRpcUrl` === "Default RPC" ❌) and Tatum's blockchains2.json slugs.
expect(WALLET_CHAINS[WalletChain.LITECOIN_MAINNET]).toEqual({
// Portal lists a 31-char genesis hash (not the CAIP-2 32-char form) and no
// `-p2wpkh` suffix; passed through verbatim as Portal's registry key.
chainId: 'bip122:12a765e31ffd4059bada1e25190f6e9',
curve: 'SECP256K1',
requiresRpcUrl: true,
tatumNetwork: 'litecoin-mainnet',
});
expect(WALLET_CHAINS[WalletChain.STELLAR_TESTNET]).toEqual({
chainId: 'stellar:testnet',
curve: 'ED25519',
requiresRpcUrl: true,
tatumNetwork: 'stellar-testnet',
});
expect(WALLET_CHAINS[WalletChain.TRON_SHASTA]).toEqual({
chainId: 'tron:shasta',
curve: 'SECP256K1',
requiresRpcUrl: true,
tatumNetwork: 'tron-shasta',
});
expect(WALLET_CHAINS[WalletChain.ZKSYNC_MAINNET]).toEqual({
chainId: 'eip155:324',
curve: 'SECP256K1',
requiresRpcUrl: false,
tatumNetwork: 'zksync-mainnet',
});
expect(WALLET_CHAINS[WalletChain.GNOSIS_CHIADO]).toEqual({
chainId: 'eip155:10200',
curve: 'SECP256K1',
requiresRpcUrl: false,
tatumNetwork: 'gnosis-testnet',
});
// Portal reports no default RPC for these, so callers must supply one.
expect(WALLET_CHAINS[WalletChain.CHILIZ_MAINNET].requiresRpcUrl).toBe(true);
expect(WALLET_CHAINS[WalletChain.CRONOS_MAINNET].requiresRpcUrl).toBe(true);
expect(WALLET_CHAINS[WalletChain.RONIN_MAINNET].requiresRpcUrl).toBe(true);
expect(WALLET_CHAINS[WalletChain.LISK_MAINNET].requiresRpcUrl).toBe(true);
// Tatum slugs that don't follow the `<chain>-<network>` guess.
expect(WALLET_CHAINS[WalletChain.AVALANCHE_FUJI].tatumNetwork).toBe('avalanche-testnet');
expect(WALLET_CHAINS[WalletChain.ARBITRUM_NOVA_MAINNET].tatumNetwork).toBe(
'arbitrum-nova-mainnet',
);
expect(WALLET_CHAINS[WalletChain.ZKSYNC_SEPOLIA].tatumNetwork).toBe('zksync-sepolia');
expect(WALLET_CHAINS[WalletChain.TRON_NILE]).toEqual({
chainId: 'tron:nile',
curve: 'SECP256K1',
Expand Down
Loading