Skip to content

Commit 70c54aa

Browse files
committed
add file links in review guide
1 parent c7aaacb commit 70c54aa

File tree

2 files changed

+15
-13
lines changed

2 files changed

+15
-13
lines changed

docs/poc-review-guide.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,19 +28,21 @@ The general workflow to build transactions in Cobuild:
2828

2929
The core is the step 2. There will be a framework to handle 1, 3, 4, 5, I just build a minimal framework to make the PoC work.
3030

31-
1. `src/lib/cobuild/types.js`: Cobuild data structures definition.
32-
2. `src/lib/papps/dao`: DAO papp
31+
This guide is based on the version [v0.0.1](https://github.com/cryptape/ckb-dao-cobuild-poc/tree/v0.0.1).
32+
33+
1. [`src/lib/cobuild/types.js`](../src/lib/cobuild/types.js): Cobuild data structures definition.
34+
2. [`src/lib/papps/dao`](../src/lib/papps/dao): DAO papp
3335
- a.
34-
- `src/lib/papps/dao/schema.js`: Action.data schema
35-
- `src/lib/papps/dao/action-creators.js`: Functions to create Action.data for DAO.
36-
- b. `src/lib/papps/dao/lumos-callbacks.js`: Build transactions based on DAO message actions.
37-
3. `src/lib/cobuild/fee-manager.js`: See the function `payFee` and `storeWitnessForFeeEstimation`
38-
4. `src/lib/cobuild/lock-actions.js`: See the function `prepareLockActions`.
39-
- a/b. `src/lib/cobuild/general-lock-actions.js`: See the function `prepareLockActionWithWitnessStore`
40-
- c. `src/lib/wallet/selector.js` acts as a gateway to connect different wallets and create signatures.
41-
- c. `src/lib/cobuild/general-lock-actions.js`: See the function `applyLockAction`
42-
5. `src/app/u/[wallet]/[connection]/submit-building-packet.js`: a simple UI to send tx and query its status.
36+
- [`src/lib/papps/dao/schema.js`](../src/lib/papps/dao/schema.js): Action.data schema
37+
- [`src/lib/papps/dao/action-creators.js`](../src/lib/papps/dao/action-creators.js): Functions to create Action.data for DAO.
38+
- b. [`src/lib/papps/dao/lumos-callbacks.js`](../src/lib/papps/dao/lumos-callbacks.js): Build transactions based on DAO message actions.
39+
3. [`src/lib/cobuild/fee-manager.js`](../src/lib/cobuild/fee-manager.js): See the function [`payFee`](https://github.com/cryptape/ckb-dao-cobuild-poc/blob/v0.0.1/src/lib/cobuild/fee-manager.js#L9) and [`storeWitnessForFeeEstimation`](https://github.com/cryptape/ckb-dao-cobuild-poc/blob/c7aaacbcf4a2a9c90674e7d732b58b800cb94fe4/src/lib/cobuild/fee-manager.js#L46)
40+
4. [`src/lib/cobuild/lock-actions.js`](../src/lib/cobuild/lock-actions.js): See the function [`prepareLockActions`](https://github.com/cryptape/ckb-dao-cobuild-poc/blob/c7aaacbcf4a2a9c90674e7d732b58b800cb94fe4/src/lib/cobuild/lock-actions.js#L12).
41+
- a/b. [`src/lib/cobuild/general-lock-actions.js`](../src/lib/cobuild/general-lock-actions.js): See the function [`prepareLockActionWithWitnessStore`](https://github.com/cryptape/ckb-dao-cobuild-poc/blob/c7aaacbcf4a2a9c90674e7d732b58b800cb94fe4/src/lib/cobuild/general-lock-actions.js#L25)
42+
- c. [`src/lib/wallet/selector.js`](../src/lib/wallet/selector.js) acts as a gateway to connect different wallets and create signatures.
43+
- c. [`src/lib/cobuild/general-lock-actions.js`](../src/lib/cobuild/general-lock-actions.js): See the function [`applyLockAction`](https://github.com/cryptape/ckb-dao-cobuild-poc/blob/c7aaacbcf4a2a9c90674e7d732b58b800cb94fe4/src/lib/cobuild/general-lock-actions.js#L84)
44+
5. [`src/app/u/[wallet]/[connection]/submit-building-packet.js`](../src/app/u/%5Bwallet%5D/%5Bconnection%5D/submit-building-packet.js): a simple UI to send tx and query its status.
4345

4446
Remarks:
4547

46-
- `src/lib/cobuild/react/building-packet-review.js`: UI to review the building packet for signing.
48+
- [`src/lib/cobuild/react/building-packet-review.js`](https://github.com/cryptape/ckb-dao-cobuild-poc/blob/v0.0.1/src/lib/cobuild/react/building-packet-review.js): UI to review the building packet for signing.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "ckb-dao-cobuild-poc",
33
"type": "module",
4-
"version": "0.1.0",
4+
"version": "0.0.1",
55
"private": true,
66
"scripts": {
77
"dev": "next dev",

0 commit comments

Comments
 (0)