This changelog is a work in progress and may contain notes for versions which have not actually been released. Check the Releases page to see full release notes and more information about the latest released versions.
Note: This release will require wiping your Mesh's DB before upgrading. The DB location defaults to
Renamed env config from
network is a misnomer here and what we actually care about is the
chainID. Most chains have the same id for their p2p network and chain. From the ones we support, the only outlier is Ganache, for which you will now need to supply
1337 instead of
50 (Learn more: https://medium.com/@pedrouid/chainid-vs-networkid-how-do-they-differ-on-ethereum-eec2ed41635b) (#485)
Rejected order code
OrderForIncorrectNetwork has been changed to
RPC_PORT environment variable. The new
RPC_ADDR environment variable allows specifying both the interface and port (487).
EXPIRED event such that it is emitted when an order is expired according to the latest block timestamp, not anymore based on UTC time. (#490)
EXPIRATION_BUFFER_SECONDS env config since we no longer compute order expiration using UTC time. (#490)
Implemented a new strategy for limiting the amount of database storage used by Mesh and removing orders when the database is full. This strategy involves a dynamically adjusting maximum expiration time. When the database is full, Mesh will enforce a maximum expiration time for all incoming orders and remove any existing orders with an expiration time too far in the future. If conditions change and there is enough space in the database again, the max expiration time will slowly increase. This is a short term solution which solves the immediate issue of finite storage capacities and does a decent job of protecting against spam. We expect to improve and possibly replace it in the future. See #450 for more details.
Added support for a new feature called "order pinning" (#474). Pinned orders will not be affected by any DDoS prevention or incentive mechanisms (including the new dynamic max expiration time feature) and will always stay in storage until they are no longer fillable. By default, all orders which are submitted via either the JSON-RPC API or the
addOrdersAsync function in the TypeScript bindings will be pinned.
Re-enabled bandwidth-based peer banning with a workaround to deal with erroneous spikes #478.
UNEXPIRED order event kind which is emitted for orders that were previously considered expired but due to a block-reorg causing the latest block timestamp to be earlier than the previous latest block timestamp, are no longer expired. (#490)
Added support for decoding Axie Infinity
Approve ERC721 events which differ from the ERC721 standard. (#494)
Improved the aggressiveness at which we permanently delete orders that have been flagged for removal. Previously we would wait for the cleanup job to handle this (once an hour), but that meant many removed orders would accumulate. We now prune them every 5 minutes. (#471)
Fixed a bug in the Go RPC client which resulted in errors when receving order events with at least one contract event (#496).
getStats RPC endpoint now includes a new field which accounts for the number of orders that have been marked as "removed" but not yet permanently deleted (#461).
Improved historical order sharing using round-robin algorithm instead of random selection (#454). This will reduce the warm-up time for receiving existing orders when first joining the network.
Added ERC1155 assetData support (#453). This includes order watching and order events for orders involving ERC1155 tokens.
Added Ability to specify custom contract addresses via the
CUSTOM_ADDRESSES environment variable or the
customAddresses field in the TypeScript bindings (#451).
Temporarily disabled bandwidth-based peer banning (#448). A bug in libp2p was occasionally causing observed bandwidth usage to spike to unrealistic levels, which can result in peers being erroneously banned. We decided to temporarily stop banning peers while we're working with the libp2p team to resolve the issue.
txHashes key in the
OrderEvents emitted from the
orders JSON-RPC subscription and replaced it with
contractEvents, an array of decoded order-relevant contract events. Parsing these events allows callers to find every discrete order fill/cancel event. (#420)
Kind key in
EndState to better elucidate that it represents the aggregate change to the orders state since it was last re-validated. As an end state, it does not capture any possible intermediate states the order might have been in since the last re-validation. Intermediate states can be inferred from the
contractEvents included (#420)
Removed the max expiration limit for orders. The only remaining expiration constraint is that the unix timestamp does not overflow int64 (i.e., is not larger than 9223372036854775807). (#400)
Fixed bug where we weren't updating an orders
fillableTakerAssetAmount in the DB when orders were being partially filled or when their fillability increased due to a block re-org. (#439)
verbosity field optional in the TypeScript
Config type. (#410)
Fixed issue where we weren't re-validating orders potentially impacted by the balance increase of the recipient of an ERC20 or ERC721 transfer. (#416)
Fixed a DB transaction deadlock accidentally introduced in the v4.0.0-beta release. (#403)
Renamed the environment variable
P2P_TCP_PORT (#366). This makes it possible to configure Mesh to use both the TCP and Websocket transports by listening on different ports.
Added ability to use custom bootstrap list via the
BOOTSTRAP_LIST environment variable (#374). Typically this should only be used for testing/debugging.
Order hash calculations are now cached, which slightly improves performance (#365).
BlockWatch so that it can be used without using
LevelDB for Ethereum block storage. (#355)
Fixed two related bugs: One where order expiration events would be emitted multiple times and another that meant subsequent fill/cancel events for orders deemed expired were not emitted. Fills/cancels for expired orders will continue to be emitted if they occur within ~4 mins (i.e. 20 blocks) of the expiration (#385).
Fixed a data race-condition in OrderWatcher that could have caused order collection updates to be overwritten in the DB. (#386)
Fixed a bug where
lastUpdated were not always being properly updated in the DB. (#386)
Fixed some issues with key prefixes for certain types not being applied correctly to logs (#375).
Fixed an issue where order hashes were not being correctly logged (#368).
Mesh will now properly shut down if the database is unexpectedly closed (#370).
Fixed bug which resulted in orders that were close to expiring being re-added and removed multiple times, resulting in multiple ADDED and EXPIRED events for the same order (#352).
Modified Mesh's validation logic to reject and consider invalid any partially fillable orders. While this is
technically a breaking change, partially fillable orders are rare in the wild and we don't expect this will
affect many users. (#333)
GetStatsAsync method to
getStatsAsync in TS client
De-dup order submitted via the JSON-RPC method
mesh_addOrders before performing validation (#331)
"declaration": true, to TS client's
tsconfig.json so that downstream projects can use it's TS typings. (#325)
mesh_addOrders treats orders that are already stored on the Mesh node. Previously, they would be rejected with code
OrderAlreadyStored. Now, if the order is stored and fillable, it will be accepted. If it is stored but unfillable, it will be rejected with
OrderAlreadyStoredAndUnfillable. We additionally added a
isNew property to the accepted orderInfos returned, so that callers can discern which orders Mesh already knew about. (#316)
Added backup bootstrap nodes provided by the libp2p community
Reduced AdvertiseBootDelay for bootstrap nodes
Implemented a check that will alerts you when switching to a different Ethereum network ID. (#301) -- special thanks to @hrharder!
Made environment variable parsing more generous by automatically removing quotes if needed (#306)
Increased robustness by removing panics and failing more gracefully (#312)
RPC server is now started while block event backfilling is happening under the hood instead of waiting for it to complete (#318)
mesh_getStats endpoint which returns a host of useful information about the state of the Mesh node (e.g., number of fillable order stored, number of peers, peerID, etc...) (#322)
Log messages are no longer incorrectly fired when receiving orders which have already been seen (#286)
Fixed a bug where Mesh was still running after the database was closed (#300)
Handled Parity "unknown block" error gracefully like we do Geth's (#285)
This release fixes several bugs:
Uninitialized TxHashes map & accidental inclusion of null address txHash in order events (#280)
Concurrent read/write issue in OrderWatcher's EventDecoder (#278)
Non-unique logging keys causing Elastic Search indexing issues (#275)
It also includes a reduction in the delay before which bootstrap nodes advertise themselves as relays from 15mins to 30sec.
This version introduces a temporary hack in order to help some Mesh nodes find their public IP address under certain circumstances.
This release fixes a bug in how AutoNAT and AutoRelay services were discovered.
This release fixes some networking related issues with our bootstrap nodes.
Bootstrap nodes now advertise the correct public IP address.
Bootstrap nodes now also operate as a relay.
These fixes will help smooth out any issues with peer discovery.
This release fixes a few minor bugs and includes additional documentation.
Set a custom protocol ID for our DHT in order to separate it from the default IPFS DHT.
Fixed a bug in the getOrders JSON-RPC endpoint where fillableTakerAssetAmount was sometimes being encoded as numbers instead of strings.
Converted addresses to all lowercase (non-checksummed) in the JSON-RPC API.
Added a guide for running a Mesh node with telemetry-enabled.
This release adds AutoNAT support for our bootstrap nodes. This enables peers who are behind NATs to find each and connect to each other (in most cases).
In addition, this release includes some changes to default network timeouts and documentation improvements.
This is the initial beta release for 0x Mesh!
This release supports the following features:
Automatic peer discovery via a DHT.
A JSON-RPC endpoint for interacting with your Mesh node. It includes support for adding new orders and subscribing to order updates.
Efficient order validation and order watching under the hood. You will get notified quickly when orders are expired, canceled, or filled.
Basic limitations on the size and types of messages sent by peers. Peers that send malformed messages or messages that are too big will be dropped.
In addition to improving stability and scalability we plan to release many more important features in the near future. Check out https://github.com/0xProject/0x-mesh/issues for more information about what we are working on.