Ecosystem/serai
Ecosystem/serai
1
0
Fork 0
mirror of https://github.com/serai-dex/serai.git synced 2024-11-16 17:07:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
serai/processor
History
Luke Parker 9f143a9742
Replace "coin" with "network" 
The Processor's coins folder referred to the networks it could process, as did
its Coin trait. This, and other similar cases throughout the codebase, have now
been corrected.

Also corrects dated documentation for a key pair is confirmed under the
validator-sets pallet.
2023-07-30 16:11:30 -04:00
..
messages Replace "coin" with "network" 2023-07-30 16:11:30 -04:00
src Replace "coin" with "network" 2023-07-30 16:11:30 -04:00
Cargo.toml Minimize features pulled in to try and reduce build times 2023-07-25 22:29:39 -04:00
LICENSE Update licenses 2023-01-11 23:05:31 -05:00
README.md Update processor README 2023-04-11 05:53:19 -04:00

README.md

Processor

The Serai processor scans a specified chain, communicating with the coordinator.

Key Generation

The coordinator will tell the processor if it's been included in managing a coin. If so, the processor is to begin the key generation protocol, relying on the coordinator to provided authenticated communication with the remote parties.

When the key generation protocol successfully completes, the processor is expected to inform the coordinator so it may vote on it on the Substrate chain. Once the key is voted in, it'll become active.

Scanning

Sufficiently confirmed block become finalized in the eyes of the procesor. Finalized blocks are scanned and have their outputs emitted, though not acted on.

Reporting

The processor reports finalized blocks to the coordinator. Once the group acknowledges the block as finalized, they begin a threshold signing protocol to sign the block's outputs as a Batch.

Once the Batch is signed, the processor emits an Update with the signed batch. Serai includes it, definitively ordering its outputs within the context of Serai.

Confirmed Outputs

With the outputs' ordering, validators are able to act on them.

Actions are triggered by passing the outputs to the scheduler. The scheduler will do one of two things:

  1. Use the output
  2. Accumulate it for later usage

Burn Events

When the Serai chain issues a Burn event, the processor should send coins accordingly. This is done by scheduling the payments out.

TODO

  • Items marked TODO

  • Items marked TODO2, yet those only need to be done after protonet

  • Test the implementors of Coin against the trait API

  • Test the databases

  • Test eventuality handling

  • Coordinator communication

Kafka? RPC ping to them, which we don't count as 'sent' until we get a pong?