npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@spruceid/tzprofiles

v1.0.1

Published

Library to interact with the Tezos Profiles smart contract and storage

Downloads

3

Readme

Tezos Profiles Smart Contract Registry

This smart-contract is a registry of personal claims (meaning every user has to originate it).

Local Environment

Requires Docker.

For development purposes, a full-fledged local environment is provided. It contains a sandbox Tezos node, better-call.dev API, and the likes. To use it:

docker-compose -f sandbox-docker.yml up -d

CLI

Installation

npm i

Usage

Deploy with tezos blockchain via the CLI

node cli/cli.js originate --secret <secret> --url <local node or mainnet url>

To see all possible usages and parameters, you can refer to the CLI's help:

$ node cli/cli.js --help
cli.js [command]

Commands:
  cli.js originate       Deploy Tezos Public Profiles smart contract.
  cli.js add-claims      Add a claim.
  cli.js remove-claims   Remove a claim.
  cli.js get-claims      Get claims.
  cli.js get-subject     Get the subject for a Tezos Public Profile smart
                         contract.
  cli.js resolve-tzp     Get the TZP address for a Tezos Wallet address.
  cli.js resolve-claims  Get the TZP claims for a Tezos Wallet address.

Options:
      --version          Show version number                           [boolean]
  -u, --url              Tezos node.
                            [string] [default: "https://api.tez.ie/rpc/mainnet"]
  -n, --network          Tezos network.            [string] [default: "mainnet"]
  -f, --faucet_key_file  Path to a faucet key JSON file.                [string]
  -s, --secret           Secret key.                                    [string]
  -b, --tzkt_base        Base url for TzKT API endpoints
                               [string] [default: "https://api.mainnet.tzkt.io"]
  -k, --kepler_base      Base url for kepler API server
                             [string] [default: "https://kepler.tzprofiles.com"]
  -h, --help             Show help                                     [boolean]

SDK

It is recommended to only use TZProfilesClient.

Example: retrieve claims for an address

const lib = require('tzprofiles');
const kepler = require('kepler-sdk');
const DIDKit = require('didkit-wasm-node');

const hashFunc = async (claimBody) => {
	return crypto.createHash("sha256").update(claimBody).digest().toString('hex');
}

let clientOpts = {
    tzktBase: "https://api.mainnet.tzkt.io",
    keplerClient: new kepler.Kepler(
        'https://kepler.tzprofiles.com'
    ),
    hashContent: hashFunc,
    nodeURL: "https://api.tez.ie/rpc/mainnet",
    signer: false,
    validateType: async (c, t) => {
        // Validate VC
        switch (t) {
            case "VerifiableCredential": {
                let verifyResult = await DIDKit.verifyCredential(c, '{}');
                let verifyJSON = JSON.parse(verifyResult);
                if (verifyJSON.errors.length > 0) throw new Error(verifyJSON.errors.join(", "));
                break;
            }
            default:
                throw new Error(`Unknown ClaimType: ${t}`);
        }
    }
};
let client = new lib.TZProfilesClient(clientOpts);
return await client.retrieve("tz1...");

Smart Contract Code

The smart-contract code is written in LIGO (under src/), compiled to Michelson and embedded in lib/contract.ts.