RanchiMall/blockbook
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

added note about pull requests

Browse Source
This commit is contained in:
Jakub Matys 2018-08-29 10:12:54 +02:00
parent eb87d530df
commit c55ad72210
1 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
CONTRIBUTING.md
View File

@ -1,10 +1,11 @@
# Blockbook Contributor Guide # Blockbook Contributor Guide
Blockbook is back-end service for Trezor wallet. Although it is open source, design and development of core packages Blockbook is back-end service for Trezor wallet. Although it is open source, design and development of core packages
is done by Trezor developers in order to keep Blockbook compatible with Trezor. If you feel you could use Blockbook is done by Trezor developers in order to keep Blockbook compatible with Trezor.
for another purposes, we recommend you to make a fork.
However you can still help us find bugs or add support for new coins. Bug fixes and support for new coins are welcome. Please take note that non-fixing pull requests that change base
packages or another coin code will not be accepted. If you will have to change some of existing code, please file
an issue and discuss your request with Blockbook maintainers.
## Development environment ## Development environment
@ -15,6 +16,10 @@ Instructions to set up your development environment and build Blockbook are desc
### Reporting bugs ### Reporting bugs
If you think you found a bug, please [file an issue](https://github.com/trezor/blockbook/issues/new).
TODO issue content
### Adding coin support ### Adding coin support
Trezor harware wallet supports over 500 coins, see https://trezor.io/coins/. You are free to add support for any of Trezor harware wallet supports over 500 coins, see https://trezor.io/coins/. You are free to add support for any of
@ -50,12 +55,13 @@ about coin in section *coin* – name, alias etc. Then update port information i
listed in [port registry](/docs/ports.md). Select next port numbers in series. Port numbers must be unique across all listed in [port registry](/docs/ports.md). Select next port numbers in series. Port numbers must be unique across all
port definitions. port definitions.
In section *backend* update information how to build and configure backend service. When back-end package is built, In section *backend* update information how to build and configure back-end service. When back-end package is built,
build process downloads installation archive, verify and extract it. How it is done is described in build process downloads installation archive, verify and extract it. How it is done is described in
[build guide](/docs/build.md#on-back-end-building). Naming conventions and versioning are described [build guide](/docs/build.md#on-back-end-building). Naming conventions and versioning are described
also in [build guide](/docs/build.md#on-naming-conventions-and-versioning). You have to update *package_name*, also in [build guide](/docs/build.md#on-naming-conventions-and-versioning). You have to update *package_name*,
*package_revision*, *system_user*, *version*, *binary_url*, *verification_type*, *verification_source*, *extract_command* and *package_revision*, *system_user*, *version*, *binary_url*, *verification_type*, *verification_source*,
*exclude_files*. Also update information whether service runs mainnet or testnet network in *mainnet* option. *extract_command* and *exclude_files*. Also update information whether service runs mainnet or testnet network in
*mainnet* option.
In section *blockbook* update information how to build and configure Blockbook service. Usually they are only In section *blockbook* update information how to build and configure Blockbook service. Usually they are only
*package_name*, *system_user* and *explorer_url* options. Naming conventions are are described *package_name*, *system_user* and *explorer_url* options. Naming conventions are are described
@ -77,8 +83,8 @@ Coin implementation is stored in *bchain/coins* directory. Each coin must implem
There are several approaches how to implement coin support in Blockbook, please see examples below. There are several approaches how to implement coin support in Blockbook, please see examples below.
Bitcoin package *blockbook/bchain/coins/btc* is reference implementation for Bitcoin-like coins. Most of functionality is Bitcoin package *blockbook/bchain/coins/btc* is reference implementation for Bitcoin-like coins. Most of functionality
same so particular coin should embed it and override just different parts. is same so particular coin should embed it and override just different parts.
Bitcoin uses binary WIRE protocol thus decoding is very fast but require complex parser. Parser translate whole Bitcoin uses binary WIRE protocol thus decoding is very fast but require complex parser. Parser translate whole
pubkey-script to database ID and therefore it is usually possible store transactions without change. pubkey-script to database ID and therefore it is usually possible store transactions without change.