安装和配置适用于 Visual Studio Code 的区块链应用程序构建器扩展

可通过 Oracle Blockchain Platform 控制台下载适用于 Visual Studio Code 的 Blockchain App Builder 扩展。

支持以下平台：
  • macOS
  • Oracle Linux 8.0 或 9.0
  • Microsoft Windows 10 或 11

Prerequisites

在本地系统上安装 Blockchain App Builder 之前，必须先安装先决条件。

注意：

区块链应用构建器可与 Oracle Blockchain Platform 及其编译器进行协调。如果使用以下部分提到的先决条件之外的其他任何版本，则将链代码部署到远程 Oracle Blockchain Platform 网络可能会失败。

安装 Blockchain App Builder 时，先运行先决条件检查。如果先决条件检查失败，则安装过程将停止。

先决条件

  • Rancher Desktop（使用 1.4.1 进行测试）。Blockchain App Builder 也可以与 Docker 一起使用，但它已经通过 Rancher Desktop 进行了测试和验证。如果您打算使用 Rancher Desktop，请在安装 Rancher Desktop 之前完全卸载 Docker。安装 Rancher Desktop 之后，确保容器运行时设置为 dockerd (moby) 。要在 Rancher Desktop 1.4.1 中验证容器运行时，请单击 Kubernetes 设置 > 容器运行时。
  • Node.js 版本 18 的最新版本（使用 18.15.0 和 18.16.0 进行测试）和 npm v8.x 或 9.x（使用 9.5.0 和 9.5.1 进行测试）

    通过运行以下命令检查 Node.js 版本：node --version

    通过运行以下命令检查 npm 版本：npm --version

    如果使用 nvm 或 nodenv 等管理器安装 Node.js 和 npm，请设置默认/全局版本，然后重新启动 Visual Studio Code，以便先决条件页可以检测到该版本。

    请勿使用早于或晚于版本 18 的 Node.js 版本。

  • 转到 v1.23.2 或更高版本，但不转到 v1.24 或更高版本。安装 Blockchain App Builder 后，请参见 Additional Setup for Go Chaincode Projects 。

    通过运行以下命令检查 Go 版本：go version

  • 如果您计划使用区块链应用程序构建器的同步功能，请安装 Git 并配置用户名和电子邮件，如以下命令中所示。在 <your_name> 和 <email> 的位置指定您的用户名和电子邮件地址。 
    git config --global user.name "<your_name>" 

    git config --global user.email "<email>"
  • Visual Studio Code 版本 1.66.0 或更高版本

    通过运行以下命令检查 Visual Studio Code 版本：code --version

使用 nvm 安装 Node.js 和 npm

使用 nvm 安装 Node.js 和 npm 可在不使用 sudo 的情况下运行更多命令。
  1. 输入以下命令以安装 nvm：
    curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash
  2. 将以下代码片段添加到适用文件中：~/.bash_profile、~/.profile、~/.bashrc 或 ~/.zshrc。
    export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"  # This loads nvm
[ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion"  # This loads nvm bash_completion
  3. 注销，然后重新登录您的操作系统。
  4. 输入以下命令以验证 nvm 安装：
    nvm version
  5. 输入以下命令以安装 Node.js 和 npm：
    nvm install 18.16.0
  6. 输入以下命令将 Node.js 18.16.0 设置为 nvm 中的缺省值：
    nvm alias default 18.16.0
    该命令的输出为以下文本：
    default -> 18.16.0 (-> v18.16.0)

先决条件

  • Docker v18.09.0 或更高版本
  • Docker 编写 v1.23.0 或更高版本
  • Node.js 版本 18 的最新发行版（使用 18.15.0 和 18.16.0 进行测试）和 npm v8.x 或 v9.x（使用 9.5.0 和 9.5.1 进行测试）

    通过运行以下命令检查 Node.js 版本：node --version

    通过运行以下命令检查 npm 版本：npm --version

    如果使用 nvm 或 nodenv 等管理器安装 Node.js 和 npm，请设置默认/全局版本，然后重新启动 Visual Studio Code，以便先决条件页可以检测到该版本。

    请勿使用早于或晚于版本 18 的 Node.js 版本。

  • 转到 v1.23.2 或更高版本，但不转到 v1.24 或更高版本。安装 Blockchain App Builder 后，请参见 Additional Setup for Go Chaincode Projects 。

    通过运行以下命令检查 Go 版本：go version

  • 如果您计划使用区块链应用程序构建器的同步功能，请安装 Git 并配置用户名和电子邮件，如以下命令中所示。在 <your_name> 和 <email> 的位置指定您的用户名和电子邮件地址。 
    git config --global user.name "<your_name>" 

    git config --global user.email "<email>"
  • Visual Studio Code 版本 1.66.0 或更高版本

    通过运行以下命令检查 Visual Studio Code 版本：code --version

使用 nvm 安装 Node.js 和 npm

使用 nvm 安装 Node.js 和 npm 可在不使用 sudo 的情况下运行更多命令。
  1. 输入以下命令以安装 nvm：
    curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash
  2. 将以下代码片段添加到适用文件中：~/.bash_profile、~/.profile、~/.bashrc 或 ~/.zshrc。
    export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"  # This loads nvm
[ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion"  # This loads nvm bash_completion
  3. 注销，然后重新登录您的操作系统。
  4. 输入以下命令以验证 nvm 安装：
    nvm version
  5. 输入以下命令以安装 Node.js 和 npm：
    nvm install 18.16.0
  6. 输入以下命令将 Node.js 18.16.0 设置为 nvm 中的缺省值：
    nvm alias default 18.16.0
    该命令的输出为以下文本：
    default -> 18.16.0 (-> v18.16.0)

先决条件

  • Rancher Desktop（使用 1.4.1 进行测试）。Blockchain App Builder 也可以与 Docker 一起使用，但它已经通过 Rancher Desktop 进行了测试和验证。
  • Node.js 版本 18 的最新发行版（经 18.15.0 和 18.16.0 测试）。请勿使用早于或晚于版本 18 的 Node.js 版本。
  • npm v8.x 或 v9.x（使用 9.5.0 和 9.5.1 进行测试）
  • 转到 v1.23.2 或更高版本，但不转到 v1.24 或更高版本。安装 Blockchain App Builder 后，请参见 Additional Setup for Go Chaincode Projects 。
  • 如果要使用区块链应用程序构建器的同步功能，请安装 Git 并配置用户名和电子邮件，如以下命令中所示。在 <your_name> 和 <email> 的位置指定您的用户名和电子邮件地址。 
    git config --global user.name "<your_name>" 

    git config --global user.email "<email>"

安装 Rancher 桌面

完成以下步骤以在 Microsoft Windows 上安装 Rancher Desktop。
  1. 如果本地计算机上安装了 Docker，请将其完全卸载。
  2. 下载并安装 Rancher Desktop。
  3. 安装向导完成后，在打开 Rancher Desktop 之前，运行以下命令：
    wsl --install
wsl --set-default-version 2
wsl --setdefault rancher-desktop
  4. 打开 Rancher Desktop 以完成设置过程。
  5. 安装 Rancher Desktop 之后，确保容器运行时设置为 dockerd (moby) 。要在 Rancher Desktop 1.4.1 中验证容器运行时，请单击 Kubernetes 设置 > 容器运行时。

安装区块链应用程序构建器扩展

  1. 从 Oracle Blockchain Platform 控制台的 Blockchain App Builder 窗格上的 Developer Tools 选项卡下载扩展。在区块链应用程序构建器窗格上的下载部分下，选择 Visual Studio Code Extension 。
  2. 在 Visual Studio Code 中，打开 Extensions 面板，然后从 More Actions（更多操作）菜单中选择 Install from VSIX（从 VSIX 安装）。
  3. 找到下载的 oracle-ochain-extension-x.x.x.vsix 文件，然后单击 Install 。（为要安装的版本调整 .vsix 文件的名称。）
  4. 重新启动 Visual Studio Code 以完成扩展的安装。
  5. 要使用规范文件验证函数（在您键入时自动验证规范文件），请从 Red Hat 安装 YAML 扩展名。打开 Extensions（扩展）面板，搜索 YAML，安装 YAML 语言支持扩展，然后重新启动 Visual Studio Code。

安装后，您可以使用 Visual Studio Code 左侧的 Oracle Blockchain App Builder 图标打开 Blockchain App Builder 面板。

此外，如果尚未单独安装 Blockchain App Builder 命令行界面 (command line interface，CLI)，该界面将作为 Visual Studio Code 扩展的一部分自动安装。CLI 命令可以从任何终端应用程序（包括 Visual Studio Code 控制台窗口）运行。Blockchain App Builder 已全局安装，因此您可以从文件系统中的任何位置运行 CLI 命令。

执行链代码项目的附加设置

要开发 Go 项目，必须设置 GOPATH 环境变量。这允许 Go 查找工作区并运行代码。

在设置 GOPATH 环境变量之前，请确保 $HOME 目录中存在 go/ 文件夹。如果不是，请输入以下命令在主目录中创建 go/ 目录：
mkdir $HOME/go
通过将以下变量添加到适用文件来设置 GOPATH 环境变量：~/.bash_profile、~/.profile、~/.bashrc 或 ~/.zshrc。
export PATH=$PATH:/usr/local/go/bin
export GOPATH=$HOME/go
export PATH=$PATH:$GOPATH/bin
编辑文件后，运行以下命令以使更改立即生效：
source ~/.bash_profile

或者，可以通过将以前的变量添加到 /etc/bashrc 文件，在系统范围内应用更改。

在设置 GOPATH 环境变量之前，请确保 $HOME 目录中存在 go/ 文件夹。如果不是，请输入以下命令在主目录中创建 go/ 目录：
mkdir $HOME/go
通过将以下变量添加到适用文件来设置 GOPATH 环境变量：~/.bash_profile、~/.profile、~/.bashrc 或 ~/.zshrc。
export PATH=$PATH:/usr/local/go/bin
export GOPATH=$HOME/go
export PATH=$PATH:$GOPATH/bin
编辑文件后，运行以下命令以使更改立即生效：
source ~/.bash_profile

或者，可以通过将以前的变量添加到 /etc/bashrc 文件，在系统范围内应用更改。

在起始目录中创建 go/ 目录：C:\Users\<username>\go。