@elrondnetwork/attest.node
v0.0.2@elrondnetwork/attest.node
The Node implementation of the Elrond Attest service, built using Node.js and Typescript.
Requirements
- Node.js version 14.16.0+
- Npm version 6.14.0+
- Typescript version 4.2.3+
Dependencies
- rxjs version 6.6.6+
- mime-types version 2.1.28+
- read-chunk version 3.2.0+
- attest.core
Usage
// Creating a hash
import { hash } from '@elrondnetwork/attest.node'
// (input: Input) => Promise<HashResult>
const hashResult = await hash({ path: 'path/to/file' })
// Creating the attest client
import { attest } from '@elrondnetwork/attest.node'
// Only one of the following fields should be used at once
const authorization = {
token: 'sampleToken', // if you want to authorize the client using an access token
apiKey: 'sampleApiKey' // if you want to authorize the client using an api key
}
const client = attest({ authorization })
// The client can then be used to access the attestation functions
// Creating an attestation
const input = {
path: '/path/to/file', // Path to the file to be attested
onProgress: progress => {}, // Optional callback to track attestation progress
options: {
shouldStoreObject: true // Flag to store generated object alongside attestation
}
}
// (input: Input) => Promise<Result>
const createResponse = await client.create(input)
// Verifying if a file is already attested
const input = {
sha256: 'some existing hash',
path: 'path/to/file', // To be used instead of the sha256 field
onProgress: progress => {} // Optional callback to track verification progress
}
const verifyResponse = await client.verify(input)
Exposed types
TokenAuthorization: { baseUrl: string, token: string }
Type to be used for authorizing the client by access token
ApiKeyAuthorization: { baseUrl: string, apiKey: string }
Type to be used fot authorizing the client by api key
NodeAttest: { create, verify }
Type of the attest client