No description
Find a file
merge-script 511c0820ab
Some checks are pending
CI / test each commit (push) Waiting to run
CI / macOS 14 native, arm64, no depends, sqlite only, gui (push) Waiting to run
CI / macOS 14 native, arm64, fuzz (push) Waiting to run
CI / Win64 native, VS 2022 (push) Waiting to run
CI / Win64 native fuzz, VS 2022 (push) Waiting to run
CI / ASan + LSan + UBSan + integer, no depends, USDT (push) Waiting to run
Merge ElementsProject/elements#1571: Additional RPC documentation fixes
e5d02b9fd5 fix RPC documentation inconsistencies (Tom Trevethan)

Pull request description:

  Additional fixes for RPC documentation.

  | # | File | RPC | Issue |
  | --- | --- | --- | --- |
  | 1 | blockchain.cpp | getblockheader, getblock | "target" documented but never emitted |
  | 2 | blockchain.cpp | getdescriptoractivity | "spend_vout" in docs vs "spend_vin" in code |
  | 3 | blockchain.cpp | getblock | Typo "Uninforced" vs "Unenforced" |
  | 4 | blockchain.cpp | scantxoutset | "asset" not optional |
  | 5 | blockchain.cpp | getsidechaininfo | current_fedpeg_programs/current_fedpegscripts output order inverted |
  | 6 | mining.cpp | getmininginfo | "next" not marked optional; absent on all signed-block chains |
  | 7 | mining.cpp | getmininginfo | "signet_challenge"/"next" emit order inverted vs docs |
  | 8 | mining.cpp | combineblocksigs | witnessScript declared optional but required for dynafed |
  | 9 | mining.cpp | getcompactsketch | Return type STR should be STR_HEX |
  | 10 | mining.cpp | getblocktemplate | "capabilities" pushed first, documented fourth |
  | 11 | mining.cpp | getnewblockhex | Stale "Wallet keypool empty" error message |
  | 12 | rawtransaction.cpp | decodepsbt | "fees" documented twice with conflicting types |
  | 13 | rawtransaction.cpp | decodepsbt | "input_count"/"output_count" not marked optional |
  | 14 | rawtransaction.cpp | getrawtransaction | Verbosity=0 return type STR should be STR_HEX |
  | 15 | rawtransaction.cpp | combinerawtransaction | Return type STR should be STR_HEX |
  | 16 | rawtransaction.cpp | rawblindrawtransaction | Return type STR should be STR_HEX |
  | 17 | rawtransaction.cpp | rawblindrawtransaction | inputAmounts error says "input blind" |
  | 18 | rawtransaction.cpp | rawblindrawtransaction | asset validation error says "asset blinds" not "asset ids" |
  | 19 | rawtransaction.cpp | signrawtransactionwithkey | privatekey typed STR_HEX but is base58 |

  Wallet RPC fixes:

  | # | File | RPC | Issue |
  | --- | --- | --- | --- |
  | 1 | coins.cpp | listunspent | "asset", "amountblinder", "assetblinder" not marked optional |
  | 2 | coins.cpp | listunspent | "ancestorfees" typed STR_AMOUNT but code emits raw integer |
  | 3 | coins.cpp | getreceivedbyaddress, getreceivedbylabel | include_immature_coinbase examples pass true as assetlabel |
  | 4 | spend.cpp | walletcreatefundedpsbt | psbt_version implies configurability but only version 2 is accepted |
  | 5 | spend.cpp | signrawtransactionwithwallet | amountcommitment prevtxs arg typed STR instead of STR_HEX |
  | 6 | wallet.cpp | getwalletinfo | Balance OBJ fields document a fixed "bitcoin" key; code emits dynamic asset map |
  | 7 | elements.cpp | createrawpegin | Result "hex" typed STR instead of STR_HEX |
  | 8 | elements.cpp | sendtomainchain | bip32_counter result typed STR; should be NUM to match input arg type |

ACKs for top commit:
  delta1:
    ACK e5d02b9fd5; tested locally

Tree-SHA512: d3d3485ddd5dba3699902d8ede22a1c603f44ed2fc4fc426bf9a1730a64c9d5cf9899a1661f30ed073d00b738c9c89aa3273b18265c92e500229351ab7fe2452
2026-07-09 15:42:03 +02:00
.github set Wno-error for simplicity keep warning but dont error on it 2026-06-17 14:15:49 +01:00
.tx Update Transifex slug for 29.x 2025-02-06 09:38:49 +00:00
build_msvc/libelementssimplicity Merge 0c90fc6443 into merged_master (Bitcoin PR bitcoin/bitcoin#30731) 2026-03-20 13:46:31 +00:00
ci set Wno-error for simplicity keep warning but dont error on it 2026-06-17 14:15:49 +01:00
cmake rename test_bitcoin to test_elements 2026-05-26 14:15:17 +01:00
contrib Merge remote-tracking branch 'origin/master' into HEAD 2026-06-19 14:59:31 +01:00
depends Merge 5b3a81f44d into merged_master (Bitcoin PR bitcoin/bitcoin#31626) 2026-04-10 08:57:56 +00:00
doc Merge remote-tracking branch 'origin/master' into HEAD 2026-06-19 14:59:31 +01:00
share build: fix windows/mingw build 2026-05-07 20:34:28 +01:00
src fix RPC documentation inconsistencies 2026-07-09 14:13:48 +01:00
test fix RPC documentation inconsistencies 2026-07-09 14:13:48 +01:00
.cirrus.yml Merge 2f98d1e06e into merged_master (Bitcoin PR bitcoin/bitcoin#31814) 2026-04-14 13:59:27 +00:00
.editorconfig code style: update .editorconfig file 2024-09-13 17:55:10 +02:00
.gitattributes
.gitignore Merge 99e35fb7b9 into merged_master (Bitcoin PR bitcoin/bitcoin#30779) 2026-03-24 12:54:24 +00:00
.python-version Bump python minimum supported version to 3.10 2024-08-28 15:53:07 +02:00
.style.yapf Update .style.yapf 2023-06-01 23:35:10 +05:30
CMakeLists.txt reviewed cmake build process and removed fixme comment 2026-04-20 15:29:12 +01:00
CMakePresets.json cmake: Remove unused BUILD_TESTING variable from "dev-mode" preset 2024-12-19 22:25:11 +00:00
CONTRIBUTING.md Merge 15c1f47a00 into merged_master (Bitcoin PR bitcoin/bitcoin#31327) 2026-04-03 14:38:41 +00:00
COPYING doc: upgrade license to 2025. 2025-01-06 12:23:11 +00:00
INSTALL.md doc: Added hyperlink for doc/build 2021-09-09 19:53:12 +05:30
libbitcoinkernel.pc.in build: use CLIENT_NAME in libbitcoinkernel.pc.in 2025-02-07 16:11:48 +00:00
README.md Merge 15563d3388 into merged_master (Bitcoin PR bitcoin/bitcoin#30859) 2026-03-30 12:02:45 +00:00
SECURITY.md docs: update security.md 2025-03-24 09:09:02 +02:00
vcpkg.json rename test_bitcoin to test_elements 2026-05-26 14:15:17 +01:00

Elements Project blockchain platform

Release

https://elementsproject.org

This is the integration and staging tree for the Elements blockchain platform, a collection of feature experiments and extensions to the Bitcoin protocol. This platform enables anyone to build their own businesses or networks pegged to Bitcoin as a sidechain or run as a standalone blockchain with arbitrary asset tokens.

Modes

Elements supports a few different pre-set chains for syncing. Note though some are intended for QA and debugging only:

  • Liquid mode: elementsd -chain=liquidv1 (syncs with Liquid network)
  • Bitcoin mainnet mode: elementsd -chain=main (not intended to be run for commerce)
  • Bitcoin testnet mode: elementsd -chain=testnet3
  • Bitcoin regtest mode: elementsd -chain=regtest
  • Elements custom chains: Any other -chain= argument. It has regtest-like default parameters that can be over-ridden by the user by a rich set of start-up options.

Confidential Assets

The latest feature in the Elements blockchain platform is Confidential Assets, the ability to issue multiple assets on a blockchain where asset identifiers and amounts are blinded yet auditable through the use of applied cryptography.

Features of the Elements blockchain platform

Compared to Bitcoin itself, it adds the following features:

Previous elements that have been integrated into Bitcoin:

  • Segregated Witness
  • Relative Lock Time

Elements deferred for additional research and standardization:

Additional RPC commands and parameters:

Testing and code review is the bottleneck for development; we get more pull requests than we can review and test on short notice. Please be patient and help out by testing other people's pull requests, and remember this is a security-critical project where any mistake might cost people lots of money.

Automated Testing

Developers are strongly encouraged to write unit tests for new code, and to submit new unit tests for old code. Unit tests can be compiled and run (assuming they weren't disabled during the generation of the build system) with: ctest. Further details on running and extending unit tests can be found in /src/test/README.md.

There are also regression and integration tests, written in Python. These tests can be run (if the test dependencies are installed) with: build/test/functional/test_runner.py (assuming build is your build directory).

The CI (Continuous Integration) systems make sure that every pull request is built for Windows, Linux, and macOS, and that unit/sanity tests are run automatically.

License

Elements is released under the terms of the MIT license. See COPYING for more information or see http://opensource.org/licenses/MIT.

What is the Elements Project?

Elements is an open source, sidechain-capable blockchain platform. It also allows experiments to more rapidly bring technical innovation to the Bitcoin ecosystem.

Learn more on the Elements Project website

https://github.com/ElementsProject/elementsproject.github.io

Secure Reporting

See our vulnerability reporting guide