Skip to content

Change Log

All notable changes to this project will be documented in this file. This change log follows the conventions of keepachangelog.com.

2.3.2

Added

  • none

Changed

  • Change default gasPrice from 1e6 to `1e9z
  • Fix AEPP example app
  • Force image pull before builds

### Removed - none

### Breaking Changes - none

### Notes and known Issues - none

2.3.1

Added

  • Oracle fee calculation
  • getAccountNonce function to tx stamp

Changed

  • Change FEE_BYTE_SIZE from 1 to 8 bytes in fee calculation
  • Improve error handling in tx builder

### Removed - none

### Breaking Changes - none

### Notes and known Issues - none

2.3.0

Added

  • Minerva comparability
  • Add Mnemonic wallet implementation es/utils/hd-wallet

### Changed - Change Channel legacy API to JSON RPC - Change default gasPrice to 1e6 - Change minFee calculation, multiply min fee by 1e9

### Removed - none

### Breaking Changes - none

### Notes and known Issues - Change supported node version range to 1.4.0 <= version < 3.0.0 - This release contain changes from: 2.3.0-next, 2.2.1-next, 2.1.1-0.1.0-next, 2.1.0

## 2.3.0-next

Added

  • Add channel withdraw and deposit methods

### Changed - Change default gasPrice in Contract stamp and Tx stamp to 1e9 - Fix contract tx fee calculation - Refactor error handling in sendTransaction function - Change default gasPrice to 1e9 - Change Fee byte_size to 1

### Removed - none

### Breaking Changes - none

### Notes and known Issues - none

2.2.1-next

Added

  • Add deserialization schema for Channel transactions(channelCreate, channelCloseMutual, channelDeposit, channelWithdraw, channelSettle)
  • Add rawTx and verifyTx to error from poll function(when you wait for transaction will mined)

Changed

  • Change Channel legacy API to JSON RPC
  • Change minFee calculation, multiply min fee by 10^9

Removed

  • none

Breaking Changes

  • none

Notes and known Issues

  • Depend on bip39 from npm instead of git repo

2.1.1-0.1.0-next

Added

  • none

Changed

  • Fix linter errors

Removed

  • none

Breaking Changes

  • none

Notes and known Issues

  • none

2.1.0

Added

  • Minerva comparability
  • Add Mnemonic wallet implementation es/utils/hd-wallet

Changed

  • Change supported node version range to 1.4.0 <= version < 3.0.0

Removed

  • none

Breaking Changes

  • none

Notes and known Issues

  • Broken build(linter errors) - fixed in next release

2.0.0

Added

  • Add unpackedTx, txType and signature to validate transaction function
  • Add top param to contract static call(dry-run)
  • Add errors handling for dry-run
  • Add keystore docs
  • Add verify options to send function which verify tx before broadcasting and throw error if tx is invalid
  • Add dryRun to RPC methods
  • Add Oracle transaction creation to Aepp rpc
  • Add tx builder docs
  • Add doc's for utils/bytes and tx builder schema

Changed

  • refactor calculateFee function in TxBuilder(use BigNumber)
  • RpcServer: Avoid storing of window in instance properties
  • Disable balance formatting by default
  • Extend response of Oracle, Aens, Contrat with rawTx
  • Change response of send function now it's and object with transaction data(hash, rawTxHash, ...)
  • Move verification of transaction to chain stamp
  • Move Contract and Oracle API wrapper's to Chain stamp
  • Rename epoch in CHANGELOG, README, HACKING
  • Retrieve node version from /api
  • Fix unpack tx example in bin/aecrypto.js

Removed

  • Remove unused function's from crypto.js

Breaking Changes

  • Remove old transaction builder es/tx/js.js (Please use es/tx/builder instead)
  • Rename es/epoch.js to es/node.js
  • Rename Oracle, Contract, Chain API wrapper files from epoch to node
  • Rename Contract api wrapper method's

Notes and known Issues

  • none

1.3.2

Added

  • Add destroyInstance function to Ae stamp which remove all listeners for RPC event's
  • Add docs for TransactionValidator and TxBuilder stamp's
  • Add TxBuilderHelper to bundle

Changed

  • Adjust doc's for Contract and Aens stamp's
  • Fix decoding of address from contract call
  • Contract call static now using dry-run API
  • Improve test's for Transaction verification

Removed

  • none

Breaking Changes

  • none

Notes and known Issues

  • none

1.3.1

Changed

  • Remove KeyStore from bundle due to build issue(for now you can export it only using tree-shaking import * as Keystore from '@aeternity/aepp-sdk/utils/keystore')

1.3.0

Added

  • Add support for State Channels
  • New transaction builder going through schema(build, unpack)
  • Add new stamp TransactionValidator which can verify your transaction

Changed

  • Rename epoch to aeternity node(docker configs, some docs)
  • Use new tx builder in TX stamp
  • Set default values for amount and deposit to 0 for contract transaction
  • Improve RPC server

Removed

  • none

Breaking Changes

  • none

Notes and known Issues

  • Old transaction builder es/tx/js.js will be removed in next major release.

1.2.1

Added

  • amount formatter
  • amount format balance client.balance('AK_PUBLICKEY', { format: true })
  • Oracle and Contracts API to Aepp stamp

Changed

  • Use prepare instead of postinstall-build (thanks @davidyuk)
  • Fix Import RLP package (thanks @davidyuk)
  • Fix for NetworkId propagation and override
  • TxJS is not a stamp anymore, and instead: it exports helper functions
  • Refreshed Docs: README.md + docs/usage.md

Removed

  • TxJs stamp (not a stamp anymore)

Breaking Changes

  • TxJs stamp (not a stamp anymore)
  • balance now answer a formatted string composed of AMOUNT + ' ' + unit (eg. 10 exa for 10 AE)

Notes and known Issues

  • 10 exa should be 10 ae
  • format shouldn't be a flag, but a request for unit eg. { format:ae}

1.1.2

Added

  • isAddressValid check

Changed

  • Compatibility with Node >= 1.0.0 and <= 1.1.0
  • Fixed networkId propagation (and overriding on init of Flavors)
  • Tx Fee formulas
  • Fixed encodeBase58Check by feeding Buffered input

Removed

  • none

Breaking Changes

  • none

Notes and known Issues

  • none

1.1.1

Added

  • none

Changed

  • Fix Testing
  • Added a command to remove images after CI testing
  • Fixed Oracle error for Wallet flavor

Removed

  • none

Breaking Changes

  • none

Notes and known Issues

  • none

1.1.0

Added

  • Oracles functionality and flavor
  • Simple example of aepp-in-aepp (see /examples folder)

Changed

  • Fixed issue with big numbers and TX

Removed

  • none

Breaking Changes

  • none

Notes and known Issues

  • none

1.0.1

Added

  • ability to support Node range(s) using semver package (see https://www.npmjs.com/package/semver#ranges)

Changed

  • Support for Node >= 1.0.0 and < 2.0.0

Removed

  • none

Breaking Changes

  • none

Notes and known Issues

  • none

1.0.0

Added

  • Contract native Transactions

Changed

  • Rolled back to bignumbers.js for easier fix with axios.get/post

Removed

  • Support for Node < 1.0.0

Breaking Changes

Notes and known Issues

  • State Channels have been excluded for problems with CI, will be included in next release

0.25.0-0.1.1

Added

Changed

  • Change bignumbers.js with bn.js due to binding errors in browser's package

Removed

Breaking Changes

Notes and known Issues

0.25.0-0.1.0

Added

  • Parsing of fee using bignum.js
  • Add networkId as param to Account flavor(default: ae_mainnet)
  • Implement native build of AENS transaction.

Changed

- Update keystore for new requirements

Removed

Breaking Changes

  • Use NETWORK_ID for signing (see here)
  • Keystore format changes

Notes and known Issues

  • none

0.25.0-0.1.0-next

Added

  • Contract type checked call (Ability to call contract using contract address)

Changed

  • Use ES methods instead of Ramda, where possible
  • Fixed keystore by adding a salt param for derivedKey function

Removed

Breaking Changes

  • Aens use domain .test instead of .aet (see here)
  • Use NETWORK_ID for signing (see here)

Notes and known Issues

0.24.0-0.2.0

Added

  • RPC Client improvements
  • (RPC) onContract Guard
  • (AE PROJECT CLI) born

Changed

  • (CLI) New keystore following these specifications: https://www.pivotaltracker.com/n/projects/2124891/stories/155155204
  • (CLI) Host parameter became Url. (-u for hostname, -U for internal)

Breaking Changes

  • The Cli flavor is now Universal
  • the keypair keys changed from { pub, priv } to { publicKey, secretKey } for consistency with other systems using them (eg. AirGap and HD Wallet)

Notes and known Issues

  • CLI and AE PROJECT CLI will move to a separate package

0.24.0-0.1.0

Added

  • Full support of Node-0.24.0
  • (CLI) Develop decode base58 address command in crypto module
  • (CLI) Add nonce param to all tx command's
  • (CLI) Add gas param to deploy and call commands
  • Add ability to create spend transaction natively
  • Implement ethereum keystore using AES-126-CTR and SCRYPT as key derivation function

Changed

  • (CLI) Change --privateKey to flag on ACCOUNT ADDRESS command
  • Change node version in Dockerfile
  • API endpoints to meet new Node specifications
  • Update docco config and change rename package to recursive-rename
  • Improved documentation

Removed

  • Support for < 0.24.0

Notes and known Issues

  • ethereum keystore usage will be removed in the next release
  • CLI will move to a separate package

0.22.0-0.1.0-beta.1

Added

  • Add CLI implementation
  • nameId function for commitment hash calculations

Changed

  • API endpoints to meet new Node specifications
  • Add Nonce calculation on SDK side
  • Add check for MAX_GAS in call and deploy contract
  • change hash prefix separator from $ to _
  • Add keywords ('SDK', 'CLI') to package.json
  • Link aecli to ./bin/aecli.js in package.json (After "npm link" you can use CLI globally)
  • Wait until pre-claim transaction block was mined before send claim transaction
  • Updated webpack, webpack-cli and added new dev deps accordingly
  • Add Node Compatibility Check
  • Add SDK nonce calculations
  • Fixes commitment hash calculations in naming system, to be Hash(nameId(name) + name_salt) instead of Hash(Hash(name + name_salt)).

Removed

  • Support for < 0.22.0

0.18.0-0.1.1

Added

  • Lots of new documentation (prose and API)
  • Fancy badges to README
  • Transitive dev dependencies for standard-loader not covered by pnpm
  • CI Dockerfile to include pnpm
  • Fancy-shmancy diagram in README
  • Generated documentation files since they are linked in static docs

Changed

  • Switch from Yarn to pnpm for building
  • Structure of documentation
  • Generate Markdown from Docco

0.18.0-0.1.0

Added

  • Support for Node 0.18.0 (changed endpoints)
  • Wallet/Aepp RPC support
  • Contract call result decoding support
  • Per-module API documentation (Markdown based on JSDoc)
  • More API documentation (still incomplete)
  • SDK entrypoint factories (in /es/ae/universal.js)

Removed

  • Support for < 0.18.0 (changed endpoints)

Changed

  • Module load path (src -> es)
  • Lower mining rate (5s) in docker-compose

Fixed

  • Symmetric key encryption/decryption

0.15.0-0.1.0

Removed

  • Legacy Swagger file loading
  • Compatibility with < 0.15.0

Fixed

  • Contract unit state initialization
  • Missing required parameter for name transfers (workaround for Swagger file bug)

0.14.0-0.1.0

Added

  • New, opinionated top-level API

Changed

  • Rest of legacy API now uses new API as well
  • Generated API now encapsulated in api object
  • Automatic case conversion for remote parameter names
  • Remaining tests to use new API
  • Adapted new method of obtaining transaction hash, breaks compatibility (see below)

Removed

  • Oracle API (for the time being)
  • Legacy API and tests
  • Compatibility with older versions of Node which provide the transaction hash the old way

Fixed

  • [GH-49]: Handle existing path components correctly

0.13.0-0.1.0

Added

  • This change log file

Changed

  • Switch to curve ed25519 (from secp256k1) to align with Node protocol changes
  • Generate basic API directly from Swagger files, also validate input data
  • Compiled library now self-contained with all dependencies
  • Use Webpack 4 based cross-platform (Node/Web) compilation
  • Package description now reads SDK for the æternity blockchain
  • Authors are now taken from AUTHORS instead of package.json
  • Moved code examples from README to separate file in docs

Removed

  • Defunct scripts; will be brought back later

Fixed

  • More consistent code examples