@aboutcircles/sdk-runner 0.1.27 → 0.1.29

package/dist/chain-types.d.ts

@@ -0,0 +1,84 @@
+import type { Chain } from 'viem';
+/**
+ * Flexible chain configuration interface.
+ * Accepts both full viem Chain objects and minimal chain configs.
+ * This allows the runner to work without requiring the exact viem Chain branded type.
+ */
+export interface ChainConfig {
+    id: number;
+    name: string;
+    nativeCurrency: {
+        name: string;
+        symbol: string;
+        decimals: number;
+    };
+    rpcUrls: {
+        default: {
+            http: readonly string[];
+        };
+    };
+}
+/**
+ * Type that accepts either a full viem Chain or our minimal ChainConfig.
+ * This provides flexibility while maintaining type safety.
+ */
+export type ChainLike = Chain | ChainConfig;
+/**
+ * Validates that a ChainLike object has the required fields for viem's createPublicClient.
+ * Throws an error if required fields are missing, making failures explicit.
+ *
+ * @param chain - The chain configuration to validate
+ * @returns The chain cast to viem's expected type
+ * @throws Error if required fields are missing
+ */
+export declare function asViemChain(chain: ChainLike): Chain;
+/**
+ * Pre-configured chain configs for common networks.
+ * Use these instead of importing from viem/chains to avoid type mismatches.
+ */
+export declare const chains: {
+    readonly gnosis: {
+        id: number;
+        name: string;
+        nativeCurrency: {
+            name: string;
+            symbol: string;
+            decimals: number;
+        };
+        rpcUrls: {
+            default: {
+                http: readonly ["https://rpc.gnosischain.com"];
+            };
+        };
+    };
+    readonly chiado: {
+        id: number;
+        name: string;
+        nativeCurrency: {
+            name: string;
+            symbol: string;
+            decimals: number;
+        };
+        rpcUrls: {
+            default: {
+                http: readonly ["https://rpc.chiadochain.net"];
+            };
+        };
+    };
+    /** Alias for chiado - common testnet naming convention */
+    readonly gnosisChiado: {
+        id: number;
+        name: string;
+        nativeCurrency: {
+            name: string;
+            symbol: string;
+            decimals: number;
+        };
+        rpcUrls: {
+            default: {
+                http: readonly ["https://rpc.chiadochain.net"];
+            };
+        };
+    };
+};
+//# sourceMappingURL=chain-types.d.ts.map

package/dist/chain-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chain-types.d.ts","sourceRoot":"","sources":["../src/chain-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAElC;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE;QACd,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,OAAO,EAAE;QACP,OAAO,EAAE;YACP,IAAI,EAAE,SAAS,MAAM,EAAE,CAAC;SACzB,CAAC;KACH,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,WAAW,CAAC;AAE5C;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,SAAS,GAAG,KAAK,CAiBnD;AAED;;;GAGG;AACH,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA+BjB,0DAA0D;;;;;;;;;;;;;;;CAIlD,CAAC"}

package/dist/chain-types.js

@@ -0,0 +1,63 @@
+/**
+ * Validates that a ChainLike object has the required fields for viem's createPublicClient.
+ * Throws an error if required fields are missing, making failures explicit.
+ *
+ * @param chain - The chain configuration to validate
+ * @returns The chain cast to viem's expected type
+ * @throws Error if required fields are missing
+ */
+export function asViemChain(chain) {
+    // Validate required fields exist at runtime
+    if (typeof chain.id !== 'number') {
+        throw new Error('Chain config missing required field: id');
+    }
+    if (typeof chain.name !== 'string') {
+        throw new Error('Chain config missing required field: name');
+    }
+    if (!chain.nativeCurrency || typeof chain.nativeCurrency.decimals !== 'number') {
+        throw new Error('Chain config missing required field: nativeCurrency');
+    }
+    if (!chain.rpcUrls?.default?.http?.length) {
+        throw new Error('Chain config missing required field: rpcUrls.default.http');
+    }
+    // Cast is safe after validation - ChainConfig satisfies viem's runtime requirements
+    return chain;
+}
+/**
+ * Pre-configured chain configs for common networks.
+ * Use these instead of importing from viem/chains to avoid type mismatches.
+ */
+export const chains = {
+    gnosis: {
+        id: 100,
+        name: 'Gnosis',
+        nativeCurrency: {
+            name: 'xDAI',
+            symbol: 'xDAI',
+            decimals: 18,
+        },
+        rpcUrls: {
+            default: {
+                http: ['https://rpc.gnosischain.com'],
+            },
+        },
+    },
+    chiado: {
+        id: 10200,
+        name: 'Chiado',
+        nativeCurrency: {
+            name: 'xDAI',
+            symbol: 'xDAI',
+            decimals: 18,
+        },
+        rpcUrls: {
+            default: {
+                http: ['https://rpc.chiadochain.net'],
+            },
+        },
+    },
+    /** Alias for chiado - common testnet naming convention */
+    get gnosisChiado() {
+        return this.chiado;
+    },
+};

package/dist/index.d.ts

@@ -7,6 +7,8 @@
 export type { ContractRunner, BatchRun } from './runner.js';
 export { SafeContractRunner, SafeBatchRun } from './safe-runner.js';
 export { SafeBrowserRunner, SafeBrowserBatchRun } from './safe-browser-runner.js';
+export type { ChainConfig, ChainLike } from './chain-types';
+export { chains, asViemChain } from './chain-types';
 export { RunnerError } from './errors.js';
 export type { RunnerErrorSource } from './errors.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,YAAY,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAG5D,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAGpE,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAGlF,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,YAAY,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,YAAY,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAG5D,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAGpE,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAGlF,YAAY,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAGpD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,YAAY,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC"}