Skip to content
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.

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

docs: update readme #27

Merged
merged 1 commit into from
May 9, 2024
Merged

Conversation

EthanYuan
Copy link
Collaborator

@EthanYuan EthanYuan commented May 9, 2024

Show more information about Cell's structure in the README, such as args and data.

Reference

//
// Cells Data
//

struct SpvInfo {
    tip_client_id: byte,
}

struct TargetAdjustInfo {
    // The `time` of the latest 2016-th header.
    start_time: Uint32,
    // The `nbits` of the next header.
    next_compact_target: Uint32,
}

struct SpvClient {
    id: byte,
    tip_block_hash: Hash,
    headers_mmr_root: HeaderDigest,
    target_adjust_info: TargetAdjustInfo,
}

//
// Script Args
//

struct SpvTypeArgs {
    type_id: Hash,
    clients_count: byte,
    flags: byte,
}

See https://github.com/ckb-cell/ckb-bitcoin-spv/blob/a13477bd12840fc2cd3e606ceea18d52f9c78e9a/verifier/schemas/types.mol#L29C1-L59C2

@EthanYuan EthanYuan requested review from jjyr and Flouse May 9, 2024 03:09
@EthanYuan EthanYuan added this pull request to the merge queue May 9, 2024
Merged via the queue into utxostack:master with commit e298cd0 May 9, 2024
6 checks passed
@EthanYuan EthanYuan deleted the update-readme branch May 9, 2024 06:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants