@elrondnetwork/attest.web

@elrondnetwork/attest.web

The Browser 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+
• attest.core

Usage

// Creating a hash

import { hash } from '@elrondnetwork/attest.web'

// (file: File) => Promise<HashResult>
const hashResult = await hash(file) // regular Web API file, 
// see https://developer.mozilla.org/en-US/docs/Web/API/File

// Creating the attest client
import { attest } from '@elrondnetwork/attest.web'

// Only one of the following fields should be used at once
const authorization = {
    token: 'sampleToken', 
}

const client = attest({ authorization })

// The client can then be used to access the attestation functions

// Fetching an user's account

// () => Promise<Result>
const account = await client.account()

// Fetching an user's attestations

// Both of the following fields are nullable
const parameter = {
    sha256: 'some hash', // Last hash after which to fetch attestations 
    timeStamp: 'some timestamp' // Last timestamp after which to fetch attestations
}

// (input: AttestationParameter) => Promise<Result>
const attestations = await client.attestations(parameter)

// Creating an attestation

const input = {
    file,
    options: {
        shouldStoreObject: true // Flag to store generated object alongside attestation
    }
}

// (input: { file: File, onProgress?: onProgress, options?: Options }) => Promise<Result> 
const createResponse = await client.create(input)

// Verifying if a file is already attested

const input = "some existing hash" // Or use the reader if you don't already have a hash

const verifyResponse = await client.verify(input)

Exposed types

TokenAuthorization: { baseUrl: string, token: string }

Type to be used for authorizing the client by access token

AttestWeb: { attestations, account, create, verify }

Type of the attest client