@neus/sdk 1.0.0

package/LICENSE

@@ -0,0 +1,181 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (which shall not include communication that is conspicuously
+      marked or otherwise designated in writing by the copyright owner
+      as "Not a Contribution").
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control
+      systems, and issue tracking systems that are managed by, or on behalf
+      of, the Licensor for the purpose of discussing and improving the Work,
+      but excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution".
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to use, reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright notice or additional
+      terms and conditions for use, reproduction, or distribution of Your
+      derivative works, or for any such Derivative Works as a whole,
+      provided Your use, reproduction, and distribution of the Work
+      otherwise complies with the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Support. When redistributing the Work or
+      Derivative Works thereof, You may choose to offer, and charge a fee
+      for, acceptance of support, warranty, indemnity, or other liability
+      obligations and/or rights consistent with this License. However, in
+      accepting such obligations, You may act only on Your own behalf and
+      on Your sole responsibility, not on behalf of any other Contributor,
+      and only if You agree to indemnify, defend, and hold each Contributor
+      harmless for any liability incurred by, or claims asserted against,
+      such Contributor by reason of your accepting any such warranty or support.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 NEUS Network, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,206 @@
+# NEUS SDK
+
+JavaScript client for NEUS Network. Handles wallet signing and API calls automatically.
+
+## Installation
+
+```bash
+npm install @neus/sdk
+```
+
+## Quick Start
+
+```javascript
+import { NeusClient } from '@neus/sdk';
+
+const client = new NeusClient();
+const proof = await client.verify({
+  verifier: 'ownership-basic',
+  content: 'Hello NEUS Network'
+});
+
+console.log('Proof created:', proof.qHash);
+```
+
+## Basic Usage
+
+### Create Proof
+
+```javascript
+// Content ownership
+const proof = await client.verify({
+  verifier: 'ownership-basic',
+  content: 'My original content'
+});
+
+// NFT ownership  
+const proof = await client.verify({
+  verifier: 'nft-ownership',
+  data: {
+    ownerAddress: walletAddress,
+    contractAddress: '0x...',
+    tokenId: '1234',
+    chainId: 1
+  }
+});
+
+// Token holdings
+const proof = await client.verify({
+  verifier: 'token-holding',
+  data: {
+    ownerAddress: walletAddress,
+    contractAddress: '0x...',
+    minBalance: '100.0',
+    chainId: 1
+  }
+});
+```
+
+### Check Status
+
+```javascript
+// Public proof status
+const status = await client.getStatus(proof.qHash);
+console.log('Verified:', status.success);
+
+// Private proof access (requires wallet signature)
+const privateStatus = await client.getPrivateStatus(proof.qHash, wallet);
+```
+
+### Monitor Progress
+
+```javascript
+// Poll until completion
+const finalStatus = await client.pollProofStatus(proof.qHash, {
+  interval: 3000,
+  onProgress: (status) => console.log('Current status:', status.status)
+});
+```
+
+## Configuration
+
+```javascript
+const client = new NeusClient({
+  apiUrl: 'https://api.neus.network', // Default
+  timeout: 30000                      // Request timeout
+});
+```
+
+## Privacy Controls
+
+```javascript
+// Public proof - publicly accessible verification details
+const publicProof = await client.verify({
+  verifier: 'ownership-basic',
+  content: 'Public content',
+  options: { privacyLevel: 'public' }
+});
+
+// Private proof - restricted access; details require wallet authentication
+const privateProof = await client.verify({
+  verifier: 'ownership-basic', 
+  content: 'Private content',
+  options: { privacyLevel: 'private' }
+});
+```
+
+## Cross-Chain Storage
+
+Store proofs on multiple testnets:
+
+```javascript
+const proof = await client.verify({
+  verifier: 'ownership-basic',
+  content: 'Multi-chain proof',
+  options: {
+    targetChains: [11155111, 80002, 421614] // Testnet chains
+  }
+});
+```
+
+## Error Handling
+
+```javascript
+try {
+  const proof = await client.verify({
+    verifier: 'ownership-basic',
+    content: 'Hello NEUS'
+  });
+} catch (error) {
+  if (error.code === 4001) {
+    console.log('User cancelled verification');
+  } else {
+    console.error('Verification failed:', error.message);
+  }
+}
+```
+
+## API Methods
+
+### `verify(params)`
+
+Create verification proof.
+
+**Parameters:**
+- `verifier` (string) - Verifier ID
+- `content` (string) - Content to verify (for ownership-basic)
+- `data` (object) - Verifier-specific data
+- `options` (object) - Privacy and storage options
+
+**Returns:** `{ qHash, status, data }`
+
+### `getStatus(qHash)`
+
+Get proof status.
+
+**Parameters:**
+- `qHash` (string) - Proof identifier
+
+**Returns:** `{ success, status, data }`
+
+### `getPrivateStatus(qHash, wallet)`
+
+Access private proof with wallet signature.
+
+**Parameters:**
+- `qHash` (string) - Proof identifier  
+- `wallet` (object) - Wallet provider
+
+**Returns:** `{ success, status, data }`
+
+### `pollProofStatus(qHash, options)`
+
+Poll until verification completes.
+
+**Parameters:**
+- `qHash` (string) - Proof identifier
+- `options` (object) - Polling configuration
+  - `interval` (number) - Polling interval in ms
+  - `timeout` (number) - Total timeout in ms
+  - `onProgress` (function) - Progress callback
+
+**Returns:** `{ success, status, data }`
+
+### `isHealthy()`
+
+Check API connectivity.
+
+**Returns:** `boolean`
+
+### `getVerifiers()`
+
+List available verifiers.
+
+**Returns:** `string[]`
+
+## Requirements
+
+- **Node.js**: 18+ 
+- **Browser**: Modern browser with Web3 wallet
+- **Wallet**: MetaMask, WalletConnect, or ethers.js Wallet
+
+## Links
+
+- **[Complete Reference](https://github.com/neus/network/tree/main/docs/REFERENCE.md)** - Full API and verifier documentation
+- **[Available Verifiers](https://github.com/neus/network/tree/main/docs/VERIFIERS.md)** - All verification types
+- **[GitHub Issues](https://github.com/neus/network/issues)** - Community support

package/SECURITY.md

@@ -0,0 +1,224 @@
+# NEUS SDK Security Guidelines
+
+## Overview
+
+The NEUS Network provides cryptographic verification infrastructure with strong security guarantees at the protocol level. Developers implementing custom verifiers or integrating the SDK must understand and follow security best practices to maintain system integrity.
+
+## Core Security Model
+
+### What NEUS Guarantees
+
+- **EIP-191/EIP-1271 Signature Verification**: All API calls require valid signatures (supports contract wallets)
+- **Replay Protection**: 5-minute timestamp windows with anti-replay protections
+- **Cross-Chain Integrity**: Cryptographic proofs propagated across multiple chains
+- **Immutable Audit Trail**: All verifications stored with quantum-safe qHash identifiers
+- **Privacy-Respecting IPFS**: Public snapshots protect sensitive data; signatures never exposed
+
+### Developer Responsibilities
+
+- **Input Validation**: Sanitize all user-provided data before verification
+- **Contract Security**: Verify smart contract addresses before interaction
+- **API Rate Limiting**: Implement appropriate limits for external service calls
+- **Key Management**: Never expose private keys in verifier logic
+
+## Verifier Security Checklist
+
+### 1. Input Validation
+
+```javascript
+// CORRECT: Validate inputs
+async verify(data, options) {
+  // Validate address format
+  if (!ethers.isAddress(data.contractAddress)) {
+    throw new ValidationError('Invalid contract address');
+  }
+  
+  // Sanitize content
+  const sanitizedContent = data.content.trim().slice(0, 1000);
+  
+  // Verify required fields (owner for ownership-basic/licensed, ownerAddress for nft-ownership/token-holding)
+  if ((!data.owner && !data.ownerAddress) || !data.reference) {
+    throw new ValidationError('Missing required fields');
+  }
+}
+
+// WRONG: Direct usage without validation
+async verify(data, options) {
+  const result = await contract.balanceOf(data.address); // Unsafe!
+}
+```
+
+### 2. External API Security
+
+```javascript
+// CORRECT: Rate limiting and error handling
+class ExternalVerifier {
+  constructor() {
+    this.rateLimiter = new Map();
+    this.maxRequests = 100; // per hour
+  }
+  
+  async callExternalAPI(userId) {
+    // Check rate limits
+    if (this.isRateLimited(userId)) {
+      throw new Error('Rate limit exceeded');
+    }
+    
+    try {
+      const result = await fetch(url, { timeout: 5000 });
+      return result;
+    } catch (error) {
+      // Don't expose internal errors
+      throw new Error('External verification failed');
+    }
+  }
+}
+```
+
+### 3. Smart Contract Interaction
+
+```javascript
+// CORRECT: Verify contract bytecode
+async verifyContract(address, expectedBytecode) {
+  const provider = new ethers.JsonRpcProvider(RPC_URL);
+  const code = await provider.getCode(address);
+  
+  if (code === '0x') {
+    throw new Error('No contract at address');
+  }
+  
+  // Optionally verify against known bytecode
+  if (expectedBytecode && code !== expectedBytecode) {
+    throw new Error('Contract bytecode mismatch');
+  }
+}
+```
+
+## Common Attack Vectors
+
+### 1. Proof Spoofing
+
+**Risk**: Malicious users attempting to forge verification results
+
+**Mitigation**:
+- Always verify ownership through on-chain data or cryptographic signatures
+- Never trust client-provided verification results
+- Use the protocol's signature verification for all critical operations
+ - Use `verifierContentHash` for proof-of-existence; avoid publishing full content unless explicitly intended
+
+### 2. Replay Attacks
+
+**Risk**: Reusing old signatures or proofs
+
+**Mitigation**:
+- Built-in: 5-minute timestamp validation and anti-replay protections
+- Additional: Include chain-specific data in verification
+
+### 3. Unintended Data Exposure
+
+**Risk**: Accidentally exposing private content in public snapshots
+
+**Mitigation**:
+- Set `privacyLevel: 'private'` and avoid `publicDisplay`/`storeOriginalContent`
+- For anchoring without exposure, use `enableIpfs: true` with `publicDisplay: false`, `storeOriginalContent: false`
+- Ensure UI defaults use secure privacy settings
+
+### 4. Contract Upgrades
+
+**Risk**: Verified contracts changing implementation
+
+**Mitigation**:
+- Store contract address AND block number in proof
+- Consider proxy pattern detection
+- Document upgrade implications for users
+
+## Rate Limiting Guidelines
+
+### External APIs
+
+| Service Type | Recommended Limit | Timeout |
+|-------------|------------------|---------|
+| Blockchain RPC | 100 req/sec | 10s |
+| Social APIs | 10 req/min | 5s |
+| DNS Lookups | 50 req/min | 3s |
+| IPFS Gateway | 30 req/min | 30s |
+
+### Implementation Example
+
+```javascript
+class RateLimiter {
+  constructor(maxRequests, windowMs) {
+    this.requests = new Map();
+    this.maxRequests = maxRequests;
+    this.windowMs = windowMs;
+  }
+  
+  allow(identifier) {
+    const now = Date.now();
+    const requests = this.requests.get(identifier) || [];
+    
+    // Clean old requests
+    const valid = requests.filter(t => now - t < this.windowMs);
+    
+    if (valid.length >= this.maxRequests) {
+      return false;
+    }
+    
+    valid.push(now);
+    this.requests.set(identifier, valid);
+    return true;
+  }
+}
+```
+
+## Error Handling
+
+### Security-First Error Messages
+
+```javascript
+// CORRECT: Generic external errors
+catch (error) {
+  logger.error('Verification failed', { 
+    error: error.message,
+    userId: data.owner 
+  });
+  throw new Error('Verification failed');
+}
+
+// WRONG: Exposing internal details
+catch (error) {
+  throw new Error(`Database query failed: ${error.stack}`);
+}
+```
+
+## Reporting Security Issues
+
+Found a security vulnerability? Please report it responsibly:
+
+1. **DO NOT** create public GitHub issues for security vulnerabilities
+2. Email: dev@neus.network
+3. Include:
+   - Description of the vulnerability
+   - Steps to reproduce
+   - Potential impact
+   - Suggested fix (if applicable)
+
+## Security Updates
+
+Monitor security updates:
+- GitHub Security Advisories: https://github.com/neus/network/security
+- NPM Audit: Run `npm audit` regularly
+- Email updates: dev@neus.network
+
+## Compliance
+
+The NEUS Network is designed for:
+- GDPR compliance (no PII storage by default)
+- Cryptographic proof integrity
+- Decentralized trust model
+
+However, verifier implementations must ensure their own compliance based on data handled.
+
+---
+
+*Version: 1.0.0*