mirror of
https://github.com/btcsuite/btcd.git
synced 2024-11-19 01:40:07 +01:00
Conver mediawiki to markdown for consistency
Dave Collins
parent
3a790cb65b
commit
96ffe15b69
133
Home.md
Normal file
133
Home.md
Normal file
@ -0,0 +1,133 @@
|
||||
### Table of Contents
|
||||
1. [About](#About)
|
||||
2. [Getting Started](#GettingStarted)
|
||||
1. [Installation](#Installation)
|
||||
1. [Windows](#WindowsInstallation)
|
||||
2. [Linux/BSD/MacOSX/POSIX](#PosixInstallation)
|
||||
2. [Configuration](#Configuration)
|
||||
3. [Controlling and Querying btcd via btcctl](#BtcctlConfig)
|
||||
3. [Help](#Help)
|
||||
1. [Startup](#Startup)
|
||||
1. [Using bootstrap.data](#BootstrapDat)
|
||||
2. [Network Configuration](#NetworkConfig)
|
||||
3. [Wallet](#Wallet)
|
||||
4. [Contact](#Contact)
|
||||
1. [IRC](#ContactIRC)
|
||||
2. [Mailing Lists](#MailingLists)
|
||||
5. [Developer Resources](#DeveloperResources)
|
||||
1. [Code Contribution Guidelines](#ContributionGuidelines)
|
||||
2. [JSON-RPC Reference](#JSONRPCReference)
|
||||
3. [Websocket JSON-RPC Reference](#WebsocketReference)
|
||||
3. [Conformal Bitcoin-related Go Packages](#GoPackages)
|
||||
|
||||
<a name="About" />
|
||||
### 1. About
|
||||
btcd is a full node bitcoin implementation written in [Go](http://golang.org), licensed under the [copyfree](http://www.copyfree.org) ISC License.
|
||||
|
||||
This project is currently under active development and is in an Alpha state.
|
||||
|
||||
It currently properly downloads, validates, and serves the block chain using the exact rules (including bugs) for block acceptance as the reference implementation, [bitcoind](https://github.com/bitcoin/bitcoin). We have taken great care to avoid btcd causing a fork to the block chain. It passes all of the '[official](https://github.com/TheBlueMatt/test-scripts/)' block acceptance tests.
|
||||
|
||||
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 into the block chain and also includes the vast majority of the more strict checks which filter transactions based on miner requirements ("standard" transactions).
|
||||
|
||||
One key difference between btcd and bitcoind is that btcd does NOT include wallet functionality and this was a very intentional design decision. See the [blog entry](https://blog.conformal.com/btcd-not-your-moms-bitcoin-daemon) for more details. This means you can't actually make or receive payments directly with btcd. That functionality is provided by the [btcwallet](https://github.com/conformal/btcwallet) and [btcgui](https://github.com/conformal/btcgui) projects which are both under active development.
|
||||
|
||||
<a name="GettingStarted" />
|
||||
### 2. Getting Started
|
||||
|
||||
<a name="Installation" />
|
||||
**2.1 Installation**<br />
|
||||
|
||||
<a name="WindowsInstallation" />
|
||||
**2.1.1 Windows Installation**<br />
|
||||
|
||||
* Install the MSI available at: https://github.com/conformal/btcd/releases
|
||||
* Launch btcd from the Start Menu
|
||||
|
||||
<a name="PosixInstallation" />
|
||||
**2.1.2 Linux/BSD/MacOSX/POSIX Installation**<br />
|
||||
|
||||
* Install Go according to the installation instructions here: http://golang.org/doc/install
|
||||
* Run the following command to obtain btcd, its dependencies, and install it: `$ go get github.com/conformal/btcd/...`<br />
|
||||
* To upgrade, run the following command: `$ go get -u github.com/conformal/btcd/...`
|
||||
* Run btcd: `$ btcd`
|
||||
|
||||
<a name="Configuration" />
|
||||
**2.2 Configuration**<br />
|
||||
|
||||
btcd has a number of [configuration](http://godoc.org/github.com/conformal/btcd) options, which can be viewed by running: `$ btcd --help`.
|
||||
|
||||
<a name="BtcctlConfig" />
|
||||
**2.3 Controlling and Querying btcd via btcctl**<br />
|
||||
|
||||
btcctl is a command line utility that can be used to both control and query btcd via [http://www.wikipedia.org/wiki/Remote_procedure_call RPC].
|
||||
btcd does <strong>not</strong> enable its RPC server by default; You must configure at minimum both an RPC username and password:
|
||||
|
||||
* btcd.conf configuration file
|
||||
```
|
||||
[Application Options]
|
||||
rpcuser=myuser
|
||||
rpcpass=SomeDecentp4ssw0rd
|
||||
```
|
||||
* btcctl.conf configuration file
|
||||
```
|
||||
[Application Options]
|
||||
rpcuser=myuser
|
||||
rpcpass=SomeDecentp4ssw0rd
|
||||
```
|
||||
For a list of available options, run: `$ btcctl --help`
|
||||
|
||||
<a name="Help" />
|
||||
### 3. Help
|
||||
|
||||
<a name="Startup" />
|
||||
**3.1 Startup**<br />
|
||||
|
||||
<a name="BootstrapDat" />
|
||||
**3.1.1 bootstrap.dat**<br />
|
||||
* [Using bootstrap.dat](https://github.com/conformal/btcd/wiki/Using-bootstrap.dat)
|
||||
|
||||
<a name="NetworkConfig" />
|
||||
**3.1.2 Network Configuration**<br />
|
||||
* [What Ports Are Used by Default?](https://github.com/conformal/btcd/wiki/What-Ports-Are-Used-by-Default%3F)
|
||||
* [How To Listen on Specific Interfaces](https://github.com/conformal/btcd/wiki/How-To-Listen-on-Specific-Interfaces)
|
||||
* [Configuring btcd with Tor](https://github.com/conformal/btcd/wiki/Configuring-Tor)
|
||||
|
||||
<a name="Wallet" />
|
||||
**3.1 Wallet**<br />
|
||||
|
||||
btcd was intentionally developed without an integrated wallet for security reasons. Please see [btcwallet](https://github.com/conformal/btcwallet) for more information.
|
||||
|
||||
<a name="Contact" />
|
||||
### 4. Contact
|
||||
|
||||
<a name="ContactIRC" />
|
||||
**4.1 IRC**<br />
|
||||
* [irc.conformal.com](irc://irc.conformal.com:+6697), port 6697, tls, channel #btcd
|
||||
|
||||
<a name="MailingLists" />
|
||||
**4.2 Mailing Lists**<br />
|
||||
* <a href="mailto:btcd+subscribe@opensource.conformal.com">btcd</a>: discussion of btcd and its packages.
|
||||
* <a href="mailto:btcd-commits+subscribe@opensource.conformal.com">btcd-commits</a>: readonly mail-out of source code changes.
|
||||
|
||||
<a name="DeveloperResources" />
|
||||
### 5. Developer Resources
|
||||
|
||||
<a name="ContributionGuidelines" />
|
||||
* [Code Contribution Guidelines](https://github.com/conformal/btcd/wiki/Code-Contribution-Guidelines)
|
||||
<a name="JSONRPCReference" />
|
||||
* [JSON-RPC Reference](https://github.com/conformal/btcd/wiki/JSON-RPC-API Standard)
|
||||
* [Examples](https://github.com/conformal/btcd/wiki/JSON-RPC-API#ExampleGoApp RPC)
|
||||
<a name="WebsocketReference" />
|
||||
* [Websocket JSON-RPC Reference](https://github.com/conformal/btcd/wiki/Websocket-JSON-RPC-API)
|
||||
* [Websocket RPC Examples](https://github.com/conformal/btcd/wiki/Websocket-JSON-RPC-API#ExampleGoApplications)
|
||||
<a name="GoPackages" />
|
||||
* Conformal Bitcoin-related Go Packages:
|
||||
* [btcjson](https://github.com/conformal/btcjson) - Provides an extensive API for controlling and communicating with the client using JSON-RPC calls
|
||||
* [btcws](https://github.com/conformal/btcws) - Custom types for btcd websocket extension commands (registers the extension commands with [btcjson](https://github.com/conformal/btcjson))
|
||||
* [btcwire](https://github.com/conformal/btcwire) - Implements the bitcoin wire protocol
|
||||
* [btcchain](https://github.com/conformal/btcchain) - Implements Bitcoin block handling and chain selection rules
|
||||
* [btcscript](https://github.com/conformal/btcscript) - Implements the Bitcoin transaction scripting language
|
||||
* [btcec](https://github.com/conformal/btcec) - Implements support for the elliptic curve cryptographic functions needed for the Bitcoin scripts
|
||||
* [btcdb](https://github.com/conformal/btcdb) - Provides a database interface for the Bitcoin block chain
|
||||
* [btcutil](https://github.com/conformal/btcutil) - Provides Bitcoin-specific convenience functions and types
|
||||
@ -1,91 +0,0 @@
|
||||
== About ==
|
||||
<p align="justify">
|
||||
btcd is a full node bitcoin implementation written in [http://golang.org Go], licensed under the [http://www.copyfree.org copyfree] ISC License.
|
||||
</p>
|
||||
<p align="justify">
|
||||
This project is currently under active development and is in an Alpha state.
|
||||
</p>
|
||||
<p align="justify">
|
||||
It currently properly downloads, validates, and serves the block chain using the exact rules (including bugs) for block acceptance as the reference implementation, [https://github.com/bitcoin/bitcoin bitcoind]. We have taken great care to avoid btcd causing a fork to the block chain. It passes all of the '[https://github.com/TheBlueMatt/test-scripts/ official]' block acceptance tests.
|
||||
</p>
|
||||
<p align="justify">
|
||||
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 into the block chain and also includes the vast majority of the more strict checks which filter transactions based on miner requirements ("standard" transactions).
|
||||
</p>
|
||||
<p align="justify">
|
||||
One key difference between btcd and bitcoind is that btcd does NOT include wallet functionality and this was a very intentional design decision. See the [https://blog.conformal.com/btcd-not-your-moms-bitcoin-daemon blog entry] for more details. This means you can't actually make or receive payments directly with btcd. That functionality is provided by the [https://github.com/conformal/btcwallet btcwallet] and [https://github.com/conformal/btcgui btcgui] projects which are both under active development.
|
||||
</p>
|
||||
==Getting Started==
|
||||
===Installation===
|
||||
|
||||
====Windows====
|
||||
|
||||
# Install the MSI available at: https://github.com/conformal/btcd/releases
|
||||
# Launch btcd from the Start Menu
|
||||
|
||||
====Linux/BSD/MacOSX/POSIX====
|
||||
|
||||
# Install Go according to the installation instructions here: http://golang.org/doc/install
|
||||
# Run the following command to obtain btcd, its dependencies, and install it: <pre>$ go get github.com/conformal/btcd/...</pre>
|
||||
## To upgrade, run the following command: <pre>$ go get -u github.com/conformal/btcd/...</pre>
|
||||
# Run btcd: <pre>$ btcd</pre>
|
||||
|
||||
===Configuration===
|
||||
|
||||
btcd has a number of [http://godoc.org/github.com/conformal/btcd configuration] options, which can be viewed by running: <pre>$ btcd --help</pre>.
|
||||
|
||||
===Controlling and querying btcd via btcctl===
|
||||
|
||||
btcctl is a command line utility that can be used to both control and query btcd via [http://www.wikipedia.org/wiki/Remote_procedure_call RPC].
|
||||
btcd does <strong>not</strong> enable its RPC server by default; You must configure at minimum both an RPC username and password:
|
||||
|
||||
* btcd.conf configuration file
|
||||
<pre>
|
||||
[Application Options]
|
||||
rpcuser=myuser
|
||||
rpcpass=SomeDecentp4ssw0rd
|
||||
</pre>
|
||||
|
||||
* btcctl.conf configuration file
|
||||
<pre>
|
||||
[Application Options]
|
||||
rpcuser=myuser
|
||||
rpcpass=SomeDecentp4ssw0rd
|
||||
</pre>
|
||||
|
||||
For a list of available options, run: <pre>$ btcctl --help</pre>
|
||||
|
||||
==Help==
|
||||
===Startup===
|
||||
====Bootstrap.dat====
|
||||
*[https://github.com/conformal/btcd/wiki/Using-bootstrap.dat Using bootstrap.dat]
|
||||
|
||||
===Network Configuration===
|
||||
*[https://github.com/conformal/btcd/wiki/What-Ports-Are-Used-by-Default%3F What Ports Are Used by Default?]
|
||||
*[https://github.com/conformal/btcd/wiki/How-To-Listen-on-Specific-Interfaces How To Listen on Specific Interfaces]
|
||||
*[https://github.com/conformal/btcd/wiki/Configuring-Tor Configuring btcd with Tor]
|
||||
|
||||
===Wallet===
|
||||
btcd was intentionally developed without an integrated wallet for security reasons. Please see [https://github.com/conformal/btcwallet btcwallet] for more information.
|
||||
|
||||
==Contact==
|
||||
===IRC===
|
||||
*[irc://irc.conformal.com:+6697 irc.conformal.com], port 6697, tls, channel #btcd
|
||||
===Mailing Lists===
|
||||
*<a href="mailto:btcd+subscribe@opensource.conformal.com">btcd</a>: discussion of btcd and its packages.
|
||||
*<a href="mailto:btcd-commits+subscribe@opensource.conformal.com">btcd-commits</a>: readonly mail-out of source code changes.
|
||||
|
||||
==Developer Resources==
|
||||
*[https://github.com/conformal/btcd/wiki/Code-Contribution-Guidelines Code Contribution Guidelines]
|
||||
*[https://github.com/conformal/btcd/wiki/JSON-RPC-API Standard JSON-RPC Reference]
|
||||
**[https://github.com/conformal/btcd/wiki/JSON-RPC-API#ExampleGoApp RPC Examples]
|
||||
*[https://github.com/conformal/btcd/wiki/Websocket-JSON-RPC-API Websocket JSON-RPC Reference]
|
||||
**[https://github.com/conformal/btcd/wiki/Websocket-JSON-RPC-API#ExampleGoApplications Websocket RPC Examples]
|
||||
*Conformal Bitcoin-related Go Packages:
|
||||
**[https://github.com/conformal/btcjson btcjson] - Provides an extensive API for controlling and communicating with the client using JSON-RPC calls
|
||||
**[https://github.com/conformal/btcws btcws] - Custom types for btcd websocket extension commands (registers the extension commands with [https://github.com/conformal/btcjson btcjson])
|
||||
**[https://github.com/conformal/btcwire btcwire] - Implements the bitcoin wire protocol and is a core package from btcd
|
||||
**[https://github.com/conformal/btcchain btcchain] - Implements Bitcoin block handling and chain selection rules
|
||||
**[https://github.com/conformal/btcscript btcscript] - Implements the Bitcoin transaction scripting language
|
||||
**[https://github.com/conformal/btcec btcec] - Implements support for the elliptic curve cryptographic functions needed for the Bitcoin scripts
|
||||
**[https://github.com/conformal/btcdb btcdb] - Provides a database interface for the Bitcoin block chain
|
||||
**[https://github.com/conformal/btcutil btcutil] - Provides Bitcoin-specific convenience functions and types
|
||||
Loading…
Reference in New Issue
Block a user