update README about action data schema

README.md

@@ -4,11 +4,35 @@
 
 ## Disclaimer
 
-TODO
+This is a Proof-of-Concept demo to show how to use the building packet lock actions in [CoBuild](https://talk.nervos.org/t/ckb-transaction-cobuild-protocol-overview/7702) to collect multisig signatures.
 
 ## Background
 
-TODO
+This PoC utilizes the CoBuild building packet as an intermediate format for enabling collaboration among various tools in the collection of multisig signatures. Currently, it supports ckb-cli and Neuron.
+
+CoBuild enables lock scripts to include their pending actions in the `lock_actions` field of the building packet.
+
+This PoC defines `MultisigAction` to store the mulgisig config and collected signatures.
+
+```
+array PubkeyHash [byte; 20];
+vector PubkeyHashVec <PubkeyHash>;
+table MultisigConfig {
+    require_first_n: byte,
+    threshold: byte,
+    signer_pubkey_hashes: PubkeyHashVec,
+}
+array Signature [byte; 65];
+struct PubkeyHashSignaturePair {
+    pubkey_hash: PubkeyHash,
+    signature: Signature,
+}
+vector PubkeyHashSignaturePairVec <PubkeyHashSignaturePair>;
+table MultisigAction {
+    config: MultisigConfig,
+    signed: PubkeyHashSignaturePairVec,
+}
+```
 
 ## Getting Started
 

src/lib/__snapshots__/multisig-lock-action.test.js.snap

@@ -8,7 +8,7 @@ Object {
 }
 `;
 
-exports[`buildScriptInfo 2`] = `
+exports[`buildScriptInfo 1`] = `
 Object {
   "message_type": "MultisigAction",
   "name": "secp256k1_blake160_multisig_all",

src/lib/multisig-lock-action.test.js

@@ -5,8 +5,9 @@ import { decodeHex } from "@ckb-cobuild/hex-encoding";
 test("buildScriptInfo", () => {
   const { schema, ...remaining } = buildScriptInfo();
 
-  expect(schema).toMatchInlineSnapshot(`
-"array PubkeyHash [byte; 20];
+  expect(schema).toMatch(
+    `
+array PubkeyHash [byte; 20];
 vector PubkeyHashVec <PubkeyHash>;
 table MultisigConfig {
     require_first_n: byte,
@@ -22,8 +23,9 @@ vector PubkeyHashSignaturePairVec <PubkeyHashSignaturePair>;
 table MultisigAction {
     config: MultisigConfig,
     signed: PubkeyHashSignaturePairVec,
-}"
-`);
+}
+    `.trim(),
+  );
   expect(toJson(remaining)).toMatchSnapshot();
 });