Install the TypeScript SDKs

Current: the SDK implementation and package checks are complete. The prepared bundle version is 0.1.0-mvp.2; signing and distribution are still pending. This page does not announce an available GitHub release or public npm package. Ask your onboarding contact for the actual release location before downloading.

Package	Purpose
@human.tech/tridentgold-zknc-mvp-client	Issuer invitation/handoff, sandbox verifier request/result, and low-level status retrieval.
@human.tech/tridentgold-siop-rp	Server-side Sign in with TridentGold request and callback handling.
@human.tech/tridentgold-siop	Shared sign-in contracts, used by the RP package.
@human.tech/tridentgold-account-crypto	Shared cryptographic functions, required transitively by the sign-in packages.

All four tarballs in this bundle have the same version. These are provisional sandbox interfaces; package version 0.1.0-mvp.2 does not mean API contract v1 is stable. The packages do not include the native proof runtime or install an independently operating issuer/verifier service.

How to install

Use Node.js 22 and npm. A GitHub release contains downloadable package files; it is not an npm registry. Download the four .tgz files, verify the release, then install those files into your project.

1. Get access and download

For releases in the private TridentGold repository, accept the repository invitation from your onboarding contact and sign in to GitHub. Your contact will also supply the release tag, approved usage terms and signing identity. These commands apply after the release has been published.

Download the four package assets, SDK-MANIFEST.json, and SHA256SUMS from the TridentGold releases page into vendor/tridentgold/ in your project. Use the .tgz assets rather than GitHub's automatically generated “Source code” archives.

Or run this from your project root with the GitHub CLI:

gh auth login
gh release download tridentgold-mvp-sdk-v0.1.0-mvp.2 \
  --repo holonym-foundation/TridentGold \
  --pattern '*.tgz' \
  --pattern SDK-MANIFEST.json \
  --pattern SHA256SUMS \
  --dir vendor/tridentgold

Follow the release's signature-verification instructions before installation. Verify the signed tag against the approved signing identity and the manifest's commit/digest, then check each tarball against the authenticated manifest. SHA256SUMS alone does not establish who published the files.

2. Install the packages

From the same project root, install all four archives together:

npm install --ignore-scripts \
  ./vendor/tridentgold/human.tech-tridentgold-account-crypto-0.1.0-mvp.2.tgz \
  ./vendor/tridentgold/human.tech-tridentgold-siop-0.1.0-mvp.2.tgz \
  ./vendor/tridentgold/human.tech-tridentgold-siop-rp-0.1.0-mvp.2.tgz \
  ./vendor/tridentgold/human.tech-tridentgold-zknc-mvp-client-0.1.0-mvp.2.tgz

This satisfies the bundle's package dependencies without querying npm for unpublished packages. Public dependencies are still downloaded from npm. The command adds file:vendor/tridentgold/... dependencies to package.json and records them in package-lock.json. npm supports installing local package tarballs.

Keep the tarballs at those paths for future installs and commit the package and lock files. You can retain the archives in your private project if the agreed terms permit it, or download and verify them in CI before npm ci. Keep private release assets and credentials out of public repositories.

3. Import the SDK

Use normal package imports in TypeScript or an ESM Node project:

import { createTridentGoldSiopRpClient } from "@human.tech/tridentgold-siop-rp";
import { createZkncMvpIssuerAdminClient } from "@human.tech/tridentgold-zknc-mvp-client/admin";
import { createZkncMvpVerifierServerClient } from "@human.tech/tridentgold-zknc-mvp-client/verifier-server";

The last two entry points are server-only; do not bundle them into your frontend. You do not need to build TridentGold from source. Your onboarding contact provides hosted-service authorization separately from package access.

Start from the packaged examples

The installed packages include TypeScript examples you can copy into your backend and adapt to your session store and approved configuration:

Installed file	Function supplied by the example
node_modules/@human.tech/tridentgold-siop-rp/examples/sign-in.ts	signInHandlers() wraps initiation, callback processing and terminal-result lookup.
node_modules/@human.tech/tridentgold-zknc-mvp-client/examples/issuer.ts	beginIssuance() creates an invitation and returns wallet launch links.
node_modules/@human.tech/tridentgold-zknc-mvp-client/examples/verifier.ts	beginVerification() and pollVerification() separate server-held result tokens from browser handoff data.

These helper names belong to the example files; they are not additional SDK exports. The examples are compiled and executed from installed tarballs during the release check. HTTP checks use actual Rust routes with a mock proof provider; they do not establish a new live-service or real-proof acceptance result.

Continue with issuer integration, verifier integration, and release compatibility.