Ethereum 以太坊节点启动源码分析


title: Ethereum 以太坊节点启动源码分析
date: 2018-06-01 11:37:21
tags:
- 以太坊
categories:
- 区块链


0 前言

  • 基于 Ethereum Coffice (v.1.8.8) 分析
  • 需要区块链基础知识
  • 有 C++/JAVA 基础就能理解文中 go 代码

1 定义

1.1 节点

在 Ethereum 区块链网络中,节点被定义为一个可以注册多种服务的容器。服务是一套独立的协议,可以基于P2P网络和PRC通信来提供具体的服务内容。节点对象的定义如下所示:

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 服务监听
    ipcHandler  *rpc.Server  // IPC API 消息处理

    httpEndpoint  string       // HTTP 端点
    httpWhitelist []string     // HTTP 白名单
    httpListener  net.Listener // HTTP API 服务监听
    httpHandler   *rpc.Server  // HTTP API 消息处理

    wsEndpoint string       // Websocket 端点
    wsListener net.Listener // Websocket API 服务监听
    wsHandler  *rpc.Server  // Websocket API 消息处理
    // --- RPC 相关对象 -- End

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

    log log.Logger  // 日志
}

1.2 默认值

node/defaults.go 源码中定义了关于节点的一系列默认值,包括:

  • HTTP RPC 端口默认 8545
  • WebSocket RPC 端口默认 8546
  • P2P 监听端口默认 30303
  • 数据库文件夹
    • Apple 系统 home\Library\Ethereum
    • Windows 系统 home\AppData\Roaming\Ethereum
    • 其他系统 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() 函数描述了节点创建运行的过程。

  • openDataDir() 在FS上创建一个文件夹用于存储节点相关数据

    if err := n.openDataDir(); err != nil {
        return err
    }
    
  • 创建 P2P 并导入服务的相关协议,启动 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,用于同系统内进程间的通信
    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
    }
    
    • 为节点关闭创建 channel
    n.stop = make(chan struct{})
    

3 API 交互

客户端通过 API 与 Ethereum 区块链网络进行交互,目前提供的服务有

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 以太坊节点启动源码分析 - FinJmy - 简书
Ethereum 以太坊智能合约部署源码分析 - FinJmy - 简书
Ethereum 以太坊智能合约调用源码分析 - FinJmy - 简书

本文文字和图片均属博主原创。未经授权,不得转载。

个人网站:https://jmy5945hh.github.io/

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 222,000评论 6 515
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 94,745评论 3 399
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 168,561评论 0 360
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,782评论 1 298
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,798评论 6 397
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 52,394评论 1 310
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,952评论 3 421
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,852评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,409评论 1 318
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,483评论 3 341
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,615评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 36,303评论 5 350
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,979评论 3 334
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,470评论 0 24
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,571评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 49,041评论 3 377
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,630评论 2 359

推荐阅读更多精彩内容