This release was mainly focused on refactoring code and properties as a necessary step for future enhancements. We also continued making improvements to our Kubernetes support. To that end, we added Prometheus REST metrics, Helm tests and Mirror Node can now run in GKE.
We added a new parameter to all of the topic related REST APIs to return a topic message in plaintext instead of binary. Messages submitted to HAPI are submitted as binary and stored in the Mirror Node that way as well. If you know the messages are actually strings encoded in UTF-8, then you can set encoding=utf-8 and the REST API will make a best effort conversion to string. By default or if you pass a query parameter of encoding=base64, it will return the message as base64 encoded binary.
Breaking Changes
Please note when upgrading that we made major breaking changes to the naming of our configuration properties. We've renamed all hedera.mirror.api properties to hedera.mirror.rest. We also renamed the properties apiUsername to restUsername and apiPassword to restPassword to reflect that as well. Any properties that were used by the importer module were renamed to be nested under hedera.mirror.importer. We apologize for any inconvenience.
We've removed the hedera.mirror.addressBookPath property in favor of a hedera.mirror.importer.initialAddressBook property. The former was overloaded to be both the initial bootstrap address book and the live address book being updated by file transactions for 0.0.102. The live address book is now hardcoded to ${hedera.mirror.importer.dataPath}/addressbook.bin and cannot be changed.
The REST API to retrieve a topic message by its consensus timestamp now supports both a plural (/topics/messages/:consensusTimestamp) and singular (/topic/message/:consensusTimestamp) URI path. The singular format is deprecated and will be going away in the near future, so please update to the plural format soon.
We removed the singular form of a few alpha topic REST APIs. The /topic/:id/message API was removed in favor of the plural form /topics/:id/messages. Similarly, the /topic/:id/message/:sequencenumber API was removed in favor of its plural form /topics/:id/messages/:sequencenumber. Please update accordingly.
Enhancements
- Prepare for v0.11.0 #760
- Automate versioning and prepare for v0.11.0-rc1 #742
- Auto Clean up old master images in GCR #734
- Lint and template helm charts #731
- Add PubSub integration tests #729
- Homogenize integration test setup #728
- Added running_hash_version migration #726
- Record Parser file reorg #725
- Update protobuf for Hedera Node 0.5.0 #722
- Update protobuf for Hedera Node 0.5.0 #721
- Add initialAddressBook property #719
- Add Helm tests #718
- Fixes to run in GKE #716
- Separate configuration properties by project #715
- Add missing transactionType to PubSubMessge #714
- Change 'left outer join' to 'join' with t_cryptotransferlists #706
- PubSub exporter integration tests and docs #705
- Topic message format support for UTF8 message encoding #704
- Support UTF encoding of Topic Message Results #703
- Configure bootstrap address book path #697
- Consume REST Swagger Prometheus Formatted Metrics #691
- Auto Clean up old master images in GCR #689
- Store new receipt.topicRunningHashVersion #688
- Kubernetes: Manual Deployment to GKE #669
- Kubernetes: Helm chart CI #654
- Kubernetes: Helm chart tests #653
- Nest module properties under a module specific path #416
- Remove the 'left outer join' from the queries in the transactions queries #136
Bug Fixes
- Add awaitjs and swagger missing rest api bundle dependencies #733
- Utilize plural rest api endpoints without breaking support #710
- Topic REST API Endpoints utilize both singular and plural paths #700
Documentation
- Add pubsub docs. Minor properties refactor #741
Contributors
We'd like to thank all the contributors who worked on this release!