Interchained Core integration/staging tree

https://interchained.org

What is Interchained?

Interchained is an experimental digital currency that enables instant payments to anyone, anywhere in the world. Interchained uses peer-to-peer technology to operate with no central authority: managing transactions and issuing money are carried out collectively by the network. Interchained Core is the name of open source software which enables the use of this currency.

For more information, as well as an immediately usable, binary version of the Interchained Core software, see https://interchained.org/en/download/, or read the original whitepaper.

License

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

Development Process

The master branch is regularly built (see doc/build-*.md for instructions) and tested, but it is not guaranteed to be completely stable. Tags are created regularly from release branches to indicate new official, stable release versions of Interchained Core.

The https://github.com/interchained-core/gui repository is used exclusively for the development of the GUI. Its master branch is identical in all monotree repositories. Release branches and tags do not exist, so please do not fork that repository unless it is for development reasons.

The contribution workflow is described in CONTRIBUTING.md and useful hints for developers can be found in doc/developer-notes.md.

Testing

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 in configure) with: make check. 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, that are run automatically on the build server. These tests can be run (if the test dependencies are installed) with: test/functional/test_runner.py

The Travis CI system makes sure that every pull request is built for Windows, Linux, and macOS, and that unit/sanity tests are run automatically.

Manual Quality Assurance (QA) Testing

Changes should be tested by somebody other than the developer who wrote the code. This is especially important for large or high-risk changes. It is useful to add a test plan to the pull request description if testing the changes is not straightforward.

Translations

Changes to translations as well as new translations can be submitted to Interchained Core's Transifex page.

Translations are periodically pulled from Transifex and merged into the git repository. See the translation process for details on how this works.

Important: We do not accept translation changes as GitHub pull requests because the next pull from Transifex would automatically overwrite them again.

Translators should also subscribe to the mailing list.

Token subsystem

The optional token module allows wallets to create and transfer custom tokens identified by strings that begin with 0x, contain 54 hex characters, and end with tok. When no identifier is supplied to createtoken, a unique one is generated from the creator name and token name plus a random nonce.

Recent additions improve robustness:

• Persistent ledger – token balances and history are stored on disk using LevelDB so that restarts keep token state.
• On‑chain records – each token operation is embedded in an OP_RETURN transaction, enabling miners to include the data in blocks.
• Event logging – operations are written to the debug log for wallet UIs or other processes to monitor.
• Node operator reward – if -nodeoperatorwallet is set, 5% of each block reward is sent to that address.
• Dynamic fees – governance fees are charged per‑byte at a fixed rate of 10000 sat/vB (minimum 0.075 ITC) and paid to a predefined wallet. Creating a token incurs a special rate of 10000000 sat/vB sent to the governance wallet.
• ERC‑20 style upgrades – tokens now carry metadata including name, symbol and decimals, and a mint operation is available.
• Signed operations – token actions are signed by the controlling wallet so peers reject unauthorized spends.
• Operator minting – only the wallet that created a token may mint additional supply.
• Metadata lookup – the token_meta RPC returns name, symbol, decimals, creator, creation height and total supply for any token.
• Authenticated network messages – incoming TOKENTX messages are verified and peers sending invalid ones are penalized.
• Consensus ordering – token operations are processed as blocks connect, giving all nodes the same history.
• Versioned database – ledger state stored in LevelDB includes a version number to support future migrations.
• Rescan support – the rescan_tokentx RPC rebuilds the token ledger from a chosen block height.
• Planned atomic swaps – future versions aim to enable trustless token-to-coin swaps.

Token RPC usage examples

Create a token with an auto-generated id:

$ interchained-cli createtoken 100 "MyToken" "MTK" 0

Create a token with 8 decimals and an auto-generated id:

$ interchained-cli createtoken 100 "AnotherToken" "ATK" 8

Create a token with a specific id:

$ interchained-cli createtoken "001122...tok" 100 "MyToken" "MTK" 0

Query the token balance for the current wallet:

$ interchained-cli gettokenbalance "tokenidtok" false

Query the token balance of another address:

$ interchained-cli gettokenbalanceof "tokenidtok" "address"

Retrieve this wallet's signer address:

$ interchained-cli getsigneraddress

Query the token balance of another address:

$ bitcoin-cli gettokenbalanceof "tokenidtok" "address"

Approve a spender:

$ interchained-cli tokenapprove "spender" "tokenidtok" 10

Check remaining allowance:

$ interchained-cli tokenallowance "owner" "spender" "tokenidtok"

Transfer tokens to another wallet:

$ interchained-cli tokentransfer "other" "tokenidtok" 5

Transfer tokens using an allowance:

$ interchained-cli tokentransferfrom "alice" "bob" "tokenidtok" 1

Increase a spender's allowance:

$ interchained-cli tokenincreaseallowance "spender" "tokenidtok" 1

Decrease a spender's allowance:

$ interchained-cli tokendecreaseallowance "spender" "tokenidtok" 1

Burn some of your tokens:

$ interchained-cli tokenburn "tokenidtok" 1

Transfer token ownership (must be called from the current operator's wallet):

$ bitcoin-cli tokentransferownership "tokenidtok" "newowner"

Check the total supply of a token:

$ interchained-cli tokentotalsupply "tokenidtok"

Look up token metadata:

$ interchained-cli token_meta "tokenidtok"

List your tokens with positive balances:

$ interchained-cli my_tokens false

List all known tokens:

$ interchained-cli all_tokens

Show token history:

$ interchained-cli token_history "tokenidtok"
$ interchained-cli token_history "tokenidtok" "recipient"
$ interchained-cli token_history "tokenidtok" "bob"

Check accumulated governance fees:

$ interchained-cli getgovernancebalance

Rescan token transactions from a specific block height:

$ interchained-cli rescan_tokentx 3000

Run the basic token functional test:

$ test/functional/test_runner.py wallet_tokens.py

Bulk transfer payments from a CSV file:

# csv, replaceable, conf_target, estimate_mode, fee_rate, verbose
$ interchained-cli bulktransfer "/path/to/payments.csv" true 6 econservative 0.0001 true