开始

本指南将解释如何安装 js-mcs-sdk 及其基本用法

先决条件

• Node.js - 此 SDK 使用版本 v16.13.0 (npm v8.1.0) 构建

• Polygon Mumbai Testnet 钱包 - Metamask Tutorial

• Polygon Mumbai Testnet Alchemy RPC - Alchemy Tutorial

• Mumbai Testnet USDC和 MATIC 也是必需的-Swan Faucet Tutorial

安装

使用 npm 安装包。建议为新项目创建新目录。

npm init -y
npm install js-mcs-sdk

环境变量

获得Mumbai 测试网钱包和 RPC URL 后，创建一个名为 .env并存储你钱包的私钥和 RPC URL。

PRIVATE_KEY=<PRIVATE_KEY>
RPC_URL=https://polygon-mumbai.g.alchemy.com/v2/<API_KEY>

小心不要泄露这些信息

向他人透露您的私钥将使他们能够访问您的钱包

编写SDK脚本

要开始使用 SDK 编写脚本前, 需创建一个新的.js 文件。让我们创建一个名为 demo.js文件。

此文件的上方需放置脚本所需的套件。

// demo.js
require('dotenv').config()
const { mcsSDK } = require('js-mcs-sdk')

• require('donenv').config() 将加变量在你的 .env 文件中以执行process.env

• const { mcsSDK } = require('js-mcs-sdk') 将引入 SDK

接下来，在引入SDK完成后，需要执行初始化

require('dotenv').config()
const { mcsSDK } = require('js-mcs-sdk')

// set up js-mcs-sdk
const mcs = new mcsSDK({
  privateKey: process.env.PRIVATE_KEY,
  rpcUrl: process.env.RPC_URL,
})

现在我们可以开始使用SDK工具，由于这个函数是异步的，我们需要创建一个async 函数来跑SDK工具。

require('dotenv').config()
const { mcsSDK } = require('js-mcs-sdk')

// set up js-mcs-sdk
const mcs = new mcsSDK({
  privateKey: process.env.PRIVATE_KEY,
  rpcUrl: process.env.RPC_URL,
})

async function main() {
  // code snippets found in the documentation go here
}

main()

这是SDK文档中所有片段的样板代码。

上传文件示例

这是一个将单个文件上传到 MCS 的简单示例。 新建了一个文件名为 upload.js

require('dotenv').config()
const { mcsSDK } = require('js-mcs-sdk')

// set up js-mcs-sdk
const mcs = new mcsSDK({
  privateKey: process.env.PRIVATE_KEY,
  rpcUrl: process.env.RPC_URL,
})

async function main() {
  const testFile = JSON.stringify({ address: mcs.publicKey })
  const fileArray = [{ fileName: `${mcs.publicKey}.txt`, file: testFile }]

  const uploadResponse = await mcs.upload(fileArray)
  console.log(uploadResponse)
}

main()

使用命令 node upload.js运行代码。 此代码段创建 MCS SDK 实例，使用您的钱包地址创建 JSON 文件，并将文件上传到 MCS。