Skip to content

docs: update readme #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 9, 2024
Merged

docs: update readme #27

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion contracts/ckb-bitcoin-spv-type-lock/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

# CKB Bitcoin SPV Type Lock

A type script for Bitcoin SPV clients which synchronize [Bitcoin] state into [CKB].
Expand All @@ -19,7 +20,20 @@ There are 2 kinds of cells in a Bitcoin SPV instance:

This cell is used to store the Bitcoin state.

Each Bitcoin SPV instance should contain at least 1 client cell.
Each Bitcoin SPV instance should contain at least 3 client cells.

```yaml
Client Cell:
Type Script:
code hash: "..."
hash type: "type"
args: "typeid + clients count + flags"
Data:
- id
- btc tip block hash
- btc headers mmr root
- target adjust info
```

- Info Cell

Expand All @@ -28,6 +42,16 @@ There are 2 kinds of cells in a Bitcoin SPV instance:

Each Bitcoin SPV instance should contain only 1 info cell.

```yaml
Info Cell:
Type Script:
code hash: "..."
hash type: "type"
args: "typeid + clients count + flags"
Data:
- tip client cell id
```

### Operations

There are 4 kinds of operations:
Expand Down
Loading