@rocketh/viem 0.17.4 → 0.17.6

package/README.md

@@ -1 +1,7 @@
 # @rocketh/viem
+
+Viem integration for rocketh, providing viem clients and contract instances for interacting with deployed smart contracts using the viem library.
+
+For full documentation, visit [rocketh.dev](https://rocketh.dev).
+
+For hardhat-deploy documentation, see [rocketh.dev/hardhat-deploy/](https://rocketh.dev/hardhat-deploy/).

package/dist/index.d.ts

@@ -13,7 +13,9 @@ export type ViemHandle = {
     walletClient: WalletClient;
     publicClient: PublicClient;
     getContract<TAbi extends Abi>(name: string | Deployment<TAbi>): ViemContract<TAbi>;
-    getWritableContract<TAbi extends Abi>(name: string | Deployment<TAbi>): ViemWritableContract<TAbi>;
+    getWritableContract<TAbi extends Abi>(name: string | Deployment<TAbi>, options?: {
+        account?: `0x${string}`;
+    }): ViemWritableContract<TAbi>;
 };
 export declare function viem(env: Environment): ViemHandle;
 export {};

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,GAAG,EAAE,UAAU,EAAE,WAAW,EAAC,MAAM,qBAAqB,CAAC;AACtE,OAAO,EAIN,YAAY,EACZ,YAAY,EAEZ,OAAO,EACP,qBAAqB,EACrB,SAAS,EACT,KAAK,EACL,OAAO,EACP,MAAM,EACN,eAAe,EACf,MAAM,MAAM,CAAC;AAId,KAAK,WAAW,CACf,SAAS,SAAS,SAAS,GAAG,SAAS,IAGpC;IACH,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IACjC,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;CAC1C,CAAC;AAEF,KAAK,mBAAmB,CAAC,SAAS,SAAS,SAAS,GAAG,SAAS,IAAI;IACnE,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAAC,IAAI,SAAS,GAAG,IAAI,qBAAqB,CAAC,IAAI,EAAE,WAAW,CAAC,eAAe,CAAC,EAAE,OAAO,CAAC,CAAC;AACxH,MAAM,MAAM,YAAY,CAAC,IAAI,SAAS,GAAG,IAAI,qBAAqB,CAAC,IAAI,EAAE,mBAAmB,CAAC,eAAe,CAAC,EAAE,OAAO,CAAC,CAAC;AAExH,MAAM,MAAM,UAAU,GAAG;IACxB,YAAY,EAAE,YAAY,CAAC;IAC3B,YAAY,EAAE,YAAY,CAAC;IAC3B,WAAW,CAAC,IAAI,SAAS,GAAG,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IACnF,mBAAmB,CAAC,IAAI,SAAS,GAAG,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAC;CACnG,CAAC;AAEF,wBAAgB,IAAI,CAAC,GAAG,EAAE,WAAW,GAAG,UAAU,CA6CjD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,GAAG,EAAE,UAAU,EAAE,WAAW,EAAC,MAAM,qBAAqB,CAAC;AACtE,OAAO,EAIN,YAAY,EACZ,YAAY,EAEZ,OAAO,EACP,qBAAqB,EACrB,SAAS,EACT,KAAK,EACL,OAAO,EACP,MAAM,EACN,eAAe,EACf,MAAM,MAAM,CAAC;AAId,KAAK,WAAW,CACf,SAAS,SAAS,SAAS,GAAG,SAAS,IAGpC;IACH,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IACjC,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;CAC1C,CAAC;AAEF,KAAK,mBAAmB,CAAC,SAAS,SAAS,SAAS,GAAG,SAAS,IAAI;IACnE,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAAC,IAAI,SAAS,GAAG,IAAI,qBAAqB,CAAC,IAAI,EAAE,WAAW,CAAC,eAAe,CAAC,EAAE,OAAO,CAAC,CAAC;AACxH,MAAM,MAAM,YAAY,CAAC,IAAI,SAAS,GAAG,IAAI,qBAAqB,CAAC,IAAI,EAAE,mBAAmB,CAAC,eAAe,CAAC,EAAE,OAAO,CAAC,CAAC;AAExH,MAAM,MAAM,UAAU,GAAG;IACxB,YAAY,EAAE,YAAY,CAAC;IAC3B,YAAY,EAAE,YAAY,CAAC;IAC3B,WAAW,CAAC,IAAI,SAAS,GAAG,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IACnF,mBAAmB,CAAC,IAAI,SAAS,GAAG,EACnC,IAAI,EAAE,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,EAC/B,OAAO,CAAC,EAAE;QACT,OAAO,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;KACxB,GACC,oBAAoB,CAAC,IAAI,CAAC,CAAC;CAC9B,CAAC;AAEF,wBAAgB,IAAI,CAAC,GAAG,EAAE,WAAW,GAAG,UAAU,CA6CjD"}

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,YAAY,CAAC;AAEhC,OAAO,EACN,kBAAkB,EAClB,kBAAkB,EAClB,MAAM,EAGN,WAAW,IAAI,eAAe,GAQ9B,MAAM,MAAM,CAAC;AAEd,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC;AAyBrC,MAAM,UAAU,IAAI,CAAC,GAAgB;IACpC,MAAM,YAAY,GAAG,kBAAkB,CAAC;QACvC,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK;QACxB,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC;KACvC,CAAC,CAAC;IAEH,MAAM,YAAY,GAAG,kBAAkB,CAAC;QACvC,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK;QACxB,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC;KACvC,CAAC,CAAC;IAEH,OAAO;QACN,YAAY;QACZ,YAAY;QACZ,mBAAmB,CAClB,IAA+B,EAC/B,OAEC;YAED,MAAM,UAAU,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAO,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YACzE,IAAI,oBAAoB,GAA4B,YAAY,CAAC;YACjE,IAAI,OAAO,EAAE,OAAO,EAAE,CAAC;gBACtB,oBAAoB,GAAG,kBAAkB,CAAC;oBACzC,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK;oBACxB,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC;oBACvC,OAAO,EAAE,OAAO,CAAC,OAAO;iBACxB,CAAC,CAAC;YACJ,CAAC;YACD,MAAM,QAAQ,GAAG,eAAe,CAAC;gBAChC,OAAO,EAAE,UAAU,CAAC,OAAO;gBAC3B,GAAG,EAAE,UAAU,CAAC,GAAG;gBACnB,MAAM,EAAE,EAAC,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,oBAAoB,EAAC;aAC5D,CAA+B,CAAC;YACjC,OAAO,QAAQ,CAAC;QACjB,CAAC;QACD,WAAW,CAAmB,IAA+B;YAC5D,MAAM,UAAU,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAO,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YACzE,OAAO,eAAe,CAAC;gBACtB,OAAO,EAAE,UAAU,CAAC,OAAO;gBAC3B,GAAG,EAAE,UAAU,CAAC,GAAG;gBACnB,MAAM,EAAE,EAAC,MAAM,EAAE,YAAY,EAAC;aAC9B,CAAuB,CAAC;QAC1B,CAAC;KACD,CAAC;AACH,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,YAAY,CAAC;AAEhC,OAAO,EACN,kBAAkB,EAClB,kBAAkB,EAClB,MAAM,EAGN,WAAW,IAAI,eAAe,GAQ9B,MAAM,MAAM,CAAC;AAEd,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC;AA8BrC,MAAM,UAAU,IAAI,CAAC,GAAgB;IACpC,MAAM,YAAY,GAAG,kBAAkB,CAAC;QACvC,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK;QACxB,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC;KACvC,CAAC,CAAC;IAEH,MAAM,YAAY,GAAG,kBAAkB,CAAC;QACvC,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK;QACxB,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC;KACvC,CAAC,CAAC;IAEH,OAAO;QACN,YAAY;QACZ,YAAY;QACZ,mBAAmB,CAClB,IAA+B,EAC/B,OAEC;YAED,MAAM,UAAU,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAO,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YACzE,IAAI,oBAAoB,GAA4B,YAAY,CAAC;YACjE,IAAI,OAAO,EAAE,OAAO,EAAE,CAAC;gBACtB,oBAAoB,GAAG,kBAAkB,CAAC;oBACzC,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK;oBACxB,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC;oBACvC,OAAO,EAAE,OAAO,CAAC,OAAO;iBACxB,CAAC,CAAC;YACJ,CAAC;YACD,MAAM,QAAQ,GAAG,eAAe,CAAC;gBAChC,OAAO,EAAE,UAAU,CAAC,OAAO;gBAC3B,GAAG,EAAE,UAAU,CAAC,GAAG;gBACnB,MAAM,EAAE,EAAC,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,oBAAoB,EAAC;aAC5D,CAA+B,CAAC;YACjC,OAAO,QAAQ,CAAC;QACjB,CAAC;QACD,WAAW,CAAmB,IAA+B;YAC5D,MAAM,UAAU,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAO,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YACzE,OAAO,eAAe,CAAC;gBACtB,OAAO,EAAE,UAAU,CAAC,OAAO;gBAC3B,GAAG,EAAE,UAAU,CAAC,GAAG;gBACnB,MAAM,EAAE,EAAC,MAAM,EAAE,YAAY,EAAC;aAC9B,CAAuB,CAAC;QAC1B,CAAC;KACD,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rocketh/viem",
-  "version": "0.17.4",
+  "version": "0.17.6",
   "description": "provide viem functionality for rocketh",
   "publishConfig": {
     "access": "public"
@@ -18,19 +18,20 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "src"
   ],
   "dependencies": {
     "abitype": "^1.2.3",
     "eip-1193": "^0.6.5",
     "named-logs": "^0.4.1",
-    "@rocketh/core": "0.17.7"
+    "@rocketh/core": "0.17.9"
   },
   "devDependencies": {
-    "as-soon": "^0.0.11",
+    "as-soon": "^0.1.4",
     "rimraf": "^6.1.2",
     "typescript": "^5.9.3",
-    "viem": "^2.44.1"
+    "viem": "^2.44.4"
   },
   "peerDependencies": {
     "viem": "^2.41.2"

package/src/index.ts

@@ -0,0 +1,94 @@
+import {logs} from 'named-logs';
+import type {Abi, Deployment, Environment} from '@rocketh/core/types';
+import {
+	createPublicClient,
+	createWalletClient,
+	custom,
+	PublicClient,
+	WalletClient,
+	getContract as getViemContract,
+	Address,
+	GetContractReturnType,
+	Transport,
+	Chain,
+	Account,
+	Client,
+	CustomTransport,
+} from 'viem';
+
+const logger = logs('@rocketh/viem');
+
+type KeyedClient<
+	transport extends Transport = Transport,
+	// chain extends Chain | undefined = Chain | undefined,
+	// account extends Account | undefined = Account | undefined
+> = {
+	public: Client<transport, Chain>;
+	wallet: Client<transport, Chain, Account>;
+};
+
+type ReadonlyKeyedClient<transport extends Transport = Transport> = {
+	public: Client<transport, Chain>;
+};
+
+export type ViemWritableContract<TAbi extends Abi> = GetContractReturnType<TAbi, KeyedClient<CustomTransport>, Address>;
+export type ViemContract<TAbi extends Abi> = GetContractReturnType<TAbi, ReadonlyKeyedClient<CustomTransport>, Address>;
+
+export type ViemHandle = {
+	walletClient: WalletClient;
+	publicClient: PublicClient;
+	getContract<TAbi extends Abi>(name: string | Deployment<TAbi>): ViemContract<TAbi>;
+	getWritableContract<TAbi extends Abi>(
+		name: string | Deployment<TAbi>,
+		options?: {
+			account?: `0x${string}`;
+		},
+	): ViemWritableContract<TAbi>;
+};
+
+export function viem(env: Environment): ViemHandle {
+	const walletClient = createWalletClient({
+		chain: env.network.chain,
+		transport: custom(env.network.provider),
+	});
+
+	const publicClient = createPublicClient({
+		chain: env.network.chain,
+		transport: custom(env.network.provider),
+	});
+
+	return {
+		walletClient,
+		publicClient,
+		getWritableContract<TAbi extends Abi>(
+			name: string | Deployment<TAbi>,
+			options?: {
+				account?: `0x${string}`;
+			},
+		) {
+			const deployment = typeof name === 'string' ? env.get<TAbi>(name) : name;
+			let contractWalletClient: WalletClient<Transport> = walletClient;
+			if (options?.account) {
+				contractWalletClient = createWalletClient({
+					chain: env.network.chain,
+					transport: custom(env.network.provider),
+					account: options.account,
+				});
+			}
+			const contract = getViemContract({
+				address: deployment.address,
+				abi: deployment.abi,
+				client: {public: publicClient, wallet: contractWalletClient},
+			}) as ViemWritableContract<TAbi>;
+			return contract;
+		},
+		getContract<TAbi extends Abi>(name: string | Deployment<TAbi>) {
+			const deployment = typeof name === 'string' ? env.get<TAbi>(name) : name;
+			return getViemContract({
+				address: deployment.address,
+				abi: deployment.abi,
+				client: {public: publicClient},
+			}) as ViemContract<TAbi>;
+		},
+	};
+}