Skip to content

Release 4.0.0
Compare
Choose a tag to compare
@cheeseandcereal cheeseandcereal released this 24 Sep 00:07
· 17 commits to production since this release
v4.0.0
7e36ff6
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.

This release supports Dragonchain's accompanying 4.0.0 release.

Because Dragonchain has a breaking change to replace its indexing solution, this is also a breaking SDK change for queries and custom indexing.

The following are worth noting when transitioning from 3.X.X to 4.X.X:

  • Custom indexes have changed for a new redisearch schema. Transaction types can no longer be updated, and custom indexes must be provided upfront when creating a transaction type or smart contract. If updating is desired, simply delete and recreate the relevant transaction type/smart contract with the new desired custom indexes.
  • A transaction type's indexes are now removed when the transaction type is deleted. You can no longer query for transactions from a deleted transaction type (or smart contract). (The transactions still exist and can be retrieved directly by transaction id, they simply can't be searched with a query)
  • Querying blocks and transactions are completely different, and now use Redisearch queries. Check their client functions for argument reference. Note the response schema of queries remain unchanged.
  • Smart contract querying has been removed, and instead replaced with a generic listSmartContracts which simply returns all contracts.

Check the docs for more details on migrating from v3 to v4.

Changelog

  • Feature:
    • Support new query endpoints/parameters for redisearch replacement on dragonchain
    • Support adding custom indexes for smart contracts on creation
    • Support optionally fetching ids only (not entire documents) for querying
    • Support list smart contracts
    • Support disable schedule for updateSmartContract
    • Support new get logs endpoint
  • Documentation:
    • Added docs for migrating from v3 to v4
  • CICD:
    • Add NodeJS 12 to PR checks
  • Packaging:
    • Remove some unnecessary files from the packaged release
  • Bug Fix
    • Increase precision on timestamp sent to Dragonchain to prevent replay attack error for subsequent requests
Assets 2
Loading