Catalog npm
Back to packageRELEASE DETAILS

1.25.1

npm

@0xpolygonid/js-sdk

SDK to work with Polygon ID

Published18 Dec 2024
Direct dependencies56
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 56

Native requirements
56 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.1runtime
ethers
Environment
{
  "local_name": "ethers",
  "alias": false,
  "peer_metadata": null
}
^6.13.1runtime
jsonld
Environment
{
  "local_name": "jsonld",
  "alias": false,
  "peer_metadata": null
}
8.3.1runtime
did-jwt
Environment
{
  "local_name": "did-jwt",
  "alias": false,
  "peer_metadata": null
}
8.0.4runtime
js-sha3
Environment
{
  "local_name": "js-sha3",
  "alias": false,
  "peer_metadata": null
}
0.9.3runtime
pubsub-js
Environment
{
  "local_name": "pubsub-js",
  "alias": false,
  "peer_metadata": null
}
1.9.4runtime
idb-keyval
Environment
{
  "local_name": "idb-keyval",
  "alias": false,
  "peer_metadata": null
}
6.2.0runtime
ajv-formats
Environment
{
  "local_name": "ajv-formats",
  "alias": false,
  "peer_metadata": null
}
2.1.1runtime
did-resolver
Environment
{
  "local_name": "did-resolver",
  "alias": false,
  "peer_metadata": null
}
4.1.0runtime
@noble/curves
Environment
{
  "local_name": "@noble/curves",
  "alias": false,
  "peer_metadata": null
}
^1.4.0runtime
@iden3/onchain-non-merklized-issuer-base-abi
Environment
{
  "local_name": "@iden3/onchain-non-merklized-issuer-base-abi",
  "alias": false,
  "peer_metadata": null
}
^0.0.3runtime
chai
Environment
{
  "local_name": "chai",
  "alias": false,
  "peer_metadata": null
}
^4.3.10development
nock
Environment
{
  "local_name": "nock",
  "alias": false,
  "peer_metadata": null
}
^14.0.0-beta.16development
mocha
Environment
{
  "local_name": "mocha",
  "alias": false,
  "peer_metadata": null
}
10.2.0development
rimraf
Environment
{
  "local_name": "rimraf",
  "alias": false,
  "peer_metadata": null
}
^5.0.5development
rollup
Environment
{
  "local_name": "rollup",
  "alias": false,
  "peer_metadata": null
}
^4.14.3development
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
chai-spies
Environment
{
  "local_name": "chai-spies",
  "alias": false,
  "peer_metadata": null
}
^1.0.0development
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.9development
@types/node
Environment
{
  "local_name": "@types/node",
  "alias": false,
  "peer_metadata": null
}
^20.8.9development
@types/uuid
Environment
{
  "local_name": "@types/uuid",
  "alias": false,
  "peer_metadata": null
}
^9.0.6development
@types/mocha
Environment
{
  "local_name": "@types/mocha",
  "alias": false,
  "peer_metadata": null
}
^10.0.3development
@types/jsonld
Environment
{
  "local_name": "@types/jsonld",
  "alias": false,
  "peer_metadata": null
}
^1.5.11development
@types/fs-extra
Environment
{
  "local_name": "@types/fs-extra",
  "alias": false,
  "peer_metadata": null
}
^11.0.1development
@types/pubsub-js
Environment
{
  "local_name": "@types/pubsub-js",
  "alias": false,
  "peer_metadata": null
}
^1.8.6development
chai-as-promised
Environment
{
  "local_name": "chai-as-promised",
  "alias": false,
  "peer_metadata": null
}
^7.1.1development
@types/chai-spies
Environment
{
  "local_name": "@types/chai-spies",
  "alias": false,
  "peer_metadata": null
}
^1.0.5development
@rollup/plugin-json
Environment
{
  "local_name": "@rollup/plugin-json",
  "alias": false,
  "peer_metadata": null
}
^6.1.0development
@iden3/eslint-config
Environment
{
  "local_name": "@iden3/eslint-config",
  "alias": false,
  "peer_metadata": null
}
git+https://github.com/iden3/eslint-config.gitdevelopment
@typechain/ethers-v6
Environment
{
  "local_name": "@typechain/ethers-v6",
  "alias": false,
  "peer_metadata": null
}
^0.5.1development
@cspell/eslint-plugin
Environment
{
  "local_name": "@cspell/eslint-plugin",
  "alias": false,
  "peer_metadata": null
}
^8.14.2development
@rollup/plugin-terser
Environment
{
  "local_name": "@rollup/plugin-terser",
  "alias": false,
  "peer_metadata": null
}
^0.4.4development
@rollup/plugin-replace
Environment
{
  "local_name": "@rollup/plugin-replace",
  "alias": false,
  "peer_metadata": null
}
^5.0.5development
@rollup/plugin-virtual
Environment
{
  "local_name": "@rollup/plugin-virtual",
  "alias": false,
  "peer_metadata": null
}
^3.0.2development
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
@rollup/plugin-commonjs
Environment
{
  "local_name": "@rollup/plugin-commonjs",
  "alias": false,
  "peer_metadata": null
}
^25.0.7development
@types/chai-as-promised
Environment
{
  "local_name": "@types/chai-as-promised",
  "alias": false,
  "peer_metadata": null
}
^7.1.7development
@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
@rollup/plugin-typescript
Environment
{
  "local_name": "@rollup/plugin-typescript",
  "alias": false,
  "peer_metadata": null
}
^11.1.6development
@rollup/plugin-node-resolve
Environment
{
  "local_name": "@rollup/plugin-node-resolve",
  "alias": false,
  "peer_metadata": null
}
^15.2.3development
@typescript-eslint/eslint-plugin
Environment
{
  "local_name": "@typescript-eslint/eslint-plugin",
  "alias": false,
  "peer_metadata": null
}
^5.41.0development
rfc4648
Environment
{
  "local_name": "rfc4648",
  "alias": false,
  "peer_metadata": null
}
1.5.3peer
snarkjs
Environment
{
  "local_name": "snarkjs",
  "alias": false,
  "peer_metadata": null
}
0.7.4peer
ffjavascript
Environment
{
  "local_name": "ffjavascript",
  "alias": false,
  "peer_metadata": null
}
0.3.0peer
@iden3/js-jwz
Environment
{
  "local_name": "@iden3/js-jwz",
  "alias": false,
  "peer_metadata": null
}
1.8.0peer
@iden3/js-crypto
Environment
{
  "local_name": "@iden3/js-crypto",
  "alias": false,
  "peer_metadata": null
}
1.1.0peer
@iden3/js-iden3-core
Environment
{
  "local_name": "@iden3/js-iden3-core",
  "alias": false,
  "peer_metadata": null
}
1.4.1peer
@iden3/js-merkletree
Environment
{
  "local_name": "@iden3/js-merkletree",
  "alias": false,
  "peer_metadata": null
}
1.3.1peer
@iden3/js-jsonld-merklization
Environment
{
  "local_name": "@iden3/js-jsonld-merklization",
  "alias": false,
  "peer_metadata": null
}
1.4.1peer

Distribution files

1 collected
Distribution 1

Source distribution

Source file
Checksums from source
{
  "shasum": "96c024163a4b14ebf8382a32049270fc8ed7da3c",
  "tarball": "https://registry.npmjs.org/@0xpolygonid/js-sdk/-/js-sdk-1.25.1.tgz",
  "fileCount": 487,
  "integrity": "sha512-tpYgXXwjRNbIwJHGsGJjb1jFo9gH45EysLMleLd5Lm+ISnlRTc/4pyooETZUdoDHn++IM0NfrJ0FKMHY9c+9vw==",
  "signatures": [
    {
      "sig": "MEUCIQC3UCRuonLRhRpqsbJCW+8CTTvA7LYFz9l9ggh2XIVlUgIgNCGZC7xf8dcM7tAOmsT5xEevdVAlVG0QvnnyjdjtiTg=",
      "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"
    }
  ],
  "unpackedSize": 22750600
}

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:9d40ccc3f5b6f5ffc0df92cc69e2bbeb3a5e2b5a6918de6cd6f58ca08d6f45bb

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 →