@neus/sdk 1.0.2 → 1.0.4
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 +53 -75
- package/SECURITY.md +33 -29
- package/cjs/client.cjs +678 -337
- package/cjs/errors.cjs +1 -0
- package/cjs/gates.cjs +1 -0
- package/cjs/index.cjs +927 -362
- package/cjs/utils.cjs +408 -32
- package/cli/neus.mjs +58 -0
- package/client.js +1957 -1728
- package/errors.js +5 -5
- package/gates.js +18 -18
- package/index.js +18 -3
- package/neus-logo.svg +3 -0
- package/package.json +21 -11
- package/types.d.ts +303 -53
- package/utils.js +1291 -777
- package/widgets/README.md +12 -20
- package/widgets/index.js +9 -9
- package/widgets/verify-gate/dist/ProofBadge.js +57 -52
- package/widgets/verify-gate/dist/VerifyGate.js +357 -121
- package/widgets/verify-gate/index.js +13 -13
package/types.d.ts
CHANGED
|
@@ -31,18 +31,17 @@ declare module '@neus/sdk' {
|
|
|
31
31
|
verify(params: VerifyParams): Promise<VerificationResult>;
|
|
32
32
|
|
|
33
33
|
/**
|
|
34
|
-
* Get
|
|
35
|
-
* @param
|
|
36
|
-
* @returns Promise resolving to current status
|
|
34
|
+
* Get proof record by receipt ID.
|
|
35
|
+
* @param proofId - Proof receipt ID (0x + 64 hex).
|
|
37
36
|
*/
|
|
38
|
-
|
|
37
|
+
getProof(proofId: string): Promise<StatusResult>;
|
|
39
38
|
|
|
40
39
|
/**
|
|
41
|
-
* Get private proof
|
|
42
|
-
* @param
|
|
40
|
+
* Get private proof record (owner-signed)
|
|
41
|
+
* @param proofId - Proof receipt ID.
|
|
43
42
|
* @param wallet - Optional injected wallet/provider (MetaMask/ethers Wallet)
|
|
44
43
|
*/
|
|
45
|
-
|
|
44
|
+
getPrivateProof(proofId: string, wallet?: WalletLike | GatePrivateAuth): Promise<StatusResult>;
|
|
46
45
|
|
|
47
46
|
/**
|
|
48
47
|
* Check API health
|
|
@@ -52,24 +51,27 @@ declare module '@neus/sdk' {
|
|
|
52
51
|
|
|
53
52
|
/** List available verifiers */
|
|
54
53
|
getVerifiers(): Promise<string[]>;
|
|
54
|
+
|
|
55
|
+
/** Get the public verifier catalog, including per-verifier capabilities. */
|
|
56
|
+
getVerifierCatalog(): Promise<VerifierCatalog>;
|
|
55
57
|
|
|
56
58
|
/**
|
|
57
59
|
* Poll verification status until completion
|
|
58
|
-
* @param
|
|
60
|
+
* @param proofId - Proof ID to poll.
|
|
59
61
|
* @param options - Polling configuration options
|
|
60
62
|
* @returns Promise resolving to final status
|
|
61
63
|
* @example
|
|
62
|
-
* const finalStatus = await client.pollProofStatus(
|
|
64
|
+
* const finalStatus = await client.pollProofStatus(proofId, {
|
|
63
65
|
* interval: 3000,
|
|
64
66
|
* onProgress: (status) => {
|
|
65
67
|
* // Handle status updates
|
|
66
68
|
* }
|
|
67
69
|
* });
|
|
68
70
|
*/
|
|
69
|
-
pollProofStatus(
|
|
71
|
+
pollProofStatus(proofId: string, options?: PollOptions): Promise<StatusResult>;
|
|
70
72
|
|
|
71
73
|
/** Revoke own proof (owner-signed) */
|
|
72
|
-
revokeOwnProof(
|
|
74
|
+
revokeOwnProof(proofId: string, wallet?: { address: string }): Promise<boolean>;
|
|
73
75
|
|
|
74
76
|
// ═══════════════════════════════════════════════════════════════
|
|
75
77
|
// PROOFS & GATING METHODS
|
|
@@ -90,11 +92,21 @@ declare module '@neus/sdk' {
|
|
|
90
92
|
getPrivateProofsByWallet(walletAddress: string, options?: GetProofsOptions, wallet?: WalletLike): Promise<ProofsResult>;
|
|
91
93
|
|
|
92
94
|
/**
|
|
93
|
-
* Minimal eligibility check against public +
|
|
95
|
+
* Minimal eligibility check against public + unlisted proofs by default (API-backed).
|
|
94
96
|
* Prefer this for server-side integrations that do not need full proof payloads.
|
|
95
97
|
*/
|
|
96
98
|
gateCheck(params: GateCheckApiParams): Promise<GateCheckApiResponse>;
|
|
97
99
|
|
|
100
|
+
/**
|
|
101
|
+
* Pre-sign owner auth payload for repeated includePrivate gate checks (single prompt).
|
|
102
|
+
*/
|
|
103
|
+
createGatePrivateAuth(params: {
|
|
104
|
+
address: string;
|
|
105
|
+
wallet?: WalletLike;
|
|
106
|
+
chain?: string;
|
|
107
|
+
signatureMethod?: string;
|
|
108
|
+
}): Promise<GatePrivateAuth>;
|
|
109
|
+
|
|
98
110
|
/**
|
|
99
111
|
* Evaluate gate requirements against existing proofs
|
|
100
112
|
* Returns whether wallet satisfies all requirements, with missing items listed
|
|
@@ -125,10 +137,18 @@ declare module '@neus/sdk' {
|
|
|
125
137
|
export interface NeusClientConfig {
|
|
126
138
|
/** API endpoint URL (defaults to hosted public API) */
|
|
127
139
|
apiUrl?: string;
|
|
128
|
-
/** Optional
|
|
140
|
+
/** Optional API key (server-side only; do not embed in browser apps) */
|
|
129
141
|
apiKey?: string;
|
|
142
|
+
/** Optional public app attribution ID (maps to X-Neus-App) */
|
|
143
|
+
appId?: string;
|
|
144
|
+
/** Optional x402 receipt token for retry calls (maps to PAYMENT-SIGNATURE) */
|
|
145
|
+
paymentSignature?: string;
|
|
146
|
+
/** Optional extra passthrough headers for advanced integrations */
|
|
147
|
+
extraHeaders?: Record<string, string>;
|
|
130
148
|
/** Request timeout in milliseconds */
|
|
131
149
|
timeout?: number;
|
|
150
|
+
/** Advanced. NEUS protocol primary-chain id override; most integrators omit. */
|
|
151
|
+
hubChainId?: number;
|
|
132
152
|
/** Enable SDK logging */
|
|
133
153
|
enableLogging?: boolean;
|
|
134
154
|
}
|
|
@@ -152,6 +172,24 @@ declare module '@neus/sdk' {
|
|
|
152
172
|
/** Verifier-specific options */
|
|
153
173
|
verifierOptions?: Record<string, any>;
|
|
154
174
|
}
|
|
175
|
+
|
|
176
|
+
export interface VerifierCatalogMetadataEntry {
|
|
177
|
+
category?: string;
|
|
178
|
+
description?: string;
|
|
179
|
+
flowType?: 'instant' | 'interactive' | 'external_lookup' | string;
|
|
180
|
+
expiryType?: 'permanent' | 'point_in_time' | 'expiring' | string;
|
|
181
|
+
supportsDirectApi?: boolean;
|
|
182
|
+
supportsHostedVerify?: boolean;
|
|
183
|
+
dataSchema?: Record<string, any>;
|
|
184
|
+
requiredFields?: string[];
|
|
185
|
+
optionalFields?: string[];
|
|
186
|
+
}
|
|
187
|
+
|
|
188
|
+
export interface VerifierCatalog {
|
|
189
|
+
data: string[];
|
|
190
|
+
metadata: Record<string, VerifierCatalogMetadataEntry>;
|
|
191
|
+
meta?: Record<string, any>;
|
|
192
|
+
}
|
|
155
193
|
|
|
156
194
|
/**
|
|
157
195
|
* Parameters for manual verification
|
|
@@ -174,7 +212,7 @@ declare module '@neus/sdk' {
|
|
|
174
212
|
signature?: string;
|
|
175
213
|
/** Advanced/manual path: signed timestamp */
|
|
176
214
|
signedTimestamp?: number;
|
|
177
|
-
/** Advanced/
|
|
215
|
+
/** Advanced/optional. EVM signing-context hint; when omitted, resolved to the NEUS protocol primary chain for signing. For chain-specific asset claims (NFT, token, contract), set chainId inside verifier data instead. */
|
|
178
216
|
chainId?: number;
|
|
179
217
|
/** CAIP-2 chain reference for universal mode (e.g. eip155:1, solana:mainnet) */
|
|
180
218
|
chain?: string;
|
|
@@ -188,14 +226,16 @@ declare module '@neus/sdk' {
|
|
|
188
226
|
* Result from proof creation
|
|
189
227
|
*/
|
|
190
228
|
export interface ProofResult {
|
|
191
|
-
/** Proof ID
|
|
229
|
+
/** Proof receipt ID */
|
|
230
|
+
proofId: string;
|
|
231
|
+
/** HTTP wire field for the proof receipt ID. */
|
|
192
232
|
qHash: string;
|
|
193
233
|
/** Current status */
|
|
194
234
|
status: string;
|
|
195
235
|
/** Wallet address that created proof */
|
|
196
236
|
walletAddress?: string;
|
|
197
|
-
/**
|
|
198
|
-
|
|
237
|
+
/** Stable URL for GET proof record */
|
|
238
|
+
proofUrl?: string;
|
|
199
239
|
/** Cross-chain enabled */
|
|
200
240
|
crossChain?: boolean;
|
|
201
241
|
}
|
|
@@ -204,7 +244,9 @@ declare module '@neus/sdk' {
|
|
|
204
244
|
* Verification result
|
|
205
245
|
*/
|
|
206
246
|
export interface VerificationResult {
|
|
207
|
-
/** Proof ID
|
|
247
|
+
/** Proof receipt ID */
|
|
248
|
+
proofId: string;
|
|
249
|
+
/** HTTP wire field for the proof receipt ID. */
|
|
208
250
|
qHash: string;
|
|
209
251
|
/** Current status */
|
|
210
252
|
status: VerificationStatus;
|
|
@@ -218,13 +260,21 @@ declare module '@neus/sdk' {
|
|
|
218
260
|
* Status check result
|
|
219
261
|
*/
|
|
220
262
|
export interface StatusResult {
|
|
263
|
+
/** Proof receipt ID */
|
|
264
|
+
proofId?: string;
|
|
265
|
+
/** HTTP wire field for the proof receipt ID. */
|
|
266
|
+
qHash?: string;
|
|
267
|
+
/** Stable URL for GET proof record */
|
|
268
|
+
proofUrl?: string | null;
|
|
221
269
|
/** Whether verification succeeded */
|
|
222
270
|
success: boolean;
|
|
223
271
|
/** Current status */
|
|
224
272
|
status: VerificationStatus;
|
|
225
273
|
/** Full verification data */
|
|
226
274
|
data?: {
|
|
227
|
-
|
|
275
|
+
proofId?: string;
|
|
276
|
+
/** HTTP wire field for the proof receipt ID. */
|
|
277
|
+
qHash?: string;
|
|
228
278
|
status: string;
|
|
229
279
|
walletAddress: string;
|
|
230
280
|
verifierIds?: string[];
|
|
@@ -257,6 +307,7 @@ declare module '@neus/sdk' {
|
|
|
257
307
|
}>;
|
|
258
308
|
createdVouchers?: string[];
|
|
259
309
|
};
|
|
310
|
+
/** Advanced. Primary-chain transaction metadata from the NEUS protocol. */
|
|
260
311
|
hubTransaction?: {
|
|
261
312
|
txHash: string;
|
|
262
313
|
timestamp: number;
|
|
@@ -320,14 +371,17 @@ declare module '@neus/sdk' {
|
|
|
320
371
|
export type CoreVerifierId =
|
|
321
372
|
// Public verifiers (auto-path via verify())
|
|
322
373
|
| 'ownership-basic'
|
|
374
|
+
| 'ownership-social' // Hosted OAuth social ownership
|
|
323
375
|
| 'ownership-pseudonym' // Pseudonymous identity verification
|
|
376
|
+
| 'ownership-org-oauth' // Hosted OAuth organization ownership
|
|
324
377
|
| 'nft-ownership'
|
|
325
378
|
| 'token-holding'
|
|
326
379
|
| 'ownership-dns-txt'
|
|
327
380
|
| 'wallet-link'
|
|
328
381
|
| 'contract-ownership'
|
|
329
382
|
| 'wallet-risk' // Wallet risk assessment
|
|
330
|
-
//
|
|
383
|
+
| 'proof-of-human' // Hosted ZK personhood verification
|
|
384
|
+
// AI & Agent verifiers (portable, protocol-agnostic)
|
|
331
385
|
| 'agent-identity'
|
|
332
386
|
| 'agent-delegation'
|
|
333
387
|
| 'ai-content-moderation'
|
|
@@ -374,13 +428,22 @@ declare module '@neus/sdk' {
|
|
|
374
428
|
signedTimestamp: number;
|
|
375
429
|
data: any;
|
|
376
430
|
verifierIds: VerifierId[];
|
|
377
|
-
chainId
|
|
431
|
+
chainId?: number;
|
|
432
|
+
chain?: string;
|
|
378
433
|
}): string;
|
|
434
|
+
|
|
435
|
+
/** CAIP-380 six-line signer message — line 1 */
|
|
436
|
+
export const PORTABLE_PROOF_SIGNER_HEADER: string;
|
|
379
437
|
|
|
380
438
|
/**
|
|
381
439
|
* Validate Ethereum wallet address
|
|
382
440
|
*/
|
|
383
441
|
export function validateWalletAddress(address: string): boolean;
|
|
442
|
+
|
|
443
|
+
/**
|
|
444
|
+
* Validate universal wallet address format (EVM/non-EVM).
|
|
445
|
+
*/
|
|
446
|
+
export function validateUniversalAddress(address: string, chain?: string): boolean;
|
|
384
447
|
|
|
385
448
|
/**
|
|
386
449
|
* Validate timestamp freshness
|
|
@@ -388,7 +451,7 @@ declare module '@neus/sdk' {
|
|
|
388
451
|
export function validateTimestamp(timestamp: number, maxAgeMs?: number): boolean;
|
|
389
452
|
|
|
390
453
|
/**
|
|
391
|
-
* Validate Proof ID (qHash)
|
|
454
|
+
* Validate Proof ID format (`qHash` wire alias)
|
|
392
455
|
*/
|
|
393
456
|
export function validateQHash(qHash: string): boolean;
|
|
394
457
|
|
|
@@ -397,6 +460,71 @@ declare module '@neus/sdk' {
|
|
|
397
460
|
*/
|
|
398
461
|
export function normalizeAddress(address: string): string;
|
|
399
462
|
|
|
463
|
+
/**
|
|
464
|
+
* Resolve DID from wallet identity via profile resolver endpoint.
|
|
465
|
+
* EVM wallets resolve to the NEUS protocol primary chain by default; chainId is optional.
|
|
466
|
+
* Use `chain` (CAIP-2) for non-EVM wallets (e.g. `solana:mainnet`).
|
|
467
|
+
*/
|
|
468
|
+
export function resolveDID(
|
|
469
|
+
params: {
|
|
470
|
+
walletAddress?: string;
|
|
471
|
+
chainId?: number;
|
|
472
|
+
chain?: string;
|
|
473
|
+
},
|
|
474
|
+
options?: {
|
|
475
|
+
endpoint?: string;
|
|
476
|
+
apiUrl?: string;
|
|
477
|
+
credentials?: 'omit' | 'same-origin' | 'include';
|
|
478
|
+
headers?: Record<string, string>;
|
|
479
|
+
}
|
|
480
|
+
): Promise<{
|
|
481
|
+
did: string;
|
|
482
|
+
data: unknown;
|
|
483
|
+
raw: unknown;
|
|
484
|
+
}>;
|
|
485
|
+
|
|
486
|
+
/**
|
|
487
|
+
* Build a server-standardized signing payload.
|
|
488
|
+
*/
|
|
489
|
+
export function standardizeVerificationRequest(
|
|
490
|
+
params: Record<string, any>,
|
|
491
|
+
options?: {
|
|
492
|
+
endpoint?: string;
|
|
493
|
+
apiUrl?: string;
|
|
494
|
+
credentials?: 'omit' | 'same-origin' | 'include';
|
|
495
|
+
headers?: Record<string, string>;
|
|
496
|
+
}
|
|
497
|
+
): Promise<any>;
|
|
498
|
+
|
|
499
|
+
/**
|
|
500
|
+
* Resolve ZK Passport default configuration.
|
|
501
|
+
*/
|
|
502
|
+
export function resolveZkPassportConfig(overrides?: Record<string, any>): {
|
|
503
|
+
provider: string;
|
|
504
|
+
scope: string;
|
|
505
|
+
checkSanctions: boolean;
|
|
506
|
+
requireFaceMatch: boolean;
|
|
507
|
+
faceMatchMode: string;
|
|
508
|
+
[key: string]: any;
|
|
509
|
+
};
|
|
510
|
+
|
|
511
|
+
/**
|
|
512
|
+
* Convert a UTF-8 message string to a 0x-prefixed hex payload.
|
|
513
|
+
*/
|
|
514
|
+
export function toHexUtf8(message: string): string;
|
|
515
|
+
|
|
516
|
+
/**
|
|
517
|
+
* Sign a message with an injected/provider wallet.
|
|
518
|
+
* Uses `personal_sign` and retries with UTF-8 hex payloads when providers
|
|
519
|
+
* report encoding/non-hex input issues (common with some embedded wallets).
|
|
520
|
+
*/
|
|
521
|
+
export function signMessage(params: {
|
|
522
|
+
provider?: any;
|
|
523
|
+
message: string;
|
|
524
|
+
walletAddress?: string;
|
|
525
|
+
chain?: string;
|
|
526
|
+
}): Promise<string>;
|
|
527
|
+
|
|
400
528
|
/**
|
|
401
529
|
* Validate a verifier payload for basic structural integrity
|
|
402
530
|
*/
|
|
@@ -410,9 +538,10 @@ declare module '@neus/sdk' {
|
|
|
410
538
|
data: any;
|
|
411
539
|
walletAddress: string;
|
|
412
540
|
chainId?: number;
|
|
541
|
+
chain?: string;
|
|
413
542
|
options?: any;
|
|
414
543
|
signedTimestamp?: number;
|
|
415
|
-
}): { message: string; request: { verifierIds: string[]; data: any; walletAddress: string; signedTimestamp: number; chainId
|
|
544
|
+
}): { message: string; request: { verifierIds: string[]; data: any; walletAddress: string; signedTimestamp: number; chainId?: number; chain?: string; options?: any } };
|
|
416
545
|
|
|
417
546
|
/**
|
|
418
547
|
* Check if status is terminal (complete)
|
|
@@ -443,7 +572,7 @@ declare module '@neus/sdk' {
|
|
|
443
572
|
* Status polling utility
|
|
444
573
|
*/
|
|
445
574
|
export class StatusPoller {
|
|
446
|
-
constructor(client: NeusClient,
|
|
575
|
+
constructor(client: NeusClient, proofId: string, options?: { interval?: number; maxAttempts?: number; exponentialBackoff?: boolean; maxInterval?: number });
|
|
447
576
|
poll(): Promise<StatusResult>;
|
|
448
577
|
}
|
|
449
578
|
|
|
@@ -472,19 +601,51 @@ declare module '@neus/sdk' {
|
|
|
472
601
|
backoffFactor?: number;
|
|
473
602
|
}): Promise<T>;
|
|
474
603
|
|
|
475
|
-
/**
|
|
476
|
-
* Proof status
|
|
477
|
-
*/
|
|
478
|
-
// Use NeusClient.getStatus(qHash) for status checks.
|
|
479
|
-
|
|
480
|
-
|
|
481
604
|
// ============================================================================
|
|
482
605
|
// CONSTANTS & REGISTRY
|
|
483
606
|
// ============================================================================
|
|
607
|
+
|
|
608
|
+
/**
|
|
609
|
+
* Build `agent-delegation` maxSpend from a display decimal (e.g. USDC `"100.50"` with six decimal places).
|
|
610
|
+
* Returns a whole-number string in token base units (no decimal point) for the verifier API.
|
|
611
|
+
*/
|
|
612
|
+
export function toAgentDelegationMaxSpend(
|
|
613
|
+
humanAmount: string | number,
|
|
614
|
+
decimals: number
|
|
615
|
+
): string;
|
|
484
616
|
|
|
485
617
|
/**
|
|
486
618
|
* NEUS Network constants
|
|
487
619
|
*/
|
|
620
|
+
export const DEFAULT_HOSTED_VERIFY_URL: string;
|
|
621
|
+
|
|
622
|
+
export function getHostedCheckoutUrl(opts?: {
|
|
623
|
+
gateId?: string;
|
|
624
|
+
returnUrl?: string;
|
|
625
|
+
verifiers?: string[];
|
|
626
|
+
preset?: string;
|
|
627
|
+
mode?: string;
|
|
628
|
+
intent?: string;
|
|
629
|
+
origin?: string;
|
|
630
|
+
oauthProvider?: string;
|
|
631
|
+
baseUrl?: string;
|
|
632
|
+
}): string;
|
|
633
|
+
|
|
634
|
+
/**
|
|
635
|
+
* Public gate monetization.charge from GET /api/v1/profile/gates/{gateId} (sanitized).
|
|
636
|
+
* Safe for clients: no payout secrets; `recipient` is the published settlement address when enabled.
|
|
637
|
+
*/
|
|
638
|
+
export type NeusPublicGateCharge = {
|
|
639
|
+
enabled: boolean;
|
|
640
|
+
scheme: string;
|
|
641
|
+
label: string;
|
|
642
|
+
amountUsd: number;
|
|
643
|
+
methods: string[];
|
|
644
|
+
appliesTo: string;
|
|
645
|
+
executionOrder?: string;
|
|
646
|
+
recipient?: string;
|
|
647
|
+
};
|
|
648
|
+
|
|
488
649
|
export const NEUS_CONSTANTS: {
|
|
489
650
|
HUB_CHAIN_ID: number;
|
|
490
651
|
TESTNET_CHAINS: number[];
|
|
@@ -549,12 +710,6 @@ declare module '@neus/sdk' {
|
|
|
549
710
|
*/
|
|
550
711
|
export class AuthenticationError extends SDKError {}
|
|
551
712
|
|
|
552
|
-
// ============================================================================
|
|
553
|
-
// SCHEMA ACCESS
|
|
554
|
-
// ============================================================================
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
713
|
// ============================================================================
|
|
559
714
|
// PROOFS & GATING TYPES
|
|
560
715
|
// ============================================================================
|
|
@@ -567,6 +722,10 @@ declare module '@neus/sdk' {
|
|
|
567
722
|
limit?: number;
|
|
568
723
|
/** Offset for pagination */
|
|
569
724
|
offset?: number;
|
|
725
|
+
/** CAIP-2 signer chain for owner-signed private access (non-EVM) */
|
|
726
|
+
chain?: string;
|
|
727
|
+
/** Signature method hint for owner-signed private access (eip191, ed25519, ...) */
|
|
728
|
+
signatureMethod?: string;
|
|
570
729
|
}
|
|
571
730
|
|
|
572
731
|
/**
|
|
@@ -624,10 +783,10 @@ declare module '@neus/sdk' {
|
|
|
624
783
|
|
|
625
784
|
/**
|
|
626
785
|
* Parameters for gateCheck() (API-backed).
|
|
627
|
-
* Mirrors `GET /api/v1/proofs/
|
|
786
|
+
* Mirrors `GET /api/v1/proofs/check` query parameters.
|
|
628
787
|
*/
|
|
629
788
|
export interface GateCheckApiParams {
|
|
630
|
-
/** Wallet
|
|
789
|
+
/** Wallet identity to check (EVM/Solana/NEAR) */
|
|
631
790
|
address: string;
|
|
632
791
|
/** Verifier IDs to match (array or comma-separated string) */
|
|
633
792
|
verifierIds?: string[] | string;
|
|
@@ -641,6 +800,18 @@ declare module '@neus/sdk' {
|
|
|
641
800
|
since?: number;
|
|
642
801
|
/** Max rows to scan (server may clamp) */
|
|
643
802
|
limit?: number;
|
|
803
|
+
/** Include private proofs for owner/controller-authorized checks */
|
|
804
|
+
includePrivate?: boolean;
|
|
805
|
+
/** Include matched qHashes in response (minimal identifiers only) */
|
|
806
|
+
includeQHashes?: boolean;
|
|
807
|
+
/** Optional wallet/provider used to sign includePrivate owner checks */
|
|
808
|
+
wallet?: WalletLike;
|
|
809
|
+
/** CAIP-2 signer chain for universal owner signatures (e.g. solana:mainnet) */
|
|
810
|
+
chain?: string;
|
|
811
|
+
/** Signature method hint for universal owner signatures (eip191, ed25519, ...) */
|
|
812
|
+
signatureMethod?: string;
|
|
813
|
+
/** Optional pre-signed owner auth payload to reuse across multiple gateCheck calls */
|
|
814
|
+
privateAuth?: GatePrivateAuth;
|
|
644
815
|
|
|
645
816
|
// Common match filters
|
|
646
817
|
referenceType?: string;
|
|
@@ -651,9 +822,10 @@ declare module '@neus/sdk' {
|
|
|
651
822
|
content?: string;
|
|
652
823
|
contentHash?: string;
|
|
653
824
|
|
|
654
|
-
// Asset/ownership filters
|
|
825
|
+
// Asset/ownership filters — chainId here is the chain where the asset lives (e.g. 8453 for Base, 1 for Ethereum)
|
|
655
826
|
contractAddress?: string;
|
|
656
827
|
tokenId?: string;
|
|
828
|
+
/** EVM chain ID of the asset (e.g. 1, 8453). Required for nft-ownership, token-holding, contract-ownership. */
|
|
657
829
|
chainId?: number;
|
|
658
830
|
domain?: string;
|
|
659
831
|
minBalance?: string;
|
|
@@ -661,6 +833,10 @@ declare module '@neus/sdk' {
|
|
|
661
833
|
// Wallet filters
|
|
662
834
|
/** Risk assessment provider hint. Known value: webacy. */
|
|
663
835
|
provider?: string;
|
|
836
|
+
/** Social handle (ownership-social) or pseudonym handle (ownership-pseudonym); server matches data.handle / pseudonymId */
|
|
837
|
+
handle?: string;
|
|
838
|
+
/** ownership-pseudonym namespace filter (matches GET /api/v1/proofs/check `namespace` query) */
|
|
839
|
+
namespace?: string;
|
|
664
840
|
ownerAddress?: string;
|
|
665
841
|
riskLevel?: string;
|
|
666
842
|
sanctioned?: boolean;
|
|
@@ -670,12 +846,22 @@ declare module '@neus/sdk' {
|
|
|
670
846
|
verificationMethod?: string;
|
|
671
847
|
}
|
|
672
848
|
|
|
849
|
+
export interface GatePrivateAuth {
|
|
850
|
+
walletAddress: string;
|
|
851
|
+
signature: string;
|
|
852
|
+
signedTimestamp: number;
|
|
853
|
+
chain?: string;
|
|
854
|
+
signatureMethod?: string;
|
|
855
|
+
}
|
|
856
|
+
|
|
673
857
|
export interface GateCheckApiResponse {
|
|
674
858
|
success: boolean;
|
|
675
859
|
data?: {
|
|
676
860
|
eligible: boolean;
|
|
677
861
|
matchedCount?: number;
|
|
678
862
|
matchedQHashes?: string[];
|
|
863
|
+
/** @deprecated matchedProofIds is a compatibility alias of matchedQHashes (same values when provided). */
|
|
864
|
+
matchedProofIds?: string[];
|
|
679
865
|
matchedTags?: string[];
|
|
680
866
|
projections?: Array<Record<string, any>> | null;
|
|
681
867
|
criteria?: Record<string, any>;
|
|
@@ -842,7 +1028,8 @@ declare module '@neus/sdk' {
|
|
|
842
1028
|
primaryWalletAddress: string;
|
|
843
1029
|
secondaryWalletAddress: string;
|
|
844
1030
|
signature: string;
|
|
845
|
-
|
|
1031
|
+
chain: string;
|
|
1032
|
+
signatureMethod: string;
|
|
846
1033
|
signedTimestamp: number;
|
|
847
1034
|
relationshipType?: 'primary' | 'personal' | 'org' | 'affiliate' | 'agent' | 'linked';
|
|
848
1035
|
label?: string;
|
|
@@ -872,6 +1059,13 @@ declare module '@neus/sdk' {
|
|
|
872
1059
|
agentType?: 'ai' | 'bot' | 'service' | 'automation' | 'agent';
|
|
873
1060
|
description?: string;
|
|
874
1061
|
capabilities?: any[];
|
|
1062
|
+
instructions?: string;
|
|
1063
|
+
skills?: string[];
|
|
1064
|
+
services?: Array<{
|
|
1065
|
+
name: string;
|
|
1066
|
+
endpoint: string;
|
|
1067
|
+
version?: string;
|
|
1068
|
+
}>;
|
|
875
1069
|
[key: string]: any;
|
|
876
1070
|
};
|
|
877
1071
|
|
|
@@ -881,10 +1075,13 @@ declare module '@neus/sdk' {
|
|
|
881
1075
|
agentId?: string;
|
|
882
1076
|
scope?: string;
|
|
883
1077
|
permissions?: any[];
|
|
1078
|
+
/** Whole-number string, token base units (1–78 digits, no decimal point). Build via `toAgentDelegationMaxSpend`. */
|
|
884
1079
|
maxSpend?: string;
|
|
885
1080
|
allowedPaymentTypes?: string[];
|
|
886
1081
|
receiptDisclosure?: 'none' | 'summary' | 'full';
|
|
887
1082
|
expiresAt?: number;
|
|
1083
|
+
instructions?: string;
|
|
1084
|
+
skills?: string[];
|
|
888
1085
|
[key: string]: any;
|
|
889
1086
|
};
|
|
890
1087
|
|
|
@@ -981,28 +1178,45 @@ declare module '@neus/sdk/widgets' {
|
|
|
981
1178
|
requiredVerifiers?: string[];
|
|
982
1179
|
/** Callback when verification completes successfully */
|
|
983
1180
|
onVerified?: (result: {
|
|
1181
|
+
proofId: string;
|
|
1182
|
+
/** HTTP wire field for the proof receipt ID. */
|
|
984
1183
|
qHash: string;
|
|
1184
|
+
proofIds?: string[];
|
|
1185
|
+
/** HTTP wire fields for proof receipt IDs. */
|
|
985
1186
|
qHashes?: string[];
|
|
986
1187
|
address?: string;
|
|
987
1188
|
txHash?: string | null;
|
|
988
1189
|
verifierIds: string[];
|
|
989
1190
|
verifiedVerifiers?: any[];
|
|
990
|
-
|
|
1191
|
+
proofUrl?: string | null;
|
|
991
1192
|
existing?: boolean;
|
|
1193
|
+
eligible?: boolean;
|
|
992
1194
|
mode?: 'create' | 'access';
|
|
993
1195
|
data?: any;
|
|
994
1196
|
results?: Array<{
|
|
995
1197
|
verifierId: string;
|
|
1198
|
+
proofId: string;
|
|
1199
|
+
/** HTTP wire field for the proof receipt ID. */
|
|
996
1200
|
qHash: string;
|
|
997
1201
|
address?: string;
|
|
998
1202
|
txHash?: string | null;
|
|
999
1203
|
verifiedVerifiers?: any[];
|
|
1000
|
-
|
|
1204
|
+
proofUrl?: string | null;
|
|
1001
1205
|
}>;
|
|
1002
1206
|
proofsByVerifierId?: Record<string, any>;
|
|
1003
1207
|
}) => void;
|
|
1004
1208
|
/** Custom API endpoint URL */
|
|
1005
1209
|
apiUrl?: string;
|
|
1210
|
+
/** Optional public app attribution ID (maps to X-Neus-App) */
|
|
1211
|
+
appId?: string;
|
|
1212
|
+
/** Optional x402 receipt token for retry calls (maps to PAYMENT-SIGNATURE) */
|
|
1213
|
+
paymentSignature?: string;
|
|
1214
|
+
/** Optional extra passthrough headers for advanced integrations */
|
|
1215
|
+
extraHeaders?: Record<string, string>;
|
|
1216
|
+
/** Hosted checkout URL for interactive verifiers (default: https://neus.network/verify) */
|
|
1217
|
+
hostedCheckoutUrl?: string;
|
|
1218
|
+
/** Optional OAuth provider id to pre-select for social/org verifiers (hosted flow) */
|
|
1219
|
+
oauthProvider?: string;
|
|
1006
1220
|
/** Custom inline styles */
|
|
1007
1221
|
style?: Record<string, any>;
|
|
1008
1222
|
/** Child content to show when verified */
|
|
@@ -1011,7 +1225,7 @@ declare module '@neus/sdk/widgets' {
|
|
|
1011
1225
|
verifierOptions?: Record<string, any>;
|
|
1012
1226
|
/** Pre-built verifier data for each verifier */
|
|
1013
1227
|
verifierData?: Record<string, any>;
|
|
1014
|
-
/** Proof creation options (
|
|
1228
|
+
/** Proof creation options (defaults: private, publicDisplay false, storeOriginalContent true) */
|
|
1015
1229
|
proofOptions?: Record<string, any>;
|
|
1016
1230
|
/** Proof reuse strategy */
|
|
1017
1231
|
strategy?: 'reuse-or-create' | 'reuse' | 'fresh';
|
|
@@ -1029,8 +1243,16 @@ declare module '@neus/sdk/widgets' {
|
|
|
1029
1243
|
buttonText?: string;
|
|
1030
1244
|
/** Mode: 'create' for new verification, 'access' for private proof access */
|
|
1031
1245
|
mode?: 'create' | 'access';
|
|
1032
|
-
/**
|
|
1246
|
+
/** proofId for private proof access (required when mode='access') */
|
|
1247
|
+
proofId?: string | null;
|
|
1248
|
+
/** HTTP wire field for callers that receive API-shaped proof records. */
|
|
1033
1249
|
qHash?: string | null;
|
|
1250
|
+
/** Optional injected wallet/provider for signing flows */
|
|
1251
|
+
wallet?: WalletLike | any;
|
|
1252
|
+
/** Optional CAIP-2 chain context for non-EVM owner signatures */
|
|
1253
|
+
chain?: string;
|
|
1254
|
+
/** Optional signature method hint for non-EVM owner signatures */
|
|
1255
|
+
signatureMethod?: string;
|
|
1034
1256
|
/** Callback for state changes */
|
|
1035
1257
|
onStateChange?: (state: string) => void;
|
|
1036
1258
|
/** Callback for errors */
|
|
@@ -1040,8 +1262,12 @@ declare module '@neus/sdk/widgets' {
|
|
|
1040
1262
|
export function VerifyGate(props: VerifyGateProps): any;
|
|
1041
1263
|
|
|
1042
1264
|
export interface ProofBadgeProps {
|
|
1043
|
-
/** Proof ID
|
|
1044
|
-
|
|
1265
|
+
/** Proof receipt ID. */
|
|
1266
|
+
proofId?: string;
|
|
1267
|
+
/** HTTP wire field for callers that receive API-shaped proof records. Prefer proofId. */
|
|
1268
|
+
qHash?: string;
|
|
1269
|
+
/** URL path pattern for proof links. Supports :proofId. */
|
|
1270
|
+
proofUrlPattern?: string;
|
|
1045
1271
|
/** Badge size */
|
|
1046
1272
|
size?: 'sm' | 'md';
|
|
1047
1273
|
/** UI platform base URL */
|
|
@@ -1054,8 +1280,10 @@ declare module '@neus/sdk/widgets' {
|
|
|
1054
1280
|
showChains?: boolean;
|
|
1055
1281
|
/** Show status label (default: true) */
|
|
1056
1282
|
showLabel?: boolean;
|
|
1283
|
+
/** Logo URL override (defaults to bundled NEUS logo) */
|
|
1284
|
+
logoUrl?: string;
|
|
1057
1285
|
/** Custom click handler */
|
|
1058
|
-
onClick?: (data: { qHash: string; status: string; chainCount?: number }) => void;
|
|
1286
|
+
onClick?: (data: { proofId: string; qHash: string; status: string; chainCount?: number }) => void;
|
|
1059
1287
|
/** Additional CSS class */
|
|
1060
1288
|
className?: string;
|
|
1061
1289
|
}
|
|
@@ -1063,41 +1291,59 @@ declare module '@neus/sdk/widgets' {
|
|
|
1063
1291
|
export function ProofBadge(props: ProofBadgeProps): any;
|
|
1064
1292
|
|
|
1065
1293
|
export interface SimpleProofBadgeProps {
|
|
1066
|
-
|
|
1294
|
+
proofId?: string;
|
|
1295
|
+
/** HTTP wire field for callers that receive API-shaped proof records. Prefer proofId. */
|
|
1296
|
+
qHash?: string;
|
|
1297
|
+
/** URL path pattern for proof links. Supports :proofId. */
|
|
1298
|
+
proofUrlPattern?: string;
|
|
1067
1299
|
uiLinkBase?: string;
|
|
1068
1300
|
apiUrl?: string;
|
|
1069
1301
|
size?: 'sm' | 'md';
|
|
1070
1302
|
/** Label text (default: 'Verified') */
|
|
1071
1303
|
label?: string;
|
|
1304
|
+
/** Logo URL override (defaults to bundled NEUS logo) */
|
|
1305
|
+
logoUrl?: string;
|
|
1072
1306
|
proof?: any;
|
|
1073
|
-
onClick?: (data: { qHash: string; status: string }) => void;
|
|
1307
|
+
onClick?: (data: { proofId: string; qHash: string; status: string }) => void;
|
|
1074
1308
|
className?: string;
|
|
1075
1309
|
}
|
|
1076
1310
|
|
|
1077
1311
|
export function SimpleProofBadge(props: SimpleProofBadgeProps): any;
|
|
1078
1312
|
|
|
1079
1313
|
export interface NeusPillLinkProps {
|
|
1314
|
+
proofId?: string;
|
|
1315
|
+
/** HTTP wire field for callers that receive API-shaped proof records. Prefer proofId. */
|
|
1080
1316
|
qHash?: string;
|
|
1317
|
+
/** URL path pattern for proof links. Supports :proofId. */
|
|
1318
|
+
proofUrlPattern?: string;
|
|
1081
1319
|
uiLinkBase?: string;
|
|
1082
1320
|
label?: string;
|
|
1083
1321
|
size?: 'sm' | 'md';
|
|
1084
|
-
|
|
1322
|
+
/** Logo URL override (defaults to bundled NEUS logo) */
|
|
1323
|
+
logoUrl?: string;
|
|
1324
|
+
onClick?: (data: { proofId?: string; qHash?: string }) => void;
|
|
1085
1325
|
className?: string;
|
|
1086
1326
|
}
|
|
1087
1327
|
|
|
1088
1328
|
export function NeusPillLink(props: NeusPillLinkProps): any;
|
|
1089
1329
|
|
|
1090
1330
|
export interface VerifiedIconProps {
|
|
1091
|
-
/** Proof ID
|
|
1331
|
+
/** Proof receipt ID for link */
|
|
1332
|
+
proofId?: string;
|
|
1333
|
+
/** HTTP wire field for callers that receive API-shaped proof records. Prefer proofId. */
|
|
1092
1334
|
qHash?: string;
|
|
1335
|
+
/** URL path pattern for proof links. Supports :proofId. */
|
|
1336
|
+
proofUrlPattern?: string;
|
|
1093
1337
|
/** UI platform base URL */
|
|
1094
1338
|
uiLinkBase?: string;
|
|
1095
1339
|
/** Icon size in pixels */
|
|
1096
1340
|
size?: number;
|
|
1341
|
+
/** Logo URL override (defaults to bundled NEUS logo) */
|
|
1342
|
+
logoUrl?: string;
|
|
1097
1343
|
/** Tooltip text */
|
|
1098
1344
|
tooltip?: string;
|
|
1099
1345
|
/** Custom click handler */
|
|
1100
|
-
onClick?: (data: { qHash?: string }) => void;
|
|
1346
|
+
onClick?: (data: { proofId?: string; qHash?: string }) => void;
|
|
1101
1347
|
/** Additional CSS class */
|
|
1102
1348
|
className?: string;
|
|
1103
1349
|
}
|
|
@@ -1107,4 +1353,8 @@ declare module '@neus/sdk/widgets' {
|
|
|
1107
1353
|
|
|
1108
1354
|
declare module '@neus/sdk/widgets/verify-gate' {
|
|
1109
1355
|
export * from '@neus/sdk/widgets';
|
|
1110
|
-
}
|
|
1356
|
+
}
|
|
1357
|
+
|
|
1358
|
+
declare module '@neus/sdk/client' {
|
|
1359
|
+
export { NeusClient } from '@neus/sdk';
|
|
1360
|
+
}
|