@elsoul/erpc-sdk 0.4.0 → 0.6.0

package/README.md

@@ -1,8 +1,9 @@
 # `@elsoul/erpc-sdk`
 
 Official type-safe TypeScript client for [ERPC](https://erpc.global). Use one
-client and one API key for Solana, Ethereum, price data, indexed data, leader
-and validator data, analytics, subscriptions, and account information.
+client and one API key for Solana, Ethereum, Avalanche C/P/X chains, price data,
+indexed data, leader and validator data, analytics, subscriptions, and account
+information.
 
 ## Install
 
@@ -26,8 +27,9 @@ const erpc = createErpcClient({ apiKey })
 
 const slot = await erpc.solana.rpc.getSlot().send()
 const chainId = await erpc.ethereum.rpc.eth_chainId().send()
+const avalancheChainId = await erpc.avalanche.rpc.eth_chainId().send()
 
-console.log({ slot, chainId })
+console.log({ slot, chainId, avalancheChainId })
 erpc.close()
 ```
 
@@ -46,10 +48,25 @@ network request.
 | `erpc.solana.subscriptions` | Enhanced WebSocket subscriptions |
 | `erpc.ethereum.rpc` | Ethereum JSON-RPC |
 | `erpc.ethereum.subscriptions` | Ethereum WebSocket subscriptions |
+| `erpc.avalanche.rpc` | Avalanche C-Chain EVM-compatible JSON-RPC |
+| `erpc.avalanche.subscriptions` | Avalanche C-Chain WebSocket subscriptions |
+| `erpc.avalanche.avax` | C-Chain AVAX atomic transaction API |
+| `erpc.avalanche.xChain` | X-Chain API |
+| `erpc.avalanche.pChain` | P-Chain API |
+| `erpc.avalanche.proposerVm` | P-Chain proposer VM API |
+| `erpc.avalanche.info` | Network upgrade information |
+| `erpc.avalanche.index` | C/P/X block and X transaction indexes |
 | `erpc.price` | Price metadata, updates, and streams |
 | `erpc.account` | ERPC token balance |
 | `erpc.usage` | Masked monthly API-key usage |
 
+`avalancheEndpoint` defaults to `https://ava-rpc.erpc.global` and can be
+overridden independently from the shared `endpoint` option. The SDK uses its
+`/ava` HTTP route and `/ava-ws` WebSocket route. Native C/P/X methods use named
+parameters; Index calls are routed to the required explicit chain/container
+path. Native and Index batches are rejected locally. Use `raw` with an exact
+wire method name for forward compatibility.
+
 ## Examples
 
 ```ts
@@ -59,6 +76,16 @@ const block = await erpc.ethereum.rpc
   .eth_getBlockByNumber('latest', false)
   .send()
 
+const avalancheBlock = await erpc.avalanche.rpc
+  .eth_getBlockByNumber('latest', false)
+  .send()
+
+const pChainHeight = await erpc.avalanche.pChain.getHeight().send()
+const xChainHeight = await erpc.avalanche.xChain.getHeight().send()
+const indexedTransaction = await erpc.avalanche.index.xChainTransactions
+  .getContainerByID({ id: transactionId })
+  .send()
+
 const prices = await erpc.price.getLatestPriceUpdates({
   ids: [feedId],
   parsed: true,

package/dist/index.cjs

@@ -316,6 +316,7 @@ var CloudCatalogClient = class {
 
 // src/config.ts
 var DEFAULT_ENDPOINT = "https://edge.erpc.global";
+var DEFAULT_AVALANCHE_ENDPOINT = "https://ava-rpc.erpc.global";
 var DEFAULT_ACCOUNT_ENDPOINT = "https://solana-rpc.erpc.global";
 var DEFAULT_USER_ENDPOINT = "https://user-api.erpc.global";
 var DEFAULT_TIMEOUT_MS = 3e4;
@@ -332,10 +333,14 @@ var resolveConfig = (config) => {
   const apiKey = config.apiKey.trim();
   if (!apiKey) throw new ErpcConfigError("apiKey must not be empty");
   let endpoint;
+  let avalancheEndpoint;
   let accountEndpoint;
   let userEndpoint;
   try {
     endpoint = new URL(config.endpoint ?? DEFAULT_ENDPOINT);
+    avalancheEndpoint = new URL(
+      config.avalancheEndpoint ?? DEFAULT_AVALANCHE_ENDPOINT
+    );
     accountEndpoint = new URL(
       config.accountEndpoint ?? DEFAULT_ACCOUNT_ENDPOINT
     );
@@ -346,6 +351,9 @@ var resolveConfig = (config) => {
   if (endpoint.protocol !== "https:" && endpoint.protocol !== "http:") {
     throw new ErpcConfigError("endpoint must use HTTP or HTTPS");
   }
+  if (avalancheEndpoint.protocol !== "https:" && avalancheEndpoint.protocol !== "http:") {
+    throw new ErpcConfigError("avalancheEndpoint must use HTTP or HTTPS");
+  }
   if (accountEndpoint.protocol !== "https:" && accountEndpoint.protocol !== "http:") {
     throw new ErpcConfigError("accountEndpoint must use HTTP or HTTPS");
   }
@@ -355,6 +363,9 @@ var resolveConfig = (config) => {
   endpoint.search = "";
   endpoint.hash = "";
   endpoint.pathname = endpoint.pathname.replace(/\/+$/, "") || "/";
+  avalancheEndpoint.search = "";
+  avalancheEndpoint.hash = "";
+  avalancheEndpoint.pathname = avalancheEndpoint.pathname.replace(/\/+$/, "") || "/";
   accountEndpoint.search = "";
   accountEndpoint.hash = "";
   accountEndpoint.pathname = accountEndpoint.pathname.replace(/\/+$/, "") || "/";
@@ -368,6 +379,7 @@ var resolveConfig = (config) => {
   return {
     accountEndpoint,
     apiKey,
+    avalancheEndpoint,
     endpoint,
     fetch: requireFetch(config.fetch),
     headers: config.headers ?? {},
@@ -529,10 +541,14 @@ var methodParams = (mode, args) => {
   return args[0];
 };
 var createRpcNamespace = (config) => {
+  const wireMethod = (method) => config.methodPrefix === void 0 ? method : `${config.methodPrefix}.${method}`;
   const base = {
     endpoint: config.transport.endpoint,
     batch: (calls) => {
-      const wireCalls = calls;
+      const wireCalls = calls.map((call) => ({
+        ...call,
+        method: wireMethod(call.method)
+      }));
       config.validateBatch?.(wireCalls);
       return new PendingRpcBatchRequest(
         (options) => config.transport.batch(
@@ -546,7 +562,7 @@ var createRpcNamespace = (config) => {
     ),
     request: (method, ...params) => new PendingRpcRequest(
       (options) => config.transport.request(
-        method,
+        wireMethod(method),
         params[0],
         options
       )
@@ -560,7 +576,7 @@ var createRpcNamespace = (config) => {
       if (property === "then") return void 0;
       return (...args) => new PendingRpcRequest(
         (options) => config.transport.request(
-          property,
+          wireMethod(property),
           methodParams(config.parameterMode, args),
           options
         )
@@ -636,6 +652,110 @@ var createEthereumClient = (transport) => ({
   })
 });
 
+// src/rpc/avalanche.ts
+var AVALANCHE_AVAX_METHODS = [
+  "avax.getAtomicTx",
+  "avax.getAtomicTxStatus",
+  "avax.getUTXOs",
+  "avax.issueTx"
+];
+var AVALANCHE_X_CHAIN_METHODS = [
+  "avm.buildGenesis",
+  "avm.getAllBalances",
+  "avm.getAssetDescription",
+  "avm.getBalance",
+  "avm.getBlockByHeight",
+  "avm.getHeight",
+  "avm.getTx",
+  "avm.getTxFee",
+  "avm.getTxStatus",
+  "avm.getUTXOs",
+  "avm.issueTx"
+];
+var AVALANCHE_P_CHAIN_METHODS = [
+  "platform.getAllValidatorsAt",
+  "platform.getBalance",
+  "platform.getBlockchainStatus",
+  "platform.getBlockchains",
+  "platform.getCurrentSupply",
+  "platform.getCurrentValidators",
+  "platform.getFeeConfig",
+  "platform.getFeeState",
+  "platform.getHeight",
+  "platform.getMinStake",
+  "platform.getRewardUTXOs",
+  "platform.getStake",
+  "platform.getStakingAssetID",
+  "platform.getSubnets",
+  "platform.getTimestamp",
+  "platform.getTotalStake",
+  "platform.getTx",
+  "platform.getTxStatus",
+  "platform.getUTXOs",
+  "platform.getValidatorFeeConfig",
+  "platform.getValidatorFeeState",
+  "platform.getValidatorsAt",
+  "platform.issueTx",
+  "platform.sampleValidators",
+  "platform.validatedBy",
+  "platform.validates"
+];
+var AVALANCHE_PROPOSER_VM_METHODS = [
+  "proposervm.getCurrentEpoch",
+  "proposervm.getProposedHeight"
+];
+var AVALANCHE_INFO_METHODS = ["info.upgrades"];
+var AVALANCHE_INDEX_METHODS = [
+  "index.getContainerByID",
+  "index.getContainerByIndex",
+  "index.getContainerRange",
+  "index.getIndex",
+  "index.getLastAccepted",
+  "index.isAccepted"
+];
+var rejectNativeBatch = (calls) => {
+  if (calls.length > 0) {
+    throw new ErpcBatchPolicyError(
+      "Avalanche native RPC methods do not support batching"
+    );
+  }
+};
+var nativeNamespace = (transport, methodPrefix) => createRpcNamespace({
+  methodPrefix,
+  parameterMode: "named",
+  transport,
+  validateBatch: rejectNativeBatch
+});
+var createAvalancheClient = (transport, indexTransports) => ({
+  ...createEthereumClient(transport),
+  avax: nativeNamespace(transport, "avax"),
+  xChain: nativeNamespace(transport, "avm"),
+  pChain: nativeNamespace(transport, "platform"),
+  proposerVm: nativeNamespace(
+    transport,
+    "proposervm"
+  ),
+  info: nativeNamespace(transport, "info"),
+  index: {
+    cChainBlocks: nativeNamespace(
+      indexTransports.cChainBlocks,
+      "index"
+    ),
+    pChainBlocks: nativeNamespace(
+      indexTransports.pChainBlocks,
+      "index"
+    ),
+    xChainBlocks: nativeNamespace(
+      indexTransports.xChainBlocks,
+      "index"
+    ),
+    xChainTransactions: nativeNamespace(
+      indexTransports.xChainTransactions,
+      "index"
+    )
+  }
+});
+
 // src/rpc/solana.ts
 var SOLANA_RPC_METHODS = [
   "getAccountInfo",
@@ -1394,6 +1514,14 @@ var createErpcClient = (config) => {
     ...sharedTransport,
     endpoint: ethereumEndpoint
   });
+  const avalancheTransport = new HttpJsonRpcTransport({
+    ...sharedTransport,
+    endpoint: endpointWithPath(resolved.avalancheEndpoint, "/ava")
+  });
+  const avalancheIndexTransport = (path) => new HttpJsonRpcTransport({
+    ...sharedTransport,
+    endpoint: endpointWithPath(resolved.avalancheEndpoint, path)
+  });
   const solanaWebSocket = new WebSocketJsonRpcTransport({
     endpoint: websocketUrl(resolved.endpoint, resolved.apiKey),
     timeoutMs: resolved.timeoutMs,
@@ -1404,6 +1532,15 @@ var createErpcClient = (config) => {
     timeoutMs: resolved.timeoutMs,
     ...resolved.webSocket === void 0 ? {} : { webSocket: resolved.webSocket }
   });
+  const avalancheWebSocket = new WebSocketJsonRpcTransport({
+    endpoint: websocketUrl(
+      resolved.avalancheEndpoint,
+      resolved.apiKey,
+      "/ava-ws"
+    ),
+    timeoutMs: resolved.timeoutMs,
+    ...resolved.webSocket === void 0 ? {} : { webSocket: resolved.webSocket }
+  });
   const priceTransport = new RestTransport({
     ...sharedTransport,
     endpoint: resolved.endpoint
@@ -1424,15 +1561,26 @@ var createErpcClient = (config) => {
     ...createEthereumClient(ethereumTransport),
     subscriptions: new EthereumSubscriptions(ethereumWebSocket)
   };
+  const avalanche = {
+    ...createAvalancheClient(avalancheTransport, {
+      cChainBlocks: avalancheIndexTransport("/ava/ext/index/C/block"),
+      pChainBlocks: avalancheIndexTransport("/ava/ext/index/P/block"),
+      xChainBlocks: avalancheIndexTransport("/ava/ext/index/X/block"),
+      xChainTransactions: avalancheIndexTransport("/ava/ext/index/X/tx")
+    }),
+    subscriptions: new EthereumSubscriptions(avalancheWebSocket)
+  };
   return {
     solana,
     ethereum,
+    avalanche,
     price: new PriceClient(priceTransport),
     account: new AccountClient(accountTransport),
     usage: new UsageClient(userTransport),
     close: () => {
       solana.subscriptions.close();
       ethereum.subscriptions.close();
+      avalanche.subscriptions.close();
     }
   };
 };
@@ -1653,11 +1801,18 @@ var createErpcCloudClient = (config) => {
   };
 };
 
+exports.AVALANCHE_AVAX_METHODS = AVALANCHE_AVAX_METHODS;
+exports.AVALANCHE_INDEX_METHODS = AVALANCHE_INDEX_METHODS;
+exports.AVALANCHE_INFO_METHODS = AVALANCHE_INFO_METHODS;
+exports.AVALANCHE_PROPOSER_VM_METHODS = AVALANCHE_PROPOSER_VM_METHODS;
+exports.AVALANCHE_P_CHAIN_METHODS = AVALANCHE_P_CHAIN_METHODS;
+exports.AVALANCHE_X_CHAIN_METHODS = AVALANCHE_X_CHAIN_METHODS;
 exports.AccountClient = AccountClient;
 exports.CloudCatalogClient = CloudCatalogClient;
 exports.CloudCreditClient = CloudCreditClient;
 exports.CloudResourcesClient = CloudResourcesClient;
 exports.DEFAULT_ACCOUNT_ENDPOINT = DEFAULT_ACCOUNT_ENDPOINT;
+exports.DEFAULT_AVALANCHE_ENDPOINT = DEFAULT_AVALANCHE_ENDPOINT;
 exports.DEFAULT_ENDPOINT = DEFAULT_ENDPOINT;
 exports.DEFAULT_TIMEOUT_MS = DEFAULT_TIMEOUT_MS;
 exports.DEFAULT_USER_ENDPOINT = DEFAULT_USER_ENDPOINT;