Skip to content

Commit 1703817

Browse files
committed
Merge branch 'main' into develop
2 parents 2671d18 + 99792f6 commit 1703817

File tree

3 files changed

+94
-26
lines changed

3 files changed

+94
-26
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,6 @@ Ixo has 8 custom cosmos modules which help to reach the Ixo goals and missions:
3333

3434
## 🤝 How to contribute
3535

36-
If you are interested in contributing to the ixo Blockchain, you can start by reviewing the documentation on our [website](https://docs.ixo.foundation/ixo/developers). There are many opportunities to get involved, such as contributing code or participating in community discussions.
36+
If you are interested in contributing to the ixo Blockchain, there are many opportunities to get involved, such as contributing code or participating in community discussions. See the [How to Contribute section](https://github.com/ixofoundation#how-to-contribute) of our documentation for more details.
3737

38-
Our community is passionate about using blockchain technology to create positive impacts in the world. We believe in the power of collaboration and innovation to drive change, and we welcome anyone who shares our vision to join us on Discord or Telegram
38+
Our community is passionate about using blockchain technology to create positive impacts in the world. We believe in the power of collaboration and innovation to drive change, and we welcome anyone who shares our vision to join us on Discord or Telegram.

x/entity/spec/01_concepts.md

Lines changed: 39 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,60 @@
1-
# Entity Module
2-
3-
The `Entity` module is a pivotal component of our blockchain system, facilitating the unified management of both non-fungible tokens (NFTs) and their associated Interchain Identifiers (IIDs). By seamlessly intertwining NFTs with IIDs, the `Entity` module establishes a new paradigm for decentralized asset management, bolstered by the credibility and dependability of DID Documents.
1+
# Entity Module: Digital Twin Domains in the Spatial Web
42

53
## Overview
64

7-
When an `Entity` is created on the blockchain, a trifecta of operations is set into motion:
5+
The Entity Module introduces a revolutionary approach to digital identity and asset representation in the Spatial Web. When an `Entity` is created, it establishes a sovereign digital twin domain through a trifecta of operations:
86

9-
1. An IID Document is birthed through the `iid` module, cementing the foundational identity and associated metadata of the entity.
10-
2. An NFT is minted using the CW721 smart contract, capturing the unique and immutable essence of the entity in tokenized form.
11-
3. A dedicated `Entity` data structure is etched into the KV store. This is not merely a reflection of the IID Document; it captures supplementary metadata exclusive to the `Entity`, enhancing its depth and versatility.
7+
1. An Interoperable Identifier (IID) Document is generated via the `iid` module, establishing the foundational decentralized identity and associated metadata of the entity.
8+
2. A Non-Fungible Token (NFT) is minted using the [CW721](https://github.com/CosmWasm/cw-nfts/blob/main/packages/cw721/README.md) smart contract, capturing the unique and immutable essence of the entity in tokenized form.
9+
3. A dedicated `Entity` data structure is recorded in the key-value (KV) store, encompassing supplementary metadata exclusive to the `Entity`.
1210

13-
The `id` for all 3 of the different data stored above is deterministically determined on-chain on Entity creation.
11+
The `id` for all three data components is deterministically generated on-chain during Entity creation, ensuring consistency and traceability.
1412

1513
## Key Components
1614

1715
### Entity Data Structure
1816

19-
Stored within the KV store, the `Entity` data structure houses metadata that isn't contained within the IID Document. It's instrumental in furnishing a holistic view of the `Entity`, encapsulating both inherent and appended attributes. This data provides richer context, driving interoperability and comprehensive understanding across platforms and applications.
17+
The `Entity` data structure, stored within the KV store, serves as a comprehensive digital twin domain representation, including:
18+
19+
- **Controllers**: Governing authorities of the domain.
20+
- **Verifiable Credentials**: Cryptographic proofs for verifying attributes, bassed on [W3C standards](https://w3c.github.io/vc-overview/)
21+
- **Linked Resources**: Digital or physical assets associated with the domain.
22+
- **Accorded Rights**: Permissions and capabilities available within the Spatial Web.
23+
- **Services**: Functionalities provided by the entity, including third-party web services that interface with the domain.
24+
- **Linked Claims**: Assertions about or made by the entity.
25+
- **Linked Entities**: Relationships with other domains in the Spatial Web graph.
26+
27+
### Entity Accounts
2028

21-
#### Entity Accounts
29+
Entity Accounts are Cosmos Module Accounts uniquely associated with and controlled by an Entity Owner. Key features include:
2230

23-
An Entity Account is a Cosmos Module Account that can only be created and controlled by an Entity Owner. An Entity may have any number of Entity Accounts. Each Entity Account has a unique name. For instance “Savings”. The account address is derived from this name and the DID of the Entity. The Entity Owner may authorise any other account to perform transactions for an Entity Account, using Authz. When ownership of an Entity is transferred, the new owner gains control of the Entity Accounts. All residual balances in an Entity Account get transferred together with the Entity NFT when ownership is transferred.
31+
- **Multiple Accounts**: Each Entity may have multiple accounts, each with a unique name (e.g., 'Savings').
32+
- **Account Address Generation**: Account addresses are derived from the account name and Entity's DID.
33+
- **Authz Delegation**: Authz-based delegation allows transaction permissions to be granted to other accounts, using the [Authz Module](https://docs.cosmos.network/main/modules/authz/)
34+
- **Ownership Transfer**: Control and balances are automatically transferred when Entity ownership changes.
35+
- **Default Admin Account**: A default 'admin' account is created when the Entity is first established.
2436

25-
On Entity creation a default Entity Account gets created with the name `admin`.
37+
### NFT Representation
2638

27-
### NFT Creation
39+
The minted NFT via the CW721 smart contract embodies the distinct essence of each `Entity`, offering:
2840

29-
The minting of an NFT via the CW721 smart contract reaffirms the distinctiveness of each `Entity`. This tokenized representation not only encapsulates the essence of the entity but also offers a myriad of possibilities in terms of trade, ownership verification, and utilization in decentralized applications.
41+
- **Tokenized representation** for trade and ownership verification.
42+
- **Utilization in decentralized applications** within the Spatial Web.
43+
- **Immutable link** to the entity's digital twin domain.
3044

31-
### IID Document Creation
45+
### IID Document
3246

33-
The automatic generation of an IID Document ensures that every `Entity` is backed by a standardized, robust, and decentralized identity mechanism. This identity is enriched with crucial metadata and, being compliant with W3C's DID specifications, offers global compatibility and recognition.
47+
The automatically generated IID Document ensures each `Entity` has a standardized, robust, and decentralized identity, featuring:
3448

35-
### Advantages
49+
- **Compliance with W3C Specifications**: Each IID complies with W3C's [DID Core](https://www.w3.org/TR/did-core/) specification for global compatibility.
50+
- **Metadata Enrichment**: Enrichment with crucial metadata provides a comprehensive representation of the identity.
3651

37-
- **Unified Management:** The `Entity` module simplifies the intricacies of managing decentralized assets by unifying IID creation, NFT minting, and metadata storage.
38-
- **Enhanced Metadata:** By preserving additional metadata in the `Entity` data structure, a comprehensive and nuanced understanding of each entity is achieved.
39-
- **Interoperability:** Rooted in globally recognized standards, `Entities` foster seamless interactions across various decentralized platforms and applications.
52+
## Advantages
4053

41-
- **Decentralization and Security:** The tandem of IID Documents and NFTs ensures a decentralized, tamper-proof, and transparent representation of entities.
54+
- **Sovereign Digital Twin Domains**: Each entity represents a self-sovereign domain in the Spatial Web, with full control over its digital representation and associated assets.
55+
- **Enhanced Interoperability**: Rooted in globally recognized standards, `Entities` foster seamless interactions across various decentralized platforms and applications in the Spatial Web ecosystem.
56+
- **Comprehensive Metadata Management**: The unified approach to metadata storage provides a nuanced and rich understanding of each entity's characteristics and relationships.
57+
- **Decentralization and Security**: The combination of IID Documents and NFTs ensures a decentralized, tamper-proof, and transparent representation of entities within the Spatial Web.
58+
- **Flexible Governance**: Entity Accounts and delegation mechanisms allow for sophisticated control and management of digital assets and interactions.
4259

43-
For a deeper dive into the foundational principles of IIDs, consult the [`iid` module documentation](/x/iid/spec/README.md). For a comprehensive understanding of NFTs and the CW721 standard, refer to the [official CW721 documentation](https://github.com/CosmWasm/cw-nfts/blob/main/packages/cw721/README.md) which follows the [eip721 standard](https://eips.ethereum.org/EIPS/eip-721).
60+
This Entity Module serves as a crucial building block in the Spatial Web, enabling interconnected digital twin domains, graph-based relationships between entities, and decentralized governance models.

x/entity/spec/README.md

Lines changed: 53 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,59 @@
11
# Entity module specification
22

3-
This document specifies the entity module, a custom Ixo Cosmos SDK module.
3+
# IXO Entity Module: Digital Twin Domains in the Spatial Web
44

5-
The Entity Module introduces a holistic approach to NFT-backed identities, bridging the gap between decentralized identifiers and tangible assets. Upon entity creation, a symbiotic relationship forms between an IID Document, an NFT, and the Entity's metadata. Further enriched with the concept of Entity Accounts, this module ensures a seamless transition of ownership, while offering a robust framework for entities to operate within a decentralized landscape.
5+
## Overview
6+
7+
The IXO **Entity** Module provides a cutting-edge approach to digital identity and real-world asset representation within the Spatial Web. By enabling sovereign digital twin domains, backed by NFTs and managed by actors with decentralized identifiers (DIDs), this module creates a network of interconnected nodes within the Spatial Web. These entities form a robust framework for decentralized operations, facilitating interactions that have tangible impacts in the real world.
8+
9+
## Key Features
10+
11+
### Sovereign Digital Twin Domains
12+
13+
Each entity represents a distinct, sovereign domain within the Spatial Web, including:
14+
15+
- **Controllers**: Authorities responsible for governing the domain.
16+
- **Verifiable Credentials**: Cryptographic proofs for verifying attributes.
17+
- **Linked Resources**: Digital or physical assets associated with the domain.
18+
- **Accorded Rights**: Permissions and capabilities available within the Spatial Web.
19+
- **Services**: Functionalities provided by the entity, including third-party web services that interface with the domain.
20+
- **Linked Claims**: Assertions about or made by the entity.
21+
- **Linked Entities**: Relationships with other domains in the Spatial Web.
22+
- **Entity Accounts**: Any number of blockchain Accounts that may be used for different purposes.
23+
24+
### NFT-Backed Domains
25+
26+
- **NFT Integration**: Domains are represented as NFTs, integrated seamlessly with DIDs for enhanced security.
27+
- **Tangible Assets**: Digital twin domains can be owned, transferred, financed, or used as collateral, similar to traditional assets.
28+
29+
### Interchain Identifier (IID) Document
30+
31+
- **Comprehensive Representation**: IIDs provide a complete representation of the identity domain.
32+
- **Interoperability**: Supports interactions across multiple blockchain networks.
33+
34+
### Entity Metadata
35+
36+
- **Customizable Metadata**: Rich and customizable metadata allows detailed descriptions of each digital twin domain, enabling better discovery and context.
37+
38+
### Entity Accounts
39+
40+
- **Financial Management**: Dedicated accounts for managing resources, payments, and interactions between entities.
41+
42+
## Spatial Web Integration
43+
44+
The IXO Entity Module is a foundational element of the Spatial Web, enabling:
45+
46+
- **Interconnected Digital Twin Domains**: Digital entities that operate autonomously and are linked through the Spatial Web.
47+
- **Graph-Based Relationships**: Establishing connections and relationships between entities, forming a robust network.
48+
- **Decentralized Governance**: Sovereign entities enable new models of governance and ownership.
49+
50+
## Technical Implementation
51+
52+
The Entity Module is built using the IXO Cosmos SDK, leveraging blockchain technology for:
53+
54+
- **Immutability**: Ensuring that entity records are tamper-proof and reliable.
55+
- **Decentralized Control**: Giving entities complete control over their domains without centralized authorities.
56+
- **Interoperability**: Facilitating seamless interactions with other networks within the Cosmos ecosystem.
657

758
## Contents
859

0 commit comments

Comments
 (0)