neoneo-go/ROADMAP.md

Roadmap for neo-go

This defines approximate plan of neo-go releases and key features planned for them. Things can change if there is a need to push a bugfix or some critical functionality.

Versions 0.7X.Y (as needed)

• Neo 2.0 support (bug fixes, minor functionality additions)

Version 0.102.1 (~October 2023)

• bug fixes

Version 0.103.0 (~November 2023)

• extended data types for iterators to be used by RPC wrapper generator
• RPC subscription extensions

Version 1.0 (2023, TBD)

• stable version

Deprecated functionality

As the node and the protocol evolve some external APIs can change. Usually we try keeping backwards compatibility for some time (like half a year) unless it's impossible to do for some reason. But eventually old APIs/commands/configurations will be removed and here is a list of scheduled breaking changes. Consider changing your code/scripts/configurations if you're using anything mentioned here.

SecondsPerBlock protocol configuration

With 0.100.0 version SecondsPerBlock protocol configuration setting was deprecated and replaced by a bit more generic and precise TimePerBlock (allowing for subsecond time). An informational message is printed on node startup to inform about this, it's very easy to deal with this configuration change, just replace one line.

Removal of SecondsPerBlock is scheduled for May-June 2023 (~0.103.0 release).

Services/node address and port configuration

Version 0.100.0 of NeoGo introduces a multiple binding addresses capability to the node's services (RPC server, TLS RPC configuration, Prometheus, Pprof) and the node itself. It allows to specify several listen addresses/ports using an array of "address:port" pairs in the service's Addresses config section and array of "address:port:announcedPort" tuples in the ApplicationConfiguration's Addresses node config section. Deprecated Address and Port sections of RPC, Prometheus, Pprof subsections of the ApplicationConfiguration as far as the one of RPC server's TLSConfig are still available, but will be removed, so please convert your node configuration file to use new P2P-level Addresses section for the node services. Deprecated Address, NodePort and AnnouncedPort sections of ApplicationConfiguration will also be removed eventually, so please update your node configuration file to use Addresses section for the P2P addresses configuration.

Removal of these config sections is scheduled for May-June 2023 (~0.103.0 release).

P2P application settings configuration

Version 0.100.0 of NeoGo marks the following P2P application settings as deprecated: AttemptConnPeers, BroadcastFactor, DialTimeout, ExtensiblePoolSize, MaxPeers, MinPeers, PingInterval, PingTimeout, ProtoTickInterval. These settings are moved to a separate P2P section of ApplicationConfiguration. The DialTimeout, PingInterval, PingTimeout, ProtoTickInterval settings are converted to more precise Duration format (allowing for subsecond time). Please, update your node configuration (all you need is to move specified settings under the P2P section and convert time-related settings to Duration format).

Removal of deprecated P2P related application settings is scheduled for May-June 2023 (~0.103.0 release).

Direct UnlockWallet consensus configuration

Top-level UnlockWallet section in ApplicationConfiguration was used as an implicit consensus service configuration, now this setting (with Enabled flag) is moved into a section of its own (Consensus). Old configurations are still supported, but this support will eventually be removed.

Removal of this compatibility code is scheduled for May-June 2023 (~0.103.0 release).

Node-specific configuration moved from Protocol to Application

GarbageCollectionPeriod, KeepOnlyLatestState, RemoveUntraceableBlocks, SaveStorageBatch and VerifyBlocks settings were moved from ProtocolConfiguration to ApplicationConfiguration in version 0.100.0. Old configurations are still supported, except for VerifyBlocks which is replaced by SkipBlockVerification with inverted meaning (and hence an inverted default) for security reasons.

Removal of these options from ProtocolConfiguration is scheduled for May-June 2023 (~0.103.0 release).

GetPeers RPC server response type changes and RPC client support

GetPeers RPC command returns a list of Peers where the port type has changed from string to uint16 to match C#. The RPC client currently supports unmarshalling both formats.

Removal of Peer unmarshalling with string based ports is scheduled for ~September 2023 (~0.105.0 release).

NEOBalance from stack item

We check struct items count before convert LastGasPerVote to let RPC client be compatible with old versions.

Removal of this compatiblility code is scheduled for Sep-Oct 2023.

serv_node_version Prometheus gauge metric

This metric is replaced by the new neogo_version and server_id Prometheus gauge metrics with proper version formatting. neogo_version contains NeoGo version hidden under version label and server_id contains network server ID hidden under server_id label.

Removal of serv_node_version is scheduled for Sep-Oct 2023 (~0.105.0 release).

RPC error codes returned by old versions and C#-nodes

NeoGo retains certain deprecated error codes: neorpc.ErrCompatGeneric, neorpc.ErrCompatNoOpenedWallet. They returned by nodes not compliant with the neo-project/proposals#156 (NeoGo pre-0.102.0 and all known C# versions).

Removal of the deprecated RPC error codes is planned once all nodes adopt the new error standard.