Neo Blockchain Toolkit Persistence Library

This repo projects for code shared between managed projects in the Neo Blockchain Toolkit. In particular, these libraries are used in Neo-Express and the Neo Smart Contract Debugger for VS Code.

Continutious Integration build packages are available via Azure Artifacts.

Models

This library contains classes for reading and writing .neo-express files and NEP-19 compatible debug information

Contract Parameter Parsing

This library contains code to parse Neo Express contract invoke files as specified in NDX-DN12. This includes custom handling of JSON native types (boolean, integer, null, array) as well as custom handling of JSON strings for encoding addresses with @ prefix, hashes with # prefix and hex strings with 0x prefix.

Persistence

This library contains two Neo.Persistence.IStore implementations:

• RocksDbStore: This implementation stores blockchain information in a RocksDb. It is similar to the RocksDbStore implementation in neo-modules, but is optimized for developer scenarios, including live checkpoint support.

• MemoryTrackingStore: This implementation sits on top of any Neo.Persistence.IReadOnlyStore implementation and stores all changes in memory. This enables test/debug runs to use live data without persisting further changes.

• PersistentTrackingStore: This implementation sits on top of any Neo.Persistence.IReadOnlyStore implementation and stores all changes on disk.

• CheckpointStore: This implementation of Neo.Persistence.IReadOnlyStore pulls data from a Neo Express checkpoint. Combined with a tracking store, this enables test/debug runs to use live data without persisting further changes.

• StateServiceStore: This implementation of Neo.Persistence.IReadOnlyStore sits on top of a StateService node running with FullState: true. Combined with a tracking store, this enables code to use live data from a public Neo blockchain network such as MainNet or TestNet.

Trace Models

This library contains the model classes that read/write Time Travel Debugging (TTD) traces. TTD traces are encoded using MessagePack. These model classes use the MessagePack managed library. In addition to the trace model classes, this library includes message pack formatters for Neo types that are serialized in TTD traces as well as a MessagePack resolver.

Application Engines

This library contains two Neo.SmartContract.ApplicationEngine subclasses:

• TestApplicationEngine: This implementation is used across test scenarios. It supports overriding the CheckWitness service and collecting code coverage information
• TraceApplicationEngine: This implementation writes trace information to a provided ITraceDebugSink. The Trace Model classes (described above) include an implementation of ITraceDebugSink that writes trace messages to a file in MessagePack format.