v1.5.3

Description

BREAKING CONFIG CHANGE

v1.5.2 introduced a new config, REDIS_OPTIONS, that could be used alongside REDIS_URL. To eliminate confusion, now REDIS_OPTIONS and REDIS_URL are mutually exclusive; that is, both are capable of specifying additional Redis options, but only one or the other may be used (and at least one must be used).

• REDIS_URL may specify additional options as URL query parameters, ie: redis://localhost:6379?commandTimeout=10000
• REDIS_OPTIONS takes the form of a JSON string: '{"host": "localhost", "port": 6379, "commandTimeout": 10000}'

SSL/TLS Notes for Redis

To enable SSL/TLS for Redis connections:

• WIth REDIS_URL, use rediss:// as the protocol
• WIth REDIS_OPTIONS, specify "tls": true as one of the properties

What's Changed

• fix: remove redundant Quick Start entry from documentation summary by @mattheworris in #791
• Consolidate Redis options and handle ssl by @JoeCap08055 in #792
• fix: use block number, not hash, in mortality era by @JoeCap08055 in #795
• fix: temporarily bump Redis commandTimeout to 25s by @JoeCap08055 in #796
• fix: add missing directories to 'common' pipeline determination flows by @JoeCap08055 in #797

Full Changelog: v1.5.2...v1.5.3

v1.5.2

What's Changed

• fix: add configurable Redis options and default commandTimeout by @JoeCap08055 in #785

Full Changelog: v1.5.1...v1.5.2

v1.5.1

What's Changed

• feat: log the failed route when a timeout error occurs by @JoeCap08055 in #769
• fix: increase default incoming request api timeout to 30s by @JoeCap08055 in #771
• Fix/account load test issues by @JoeCap08055 in #776

Full Changelog: v1.5.0...v1.5.1

v1.5.0

What's Changed

• Updated OpenAPI specs for both Gateway endpoints as well as webhook APIs. Of particular note:
• In content-publishing-api service, new POST /v2/assets/upload endpoint
  • Same request payload; different response payload
  • Streams asset uploads directly to IPFS -- successful response guarantees asset is pinned in IPFS
• Configuration changes:
  • BREAKING CHANGE The IPFS_ENDPOINT env var now must include the path to the API in addition to the host:port. So:
    http://ipfs.io:5001
    becomes
    http://ipfs.io:5001/api/v0
  • The SIWF_V2_URI_VALIDATION configuration variable can now accept either a single URI string or a JSON array of URI strings
    Example: SIWF_V2_URI_VALIDATION='["http://example.com","http://otherdomain.com"]'
  • Logging changes:
    • DEBUG=true now does not include the 'verbose' log level. To enable verbose logging, you have the following options:
      • VERBOSE_LOGGING=true (enables 'verbose')
      • DEBUG=verbose (enables both 'debug' and 'verbose')
• Performance enhancements for submitting transactions to the blockchain (eliminated multiple RPC call overhead)
• Duplicate nonce errors will now trigger a retry of a transaction submission
• Various bug fixes, logging cleanup

CHANGELOG

• fix: revert DSNP content hash validation changes, update tests by @JoeCap08055 in #722
• fix: update logic for change in property name by @JoeCap08055 in #724
• fix: address race condition between asset publishing and batch announcement by @JoeCap08055 in #728
• docs: update links in README and SSO documentation for accuracy by @mattheworris in #732
• fix: null value in generated SwaggerUI by @JoeCap08055 in #733
• Update the prerequisite section to include Frequency Access Testnet f… by @emresurmeli in #736
• fix: update package dependencies to latest versions by @mattheworris in #738
• feat: add kubo-rpc-client, specify timeout for all http requests by @JoeCap08055 in #739
• lock redis version to v7.0 by @demisx in #718
• fix: minor miscellaneous updates by @mattheworris in #743
• feat: update documentation structure, add troubleshooting section by @mattheworris in #746
• Feat/stream files to ipfs by @JoeCap08055 in #747
• fix: do not queue multiple jobs when same SIWF payload is posted multiple times by @JoeCap08055 in #752
• Fix type generation from OpenAPI spec by @JoeCap08055 in #754
• fix: change shutdown timer log level and exit code by @mattheworris in #759
• feat: eliminate some chain RPC calls in favor of cached values by @JoeCap08055 in #758
• feat: implement dynamic log level configuration across applications by @mattheworris in #761
• feat: add mdbook-mermaid plugin and version check by @mattheworris in #757
• feat: allow specifying a list of domains for validating SIWFv2 login requests by @JoeCap08055 in #764
• feat: enhance content-watcher logging by @mattheworris in #765
• feat: allow task retry on nonce conflict error by @JoeCap08055 in #766
• fix: add missing getLogLevels call, deprecate v1 endpoint by @JoeCap08055 in #767

New Contributors

• @emresurmeli made their first contribution in #736

Full Changelog: v1.4.1...v1.5.0

v1.5.0-beta1

What's Changed

• fix: revert DSNP content hash validation changes, update tests by @JoeCap08055 in #722
• fix: update logic for change in property name by @JoeCap08055 in #724
• fix: address race condition between asset publishing and batch announcement by @JoeCap08055 in #728
• docs: update links in README and SSO documentation for accuracy by @mattheworris in #732
• fix: null value in generated SwaggerUI by @JoeCap08055 in #733
• Update the prerequisite section to include Frequency Access Testnet f… by @emresurmeli in #736
• fix: update package dependencies to latest versions by @mattheworris in #738
• feat: add kubo-rpc-client, specify timeout for all http requests by @JoeCap08055 in #739
• lock redis version to v7.0 by @demisx in #718
• fix: minor miscellaneous updates by @mattheworris in #743
• feat: update documentation structure, add troubleshooting section by @mattheworris in #746
• Feat/stream files to ipfs by @JoeCap08055 in #747
• fix: do not queue multiple jobs when same SIWF payload is posted multiple times by @JoeCap08055 in #752
• Fix type generation from OpenAPI spec by @JoeCap08055 in #754
• fix: change shutdown timer log level and exit code by @mattheworris in #759
• feat: eliminate some chain RPC calls in favor of cached values by @JoeCap08055 in #758
• feat: implement dynamic log level configuration across applications by @mattheworris in #761

New Contributors

• @emresurmeli made their first contribution in #736

Full Changelog: v1.4.1...v1.5.0-beta1

content-publishing-v1.4.2-beta1

What's Changed

• fix: revert DSNP content hash validation changes, update tests by @JoeCap08055 in #722
• fix: update logic for change in property name by @JoeCap08055 in #724
• fix: address race condition between asset publishing and batch announcement by @JoeCap08055 in #728

Full Changelog: v1.4.1...content-publishing-v1.4.2-beta1

v1.4.1

What's Changed

• feat: add handle validation using blockchain service in HandlesControllerV1 and AccountsControllerV2 by @mattheworris in #677
• fix: use correct test for determine if jobs should run for matrix items by @JoeCap08055 in #681
• feat: add docker-compose configurations for Developer track by @mattheworris in #682
• Check capacity enough for tx by @saraswatpuneet in #673
• Developer Docs updates for docker swarm deployment by @mattheworris in #683
• rename Gateway/Frequency Gateway -> Frequency Developer Gateway by @saraswatpuneet in #686
• Update dependency by @saraswatpuneet in #671
• Force mdbook to use v0.4.40 by @wilwade in #688
• Add SIWF button to the example by @wesbiggs in #684
• Update Docs Theme by @wilwade in #691
• Docs: Fix some heading margins by @wilwade in #692
• Bug fixes and Guides Landing Page by @wilwade in #694
• Fix warning overflow by @shannonwells in #695
• Added spellcheck for markdown files by @wesbiggs in #696
• Fix the link and order of the Getting Started Guides by @wilwade in #698
• correct the name of docker network to match docker compose by @demisx in #699
• update docs to correct dependencies on IPFS by @demisx in #706
• remove CHAIN_ENVIRONMENT env var by @demisx in #707
• 713 content publishing support posting existing at protocol batch content notifications to frequency using a non dsnp schema on frequency by @JoeCap08055 in #717
• feat: add support for publishing batch announcements for non-DSNP schemas by @JoeCap08055 in #720

New Contributors

• @wesbiggs made their first contribution in #684
• @demisx made their first contribution in #699

Full Changelog: v1.4.0...v1.4.1

v1.4.0

What's Changed

Account Service is updated to use Sign In With Frequency (SIWF) V2 v2.1.0, which has breaking changes to the SIWF interface:

SIWF_V2_DOMAIN is changed to SIWF_V2_URI_VALIDATION and it must match the domain of the URI in the SIWF message. Please see SIWF for more details.

loginMsgDomain is changed to loginMsgURIValidation this affects the following functions:

• getPayload

Breaking Changes

• Account Service SIWF v2 URI Validation by @mattheworris in #669

Other Changes

• Monitoring Gateway by @saraswatpuneet in #667
• Docs: Minor updates and fill by @wilwade in #668

Full Changelog: v1.3.0...v1.4.0

v1.3.0

What's Changed

Mostly hardening, resiliency & input sanitization fixes in this release.
One significant change: the content-watcher endpoint PUT /v1/webhooks has changed to POST /v1/webhooks. We opted not to change the API version since there have been no users yet consuming the 'content-watcher' service.

List of Changes

• account-service: some fixes by @aramikm in #624
• Document improvements from feedback by @saraswatpuneet in #622
• Update account.openapi.json for SIWF v2 POST by @wilwade in #626
• graph-service: added connection type to request by @aramikm in #628
• homogenize docs across Run by @saraswatpuneet in #632
• chore(docs): update account service by @enddynayn in #633
• chore(docs): update graph service by @enddynayn in #638
• chore(docs): update content-publisher by @enddynayn in #641
• update start/stop to use imported bash_functions script by @shannonwells in #619
• content-watcher: some fixes by @aramikm in #645
• chore(docs): update content-watcher docs by @enddynayn in #644
• chore(docs): update content-watcher by @enddynayn in #646
• Add DockerHub Descriptions for the gateway containers by @mattheworris in #629
• Docker: add darwin/arm and linux/arm for target platforms by @saraswatpuneet in #639
• fix: make sure correct tag is used when release workflow is triggered manually by @JoeCap08055 in #648
• fix: do not update DockerHub image description for test runs by @JoeCap08055 in #649
• fix: re-word summary for content-watcher webhook endpoint by @JoeCap08055 in #651
• fix: change end-of-chain scan log message to debug instead of error by @JoeCap08055 in #652
• Chore/handle chain rpc node disconnect by @JoeCap08055 in #642
• fix: was monitoring incorrect event name for msa.MsaRetired by @JoeCap08055 in #650
• set config/docs for scalability by @saraswatpuneet in #647
• fix: make all docs consistent with version prefix and grouping in sidebar by @JoeCap08055 in #659
• update graph-sdk dependency by @aramikm in #653
• Add SIWF SSO docs by @wilwade in #654
• upgrade nestjs dependencies by @aramikm in #656
• fix: make account service scanner the same as graph by @mattheworris in #661
• fix: use stock Frequency node image by @JoeCap08055 in #663
• fix: healthcheck specification in docker-compose file by @JoeCap08055 in #665
• feat: add webhook support for retireMsa, revokeDelegation by @JoeCap08055 in #664

New Contributors

• @shannonwells made their first contribution in #619

Full Changelog: v1.2.0...v1.3.0

v1.2.1-arm-test.4

Check arm releases on branch