b871286f98
This refactors the script engine to store and step through raw scripts
by making using of the new zero-allocation script tokenizer as opposed
to the less efficient method of storing and stepping through parsed
opcodes. It also improves several aspects while refactoring such as
optimizing the disassembly trace, showing all scripts in the trace in
the case of execution failure, and providing additional comments
describing the purpose of each field in the engine.
It should be noted that this is a step towards removing the parsed
opcode struct and associated supporting code altogether, however, in
order to ease the review process, this retains the struct and all
function signatures for opcode execution which make use of an individual
parsed opcode. Those will be updated in future commits.
The following is an overview of the changes:
- Modify internal engine scripts slice to use raw scripts instead of
parsed opcodes
- Introduce a tokenizer to the engine to track the current script
- Remove no longer needed script offset parameter from the engine since
that is tracked by the tokenizer
- Add an opcode index counter for disassembly purposes to the engine
- Update check for valid program counter to only consider the script
index
- Update tests for bad program counter accordingly
- Rework the NewEngine function
- Store the raw scripts
- Setup the initial tokenizer
- Explicitly check against version 0 instead of DefaultScriptVersion
which would break consensus if changed
- Check the scripts parse according to version 0 semantics to retain
current consensus rules
- Improve comments throughout
- Rework the Step function
- Use the tokenizer and raw scripts
- Create a parsed opcode on the fly for now to retain existing
opcode execution function signatures
- Improve comments throughout
- Update the Execute function
- Explicitly check against version 0 instead of DefaultScriptVersion
which would break consensus if changed
- Improve the disassembly tracing in the case of error
- Update the CheckErrorCondition function
- Modify clean stack error message to make sense in all cases
- Improve the comments
- Update the DisasmPC and DisasmScript functions on the engine
- Use the tokenizer
- Optimize construction via the use of strings.Builder
- Modify the subScript function to return the raw script bytes since the
parsed opcodes are no longer stored
- Update the various signature checking opcodes to use the raw opcode
data removal and signature hash calculation functions since the
subscript is now a raw script
- opcodeCheckSig
- opcodeCheckMultiSig
- opcodeCheckSigAlt
|
||
|---|---|---|
| .github/workflows | ||
| addrmgr | ||
| blockchain | ||
| btcec | ||
| btcjson | ||
| chaincfg | ||
| cmd | ||
| connmgr | ||
| database | ||
| docs | ||
| integration | ||
| limits | ||
| mempool | ||
| mining | ||
| netsync | ||
| peer | ||
| release | ||
| rpcclient | ||
| txscript | ||
| wire | ||
| .gitignore | ||
| btcd.go | ||
| CHANGES | ||
| config.go | ||
| config_test.go | ||
| doc.go | ||
| Dockerfile | ||
| go.mod | ||
| go.sum | ||
| goclean.sh | ||
| LICENSE | ||
| log.go | ||
| params.go | ||
| README.md | ||
| rpcadapters.go | ||
| rpcserver.go | ||
| rpcserverhelp.go | ||
| rpcserverhelp_test.go | ||
| rpcwebsocket.go | ||
| sample-btcd.conf | ||
| server.go | ||
| service_windows.go | ||
| signal.go | ||
| signalsigterm.go | ||
| upgrade.go | ||
| upnp.go | ||
| version.go | ||
btcd
btcd is an alternative full node bitcoin implementation written in Go (golang).
This project is currently under active development and is in a Beta state. It is extremely stable and has been in production use since October 2013.
It properly downloads, validates, and serves the block chain using the exact rules (including consensus bugs) for block acceptance as Bitcoin Core. We have taken great care to avoid btcd causing a fork to the block chain. It includes a full block validation testing framework which contains all of the 'official' block acceptance tests (and some additional ones) that is run on every pull request to help ensure it properly follows consensus. Also, it passes all of the JSON test data in the Bitcoin Core code.
It also properly relays newly mined blocks, maintains a transaction pool, and relays individual transactions that have not yet made it into a block. It ensures all individual transactions admitted to the pool follow the rules required by the block chain and also includes more strict checks which filter transactions based on miner requirements ("standard" transactions).
One key difference between btcd and Bitcoin Core is that btcd does NOT include wallet functionality and this was a very intentional design decision. See the blog entry here for more details. This means you can't actually make or receive payments directly with btcd. That functionality is provided by the btcwallet and Paymetheus (Windows-only) projects which are both under active development.
Requirements
Go 1.16 or newer.
Installation
https://github.com/btcsuite/btcd/releases
Linux/BSD/MacOSX/POSIX - Build from Source
-
Install Go according to the installation instructions here: http://golang.org/doc/install
-
Ensure Go was installed properly and is a supported version:
$ go version
$ go env GOROOT GOPATH
NOTE: The GOROOT and GOPATH above must not be the same path. It is
recommended that GOPATH is set to a directory in your home directory such as
~/goprojects to avoid write permission issues. It is also recommended to add
$GOPATH/bin to your PATH at this point.
- Run the following commands to obtain btcd, all dependencies, and install it:
$ cd $GOPATH/src/github.com/btcsuite/btcd
$ GO111MODULE=on go install -v . ./cmd/...
- btcd (and utilities) will now be installed in
$GOPATH/bin. If you did not already add the bin directory to your system path during Go installation, we recommend you do so now.
Updating
Linux/BSD/MacOSX/POSIX - Build from Source
- Run the following commands to update btcd, all dependencies, and install it:
$ cd $GOPATH/src/github.com/btcsuite/btcd
$ git pull
$ GO111MODULE=on go install -v . ./cmd/...
Getting Started
btcd has several configuration options available to tweak how it runs, but all of the basic operations described in the intro section work with zero configuration.
Linux/BSD/POSIX/Source
$ ./btcd
IRC
- irc.libera.chat
- channel #btcd
- webchat
Issue Tracker
The integrated github issue tracker is used for this project.
Documentation
The documentation is a work-in-progress. It is located in the docs folder.
Release Verification
Please see our documentation on the current build/verification process for all our releases for information on how to verify the integrity of published releases using our reproducible build system.
License
btcd is licensed under the copyfree ISC License.