Skip to content

Commit

Permalink
doc: polish docs
Browse files Browse the repository at this point in the history
  • Loading branch information
doitian committed Dec 28, 2023
1 parent c5150ed commit af6c532
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 21 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,12 @@

## Disclaimer

- This is a PoC demo to show how to use JoyID and the new witness layout and transaction building process named Cobuild.
- The demo uses a custom lock which has a different CKB address from the JoyID CKB address.
- The [contract](contracts/joyid-cobuild-poc/README.md) has not been audited, USE AT YOUR OWN RISK!
- This is a PoC demo showcasing the management of DAO deposits through the use of a new witness layout and transaction building protocol named **Cobuild**.
- In this demo, JoyID is used to sign transactions. Please note that the CKB address used in this demo is different from the official JoyID CKB address, as a [custom lock][custom-lock] is employed to support the Cobuild witness layout.
- The [custom lock][custom-lock] utilized in this demo has never been audited, USE AT YOUR OWN RISK!
- There's a [preview](https://ckb-dao-cobuild-poc.vercel.app/) deployed to the testnet, have fun.

[custom-lock]: contracts/joyid-cobuild-poc/README.md

## Getting Started

Expand Down
34 changes: 17 additions & 17 deletions src/app/disclaimer.js
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
"use client";

import { useState } from "react";
import { Alert } from "flowbite-react";

export default function Disclaimer() {
const [dismissed, setDismissed] = useState(false);

return dismissed ? null : (
export default function Disclaimer({ config: { ckbChain } }) {
return (
<Alert className="mb-5" color="warning">
<h3 className="not-prose font-medium">Disclamer!</h3>
<p>
This is a PoC demo to show how to use JoyID and the new witness layout
and transaction building process named Cobuild.
</p>
<p>
The demo uses a custom lock which has a different CKB address from the
JoyID CKB address.
</p>
<p>The contract used by this demo has not been audited.</p>
<p>This demo runs in CKB testnet.</p>
<ul>
<li>
This is a PoC demo showcasing the management of DAO deposits through
the use of a new witness layout and transaction building protocol
named <strong>Cobuild</strong>.
</li>
<li>
In this demo, JoyID is used to sign transactions. Please note that the
CKB address used in this demo is different from the official JoyID CKB
address, as a custom lock is employed to support the Cobuild witness
layout.
</li>
<li>The custom lock utilized in this demo has never been audited!</li>
<li>This demo runs in the CKB chain {ckbChain}.</li>
</ul>
</Alert>
);
}
2 changes: 1 addition & 1 deletion src/app/page.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ export default function RootPage({ config }) {
config = config ?? useConfig();
return (
<main>
<Disclaimer />
<Disclaimer config={config} />
<RootHeader config={config} />
</main>
);
Expand Down

0 comments on commit af6c532

Please sign in to comment.