Entity Domains - IXO Docs Hub

Entity Domains provide a standardized way to register and manage digital twins of real-world entities on the IXO blockchain, with built-in support for decentralized identity, verifiable credentials, and relationship management.

Overview

Decentralized Identity Management

Verifiable Ownership and Control

Service Endpoint Configuration

Resource and Claim Linking

Relationship Mapping

Economic Account Management

Domain Properties

Core Properties

interface DomainProperties {
  did: string;              // Decentralized identifier
  controller: string[];     // Domain controllers
  type: string;            // Entity type
  status: number;          // Domain status
  credentials: VerifiableCredential[]; // Domain credentials
}

Service Configuration

interface Service {
  id: string;              // Service identifier
  type: string;           // Service type
  serviceEndpoint: string; // Endpoint URL
  description?: string;    // Optional description
}

Linked Resources

interface LinkedResource {
  id: string;             // Resource identifier
  type: string;          // Resource type
  path: string;          // Resource location
  proof?: string;        // Optional cryptographic proof
}

Accorded Rights

Linked Claims

Linked Entities

Domain Accounts

Domain Registration

Create Domain Document
- Specify entity type and class
- Define controllers
- Configure services
- Set up linked resources
Submit Registration
- Sign domain creation transaction
- Broadcast to blockchain
- Wait for confirmation
- Verify registration
Configure Properties
- Add verification methods
- Link resources
- Set up services
- Define relationships

Implementation

import { Entity } from '@ixo/client-sdk';

async function createEntityDomain(
  creator: string,
  entityType: string
) {
  const msg = {
    typeUrl: "/ixo.entity.v1beta1.MsgCreateEntity",
    value: {
      creator,
      entityType,
      entityStatus: 1
    }
  };

  return await Entity.broadcast(msg);
}

Domain Management

Add Service

async function addDomainService(
  entityId: string,
  service: Service
) {
  const msg = {
    typeUrl: "/ixo.entity.v1beta1.MsgAddEntityService",
    value: {
      entityId,
      service
    }
  };
  
  return await Entity.broadcast(msg);
}

Link Resource

async function addLinkedResource(
  entityId: string,
  resource: LinkedResource
) {
  const msg = {
    typeUrl: "/ixo.entity.v1beta1.MsgAddEntityResource",
    value: {
      entityId,
      resource
    }
  };
  
  return await Entity.broadcast(msg);
}

Update Status

async function updateEntityStatus(
  entityId: string,
  status: number
) {
  const msg = {
    typeUrl: "/ixo.entity.v1beta1.MsgUpdateEntityStatus",
    value: {
      entityId,
      status
    }
  };
  
  return await Entity.broadcast(msg);
}

Best Practices

Identity Management

Use strong verification methods
Implement key rotation
Maintain controller list
Document access policies

Service Configuration

Validate endpoints
Monitor availability
Update stale endpoints
Document service types

Resource Management

Verify resource integrity
Maintain proof chains
Update broken links
Document dependencies

Security

Implement access control
Validate transactions
Monitor activities
Regular audits

Developer Resources

API Reference

Entity module API documentation

SDK Guide

Client SDK implementation guide

Examples

Implementation examples

GitHub

Entity module source code

For technical support or questions about Entity Domains, join our Developer Community or contact our Developer Relations Team.

On this page

Overview
Domain Properties
Domain Registration
Implementation
Domain Management
Best Practices
Developer Resources

Overview

Decentralized Identity Management

Verifiable Ownership and Control

Service Endpoint Configuration

Resource and Claim Linking

Relationship Mapping

Economic Account Management

Domain Properties

Core Properties

interface DomainProperties {
  did: string;              // Decentralized identifier
  controller: string[];     // Domain controllers
  type: string;            // Entity type
  status: number;          // Domain status
  credentials: VerifiableCredential[]; // Domain credentials
}

Service Configuration

interface Service {
  id: string;              // Service identifier
  type: string;           // Service type
  serviceEndpoint: string; // Endpoint URL
  description?: string;    // Optional description
}

Linked Resources

interface LinkedResource {
  id: string;             // Resource identifier
  type: string;          // Resource type
  path: string;          // Resource location
  proof?: string;        // Optional cryptographic proof
}

Accorded Rights

Linked Claims

Linked Entities

Domain Accounts

Domain Registration

Create Domain Document
- Specify entity type and class
- Define controllers
- Configure services
- Set up linked resources
Submit Registration
- Sign domain creation transaction
- Broadcast to blockchain
- Wait for confirmation
- Verify registration
Configure Properties
- Add verification methods
- Link resources
- Set up services
- Define relationships

Implementation

import { Entity } from '@ixo/client-sdk';

async function createEntityDomain(
  creator: string,
  entityType: string
) {
  const msg = {
    typeUrl: "/ixo.entity.v1beta1.MsgCreateEntity",
    value: {
      creator,
      entityType,
      entityStatus: 1
    }
  };

  return await Entity.broadcast(msg);
}

Domain Management

Add Service

async function addDomainService(
  entityId: string,
  service: Service
) {
  const msg = {
    typeUrl: "/ixo.entity.v1beta1.MsgAddEntityService",
    value: {
      entityId,
      service
    }
  };
  
  return await Entity.broadcast(msg);
}

Link Resource

async function addLinkedResource(
  entityId: string,
  resource: LinkedResource
) {
  const msg = {
    typeUrl: "/ixo.entity.v1beta1.MsgAddEntityResource",
    value: {
      entityId,
      resource
    }
  };
  
  return await Entity.broadcast(msg);
}

Update Status

async function updateEntityStatus(
  entityId: string,
  status: number
) {
  const msg = {
    typeUrl: "/ixo.entity.v1beta1.MsgUpdateEntityStatus",
    value: {
      entityId,
      status
    }
  };
  
  return await Entity.broadcast(msg);
}

Best Practices

Identity Management

Use strong verification methods
Implement key rotation
Maintain controller list
Document access policies

Service Configuration

Validate endpoints
Monitor availability
Update stale endpoints
Document service types

Resource Management

Verify resource integrity
Maintain proof chains
Update broken links
Document dependencies

Security

Implement access control
Validate transactions
Monitor activities
Regular audits

Developer Resources

API Reference

Entity module API documentation

SDK Guide

Client SDK implementation guide

Examples

Implementation examples

GitHub

Entity module source code

For technical support or questions about Entity Domains, join our Developer Community or contact our Developer Relations Team.

On this page

Overview
Domain Properties
Domain Registration
Implementation
Domain Management
Best Practices
Developer Resources

​Overview

​Domain Properties

​Domain Registration

​Implementation

​Domain Management

​Best Practices

Identity Management

Service Configuration

Resource Management

Security

​Developer Resources

API Reference

SDK Guide

Examples

GitHub

​Overview

​Domain Properties

​Domain Registration

​Implementation

​Domain Management

​Best Practices

Identity Management

Service Configuration

Resource Management

Security

​Developer Resources

API Reference

SDK Guide

Examples

GitHub

Overview

Domain Properties

Domain Registration

Implementation

Domain Management

Best Practices

Developer Resources

Overview

Domain Properties

Domain Registration

Implementation

Domain Management

Best Practices

Developer Resources