Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion babel.config.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
presets: [require.resolve("@docusaurus/core/lib/babel/preset")],
};
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Subcoin introduces an innovative approach to encapsulating the Bitcoin chain wit

**Subcoin runtime**

Subcoin runtime is a minimalistic Substrate runtime, comprising two essential pallets:
Subcoin runtime is a minimalistic Substrate runtime, comprising two essential pallets:

- **frame-system**: This pallet is the core component of the Substrate framework.
- **pallet-bitcoin**: This pallet tracks the state of the UTXO set on-chain. It processes the inputs and outputs of each Bitcoin transaction embedded in an unsigned extrinsic within the pallet.
Expand Down Expand Up @@ -122,17 +122,11 @@ The Proof of Concept implementation has been developed, but several optimization
## Future Vision

- **Bitcoin Wallet Integration in polkadot.js.org**

A significant future goal is to enable [polkadot.js.org](http://polkadot.js.org/) to support Bitcoin transactions, effectively turning it into a fully functional Bitcoin wallet. This ambitious enhancement would require deep integration of Bitcoin into the Substrate framework, including adjustments to the runtime, the creation of a custom transaction pool, and likely modifications to the [polkadot.js.org](http://polkadot.js.org/) interface.

A significant future goal is to enable [polkadot.js.org](http://polkadot.js.org/) to support Bitcoin transactions, effectively turning it into a fully functional Bitcoin wallet. This ambitious enhancement would require deep integration of Bitcoin into the Substrate framework, including adjustments to the runtime, the creation of a custom transaction pool, and likely modifications to the [polkadot.js.org](http://polkadot.js.org/) interface.
- **Develop a BRC20 Indexer**

Expanding Subcoin to include a BRC20 indexer is a straightforward extension that can be implemented during the Bitcoin full sync process. This addition would enhance the decentralization of BRC20 assets, contributing to a more robust and accessible Bitcoin ecosystem.

Expanding Subcoin to include a BRC20 indexer is a straightforward extension that can be implemented during the Bitcoin full sync process. This addition would enhance the decentralization of BRC20 assets, contributing to a more robust and accessible Bitcoin ecosystem.
- **Explore Bitcoin Layer 2 Solutions**

The Subcoin team's initial goal was not to build a Bitcoin node in Rust but to explore Bitcoin L2 solutions. With the recent surge in Bitcoin L2 projects, the Subcoin team is still actively seeking innovative ways to enhance the Bitcoin ecosystem, going beyond just creating a Rust client.

The Subcoin team's initial goal was not to build a Bitcoin node in Rust but to explore Bitcoin L2 solutions. With the recent surge in Bitcoin L2 projects, the Subcoin team is still actively seeking innovative ways to enhance the Bitcoin ecosystem, going beyond just creating a Rust client.

These ideas represent just the beginning. As Subcoin matures and grows, more possibilities will emerge.

Expand Down
11 changes: 6 additions & 5 deletions docs/basics/download-UTXO-snapshot.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,13 @@ TODO: public bootnodes

- Snapshot integrity:

The expected `sha256sum` for the snapshot at block 840000 is:
The expected `sha256sum` for the snapshot at block 840000 is:

```text
dc4bb43d58d6a25e91eae93eb052d72e3318bd98ec62a5d0c11817cefbba177b
```
This checksum matches the one documented in the official [Bitcoin Core pull request](https://github.com/bitcoin/bitcoin/pull/28553#issue-1920247340).
```text
dc4bb43d58d6a25e91eae93eb052d72e3318bd98ec62a5d0c11817cefbba177b
```

This checksum matches the one documented in the official [Bitcoin Core pull request](https://github.com/bitcoin/bitcoin/pull/28553#issue-1920247340).

## Verify the Downloaded Snapshot

Expand Down
13 changes: 6 additions & 7 deletions docs/basics/set-up-a-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,9 @@ This guide will show you how to connect to Bitcoin network with Subcoin.
- **Full Node**: A full node prunes historical states, all finalized blocks' states older than a configurable number except the genesis block's state will be pruned. This is 256 blocks from the last finalized one by default. A pruned node this way requires much less space than an archive node.
- **Light Node**: TODO


### Sync Strategies

There are two strategies to sync the Bitcoin network for new nodes: _Full Sync_ and _Fast Sync_.
There are two strategies to sync the Bitcoin network for new nodes: _Full Sync_ and _Fast Sync_.

- **Full Sync**: This will download and replay all the blocks from the genesis to the tip directly from the P2P network (either the Subcoin network or directly from the Bitcoin P2P network). This sync strategy is only necessary for establishing the Subcoin bootnodes when the Subcoin P2P network starts as this process is time-consuming and resources-intensive, possibly taking days to complete depending on the performance of your machine. For the regular users, _Fast Sync_ is usually recommended.

Expand All @@ -30,9 +29,9 @@ There are two strategies to sync the Bitcoin network for new nodes: _Full Sync_
```mermaid
graph TD
%% Define nodes
subcoin_p2p((Subcoin P2P Network)) ---> |Fast Sync|subcoin_node[Subcoin Node]
subcoin_p2p ---> |Full Sync|subcoin_node[Subcoin Node]
bitcoin_p2p((Bitcoin P2P Network)) ---> |Full Sync|subcoin_node
subcoin_p2p((Subcoin P2P Network)) ---> |Fast Sync|subcoin_node[Subcoin Node]
subcoin_p2p ---> |Full Sync|subcoin_node[Subcoin Node]
bitcoin_p2p((Bitcoin P2P Network)) ---> |Full Sync|subcoin_node

%% Add labels for syncing methods

Expand All @@ -56,9 +55,9 @@ Although it's technically supported to perform a full sync from the Subcoin p2p
Note that the storage usage will grow over time.

- Full Node
- SSD with 500GiB of space
- SSD with 500GiB of space
- Archive Node
- SSD with 4TiB of space
- SSD with 4TiB of space

## Syncing Bitcoin Chain

Expand Down
2 changes: 1 addition & 1 deletion docs/extras/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
"position": 3,
"link": {
"type": "generated-index",
"slug": "extras",
"slug": "extras"
}
}
2 changes: 1 addition & 1 deletion docs/extras/manage-docs-versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export default {
items: [
// highlight-start
{
type: 'docsVersionDropdown',
type: "docsVersionDropdown",
},
// highlight-end
],
Expand Down
Loading
Loading