@zkproofport-ai/sdk 0.2.14 → 0.2.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +32 -3
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  Client SDK for ZKProofport zero-knowledge proofs, including experimental exact-action authorization on Arc Testnet.
4
4
 
5
- The shared `hashTypedAction` helper and corrected Arc stepwise signing require SDK/MCP **0.2.12 or later**. Release Please owns the versions. Confirm the resolved npm versions before using this path.
5
+ The shared `hashTypedAction` helper is available from **SDK 0.2.12**. Arc/GIWA optional actions require **SDK 0.2.14 or later**; MCP stepwise input preparation requires **MCP 0.2.15 or later**. Release Please owns the versions. Confirm the resolved npm versions before using this path.
6
6
 
7
7
  ## Overview
8
8
 
@@ -85,7 +85,7 @@ An endpoint without that key receives readable circuit inputs over HTTPS and pro
85
85
  npm install @zkproofport-ai/sdk@latest ethers
86
86
  ```
87
87
 
88
- Corrected Arc stepwise support and shared action hashing require SDK/MCP **0.2.12 or later**. Install from npm and check the resolved version. Release Please manages package versions and the release workflow publishes them; repository source changes alone do not update `@latest`.
88
+ Use **SDK 0.2.14 or later** and **MCP 0.2.15 or later** for both Arc/GIWA signature modes, including stepwise preparation. Install from npm and check the resolved version. Release Please manages package versions and the release workflow publishes them; repository source changes alone do not update `@latest`.
89
89
 
90
90
  ## Prerequisites
91
91
 
@@ -650,7 +650,7 @@ function fromSigner(signer: ethers.Signer): ProofportSigner;
650
650
  ```typescript
651
651
  interface ProofParams {
652
652
  circuit: CircuitName;
653
- action?: { domain: { name: string; version: string; chainId: number; verifyingContract: string }; types: Record<string, Array<{name: string; type: string}>>; primaryType: string; message: Record<string, unknown> }; // required only for arc_eligibility
653
+ action?: { domain: { name: string; version: string; chainId: number; verifyingContract: string }; types: Record<string, Array<{name: string; type: string}>>; primaryType: string; message: Record<string, unknown> }; // optional for arc_eligibility and giwa_attestation
654
654
  payOn?: string;
655
655
  maxPayment?: string; // decimal USDC
656
656
  approvedPayment?: ApprovedPayment;
@@ -747,3 +747,32 @@ Common errors:
747
747
  ## License
748
748
 
749
749
  MIT
750
+
751
+
752
+ ### Testing the published packages
753
+
754
+ From the `proofport-ai` repository root, use the isolated registry runner:
755
+
756
+ ```bash
757
+ E2E_BASE_URL=https://stg-ai.zkproofport.app \
758
+ E2E_PAYMENT_NETWORK=base-sepolia \
759
+ npm run test:e2e:published -- --sdk-version 0.2.14 --mcp-version 0.2.15
760
+ ```
761
+
762
+ It installs those exact npm versions outside the workspace, resolves SDK imports
763
+ and the MCP process to that installation, and removes it afterwards. The runner
764
+ also installs and verifies Circle CLI 1.1.4, automatically putting it on the test
765
+ subprocess PATH without changing the global installation. A normal
766
+ workspace test run exercises local packages and is not published-package evidence.
767
+ The full suite creates paid testnet proofs. It requires the attestation and payer
768
+ credentials loaded by `tests/setup.ts`; GIWA uses `GIWA_ATTESTATION_KEY`, and OIDC
769
+ uses `E2E_OIDC_JWT` or an authenticated gcloud account. The payment matrix checks
770
+ Base Sepolia, Arc immediate settlement, Ethereum Sepolia, and Arc Gateway nano
771
+ separately, so each needs a funded payer on its selected network. Optional
772
+ `E2E_PAYER_KEY_<NETWORK>` overrides use uppercase names with underscores, for
773
+ example `E2E_PAYER_KEY_ETHEREUM_SEPOLIA`. `E2E_ARC_AGENT_ADDRESS` selects an
774
+ existing Circle Agent Wallet for both Arc cases; the supported Circle CLI,
775
+ on-chain USDC for immediate settlement, and Gateway USDC for nano are required. The runner never deposits or transfers funds.
776
+
777
+ For a non-paying package/discovery check, append
778
+ `-t 'should list all 5 circuits'`. This checks discovery only, not proof generation.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@zkproofport-ai/sdk",
3
- "version": "0.2.14",
4
- "description": "TypeScript SDK for ZKProofport identity proofs and experimental Arc Testnet EIP-712 action authorization. Circle Agent Wallet payments, Circle Gateway nanopayments and x402 USDC; Coinbase KYC, country and OIDC proofs.",
3
+ "version": "0.2.15",
4
+ "description": "TypeScript SDK for ZKProofport Coinbase KYC, country, OIDC, Arc eligibility and GIWA attestation proofs. Optional EIP-712 action binding for Arc/GIWA; x402 USDC and Circle Gateway payments.",
5
5
  "keywords": [
6
6
  "sdk",
7
7
  "typescript",