Skip to content

feat: add bitcoin ledger module to UTxO RPC #34

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
scarmuega merged 1 commit into from
May 2, 2025
Merged

feat: add bitcoin ledger module to UTxO RPC #34

Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions pages/_meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
"title": "Ledgers"
},
"cardano": "Cardano Module",
"bitcoin": "Bitcoin Module",
"-- SDK --": {
"type": "separator",
"title": "SDK"
Expand Down
75 changes: 75 additions & 0 deletions pages/bitcoin.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# Bitcoin Module

<a name="bitcoin-v1-Block"></a>

## Block

Represents a block in the Bitcoin blockchain.

| Field | Type | Label | Description |
| --------------- | -------------------------------------- | -------- | ------------------------------------------- |
| version | [uint32](#uint32) | | Block version number |
| prev_block_hash | [bytes](#bytes) | | Hash of the previous block |
| merkle_root | [bytes](#bytes) | | Root hash of the Merkle tree |
| timestamp | [uint32](#uint32) | | Time when the block was created |
| bits | [uint32](#uint32) | | Target difficulty value |
| nonce | [uint32](#uint32) | | Value used for Proof-of-Work |
| transactions | [Transaction](#bitcoin-v1-Transaction) | repeated | List of transactions included in the block |


<a name="bitcoin-v1-Transaction"></a>

## Transaction

Represents a transaction in the Bitcoin network.

| Field | Type | Label | Description |
| ---------- | -------------------------------- | -------- | --------------------------------------------------- |
| version | [uint32](#uint32) | | Transaction version number. Currently 1 |
| inputs | [TxInput](#bitcoin-v1-TxInput) | repeated | List of transaction inputs |
| outputs | [TxOutput](#bitcoin-v1-TxOutput) | repeated | List of transaction outputs |
| locktime | [uint32](#uint32) | | Block height or timestamp when transaction is final |
| hash | [bytes](#bytes) | | |
| block_hash | [bytes](#bytes) | | Transactions reference their block |
| timestamp | [uint32](#uint32) | | |


<a name="bitcoin-v1-TxInput"></a>

## TxInput

Represents an input in a Bitcoin transaction.

| Field | Type | Label | Description |
| ---------- | ----------------- | -------- | ------------------------------------------------------------- |
| tx_id | [bytes](#bytes) | | Hash of the previous transaction output |
| script_sig | [bytes](#bytes) | | Unlocking script for spending the UTXO |
| sequence | [uint32](#uint32) | | Used for relative timelocks |
| coinbase | [bytes](#bytes) | | Coinbase transactions have this instead of txid and scriptSig |
| witnesses | [bytes](#bytes) | repeated | |


<a name="bitcoin-v1-TxOutput"></a>

## TxOutput

Represents an output in a Bitcoin transaction.

| Field | Type | Label | Description |
| -------------- | ---------------------------------------- | ----- | ------------------------------------- |
| value | [uint64](#uint64) | | Amount of Bitcoin in Satoshis |
| script_pub_key | [ScriptPubKey](#bitcoin-v1-ScriptPubKey) | | Locking script defining spendability |


<a name="bitcoin-v1-ScriptPubKey"></a>

## ScriptPubKey

Represents a script pub key in the output.

| Field | Type | Label | Description |
| ----------- | -------------------- | ----- | ------------------------------- |
| asm | [bytes](#bytes) | | Script in human-readable format |
| hex | [bytes](#bytes) | | Script in hexadecimal format |
| script_type | [ScriptType](#bytes) | | Can be ScriptHash, Multsig, etc |

3 changes: 2 additions & 1 deletion pages/introduction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,12 @@ The interface is divided into different modules that represent specific use-case
Modules are blockchain-agnostic, they need to be paired with a specific ledger to be used. A ledger represents a set of primitive structures that are specific to a particular blockchain ecosystem.

<Callout type="info">
So far, the spec focuses only on Cardano. Other UTxO-based blockchains will follow.
So far, the spec focuses on Cardano and Bitcoin. Other UTxO-based blockchains will follow.
</Callout>

<Cards>
<Card title="Cardano Ledger" href="cardano" />
<Card title="Bitcoin Ledger" href="bitcoin" />
</Cards>

## SDKs
Expand Down