Skip to content

Commit e298cd0

Browse files
authored
Merge pull request #27 from EthanYuan/update-readme
docs: update readme
2 parents b9bfcc6 + 661ce1a commit e298cd0

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

contracts/ckb-bitcoin-spv-type-lock/README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
12
# CKB Bitcoin SPV Type Lock
23

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

2021
This cell is used to store the Bitcoin state.
2122

22-
Each Bitcoin SPV instance should contain at least 1 client cell.
23+
Each Bitcoin SPV instance should contain at least 3 client cells.
24+
25+
```yaml
26+
Client Cell:
27+
Type Script:
28+
code hash: "..."
29+
hash type: "type"
30+
args: "typeid + clients count + flags"
31+
Data:
32+
- id
33+
- btc tip block hash
34+
- btc headers mmr root
35+
- target adjust info
36+
```
2337
2438
- Info Cell
2539
@@ -28,6 +42,16 @@ There are 2 kinds of cells in a Bitcoin SPV instance:
2842
2943
Each Bitcoin SPV instance should contain only 1 info cell.
3044
45+
```yaml
46+
Info Cell:
47+
Type Script:
48+
code hash: "..."
49+
hash type: "type"
50+
args: "typeid + clients count + flags"
51+
Data:
52+
- tip client cell id
53+
```
54+
3155
### Operations
3256
3357
There are 4 kinds of operations:

0 commit comments

Comments
 (0)