Natively Pluggable Module

    @elrondnetwork/evertrail.node
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.2 • Public • Published

    @elrondnetwork/evertrail.node

    The Node implementation of the Elrond Evertrail 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

    Usage

    // Creating a hash
    
    import { hash } from '@elrondnetwork/evertrail.node'
    
    // (input: Input) => Promise<HashResult>
    const hashResult = await hash({ path: 'path/to/file' })
    // Creating the evertrail client
    import { evertrail } from '@elrondnetwork/evertrail.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 = evertrail({ authorization })
    
    // The client can then be used to access the trail functions
    
    // Creating an trail
    
    const input = {
        path: '/path/to/file', // Path to the file to be trailed
        onProgress: progress => {}, // Optional callback to track trail progress
        options: {
            shouldStoreObject: true // Flag to store generated object alongside trail
        }
    }
    
    // (input: Input) => Promise<Result> 
    const createResponse = await client.create(input)
    
    // Verifying if a file is already trailed
    
    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

    NodeEvertrail: { create, verify }

    Type of the evertrail client

    Keywords

    none

    Install

    npm i @elrondnetwork/evertrail.node

    DownloadsWeekly Downloads

    3

    Version

    0.0.2

    License

    ISC

    Unpacked Size

    34.9 kB

    Total Files

    65

    Last publish

    Collaborators

    • cipriand
    • stanislav
    • tanghel
    • lucian.mincu
    • ccorcoveanu
    • titel
    • valentinlup
    • arhtudormorar
    • andreibancioiu