FuLink SDK

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

Build & Install

Build Source

Copy

1. Rename .env.example to .env
2. Modify config:
  // The SDK backend testnet server address. In the FuLink testnet,
  // you can use the address: https://agent.testnet.fulink.org/bk
  REACT_APP_CENTRALIZED_SERVER_URL=xxxxx
  // Your IPFS address, requires permission to write data. In the FuLink testnet,
  // you can use the address: https://agent.testnet.fulink.org/nuipfs
  REACT_APP_IPFS_NODE_URL=xxxxx
  // The FuLink porter address. In the FuLink testnet,
  // you can use the address: https://agent.testnet.fulink.org/porter
  REACT_APP_PORTER_URL= xxxxx
  // The BSC testnet Web3 RPC URL. Example:
  REACT_APP_WEB3_RPC_URL=xxxxx

3. yarn install
4. yarn build:main

Install via npm

Copy

npm i @fulink_network/fulink-sdk

or

Copy

yarn add @fulink_network/fulink-sdk

API docs

The Classes

  • FulinkHDWallet: The module mainly includes interfaces for fulink wallet related operations.

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

  • Account: The module mainly includes interfaces for fulink 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.

Last updated