README.md

Sui NTT

The project is structured into three packages:

• ntt (NTT manager)
• ntt_common
• wormhole_transciever

In the NTT architecture, the NTT manager implements the token transfer logic, and sends/receives messages via potentially multiple transceivers in a threshold configuration. Here, we decouple the implementation of the manager from the transceiver, so they don't need to know about each other. Indeed, the ntt and wormhole_transceiver packages don't depend on each other.

Instead, they communicate via permissioned structs defined in ntt_common.

ntt_common

The ntt_common package contains common struct definitions that are shared between the NTT manager and transceivers.

There are two flavours of these structs: unpermissioned and permissioned.

By unpermissioned, we mean that these can be created and destructed by any module. These define the structs in the wire format, and as such come with (de)serialiser functions too. Holding a value of these types gives no guarantees about the provenance of the data, so they are exclusively used for structuring information. These structs are defined in the messages folder.

On the other hand, construction/consumption of permissioned structs is restricted, and thus provide specific gurantees about the information contained within. The NTT manager sends messages by creating a value of type OutboundMessage, which the transceiver consumes and processes. In the other direction, the NTT manager receives messages by consuming ValidatedTransceiverMessage structs that are created by the transceiver. See the documentation in those modules for more details on the implementation. These inbound/outbound permissioned structs are passed between the manager and transceivers in a programmable transaction block, meaning that the contracts don't directly call each other. As such, care has been taken to restrict the capabilities of these structs sufficiently to ensure that the client constructing the PTB can not do the wrong thing.

The intention is for a single ntt_common module to be deployed, and shared between all NTT manager & transceiver instances.