title: Ethereum 以太坊節(jié)點啟動源碼分析
date: 2018-06-01 11:37:21
tags:
- 以太坊
categories:
- 區(qū)塊鏈

0 前言

• 基于 Ethereum Coffice (v.1.8.8) 分析
• 需要區(qū)塊鏈基礎知識
• 有 C++/JAVA 基礎就能理解文中 go 代碼

1 定義

1.1 節(jié)點

在 Ethereum 區(qū)塊鏈網絡中，節(jié)點被定義為一個可以注冊多種服務的容器。服務是一套獨立的協(xié)議，可以基于P2P網絡和PRC通信來提供具體的服務內容。節(jié)點對象的定義如下所示：

Node is a container on which services can be registered.

/* 
file:node/node.go
 */
type Node struct {
    eventmux *event.TypeMux // 服務之間的事件鎖
    config   *Config
    accman   *accounts.Manager

    ephemeralKeystore string
    instanceDirLock   flock.Releaser
    
    // --- P2P 相關對象 -- Start
    serverConfig p2p.Config     
    server       *p2p.Server
    // --- P2P 相關對象 -- End

    // --- 服務相關對象 -- Start
    serviceFuncs []ServiceConstructor      
    services     map[reflect.Type]Service
    // --- 服務相關對象 -- End

    // --- RPC 相關對象 -- Start
    rpcAPIs       []rpc.API   // RPC 提供的 API
    inprocHandler *rpc.Server // RPC API 消息處理

    ipcEndpoint string       // IPC 端點
    ipcListener net.Listener // IPC API 服務監(jiān)聽
    ipcHandler  *rpc.Server  // IPC API 消息處理

    httpEndpoint  string       // HTTP 端點
    httpWhitelist []string     // HTTP 白名單
    httpListener  net.Listener // HTTP API 服務監(jiān)聽
    httpHandler   *rpc.Server  // HTTP API 消息處理

    wsEndpoint string       // Websocket 端點
    wsListener net.Listener // Websocket API 服務監(jiān)聽
    wsHandler  *rpc.Server  // Websocket API 消息處理
    // --- RPC 相關對象 -- End

    stop chan struct{} // 等待關閉通知的 通道
    lock sync.RWMutex

    log log.Logger  // 日志
}

1.2 默認值

node/defaults.go 源碼中定義了關于節(jié)點的一系列默認值，包括：

• HTTP RPC 端口默認 8545
• WebSocket RPC 端口默認 8546
• P2P 監(jiān)聽端口默認 30303
• 數(shù)據(jù)庫文件夾
  • Apple 系統(tǒng) home\Library\Ethereum
  • Windows 系統(tǒng) home\AppData\Roaming\Ethereum
  • 其他系統(tǒng) home\.ethereum

詳見源碼

package node

import ...

const (
    DefaultHTTPHost = "localhost"
    DefaultHTTPPort = 8545 
    DefaultWSHost   = "localhost"
    DefaultWSPort   = 8546
)

var DefaultConfig = Config{
    DataDir:          DefaultDataDir(),
    HTTPPort:         DefaultHTTPPort,
    HTTPModules:      []string{"net", "web3"},
    HTTPVirtualHosts: []string{"localhost"},
    WSPort:           DefaultWSPort,
    WSModules:        []string{"net", "web3"},
    P2P: p2p.Config{
        ListenAddr: ":30303",
        MaxPeers:   25,
        NAT:        nat.Any(),
    },
}

func DefaultDataDir() string {
    home := homeDir()
    if home != "" {
        if runtime.GOOS == "darwin" {
            return filepath.Join(home, "Library", "Ethereum")
        } else if runtime.GOOS == "windows" {
            return filepath.Join(home, "AppData", "Roaming", "Ethereum")
        } else {
            return filepath.Join(home, ".ethereum")
        }
    }

    return ""
}

func homeDir() string {
    ...
}

2 啟動

node/node.go 源碼中的 Start() 函數(shù)描述了節(jié)點創(chuàng)建運行的過程。

• openDataDir() 在FS上創(chuàng)建一個文件夾用于存儲節(jié)點相關數(shù)據(jù)

  if err := n.openDataDir(); err != nil {
      return err
  }
  

• 創(chuàng)建 P2P 并導入服務的相關協(xié)議，啟動 P2P

  running := &p2p.Server{Config: n.serverConfig}
  
  services := make(map[reflect.Type]Service)
  for _, constructor := range n.serviceFuncs {
      ...
      services[kind] = service
  }
  
  for _, service := range services {
      running.Protocols = append(running.Protocols, service.Protocols()...)
  }
  
  if err := running.Start(); err != nil {
      return convertFileLockError(err)
  }
  

• 啟動服務

  started := []reflect.Type{}
  for kind, service := range services {
      if err := service.Start(running); err != nil {
          ...
      }
      started = append(started, kind)
  }
  

• 啟動 RPC 接口

  if err := n.startRPC(services); err != nil {
      for _, service := range services {
          service.Stop()
      }
      running.Stop()
      return err
  }
  

  • API 接口導入

  apis := n.apis()
  for _, service := range services {
      apis = append(apis, service.APIs()...)
  }
  

  • 啟動 InProc，用于進程內部的通信

  if err := n.startInProc(apis); err != nil {
      return err
  }
  

  • 啟動 IPC，用于同系統(tǒng)內進程間的通信

  if err := n.startIPC(apis); err != nil {
      ...
      return err
  }
  

  • 啟動 HTTP，用于 HTTP 的交互通信

  if err := n.startHTTP(...); err != nil {
      ...
      return err
  }
  

  • 啟動 WebSocket，用于瀏覽器與服務器的 TCP 全雙工通信

  if err := n.startWS(...); err != nil {
      ...
      return err
  }
  

  • 為節(jié)點關閉創(chuàng)建 channel

  n.stop = make(chan struct{})
  

3 API 交互

客戶端通過 API 與 Ethereum 區(qū)塊鏈網絡進行交互，目前提供的服務有

backend.go
func (s *Ethereum) APIs() []rpc.API {
backend.go
func (s *LightEthereum) APIs() []rpc.API {
exec.go
func (s *snapshotService) APIs() []rpc.API {
ping-pong.go
func (p *pingPongService) APIs() []rpc.API {
swarm.go
func (self *Swarm) APIs() []rpc.API {
whisper.go
func (w *Whisper) APIs() []rpc.API {
whisper.go
func (whisper *Whisper) APIs() []rpc.API {

通常，進行交易、查詢的相關操作的API主要關注 ethapi\api.go 源碼提供的接口。

——————————THE END——————————

以太坊系列文章：
Ethereum 以太坊節(jié)點啟動源碼分析 - FinJmy - 簡書
Ethereum 以太坊智能合約部署源碼分析 - FinJmy - 簡書
Ethereum 以太坊智能合約調用源碼分析 - FinJmy - 簡書

本文文字和圖片均屬博主原創(chuàng)。未經授權，不得轉載。

個人網站：https://jmy5945hh.github.io/