@beclab/olaresid 0.1.12 → 0.2.0

package/examples/fetch-domains-demo.ts

@@ -0,0 +1,221 @@
+import OlaresID from '../src/index';
+
+/**
+ * Example: Paginated domain fetching with fetchDomains
+ *
+ * This example demonstrates how to use fetchDomains to fetch domains
+ * in controlled batches, useful for:
+ * - Building paginated UIs
+ * - Processing large datasets in chunks
+ * - Implementing infinite scroll
+ * - Memory-efficient data loading
+ *
+ * Run: npx ts-node examples/fetch-domains-demo.ts
+ */
+
+// Configuration
+const USE_TESTNET = true; // Switch to false for mainnet
+
+async function main() {
+	const network = process.env.NETWORK || 'sepolia';
+
+	console.log('🚀 fetchDomains Demo - Paginated Query\n');
+	console.log('='.repeat(80));
+	console.log('📝 Config:');
+	console.log(`  Network: ${network}`);
+	console.log('='.repeat(80));
+	console.log('');
+
+	// Create DID console instance (query contract automatically configured)
+	const didConsole =
+		network === 'mainnet'
+			? OlaresID.createMainnet()
+			: OlaresID.createTestnet();
+
+	// Verify query contract is configured
+	if (!didConsole.queryContractAddress) {
+		console.error(
+			'❌ Error: Query contract address not configured for this network'
+		);
+		process.exit(1);
+	}
+
+	console.log(`📋 Query Contract: ${didConsole.queryContractAddress}\n`);
+
+	// Get total supply first
+	const totalSupply = Number(await didConsole.getTotalSupply());
+
+	console.log(`📊 Total domains: ${totalSupply}\n`);
+
+	// Example 1: Fetch first page
+	console.log('📄 Example 1: Fetch First Page (10 domains)');
+	console.log('-'.repeat(80));
+
+	const pageSize = 10;
+	const startTime1 = Date.now();
+
+	const firstPage = await didConsole.fetchDomains(
+		0,
+		Math.min(pageSize, totalSupply)
+	);
+
+	const elapsed1 = Date.now() - startTime1;
+	console.log(`✅ Fetched ${firstPage.length} domains in ${elapsed1}ms\n`);
+
+	firstPage.forEach((domain, i) => {
+		console.log(`  ${i + 1}. ${domain.name}`);
+		console.log(`     ID: ${domain.id.substring(0, 20)}...`);
+		console.log(`     Owner: ${domain.owner}`);
+		console.log(`     Tags: ${domain.tags.length}, Level: ${domain.level}`);
+	});
+
+	// Example 2: Fetch second page (if exists)
+	if (totalSupply > pageSize) {
+		console.log(`\n📄 Example 2: Fetch Second Page (offset ${pageSize})`);
+		console.log('-'.repeat(80));
+
+		const startTime2 = Date.now();
+
+		const secondPage = await didConsole.fetchDomains(
+			pageSize,
+			Math.min(pageSize, totalSupply - pageSize)
+		);
+
+		const elapsed2 = Date.now() - startTime2;
+		console.log(
+			`✅ Fetched ${secondPage.length} domains in ${elapsed2}ms\n`
+		);
+
+		secondPage.slice(0, 5).forEach((domain, i) => {
+			console.log(
+				`  ${i + 1}. ${domain.name} (${domain.tags.length} tags)`
+			);
+		});
+
+		if (secondPage.length > 5) {
+			console.log(`  ... and ${secondPage.length - 5} more`);
+		}
+	}
+
+	// Example 3: Fetch specific range
+	if (totalSupply > 20) {
+		console.log('\n📄 Example 3: Fetch Specific Range (20-30)');
+		console.log('-'.repeat(80));
+
+		const startTime3 = Date.now();
+
+		const customRange = await didConsole.fetchDomains(
+			20,
+			Math.min(10, totalSupply - 20)
+		);
+
+		const elapsed3 = Date.now() - startTime3;
+		console.log(
+			`✅ Fetched ${customRange.length} domains in ${elapsed3}ms\n`
+		);
+
+		customRange.slice(0, 5).forEach((domain, i) => {
+			console.log(
+				`  ${i + 1}. ${domain.name} (${domain.tags.length} tags)`
+			);
+		});
+	}
+
+	// Example 4: Simulate pagination loop
+	console.log('\n📄 Example 4: Pagination Loop (Fetch All Pages)');
+	console.log('-'.repeat(80));
+
+	const pagesLimit = 3; // Limit to 3 pages for demo
+	let currentOffset = 0;
+	let pageNumber = 1;
+	let allFetchedDomains = [];
+
+	while (currentOffset < totalSupply && pageNumber <= pagesLimit) {
+		const limit = Math.min(pageSize, totalSupply - currentOffset);
+
+		console.log(
+			`\nFetching page ${pageNumber} (offset: ${currentOffset}, limit: ${limit})...`
+		);
+
+		const startTime = Date.now();
+		const pageDomains = await didConsole.fetchDomains(currentOffset, limit);
+		const elapsed = Date.now() - startTime;
+
+		allFetchedDomains.push(...pageDomains);
+
+		console.log(
+			`✅ Page ${pageNumber}: ${pageDomains.length} domains in ${elapsed}ms`
+		);
+		console.log(
+			`   Domains: ${pageDomains
+				.slice(0, 3)
+				.map((d) => d.name)
+				.join(', ')}${pageDomains.length > 3 ? '...' : ''}`
+		);
+
+		currentOffset += pageSize;
+		pageNumber++;
+	}
+
+	console.log(
+		`\n📊 Total fetched across ${pageNumber - 1} pages: ${
+			allFetchedDomains.length
+		} domains`
+	);
+
+	// Example 5: Error handling - invalid parameters
+	console.log('\n⚠️  Example 5: Error Handling');
+	console.log('-'.repeat(80));
+
+	try {
+		await didConsole.fetchDomains(-1, 10);
+	} catch (error) {
+		console.log('✅ Correctly caught error for negative offset:');
+		console.log(`   ${(error as Error).message}`);
+	}
+
+	try {
+		await didConsole.fetchDomains(0, 0);
+	} catch (error) {
+		console.log('✅ Correctly caught error for zero limit:');
+		console.log(`   ${(error as Error).message}`);
+	}
+
+	// Fetch beyond total supply (contract will throw InvalidPagination)
+	console.log('\n✅ Fetching beyond total supply:');
+	try {
+		const emptyResult = await didConsole.fetchDomains(
+			totalSupply + 100,
+			10
+		);
+		console.log(
+			`   Returned ${emptyResult.length} domains (expected 0 or error)`
+		);
+	} catch (error) {
+		console.log(`   ✅ Contract correctly reverted with InvalidPagination`);
+		console.log(
+			`   (This is expected behavior when offset exceeds total supply)`
+		);
+	}
+
+	console.log('\n' + '='.repeat(80));
+	console.log('✅ Demo completed successfully!');
+	console.log('\n💡 Use Cases:');
+	console.log('   - Paginated UI: Load 10-50 domains per page');
+	console.log('   - Infinite scroll: Load next batch on scroll');
+	console.log('   - Memory efficient: Process large datasets in chunks');
+	console.log('   - Background sync: Fetch and process incrementally');
+	console.log('\n💡 Simplified API:');
+	console.log('   - No need to pass queryContractAddress');
+	console.log('   - Automatically configured based on network');
+}
+
+// Run the example
+main().catch((error) => {
+	console.error('\n❌ Error:', error);
+	if (error instanceof Error) {
+		console.error('Message:', error.message);
+		console.error('Stack:', error.stack);
+	}
+	process.exit(1);
+});

package/examples/frontend-demo/index.html

@@ -3,8 +3,8 @@
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <meta name="description" content="DID Gate - Decentralized Identity Service" />
-    <title>DID Gate</title>
+    <meta name="description" content="Olares SDK Demo" />
+    <title>Olares SDK Demo</title>
   </head>
   <body>
     <div id="app"></div>

package/examples/frontend-demo/package-lock.json

@@ -32,7 +32,7 @@
         },
         "../..": {
             "name": "@beclab/olaresid",
-            "version": "0.1.7",
+            "version": "0.2.0",
             "license": "Terminus License",
             "dependencies": {
                 "@solana/web3.js": "^1.87.6",
@@ -48,8 +48,11 @@
                 "did-cli": "dist/cli.js"
             },
             "devDependencies": {
+                "@types/jest": "^30.0.0",
                 "@types/node": "^20.0.0",
                 "@types/varint": "^6.0.3",
+                "jest": "^30.2.0",
+                "ts-jest": "^29.4.6",
                 "ts-node": "^10.9.2",
                 "typescript": "^5.9.3"
             }

package/examples/index.ts

@@ -1,4 +1,4 @@
-import OlaresID, { debug } from '../src/index';
+import OlaresID from '../src/index';
 
 async function main() {
 	const olaresId = OlaresID.createTestnet();
@@ -6,10 +6,8 @@ async function main() {
 	const domain = await olaresId.fetchDomain('tw7613781.olares.com');
 	console.log(domain);
 
-	// Get all domain data (the mainnet has a large amount of data, the testnet has a small amount of data, for testing it is recommended to experience this function in the testnet environment)
-	// await olaresId.fetchAll();
-	// console.log('All Domains:', olaresId.allDomainCache);
-	// console.log('Domain Tree Cache:', olaresId.treesCache);
+	const allDomains = await olaresId.fetchAllFlat();
+	console.log('All Domains:', JSON.stringify(allDomains, null, 2));
 }
 
 main().catch(console.error);

package/jest.config.js

@@ -0,0 +1,25 @@
+module.exports = {
+	preset: 'ts-jest',
+	testEnvironment: 'node',
+	roots: ['<rootDir>/tests'],
+	testMatch: ['**/*.test.ts'],
+	collectCoverageFrom: [
+		'src/**/*.ts',
+		'!src/**/*.d.ts',
+		'!src/test/**',
+		'!src/cli.ts'
+	],
+	coverageDirectory: 'coverage',
+	coverageReporters: ['text', 'lcov', 'html'],
+	moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
+	transform: {
+		'^.+\\.tsx?$': [
+			'ts-jest',
+			{
+				tsconfig: {
+					esModuleInterop: true
+				}
+			}
+		]
+	}
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@beclab/olaresid",
-    "version": "0.1.12",
+    "version": "0.2.0",
     "description": "DID Contract SDK with CLI tool",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -17,7 +17,8 @@
     },
     "scripts": {
         "build": "tsc",
-        "test": "npm run build && node dist/test/did.js",
+        "test:unit": "jest tests/unit",
+        "test:coverage": "jest --coverage",
         "prepublishOnly": "npm run build",
         "example": "ts-node ./examples/index.ts",
         "example:debug": "ts-node ./examples/index.ts --debug",
@@ -48,8 +49,11 @@
     },
     "module": "commonjs",
     "devDependencies": {
+        "@types/jest": "^30.0.0",
         "@types/node": "^20.0.0",
         "@types/varint": "^6.0.3",
+        "jest": "^30.2.0",
+        "ts-jest": "^29.4.6",
         "ts-node": "^10.9.2",
         "typescript": "^5.9.3"
     },