js-neurahive-sdk

This is the JavaScript SDK for Neurahive. Features include:

• [x] File Merkle Tree Class
• [x] Flow Contract Types
• [x] RPC methods support
• [x] File upload
• [x] Support browser environment
• [ ] Tests for different environments
• [ ] File download

Install

npm install js-neurahive-sdk ethers

ethers is a peer dependency of this project.

Usage

NH is short for Neurahive.

Node.js environment ESM example:

Use NHFile to create a file object, then call merkleTree method to get the merkle tree of the file.

import { NHFile } from 'js-neurahive-sdk';

const file = await NHFile.fromFilePath('path/to/file');
const tree = await file.merkleTree();
if (tree) {
  console.log("File Root Hash: ", tree.rootHash());
}
await file.close();

Create and submit submission:

import { getFlowContract, TESTNET_FLOW_ADDRESS } from 'js-neurahive-sdk';
import { ethers } from 'ethers';

// create ethers signer from private key and rpc endpoint
const evmRpc = 'https://evmtestnet.confluxrpc.com';
const provider = new ethers.JsonRpcProvider(evmRpc);
const privateKey = 'your-private-key'; // with balance to pay for gas
const signer = new ethers.Wallet(privateKey, provider);

// get flow contract instance
const flowContract = getFlowContract(TESTNET_FLOW_ADDRESS, signer);

const tagBytes = '0x';
const submission = await file.createSubmission(tagBytes); // check previous example for file
let tx = await flowContract.submit(submission);
await tx.wait();
console.log(tx.hash);

Upload file to neurahive:

import { NHProvider } from 'js-neurahive-sdk';

const nhRpc = 'http://47.92.4.77:5678';
const nhProvider = new NHProvider(nhRpc);

await nhProvider.uploadFile(file);

Browser environment example:

Import neurahive.esm.js in your html file:

<script type="module">
  import { NHBlob, NHProvider, getFlowContract } from "./dist/neurahive.esm.js";
  // Your code here...
</script>

Create file object from blob:

const file = new NHBlob(blob);
const tree = await file.merkleTree();
if (tree) {
  console.log("File Root Hash: ", tree.rootHash());
}

Create and submit submission:

// create ethers signer from private key and rpc endpoint
import { BrowserProvider } from 'ethers';  // or from ethers.js url
import { getFlowContract, TESTNET_FLOW_ADDRESS } from 'js-neurahive-sdk';
let provider = new BrowserProvider(window.ethereum) // metamask need to be installed
let signer = await provider.getSigner();

// get flow contract instance
const flowContract = getFlowContract(TESTNET_FLOW_ADDRESS, signer);

const tagBytes = '0x';
const submission = await file.createSubmission(tagBytes); // check previous example for file
let tx = await flowContract.submit(submission);
await tx.wait();
console.log(tx.hash);

File upload is same with node.js environment.

Check codes in examples for more details.

Contribute

This project uses pnpm as package manager. After cloning the project, run pnpm install to install dependencies.

Generate Contract Flow Types

Make sure neurahive-contracts is in project sibling directory.

pnpm gen-contract-type-flow

Issues

• The error return style should be change to throw error
• Upload big file failed, for example ~/Downloads/2.png: index exceeds window limit, index = 19, left_boundary = 13, window_size = 4