Skip to content
This repository has been archived by the owner on Oct 31, 2024. It is now read-only.

Docs: safe-buffer usage note, Node.js distribution table #45

Merged
merged 1 commit into from
Jan 10, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 32 additions & 6 deletions docs/technical.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,28 @@ Runtime environment for development is `node.js <https://nodejs.org/en/>`_.
Development should always be possible running the last two ``LTS`` Node.js versions,
see Node.js `release schedule table <https://github.com/nodejs/Release#release-schedule>`_.

====================== =================================================
Node.js 8 Supported
Node.js 10 Supported
====================== =================================================
====================== ================= ===============================
Node Version Status Latest Status Change
====================== ================= ===============================
Node.js 8 Supported 2018-11-01
Node.js 10 Supported 2018-11-01
====================== ================= ===============================

Node.js Features
^^^^^^^^^^^^^^^^

``TODO``
Buffer vs safe-buffer
"""""""""""""""""""""
Old Node versions up to versions ``4`` and ``5`` allowed for some unsafe usage
of the ``Buffer`` API which led to the development of a replacement
holgerd77 marked this conversation as resolved.
Show resolved Hide resolved
`safe-buffer <https://github.com/feross/safe-buffer>`_ library. We have now for
some time dropped support for distibution on all affected Node versions (mainly
``4``) and usage of ``safe-buffer`` is not needed any more.

Notes on ``Buffer``, ``safe-buffer``, stuff like that.
.. note::
holgerd77 marked this conversation as resolved.
Show resolved Hide resolved
The ``safe-buffer`` is still in
use `on many libraries <https://github.com/search?q=org%3Aethereumjs+safe-buffer&type=Code>`_,
this should be removed and updated with direct ``Buffer`` usage.

Node.js Best Practices
^^^^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -162,6 +173,21 @@ compiler ``tsc`` command line tool.
.. note::
``TODO``: This section has to be expanded.

Node.js Version
---------------

The following table gives an overview on supported Node versions for distribution:

====================== ================= ===============================
Node Version Status Latest Status Change
====================== ================= ===============================
Node.js 4 Dropped 2018-10-01
Node.js 6 Supported 2018-10-01
Node.js 8 Supported 2018-11-01
Node.js 10 In the works 2018-12-01
holgerd77 marked this conversation as resolved.
Show resolved Hide resolved
====================== ================= ===============================


Browser Compatibility
---------------------

Expand Down