@minhtetoo/tradetrust-core-test
v1.0.14
Published
Unified interface for interacting with TradeTrust's various services. This library contains a set of modules.
Downloads
5
Readme
TradeTrust Core
Unified interface for interacting with TradeTrust's various services. This library contains a set of modules.
| Module | Description | | ----------------- | ------------------------------------------------------ | | Verify | Verify TradeTrust issued document | | Utils | Provide utility methods for TradeTrust functionalities |
Installation
npm i @tradetrust-tt/tradetrust-core
Verify
verify
allows you to verify issued document programmatically. After verification, use isValid
method to answer some questions:
- Has the document been tampered with ?
- Is the issuance state of the document valid ?
- Is the document issuer identity valid ? (see identity proof)
Document can be either verifiable document or transferrable record which follows TradeTrust document schema
// verify document using network name
import { verify, isValid } from '@tradetrust-tt/tradetrust-core/verify'
let document = {
// your tradetrust document
}
const fragments = await verify(document, {
network: 'sepolia', // can also provide other networks such as homestead
})
console.log(isValid(fragments))
// verify document using provider
import { ethers } from 'ethers'
import { utils } from '@tradetrust-tt/tt-verify'
const providerOptions = {
// modify your provider options accordingly
network: 'sepolia',
providerType: 'infura',
apiKey: 'abdfddsfe23232',
}
const provider = utils.generateProvider(providerOptions)
let document = {
// your tradetrust document
}
const fragments = await verify(document, { provider })
console.log(isValid(fragments))
For more information about building provider, visit tt-verify repository
Utils
This module provides utility methods that supports the shared functionalities for other TradeTrust modules.
InterpretFragments
interpretFragments
allows you to extract out the verified results from the fragments.
import {interpretFragments} from '@tradetrust-tt/tradetrust-core/utils`;
const fragments = await verify(document, {
network: 'sepolia',
});
const {hasValid, issuedValid, identityValid} = interpretFragments(fragments);
console.log({hasValid, issuedValid, identityValid});
Contributing
We welcome contributions to the TradeTrust core library. Please feel free to submit a pull request or open an issue.