@beclab/olaresid 0.1.12 → 0.2.0

package/examples/olares-id-format.ts

@@ -1,197 +0,0 @@
-/**
- * Example: Testing Olares ID Format Support
- *
- * This example demonstrates the new Olares ID format support.
- * Olares ID uses @ instead of the first dot, making it look like an email address.
- *
- * Format conversion:
- *   - Standard domain: alice.example.com
- *   - Olares ID format: alice@example.com
- *
- * Both formats should work identically in the SDK and CLI.
- */
-
-import OlaresID from '../src/index';
-import { normalizeToDomain, normalizeToOlaresId } from '../src/utils/olares-id';
-
-async function main() {
-	console.log('='.repeat(80));
-	console.log('Testing Olares ID Format Support');
-	console.log('='.repeat(80));
-
-	// Test 1: Utility Functions
-	console.log('\n📝 Test 1: Olares ID Utility Functions');
-	console.log('-'.repeat(80));
-
-	const testCases = [
-		{ input: 'alice@example.com', expected: 'alice.example.com' },
-		{ input: 'bob@sub.example.com', expected: 'bob.sub.example.com' },
-		{ input: 'charlie.example.com', expected: 'charlie.example.com' },
-		{ input: 'user@olares.com', expected: 'user.olares.com' }
-	];
-
-	console.log('Testing normalizeToDomain():');
-	for (const test of testCases) {
-		const result = normalizeToDomain(test.input);
-		const status = result === test.expected ? '✅' : '❌';
-		console.log(
-			`  ${status} normalizeToDomain('${test.input}') => '${result}' (expected: '${test.expected}')`
-		);
-	}
-
-	console.log('\nTesting normalizeToOlaresId():');
-	const domainToOlaresIdTests = [
-		{ input: 'alice.example.com', expected: 'alice@example.com' },
-		{ input: 'bob.sub.example.com', expected: 'bob@sub.example.com' }
-	];
-
-	for (const test of domainToOlaresIdTests) {
-		const result = normalizeToOlaresId(test.input);
-		const status = result === test.expected ? '✅' : '❌';
-		console.log(
-			`  ${status} normalizeToOlaresId('${test.input}') => '${result}' (expected: '${test.expected}')`
-		);
-	}
-
-	// Test 2: SDK with Olares ID Format
-	console.log('\n🔧 Test 2: SDK with Olares ID Format');
-	console.log('-'.repeat(80));
-
-	const didConsole = OlaresID.createTestnet();
-
-	// Use a real test domain (1.com is a common test domain on testnet)
-	const testDomainStandard = '1.com';
-	const testDomainOlaresId = '1@com'; // Olares ID format
-
-	console.log('\nTesting with standard domain format:', testDomainStandard);
-	try {
-		const domainStandard = didConsole.domain(testDomainStandard);
-		const metaStandard = await domainStandard.getMetaInfo();
-		console.log('✅ Standard format works:');
-		console.log('  Name:', metaStandard.name);
-		console.log('  DID:', metaStandard.did);
-		console.log('  Owner:', await domainStandard.getOwner());
-	} catch (error) {
-		console.error('❌ Standard format failed:', error);
-	}
-
-	console.log('\nTesting with Olares ID format:', testDomainOlaresId);
-	try {
-		const domainOlaresId = didConsole.domain(testDomainOlaresId);
-		const metaOlaresId = await domainOlaresId.getMetaInfo();
-		console.log('✅ Olares ID format works:');
-		console.log('  Name:', metaOlaresId.name);
-		console.log('  DID:', metaOlaresId.did);
-		console.log('  Owner:', await domainOlaresId.getOwner());
-	} catch (error) {
-		console.error('❌ Olares ID format failed:', error);
-	}
-
-	// Test 3: Verify Both Formats Return Same Data
-	console.log('\n🔍 Test 3: Verify Both Formats Return Same Data');
-	console.log('-'.repeat(80));
-
-	try {
-		const domainStandard = didConsole.domain(testDomainStandard);
-		const domainOlaresId = didConsole.domain(testDomainOlaresId);
-
-		const [metaStandard, metaOlaresId] = await Promise.all([
-			domainStandard.getMetaInfo(),
-			domainOlaresId.getMetaInfo()
-		]);
-
-		const ownerStandard = await domainStandard.getOwner();
-		const ownerOlaresId = await domainOlaresId.getOwner();
-
-		console.log('Comparing results:');
-		console.log(
-			`  Name match: ${
-				metaStandard.name === metaOlaresId.name ? '✅' : '❌'
-			} (${metaStandard.name} vs ${metaOlaresId.name})`
-		);
-		console.log(
-			`  DID match: ${
-				metaStandard.did === metaOlaresId.did ? '✅' : '❌'
-			}`
-		);
-		console.log(
-			`  Owner match: ${
-				ownerStandard === ownerOlaresId ? '✅' : '❌'
-			} (${ownerStandard} vs ${ownerOlaresId})`
-		);
-		console.log(
-			`  TokenId match: ${
-				domainStandard.getTokenId() === domainOlaresId.getTokenId()
-					? '✅'
-					: '❌'
-			}`
-		);
-	} catch (error) {
-		console.error('❌ Comparison failed:', error);
-	}
-
-	// Test 4: Multi-level Domain Support
-	console.log('\n🌳 Test 4: Multi-level Domain Support');
-	console.log('-'.repeat(80));
-
-	const multiLevelTests = [
-		{ standard: 'alice.example.com', olaresId: 'alice@example.com' },
-		{ standard: 'bob.sub.example.com', olaresId: 'bob@sub.example.com' },
-		{
-			standard: 'user.deep.nested.domain.com',
-			olaresId: 'user@deep.nested.domain.com'
-		}
-	];
-
-	for (const test of multiLevelTests) {
-		const normalized = normalizeToDomain(test.olaresId);
-		const matches = normalized === test.standard;
-		console.log(
-			`  ${matches ? '✅' : '❌'} ${
-				test.olaresId
-			} => ${normalized} (expected: ${test.standard})`
-		);
-	}
-
-	// Test 5: Edge Cases
-	console.log('\n⚠️  Test 5: Edge Cases');
-	console.log('-'.repeat(80));
-
-	const edgeCases = [
-		{ input: '', description: 'Empty string' },
-		{ input: 'nodot', description: 'No dot or @' },
-		{
-			input: 'multiple@at@signs.com',
-			description: 'Multiple @ signs (only first is converted)'
-		},
-		{ input: '.startswithdot', description: 'Starts with dot' },
-		{ input: '@startswithat', description: 'Starts with @' }
-	];
-
-	for (const test of edgeCases) {
-		try {
-			const result = normalizeToDomain(test.input);
-			console.log(
-				`  ℹ️  ${test.description}: '${test.input}' => '${result}'`
-			);
-		} catch (error) {
-			console.log(`  ℹ️  ${test.description}: Error - ${error}`);
-		}
-	}
-
-	console.log('\n' + '='.repeat(80));
-	console.log('✅ All Olares ID format tests completed!');
-	console.log('='.repeat(80));
-	console.log('\n💡 Key Takeaways:');
-	console.log(
-		'  • Both standard domain and Olares ID formats work identically'
-	);
-	console.log(
-		'  • Use alice@example.com instead of alice.example.com for a more intuitive format'
-	);
-	console.log('  • The conversion happens automatically in the SDK and CLI');
-	console.log('  • Only the first dot/@ is affected by the conversion');
-	console.log('='.repeat(80));
-}
-
-main().catch(console.error);

package/examples/tag-builder.ts

@@ -1,235 +0,0 @@
-/**
- * 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');

package/examples/tag-nested-tuple.ts

@@ -1,190 +0,0 @@
-import OlaresID from '../src/index';
-import { TagTypeBuilder } from '../src/utils/tag-type-builder';
-
-// Helper function to wait for blockchain indexing
-async function waitForIndexing(seconds: number = 3) {
-	console.log(`⏳ Waiting ${seconds} seconds for blockchain indexing...`);
-	await new Promise((resolve) => setTimeout(resolve, seconds * 1000));
-}
-
-/**
- * Example: Nested Tuple Tag Operations
- * Demonstrates automatic object-to-array conversion for nested tuples
- */
-
-async function main() {
-	const domainName = process.argv[2];
-	if (!domainName) {
-		console.error(
-			'Usage: npx ts-node examples/tag-nested-tuple.ts <domain-name>'
-		);
-		process.exit(1);
-	}
-
-	const privateKeyOrMnemonic = process.env.PRIVATE_KEY_OR_MNEMONIC;
-	if (!privateKeyOrMnemonic) {
-		console.error(
-			'Error: PRIVATE_KEY_OR_MNEMONIC environment variable is required'
-		);
-		process.exit(1);
-	}
-
-	console.log('🚀 Nested Tuple Tag Example\n');
-	console.log(`Domain: ${domainName}\n`);
-
-	// Initialize
-	const olaresId = OlaresID.createTestnet();
-	await olaresId.setSigner(privateKeyOrMnemonic);
-	const domain = olaresId.domain(domainName);
-	const tagCtx = domain.tag();
-	const signerAddress = await olaresId.signer!.getAddress();
-
-	// ========================================
-	// Part 1: Define Nested Tuple Type
-	// ========================================
-	console.log('='.repeat(60));
-	console.log('Part 1: Define Nested Tuple Type');
-	console.log('='.repeat(60));
-
-	const profileType = TagTypeBuilder.tuple({
-		name: TagTypeBuilder.string(),
-		details: TagTypeBuilder.tuple({
-			age: TagTypeBuilder.uint8(),
-			verified: TagTypeBuilder.bool()
-		}),
-		contact: TagTypeBuilder.tuple({
-			email: TagTypeBuilder.string(),
-			phone: TagTypeBuilder.string()
-		})
-	});
-
-	try {
-		await tagCtx.defineTag('profile', profileType);
-		console.log('✅ Defined "profile" nested tuple tag\n');
-	} catch (error: any) {
-		if (error.message.includes('already been defined')) {
-			console.log('⚠️  "profile" tag already defined, skipping...\n');
-		} else {
-			throw error;
-		}
-	}
-
-	// Set tagger
-	await domain.setTagger('profile', signerAddress);
-	console.log(`✅ Set tagger for "profile" to ${signerAddress}\n`);
-
-	// ========================================
-	// Part 2: Set Nested Tuple using Object
-	// ========================================
-	console.log('='.repeat(60));
-	console.log('Part 2: Set Nested Tuple (Object Notation)');
-	console.log('='.repeat(60));
-
-	const profileValue = {
-		name: 'Alice Johnson',
-		details: {
-			age: 30,
-			verified: true
-		},
-		contact: {
-			email: 'alice@example.com',
-			phone: '+1-555-0123'
-		}
-	};
-
-	console.log('📝 Setting nested tuple with object notation:');
-	console.log(JSON.stringify(profileValue, null, 2));
-
-	await tagCtx.setTag(domainName, 'profile', profileValue);
-	console.log('\n✅ Nested tuple set successfully!\n');
-	await waitForIndexing(3);
-
-	// ========================================
-	// Part 3: Get and Display Nested Tuple
-	// ========================================
-	console.log('='.repeat(60));
-	console.log('Part 3: Read Nested Tuple');
-	console.log('='.repeat(60));
-
-	const profile = await tagCtx.getTag(domainName, 'profile');
-	console.log('📖 Retrieved profile (raw array):');
-	console.log(
-		JSON.stringify(profile, (_, v) =>
-			typeof v === 'bigint' ? v.toString() : v
-		)
-	);
-
-	console.log('\n📖 Retrieved profile (parsed):');
-	console.log(`   name: ${profile[0]}`);
-	console.log(`   details.age: ${profile[1][0]}`);
-	console.log(`   details.verified: ${profile[1][1]}`);
-	console.log(`   contact.email: ${profile[2][0]}`);
-	console.log(`   contact.phone: ${profile[2][1]}\n`);
-
-	// ========================================
-	// Part 4: Update Nested Field
-	// ========================================
-	console.log('='.repeat(60));
-	console.log('Part 4: Update Nested Field');
-	console.log('='.repeat(60));
-
-	console.log('🔄 Updating details.age from 30 to 31...\n');
-
-	const updatedProfile = {
-		name: profile[0],
-		details: {
-			age: 31, // Updated
-			verified: profile[1][1]
-		},
-		contact: {
-			email: profile[2][0],
-			phone: profile[2][1]
-		}
-	};
-
-	await tagCtx.setTag(domainName, 'profile', updatedProfile);
-	console.log('✅ Updated nested field\n');
-	await waitForIndexing(3);
-
-	// Verify update
-	const updatedProfileRead = await tagCtx.getTag(domainName, 'profile');
-	console.log('📖 Verified update:');
-	console.log(
-		`   details.age: ${updatedProfileRead[1][0]} (was 30, now 31)\n`
-	);
-
-	// ========================================
-	// Part 5: Array Notation (Still Supported)
-	// ========================================
-	console.log('='.repeat(60));
-	console.log('Part 5: Array Notation (Alternative)');
-	console.log('='.repeat(60));
-
-	console.log('📝 Setting with array notation (for comparison):\n');
-
-	await tagCtx.setTag(domainName, 'profile', [
-		'Bob Smith', // name
-		[25, false], // details: {age: 25, verified: false}
-		['bob@example.com', '+1-555-9999'] // contact: {email, phone}
-	]);
-
-	console.log('✅ Array notation also works!\n');
-	await waitForIndexing(3);
-
-	const profileArray = await tagCtx.getTag(domainName, 'profile');
-	console.log('📖 Retrieved (set via array notation):');
-	console.log(`   name: ${profileArray[0]}`);
-	console.log(`   details.age: ${profileArray[1][0]}`);
-	console.log(`   details.verified: ${profileArray[1][1]}\n`);
-
-	console.log('='.repeat(60));
-	console.log('✅ All nested tuple operations completed!');
-	console.log('='.repeat(60));
-	console.log('\n💡 Key Takeaways:');
-	console.log('   • Objects are automatically converted to arrays');
-	console.log('   • Nested tuples work seamlessly');
-	console.log('   • No need to provide field names manually');
-	console.log('   • Array notation is still supported for flexibility\n');
-}
-
-main().catch(console.error);