feat(connect): add wallet interface docs

Author: mrcnk

apps/docs/package.json

@@ -5,7 +5,8 @@
 	"scripts": {
 		"dev": "bunx vocs dev",
 		"build": "bunx vocs build",
-		"preview": "bunx vocs preview"
+		"preview": "bunx vocs preview",
+		"cleanup": "rimraf dist .turbo node_modules"
 	},
 	"dependencies": {
 		"@theguild/remark-mermaid": "^0.1.2",

apps/docs/src/pages/connect/wallet-interface.mdx

@@ -0,0 +1,103 @@
+# Wallet Interface [Make your zkApp compatible with Mina wallets.]
+
+To make your zkApp compatible with Mina wallets, we've created a strongly typed interface for `window.mina` and injected providers found by [Provider Discovery](/connect/provider-discovery).
+
+## Queries
+
+### mina_accounts
+
+```ts twoslash
+import { createStore } from '@mina-js/connect'
+
+const store = createStore()
+const { provider } = store.getProviders()[0]
+const { result } = await provider.request<'mina_accounts'>({ method: 'mina_accounts' })
+```
+
+### mina_chainId
+
+```ts twoslash
+import { createStore } from '@mina-js/connect'
+
+const store = createStore()
+const { provider } = store.getProviders()[0]
+const { result } = await provider.request<'mina_chainId'>({ method: 'mina_chainId' })
+```
+
+### mina_getBalance
+
+```ts twoslash
+import { createStore } from '@mina-js/connect'
+
+const store = createStore()
+const { provider } = store.getProviders()[0]
+const { result } = await provider.request<'mina_getBalance'>({ method: 'mina_getBalance' })
+```
+
+### mina_chainInformation
+
+```ts twoslash
+import { createStore } from '@mina-js/connect'
+
+const store = createStore()
+const { provider } = store.getProviders()[0]
+const { result } = await provider.request<'mina_chainInformation'>({ method: 'mina_chainInformation' })
+```
+
+## Commands
+
+### mina_sign
+
+```ts twoslash
+import { createStore } from '@mina-js/connect'
+
+const store = createStore()
+const { provider } = store.getProviders()[0]
+const { result } = await provider.request<'mina_sign'>({ method: 'mina_sign', params: ['My message'] })
+```
+
+### mina_signTransaction
+
+```ts twoslash
+import { createStore } from '@mina-js/connect'
+
+const store = createStore()
+const { provider } = store.getProviders()[0]
+const { result } = await provider.request<'mina_signTransaction'>({
+  method: 'mina_signTransaction',
+  params: [{
+    // You should probably get the right nonce from Klesia for that.
+  	nonce: 1n,
+  	from: "B62qmWKtvNQTtUqo1LxfEEDLyWMg59cp6U7c4uDC7aqgaCEijSc3Hx5",
+  	to: "B62qmWKtvNQTtUqo1LxfEEDLyWMg59cp6U7c4uDC7aqgaCEijSc3Hx5",
+  	amount: 3000000000n,
+  	fee: 100000000n,
+  }]
+})
+```
+
+### mina_signFields
+
+```ts twoslash
+import { createStore } from '@mina-js/connect'
+
+const store = createStore()
+const { provider } = store.getProviders()[0]
+const { result } = await provider.request<'mina_signFields'>({
+  method: 'mina_signFields',
+  params: [[1n, 2n, 3n]]
+})
+```
+
+### mina_createNullifier
+
+```ts twoslash
+import { createStore } from '@mina-js/connect'
+
+const store = createStore()
+const { provider } = store.getProviders()[0]
+const { result } = await provider.request<'mina_createNullifier'>({
+  method: 'mina_createNullifier',
+  params: [[1n, 2n, 3n]]
+})
+```

apps/docs/vocs.config.ts

@@ -86,6 +86,7 @@ export default defineConfig({
 				{ text: "Introduction", link: "/connect" },
 				{ text: "Getting Started", link: "/connect/getting-started" },
 				{ text: "Provider Discovery", link: "/connect/provider-discovery" },
+				{ text: "Wallet Interface", link: "/connect/wallet-interface" },
 			],
 		},
 		{

apps/klesia/package.json

@@ -15,7 +15,8 @@
 		"build": "tsup-node",
 		"dev": "tsup-node --watch --onSuccess \"node dist/server.js\"",
 		"start": "node dist/server.js",
-		"test": "bun test"
+		"test": "bun test",
+		"cleanup": "rimraf dist .turbo node_modules"
 	},
 	"dependencies": {
 		"@hono/node-server": "^1.12.2",

bun.lockb

@@ -4,7 +4,7 @@
 	"scripts": {
 		"build": "turbo build",
 		"test": "turbo test",
-		"cleanup": "bun run --filter '*' cleanup",
+		"cleanup": "bun run --filter '*' cleanup && rimraf node_modules .turbo",
 		"lint": "bunx biome check .",
 		"format": "bunx biome check . --write --unsafe"
 	},

package.json

@@ -25,7 +25,8 @@
 		"@scure/base": "^1.1.8",
 		"@scure/bip32": "1.4.0",
 		"@scure/bip39": "1.3.0",
-		"mina-signer": "3.0.7"
+		"mina-signer": "3.0.7",
+		"zod": "^3.23.8"
 	},
 	"peerDependencies": {
 		"typescript": "^5.0.0"

packages/accounts/package.json

@@ -1,12 +1,19 @@
 import type {
-	CreateNullifier,
+	Nullifier,
 	PublicKey,
-	SignFields,
-	SignMessage,
-	SignTransaction,
+	SignedFields,
+	SignedMessage,
+	SignedTransaction,
 } from "@mina-js/shared";
 import type { HDKey } from "@scure/bip32";
 import type { Simplify } from "type-fest";
+import type { z } from "zod";
+import type {
+	CreateNullifierParamsSchema,
+	SignFieldsParamsSchema,
+	SignMessageParamsSchema,
+	SignTransactionParamsSchema,
+} from "./validation";
 
 export enum MinaKeyConst {
 	PURPOSE = 44,
@@ -63,3 +70,23 @@ export type HDAccount = Simplify<
 export type PrivateKeyAccount = Simplify<LocalAccount<"privateKey">>;
 
 export type { HDKey };
+
+/**
+ * Parameter types
+ */
+export type SignFieldsParams = z.infer<typeof SignFieldsParamsSchema>;
+export type SignMessageParams = z.infer<typeof SignMessageParamsSchema>;
+export type CreateNullifierParams = z.infer<typeof CreateNullifierParamsSchema>;
+export type SignTransactionParams = z.infer<typeof SignTransactionParamsSchema>;
+
+/**
+ * Signer methods
+ */
+export type SignFields = (params: SignFieldsParams) => Promise<SignedFields>;
+export type SignMessage = (params: SignMessageParams) => Promise<SignedMessage>;
+export type CreateNullifier = (
+	params: CreateNullifierParams,
+) => Promise<Nullifier>;
+export type SignTransaction = (
+	params: SignTransactionParams,
+) => Promise<SignedTransaction>;

packages/accounts/src/types.ts

@@ -0,0 +1,26 @@
+import { FieldSchema, TransactionPayload } from "@mina-js/shared";
+import { z } from "zod";
+
+export const SignFieldsParamsSchema = z
+	.object({
+		fields: z.array(FieldSchema),
+	})
+	.strict();
+
+export const SignMessageParamsSchema = z
+	.object({
+		message: z.string(),
+	})
+	.strict();
+
+export const CreateNullifierParamsSchema = z
+	.object({
+		message: z.array(FieldSchema),
+	})
+	.strict();
+
+export const SignTransactionParamsSchema = z
+	.object({
+		transaction: TransactionPayload,
+	})
+	.strict();

packages/accounts/src/validation.ts

@@ -1,14 +1,16 @@
 import type { z } from "zod";
 import type {
-	MinaProviderDetailSchema,
 	MinaProviderInfoSchema,
 	ProviderListenerSchema,
-	ProviderRequestParamsSchema,
+	ProviderRequestParamsUnion,
 	ProviderRpcErrorSchema,
 	ResultType,
 } from "./validation";
 
-export type MinaProviderDetail = z.infer<typeof MinaProviderDetailSchema>;
+export type MinaProviderDetail = {
+	info: MinaProviderInfo;
+	provider: MinaProviderClient;
+};
 
 export type MinaProviderInfo = z.infer<typeof MinaProviderInfoSchema>;
 
@@ -32,11 +34,12 @@ export type ProviderRpcEvent =
 
 export type ProviderListener = z.infer<typeof ProviderListenerSchema>;
 
+export type ProviderRequestParams = z.infer<typeof ProviderRequestParamsUnion>;
+
 export type MinaProviderRequest = <M extends string>(
-	args: Extract<M, z.infer<typeof ProviderRequestParamsSchema>>,
+	args: Extract<ProviderRequestParams, { method: M }>,
 ) => Promise<ResultType<M>>;
 
-// export type MinaProviderClient = z.infer<typeof MinaProviderClientSchema>;
 export type MinaProviderClient = {
 	request: MinaProviderRequest;
 	on: ProviderListener;