Sobriquet Vooodooo Integration

Vooodooo integration for Sobriquet - blockchain domain name analysis and registration

Features

• Domain name analysis across multiple blockchains
• Domain registration on supported chains
• Unified API for managing blockchain domains
• Pluggable architecture for extending functionality
• Knowledge system for sharing domain patterns

Installation

npm install @vooodooo/sobriquet

Usage

Basic Usage

import { SobriquetVooodooo } from "@vooodooo/sobriquet";

const vooodooo = new SobriquetVooodooo();

// Initialize the client
await vooodooo.initialize();

// Analyze a domain
const analysisResults = await vooodooo.analyzeDomain("example-domain");
console.log(analysisResults);

// Register a domain
const registrationResult = await vooodooo.registerDomain(
  "my-domain",
  "ethereum",
  {
    dryRun: true,
  }
);
console.log(registrationResult);

CLI Usage

The package includes a CLI for common operations:

# Analyze a domain
npm run analyze example-domain

# Register a domain
npm run register example-domain ethereum --dry-run

# Run any command directly
npm run cli command [options]

Plugin System

Vooodooo uses a plugin architecture that allows extending its functionality in several ways:

• Domain Analyzers - Evaluate domain quality, availability, and pricing
• Domain Registrars - Register domains on specific blockchains
• Template Generators - Create domain templates for various use cases
• Knowledge Providers - Contribute to the shared knowledge system

Creating a Plugin

Use the built-in plugin generator to create a new plugin:

npm run create-plugin my-plugin "My Plugin" "A plugin that does something awesome"

This will create a new plugin with the necessary structure in the plugins directory.

For comprehensive documentation on plugin development, see the Plugin Development Guide.

Documentation

• Architecture Overview
• Extension Points
• Knowledge System
• Plugin Development

Examples

The examples directory contains sample code for common use cases:

• Domain Analysis - examples/domain-analysis.js
• Domain Registration - examples/domain-registration.js
• Chain Registration - examples/chain-registration.js
• Premium Domains - examples/premium-domains.js
• TypeScript Example - examples/typescript-example.ts

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for details.

License

MIT