IPFS和以太坊ENS可以自動(dòng)發(fā)布網(wǎng)站嗎
如果您已經(jīng)注冊(cè)了一個(gè)不錯(cuò)的ENS名稱,并希望通過IPFS和以太坊名稱服務(wù)使您的站點(diǎn)/dapp可用。要使其成為部署腳本的無縫部分,需要執(zhí)行幾個(gè)步驟。
在我們開始之前。..
在本指南中,我假設(shè)您已經(jīng)了解如何使用IPFS和ENS托管網(wǎng)站的基礎(chǔ)知識(shí)。重點(diǎn)在于部署自動(dòng)化和調(diào)整CI工作流程。 如果您不熟悉ENS和IPFS,可能會(huì)出現(xiàn)一些問號(hào):)
Node.js版本:在編寫本文時(shí),不能將ens-updater安裝在12.x或更高版本的節(jié)點(diǎn)上,因?yàn)槟承┮蕾図?xiàng)需要腳本模塊,該腳本模塊無法構(gòu)建。 在https://github.com/TripleSpeeder/ens-updater/issues/44中跟蹤了此問題。 在問題解決之前,請(qǐng)使用節(jié)點(diǎn)版本10或更低版本。
要完成的任務(wù)
部署分布式的站點(diǎn)需要兩個(gè)步驟:
1. 將內(nèi)容發(fā)布到IPFS,獲取新的CID。
2. 將ENS名稱的IPFS記錄設(shè)置為指向新的CID。
對(duì)于這兩個(gè)步驟,都可以使用命令行工具。 首先我們將詳細(xì)研究每個(gè)步驟,然后創(chuàng)建一個(gè)Travis配置,該配置將完全自動(dòng)化部署。
第1步-發(fā)布到IPFS
對(duì)于此任務(wù),我們將使用CLI工具ipfs-deploy。 通過npm全局安裝:
》 npm install -g ipfs-deploy
這個(gè)工具真的很簡(jiǎn)單。 您只需要提供要部署的構(gòu)建文件夾,然后選擇要使用的IPFS固定服務(wù)即可。
假設(shè)應(yīng)用的生產(chǎn)版本位于文件夾版本中,則可以運(yùn)行以下命令以通過公用的infura ipfs節(jié)點(diǎn)進(jìn)行部署:
》 ipfs-deploy build -p infura
注意ipfs-deploy提供的CID字符串Qm…。 這是構(gòu)建的唯一標(biāo)識(shí)符,需要將其添加到ENS名稱中。
Ipfs部署支持許多不同的IPFSpinning服務(wù),其中一些需要身份驗(yàn)證。
這就是第一步的全部?jī)?nèi)容-您的構(gòu)建現(xiàn)已發(fā)布!
步驟2 —設(shè)置您的ENS名稱的contenthash記錄
對(duì)于此步驟,我們將使用cli工具ens-updater。通過npm全局安裝:
》 npm install -g @triplespeeder/ens-updater
ens-updater支持許多不同的命令來管理您的ENS名稱。對(duì)于本教程,我們只希望設(shè)置名稱的contenthash條目,使其指向您在步驟1中獲得的CID。請(qǐng)檢查ens-updater --help的輸出,以獲取受支持命令的概述以及github頁面的內(nèi)容。
由于我們需要與ENS智能合約進(jìn)行交互以更新contenthash條目,因此我們需要做兩件事:
1. 訪問以太坊節(jié)點(diǎn)以與智能合約進(jìn)行交互。
2. 控制ENS名稱的帳戶的私鑰。
您可以直接或通過助記符字符串(和可選的帳戶索引)間接提供私鑰。對(duì)于這兩個(gè)選項(xiàng),您都需要將信息放入.env文件中或設(shè)置環(huán)境變量。
對(duì)于本教程,我們將私鑰保存在.env文件中。 打開您選擇的文本編輯器,并在工作目錄中創(chuàng)建文件.env:
PRIVATE_KEY=《private key here, without leading 0x》
為確保所有設(shè)置均正確,請(qǐng)使用--dry-run選項(xiàng)調(diào)用ens-updater。 設(shè)置此選項(xiàng)后,將不會(huì)執(zhí)行任何實(shí)際交易,但將報(bào)告潛在的配置或設(shè)置問題。
示例:在空運(yùn)行模式下,將ENS名稱mysite.eth的內(nèi)容哈希記錄設(shè)置為ipfs CID Qmd2yEHMTswLppDkWNjEMH4WwAgeuFXYeMHSn4VcJMcvKy的完整命令:
》 ens-updater setContenthash mysite.eth ipfs-ns
Qmd2yEHMTswLppDkWNjEMH4WwAgeuFXYeMHSn4VcJMcvKy --web3
http://localhost:8545 --verbose --dry-run
檢查結(jié)果輸出以查看是否報(bào)告了任何錯(cuò)誤。否則,您最好不用— dry-run繼續(xù)!
現(xiàn)在將瀏覽器指向http://mysite.eth。假設(shè)您的系統(tǒng)設(shè)置正確,可以與.eth域一起使用,那么您應(yīng)該會(huì)看到您的網(wǎng)站正在運(yùn)行!
這就是第2步的全部操作-現(xiàn)在可以通過您的ENS名稱訪問您的網(wǎng)站!繼續(xù)閱讀以設(shè)置Travis進(jìn)行自動(dòng)部署。
將它們放在一起進(jìn)行全自動(dòng)部署
要使用Travis自動(dòng)執(zhí)行上述步驟,我們需要:
1. 創(chuàng)建一個(gè)結(jié)合了ipfs-deploy和ens-updater的部署腳本,由Travis在部署階段執(zhí)行。
2. 設(shè)置Travis以執(zhí)行部署腳本。
3. 為Travis設(shè)置環(huán)境變量,以便ens-updater可以訪問私鑰。
部署腳本
由于ipfs-deploy通過stdout提供了CID,并且可以將ens-updater設(shè)置為從stdin中讀取CID,因此我們可以將這兩個(gè)命令用pipe連接在一個(gè)小型shell腳本中,如下所示:
#!/bin/bash
ipfs-deploy build -p $1 -C -O |
ens-updater setContenthash mysite.eth ipfs-ns stdin -v --web3 $2
該腳本希望將pinner服務(wù)用于部署作為第一個(gè)參數(shù),并將web3連接字符串用作第二個(gè)參數(shù)。 另外,請(qǐng)注意,通過將特殊字符串“ stdin”指定為ens-updater的CID,它知道從stdin中讀取CID。
將此腳本添加到您的項(xiàng)目中,使其成為存儲(chǔ)庫的一部分并可供Travis使用。
Travis配置
現(xiàn)在編輯travis.yaml以在部署階段執(zhí)行腳本。這是一個(gè)真實(shí)項(xiàng)目中的(精簡(jiǎn)后的)樣本配置,其中強(qiáng)調(diào)了重要的部分:
os: linux
language: node_js
node_js: 10
jobs:
include:
- name: “IPFS”
install:
- npm ci
- npm install -g ipfs-deploy
- npm install -g @triplespeeder/ens-updater
script: npm run build
deploy:
provider: script
script: bash scripts/deploy_ipfs.sh pinata https://mainnet.infura.io/v3/$INFURA_ID
skip_cleanup: true
安裝階段包含用于安裝工具ipfs-deploy和ens-updater的其他命令。
部署階段使用ipfs pinner服務(wù)“ pinata”和來自infura的web3實(shí)例執(zhí)行我們剛剛創(chuàng)建的部署腳本。 不要忘記skip_cleanup選項(xiàng)-否則,Travis將在開始部署之前清除build文件夾。..
最后缺少的部分是提供ENS名稱控制器帳戶的私鑰。讓我們進(jìn)行設(shè)置!
1. 轉(zhuǎn)到Travis中的項(xiàng)目頁面
2. 打開設(shè)置頁面
3. 轉(zhuǎn)到“Environment Variables”部分
添加一個(gè)名稱為“ PRIVATE_KEY”的新環(huán)境變量,并將您的私鑰粘貼到VALUE字段中。將BRANCH字段設(shè)置為您的master分支,因?yàn)椴渴饘H從master分支運(yùn)行。確保不要選中“DISPLAY VALUE IN BUILD LOG”-否則任何人都可以在構(gòu)建日志中看到您的私鑰。
就我而言,我還為pinata IPFS服務(wù)和Infura web3服務(wù)添加了環(huán)境變量,并為可選部署到Github頁面添加了GitHub令牌。 這是完整設(shè)置的屏幕截圖:
在這些更改就位后,觸發(fā)新的生成。如果一切順利,您的構(gòu)建日志將像這樣結(jié)束:
就是這樣!每當(dāng)您將更新推送到主分支時(shí),所做的更改都將部署到IPFS,并且ENS名稱的contenthash記錄也將更新。