NuLink SDK

NuLink SDK is a software development kit designed to support privacy computing in the NuLink network.

Build & Install

Build Source

Set up your environment

  1. select a configuration file of your usage environment

  • Development Environment (.env.dev)

  • Production Environment (.env.prod)

  • Custom Environment (.env.example)

  1. Rename configuration file to .env

Set configuration for a custom environment

//Modify config:
//the sdk backend testnet server address. in the nulink testnet,
//you can use the address: https://agent.testnet.nulink.org/bk
REACT_APP_CENTRALIZED_SERVER_URL=xxxxx

//Configure the parameters of the network that you connect to. Parameters for networks that are not connected do not need to be configured.

//the nulink bsc testnet porter address. in the nulink testnet,
//you can use the address: https://agent.testnet.nulink.org/porter
REACT_APP_BSC_TESTNET_PORTER_URI= xxxxx
//the network's (e.g. bsc testnet) web3 rpc url. example:
REACT_APP_BSC_TESTNET_WEB3_RPC_URL=xxxxx

build project

1. yarn install
2. yarn build:main

Install via npm

npm i @nulink_network/nulink-sdk

or

yarn add @nulink_network/nulink-sdk

API docs

The Classes

  • NulinkHDWallet: The module mainly includes interfaces for nulink wallet related operations.

  • AccountManager: The module mainly responsible for managing multiple Account objects. AccountManager is a property of the NulinkHDWallet wallet object.

  • Account: The module mainly includes interfaces for nulink wallet account related operations. Account is a property of the AccountManager object.

  • Strategy: The module is mainly used to encrypt user files for file uploading using private keys.

The Functions

  • Functions: The module mainly includes interfaces for file encryption and uploading, as well as operations related to interacting with the blockchain.

API Details

Usage Example

See NuLink SDK Examples to get how to use NuLink SDK.

PreviousAPI ReferenceNextAPI Reference

Last updated

Was this helpful?