/verify-client

Primary LanguageTypeScriptApache License 2.0Apache-2.0

verify client sdk

Release TypeScript version License: Apache 2.0

VERIFY aims to be the central repository for content license and provenance, equipping the world with a backend to verify the source and license of digital content.

VERIFY is a public library of signed digital assets with capabilities that allow for a single DRM solution for digital assets. Every asset stored in VERIFY is signed by a real world entity that attests to the provenance of the asset. The publisher declares the asset’s license for access and reference through a smart contract module.

verifymedia/client is a typesafe sdk for interacting with the verify protocol. It is written in typescript and is compiled to es6 and cjs bundles ensuring compatibility with nodejs.

Network

VERIFY Protocol is deployed on an Polygon CDK validium based appchain.

Network Name: VERIFY Testnet
RPC URL: https://rpc.verify-testnet.gelato.digital
Chain ID: 1833
Currency Symbol: MATIC
Block Explorer URL: https://verify-testnet.blockscout.com/
Settlement Layer: Amoy 

more details can be found here.

Content Licensing

Each node in the ContentGraph can have a license specified for access and for reference. These licenses are smart contracts and hence can be programmatically enforced as per publisher needs.

more details can be found here.

Quick Start

  • Since VERIFY client sdk supports javascript, start by installing nodejs version 18 or higher.

  • Confirm the node version node --version in your terminal.

    sdk requires:

    "node": ">=18.15.0",
    "npm": "9.5.0"
  • Set up a test project

    mkdir test-verifymedia-client
    cd test-verifymedia-client
    npm init -y
    touch index.mjs
    npm i @verify-media/verify-client
  • Open test-verifymedia-client/index.mjs in your favorite IDE and add the following snippet

    import { hashData } from '@verify-media/verify-client'
    console.log(hashData('hello world'))
  • Head over to the terminal (within vscode or your favorite terminal which has the nodejs env setup) and try executing

    node index.mjs

    you should see some output like

    0x47173285a8d7341e5e972fc677286384f802f8ef42a5ec5f03bbfa254cb01fad

    the sdk is up and running now.

Getting started

Please check the getting started guide to start using the sdk.

Examples

The repository hosts various examples of how to use the sdk.

Tech Docs

For the most up-to-date API documentation, check out the verify-client sdk docs

License

Apache License Version 2.0