shared

README

Shared Module

• Shared Module
  • Where Do I start?
  • Code Structure
  • High Level Architecture
  • Types
  • Interfaces

Where Do I start?

1. Look at the high level architecture diagram below
2. Inspect node.go which is the main entrpoint to the node
3. Familiarize yourself with modules/module.go and all the other interfaces under module.
4. Ask a member of the team to walk you through types
5. Dive deep into the module of your choise

Code Structure

shared             # [to-be-refactored] All of this is bound to change
├── config         # Utilities to load and verify Node configurations
├── crypto         # Shared crypto utilities specific to Pocket
├── modules        # Interfaces to the core Pocket modules
|   ├── module.go
|   ├── bus_module.go
|   ├── consensus_module.go
|   ├── p2p_module.go
|   ├── utility_module.go
|   ├── persistence_module.go
├── tests          # Cross-module and shared-utility tests
├── types          # Types (structs & protos) shared across modules
|   ├──            # Please reach out to the team if you need a walk-through for these
├── utils          # Various helper utilities used across the repo
├── node.go        # The main entrypoint to the Pocket Node
├── bus.go         # Implementation of the Bus module

High Level Architecture

The key things to keep in mind are:

• Every module has a 2 way pointer with the Bus, through which it can:
  • Call methods defined by the interfaces of other modules
  • Receive asynchronous events from the main events channel
• The Persistence module is the only module that communicates with the local database
• The P2P module is the only one that communicates with the outside world

flowchart TD
    subgraph Pocket Node
        subgraph Pocket's Application Specific Bus
            B("Bus")
            E("Main Events Channel")
            B <-.-> E
        end
        subgraph Pocket's Core Modules
            P(Persistence) & C(Consensus) & U(Utility) & P2P(P2P)
        end
        P <--> B
        C <--> B
        U <--> B
        P2P <--> B
        P <--> db
        P2P <-.-> N((Pocket Network))
        db[(Pocket Database)]
    end

    click P callback "Tooltip for a callback"
    click P call callback() "Tooltip for a callback"

    classDef module fill:#28f,stroke:#016,stroke-width:2px,color:#fff,stroke-dasharray: 5 5
    class P,C,U,P2P,B module

Types

Intentionally left blank for now. Reach out to the team if you have questions.

Interfaces

Intentionally left blank for now. Reach out to the team if you have questions.

Documentation

Index

• Constants
• func CreateBus(persistence modules.PersistenceModule, p2p modules.P2PModule, ...) (modules.Bus, error)
• type Node
  • func Create(cfg *config.Config) (n *Node, err error)
  • func (m *Node) GetBus() modules.Bus
  • func (m *Node) SetBus(bus modules.Bus)
  • func (node *Node) Start() error
  • func (node *Node) Stop() error

Constants

const (
	DefaultPocketBusBufferSize = 100
)

Functions

func CreateBus

func CreateBus(
	persistence modules.PersistenceModule,
	p2p modules.P2PModule,
	utility modules.UtilityModule,
	consensus modules.ConsensusModule,
) (modules.Bus, error)

Types

type Node

type Node struct {
	Address cryptoPocket.Address
	// contains filtered or unexported fields
}

func Create

func Create(cfg *config.Config) (n *Node, err error)

func (*Node) GetBus

func (m *Node) GetBus() modules.Bus

func (*Node) SetBus

func (m *Node) SetBus(bus modules.Bus)

func (*Node) Start

func (node *Node) Start() error

func (*Node) Stop

func (node *Node) Stop() error