Conversation
Here we declare the `ByteOrder` enum that is meant to capture all the details related to Bitcoin byte order and the `CompactSizeUint` type that holds the details about the Bitcoin CompactSize Unsigned Integer.
This type is meant to represent a 32-byte Bitcoin hash widely used as identifier in the Bitcoin protocol.
Here we define `bitcoin.Transaction` and all its related types that capture all the details related with Bitcoin transactions.
Here we define the representation of the Bitcoin block header that will be used for SPV purposes.
Here we declare a minimal interface required to interact with the Bitcoin chain.
This type is supposed to establish the package structure for the Bitcoin chain implementations using ElectrumX as example.
tomaszslabon
previously approved these changes
Oct 27, 2022
Contributor
nkuba
reviewed
Oct 27, 2022
|
|
||
| // CompactSizeUint is a documentation type that is supposed to capture the | ||
| // details of the Bitcoin's CompactSize Unsigned Integer as described in: | ||
| // https://developer.bitcoin.org/reference/transactions.html#compactsize-unsigned-integers |
Member
There was a problem hiding this comment.
Could we extract some information from the linked docs and put it here? For example, we could copy the table clarifying the types.
Value | Bytes | Format
---------------------------------------------------------------------------------------
>= 0 && <= 252 | 1 | uint8
>= 253 && <= 0xffff | 3 | 0xfd followed by the number as uint16
>= 0x10000 && <= 0xffffffff | 5 | 0xfe followed by the number as uint32
>= 0x100000000 && <= 0xffffffffffffffff | 9 | 0xff followed by the number as uint64
| // use cases related with the protocol logic and cryptography. Byte arrays | ||
| // using this byte order should be converted to numbers according to | ||
| // the little-endian sequence. | ||
| InternalByteOrder = iota |
Member
There was a problem hiding this comment.
Shouldn't this enum reference the ByteOrder type?
Suggested change
| InternalByteOrder = iota | |
| InternalByteOrder ByteOrder = iota |
| // byte order that is typically used by the third party services like | ||
| // block explorers or Bitcoin chain clients. Byte arrays using this byte | ||
| // order should be converted to numbers according to the big-endian | ||
| // sequence. |
Member
There was a problem hiding this comment.
In Bitcoin docs, this type is named RPC Byte Order. Can we mention that in the comment?
| // Bits determines the target threshold this block's header hash must be | ||
| // less than or equal to. | ||
| Bits uint32 | ||
| // Nonce is the nonce used to generate the block. |
Member
There was a problem hiding this comment.
Suggested change
| // Nonce is the nonce used to generate the block. | |
| // Nonce is an arbitrary number miners change to modify the header hash | |
| // in order to produce a hash less than or equal to the target threshold. |
| // MerkleRootHash is a hash derived from the hashes of all transactions | ||
| // included in this block. | ||
| MerkleRootHash Hash | ||
| // Time is a Unix epoch time when the block was created. |
Member
There was a problem hiding this comment.
Suggested change
| // Time is a Unix epoch time when the block was created. | |
| // Time is a Unix epoch time when the miner started hashing the header. |
nkuba
approved these changes
Oct 31, 2022
tomaszslabon
approved these changes
Oct 31, 2022
nkuba
reviewed
Oct 31, 2022
| // GetBlockHeader gets the block header for the given block number. If the | ||
| // block with the given number was not found on the chain, this function | ||
| // returns an error. | ||
| GetBlockHeader(blockNumber uint) (*BlockHeader, error) |
Member
There was a problem hiding this comment.
Wouldn't it be more accurate to accept block hash as the input parameter here?
https://github.com/blockstream/esplora/blob/master/API.md#get-blockhashheader
Member
Author
There was a problem hiding this comment.
Based on experiences gathered during the development of the tBTC v2 Typescript library, getting the block by number will have more use cases than getting it by hash (not sure if we have at least one case of the latter at the moment). If we need to fetch by hash, we will just add another method to the bitcoin.Chain interface.
3 tasks
nkuba
reviewed
Nov 3, 2022
Comment on lines
+23
to
+25
| // GetCurrentBlockNumber gets the number of the current block. If the | ||
| // current block was not determined, this function returns an error. | ||
| GetCurrentBlockNumber() (uint, error) |
Member
There was a problem hiding this comment.
@lukasz-zimnoch should it return the latest mined (confirmed) block or the block that is currently being mined?
Member
There was a problem hiding this comment.
To be more precise maybe we could name this function GetLatestBlockHeight?
tomaszslabon
added a commit
that referenced
this pull request
Dec 9, 2022
This PR implements Bitcoin package integration with [Electrum API](https://electrumx-spesmilo.readthedocs.io/en/latest/protocol.html). There are a couple of servers implementations supporting the Electrum API: - [ElectrumX](https://github.com/spesmilo/electrumx) - [Esplora - Electrs by Blockstream](https://github.com/Blockstream/electrs) - [Fulcrum](https://github.com/cculianu/Fulcrum) A list of publicly exposed Electrum protocol servers for Bitcoin can be found here: - mainnet: https://1209k.com/bitcoin-eye/ele.php?chain=btc - testnet: https://1209k.com/bitcoin-eye/ele.php?chain=tbtc We added integration tests to verify the implementation works correctly with the most popular server implementations. To run the integration tests execute: ``` go test -v -tags=integration ./... ``` There are a couple of TODOs in the code regarding the improvements that will be handled in follow-up PRs. Refs #3384 Refs #3369 Refs #3395
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Refs: #3349
Here we introduce the new
pkg/bitcoinpackage that defines some basic Bitcoin types and interfaces required to work with the Bitcoin chain. This package is meant to reflect the part of the Bitcoin protocol to an extent required by the client applications. Thepkg/bitcoinpackage is supposed to hold components specific to the Bitcoin domain and must remain free of application-specific items. Third-party helper libraries (likebtcd) are allowed for use within this package though no external type should leak outside. Preserving those rules will allow us to achieve a clean package structure with proper dependencies. The exact types introduced by this pull request are:bitcoin.ByteOrder: An enum that captures all the caveats related to the byte order used across the Bitcoin ecosystembitcoin.CompactSizeUint: A documentation type that holds the details about the CompactSize Unsigned Integerbitcoin.Hash: A type that represents a 32-byte Bitcoin hash widely used as identifier in the Bitcoin protocolbitcoin.Transaction& related: A type that represents a Bitcoin transaction and related types to reflect the internalsbitcoin.BlockHeader: A representation of the Bitcoin block header that will be used for SPV purposesbitcoin.Chain: A minimal interface required to interact with the Bitcoin chainelectrum.Client: An example stub implementation of thebitcoin.Chainsupposed to establish a package structure for Bitcoin interfaces implementations