@chainflip/rpc 1.4.0

package/dist/parsers.js

@@ -0,0 +1,113 @@
+import { isNotNullish } from "@chainflip/utils/guard";
+import { isHex } from "@chainflip/utils/string";
+import { z } from "zod";
+const hexString = z.string().refine(isHex, { message: "Invalid hex string" });
+const u256 = hexString.transform((value) => BigInt(value));
+const numberOrHex = z.union([z.number().transform((n) => BigInt(n)), u256]);
+const chainAssetMapFactory = (parser) => z.object({
+  Bitcoin: z.object({ BTC: parser }),
+  Ethereum: z.object({ ETH: parser, USDC: parser, FLIP: parser, USDT: parser }),
+  Polkadot: z.object({ DOT: parser }),
+  Arbitrum: z.object({ ETH: parser, USDC: parser })
+});
+const chainMapFactory = (parser) => z.object({ Bitcoin: parser, Ethereum: parser, Polkadot: parser, Arbitrum: parser });
+const rpcAssetSchema = z.union([
+  z.object({ chain: z.literal("Bitcoin"), asset: z.literal("BTC") }),
+  z.object({ chain: z.literal("Polkadot"), asset: z.literal("DOT") }),
+  z.object({ chain: z.literal("Ethereum"), asset: z.literal("FLIP") }),
+  z.object({ chain: z.literal("Ethereum"), asset: z.literal("ETH") }),
+  z.object({ chain: z.literal("Ethereum"), asset: z.literal("USDC") }),
+  z.object({ chain: z.literal("Ethereum"), asset: z.literal("USDT") }),
+  z.object({ chain: z.literal("Arbitrum"), asset: z.literal("ETH") }),
+  z.object({ chain: z.literal("Arbitrum"), asset: z.literal("USDC") })
+]);
+const rename = (mapping) => (obj) => Object.fromEntries(
+  Object.entries(obj).map(([key, value]) => [
+    key in mapping ? mapping[key] : key,
+    value
+  ])
+);
+const rpcBaseResponse = z.object({
+  id: z.union([z.string(), z.number()]),
+  jsonrpc: z.literal("2.0")
+});
+const nonNullish = z.any().refine(isNotNullish, { message: "Value must not be null or undefined" });
+const rpcSuccessResponse = rpcBaseResponse.extend({ result: nonNullish });
+const rpcErrorResponse = rpcBaseResponse.extend({
+  error: z.object({ code: z.number(), message: z.string() })
+});
+const rpcResponse = z.union([rpcSuccessResponse, rpcErrorResponse]);
+const cfSwapRate = z.object({
+  intermediary: numberOrHex.nullable(),
+  output: numberOrHex
+});
+const fee = z.intersection(rpcAssetSchema, z.object({ amount: numberOrHex }));
+const cfSwapRateV2 = z.object({
+  egress_fee: fee,
+  ingress_fee: fee,
+  intermediary: u256.nullable(),
+  network_fee: fee,
+  output: u256
+});
+const chainGetBlockHash = hexString;
+const stateGetMetadata = hexString;
+const stateGetRuntimeVersion = z.object({
+  specName: z.string(),
+  implName: z.string(),
+  authoringVersion: z.number(),
+  specVersion: z.number(),
+  implVersion: z.number(),
+  apis: z.array(z.tuple([hexString, z.number()])),
+  transactionVersion: z.number(),
+  stateVersion: z.number()
+});
+const cfIngressEgressEnvironment = z.object({
+  minimum_deposit_amounts: chainAssetMapFactory(numberOrHex),
+  ingress_fees: chainAssetMapFactory(numberOrHex.nullable()),
+  egress_fees: chainAssetMapFactory(numberOrHex.nullable()),
+  witness_safety_margins: chainMapFactory(z.number().nullable()),
+  egress_dust_limits: chainAssetMapFactory(numberOrHex),
+  channel_opening_fees: chainMapFactory(numberOrHex)
+}).transform(rename({ egress_dust_limits: "minimum_egress_amounts" }));
+const cfSwappingEnvironment = z.object({
+  maximum_swap_amounts: chainAssetMapFactory(numberOrHex.nullable()),
+  network_fee_hundredth_pips: z.number()
+});
+const cfFundingEnvironment = z.object({
+  redemption_tax: numberOrHex,
+  minimum_funding_amount: numberOrHex
+});
+const cfEnvironment = z.object({
+  ingress_egress: cfIngressEgressEnvironment,
+  swapping: cfSwappingEnvironment,
+  funding: cfFundingEnvironment
+});
+const cfBoostPoolsDepth = z.array(
+  z.intersection(rpcAssetSchema, z.object({ tier: z.number(), available_amount: u256 }))
+);
+const cfSupportedAsssets = z.array(rpcAssetSchema);
+const brokerRequestSwapDepositAddress = z.object({
+  address: z.string(),
+  issued_block: z.number(),
+  channel_id: z.number(),
+  source_chain_expiry_block: numberOrHex,
+  channel_opening_fee: u256
+});
+export {
+  brokerRequestSwapDepositAddress,
+  cfBoostPoolsDepth,
+  cfEnvironment,
+  cfFundingEnvironment,
+  cfIngressEgressEnvironment,
+  cfSupportedAsssets,
+  cfSwapRate,
+  cfSwapRateV2,
+  cfSwappingEnvironment,
+  chainGetBlockHash,
+  hexString,
+  numberOrHex,
+  rpcResponse,
+  stateGetMetadata,
+  stateGetRuntimeVersion,
+  u256
+};

package/dist/types.cjs

@@ -0,0 +1 @@
+"use strict";

package/dist/types.d.cts

@@ -0,0 +1,24 @@
+import { RpcResult, RpcResponse } from './common.cjs';
+export { RpcMethod, RpcRequest as RpcParams } from './common.cjs';
+import 'zod';
+import './parsers.cjs';
+import '@chainflip/utils/types';
+
+type CfBoostPoolsDepth = RpcResult<'cf_boost_pools_depth'>;
+type CfEnvironment = RpcResult<'cf_environment'>;
+type CfFundingEnvironment = RpcResult<'cf_funding_environment'>;
+type CfIngressEgressEnvironment = RpcResult<'cf_ingress_egress_environment'>;
+type CfSupportedAssets = RpcResult<'cf_supported_assets'>;
+type CfSwappingEnvironment = RpcResult<'cf_swapping_environment'>;
+type CfSwapRate = RpcResult<'cf_swap_rate'>;
+type CfSwapRateV2 = RpcResult<'cf_swap_rate_v2'>;
+type CfBoostPoolsDepthResponse = RpcResponse<'cf_boost_pools_depth'>;
+type CfEnvironmentResponse = RpcResponse<'cf_environment'>;
+type CfFundingEnvironmentResponse = RpcResponse<'cf_funding_environment'>;
+type CfIngressEgressEnvironmentResponse = RpcResponse<'cf_ingress_egress_environment'>;
+type CfSupportedAssetsResponse = RpcResponse<'cf_supported_assets'>;
+type CfSwappingEnvironmentResponse = RpcResponse<'cf_swapping_environment'>;
+type CfSwapRateResponse = RpcResponse<'cf_swap_rate'>;
+type CfSwapRateV2Response = RpcResponse<'cf_swap_rate_v2'>;
+
+export { type CfBoostPoolsDepth, type CfBoostPoolsDepthResponse, type CfEnvironment, type CfEnvironmentResponse, type CfFundingEnvironment, type CfFundingEnvironmentResponse, type CfIngressEgressEnvironment, type CfIngressEgressEnvironmentResponse, type CfSupportedAssets, type CfSupportedAssetsResponse, type CfSwapRate, type CfSwapRateResponse, type CfSwapRateV2, type CfSwapRateV2Response, type CfSwappingEnvironment, type CfSwappingEnvironmentResponse, RpcResult };

package/dist/types.d.ts

@@ -0,0 +1,24 @@
+import { RpcResult, RpcResponse } from './common.js';
+export { RpcMethod, RpcRequest as RpcParams } from './common.js';
+import 'zod';
+import './parsers.js';
+import '@chainflip/utils/types';
+
+type CfBoostPoolsDepth = RpcResult<'cf_boost_pools_depth'>;
+type CfEnvironment = RpcResult<'cf_environment'>;
+type CfFundingEnvironment = RpcResult<'cf_funding_environment'>;
+type CfIngressEgressEnvironment = RpcResult<'cf_ingress_egress_environment'>;
+type CfSupportedAssets = RpcResult<'cf_supported_assets'>;
+type CfSwappingEnvironment = RpcResult<'cf_swapping_environment'>;
+type CfSwapRate = RpcResult<'cf_swap_rate'>;
+type CfSwapRateV2 = RpcResult<'cf_swap_rate_v2'>;
+type CfBoostPoolsDepthResponse = RpcResponse<'cf_boost_pools_depth'>;
+type CfEnvironmentResponse = RpcResponse<'cf_environment'>;
+type CfFundingEnvironmentResponse = RpcResponse<'cf_funding_environment'>;
+type CfIngressEgressEnvironmentResponse = RpcResponse<'cf_ingress_egress_environment'>;
+type CfSupportedAssetsResponse = RpcResponse<'cf_supported_assets'>;
+type CfSwappingEnvironmentResponse = RpcResponse<'cf_swapping_environment'>;
+type CfSwapRateResponse = RpcResponse<'cf_swap_rate'>;
+type CfSwapRateV2Response = RpcResponse<'cf_swap_rate_v2'>;
+
+export { type CfBoostPoolsDepth, type CfBoostPoolsDepthResponse, type CfEnvironment, type CfEnvironmentResponse, type CfFundingEnvironment, type CfFundingEnvironmentResponse, type CfIngressEgressEnvironment, type CfIngressEgressEnvironmentResponse, type CfSupportedAssets, type CfSupportedAssetsResponse, type CfSwapRate, type CfSwapRateResponse, type CfSwapRateV2, type CfSwapRateV2Response, type CfSwappingEnvironment, type CfSwappingEnvironmentResponse, RpcResult };

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@chainflip/rpc",
+  "version": "1.4.0",
+  "type": "module",
+  "dependencies": {
+    "@chainflip/utils": "^0.1.3",
+    "zod": "^3.22.8"
+  },
+  "devDependencies": {
+    "@types/node": "^20.12.7",
+    "@types/ws": "^8.5.10",
+    "ws": "^8.17.0"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "exports": {
+    "./*": {
+      "require": {
+        "types": "./dist/*.d.cts",
+        "default": "./dist/*.cjs"
+      },
+      "import": {
+        "types": "./dist/*.d.ts",
+        "default": "./dist/*.js"
+      }
+    },
+    ".": {
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      },
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
+  "repository": "https://github.com/chainflip-io/chainflip-product-toolkit.git",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "scripts": {
+    "clean": "rm -rf dist",
+    "prepublish": "pnpm test run && pnpm build",
+    "build": "pnpm clean && pnpm tsup",
+    "test": "vitest",
+    "coverage": "vitest run --coverage"
+  }
+}