Skip to content

Get Started

SDK

POB 提供了开箱即用的 JavaScript Client SDK,可以让开发者快速的开发出一个可以在线使用的应用。同时也提供了一个简单的 API 文档,可以帮助开发者快速的了解 POB 的 API。

如果需要直接和合约交互的,请参考 合约 部分。

💡
当前 SDK 仅支持 Goerli 测试网。

Installation

# npm
npm install @m7eio/pob-js-sdk
# yarn
yarn add @m7eio/pob-js-sdk

How to use

In Browser

Switch to the goerli network and import SDK.

import POB from '@m7eio/pob-js-sdk'
import Web3Modal from 'web3modal'
import { ethers } from 'ethers'
// ...
// web3 modal params
const w3Modal = new Web3Modal(params)
const instance = await w3Modal.connect()
// ethers.providers.Provider | ethers.Signer
const provider = new ethers.providers.Web3Provider(instance)
const pob = new POB(provider)
// create workflow
pob.workflow.create()
// apply workflow
pob.workflow.apply()
// ...
// apply task
pob.task.apply()
// ...

In Node.js

import POB from '@m7eio/pob-js-sdk'
import { ethers } from 'ethers'
const provider = new ethers.providers.AlchemyProvider('goerli', 'api key')
const pob = new POB(provider)
// create workflow
pob.workflow.create()
// apply workflow
pob.workflow.apply()
// ...
// apply task
pob.task.apply()
💡
想要了解更过关于 SDK 的使用方法请阅读 SDK