@onchain-id/complydefi-sdk v1.0.0

COMPLYDEFI SDK

This package facilitates the interaction with ComplyDefi stored in the BlockChain.

Specifications

Features

• Validate wallet address compliance
• Get required claims

BlockChain Provider

To interact with the BlockChain, you will need to instantiate a Provider.

The SDK is using Ethers to connect with Ethereum network. Thus, any provider supported by Ethers can be used with the SDK. This means any standard web3 provider should by supported.

Connect to a default provider:

// You can use any standard network name
//  - "homestead"
//  - "rinkeby"
//  - "ropsten"
//  - "kovan"
const ethers = require('ethers');

const provider = ethers.getDefaultProvider('ropsten');

const complyDefi = await Complydefi.at('0x...', {provider});

Connect to JSON RPC:

// When using the JSON-RPC API, the network will be automatically detected
// Default: http://localhost:8545
let httpProvider = new ethers.providers.JsonRpcProvider();

Connect to any Web3 Provider:

// When using a Web3 provider, the network will be automatically detected

// e.g. HTTP provider
let currentProvider = new web3.providers.HttpProvider('http://localhost:8545');

let web3Provider = new ethers.providers.Web3Provider(currentProvider);

Connect to metamask:

// The network will be automatically detected; if the network is
// changed in MetaMask, it causes a page refresh.

let provider = new ethers.providers.Web3Provider(web3.currentProvider);

Examples

Get required claims

const { ComplyDefiSDK } = require('@onchain-id/complydefi-sdk');

const provider = new ethers.providers.JsonRpcProvider();

(async () => {
    const complyDefi = new ComplyDefiSDK.ComplyDefi('0xadD92F8Ef0729E969c5a98Ea5740c9b644B362e3', { provider });

    const claims = await complyDefi.getRequiredClaims();

    console.log(claims); // ['claim1', 'claim2']
})();

Check compliance of wallet address

const { ComplyDefiSDK } = require('@onchain-id/complydefi-sdk');

const provider = new ethers.providers.JsonRpcProvider();

(async () => {
  const complyDefi = new ComplyDefiSDK.ComplyDefi('0xadD92F8Ef0729E969c5a98Ea5740c9b644B362e3', { provider });

  const isComply = await complyDefi.isComply('0xasfgdsgd...dsasd');
  
  console.log(isComply); // true or false
})();

Development

• Install dependencies: npm i.
• Lint code with npm run lint lint.
• Run unit tests: npm run test:unit. You can run unit tests each time you modify a file with npm run test:unit:watch.
• Build project with npm run build. This will build package into the dist/ folder from the TypeScript sources.
• Run end to end tests against a builded package: npm run test:e2e.