From 5b423e11b65918b7ad86ce7860639c73dfae23f3 Mon Sep 17 00:00:00 2001 From: Christoph Burgdorf Date: Tue, 3 Mar 2020 15:07:45 +0100 Subject: [PATCH] Compile release notes --- docs/release_notes.rst | 61 ++++++++++++++++++++++++++++++ newsfragments/1196.feature.rst | 2 - newsfragments/1417.bugfix.rst | 1 - newsfragments/1465.feature.rst | 1 - newsfragments/1475.feature.rst | 6 --- newsfragments/1478.feature.rst | 2 - newsfragments/1486.bugfix.rst | 2 - newsfragments/1503.feature.rst | 1 - newsfragments/1510.bugfix.rst | 1 - newsfragments/1524.bugfix.rst | 2 - newsfragments/1543.feature.rst | 2 - newsfragments/1545.bugfix.rst | 4 -- newsfragments/1545.performance.rst | 2 - newsfragments/1548.bugfix.rst | 3 -- newsfragments/1565.feature.rst | 5 --- newsfragments/1567.internal.rst | 1 - newsfragments/908.feature.rst | 3 -- 17 files changed, 61 insertions(+), 38 deletions(-) delete mode 100644 newsfragments/1196.feature.rst delete mode 100644 newsfragments/1417.bugfix.rst delete mode 100644 newsfragments/1465.feature.rst delete mode 100644 newsfragments/1475.feature.rst delete mode 100644 newsfragments/1478.feature.rst delete mode 100644 newsfragments/1486.bugfix.rst delete mode 100644 newsfragments/1503.feature.rst delete mode 100644 newsfragments/1510.bugfix.rst delete mode 100644 newsfragments/1524.bugfix.rst delete mode 100644 newsfragments/1543.feature.rst delete mode 100644 newsfragments/1545.bugfix.rst delete mode 100644 newsfragments/1545.performance.rst delete mode 100644 newsfragments/1548.bugfix.rst delete mode 100644 newsfragments/1565.feature.rst delete mode 100644 newsfragments/1567.internal.rst delete mode 100644 newsfragments/908.feature.rst diff --git a/docs/release_notes.rst b/docs/release_notes.rst index c9e5489daa..a15141d1b5 100644 --- a/docs/release_notes.rst +++ b/docs/release_notes.rst @@ -5,6 +5,67 @@ Trinity is moving fast. Read up on all the latest improvements. .. towncrier release notes start +Trinity 0.1.0-alpha.35 (2020-03-03) +----------------------------------- + +Features +~~~~~~~~ + +- We now "pivot" Beam Sync if we fall too many blocks behind. When a naive (non-pivoting) Beam Sync + falls too far behind the tip of the chain, it can get "stuck" because the trie data is no longer + available from peers. (`#908 `__) +- Add support for networks that run under Clique consensus. + Add support for syncing the Görli network via `--goerli` flag. (`#1196 `__) +- Support ``include_transactions`` param in ``eth_getBlockBy*`` APIs (`#1465 `__) +- Improve error message for when the parameters to JSON-RPC calls are invalid + + Improve error message for ``eth_getWork``, ``eth_submitWork`` and ``eth_submitHashrate`` + APIs which Trinity does not support as it generally does not support mining operations. + + Change ``eth_hashrate`` and ``eth_coinbase`` to also return errors instead of default values. (`#1475 `__) +- Upgrade to py-evm `v0.3.0-alpha.14 + `_ (`#1478 `__) +- Implement ``admin_nodeInfo`` JSON-RPC endpoint (`#1503 `__) +- Implement the ``eth/64`` networking protocol according to + `EIP 2124 `_ (`#1543 `__) +- Add support for Etherscan API keys to continue support for the + ``--beam-from-checkpoint eth://block/byetherscan/latest`` flag now that + Etherscan `has made API keys mandatory `_. + API keys need to be exposed via the ``TRINITY_ETHERSCAN_API_KEY`` + environment variable. (`#1565 `__) + + +Bugfixes +~~~~~~~~ + +- The ``p2p.abc.TransportAPI.close`` and ``p2p.abc.MultiplexerAPI.close`` methods are now coroutines to allow ``p2p.abc.TransportAPI.close()`` to drain the underlying ``StreamWriter`` before closing it, ensuring that any pending messages are written over the socket before closing it. (`#1417 `__) +- Ensure validation errors in components are properly handled + during bootstrap. (`#1486 `__) +- Fix broken API docs on https://trinity-client.readthedocs.io/en/latest/api/ (`#1510 `__) +- :class:`~p2p.exceptions.PeerConnectionLost` was escaping during a ``highest_td_peer`` call, and + crashing whatever called it. The exception is now caught. (`#1524 `__) +- Catch a variety of uncaught exceptions: :class:`asyncio.TimeoutError`, + :class:`~p2p.exceptions.UnknownAPI`, :class:`~p2p.exceptions.PeerConnectionLost`, + OSError, :class:`~eth_utils.exceptions.ValidationError`, :class:`~p2p.exceptions.CorruptTransport`. + Also, prevent AttributeError when printing a :class:`p2p.kademlia.Node` that has no address. (`#1545 `__) +- Catch a :class:`~p2p.exceptions.PeerConnectionLost` raised when: disconnecting from a peer for sending + a malformed message, and another one when finding the fastest peer. Reject handshake attempts when + the IP address is unknown. Catch a :class:`~p2p.exceptions.CorruptTransport`, raised during multiplex. (`#1548 `__) + + +Performance improvements +~~~~~~~~~~~~~~~~~~~~~~~~ + +- Exit a bit more quickly from Beam Sync, by cancelling any hanging requests for state data. This + prevents a 5 second wait and timeout in the :class:`~p2p.service.BaseService`. (`#1545 `__) + + +Internal Changes - for Trinity Contributors +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Less noisy logs when adding peers. Only show INFO logs when you have fewer than 5 peers. (`#1567 `__) + + Trinity 0.1.0-alpha.34 (2019-12-23) ----------------------------------- diff --git a/newsfragments/1196.feature.rst b/newsfragments/1196.feature.rst deleted file mode 100644 index 18dce58f93..0000000000 --- a/newsfragments/1196.feature.rst +++ /dev/null @@ -1,2 +0,0 @@ -Add support for networks that run under Clique consensus. -Add support for syncing the Görli network via `--goerli` flag. \ No newline at end of file diff --git a/newsfragments/1417.bugfix.rst b/newsfragments/1417.bugfix.rst deleted file mode 100644 index 2d1d4cc676..0000000000 --- a/newsfragments/1417.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -The ``p2p.abc.TransportAPI.close`` and ``p2p.abc.MultiplexerAPI.close`` methods are now coroutines to allow ``p2p.abc.TransportAPI.close()`` to drain the underlying ``StreamWriter`` before closing it, ensuring that any pending messages are written over the socket before closing it. diff --git a/newsfragments/1465.feature.rst b/newsfragments/1465.feature.rst deleted file mode 100644 index da22c2ec20..0000000000 --- a/newsfragments/1465.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Support ``include_transactions`` param in ``eth_getBlockBy*`` APIs \ No newline at end of file diff --git a/newsfragments/1475.feature.rst b/newsfragments/1475.feature.rst deleted file mode 100644 index 3a75c80a76..0000000000 --- a/newsfragments/1475.feature.rst +++ /dev/null @@ -1,6 +0,0 @@ -Improve error message for when the parameters to JSON-RPC calls are invalid - -Improve error message for ``eth_getWork``, ``eth_submitWork`` and ``eth_submitHashrate`` -APIs which Trinity does not support as it generally does not support mining operations. - -Change ``eth_hashrate`` and ``eth_coinbase`` to also return errors instead of default values. \ No newline at end of file diff --git a/newsfragments/1478.feature.rst b/newsfragments/1478.feature.rst deleted file mode 100644 index 7872b5a067..0000000000 --- a/newsfragments/1478.feature.rst +++ /dev/null @@ -1,2 +0,0 @@ -Upgrade to py-evm `v0.3.0-alpha.14 -`_ diff --git a/newsfragments/1486.bugfix.rst b/newsfragments/1486.bugfix.rst deleted file mode 100644 index 2eb061bd39..0000000000 --- a/newsfragments/1486.bugfix.rst +++ /dev/null @@ -1,2 +0,0 @@ -Ensure validation errors in components are properly handled -during bootstrap. \ No newline at end of file diff --git a/newsfragments/1503.feature.rst b/newsfragments/1503.feature.rst deleted file mode 100644 index 533a5ab88b..0000000000 --- a/newsfragments/1503.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Implement ``admin_nodeInfo`` JSON-RPC endpoint \ No newline at end of file diff --git a/newsfragments/1510.bugfix.rst b/newsfragments/1510.bugfix.rst deleted file mode 100644 index ea23d809df..0000000000 --- a/newsfragments/1510.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -Fix broken API docs on https://trinity-client.readthedocs.io/en/latest/api/ \ No newline at end of file diff --git a/newsfragments/1524.bugfix.rst b/newsfragments/1524.bugfix.rst deleted file mode 100644 index 7224dbcaf3..0000000000 --- a/newsfragments/1524.bugfix.rst +++ /dev/null @@ -1,2 +0,0 @@ -:cls:`~p2p.exceptions.PeerConnectionLost` was escaping during a ``highest_td_peer`` call, and -crashing whatever called it. The exception is now caught. diff --git a/newsfragments/1543.feature.rst b/newsfragments/1543.feature.rst deleted file mode 100644 index 56a8d2ae0e..0000000000 --- a/newsfragments/1543.feature.rst +++ /dev/null @@ -1,2 +0,0 @@ -Implement the ``eth/64`` networking protocol according to -`EIP 2124 `_ \ No newline at end of file diff --git a/newsfragments/1545.bugfix.rst b/newsfragments/1545.bugfix.rst deleted file mode 100644 index 20c9aa61dd..0000000000 --- a/newsfragments/1545.bugfix.rst +++ /dev/null @@ -1,4 +0,0 @@ -Catch a variety of uncaught exceptions: :cls:`asyncio.TimeoutError`, -:cls:`~p2p.exceptions.UnknownAPI`, :cls:`~p2p.exceptions.PeerConnectionLost`, -OSError, :cls:`~eth_utils.exceptions.ValidationError`, :cls:`~p2p.exceptions.CorruptTransport`. -Also, prevent AttributeError when printing a :cls:`p2p.kademlia.Node` that has no address. diff --git a/newsfragments/1545.performance.rst b/newsfragments/1545.performance.rst deleted file mode 100644 index acbd3815af..0000000000 --- a/newsfragments/1545.performance.rst +++ /dev/null @@ -1,2 +0,0 @@ -Exit a bit more quickly from Beam Sync, by cancelling any hanging requests for state data. This -prevents a 5 second wait and timeout in the :cls:`~p2p.service.BaseService`. diff --git a/newsfragments/1548.bugfix.rst b/newsfragments/1548.bugfix.rst deleted file mode 100644 index 88d63cac3b..0000000000 --- a/newsfragments/1548.bugfix.rst +++ /dev/null @@ -1,3 +0,0 @@ -Catch a :cls:`~p2p.exceptions.PeerConnectionLost` raised when: disconnecting from a peer for sending -a malformed message, and another one when finding the fastest peer. Reject handshake attempts when -the IP address is unknown. Catch a :cls:`~p2p.exceptions.CorruptTransport`, raised during multiplex. diff --git a/newsfragments/1565.feature.rst b/newsfragments/1565.feature.rst deleted file mode 100644 index 19675ab0df..0000000000 --- a/newsfragments/1565.feature.rst +++ /dev/null @@ -1,5 +0,0 @@ -Add support for Etherscan API keys to continue support for the -``--beam-from-checkpoint eth://block/byetherscan/latest`` flag now that -Etherscan `has made API keys mandatory `_. -API keys need to be exposed via the ``TRINITY_ETHERSCAN_API_KEY`` -environment variable. \ No newline at end of file diff --git a/newsfragments/1567.internal.rst b/newsfragments/1567.internal.rst deleted file mode 100644 index 3f1abd2513..0000000000 --- a/newsfragments/1567.internal.rst +++ /dev/null @@ -1 +0,0 @@ -Less noisy logs when adding peers. Only show INFO logs when you have fewer than 5 peers. diff --git a/newsfragments/908.feature.rst b/newsfragments/908.feature.rst deleted file mode 100644 index 79c7d6cc2f..0000000000 --- a/newsfragments/908.feature.rst +++ /dev/null @@ -1,3 +0,0 @@ -We now "pivot" Beam Sync if we fall too many blocks behind. When a naive (non-pivoting) Beam Sync -falls too far behind the tip of the chain, it can get "stuck" because the trie data is no longer -available from peers.