Catalog npm
Back to packageRELEASE DETAILS

1.0.0

npm

@0xpolygonid/js-sdk

SDK to work with Polygon ID

Published1 Aug 2023
Direct dependencies51
Transitive dependenciesNot calculated

README

Current package documentation

Privado ID JS SDK

SDK to work with Privado ID using JavaScript and TypeScript languages.

Usage

Installation:

npm install @0xpolygonid/js-sdk

Circuits

And place actual circuits to test/proofs/testdata

curl -LO https://circuits.privado.id/latest.zip

Tests

Run unit tests:

npm run test

Note: mtp / sig / auth / rhs files contain integration tests!

To run them, please set following variables:

export WALLET_KEY="...key in hex format"
export RPC_URL="...url to network rpc node"
export RHS_URL="..reverse hash service url"
export IPFS_URL="url for ipfs"
export STATE_CONTRACT_ADDRESS="state contract address"
export RHS_CONTRACT_ADDRESS="reverse hash service contract address"

Examples

Please see examples for visit examples information.

Documentation

Generate documentation

  1. Define path where documentation repository is located, for example:

        const DOCS_DIR = '../js-sdk-tutorials/docs/api';
    
  2.      npm run tsc:declaration:watch
    
  3.      npm run doc:watch:website
    

Documentation can be found here

License

js-sdk is part of the 0xPolygonID project copyright 2024 ZKID Labs AG

This project is licensed under either of

at your option.

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 51

Native requirements
51 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
ajv
Environment
{
  "local_name": "ajv",
  "alias": false,
  "peer_metadata": null
}
^8.12.0runtime
uuid
Environment
{
  "local_name": "uuid",
  "alias": false,
  "peer_metadata": null
}
^9.0.0runtime
ethers
Environment
{
  "local_name": "ethers",
  "alias": false,
  "peer_metadata": null
}
^5.7.2runtime
jsonld
Environment
{
  "local_name": "jsonld",
  "alias": false,
  "peer_metadata": null
}
^8.1.1runtime
did-jwt
Environment
{
  "local_name": "did-jwt",
  "alias": false,
  "peer_metadata": null
}
^6.11.6runtime
rfc4648
Environment
{
  "local_name": "rfc4648",
  "alias": false,
  "peer_metadata": null
}
^1.5.2runtime
snarkjs
Environment
{
  "local_name": "snarkjs",
  "alias": false,
  "peer_metadata": null
}
^0.5.0runtime
elliptic
Environment
{
  "local_name": "elliptic",
  "alias": false,
  "peer_metadata": null
}
^6.5.4runtime
base58-js
Environment
{
  "local_name": "base58-js",
  "alias": false,
  "peer_metadata": null
}
^1.0.4runtime
idb-keyval
Environment
{
  "local_name": "idb-keyval",
  "alias": false,
  "peer_metadata": null
}
^6.2.0runtime
uint8arrays
Environment
{
  "local_name": "uint8arrays",
  "alias": false,
  "peer_metadata": null
}
^3.0.0runtime
cross-sha256
Environment
{
  "local_name": "cross-sha256",
  "alias": false,
  "peer_metadata": null
}
^1.2.0runtime
did-resolver
Environment
{
  "local_name": "did-resolver",
  "alias": false,
  "peer_metadata": null
}
^4.1.0runtime
ffjavascript
Environment
{
  "local_name": "ffjavascript",
  "alias": false,
  "peer_metadata": null
}
^0.2.57runtime
multiformats
Environment
{
  "local_name": "multiformats",
  "alias": false,
  "peer_metadata": null
}
^9.6.5runtime
@iden3/js-jwz
Environment
{
  "local_name": "@iden3/js-jwz",
  "alias": false,
  "peer_metadata": null
}
1.0.0runtime
@iden3/js-crypto
Environment
{
  "local_name": "@iden3/js-crypto",
  "alias": false,
  "peer_metadata": null
}
1.0.0runtime
buffer-browserify
Environment
{
  "local_name": "buffer-browserify",
  "alias": false,
  "peer_metadata": null
}
^0.2.5runtime
crypto-browserify
Environment
{
  "local_name": "crypto-browserify",
  "alias": false,
  "peer_metadata": null
}
^3.12.0runtime
@iden3/js-iden3-core
Environment
{
  "local_name": "@iden3/js-iden3-core",
  "alias": false,
  "peer_metadata": null
}
1.0.0runtime
@iden3/js-merkletree
Environment
{
  "local_name": "@iden3/js-merkletree",
  "alias": false,
  "peer_metadata": null
}
1.0.0runtime
@lumeweb/js-sha3-browser
Environment
{
  "local_name": "@lumeweb/js-sha3-browser",
  "alias": false,
  "peer_metadata": null
}
^0.8.1runtime
@iden3/js-jsonld-merklization
Environment
{
  "local_name": "@iden3/js-jsonld-merklization",
  "alias": false,
  "peer_metadata": null
}
1.0.1runtime
chai
Environment
{
  "local_name": "chai",
  "alias": false,
  "peer_metadata": null
}
^4.3.7development
madge
Environment
{
  "local_name": "madge",
  "alias": false,
  "peer_metadata": null
}
^6.0.0development
mocha
Environment
{
  "local_name": "mocha",
  "alias": false,
  "peer_metadata": null
}
10.2.0development
rimraf
Environment
{
  "local_name": "rimraf",
  "alias": false,
  "peer_metadata": null
}
^2.7.1development
esbuild
Environment
{
  "local_name": "esbuild",
  "alias": false,
  "peer_metadata": null
}
^0.15.15development
ts-node
Environment
{
  "local_name": "ts-node",
  "alias": false,
  "peer_metadata": null
}
^10.9.1development
chokidar
Environment
{
  "local_name": "chokidar",
  "alias": false,
  "peer_metadata": null
}
^3.5.3development
prettier
Environment
{
  "local_name": "prettier",
  "alias": false,
  "peer_metadata": null
}
^2.7.1development
ts-loader
Environment
{
  "local_name": "ts-loader",
  "alias": false,
  "peer_metadata": null
}
^9.4.1development
typescript
Environment
{
  "local_name": "typescript",
  "alias": false,
  "peer_metadata": null
}
^4.8.4development
@types/chai
Environment
{
  "local_name": "@types/chai",
  "alias": false,
  "peer_metadata": null
}
^4.3.4development
@types/node
Environment
{
  "local_name": "@types/node",
  "alias": false,
  "peer_metadata": null
}
^18.16.19development
@types/uuid
Environment
{
  "local_name": "@types/uuid",
  "alias": false,
  "peer_metadata": null
}
^9.0.2development
@types/mocha
Environment
{
  "local_name": "@types/mocha",
  "alias": false,
  "peer_metadata": null
}
^10.0.1development
@types/jsonld
Environment
{
  "local_name": "@types/jsonld",
  "alias": false,
  "peer_metadata": null
}
^1.5.9development
@types/elliptic
Environment
{
  "local_name": "@types/elliptic",
  "alias": false,
  "peer_metadata": null
}
^6.4.14development
@types/fs-extra
Environment
{
  "local_name": "@types/fs-extra",
  "alias": false,
  "peer_metadata": null
}
^11.0.1development
@gr2m/fetch-mock
Environment
{
  "local_name": "@gr2m/fetch-mock",
  "alias": false,
  "peer_metadata": null
}
^9.11.0-pull-request-644.1development
chai-as-promised
Environment
{
  "local_name": "chai-as-promised",
  "alias": false,
  "peer_metadata": null
}
^7.1.1development
@iden3/eslint-config
Environment
{
  "local_name": "@iden3/eslint-config",
  "alias": false,
  "peer_metadata": null
}
git+https://github.com/iden3/eslint-config.gitdevelopment
eslint-config-prettier
Environment
{
  "local_name": "eslint-config-prettier",
  "alias": false,
  "peer_metadata": null
}
^8.8.0development
eslint-plugin-prettier
Environment
{
  "local_name": "eslint-plugin-prettier",
  "alias": false,
  "peer_metadata": null
}
^4.2.1development
@types/chai-as-promised
Environment
{
  "local_name": "@types/chai-as-promised",
  "alias": false,
  "peer_metadata": null
}
^7.1.5development
@microsoft/api-extractor
Environment
{
  "local_name": "@microsoft/api-extractor",
  "alias": false,
  "peer_metadata": null
}
^7.9.0development
@microsoft/api-documenter
Environment
{
  "local_name": "@microsoft/api-documenter",
  "alias": false,
  "peer_metadata": null
}
^7.8.20development
@typescript-eslint/eslint-plugin
Environment
{
  "local_name": "@typescript-eslint/eslint-plugin",
  "alias": false,
  "peer_metadata": null
}
^5.41.0development
@esbuild-plugins/node-globals-polyfill
Environment
{
  "local_name": "@esbuild-plugins/node-globals-polyfill",
  "alias": false,
  "peer_metadata": null
}
^0.1.1development
@esbuild-plugins/node-modules-polyfill
Environment
{
  "local_name": "@esbuild-plugins/node-modules-polyfill",
  "alias": false,
  "peer_metadata": null
}
^0.1.4development

Distribution files

1 collected
Distribution 1

Source distribution

Source file
Checksums from source
{
  "shasum": "9942d745c487d5846a1a83edfc31a7ad4b9d1be2",
  "tarball": "https://registry.npmjs.org/@0xpolygonid/js-sdk/-/js-sdk-1.0.0.tgz",
  "fileCount": 581,
  "integrity": "sha512-d09ps+w9jv5JHyezXLsao3MOiyUMHiprpv9WIiLzeudjD2quT/AnIwQpfxe8VK34QuEXaCiuP4KYbDDE4uXWDA==",
  "signatures": [
    {
      "sig": "MEYCIQDA1a6sn5cLWocZhj9C20preGn+N9NkHSu6B0S6hC7C1QIhAPmQDjy1e3LiLno7PJ/Dumm0hZjL590uhOUPfz3C2yge",
      "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"
    }
  ],
  "unpackedSize": 32253204
}

Repository

PENDING
0xpolygonid/js-sdk

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 21 Oct, 09:30 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:48410f9b3cdce0a11d9818a2fa3d69c13a239d7a6007cb9f97fcd60c3759e836

Other collected versions

1.46.125 Sept1.45.017 Jun1.44.02 Jun1.43.018 Mar1.42.14 Mar1.42.02 MarView all collected versions →