Node.js SDK to launch/manage escrows on Human Protocol
This SDK is available on NPM.
yarn add @human-protocol/sdk
-
InitClient
InitClient has one static function that returns a
SignerorProvider(depending on the passed parameter), as well as a chainId associated with this parameter in an asynchronous way. Used for further passing as a constructor parameter to Web3 dependent modules. -
StorageClient
StorageClient is used to upload/download files to the cloud storage with given credentials and params. If credentials are not provided, anonymous access will be used (for downloading files).
-
EscrowClient
EscrowClient enables to perform actions on Escrow contracts and obtain information from both the contracts and subgraph. Internally, the SDK will use one network or another according to the network ID of the
signerOrProvider. -
KVStoreClient
KVStoreClient enables to perform actions on KVStore contract and obtain information from both the contracts and subgraph. Internally, the SDK will use one network or another according to the network ID of the
signerOrProvider. -
StakingClient
StakingClient enables to perform actions on staking contracts and obtain staking information from both the contracts and subgraph. Internally, the SDK will use one network or another according to the network ID of the
signerOrProvider.
const {
EscrowClient,
StakingClient,
NETWORKS,
ChainId,
} = require('@human-protocol/sdk');
const { ethers } = require('ethers');
(async () => {
// Hardhat Provider
const provider = new ethers.providers.JsonRpcProvider(
'http://127.0.0.1:8545/'
);
// Load localhost configuration
const network = NETWORKS[ChainId.LOCALHOST];
const signer = new ethers.Wallet(
'0x5de4111afa1a4b94908f83103eb1f1706367c2e68ca870fc3fb9a804cdab365a',
provider
);
// Initialize StakingClient
const stakingClient = new StakingClient({
signerOrProvider: signer,
network,
});
// Stake 10 HMT
await stakingClient.approveStake(ethers.BigNumber.from(10));
await stakingClient.stake(ethers.BigNumber.from(10));
// Initialize EscrowClient
const escrowClient = new EscrowClient({
signerOrProvider: signer,
network,
});
// Create a new escrow, and setup
const escrowAddress = await escrowClient.createEscrow(network.hmtAddress, [
signer.address,
]);
await escrowClient.setup(escrowAddress, {
recordingOracle: '0x90F79bf6EB2c4f870365E785982E1f101E93b906',
reputationOracle: '0x15d34AAf54267DB7D7c367839AAf71A00a2C6A65',
exchangeOracle: '0x6b7E3C31F34cF38d1DFC1D9A8A59482028395809',
recordingOracleFee: ethers.BigNumber.from(1),
reputationOracleFee: ethers.BigNumber.from(1),
exchangeOracleFee: ethers.BigNumber.from(1),
manifestUrl: 'http://example.com',
hash: 'test',
});
})();