blockworks-foundation
/
lite-rpc
mirror of https://github.com/blockworks-foundation/lite-rpc.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
lite-rpc/docs/architecture.md

9.5 KiB
Raw Blame History

Architecture

Domains

Validator

Manage real time generated data by the validator.

Implements these RPC calls:

  • GetVoteAccounts
  • getLeaderSchedule
  • getEpochInfo
  • getSlot
  • getSignatureStatuses at process commitment.
  • new tx sent: call by the SendTx module when a Tx is processed by sendTx module.

Subdomain Validator subscription

Implements these RPC subscriptions

  • programSubscribe
  • slotSubscribe
  • blockSubscribe
  • transactionSubscribe
  • logsSubscribe
  • signatureSubscribe
  • slotsUpdatesSubscribe
  • voteSubscribe

Sub domain Cluster

Manage cluster information.

Implement the call: getClusterNodes

Provide the subscription: cluster info.

Inter module messages notification (Stream)

Provides these inter module message notification:

  • Full block
  • BLock info
  • Slots
  • Leader schedule
  • sent Tx at confirmed and / or finalized: notify when a Tx sent is confirmed or finalized. Use by RPC transactionSubscribe

A new subscription is added: Sent Tx confirmed/ finalized. SendTx module send Tx signature to the Validator domain and when a Tx sent is confirmed (or finalized), it is notified on this subscription.

It avoids to call getSignatureStatuses in a pull mode.

SendTx

Manage the whole send Tx process. Represent the current Lite RPC process.

Implements the sendTx call.

History

Manage history function like getBlock/getBlocks/getTransaction.

A special use case is the getSignatureStatuses because on process its the Validator domain that provide the data.

RPC

It's an entry point for all call and dispatch the call to the right function.

Summary diagram

flowchart TD
    subgraph History Domain
        History("History Domain

        at confirm/finalized
            getBlock()
            getBlocks()
            getSignaturesForAddress()
            getSignatureStatuses()
            getTransaction()")
        Faithfull["Faithfull Service"]
        Storage["2 epoch Storage"]
    end

    subgraph Send Tx Domain
        SendTx("SendTx Domain

              send_transaction()")
    end

    subgraph Validator Host
        Validator["Solana Validator
            Validator process
            + GRPC Geyser"]
        
        Consensus("Validator Domain
        RPC calls:
            getVoteAccounts()
            getLeaderSchedule()
            getEpochInfo()
            getSlot()...
        At process:
            getSignaturesForAddress()
            getSignatureStatuses()
              ")
        Subscription("Subscription Sub Domain
            
            programSubscribe
            slotSubscribe
            blockSubscribe
            transactionSubscribe
            logsSubscribe
            signatureSubscribe
            slotsUpdatesSubscribe
            voteSubscribe
              ")
        Cluster("Cluster Sub Domain
            
           getClusterNodes()")
    end
    

    Validator-- "geyser data" -->Consensus
    Validator-- "geyser data" -->Subscription
    Validator-- "Cluster info" -->Cluster
    Consensus-- "Block Info/Slot/Leader Schedule" -->SendTx
    Consensus-- "confirmed Tx" -->SendTx
    Consensus-- "confirmed Tx" -->Subscription
    Cluster-- "Cluster info" -->SendTx
    Consensus-- "Full Block/Slot/Epoch" -->History
    History<-. "old data" .-> Faithfull
    History<-. "recent data" .-> Storage

    classDef consensus fill:#1168bd,stroke:#0b4884,color:#ffffff
    classDef history fill:#666,stroke:#0b4884,color:#ffffff
    classDef sendtx fill:#08427b,stroke:#052e56,color:#ffffff
    classDef redgray fill:#62524F, color:#fff
    classDef greengray fill:#4F625B, color:#fff

    class SendTx sendtx
    class History redgray
    class Consensus consensus
    class Cluster greengray

Interaction diagram

flowchart TD
    SendTx("Send Tx
           [Domain]
        
          Send Tx to cluster")
    subgraph History 
        History("History
                   [Domain]
                
                  Get Block and Tx")
        Faithfull["Faithfull Service"]
        Storage["2 epoch Storage"]
    end

    subgraph Validator Host

        Validator["Solana Validator
                  Validator process
                + GRPC Geyser"]
        
        Consensus("Validator
               [Domain]
              Manage realtime produced data
        by the validator")

        Subscription("Subscription Sub Domain
            
            All RPC subscriptions
              ")

        Cluster("Cluster Info
               [SubDomain]
        
              Cluster data")

    end

    subgraph RPC Entry point
        RPC["RPC API
            
              RPC Entry point"]
    end

    

    Validator-- "geyser FullBlock/Slots Sub" -->Consensus
    Validator-- "geyser Stakes and Votes account Sub" -->Consensus
    Validator== "geyser getBlockHeight" ==>RPC
    Validator-- "geyser Cluster info Sub" -->Cluster
    Validator-- "geyser Sub" -->Subscription
    Consensus<== "getVoteAccounts/getLeaderSchedule/getEpochInfo/getSlot" ==>RPC
    Consensus<== "At Process getSignaturesForAddress/getSignatureStatuses" ==>RPC
    Consensus-- "Block Info Sub" -->SendTx
    Consensus-- "Leader Schedule Sub" -->SendTx
    Consensus-- "Sent Tx confirmed Sub" -->SendTx
    Consensus-- "Sent Tx confirmed Sub" -->Subscription
    Cluster-- "Cluster info Sub" -->SendTx
    Consensus-- "Full Block / Epoch Sub" -->History
    RPC== "SendTx" ==> SendTx
    SendTx== "A new Tx to send" ==> Consensus
    History<== "At confirm getBlock(s)/getSignaturesForAddress/getSignatureStatuses" ==> RPC
    History<-. "getBlock(s)/getSignaturesForAddress" .-> Faithfull
    History<-. "Store Blocks + Txs" .-> Storage
    Cluster<== "getClusterNodes" ==> RPC


    classDef consensus fill:#1168bd,stroke:#0b4884,color:#ffffff
    classDef history fill:#666,stroke:#0b4884,color:#ffffff
    classDef sendtx fill:#08427b,stroke:#052e56,color:#ffffff
    classDef redgray fill:#62524F, color:#fff
    classDef greengray fill:#4F625B, color:#fff

    class SendTx sendtx
    class History redgray
    class Consensus consensus
    class Subscription consensus
    class Cluster greengray

Message stream

Module organization can change depending on the deployment needed. For example several validator node can be started to add reliability. To ease this association between module and server installation, module communication will be done mostly via asynchronous message. This message propagation and routing will done by the Stream module.

Module register to it to get notifified and send new message to specific entry point.

The logic organization will be.

flowchart TD
    SendTx("Send Tx")
    History("History")
    subgraph Validator_Domain
        Cluster("Cluster Info")
            
        Consensus("Validator")

        Subscription("Subscription")
    end

    Stream("Stream
          Manage message routing
          between module.")

    Consensus-- "Send [Full&Info Block, Slot, Leader Schedule, Epoch info, Tx confirmed]" -->Stream
    Cluster-- "Send Cluster Info" -->Stream
    SendTx-- "Sent sendTx" -->Stream
   
    Stream-- "[Slot, Leader Schedule, Block and Epoch info, Tx confirmed] sub" -->SendTx
    Stream-- "[Sent Tx] sub" -->Consensus
    Stream-- "[Sent Tx] sub" -->Subscription
    Stream-- "[Full Block, Slot, Epoch info] sub" -->History

    classDef consensus fill:#1168bd,stroke:#0b4884,color:#ffffff
    classDef history fill:#666,stroke:#0b4884,color:#ffffff
    classDef sendtx fill:#08427b,stroke:#052e56,color:#ffffff
    classDef redgray fill:#62524F, color:#fff
    classDef greengray fill:#4F625B, color:#fff

    class SendTx sendtx
    class History redgray
    class Consensus consensus
    class Subscription consensus
    class Cluster greengray

Bootstrap architecture

Each domain implements its own bootsrap. A domain impl running can send boostrap data to a starting one.

Deployment example

flowchart TD
    subgraph SendTx Host1
        SendTx1("Send Tx impl")
    end
    subgraph SendTx Host2
        SendTx2("Send Tx impl")
    end
    subgraph History Host1
        History1("History impl")
    end
    subgraph History Host2
        History2("History impl")
    end
    subgraph History Host3
        History3("History impl")
    end

    subgraph Validator Host1
        Validator1["Solana Validator"]
        Consensus1("Validator impl")
        Subscription1("Subscription impl")
        Cluster1("Cluster impl")
    end
    subgraph Validator Host2
        Validator2["Solana Validator"]
        Consensus2("Validator impl")
        Subscription2("Subscription impl")
        Cluster2("Cluster impl")
    end

    RPC["RPC entry point
        dispatch on started servers"]

    RPC== "Send sendTx" ==>SendTx1
    RPC== "Send sendTx" ==>SendTx2

    RPC== "getVoteAccounts" ==>Consensus1
    RPC== "getVoteAccounts" ==>Consensus2

    RPC== "Subscription" ==>Subscription1
    RPC== "Subscription" ==>Subscription2

    RPC== "getBlock" ==>History1
    RPC== "getBlock" ==>History2
    RPC== "getBlock" ==>History3

    RPC== "getClusterNodes" ==>Cluster1
    RPC== "getClusterNodes" ==>Cluster2

    classDef consensus fill:#1168bd,stroke:#0b4884,color:#ffffff
    classDef history fill:#666,stroke:#0b4884,color:#ffffff
    classDef sendtx fill:#08427b,stroke:#052e56,color:#ffffff
    classDef redgray fill:#62524F, color:#fff
    classDef greengray fill:#4F625B, color:#fff

    class SendTx1 sendtx
    class SendTx2 sendtx
    class Cluster1 greengray
    class Cluster2 greengray
    class Subscription1 consensus
    class Subscription2 consensus
    class Consensus1 consensus
    class Consensus2 consensus
    class History1 redgray
    class History2 redgray
    class History3 redgray