Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
@onchain-id/complydefi-sdk
Advanced tools
This package facilitates the interaction with ComplyDefi stored in the BlockChain.
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);
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']
})();
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
})();
npm i
.npm run lint lint
.npm run test:unit
. You can run unit tests each time you modify a file with npm run test:unit:watch
.npm run build
. This will build package into the dist/
folder from the TypeScript sources.npm run test:e2e
.FAQs
Interact with ComplyDeFi
We found that @onchain-id/complydefi-sdk demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.