叩頂窩客 - KodingWork
  • Stable Diffusion
  • Blockchain
  • Arduino
    • ESP32
    • Raspberry Pi Pico
  • Raspberry Pi
    • Raspberry Pi
    • Odroid HC4
    • Banana Pi
  • 創客計畫
    • AI 神經網路自走車
    • 智慧家居
  • Python
  • AWS
  • 開發哲學
  • 關於作者 J
Stable Diffusion
Blockchain
Arduino
    ESP32
    Raspberry Pi Pico
Raspberry Pi
    Raspberry Pi
    Odroid HC4
    Banana Pi
創客計畫
    AI 神經網路自走車
    智慧家居
Python
AWS
開發哲學
關於作者 J
叩頂窩客 - KodingWork
  • Stable Diffusion
  • Blockchain
  • Arduino
    • ESP32
    • Raspberry Pi Pico
  • Raspberry Pi
    • Raspberry Pi
    • Odroid HC4
    • Banana Pi
  • 創客計畫
    • AI 神經網路自走車
    • 智慧家居
  • Python
  • AWS
  • 開發哲學
  • 關於作者 J
Angular•Blockchain•Frontend

能夠用 Web3.js 做去中心化的 NFT Dapp 嗎?

2022-05-27 by J No Comments

NFT 雖然是架構在去中心化的區塊鏈上,但我們查看或交易的時候,依然習慣前往中心化的 OpenSea 或者 Rarible 等平台。如果想從 Etherscan 直接查看,卻只能看到 contract 的狀態,如 token 擁有者或是轉移歷史等。依然無法看到「眼睛想看」的 JPG。能夠透過 Web3.js 簡單搭建一個去中心化的網站來達成這件事嗎?這篇文章即是分享實驗的經過。

Web3.js 是什麼?

Web3.js 是以太坊官方推出與區塊鏈溝通的套件,將 RPC-API 封裝後提供給 Javascript 使用。

但他只是 API 封裝,所以需要區塊鏈節點(Server)才能運作。可以透過瀏覽器錢包 injected provider,或是使用第三方的 RPC-API,以及使用自己本機架設的節點 API 等方式來操作。

import Web3 from 'web3';
// 使用錢包 inject 的 provider,若無 givenProvider 則為 null
web3 = new Web3(Web3.givenProvider)
// 使用第三方 RPC-API
web3 = new Web3('https://mainnet.infura.io/v3/...')
// 使用本機節點 RPC-API
web3 = new Web3('ws://localhost:8545"')

如何透過 Web3.js 查看 NFT?

既然是透過 Web3.js 跟 Smart Contract 互動,我們只能使用 Contract 現有的方法來實現我們的功能。

這個 DApp 需要有以下功能:

  1. 能夠取得 NFT 基本資訊(name、symbol、total supply)
  2. 能夠取得個別的 tokenURI 與 metadata
  3. 將資料以卡片和圖片的方式顯示在頁面上
  4. 有 token 個人頁面,列出所有 metadata 上的資料

為了方便開發,其中做了幾個假設:

  1. token id 起始值為 1
  2. token id 是單調遞增
  3. 僅支援 ERC-721 實作的 NFT

看了看需求與 ERC-721 能用的方法如下:

  1. 透過 name()、symbol()、totalSupply() 等方法取得基本資訊
  2. 透過 迭代 所有 token id 的方式,使用 ownerOf()、tokenURI() 取得每張 NFT 的擁有者和 metadata 存放路徑
  3. 分別使用 tokenURI() 回傳的路徑去抓取 metadata
// 取得 name
contract.methods.name().call().then((ret) => ...)
// 取得 symbol
contract.methods.symbol().call().then((ret) => ...)
// 取得 totalSupply
contract.methods.totalSupply().call().then((ret) => ...)
// 取得 ownerOf
contract.methods.ownerOf(tokenId).call().then((ret) => ...)
// 取得 tokenURI
contract.methods.tokenURI(tokenId).call().then((ret) => ...)

詳細的實作可以參考 這邊 ERC721.ts 和 這邊 TokenURIService.ts。

這種方法非常沒有效率,一個 token 平均要三次 request 才能取得必要的資料(分別是取 owner、tokenURI、metadata),違反我們設計前後端溝通的模式。如果一百張就要 3000 次 request!但沒辦法,若要做到去中心化,只能直接與 Smart Contract 溝通,而當初 ERC-721 的介面比較像是提供給詢問 單一 token 使用。因此要做類似 NFT 交易平台的清單頁面,只能透過多次呼叫實現。

為了避免一次性大量呼叫,頁面必須做分頁,並且只發 request 抓回必要的資料,減少效能消耗。可參考 NftSeriesComponent 實作。

如何解決 CORS 問題?

若 metadata 是託管在中心化的伺服器,瀏覽器直接去打會發生 CORS error,因為 metadata 所在的 domain 一定與 NFT Viewer app 不一樣,對方也不會幫忙在 response header 增加 Access-Control-Allow-Origin 等等允許跨網域請求的 header,怎麼辦呢?

首先思考為何 NFT 平台他們抓資料時不會發生此問題?因為 CORS 只發生在瀏覽器!瀏覽器在每一個 response 送回後會做 CORS 檢查。

所以只要有一個中間人:

  1. 接收 request 並轉發到目標伺服器
  2. 得到 response 後自行加上 CORS 所需的 header
  3. 吐回瀏覽器即可

即所謂的 CORS proxy。

本來想自己用 Django 架,但查了下已經有高手用 nodejs 開發好了

cors-anywhere

簡單用他 demo 的 server.js 就可以跑起來,完全無痛!

託管在 IPFS 的檔案如何取得?

有些 metadata 或圖片會託管在 IPFS 上,通常以 ipfs:// 開頭,後面接上一串 CID。此時將 CID 改接在 Public IPFS Gateway 即可,如

https://cloudflare-ipfs.com/ipfs/<CID>
https://ipfs.fleek.co/ipfs/<CID>

實做出來的 DApp 有完全去中心化嗎?

個人覺得沒有完全,因為

  1. Web3.js 使用 injected provider 時,通常是透過錢包,而錢包也是透過中心化的 RPC-API server 實現功能
  2. 若 metadata host 在 IPFS 上,還是透過 Public IPFS Gateway 去取得,依然是中心化 server
  3. 若 metadata host 在私人 Server 上,本身已經中心化,還需過一個自架的中心化 CORS Proxy 解決 CORS error 問題

主因還是使用者不會自行架設區塊鏈和 IPFS 節點,只能使用第三方服務來實現。但相對透過 OpenSea、Rarible 等平台來說,已經相對去中心化很多!若使用者能用自己的節點,就能非常接近去中心化了!

這個 DApp 只要 Smart Contract 還在鏈上,就看得到 NFT ,不會被下架,除非有人能夠同時 hack RPC-API server 和 IPFS,否則要被消失還是比較難。

瀏覽效能呢?

和區塊鏈的 RPC-API 溝通上速度非常快,但如果從 IPFS 取得 metadata 或圖片等資料就不一定,只有在 IPFS Gateway hit cache 的時候才能迅速顯示,否則還是會有 IPFS timeout 或速度慢等老問題。相對的從中心化伺服器取資料就非常快速。

如何將 NFT Viewer DApp 託管在 IPFS 上?

既然要做 DApp,當然要把前端 deploy 到 IPFS 上,詳細可以參考 如何用 IPFS 架設去中心化網站?

實際 DApp:
https://nft-viewer-ipfs.koding.work

如果卡了,也可以使用 hosting by Fleek 的版本:
https://nft-viewer.koding.work

原始碼參考:
https://github.com/Jim-Chang/nft-viewer

能夠用 Web3.js 做去中心化的 NFT Dapp 嗎?
輸入合約地址後即可查看 NFT
能夠用 Web3.js 做去中心化的 NFT Dapp 嗎?
也可以看周董的 NFT

延伸閱讀:
實測!用 Unstoppable Domains 鑄造區塊鏈域名並架站
用前端框架開發 IPFS Web3 DApp 有哪些坑?
如何用 IPFS 架設去中心化網站?
自己寫 NFT 吧!- 實現 ERC-721 – 以 Python Brownie 開發

Continue reading
Share:
Angular•Blockchain•Frontend

用前端框架開發 IPFS Web3 DApp 有哪些坑?

2022-05-21 by J No Comments

Web3.js 是以太坊推出的官方 library,可以透過他開發與區塊鏈互動的應用。IPFS 是一個點對點傳輸協議,可以透過他架設去中心化網站。但使用前端框架架設時會有什麼坑要避免呢?在這邊分享幾個經驗讓大家避免踩坑

使用 IPFS 託管 DApp 需注意的地方

如果使用 IPFS 架站,有兩點需要特別注意:

  • build 出來的靜態檔案必須在同一個資料夾下,且資料夾中要有 index.html 檔案
  • 所有靜態檔案連結需要使用相對連結

原因是 IPFS 託管網站時,上傳資料夾會得到一個 CID,如

QmV3NBfZLSFq8oQgiEKBraiEWEyrpPcDeifWUEahUuzRfc

要查看網站時,則在 IPFS Gateway 後面加上 /ipfs/<CID>,如

https://cloudflare-ipfs.com/ipfs/QmPyTGEnfmAtYr9LcfCsLQnYyFvE49PJHYL4g8SFLq2qvq

此時 IPFS Gateway 會去 CID 對應目錄下尋找 index.html 檔案,如果找不到,會像 Apache 一樣把整個目錄回傳。

同時我們觀察到,網站根目錄不再是 "/",而是

/ipfs/QmPyTGEnfmAtYr9LcfCsLQnYyFvE49PJHYL4g8SFLq2qvq/

這和以往我們開發網頁的習慣不一樣,為了讓靜態檔案能夠順利載入,必須使用相對連結,同時需要一些手法讓前端路由能正確操作。

動態設定路由根目錄

Angular

在 index.html 用以下取代原本 <bash href> 中的內容

<script>
     document.write('<base href="'+window.location.pathname+'"/>');
</script>

因為無法在 deploy 前知道 IPFS 的 CID,只能在網頁載入時動態使用 window.location.pathname 設定路由根目錄。

參考 Pinata 提供的 Angular-IPFS-Example

ReactJS

在 package.json 加入這一行即可

"homepage": "./",

參考 Pinata 提供的 React-IPFS-Example

VueJS

在 vue.config.js 中加入以下

module.exports = {
    publicPath: './'
};

參考 Pinata 提供的 Vue-IPFS-Example

使用 Hash URL style 前端路由

一般會使用預設的 HTML5 pushState style 作為前端路由,比如說進入 DApp 的搜尋頁面,可能會用以下路由

/search

若以 nginx 做 reverse proxy 時,會加上以下設定,在後端找不到 /search 路徑時,直接回傳 index.html 給 browser,前端起來後就能自己用前端路由切換頁面

location / {
   try_files $uri $uri/ /index.html; 
}

但用 IPFS hosting 時,沒辦法添加如 nginx 的設定,會導致無法在 CID 對應的目錄下找到 search 資料夾,因而回傳 404。

此時可以改用 Hash URL style 前端路由,如

/#/search

對 IPFS 而言,hash 以後的字串可以當作看不到,如此 IPFS 能正確找到 index.html 回傳,前端起來後也能正確切換頁面。

以 angular 為例,只需要在 app-routing.module.ts 中 imports RouterModule.forRoot() 增加參數 { useHash: true } 即可

@NgModule({
  imports: [RouterModule.forRoot(routes, { useHash: true })],
  exports: [RouterModule],
})
export class AppRoutingModule {}

舉例:

使用 Hash URL style 可以正常顯示網頁

https://cloudflare-ipfs.com/ipfs/
QmPyTGEnfmAtYr9LcfCsLQnYyFvE49PJHYL4g8SFLq2qvq/
#/contract/0x79fcdef22feed20eddacbb2587640e45491b757f

使用 HTML 5 push style

https://cloudflare-ipfs.com/ipfs/
QmV3NBfZLSFq8oQgiEKBraiEWEyrpPcDeifWUEahUuzRfc/
contract/0x79fcdef22feed20eddacbb2587640e45491b757f

則會回傳錯誤訊息

<code>ipfs resolve -r /ipfs/QmV3NBfZLSFq8oQgiEKBraiEWEyrpPcDeifWUEahUuzRfc/contract/0x79fcdef22feed20eddacbb2587640e45491b757f: no link named "contract" under QmV3NBfZLSFq8oQgiEKBraiEWEyrpPcDeifWUEahUuzRfc</code>

瀏覽器不一定支援 Web3

使用 Web3 起手第一步,初始化 Web3 instance

this.web3 = new Web3(Web3.givenProvider);

但 Web3.givenProvider 會有東西的前提是瀏覽器支援 Web3 或者有裝錢包外掛,否則其為空。

此時要考量你的 DApp 是否要讓一般瀏覽器也能運作(比如說純 Read,不能提交 Transaction),若想要向下支援,可以考慮使用託管的節點,比如說 infura

if (Web3.givenProvider) {
  this.web3 = new Web3(Web3.givenProvider);
} else {
  console.log('web3 provider not found');
  this.web3 = new Web3('https://mainnet.infura.io/v3/<YOUR PROJ ID>');
}

如何引入 ABI json

在 TypeScript 中要引用 contract 的 ABI json 靜態檔案,先在 tsconfig.json 中設定 resolveJsonModule

"compilerOptions": {
  "resolveJsonModule": true
}

在程式中即可直接 import 並用來初始化 Contract,比如

import ABI_ERC721 from 'ABI/ERC721.json';
this.contract = new this.web3.eth.Contract(ABI_ERC721 as AbiItem[], this._address);

參考我的 github ERC721 contract class 的實作。

引用 window.ethereum 時發生 type not found

這個問題只有在 TypeScript 會發生。當引用 window.ethereum 時 compiler 會立刻抱怨找不到 type define

Property 'ethereum' does not exist on type 'Window & typeof globalThis'.

可以安裝 Metamask 提供的套件 @metamask/providers

npm install @metamask/providers

並加上宣告

import { MetaMaskInpageProvider } from '@metamask/providers';

declare global {
  interface Window {
    ethereum: MetaMaskInpageProvider;
  }
}

如此即可安撫 compiler。

Build Code 時發生 Can’t resolve ‘crypto’

用 angular 開發時,import web3 library 後 compiler 會立刻不爽抱怨:

ERROR in ../node_modules/eth-lib/lib/bytes.js
Module not found: Error: Can't resolve 'crypto' in '*/node_modules/eth-lib/lib'
ERROR in ../node_modules/web3-eth-accounts/node_modules/eth-lib/lib/bytes.js
Module not found: Error: Can't resolve 'crypto' in '*/node_modules/web3-eth-accounts/node_modules/eth-lib/lib'

解法是,先安裝必要套件

npm install crypto-browserify stream-browserify assert stream-http https-browserify os-browserify

在 tsconfig.json 中將套件路徑加入 compilerOptions.paths

{
  "compilerOptions": {
    "paths" : {
      "crypto": ["./node_modules/crypto-browserify"],
      "stream": ["./node_modules/stream-browserify"],
      "assert": ["./node_modules/assert"],
      "http": ["./node_modules/stream-http"],
      "https": ["./node_modules/https-browserify"],
      "os": ["./node_modules/os-browserify"],
    }
  }
}

同時需要調整 polyfill.ts

(window as any).global = window;
global.Buffer = global.Buffer || require('buffer').Buffer;
global.process = require('process');

這樣 compiler 就會開心了!

另外一個解法是在 webpack.config.js 中加入以下設定,但這方法在 Angular 12 以後不適用,但還是記錄在這邊提供參考:

module.exports = {
  node: {
    crypto: true,
    path: true,
    os: true,
    stream: true,
    buffer: true
  }
}

希望大家能順利完成自己第一個 DApp,有任何問題也歡迎在下面討論!

延伸閱讀:
如何用 IPFS 架設去中心化網站?
實測!用 Unstoppable Domains 鑄造區塊鏈域名並架站
自己寫 NFT 吧!- 實現 ERC-721 – 以 Python Brownie 開發

參考資料:
How to Easily Host a Website on IPFS
IPFS and Angular 6
Error: Can’t resolve ‘crypto’ 

Continue reading
Share:

About me

author j

J

雖然大學唸的是生物,但持著興趣與熱情自學,畢業後轉戰硬體工程師,與宅宅工程師們一起過著沒日沒夜的生活。之後憑著一股傻勁與朋友創業,再度轉戰軟體工程師,一手扛起前後端、雙平台 app 開發,過程中雖跌跌撞撞,卻也累計不少經驗。

可惜不是那 1% 的成功人士,於是加入其他成功人士的新創公司,專職開發後端。沒想到卻在採前人坑的過程中,拓寬了眼界,得到了深層的領悟。...more

Categories

  • Angular (5)
  • Arduino (5)
    • ESP32 (2)
    • Raspberry Pi Pico (3)
  • AWS (15)
  • Blockchain (11)
  • Deep Learning (16)
    • LLM (2)
    • Stable Diffusion (9)
  • DevOps (22)
  • Frontend (6)
  • Golang (1)
  • Kafka (2)
  • Python (13)
  • Raspberry Pi (32)
    • Banana Pi (3)
    • Jetson Nano (2)
    • Odroid HC4 (4)
    • Rock Pi (6)
  • RetroArch (2)
  • ROS (2)
  • Wordpress (10)
  • 健身 (1)
  • 創客計畫 (15)
    • AI 神經網路自走車 (8)
    • 智慧家居 (7)
  • 好物推薦 (1)
  • 旅行 (2)
    • 峇里島 (2)
  • 說人話的名詞解釋 (3)
  • 那些踩過的坑 (8)
  • 開發哲學 (3)
  • 閱讀筆記 (4)
  • 面試策略 (2)

© 2023 copyright KodingWork  All rights reserved