SDK Reference

Complete API reference for the GitDigital SDK. Available in TypeScript, Python, and Rust.

Client Initialization

TypeScript

import { GitDigital } from '@gitdigital/sdk';

const client = new GitDigital({
  apiKey: "your-api-key",
  network: "mainnet",      // or 'testnet'
  timeout: 30000,              // Optional, default 30s
  retries: 3                   // Optional, default 3
});

Identity Module

Methods for zero-knowledge identity verification.

Method	Description
`identity.prove()`	Generate a ZK proof for identity claims
`identity.verify()`	Verify a proof on-chain or off-chain
`identity.batchProve()`	Generate multiple proofs in parallel
`identity.getCircuit()`	Get circuit metadata and ABI

identity.prove()

POST Generate a zero-knowledge proof for identity claims.

const result = await client.identity.prove({
  user_address: "0x...",
  claim: "age_over_18",
  circuit: "age_verification_v2",
  options: {
    zk_format: "groth16"
  }
});

// Returns: { proof, publicSignals, verificationTime }

Compliance Module

Methods for regulatory compliance monitoring.

Method	Description
`compliance.monitor()`	Create a transaction monitor
`compliance.getReport()`	Generate compliance reports
`compliance.submitSAR()`	Submit suspicious activity report

CDK Module

Methods for sovereign rollup deployment.

Method	Description
`cdk.deploy()`	Deploy a new sovereign rollup
`cdk.getStatus()`	Get rollup deployment status
`cdk.configureBridge()`	Configure bridge settings