Skip to content

Commit 8823785

Browse files
committed
Update Subcoin.md
- Removed sending test transactions as it does not make sense in Subcoin. - Added Bitcoin Transaction Broadcasting deliverable in M3. - Updated some crate names based on the latest development.
1 parent 38ad1b2 commit 8823785

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

applications/Subcoin.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This project aims to develop a prototype of a Bitcoin full node in Rust using th
1212

1313
**Relevance to Substrate & Polkadot**
1414

15-
This project showcases the versatility of Substrate as a leading blockchain development framework. With Substrate, small teams and even individuals can create production-level blockchain software efficiently. Developers within the Substrate/Polkadot ecosystem, particularly those interested in Bitcoin-related applications, stand to benefit from the tools and insights produced by this project.
15+
This project showcases the versatility of Substrate as a leading blockchain development framework. With Substrate, small teams and even individuals can create production-level blockchain software efficiently. Developers within the Substrate/Polkadot ecosystem, particularly those interested in Bitcoin-related applications, stand to benefit from the tools and insights produced by this project. Specifically, the Bitcoin bridge projects can integrate the subcoin-network into their nodes to talk to the Bitcoin network directly instead of relying on the external relayers which are suffered from the single point of failure practically.
1616

1717
**Motivation**
1818

@@ -25,10 +25,10 @@ I’m personally planning on some ideas on Bitcoin. This project may be a good s
2525
**Key Deliverables**
2626

2727
- crate `pallet-bitcoin`: This crate implements the core logic of Bitcoin protocol, handling the transaction processing and UTXO set management.
28-
- crate `runtime`: A lean Bitcoin specialized Substrate runtime integrating only two pallets frame-system and pallet-bitcoin.
28+
- crate `subcoin-runtime`: A lean Bitcoin specialized Substrate runtime integrating only two pallets frame-system and pallet-bitcoin.
2929
- crate `sc-consensus-nakamoto`: This crate offers an import queue for Bitcoin block import and full block verification.
30-
- crate `bitcoin-network`: This crate is responsible for basic Bitcoin P2P network functionalities, facilitating initial block download from other nodes.
31-
- crate `node`: This crate orchestrates the integration of all components mentioned above, providing a binary `subcoin` for running a fully functional Bitcoin node.
30+
- crate `subcoin-network`: This crate is responsible for basic Bitcoin P2P network functionalities, facilitating initial block download from other nodes.
31+
- crate `subcoin-node`: This crate orchestrates the integration of all components mentioned above, providing a binary `subcoin` for running a fully functional Bitcoin node.
3232

3333
**Non-Goals**
3434

@@ -93,13 +93,13 @@ This project is planned as 3 milestones, completed in three months.
9393
| Number | Deliverable | Specification |
9494
| --- | --- | --- |
9595
| 0a. | License | MIT |
96-
| 0b. | Documentation | We will provide both inline documentation of the code and a basic tutorial that explains how a user can (for example) spin up one of our Substrate nodes and send test transactions, which will show how the new functionality works. |
96+
| 0b. | Documentation | We will provide both inline documentation of the code and a basic tutorial that explains how a user can (for example) spin up one of our Substrate nodes, which will show how the new functionality works. |
9797
| 0c. | Testing and Testing Guide | Core functions will be fully covered by comprehensive unit tests to ensure functionality and robustness. In the guide, we will describe how to run these tests. |
9898
| 0d. | Docker | We will provide a Dockerfile(s) that can be used to test all the functionality delivered with this milestone. |
9999
| 1. | `pallet-bitcoin` | This pallet is used to process the Bitcoin transaction and manage the state of the UTXO set. |
100-
| 2. | `bitcoin-runtime` | This is a minimal Substrate runtime specialized for Bitcoin, consisting of frame-system and pallet-bitcoin. |
101-
| 3. | `sc-consensus-nakamoto` | This crate provides the function of importing a Bitcoin block BitcoinBlockImport into the node, assuming the block has been checked. |
102-
| 4. | `node` | This crate will wire up the runtime and a Substate client with necessary components to build a Bitcoin node, which is able to import the Bitcoin blocks from the bitcoind database. |
100+
| 2. | `subcoin-runtime` | This is a minimal Substrate runtime specialized for Bitcoin, consisting of frame-system and pallet-bitcoin. |
101+
| 3. | `sc-consensus-nakamoto` | This crate provides the function of importing Bitcoin blocks into the node, assuming the blocks have been checked. |
102+
| 4. | `subcoin-node` | This crate will wire up the runtime and a Substate client with necessary components to build a Bitcoin node, which is able to import the Bitcoin blocks from the bitcoind database. |
103103

104104
### Milestone 2
105105

@@ -125,12 +125,12 @@ This project is planned as 3 milestones, completed in three months.
125125
| Number | Deliverable | Specification |
126126
| --- | --- | --- |
127127
| 0a. | License | MIT |
128-
| 0b. | Documentation | We will provide both inline documentation of the code and a basic tutorial that explains how a user can (for example) spin up one of our Substrate nodes and send test transactions, which will show how the new functionality works. |
128+
| 0b. | Documentation | We will provide both inline documentation of the code and a basic tutorial that explains how a user can (for example) spin up one of our Substrate nodes, which will show how the new functionality works. |
129129
| 0c. | Testing and Testing Guide | Core functions will be fully covered by comprehensive unit tests to ensure functionality and robustness. In the guide, we will describe how to run these tests. |
130130
| 0d. | Docker | We will provide a Dockerfile(s) that can be used to test all the functionality delivered with this milestone. |
131131
| 0e. | Article | We will publish an article that explains what was done/achieved as part of the grant. |
132-
| 1. | Fast sync | A bootstrap node will be run so that the new subcoin nodes can sync to the tip of the Bitcoin network very quickly using the built-in advanced syncing strategy (e.g., light state sync) in Substrate. |
133-
| 2 | `bitcoin-rpc` | We will introduce an initial version of RPC layer compatible with Bitcore Core based on available functions (primarily the blockchain command group) and CLI exposing the same RPC interfaces. |
132+
| 1. | Fast sync | A bootstrap node will be deployed so that the new subcoin nodes can sync to the tip of the Bitcoin network very quickly using the built-in advanced syncing strategy (e.g., light state sync) in Substrate. |
133+
| 2 | Bitcoin Transaction Broadcasting | We will add an RPC call for broadcasting a Bitcoin transaction to the Bitcoin network from polkadot.js.org. |
134134

135135
## Future Plans
136136

0 commit comments

Comments
 (0)