diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/README_osx.txt | 4 | ||||
| -rw-r--r-- | doc/REST-interface.md | 19 | ||||
| -rw-r--r-- | doc/bips.md | 2 | ||||
| -rw-r--r-- | doc/build-osx.md | 2 | ||||
| -rw-r--r-- | doc/build-unix.md | 6 | ||||
| -rw-r--r-- | doc/developer-notes.md | 6 | ||||
| -rw-r--r-- | doc/dnsseed-policy.md | 13 | ||||
| -rw-r--r-- | doc/gitian-building.md | 10 | ||||
| -rw-r--r-- | doc/init.md | 2 | ||||
| -rw-r--r-- | doc/release-process.md | 2 | ||||
| -rw-r--r-- | doc/translation_process.md | 4 |
11 files changed, 44 insertions, 26 deletions
diff --git a/doc/README_osx.txt b/doc/README_osx.txt index 6c0c21c190..e8af46e0e4 100644 --- a/doc/README_osx.txt +++ b/doc/README_osx.txt @@ -1,6 +1,6 @@ Deterministic OSX Dmg Notes. -Working OSX DMG's are created in Linux by combining a recent clang, +Working OSX DMGs are created in Linux by combining a recent clang, the Apple's binutils (ld, ar, etc), and DMG authoring tools. Apple uses clang extensively for development and has upstreamed the necessary @@ -58,7 +58,7 @@ libdmg-hfsplus project is used to compress it. There are several bugs in this tool and its maintainer has seemingly abandoned the project. It has been forked and is available (with fixes) here: https://github.com/theuni/libdmg-hfsplus . -The 'dmg' tool has the ability to create DMG's from scratch as well, but this +The 'dmg' tool has the ability to create DMGs from scratch as well, but this functionality is broken. Only the compression feature is currently used. Ideally, the creation could be fixed and genisoimage would no longer be necessary. diff --git a/doc/REST-interface.md b/doc/REST-interface.md index f14aed7287..11af040ad2 100644 --- a/doc/REST-interface.md +++ b/doc/REST-interface.md @@ -5,6 +5,8 @@ The REST API can be enabled with the `-rest` option. Supported API ------------- + +####Transactions `GET /rest/tx/TX-HASH.{bin|hex|json}` Given a transaction hash, @@ -12,6 +14,7 @@ Returns a transaction, in binary, hex-encoded binary or JSON formats. For full TX query capability, one must enable the transaction index via "txindex=1" command line / configuration option. +####Blocks `GET /rest/block/BLOCK-HASH.{bin|hex|json}` `GET /rest/block/notxdetails/BLOCK-HASH.{bin|hex|json}` @@ -22,6 +25,15 @@ The HTTP request and response are both handled entirely in-memory, thus making m With the /notxdetails/ option JSON response will only contain the transaction hash instead of the complete transaction details. The option only affects the JSON response. +####Blockheaders +`GET /rest/headers/<COUNT>/<BLOCK-HASH>.<bin|hex>` + +Given a block hash, +Returns <COUNT> amount of blockheaders in upward direction. + +JSON is not supported. + +####Chaininfos `GET /rest/chaininfo.json` Returns various state info regarding block chain processing. @@ -34,6 +46,13 @@ Only supports JSON as output format. * verificationprogress : (numeric) estimate of verification progress [0..1] * chainwork : (string) total amount of work in active chain, in hexadecimal +`GET /rest/getutxos` + +The getutxo command allows querying of the UTXO set given a set of of outpoints. +See BIP64 for input and output serialisation: +https://github.com/bitcoin/bips/blob/master/bip-0064.mediawiki + + Risks ------------- Running a webbrowser on the same node with a REST enabled bitcoind can be a risk. Accessing prepared XSS websites could read out tx/block data of your node by placing links like `<script src="http://127.0.0.1:8332/rest/tx/1234567890.json">` which might break the nodes privacy. diff --git a/doc/bips.md b/doc/bips.md index 579eadfff3..90e98ed419 100644 --- a/doc/bips.md +++ b/doc/bips.md @@ -11,7 +11,7 @@ BIPs that are implemented by Bitcoin Core (up-to-date up to **v0.10.0**): * [`BIP 31`](https://github.com/bitcoin/bips/blob/master/bip-0031.mediawiki): The 'pong' protocol message (and the protocol version bump to 60001) has been implemented since **v0.6.1** ([PR #1081](https://github.com/bitcoin/bitcoin/pull/1081)). * [`BIP 34`](https://github.com/bitcoin/bips/blob/master/bip-0034.mediawiki): The rule that requires blocks to contain their height (number) in the coinbase input, and the introduction of version 2 blocks has been implemented since **v0.7.0**. The rule took effect for version 2 blocks as of *block 224413* (March 5th 2013), and version 1 blocks are no longer allowed since *block 227931* (March 25th 2013) ([PR #1526](https://github.com/bitcoin/bitcoin/pull/1526)). * [`BIP 35`](https://github.com/bitcoin/bips/blob/master/bip-0035.mediawiki): The 'mempool' protocol message (and the protocol version bump to 60002) has been implemented since **v0.7.0** ([PR #1641](https://github.com/bitcoin/bitcoin/pull/1641)). -* [`BIP 37`](https://github.com/bitcoin/bips/blob/master/bip-0037.mediawiki): The bloom filtering for transaction relaying, partial merkle trees for blocks , and the protocol version bump to 70001 (enabling low-bandwidth SPV clients) has been implemented since **v0.8.0** ([PR #1795](https://github.com/bitcoin/bitcoin/pull/1795)). +* [`BIP 37`](https://github.com/bitcoin/bips/blob/master/bip-0037.mediawiki): The bloom filtering for transaction relaying, partial merkle trees for blocks, and the protocol version bump to 70001 (enabling low-bandwidth SPV clients) has been implemented since **v0.8.0** ([PR #1795](https://github.com/bitcoin/bitcoin/pull/1795)). * [`BIP 42`](https://github.com/bitcoin/bips/blob/master/bip-0042.mediawiki): The bug that would have caused the subsidy schedule to resume after block 13440000 was fixed in **v0.9.2** ([PR #3842](https://github.com/bitcoin/bitcoin/pull/3842)). * [`BIP 61`](https://github.com/bitcoin/bips/blob/master/bip-0061.mediawiki): The 'reject' protocol message (and the protocol version bump to 70002) was added in **v0.9.0** ([PR #3185](https://github.com/bitcoin/bitcoin/pull/3185)). * [`BIP 66`](https://github.com/bitcoin/bips/blob/master/bip-0066.mediawiki): The strict DER rules and associated version 3 blocks have been implemented since **v0.10.0** ([PR #5713](https://github.com/bitcoin/bitcoin/pull/5713)). diff --git a/doc/build-osx.md b/doc/build-osx.md index d6e93cb23d..913e72519f 100644 --- a/doc/build-osx.md +++ b/doc/build-osx.md @@ -1,6 +1,6 @@ Mac OS X Build Instructions and Notes ==================================== -This guide will show you how to build bitcoind(headless client) for OSX. +This guide will show you how to build bitcoind (headless client) for OSX. Notes ----- diff --git a/doc/build-unix.md b/doc/build-unix.md index 0984f689a8..f70bf7f1fe 100644 --- a/doc/build-unix.md +++ b/doc/build-unix.md @@ -195,12 +195,12 @@ Hardening enables the following features: * Position Independent Executable Build position independent code to take advantage of Address Space Layout Randomization - offered by some kernels. An attacker who is able to cause execution of code at an arbitrary - memory location is thwarted if he or she doesn't know where anything useful is located. + offered by some kernels. Attackers who can cause execution of code at an arbitrary memory + location are thwarted if they don't know where anything useful is located. The stack and heap are randomly located by default but this allows the code section to be randomly located as well. - On an Amd64 processor where a library was not compiled with -fPIC, this will cause an error + On an AMD64 processor where a library was not compiled with -fPIC, this will cause an error such as: "relocation R_X86_64_32 against `......' can not be used when making a shared object;" To test that you have built PIE executable, install scanelf, part of paxutils, and use: diff --git a/doc/developer-notes.md b/doc/developer-notes.md index eaeb90da1d..8f7db31d59 100644 --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -53,7 +53,7 @@ bool function(int arg1, const char *arg2) ``` A complete list of `@xxx` commands can be found at http://www.stack.nl/~dimitri/doxygen/manual/commands.html. As Doxygen recognizes the comments by the delimiters (`/**` and `*/` in this case), you don't -*need* to provide any commands for a comment to be valid, just a description text is fine. +*need* to provide any commands for a comment to be valid; just a description text is fine. To describe a class use the same construct above the class definition: ```c++ @@ -175,7 +175,7 @@ Threads Pull Request Terminology ------------------------ -Concept ACK - Agree with the idea and overall direction, but haven't reviewed the code changes or tested them. +Concept ACK - Agree with the idea and overall direction, but have neither reviewed nor tested the code changes. utACK (untested ACK) - Reviewed and agree with the code changes but haven't actually tested them. @@ -183,4 +183,4 @@ Tested ACK - Reviewed the code changes and have verified the functionality or bu ACK - A loose ACK can be confusing. It's best to avoid them unless it's a documentation/comment only change in which case there is nothing to test/verify; therefore the tested/untested distinction is not there. -NACK - Disagree with the code changes/concept. Should be accompanied by an explanation. +NACK - Disagree with the code changes/concept. Should be accompanied by an explanation. diff --git a/doc/dnsseed-policy.md b/doc/dnsseed-policy.md index f15ff44e5d..506e171153 100644 --- a/doc/dnsseed-policy.md +++ b/doc/dnsseed-policy.md @@ -10,15 +10,14 @@ Other implementations of Bitcoin software may also use the same seeds and may be more exposed. In light of this exposure, this document establishes some basic expectations for operating dnsseeds. -0. A DNS seed operating organization or person is expected -to follow good host security practices and maintain control of -their serving infrastructure and not sell or transfer control of their -DNS seed. Any hosting services contracted by the operator are -equally expected to uphold these expectations. +0. A DNS seed operating organization or person is expected to follow good +host security practices, maintain control of applicable infrastructure, +and not sell or transfer control of the DNS seed. Any hosting services +contracted by the operator are equally expected to uphold these expectations. 1. The DNS seed results must consist exclusively of fairly selected and functioning Bitcoin nodes from the public network to the best of the -operators understanding and capability. +operator's understanding and capability. 2. For the avoidance of doubt, the results may be randomized but must not single-out any group of hosts to receive different results unless due to an @@ -28,7 +27,7 @@ urgent technical necessity and disclosed. 4. Any logging of DNS queries should be only that which is necessary for the operation of the service or urgent health of the Bitcoin -network and must not be retained longer than necessary or disclosed +network and must not be retained longer than necessary nor disclosed to any third party. 5. Information gathered as a result of the operators node-spidering diff --git a/doc/gitian-building.md b/doc/gitian-building.md index d285fffdbb..1fa5b5f989 100644 --- a/doc/gitian-building.md +++ b/doc/gitian-building.md @@ -87,7 +87,7 @@ After creating the VM, we need to configure it.  -- Click `Advanced`, then `Port Forwarding`. We want to set up a port through where we can reach the VM to get files in and out. +- Click `Advanced`, then `Port Forwarding`. We want to set up a port through which we can reach the VM to get files in and out. - Create a new rule by clicking the plus icon.  @@ -111,7 +111,7 @@ Installing Debian This section will explain how to install Debian on the newly created VM. -- Choose the non-graphical installer. We do not need the graphical environment, it will only increase installation time and disk usage. +- Choose the non-graphical installer. We do not need the graphical environment; it will only increase installation time and disk usage.  @@ -144,7 +144,7 @@ and proceed, just press `Enter`. To select a different button, press `Tab`.  -- The installer will set up the clock using a time server, this process should be automatic +- The installer will set up the clock using a time server; this process should be automatic - Set up the clock: choose a time zone (depends on the locale settings that you picked earlier; specifics don't matter)  @@ -371,7 +371,7 @@ COMMIT=2014_03_windows_unicode_path Signing externally ------------------- -If you want to do the PGP signing on another device that's also possible; just define `SIGNER` as mentioned +If you want to do the PGP signing on another device, that's also possible; just define `SIGNER` as mentioned and follow the steps in the build process as normal. gpg: skipped "laanwj": secret key not available @@ -393,4 +393,4 @@ Uploading signatures After building and signing you can push your signatures (both the `.assert` and `.assert.sig` files) to the [bitcoin/gitian.sigs](https://github.com/bitcoin/gitian.sigs/) repository, or if that's not possible create a pull -request. You can also mail the files to me (laanwj@gmail.com) and I'll commit them. +request. You can also mail the files to Wladimir (laanwj@gmail.com) and he will commit them. diff --git a/doc/init.md b/doc/init.md index 871bdc8123..1f206a6c02 100644 --- a/doc/init.md +++ b/doc/init.md @@ -63,7 +63,7 @@ can then be controlled by group membership. 4a) systemd -Installing this .service file consists on just copying it to +Installing this .service file consists of just copying it to /usr/lib/systemd/system directory, followed by the command "systemctl daemon-reload" in order to update running systemd configuration. diff --git a/doc/release-process.md b/doc/release-process.md index 5dad9bf5de..cdcee0ec36 100644 --- a/doc/release-process.md +++ b/doc/release-process.md @@ -164,4 +164,4 @@ Note: check that SHA256SUMS itself doesn't end up in SHA256SUMS, which is a spur - Add release notes for the new version to the directory `doc/release-notes` in git master -- Celebrate +- Celebrate diff --git a/doc/translation_process.md b/doc/translation_process.md index eed467706e..3653e53021 100644 --- a/doc/translation_process.md +++ b/doc/translation_process.md @@ -32,7 +32,7 @@ QToolBar *toolbar = addToolBar(tr("Tabs toolbar")); ### Creating a pull-request For general PRs, you shouldn’t include any updates to the translation source files. They will be updated periodically, primarily around pre-releases, allowing time for any new phrases to be translated before public releases. This is also important in avoiding translation related merge conflicts. -When an updated source file is merged into the Github repo, Transifex will automatically detect it (although it can take several hours). Once processed, the new strings will show up as "Remaining" in the Transifex web interface and are ready for translators. +When an updated source file is merged into the Github repo, Transifex will automatically detect it (although it can take several hours). Once processed, the new strings will show up as "Remaining" in the Transifex web interface and are ready for translators. To create the pull-request, use the following commands: ``` @@ -108,4 +108,4 @@ To create a new language template, you will need to edit the languages manifest ### Questions and general assistance The Bitcoin-Core translation maintainers include *tcatm, seone, Diapolo, wumpus and luke-jr*.You can find them, and others, in the Freenode IRC chatroom - `irc.freenode.net #bitcoin-dev`. -If you are a translator, you should also subscribe to the mailing list, https://groups.google.com/forum/#!forum/bitcoin-translators. Announcements will be posted during application pre-releases to notify translators to check for updates.
\ No newline at end of file +If you are a translator, you should also subscribe to the mailing list, https://groups.google.com/forum/#!forum/bitcoin-translators. Announcements will be posted during application pre-releases to notify translators to check for updates. |