@zkproofport-ai/sdk 0.5.1 → 0.5.2

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.
package/README.md CHANGED
@@ -98,9 +98,9 @@ Use **SDK 0.2.14 or later** and **MCP 0.2.15 or later** for both GIWA signature
98
98
 
99
99
  **For GIWA** (`giwa_attestation`): an attestation from GIWA's attester on **GIWA Sepolia**, and control of that wallet. Without an action, supply its local signer; with an action, the person connects that wallet on the approval page. The attestation must belong to the wallet signing the proof request on the chain the circuit reads.
100
100
 
101
- **For the circuit that can bind an action** (`giwa_attestation`): the GIWA attestation above. What differs is what the wallet signs, and the action is **optional** — see below.
101
+ **For the circuits that can bind an action** (`coinbase_kyc`, `giwa_attestation`): the attestation above. What differs is what the wallet signs, and the action is **optional** — see below.
102
102
 
103
- **One wallet has a different nullifier per circuit, and for `giwa_attestation` it does not depend on what you signed.** `giwa_attestation` derives it from your address, the circuit's own identifier and the scope, so the same wallet in the same scope gives the same nullifier whether or not you bind an action. The Coinbase circuits derive theirs from the signed challenge instead. Nothing to configure — the SDK picks the rule the circuit expects, and refuses a circuit it has no rule for rather than guessing one. Requires **0.2.14 or later**; earlier versions sent the Coinbase rule for every circuit, which a GIWA proof rejects as a nullifier mismatch.
103
+ **One wallet has a different nullifier per circuit, and for `coinbase_kyc` and `giwa_attestation` it does not depend on what you signed.** They derive it from your address, the circuit's own identifier and the scope, so the same wallet in the same scope gives the same nullifier whether or not you bind an action. `coinbase_country` derives its nullifier from the signed challenge instead. Nothing to configure — the SDK picks the rule the circuit expects, and refuses a circuit it has no rule for rather than guessing one. Requires **0.2.14 or later**; earlier versions sent the Coinbase rule for every circuit, which a GIWA proof rejects as a nullifier mismatch.
104
104
 
105
105
  ## Quick Start
106
106
 
@@ -632,7 +632,7 @@ function fromSigner(signer: ethers.Signer): ProofportSigner;
632
632
  ```typescript
633
633
  interface ProofParams {
634
634
  circuit: CircuitName;
635
- 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 giwa_attestation
635
+ 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 coinbase_kyc and giwa_attestation
636
636
  actionApproval?: ActionApproval; // private handle; resume the original action after human approval
637
637
  payOn?: string;
638
638
  maxPayment?: string; // decimal USDC
package/dist/types.d.ts CHANGED
@@ -190,8 +190,8 @@ export interface ProofParams {
190
190
  /** OIDC provider: 'google' (default) or 'microsoft' for Microsoft 365 */
191
191
  provider?: 'google' | 'microsoft';
192
192
  /**
193
- * Optional for giwa_attestation; rejected for every
194
- * other circuit, including OIDC.
193
+ * Optional for coinbase_attestation and giwa_attestation; rejected for
194
+ * every other circuit, including OIDC.
195
195
  * A human wallet must approve these exact EIP-712 fields. generateProof throws
196
196
  * ActionApprovalRequiredError with a resumable handle until approval is ready.
197
197
  * The supplied attestation signer is never used for actions.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zkproofport-ai/sdk",
3
- "version": "0.5.1",
3
+ "version": "0.5.2",
4
4
  "description": "TypeScript SDK for ZKProofport Coinbase KYC, country, OIDC and GIWA attestation proofs. Optional EIP-712 action binding for GIWA; x402 USDC payments.",
5
5
  "keywords": [
6
6
  "sdk",
@@ -37,7 +37,7 @@
37
37
  "dependencies": {
38
38
  "@x402/core": "^2.25.0",
39
39
  "@x402/evm": "^2.25.0",
40
- "@zkproofport-app/core": "0.4.0-beta.0",
40
+ "@zkproofport-app/core": "0.4.0-beta.1",
41
41
  "ethers": "^6.13.0",
42
42
  "viem": "^2.45.2"
43
43
  },