@chipi-stack/chipi-react 14.7.0 → 14.9.0

package/README.md

@@ -58,9 +58,50 @@ function Wallet() {
 - **In-app token transfer UIs** — send and receive USDC with a few lines of React
 - **Connect-with-passkey flows** — biometric wallet login without seed phrases
 - **DeFi dashboards and loyalty/rewards redemption interfaces** — display balances, history, and reward claims
+- **Multisig treasury governance** — propose/approve/execute any contract action with N-of-M approvals (see `/multisig` below)
 
 Have an idea? [Tell us what you want to build](https://github.com/chipi-pay/build-with-chipi/issues/new)
 
+## Multisig governance (`@chipi-stack/chipi-react/multisig`)
+
+> Tree-shakeable subpath for SHHH multisig: propose any contract action (or a vote), collect N-of-M approvals, execute. Experimental — the API may change.
+
+Describe your actions once as typed templates, then drive them with hooks. The hooks are auth- and chain-agnostic: you pass a `MultisigTransport` (your coordination backend) and a `MultisigSigner` (per-owner OE signer), and own the UI.
+
+```tsx
+import {
+  defineActions, voteTemplate, u256, toFelt,
+  useProposeAction, useTreasuryProposals,
+  type MultisigTransport, type MultisigSigner,
+} from "@chipi-stack/chipi-react/multisig";
+
+// 1. Register your action templates (vote ships built-in).
+const ACTIONS = defineActions([
+  voteTemplate({ governanceContract: "0x…" }),
+  {
+    key: "stake",
+    label: "Stake",
+    fields: [{ name: "amount", label: "Amount", type: "amount", decimals: 18 }],
+    toCalls: (v) => [{ to: "0x…", entrypoint: "stake", calldata: u256(v.amount) }],
+    title: (v) => `Stake ${v.amount}`,
+  },
+]);
+
+// 2. Propose → approve → execute (you supply transport + signer).
+function Governance({ walletAddress, transport, signer }: {
+  walletAddress: string; transport: MultisigTransport; signer: MultisigSigner;
+}) {
+  const propose = useProposeAction({
+    walletAddress, transport, signer,
+    getRequiredApprovals: async () => 2, // read your wallet's threshold
+  });
+  const { proposals, approve, execute } = useTreasuryProposals({ walletAddress, transport, signer });
+  // render your own UI on top of these
+}
+```
+
+The pure pieces — `defineActions`, `voteTemplate`, the `toFelt`/`u256`/`amountToBase` encoders, and the OE core (`buildActionProposal`/`signActionApproval`/`assembleActionExecuteCalldata`) — have no React or network dependency, so templates and calldata are unit-testable in isolation.
+
 ## Documentation
 
 Full docs at [docs.chipipay.com](https://docs.chipipay.com)