filecoin技術(shù)架構(gòu)分析之十一：filecoin源碼分析之內(nèi)部接口層api包分析

本文作者：楊尉；原創(chuàng)作品，轉(zhuǎn)載請(qǐng)注明出處

[上一篇鏈接] filecoin技術(shù)架構(gòu)分析之十：filecoin源碼分析之支撐包分析(2/2)

[下一篇鏈接] filecoin技術(shù)架構(gòu)分析之十二：filecoin源碼分析之內(nèi)部接口層plumbing＆porcelain接口

目錄

  • 11.filecoin源碼分析之內(nèi)部接口層api包分析
    • 11.1 api
    • 11.2 actor
    • 11.3 address
    • 11.4 client
    • 11.5 config
    • 11.6 daemon
    • 11.7 dag
    • 11.8 id
    • 11.11.log
    • 11.10 miner
    • 11.11 mining
    • 11.12 ping
    • 11.13 retrieval_client
    • 11.14 swarm

api包提供內(nèi)部接口,供協(xié)議層、command/REST使用

較大程度依賴node包

分析版本，go-filecoin版本：master 2c87fd59 (2019.3.7)

11.1 api

11.1.1 api的接口定義

如下所示，包含了一系列子接口

type API interface {
    Actor() Actor
    Address() Address
    Client() Client
    Daemon() Daemon
    Dag() Dag
    ID() ID
    Log() Log
    Miner() Miner
    Mining() Mining
    Paych() Paych
    Ping() Ping
    RetrievalClient() RetrievalClient
    Swarm() Swarm
    Version() Version
}

11.1.2 api的接口實(shí)現(xiàn)

▼ package
    impl

? imports

// nodeAPI來(lái)實(shí)現(xiàn)其接口定義
▼-nodeAPI : struct
    [fields]
    // 合約
   -actor : *nodeActor
    // 地址
   -address : *nodeAddress
    // 客戶端
   -client : *nodeClient
    // daemon
   -daemon : *nodeDaemon
    // dag
   -dag : *nodeDag
    // 節(jié)點(diǎn)ID
   -id : *nodeID
    // 日志
   -log : *nodeLog
    // 日志
   -logger : logging.EventLogger
    // 礦工
   -miner : *nodeMiner
    // 挖礦
   -mining : *nodeMining
    // 節(jié)點(diǎn)
   -node : *node.Node
    // 支付通道
   -paych : *nodePaych
    // ping
   -ping : *nodePing
    // 檢索客戶端
   -retrievalClient : *nodeRetrievalClient
    // swarm
   -swarm : *nodeSwarm
    // 版本
   -version : *nodeVersion

    [methods]
    // 如下為實(shí)現(xiàn)API接口
   +Actor() : api.Actor
   +Address() : api.Address
   +Client() : api.Client
   +Daemon() : api.Daemon
   +Dag() : api.Dag
   +ID() : api.ID
   +Log() : api.Log
   +Miner() : api.Miner
   +Mining() : api.Mining
   +Paych() : api.Paych
   +Ping() : api.Ping
   +RetrievalClient() : api.RetrievalClient
   +Swarm() : api.Swarm
   +Version() : api.Version

▼ functions
    // 實(shí)例化API
    // 1 獲取高層API porcelainAPI 指針,miner與paych有用到
    // 2 調(diào)用各子系統(tǒng)的實(shí)例化函數(shù)逐一實(shí)例化
   +New(node *node.Node) : api.API

11.2 actor

11.2.1 actor的接口定義

▼ package
    api

? imports

▼+ActorView : struct
    [fields]
    // actor類型
   +ActorType : string
    // actor地址
   +Address : string
    // actor余額
   +Balance : *types.AttoFIL
    // actor代碼-CID
   +Code : cid.Cid
    // 導(dǎo)出符號(hào)集合
   +Exports : ReadableExports
    // 表征actor實(shí)例的狀態(tài)
   +Head : cid.Cid
    // 消息計(jì)數(shù)器，僅為account actors與外部發(fā)生交互的時(shí)候計(jì)算
   +Nonce : uint64

    // 導(dǎo)出符號(hào)集合
 +ReadableExports : map[string]*ReadableFunctionSignature

▼+ReadableFunctionSignature : struct
    [fields]
    // 參數(shù)
   +Params : []string
    // 返回
   +Return : []string

▼+Actor : interface
    // 目前接口只有查看功能,返回合約的具體信息
    [methods]
   +Ls(ctx context.Context) : []*ActorView, error

11.2.2 actor的接口實(shí)現(xiàn)

▼ package
    impl

? imports

// 使用nodeActor來(lái)實(shí)現(xiàn)Actor接口
▼-nodeActor : struct
    [fields]
   -api : *nodeAPI
    [methods]
    // 調(diào)用ls方法實(shí)現(xiàn)查詢功能
   +Ls(ctx context.Context) : []*api.ActorView, error
    [functions]
    // 實(shí)例化nodeActor，由api實(shí)現(xiàn)代碼中調(diào)用
   -newNodeActor(api *nodeAPI) : *nodeActor

▼ functions
    // 獲取合約類型
    // 1 account actor
    // 2 存儲(chǔ)市場(chǎng)actor
    // 3 支付通道actor
    // 4 礦工actor
    // 4 BootstrapMiner actor
   -getActorType(actType exec.ExecutableActor) : string
    // 查詢合約狀態(tài)
   -ls(ctx context.Context, fcn *node.Node, actorGetter state.GetAllActorsFunc) : []*api.ActorView, error
   -makeActorView(act *actor.Actor, addr string, actType exec.ExecutableActor) : *api.ActorView
   -makeReadable(f *exec.FunctionSignature) : *api.ReadableFunctionSignature
   -presentExports(e exec.Exports) : api.ReadableExports

11.3 address

  • 提供功能
    • 地址顯示方法
    • 地址查找方法
    • 創(chuàng)建地址方法
    • 導(dǎo)出地址方法
    • 導(dǎo)入地址方法
▼ package
    api

? imports

▼+Address : interface
    [methods]
   +Addrs() : Addrs
   +Export(ctx context.Context, addrs []address.Address) : []*types.KeyInfo, error
   +Import(ctx context.Context, f files.File) : []address.Address, error

▼+Addrs : interface
    [methods]
   +Lookup(ctx context.Context, addr address.Address) : peer.ID, error
   +Ls(ctx context.Context) : []address.Address, error
   +New(ctx context.Context) : address.Address, error

11.4 client

  • 提供如下功能
    • 查詢piece數(shù)據(jù)（DAG格式）
    • 導(dǎo)入數(shù)據(jù)（相當(dāng)于ipfs add）
    • 列出所有訂單
    • 支付
    • 發(fā)起存儲(chǔ)交易
    • 查詢存儲(chǔ)交易
▼+Ask : struct
    [fields]
   +Error : error
   +Expiry : *types.BlockHeight
   +ID : uint64
   +Miner : address.Address
   +Price : *types.AttoFIL

▼+Client : interface
    [methods]
   +Cat(ctx context.Context, c cid.Cid) : uio.DagReader, error
   +ImportData(ctx context.Context, data io.Reader) : ipld.Node, error
   +ListAsks(ctx context.Context) : chan Ask, error
   +Payments(ctx context.Context, dealCid cid.Cid) : []*paymentbroker.PaymentVoucher, error
   +ProposeStorageDeal(ctx context.Context, data cid.Cid, miner address.Address, ask uint64, duration uint64, allowDuplicates bool) : *storage.DealResponse, error
   +QueryStorageDeal(ctx context.Context, prop cid.Cid) : *storage.DealResponse, error

11.5 config

  • 提供功能
    • Get配置
    • Set配置

11.6 daemon

  • 提供功能
    • 啟動(dòng)進(jìn)程相關(guān)
    • 具體的業(yè)務(wù)啟動(dòng)邏輯會(huì)調(diào)用到node包
▼ package
    api

? imports

▼+DaemonInitConfig : struct
    [fields]
    // 如果配置，定期檢查并密封staged扇區(qū)
   +AutoSealIntervalSeconds : uint
   +DefaultAddress : address.Address
    // 指定網(wǎng)絡(luò)
   +DevnetNightly : bool
   +DevnetTest : bool
   +DevnetUser : bool
    // 創(chuàng)世文件
   +GenesisFile : string
   +PeerKeyFile : string
    // repo目錄
   +RepoDir : string
    // 指定礦工
   +WithMiner : address.Address

 +DaemonInitOpt : func(*DaemonInitConfig)

▼+Daemon : interface
    [methods]
   +Init(ctx context.Context, opts ...DaemonInitOpt) : error
   +Start(ctx context.Context) : error
   +Stop(ctx context.Context) : error

11.7 dag

  • 提供功能
    • dag查詢功能
    • 類似ipfs block get

11.8 id

  • 提供功能
    • ID詳細(xì)信息
    • 如多地址、協(xié)議版本、導(dǎo)出公鑰等
▼+IDDetails : struct
    [fields]
   +Addresses : []ma.Multiaddr
   +AgentVersion : string
   +ID : peer.ID
   +ProtocolVersion : string
   +PublicKey : []byte
    [methods]
   +MarshalJSON() : []byte, error
   +UnmarshalJSON(data []byte) : error

▼+ID : interface
    [methods]
   +Details() : *IDDetails, error

▼ functions
   -decode(idd map[string]*json.RawMessage, key string, dest interface{}) : error

11.11.log

  • 提供日志功能
▼+Log : interface
    [methods]
   +Tail(ctx context.Context) : io.Reader

11.10 miner

  • 創(chuàng)建礦工
▼+Miner : interface
    [methods]
   +Create(ctx context.Context, fromAddr address.Address, gasPrice types.AttoFIL, gasLimit types.GasUnits, pledge uint64, pid peer.ID, collateral *types.AttoFIL) : address.Address, error

11.11 mining

  • 挖礦控制
    • 啟動(dòng)
    • 停止
▼+Mining : interface
    [methods]
   +Once(ctx context.Context) : *types.Block, error
   +Start(ctx context.Context) : error
   +Stop(ctx context.Context) : error

11.12 ping

  • 提供ping接口
▼+PingResult : struct
    [fields]
   +Success : bool
   +Text : string
   +Time : time.Duration

▼+Ping : interface
    [methods]
   +Ping(ctx context.Context, pid peer.ID, count uint, delay time.Duration) : chan *PingResult, error

11.13 retrieval_client

  • 提供檢索接口
▼+RetrievalClient : interface
    [methods]
   +RetrievePiece(ctx context.Context, pieceCID cid.Cid, minerAddr address.Address) : io.ReadCloser, error

11.14 swarm

  • 提供節(jié)點(diǎn)連接功能
    • 顯示連接節(jié)點(diǎn)
    • 連接節(jié)點(diǎn)
    • 查找節(jié)點(diǎn)
▼+SwarmConnInfo : struct
    [fields]
   +Addr : string
   +Latency : string
   +Muxer : string
   +Peer : string
   +Streams : []SwarmStreamInfo
    [methods]
   +Len() : int
   +Less(i, j int) : bool
   +Swap(i, j int)

▼+SwarmConnInfos : struct
    [fields]
   +Peers : []SwarmConnInfo
    [methods]
   +Len() : int
   +Less(i, j int) : bool
   +Swap(i, j int)

▼+SwarmConnectResult : struct
    [fields]
   +Peer : string
   +Success : bool

▼+SwarmStreamInfo : struct
    [fields]
   +Protocol : string

▼+Swarm : interface
    [methods]
   +Connect(ctx context.Context, addrs []string) : []SwarmConnectResult, error
   +FindPeer(ctx context.Context, peerID peer.ID) : peerstore.PeerInfo, error
   +Peers(ctx context.Context, verbose, latency, streams bool) : *SwarmConnInfos, error

[上一篇鏈接] filecoin技術(shù)架構(gòu)分析之十：filecoin源碼分析之支撐包分析(2/2)

[下一篇鏈接] filecoin技術(shù)架構(gòu)分析之十二：filecoin源碼分析之內(nèi)部接口層plumbing＆porcelain接口

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容