@somnia-chain/contracts-sdk 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,56 @@
+import { registry } from "./gen/registry.js";
+export * from "./gen/registry.js";
+export type Registry = typeof registry;
+export type NetworkSlug = keyof Registry & string;
+export type ProjectSlug<N extends NetworkSlug> = keyof Registry[N]["contracts"] & string;
+export type ContractName<N extends NetworkSlug, P extends ProjectSlug<N>> = keyof Registry[N]["contracts"][P] & string;
+export type Address = `0x${string}`;
+/** One deployment's record; narrow it by passing slugs and a name. */
+export type ContractEntry<N extends NetworkSlug = NetworkSlug, P extends ProjectSlug<N> = ProjectSlug<N>, C extends ContractName<N, P> = ContractName<N, P>> = Registry[N]["contracts"][P][C];
+type DistributedOmit<T, K extends PropertyKey> = T extends unknown ? Omit<T, K> : never;
+/** One network's chain information, without the address book. */
+export type NetworkInfo<N extends NetworkSlug = NetworkSlug> = DistributedOmit<Registry[N], "contracts">;
+/** Every network's chain information, retired ones included. */
+export declare const networks: readonly NetworkInfo[];
+/** One network's chain information, without the address book. */
+export declare function getNetwork<N extends NetworkSlug>(network: N): Omit<Registry[N], "contracts">;
+/**
+ * All networks that answer at a chain id. Plural on purpose: chain ids are
+ * not unique across Somnia networks (a regenesis reuses the id with none of
+ * the state), so an id can name a retired and a live network at once. Filter
+ * on `status` if only the live one matters.
+ */
+export declare function getNetworksByChainId(chainId: number): NetworkInfo[];
+/**
+ * A viem-`Chain`-shaped object for a network, structurally compatible with
+ * `viem`'s `Chain` without depending on it. The registry records no public
+ * RPC endpoint — deliberately — so you bring your own.
+ */
+export declare function toChain<N extends NetworkSlug>(network: N, opts: {
+    rpcUrl: string;
+    wsUrl?: string;
+}): {
+    id: Registry[N]["chainId"];
+    name: Registry[N]["name"];
+    nativeCurrency: Registry[N]["nativeCurrency"];
+    rpcUrls: {
+        default: {
+            http: readonly [string];
+            webSocket?: readonly [string];
+        };
+    };
+    blockExplorers?: {
+        default: {
+            name: string;
+            url: string;
+        };
+    };
+};
+/** One deployment: address, kind, version, status and — where recorded — the ABI. */
+export declare function getContract<N extends NetworkSlug, P extends ProjectSlug<N>, C extends ContractName<N, P>>(network: N, project: P, name: C): Registry[N]["contracts"][P][C];
+export declare function getAddress<N extends NetworkSlug, P extends ProjectSlug<N>, C extends ContractName<N, P>>(network: N, project: P, name: C): Registry[N]["contracts"][P][C] extends {
+    address: infer A;
+} ? A : never;
+export declare function getAbi<N extends NetworkSlug, P extends ProjectSlug<N>, C extends ContractName<N, P>>(network: N, project: P, name: C): Registry[N]["contracts"][P][C] extends {
+    abi: infer A;
+} ? A : undefined;

package/dist/index.js

@@ -0,0 +1,61 @@
+import { registry } from "./gen/registry.js";
+export * from "./gen/registry.js";
+/** Every network's chain information, retired ones included. */
+export const networks = Object.keys(registry).map((slug) => getNetwork(slug));
+/** One network's chain information, without the address book. */
+export function getNetwork(network) {
+    const entry = registry[network];
+    if (!entry)
+        throw new Error(`unknown network: ${String(network)}`);
+    const { contracts: _contracts, ...info } = entry;
+    return info;
+}
+/**
+ * All networks that answer at a chain id. Plural on purpose: chain ids are
+ * not unique across Somnia networks (a regenesis reuses the id with none of
+ * the state), so an id can name a retired and a live network at once. Filter
+ * on `status` if only the live one matters.
+ */
+export function getNetworksByChainId(chainId) {
+    return Object.keys(registry)
+        .filter((slug) => registry[slug].chainId === chainId)
+        .map((slug) => getNetwork(slug));
+}
+/**
+ * A viem-`Chain`-shaped object for a network, structurally compatible with
+ * `viem`'s `Chain` without depending on it. The registry records no public
+ * RPC endpoint — deliberately — so you bring your own.
+ */
+export function toChain(network, opts) {
+    const info = getNetwork(network);
+    const explorer = info.explorerUrls?.[0];
+    return {
+        id: registry[network].chainId,
+        name: registry[network].name,
+        nativeCurrency: registry[network].nativeCurrency,
+        rpcUrls: {
+            default: {
+                http: [opts.rpcUrl],
+                ...(opts.wsUrl ? { webSocket: [opts.wsUrl] } : {}),
+            },
+        },
+        ...(explorer ? { blockExplorers: { default: { name: "Explorer", url: explorer } } } : {}),
+    };
+}
+/** One deployment: address, kind, version, status and — where recorded — the ABI. */
+export function getContract(network, project, name) {
+    const book = registry[network]?.contracts;
+    if (!book)
+        throw new Error(`unknown network: ${String(network)}`);
+    const entry = book[project]?.[name];
+    if (!entry)
+        throw new Error(`unknown contract: ${String(project)}/${String(name)} on ${String(network)}`);
+    return entry;
+}
+export function getAddress(network, project, name) {
+    return getContract(network, project, name)
+        .address;
+}
+export function getAbi(network, project, name) {
+    return getContract(network, project, name).abi;
+}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@somnia-chain/contracts-sdk",
+  "version": "0.1.0",
+  "description": "Somnia contract addresses, ABIs and chain information, typed. Generated from the Somnia contract registry.",
+  "license": "MIT",
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/somnia-chain/contract-registry.git",
+    "directory": "sdk"
+  },
+  "keywords": [
+    "somnia",
+    "contracts",
+    "addresses",
+    "abi",
+    "web3"
+  ]
+}