Hyperledger Iroha v1.0 beta-4 version

[neewy]

In this release following changes were made:

Faster throughput, pluggable state storage

There is less abstraction on state storage level, and validation is done with means of SQL queries. It has significantly improved the performance of Iroha peer and made it less error-prone (#1557).

State storage is plugged over ORM library titled as SOCI, which bundles a nice thread pool for faster interconnection with PostgreSQL; and makes it possible to switch to other supported SQL storage (how about using in-memory SQLite database for even faster throughput? #1505)

Stateful validation errors

All the stateful validation errors are printed in peer logs and response is sent to a client along with transaction status. Now it is a lot easier to check what went wrong with a rejected transaction (#1508)

Important note: this version of Iroha can disclose some personal data like account balance (if a transaction was statefully invalid —account can now get the reason). In the future version we will implement error codes (check them there)

Binary Testing Framework

This is a test framework that helps testing client libraries (now particularly in Python) if they produce valid transactions and queries (if permissions and other business rules were met #1485)

Transaction status streaming over RxCpp

Reactive extensions library in C++ is actively used in our architecture and now is in charge of transaction status processing (#1541)

Input fuzzing

Libfuzz checks the input in our client component (called Torii) and protobuf messages are mutated as well (#1531)

Blocks and proposals are not copied now (and their creation process is benchmarked)

A proposal is a candidate for becoming the next block in Iroha chain. The lifetime of these objects is important, this is why their creation and copying has to be minimized by means of C++ (#1542, #1567)
Creation is benchmarked by means of Google Benchmark library (#1539)

Check the size of signatures set

One of the bugs, that was revealed with help of fuzzing, was a possibly valid empty signature set attached to a transaction. This behavior was fixed in #1536.

API changes

Transaction batch support

Transaction batch is a set of transactions, which are to be applied together. There are two kinds of batches:

• Ordered batch
  • transactions will be applied strictly in the order they were received
• Atomic batch
  • the order is still guaranteed
  • failure of any transaction inside it leads to failure of the whole batch

Important note: this feature was not implemented completely in this release, however, interfaces and SDKs have already been changed for easier integration in the future. This does not affect backward compatibility.

Check the status of development here

Amount is passed as a string. Everywhere

Code became much simpler and it is easier to create transactions without SDKs now (#1555)

Proto files were split

Client API proto files now are stored in a shared model folder, whereas as Iroha peer messages are stored in schema folder (#1550)

GetAccountDetail is a bit more powerful now

Check our documentation page

GetPendingTransactions

In order to make scenarios related to transaction batches and multisignature transactions easier Iroha has API endpoint to get transactions of transactions batches which require signing by participating accounts (#1532)

Important note: this feature was not implemented completely in this release, however, interfaces and SDKs have already been changed for easier integration in the future. This does not affect backward compatibility.

Deleted account_id from Add/SubtractAssetQuantity commands

Finally, we have deleted account_id from a previously confusing API in #1511

Roles can have an empty set of permissions

Now users can create empty roles for use cases where such a role can serve a purpose of a tag or the least powerful role in the system (#1510)

Other

• Transaction status bus (Feature/tx status bus #1575)
• Databases are purged and dropped after tests (Proper database drop for storage #1406, Add database removal in Storage::dropStorage #1584)
• Query execution can be mocked now (and tests are going to be much cleaner and easy to read) (Replace QPF with QueryExecution mockable module #1579)
• Common objects factory (Common objects factory #1556)
• Builders are replaced with mocked Shared Model interfaces (Mock builder introduction #1563)
• WSV Query factories (instead of builders) (common objects factory for wsv query #1573)
• Refactor QueryProcessor interface (Refactor QueryProcessor interface #1572)
• Block and proposal creation benchmarks (block and proposal creation benchmark #1539)
• Proposal and block transactions validation (Proposal and block txs validation #1506)
• Add test cases for empty protobuf payload (Add oneof case bound check #1502)
• Jenkins build status badge link (Fix jenkins build link #1551)
• Shared Model build status is fixed (Fix sm build #1576)
• Java binding fix (Java bindings package name #1507, Java bindings fix #1569)
• Color diagnostics in Jenkins CI (Add color diagnostics #1515)
• Reuse Peer proto (Reuse Peer in mst.proto #1522)
• Fix tests for createRole with the empty set of permissions (Fix tests for createRole with empty set of permissions #1520)
• Improve Findgrpc.cmake (Improve Findgrpc.cmake #1518)
• WSV (blockchain state) in PostgreSQL stores permissions as bit strings (Migrate to postgres bitstring perms #1499)
• CLI values now are cached for convenience purposes (Cache CLI input values #1496) by contributor uditha-atukorala
• Removed grantable permissions in queries (Remove hasAccountGrantablePermissions in qry exec #1500)
• Refactored TransferAsset test (Refactor TransferAsset acceptance test #1482)
• Fix indentation in a code of error message in IP validator (Fix error message in IP validator #1514, Fix error message for Peer's address #1513)
• Fix type incompatibility on 32-bit platforms in keys manager (Fix max call in keys manager  #1503)
• Python example fix (Python example fix #1529)
• Bind operator in TemporaryWsv files (Refactor Temporary Wsv command application #1544)

Known issues

Windows build does not work at the moment, as well as JS bindings, due to their rough transition to new client libraries

[neewy]

@lebdron @igor-egorov can we review Codacy issues and decide if we need to put them in backlog?

[neewy]

As our CI has issues with dependency updates, we have decided to postpone our release until Jenkins can update build dependencies @bakhtin @kamilsa @lebdron

[neewy]

Release is blocked with quality gate. Need to review & localize test issues before releasing

[sorabot]

SonarQube analysis reported 19 issues

• 1 major
• 18 minor

Top 10 issues

1. query_response_template.hpp#L203: syntax error
2. interactive_common_cli.cpp#L43: Return value of function to_string() is not used.
3. interactive_transaction_cli.hpp#L145: Unused private function: 'InteractiveTransactionCli::parseRevokePermission'
4. postgres_block_index.hpp#L54: Unused private function: 'PostgresBlockIndex::indexAccountAssets'
5. postgres_block_query.hpp#L64: Unused private function: 'PostgresBlockQuery::getBlockIds'
6. postgres_block_query.hpp#L72: Unused private function: 'PostgresBlockQuery::getBlockId'
7. postgres_block_query.hpp#L82: Unused private function: 'PostgresBlockQuery::callback'
8. ordering_init.cpp#L55: The function 'initOrderingGate' is never used.
9. pb_common.cpp#L54: The function 'serializeAsset' is never used.
10. pb_common.cpp#L71: The function 'serializeDomain' is never used.