firefly

Summary

This is a large release as we come closer to the 1.0.0 milestone. All users are recommended to upgrade to this release when possible, taking into account all breaking API changes noted here.

Breaking API changes:

• All APIs deprecated in v0.11.0 or earlier are removed - see detailed migration notes
• Richer query parameters for filtering collections - with breaking changes to the ^ operator

Other major items included in this release:

• Preview of custom on-chain logic
  • Provides flexible methods for interacting with your own contracts, deployed to the blockchain of your choice
  • New APIs are available under /namespaces/{ns}/contracts and/namespaces/{ns}/apis
  • Not yet guaranteed to be stable, and API is subject to change
• Support for new ERC20 / ERC721 connector
• Overhaul of Transaction type, and new BlockchainEvent type
• Support for delivery confirmations via DX plugin
• Support for more flexible signing via new config pointing at an external address resolver
• First-class support for blob filenames on Data objects
• UI enhancements
  • Improved support for navigating and downloading file blobs
  • Filtering for token screens (pools, transfers, accounts)
• Bug fixes and improvements

Updated Dependencies

• firefly-ethconnect v3.1.2
• firefly-fabconnect v0.9.7
• firefly-dataexchange-https v0.10.3
• firefly-tokens-erc1155 v0.10.4
• firefly-tokens-erc20-erc721 v0.1.4
• firefly-ui v0.5.0

What's Changed

• Fixing Websocket Connections when Prometheus Metrics Enabled by @hfuss in https://github.com/hyperledger/firefly/pull/371
• Set fetch-depth to get the full history in GitHub Actions by @nguyer in https://github.com/hyperledger/firefly/pull/377
• Fetch full history on all GitHub Actions by @nguyer in https://github.com/hyperledger/firefly/pull/378
• [helm] Publishing Helm Chart to GHCR via OCI by @hfuss in https://github.com/hyperledger/firefly/pull/359
• [psql-maxconns] default connection limit for postgresql by @eberger727 in https://github.com/hyperledger/firefly/pull/385
• Allow any company name in license header by @nguyer in https://github.com/hyperledger/firefly/pull/379
• Prevent send/receive deadlock in wsclient by @awrichar in https://github.com/hyperledger/firefly/pull/387
• API changes for Blob Friendly Names by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/381
• Fix unit test for wsclient send failure by @awrichar in https://github.com/hyperledger/firefly/pull/388
• Fixing Duplicate Metrics Registration when Unsetting preInit by @hfuss in https://github.com/hyperledger/firefly/pull/389
• Have DB creation script account for username by @drewmarshburn in https://github.com/hyperledger/firefly/pull/375
• Add Performance Testing Details to README by @eberger727 in https://github.com/hyperledger/firefly/pull/373
• Add postgres migrations for onchain-logic by @nguyer in https://github.com/hyperledger/firefly/pull/390
• FIR-4 (rich query updates) and FIR-7 (DX manifests) integration to onchain-logic branch by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/403
• Rectify Transactions and BlockchainEvents by @awrichar in https://github.com/hyperledger/firefly/pull/408
• Build the URL without the firefly port if it was omitted from stack.json by @jebonfig in https://github.com/hyperledger/firefly/pull/411
• Collapse onchain-logic into main by @awrichar in https://github.com/hyperledger/firefly/pull/410
• [erc20-payload] pass name and symbol to CreateTokenPool() by @eberger727 in https://github.com/hyperledger/firefly/pull/413
• Removing Helm Chart and Related CI Workflow by @hfuss in https://github.com/hyperledger/firefly/pull/412
• Update containerd by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/414
• PostgreSQL updates following merging of onchain-logic branch by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/417
• Fix token account listing on Postgres by @awrichar in https://github.com/hyperledger/firefly/pull/422
• Fix intermittent Fabric E2E test failure by @nguyer in https://github.com/hyperledger/firefly/pull/424
• Add ping/pong heartbeating to WSClient, and fix concurrent map on config by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/420
• Fail transaction when token transfer operation fails by @awrichar in https://github.com/hyperledger/firefly/pull/435
• Ready state changes require a bump to the message to re-sequence it by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/438
• JSON Schema validation for FFIs by @nguyer in https://github.com/hyperledger/firefly/pull/419
• Restore Transaction reference on TokenTransfer by @awrichar in https://github.com/hyperledger/firefly/pull/444
• Create a Transaction and Operation for contract invoke requests by @awrichar in https://github.com/hyperledger/firefly/pull/441
• Rename /contracts/events to /blockchainevents by @awrichar in https://github.com/hyperledger/firefly/pull/443
• Add convenience URL /transactions/{txnid}/blockchainevents by @awrichar in https://github.com/hyperledger/firefly/pull/446
• Allow calling JSONObject() on nil JSONAny by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/456
• Add Blockchain Transaction IDs to FireFly Transaction objects and add blockchain IDs to events by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/448
• Fixing E2E Tests for Multi-Member Networks by @hfuss in https://github.com/hyperledger/firefly/pull/459
• Avoid potential double-close of channels due to reconnects after tests complete by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/458
• Add route for /transactions/{txnid}/status by @awrichar in https://github.com/hyperledger/firefly/pull/457
• Add AddressResolver to Ethereum for key-to-address mapping by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/436
• Allow synchronous 200 response for token pool creation by @awrichar in https://github.com/hyperledger/firefly/pull/460
• Remove deprecated APIs by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/452
• ui version 0.5.0 by @shorsher in https://github.com/hyperledger/firefly/pull/464
• Add DefinitionBatchActions to execute after a batch of system definitions by @awrichar in https://github.com/hyperledger/firefly/pull/462
• Use /firefly prefix on local docs dev by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/461
• Allow passing a tokenIndex to "mint" by @awrichar in https://github.com/hyperledger/firefly/pull/465
• [v0.12.0-manifests] manifests for v0.12.0 by @eberger727 in https://github.com/hyperledger/firefly/pull/466

New Contributors

• @drewmarshburn made their first contribution in https://github.com/hyperledger/firefly/pull/375

Full Changelog: https://github.com/hyperledger/firefly/compare/v0.11.4...v0.12.0

Summary

• Backported bug fixes

What's Changed

• v0.11.x backport: Fix querying transfers by tx or type, batches by tx by @awrichar in https://github.com/hyperledger/firefly/pull/429
• v0.11.x backport: Fixing Websocket Connections when Prometheus Metrics Enabled + containerd update by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/432
• v0.11.x backport: Fix token account listing on Postgres by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/431
• v0.11.x backport: Add ping/pong heartbeating to WSClient, and fix concurrent map on config by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/430
• v0.11.x backport: Ready state changes require a bump to the message to re-sequence it by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/439

Full Changelog: https://github.com/hyperledger/firefly/compare/v0.11.4...v0.11.5

Summary

• Dependency updates and bug fixes

Updated Dependencies

• firefly-fabconnect v0.9.4

What's Changed

• Config map length fix, fix bug with missing events by closing the websocket by @jebonfig in https://github.com/hyperledger/firefly/pull/367
• Update dependencies for next release by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/369
• Fix misspelled filename (bytetypes.go) by @awrichar in https://github.com/hyperledger/firefly/pull/368
• Validate message topics/tag before sending by @awrichar in https://github.com/hyperledger/firefly/pull/365

Full Changelog: https://github.com/hyperledger/firefly/compare/v0.11.3...v0.11.4

Summary

• Dependency updates and bug fixes
• Helm/Kubernetes deployment template updated for fabric and prometheus metrics

Updated Dependencies

• firefly-ethconnect v3.1.0
• firefly-fabconnect v0.9.3
• firefly-tokens-erc1155 v0.10.2
• firefly-dataexchange-https v0.9.3

What's Changed

• Fabric connector needs to subscribe from zero by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/361
• Support configuration keys when the value type is a list by @jebonfig in https://github.com/hyperledger/firefly/pull/362
• [helm] Adding Storage for DX Blobs and PVC Templating Improvements by @hfuss in https://github.com/hyperledger/firefly/pull/354
• Fix send-to-self for private messages, and add group query URLs by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/363
• [helm] Support for Prometheus Metrics by @hfuss in https://github.com/hyperledger/firefly/pull/338
• [fabric] Dockerfile for Compiling firefly-go for Linux by @hfuss in https://github.com/hyperledger/firefly/pull/357
• Update manifest ready for v0.11.3 release by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/364
• [helm] Fabconnect Support by @hfuss in https://github.com/hyperledger/firefly/pull/356

Full Changelog: https://github.com/hyperledger/firefly/compare/v0.11.2...v0.11.3

Summary

This patch release includes important fixes and hardening for recent features. Major highlights:

• New charts UI and UI fixes for token panels
• Handling for token connectors that don't guarantee a unique URI for each NFT

Updated Dependencies

• firefly-dataexchange-https v0.9.3
• firefly-ui v0.4.3

What's Changed

• Fix Hyperledger Image Refs and Migration Job's Postgres URL in Helm Chart by @hfuss in https://github.com/hyperledger/firefly/pull/340
• Fix image repos by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/288
• Updates to handle recursive structures in swagger - depends on kin-openapi change by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/337
• Return an empty slice (rather than nil) for zero token accounts by @awrichar in https://github.com/hyperledger/firefly/pull/346
• Address coverage drop from #337 by @awrichar in https://github.com/hyperledger/firefly/pull/347
• on transfer/mint/burn fail, set transaction & operation as failed by @shorsher in https://github.com/hyperledger/firefly/pull/351
• update prometheus client version by @shorsher in https://github.com/hyperledger/firefly/pull/352
• Replace UpsertOperation with InsertOperation by @awrichar in https://github.com/hyperledger/firefly/pull/350
• Metrics endpoint to support charting by @eberger727 in https://github.com/hyperledger/firefly/pull/341
• Remove unique index on token URIs by @awrichar in https://github.com/hyperledger/firefly/pull/353
• Reduce overhead of gocritic by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/344
• ui version 0.4.3 by @shorsher in https://github.com/hyperledger/firefly/pull/358
• Update manifest for dataexchange-https by @awrichar in https://github.com/hyperledger/firefly/pull/360

Full Changelog: https://github.com/hyperledger/firefly/compare/v0.11.1...v0.11.2

Summary

This patch release includes important fixes and hardening for recent features. Major highlights:

• Fixed bugs with some token transfer events being ignored
• Added support for retrieving the URI attached to each non-fungible token
• Updated EthConnect release with significant new features, particularly when using Kafka
• Added initial prometheus metrics for batch pins

Updated Dependencies

• firefly-ethconnect v3.1.0
• firefly-fabconnect v0.9.2
• firefly-dataexchange-https v0.9.2
• firefly-tokens-erc1155 v0.10.1
• firefly-ui v0.4.2

What's Changed

• Update dependencies for v0.11.0 release by @nguyer in https://github.com/hyperledger/firefly/pull/333
• Remove "skipEventstreamInit" parameters by @awrichar in https://github.com/hyperledger/firefly/pull/329
• add batchpin counter prometheus metric by @shorsher in https://github.com/hyperledger/firefly/pull/334
• Add token URI by @awrichar in https://github.com/hyperledger/firefly/pull/335
• Split event stream helpers into separate files by @awrichar in https://github.com/hyperledger/firefly/pull/323
• Add "Getting Started" documentation for tokens by @awrichar in https://github.com/hyperledger/firefly/pull/306
• Move definitions of datatypes and tokens to their proper namespace by @nguyer in https://github.com/hyperledger/firefly/pull/312
• Leverage new token transfer id from plugin by @awrichar in https://github.com/hyperledger/firefly/pull/336
• bump ui to version 0.4.2 by @shorsher in https://github.com/hyperledger/firefly/pull/339
• Update dependencies for v0.11.1 release by @awrichar in https://github.com/hyperledger/firefly/pull/342

Full Changelog: https://github.com/hyperledger/firefly/compare/v0.11.0...v0.11.1

Summary

This release brings a lot of fixes and some exciting new features. Here are some of the highlights:

• Significantly hardened and enhanced token functionality
  • New, more flexible API structure (old APIs deprecated)
  • Coordination of token mint/burn/transfer events with attached messages and off-chain data
  • Proper handling for failed transfers and other error scenarios
• Major web UI overhaul
  • New pluggable architecture, introducing modules
    • Existing FireFly UI is now the data module
    • Added two new modules, tokens and network-map
  • Reworked navigation
  • Updated dashboard
  • Enhanced filtering
• Optimized database operations for increased transactional throughput
• Fixed PostgreSQL database migrations

What's Changed

• Move e2e to new routes, and add private/broadcast strong datatype tests by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/260
• Added more tests to the Fabric plugin for 100% coverage by @jimthematrix in https://github.com/hyperledger/firefly/pull/261
• Do not allow UUIDs to be used as names by @awrichar in https://github.com/hyperledger/firefly/pull/262
• Fix logic for transfer+message with waitConfirm=true by @awrichar in https://github.com/hyperledger/firefly/pull/258
• Do not use tokenIndex in E2E test for fungible tokens by @awrichar in https://github.com/hyperledger/firefly/pull/264
• Use firefly_e2e instead of firefly-e2e for container names by @awrichar in https://github.com/hyperledger/firefly/pull/266
• Adjust version for firefly-tokens-erc1155 by @awrichar in https://github.com/hyperledger/firefly/pull/267
• Allow nested RunAsGroup calls by @awrichar in https://github.com/hyperledger/firefly/pull/270
• Split asset manager into multiple files by @awrichar in https://github.com/hyperledger/firefly/pull/268
• New GET routes for tokens by @awrichar in https://github.com/hyperledger/firefly/pull/275
• Add extra columns to token tables for UI support by @awrichar in https://github.com/hyperledger/firefly/pull/276
• Additional E2E coverage for tokens by @awrichar in https://github.com/hyperledger/firefly/pull/274
• introduce FFTime.Time() by @shorsher in https://github.com/hyperledger/firefly/pull/277
• pools-by-connector Add connector field to TokenPoolQueryFactory by @eberger727 in https://github.com/hyperledger/firefly/pull/280
• tokens-by-id getTokenPoolByNameOrID() and getTokenTransfersByID() by @eberger727 in https://github.com/hyperledger/firefly/pull/278
• Update GitHub actions to build every merge to main by @nguyer in https://github.com/hyperledger/firefly/pull/286
• Group token database calls into RunAsGroup wherever possible by @awrichar in https://github.com/hyperledger/firefly/pull/273
• Fix PSQL migration with invalid AUTOINCREMENT by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/289
• Add topic+tag index to messages by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/290
• Add namespace field to token accounts and transfers by @awrichar in https://github.com/hyperledger/firefly/pull/287
• Fix duplicate db migration 00037 by @awrichar in https://github.com/hyperledger/firefly/pull/295
• Update DX dependency, and go deps including bluemonday for CVE-2021-42576 by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/285
• Update docs and add new guides by @nguyer in https://github.com/hyperledger/firefly/pull/284
• Collapse message bools into a new "state" field by @awrichar in https://github.com/hyperledger/firefly/pull/296
• Run E2E tests with matrix including fabric by @nguyer in https://github.com/hyperledger/firefly/pull/242
• Use single quotes for strings in postgres migration by @awrichar in https://github.com/hyperledger/firefly/pull/302
• Small doc updates by @awrichar in https://github.com/hyperledger/firefly/pull/301
• Replace BeforeSend callback with a Prepare method by @awrichar in https://github.com/hyperledger/firefly/pull/283
• remove-member-field Removing member field from operations table by @eberger727 in https://github.com/hyperledger/firefly/pull/300
• Add ?fetchdata on messages collection to include data, and make consistent with get by ID by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/299
• Allow did:firefly:org/xyz prefix on group input by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/304
• Add scheduled E2E test using latest services by @nguyer in https://github.com/hyperledger/firefly/pull/292
• Add check before writing to websocket channel by @nguyer in https://github.com/hyperledger/firefly/pull/298
• Add jobs for database migration and auto-registration by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/294
• Update assertion on unit test to pass on Go 1.17 by @nguyer in https://github.com/hyperledger/firefly/pull/303
• Only send transfer message if token transfer is successful by @awrichar in https://github.com/hyperledger/firefly/pull/297
• Consume websocket events in "strong datatype" tests by @awrichar in https://github.com/hyperledger/firefly/pull/309
• POST /tokens/<mint | burn | transfers | pools> by @eberger727 in https://github.com/hyperledger/firefly/pull/307
• Split the notions of "token balances" and "token accounts" by @awrichar in https://github.com/hyperledger/firefly/pull/311
• Always pass key and message hash to fftokens connector by @awrichar in https://github.com/hyperledger/firefly/pull/305
• Use WriteByte instead of WriteRune when possible by @awrichar in https://github.com/hyperledger/firefly/pull/314
• Additional cleanup to support tokens UI by @awrichar in https://github.com/hyperledger/firefly/pull/313
• Prometheus Metrics for Mux Router by @hfuss in https://github.com/hyperledger/firefly/pull/321
• Allow specifying pool by name or ID for transfer requests by @awrichar in https://github.com/hyperledger/firefly/pull/320
• Fix COUNT for SQL queries that use DISTINCT by @awrichar in https://github.com/hyperledger/firefly/pull/319
• add build badge by @shorsher in https://github.com/hyperledger/firefly/pull/327
• Replace token pool "validate tx" logic stubs with a new "activate" action by @awrichar in https://github.com/hyperledger/firefly/pull/317
• Upsert optimization by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/325
• Change JSONB columns to BYTEA - issue : Remove use of JSONB columns #324 by @hypefi in https://github.com/hyperledger/firefly/pull/330
• bump UI version to 0.4.1 by @shorsher in https://github.com/hyperledger/firefly/pull/332
• Update dependencies for v0.11.0 release by @nguyer in https://github.com/hyperledger/firefly/pull/333

New Contributors

• @eberger727 made their first contribution in https://github.com/hyperledger/firefly/pull/280
• @hypefi made their first contribution in https://github.com/hyperledger/firefly/pull/330

Full Changelog: https://github.com/hyperledger/firefly/compare/v0.10.1...v0.11.0

What's Changed

• Move e2e to new routes, and add private/broadcast strong datatype tests by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/260
• Added more tests to the Fabric plugin for 100% coverage by @jimthematrix in https://github.com/hyperledger/firefly/pull/261
• Do not allow UUIDs to be used as names by @awrichar in https://github.com/hyperledger/firefly/pull/262
• Fix logic for transfer+message with waitConfirm=true by @awrichar in https://github.com/hyperledger/firefly/pull/258
• Do not use tokenIndex in E2E test for fungible tokens by @awrichar in https://github.com/hyperledger/firefly/pull/264
• Use firefly_e2e instead of firefly-e2e for container names by @awrichar in https://github.com/hyperledger/firefly/pull/266
• Adjust version for firefly-tokens-erc1155 by @awrichar in https://github.com/hyperledger/firefly/pull/267
• Allow nested RunAsGroup calls by @awrichar in https://github.com/hyperledger/firefly/pull/270
• Split asset manager into multiple files by @awrichar in https://github.com/hyperledger/firefly/pull/268
• New GET routes for tokens by @awrichar in https://github.com/hyperledger/firefly/pull/275
• Add extra columns to token tables for UI support by @awrichar in https://github.com/hyperledger/firefly/pull/276
• Additional E2E coverage for tokens by @awrichar in https://github.com/hyperledger/firefly/pull/274
• introduce FFTime.Time() by @shorsher in https://github.com/hyperledger/firefly/pull/277
• pools-by-connector Add connector field to TokenPoolQueryFactory by @eberger727 in https://github.com/hyperledger/firefly/pull/280
• tokens-by-id getTokenPoolByNameOrID() and getTokenTransfersByID() by @eberger727 in https://github.com/hyperledger/firefly/pull/278

New Contributors

• @eberger727 made their first contribution in https://github.com/hyperledger/firefly/pull/280

Full Changelog: https://github.com/hyperledger/firefly/compare/v0.10.1...v0.10.1-20211025-01

What's Changed

• Fabric plugin by @jimthematrix in https://github.com/hyperledger/firefly/pull/184

Full Changelog: https://github.com/hyperledger/firefly/compare/v0.9.0...v0.10.0

What's Changed

• Reduce I/O load of test runs by using memory DB by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/253
• Update E2E script to use manifest file by @nguyer in https://github.com/hyperledger/firefly/pull/251
• Clean up Gen 1 "KAT" implementation, and update README by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/243
• Allow sending a message with a token transfer by @awrichar in https://github.com/hyperledger/firefly/pull/245
• Re-subscribe if the instance path changes by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/256
• Use a single mutex, as there is a single keys map by @peterbroadhurst in https://github.com/hyperledger/firefly/pull/255

Full Changelog: https://github.com/hyperledger/firefly/compare/v0.10.0...v0.10.1