@beclab/olaresid 0.1.1 → 0.1.3

package/examples/quasar-demo/src/router/index.ts

@@ -0,0 +1,25 @@
+import { route } from 'quasar/wrappers';
+import {
+	createMemoryHistory,
+	createRouter,
+	createWebHashHistory,
+	createWebHistory
+} from 'vue-router';
+
+import routes from './routes';
+
+export default route(function (/* { store, ssrContext } */) {
+	const createHistory = process.env.SERVER
+		? createMemoryHistory
+		: process.env.VUE_ROUTER_MODE === 'history'
+		? createWebHistory
+		: createWebHashHistory;
+
+	const Router = createRouter({
+		scrollBehavior: () => ({ left: 0, top: 0 }),
+		routes,
+		history: createHistory(process.env.VUE_ROUTER_BASE)
+	});
+
+	return Router;
+});

package/examples/quasar-demo/src/router/routes.ts

@@ -0,0 +1,11 @@
+import { RouteRecordRaw } from 'vue-router';
+
+const routes: RouteRecordRaw[] = [
+	{
+		path: '/',
+		component: () => import('layouts/MainLayout.vue'),
+		children: [{ path: '', component: () => import('pages/IndexPage.vue') }]
+	}
+];
+
+export default routes;

package/examples/quasar-demo/tsconfig.json

@@ -0,0 +1,28 @@
+{
+    "compilerOptions": {
+        "target": "ES2019",
+        "module": "ES2020",
+        "moduleResolution": "node",
+        "lib": ["ES2019", "DOM", "DOM.Iterable"],
+        "jsx": "preserve",
+        "strict": true,
+        "esModuleInterop": true,
+        "skipLibCheck": true,
+        "forceConsistentCasingInFileNames": true,
+        "resolveJsonModule": true,
+        "isolatedModules": true,
+        "baseUrl": ".",
+        "paths": {
+            "src/*": ["src/*"],
+            "app/*": ["*"],
+            "components/*": ["src/components/*"],
+            "layouts/*": ["src/layouts/*"],
+            "pages/*": ["src/pages/*"],
+            "assets/*": ["src/assets/*"],
+            "boot/*": ["src/boot/*"]
+        },
+        "types": ["node"]
+    },
+    "include": ["src/**/*.ts", "src/**/*.tsx", "src/**/*.vue"],
+    "exclude": ["node_modules"]
+}

package/examples/register-subdomain.ts

@@ -0,0 +1,152 @@
+/**
+ * Example: Register a subdomain using mnemonic-derived keys
+ *
+ * This example demonstrates how to:
+ * 1. Connect to the network with a wallet
+ * 2. Initialize OlaresID
+ * 3. Generate a mnemonic for the subdomain
+ * 4. Register the subdomain
+ */
+
+import OlaresID, { generateMnemonic } from '../src/index';
+
+async function main() {
+	console.log('🔐 Subdomain Registration Example\n');
+	console.log('='.repeat(60));
+
+	// ============================================================================
+	// Step 1: Setup
+	// ============================================================================
+	console.log('\n📝 Step 1: Setup Network and Wallet');
+	console.log('-'.repeat(60));
+
+	// Check for required environment variables
+	if (!process.env.PRIVATE_KEY_OR_MNEMONIC) {
+		console.error(
+			'❌ Error: PRIVATE_KEY_OR_MNEMONIC environment variable is required'
+		);
+		console.log('\nUsage:');
+		console.log('  export PRIVATE_KEY_OR_MNEMONIC=0x... (private key)');
+		console.log('  # Or');
+		console.log(
+			'  export PRIVATE_KEY_OR_MNEMONIC="your twelve words..." (mnemonic)'
+		);
+		console.log('  npx ts-node examples/register-subdomain-example.ts\n');
+		process.exit(1);
+	}
+
+	// ============================================================================
+	// Step 2: Initialize OlaresID
+	// ============================================================================
+	console.log('\n📝 Step 2: Initialize OlaresID');
+	console.log('-'.repeat(60));
+
+	const olaresId = OlaresID.createTestnet();
+	await olaresId.setSigner(process.env.PRIVATE_KEY_OR_MNEMONIC);
+
+	console.log('✅ OlaresID initialized for OP Sepolia Testnet');
+
+	// ============================================================================
+	// Step 3: Get Parent Domain
+	// ============================================================================
+	console.log('\n📝 Step 3: Get Parent Domain Information');
+	console.log('-'.repeat(60));
+
+	// Replace with your actual parent domain
+	const PARENT_DOMAIN = process.env.PARENT_DOMAIN || 'tw7613781.olares.com';
+	const parentDomain = olaresId.domain(PARENT_DOMAIN);
+
+	console.log(`📋 Parent domain: ${PARENT_DOMAIN}`);
+
+	try {
+		const parentInfo = await parentDomain.getMetaInfo();
+		console.log('✅ Parent domain found:');
+		console.log(`   - ID: ${parentInfo.id}`);
+		console.log(`   - DID: ${parentInfo.did}`);
+		console.log(`   - Note: ${parentInfo.note}`);
+		console.log(`   - Allow Subdomain: ${parentInfo.allowSubdomain}`);
+	} catch (error: any) {
+		console.error(
+			`❌ Error: Parent domain "${PARENT_DOMAIN}" not found or not accessible`
+		);
+		console.error(`   ${error.message}`);
+		process.exit(1);
+	}
+
+	// ============================================================================
+	// Step 4: Generate Mnemonic for Subdomain
+	// ============================================================================
+	console.log('\n📝 Step 4: Generate Mnemonic for Subdomain');
+	console.log('-'.repeat(60));
+
+	const mnemonic = generateMnemonic(12);
+	console.log('✅ Generated 12-word mnemonic:');
+	console.log(`   ${mnemonic}`);
+	console.log(
+		'\n⚠️  IMPORTANT: Save this mnemonic securely! It controls the subdomain.'
+	);
+
+	// ============================================================================
+	// Step 5: Register Subdomain
+	// ============================================================================
+	console.log('\n📝 Step 5: Register Subdomain');
+	console.log('-'.repeat(60));
+
+	const SUBDOMAIN_LABEL = process.env.SUBDOMAIN || 'example-child';
+	console.log(`📋 Subdomain label: ${SUBDOMAIN_LABEL}`);
+	console.log(`📋 Full domain will be: ${SUBDOMAIN_LABEL}.${PARENT_DOMAIN}`);
+
+	console.log('\n⏳ Submitting transaction...');
+
+	try {
+		const result = await parentDomain.registerSubdomain(
+			SUBDOMAIN_LABEL,
+			mnemonic
+		);
+
+		if (result.success) {
+			console.log('\n✅ Subdomain registered successfully!\n');
+			console.log('='.repeat(60));
+			console.log('Registration Details:');
+			console.log('='.repeat(60));
+			console.log(`Subdomain label:    ${result.data.subdomain}`);
+			console.log(`Full domain name:   ${result.data.fullDomainName}`);
+			console.log(`Owner address:      ${result.data.owner}`);
+			console.log(`DID:                ${result.data.did}`);
+			console.log(`Transaction hash:   ${result.transactionHash}`);
+			console.log(
+				`Gas used:           ${result.gasUsed?.toString() || 'N/A'}`
+			);
+			console.log(`Block number:       ${result.blockNumber || 'N/A'}`);
+			console.log('='.repeat(60));
+
+			console.log('\n🔗 View on block explorer:');
+			console.log(
+				`   https://sepolia-optimism.etherscan.io/tx/${result.transactionHash}`
+			);
+		} else {
+			console.error('\n❌ Subdomain registration failed!');
+			console.error(`   Error: ${result.error}`);
+			process.exit(1);
+		}
+	} catch (error: any) {
+		console.error('\n❌ Unexpected error during registration:');
+		console.error(`   ${error.message}`);
+		if (error.stack) {
+			console.error('\nStack trace:');
+			console.error(error.stack);
+		}
+		process.exit(1);
+	}
+
+	// ============================================================================
+	// Done
+	// ============================================================================
+	console.log('\n✅ Example completed successfully!\n');
+}
+
+// Run the example
+main().catch((error) => {
+	console.error('Fatal error:', error);
+	process.exit(1);
+});

package/examples/rsa-keypair.ts

@@ -0,0 +1,148 @@
+import OlaresID, { createRsaKeyPair, pemToDer, derToPem } from '../src/index';
+
+async function main() {
+	console.log('='.repeat(60));
+	console.log('Testing RSA Key Pair Generation and Conversion');
+	console.log('='.repeat(60));
+
+	// Test 1: Create RSA key pair
+	console.log('\n🔑 Test 1: createRsaKeyPair()');
+	console.log('-'.repeat(60));
+	try {
+		const keyPair = await createRsaKeyPair();
+		console.log('✅ Successfully generated RSA key pair');
+		console.log('\n📄 Public Key (PEM):');
+		console.log(keyPair.rsaPublicKey);
+		console.log('\n📄 Private Key (PEM):');
+		console.log(keyPair.rsaPrivateKey);
+
+		// Test 2: Convert PEM to DER
+		console.log('\n🔄 Test 2: pemToDer()');
+		console.log('-'.repeat(60));
+		const derHex = pemToDer(keyPair.rsaPublicKey);
+		console.log('✅ Successfully converted PEM to DER hex');
+		console.log('DER Hex:');
+		console.log(derHex);
+
+		// Test 2.5: Convert DER back to PEM
+		console.log('\n🔄 Test 2.5: derToPem()');
+		console.log('-'.repeat(60));
+		const pemFromDer = derToPem(derHex);
+		console.log('✅ Successfully converted DER hex back to PEM');
+		console.log(pemFromDer);
+
+		// Verify round-trip conversion
+		const originalPemNormalized = keyPair.rsaPublicKey
+			.replace(/\s/g, '')
+			.replace(/-----BEGIN.*?-----/g, '')
+			.replace(/-----END.*?-----/g, '');
+		const convertedPemNormalized = pemFromDer
+			.replace(/\s/g, '')
+			.replace(/-----BEGIN.*?-----/g, '')
+			.replace(/-----END.*?-----/g, '');
+
+		if (originalPemNormalized === convertedPemNormalized) {
+			console.log('✅ Round-trip conversion successful!');
+		} else {
+			console.log('⚠️  Round-trip conversion mismatch');
+		}
+
+		// Test 3: Set RSA public key using PEM format
+		if (process.env.PRIVATE_KEY_OR_MNEMONIC) {
+			console.log('\n📝 Test 3: setRSAPublicKey() with PEM format');
+			console.log('-'.repeat(60));
+
+			const didConsole = OlaresID.createTestnet();
+			await didConsole.setSigner(process.env.PRIVATE_KEY_OR_MNEMONIC);
+
+			const testDomain = '1.com';
+			const domain = didConsole.domain(testDomain);
+
+			// Set using PEM format (will be automatically converted to DER)
+			const result = await domain.setRSAPublicKey(keyPair.rsaPublicKey);
+
+			if (result.success) {
+				console.log('✅ Success:');
+				console.log('  Transaction Hash:', result.transactionHash);
+				console.log('  Gas Used:', result.gasUsed?.toString());
+
+				// Wait for the blockchain to index the data
+				console.log('⏳ Waiting for blockchain to index data...');
+				await new Promise((resolve) => setTimeout(resolve, 5000));
+			} else {
+				console.log('❌ Failed:', result.error);
+			}
+
+			// Verify the key was set
+			console.log('\n🔍 Test 4: Verify RSA public key');
+			console.log('-'.repeat(60));
+			const storedKey = await domain.getRSAPublicKey();
+			if (storedKey) {
+				console.log('✅ RSA Public Key found on chain (PEM format):');
+				console.log(storedKey);
+
+				// Compare with our original key
+				const originalNormalized = keyPair.rsaPublicKey
+					.replace(/\s/g, '')
+					.replace(/-----BEGIN.*?-----/g, '')
+					.replace(/-----END.*?-----/g, '');
+				const storedNormalized = storedKey
+					.replace(/\s/g, '')
+					.replace(/-----BEGIN.*?-----/g, '')
+					.replace(/-----END.*?-----/g, '');
+
+				if (storedNormalized === originalNormalized) {
+					console.log('✅ Stored key matches our original PEM key!');
+				} else {
+					console.log('⚠️  Stored key differs from original');
+				}
+			} else {
+				console.log('❌ No RSA Public Key found');
+			}
+
+			// Test 5: Remove RSA public key
+			console.log('\n🗑️  Test 5: removeRSAPublicKey()');
+			console.log('-'.repeat(60));
+			const removeResult = await domain.removeRSAPublicKey();
+
+			if (removeResult.success) {
+				console.log('✅ Success:');
+				console.log(
+					'  Transaction Hash:',
+					removeResult.transactionHash
+				);
+				console.log('  Gas Used:', removeResult.gasUsed?.toString());
+
+				// Wait for the blockchain to index the data
+				console.log('⏳ Waiting for blockchain to index data...');
+				await new Promise((resolve) => setTimeout(resolve, 5000));
+			} else {
+				console.log('❌ Failed:', removeResult.error);
+			}
+
+			// Test 6: Verify the key was removed
+			console.log('\n🔍 Test 6: Verify RSA public key after removal');
+			console.log('-'.repeat(60));
+			const removedKey = await domain.getRSAPublicKey();
+			if (removedKey) {
+				console.log('❌ RSA Public Key still exists:', removedKey);
+			} else {
+				console.log('✅ RSA Public Key successfully removed');
+			}
+
+			didConsole.clearSigner();
+		} else {
+			console.log(
+				'\n⚠️  Skipping blockchain tests (no PRIVATE_KEY_OR_MNEMONIC provided)'
+			);
+		}
+	} catch (error) {
+		console.error('❌ Failed:', error);
+	}
+
+	console.log('\n' + '='.repeat(60));
+	console.log('✅ All tests completed!');
+	console.log('='.repeat(60));
+}
+
+main().catch(console.error);

package/examples/tag-builder.ts

@@ -0,0 +1,235 @@
+/**
+ * TagTypeBuilder Example
+ *
+ * This example demonstrates how to use TagTypeBuilder to:
+ * - Create various Tag types offline (no contract calls)
+ * - See the generated ABI type bytes
+ * - Understand the encoding rules
+ *
+ * This is purely informational - no blockchain interaction required.
+ *
+ * Run:
+ * npx ts-node examples/tag-builder.ts
+ */
+
+import { TagTypeBuilder } from '../src/index';
+
+console.log('\n' + '='.repeat(70));
+console.log('TagTypeBuilder - Offline ABI Type Encoding Demo');
+console.log('='.repeat(70) + '\n');
+
+// ========================================
+// 1. Basic Types
+// ========================================
+console.log('📦 Part 1: Basic Types');
+console.log('-'.repeat(70));
+
+const stringType = TagTypeBuilder.string();
+console.log(`string        → 0x${stringType.getTypeBytes()}`);
+
+const addressType = TagTypeBuilder.address();
+console.log(`address       → 0x${addressType.getTypeBytes()}`);
+
+const boolType = TagTypeBuilder.bool();
+console.log(`bool          → 0x${boolType.getTypeBytes()}`);
+
+const uint8Type = TagTypeBuilder.uint8();
+console.log(`uint8         → 0x${uint8Type.getTypeBytes()}`);
+
+const uint256Type = TagTypeBuilder.uint256();
+console.log(`uint256       → 0x${uint256Type.getTypeBytes()}`);
+
+const bytes32Type = TagTypeBuilder.bytes32();
+console.log(`bytes32       → 0x${bytes32Type.getTypeBytes()}`);
+
+const bytesType = TagTypeBuilder.bytes();
+console.log(`bytes         → 0x${bytesType.getTypeBytes()}`);
+
+console.log();
+
+// ========================================
+// 2. Array Types
+// ========================================
+console.log('📦 Part 2: Array Types (Dynamic)');
+console.log('-'.repeat(70));
+
+const addressArrayType = TagTypeBuilder.addressArray();
+console.log(`address[]     → 0x${addressArrayType.getTypeBytes()}`);
+console.log(`              = 0x04 (array) + 0x07 (address)`);
+
+const stringArrayType = TagTypeBuilder.stringArray();
+console.log(`string[]      → 0x${stringArrayType.getTypeBytes()}`);
+console.log(`              = 0x04 (array) + 0x03 (string)`);
+
+const uint256ArrayType = TagTypeBuilder.uint256Array();
+console.log(`uint256[]     → 0x${uint256ArrayType.getTypeBytes()}`);
+console.log(`              = 0x04 (array) + 0x0120 (uint256)`);
+
+// Nested array
+const nestedArrayType = TagTypeBuilder.array(TagTypeBuilder.addressArray());
+console.log(`address[][]   → 0x${nestedArrayType.getTypeBytes()}`);
+console.log(`              = 0x04 (array) + 0x0407 (address[])`);
+
+console.log();
+
+// ========================================
+// 3. Fixed-Length Array Types
+// ========================================
+console.log('📦 Part 3: Fixed-Length Arrays');
+console.log('-'.repeat(70));
+
+const fixedArray5 = TagTypeBuilder.fixedArray(TagTypeBuilder.address(), 5);
+console.log(`address[5]    → 0x${fixedArray5.getTypeBytes()}`);
+console.log(
+	`              = 0x05 (fixed array) + 0x0005 (length 5) + 0x07 (address)`
+);
+
+const fixedArray10 = TagTypeBuilder.fixedArray(TagTypeBuilder.uint8(), 10);
+console.log(`uint8[10]     → 0x${fixedArray10.getTypeBytes()}`);
+console.log(
+	`              = 0x05 (fixed array) + 0x000A (length 10) + 0x0101 (uint8)`
+);
+
+console.log();
+
+// ========================================
+// 4. Tuple Types (Struct)
+// ========================================
+console.log('📦 Part 4: Tuple Types (Struct)');
+console.log('-'.repeat(70));
+
+// Simple tuple
+const userType = TagTypeBuilder.tuple({
+	name: TagTypeBuilder.string(),
+	age: TagTypeBuilder.uint8()
+});
+console.log(`tuple(string name, uint8 age)`);
+console.log(`              → 0x${userType.getTypeBytes()}`);
+console.log(
+	`              = 0x06 (tuple) + 0x0002 (2 fields) + 0x03 (string) + 0x0101 (uint8)`
+);
+console.log(`   Field names: ${JSON.stringify(userType.getFieldNames())}`);
+
+console.log();
+
+// Complex tuple
+const profileType = TagTypeBuilder.tuple({
+	username: TagTypeBuilder.string(),
+	age: TagTypeBuilder.uint8(),
+	wallets: TagTypeBuilder.addressArray(),
+	verified: TagTypeBuilder.bool()
+});
+console.log(
+	`tuple(string username, uint8 age, address[] wallets, bool verified)`
+);
+console.log(`              → 0x${profileType.getTypeBytes()}`);
+console.log(`              = 0x06 (tuple)`);
+console.log(`                + 0x0004 (4 fields)`);
+console.log(`                + 0x03 (string)`);
+console.log(`                + 0x0101 (uint8)`);
+console.log(`                + 0x0407 (address[])`);
+console.log(`                + 0x02 (bool)`);
+console.log(`   Field names: ${JSON.stringify(profileType.getFieldNames())}`);
+
+console.log();
+
+// ========================================
+// 5. Nested Tuple Types
+// ========================================
+console.log('📦 Part 5: Nested Tuple Types');
+console.log('-'.repeat(70));
+
+const addressBookType = TagTypeBuilder.tuple({
+	owner: TagTypeBuilder.tuple({
+		name: TagTypeBuilder.string(),
+		wallet: TagTypeBuilder.address()
+	}),
+	contacts: TagTypeBuilder.array(
+		TagTypeBuilder.tuple({
+			name: TagTypeBuilder.string(),
+			wallet: TagTypeBuilder.address()
+		})
+	)
+});
+
+console.log(`Complex nested tuple:`);
+console.log(`              → 0x${addressBookType.getTypeBytes()}`);
+console.log(
+	`   Field names: ${JSON.stringify(
+		addressBookType.getFieldNames(),
+		null,
+		2
+	)}`
+);
+
+console.log();
+
+// ========================================
+// 6. Array of Tuples
+// ========================================
+console.log('📦 Part 6: Array of Tuples');
+console.log('-'.repeat(70));
+
+const authAddressType = TagTypeBuilder.array(
+	TagTypeBuilder.tuple({
+		algorithm: TagTypeBuilder.uint8(),
+		addr: TagTypeBuilder.address()
+	})
+);
+
+console.log(`tuple(uint8 algorithm, address addr)[]`);
+console.log(`              → 0x${authAddressType.getTypeBytes()}`);
+console.log(`              = 0x04 (array)`);
+console.log(`                + 0x06 (tuple)`);
+console.log(`                + 0x0002 (2 fields)`);
+console.log(`                + 0x0101 (uint8)`);
+console.log(`                + 0x07 (address)`);
+console.log(
+	`   Field names: ${JSON.stringify(authAddressType.getFieldNames())}`
+);
+
+console.log();
+
+// ========================================
+// 7. Encoding Rules Summary
+// ========================================
+console.log('📦 Part 7: Encoding Rules Summary');
+console.log('-'.repeat(70));
+console.log(`
+Type Code | Type        | Encoding
+--------- | ----------- | ----------------------------------------
+0x00      | int         | 0x00 + size (size = bits / 8)
+0x01      | uint        | 0x01 + size (size = bits / 8)
+0x02      | bool        | 0x02
+0x03      | string      | 0x03
+0x04      | array       | 0x04 + elementType
+0x05      | fixedArray  | 0x05 + length (2 bytes) + elementType
+0x06      | tuple       | 0x06 + fieldCount (2 bytes) + fieldTypes...
+0x07      | address     | 0x07
+0x08      | fixedBytes  | 0x08 + size (1-32)
+0x09      | bytes       | 0x09
+
+Examples:
+  uint8   = 0x0101     (0x01 for uint + 0x01 for 8 bits / 8)
+  uint256 = 0x0120     (0x01 for uint + 0x20 for 256 bits / 8 = 32)
+  bytes32 = 0x0820     (0x08 for fixed bytes + 0x20 for 32 bytes)
+
+Array Examples:
+  address[]    = 0x0407           (0x04 + 0x07)
+  address[][]  = 0x040407         (0x04 + 0x0407)
+  address[5]   = 0x05000507       (0x05 + 0x0005 + 0x07)
+
+Tuple Examples:
+  tuple(string, uint8) = 0x06000203 0101
+                         ^^  ^^^^  ^^ ^^^^
+                         |   |     |  uint8
+                         |   |     string
+                         |   2 fields
+                         tuple
+`);
+
+console.log('='.repeat(70));
+console.log('✅ TagTypeBuilder Demo Completed');
+console.log('='.repeat(70) + '\n');
+console.log('💡 Key Takeaway: All ABI type bytes are calculated OFFLINE!');
+console.log('   No blockchain calls needed for type definition.\n');