Skip to content

Commit

Permalink
fix: correct typo
Browse files Browse the repository at this point in the history
  • Loading branch information
MdechampG committed Mar 8, 2024
1 parent caec834 commit 963ac7c
Show file tree
Hide file tree
Showing 8 changed files with 31 additions and 29 deletions.
2 changes: 1 addition & 1 deletion docs/academy/part-2/describe-resource.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Now that you know what a DID and a Verifiable Credential are, and what they mean

You're a digital resource provider and you want to share a dataset or a service. First, you need to describe your resource and register it in the Dataverse (i.e. in the Axone protocol).

Here are the 4 steps involved:
Here are the 4 steps involved:

<div style={{ display: "flex", justifyContent: "center" }}>
<img src="/img/content/academy/describe-resource-1.webp" alt="Steps to describe a resource in the Dataverse" style={{ maxHeight: "340px" }}></img>
Expand Down
2 changes: 1 addition & 1 deletion docs/academy/part-2/describe-zone.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A [zone](https://docs.okp4.network/whitepaper/solution#zone-overview) is a conce

All the workflows initiated within the Axone protocol must be defined in the context of a specific Zone. When the workflow is submitted, the protocol will check if all rules of the zone and of the engaged resources are respected and will apply the business model of the zone.

Let's see how to describe and register a zone in the Axone Protocol. Here are the four steps involved:
Let's see how to describe and register a zone in the Axone Protocol. Here are the four steps involved:

<div style={{ display: "flex", justifyContent: "center" }}>
<img src="/img/content/academy/describe-resource-1.webp" alt="Steps to describe a resource in the Dataverse" style={{ maxHeight: "340px" }}></img>
Expand Down
2 changes: 1 addition & 1 deletion docs/academy/part-2/resource-governance.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ In the protocol, governance structures are made up of two key elements:
<img src="/img/content/academy/resource-governance-1.webp" alt="Governance elements for Resources in Axone Protocol" style={{ maxHeight: "340px" }}></img>
</div>

Here are the five steps to create the governance of a resource in the Dataverse:
Here are the five steps to create the governance of a resource in the Dataverse:

<div style={{ display: "flex", justifyContent: "center" }}>
<img src="/img/content/academy/resource-governance-2.webp" alt="Steps to create a resource's governance" style={{ maxHeight: "340px" }}></img>
Expand Down
6 changes: 3 additions & 3 deletions docs/academy/part-2/verifiable-claims.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ import * as quiz from './verifiable-claims-quiz.json';

<i>Reading time: {readingTime} min</i>

**Verifiable Credentials** are a key concept in the world of digital identity, particularly in decentralized identity systems. A Verifiable Credential is a form of digital evidence that attests an information or a characteristic about a person, organization, or object. A trusted entity that issues these credentials is called the **Issuer**.
**Verifiable Credentials** are a key concept in the world of digital identity, particularly in decentralized identity systems. A Verifiable Credential is a form of digital evidence that attests to information or a characteristic about a person, organization, or object. A trusted entity that issues these credentials is called the **Issuer**.

## Verifiable Credentials and claims

Commonly, a credential is a certificate, proof, or qualification of competence or authority issued to an entity (corporate or individual) by a third party with the authority or presumed competence to do so. It may be proof of authority, status, rights, privileges, or others, usually written. For example, a diploma is a credential issued to a graduate by a university. The diploma includes information such as the graduate's name, the issue date, the degree obtained, and the field of study. It also bears the signature of those in charge of the institution, such as the rector or dean. The diploma serves as official proof that the individual has completed a certain level of education.

A credential may contain several claims. For example, a diploma contains the claims "I have a degree in Biology" and "My diploma was issued on 19/06/2023".

**Verifiable Credentials** (VCs) can be digitally authenticated, meaning that the credential receiver can verify its origin and integrity without contacting the issuer directly. The holder of the Verifiable Credential can control how and to whom their information is shared. For example, a person holds the VC for his degree, the Issuer of which is the university where he studied. When this person applies for a job, they can share this VC with the company to provide proof of their background and skills. The company does not need to contact the university to verify the authenticity of the VC.
**Verifiable Credentials** (VCs) can be digitally authenticated, meaning that the credential receiver can verify its origin and integrity without contacting the issuer directly. The holder of the Verifiable Credential can control how and to whom information is shared. For example, a person holds the VC for his degree, the Issuer of which is the university where he studied. When this person applies for a job, they can share this VC with the company to provide proof of their background and skills. The company does not need to contact the university to verify the authenticity of the VC.

In the [W3C standard](https://www.w3.org/TR/vc-data-model/), a credential is a set of one or more **claims** made by the same entity. Credentials include an identifier and metadata describing the credential's properties, such as the issuer, the expiry date and time, a representative image, a public key to use for verification purposes, the revocation mechanism, and so on. The issuer might sign the metadata. A verifiable credential is a set of tamper-evident claims and metadata that cryptographically prove who issued it.

Expand Down Expand Up @@ -59,7 +59,7 @@ The [Axone ontology](https://docs.okp4.network/academy/resources#ontology-how-it
It's important to note that the existence of a resource is conditional on the presence of at least one relevant claim. In other words, although the universe of potential resources is infinite, a resource only becomes concrete and tangible when a corresponding claim is established.

:::note
This notion is analogous to that of crypto-currency wallets. Although all addresses theoretically exist, they only take on practical significance (such as indicating a balance) when participating in a transaction.
This notion is analogous to that of cryptocurrency wallets. Although all addresses theoretically exist, they only take on practical significance (such as indicating a balance) when participating in a transaction.
:::

Verifiable Credentials obey schemas that describe a particular aspect of a resource. Certain VCs apply depending on the nature of the resource. A VC describing an entity or organization does not apply to the same resource as a VC describing a dataset. This is why VCs are organized in schemas.
Expand Down
14 changes: 7 additions & 7 deletions docs/academy/part-2/zone-governance.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ We recommend you first read the [Technical documentation of Governance](https://

Zone Rules establish the boundaries of a specific area in the Dataverse, termed a Zone, within which governance is enforced. Each Zone is governed by its unique set of Rules tailored to its particular function or purpose.

The materialization of a zone in the dataverse requires the creation of a Governance VP. According to a principle of self-determination, the zone itself must generate this VP, i.e., the issuer and the zone have the same identity.
The materialization of a zone in the Dataverse requires the creation of a Governance VP. According to a principle of self-determination, the zone itself must generate this VP, i.e., the issuer and the zone have the same identity.

The impact of this VP of Governance is constitutional. Its implementation transfers authority from the issuer (i.e., the zone) to an autonomous governance system associated with the zone. This system is equipped with its own mechanisms and manages changes and revisions relating to the governance of the zone in an independent, self-regulated, and decentralized manner.

Expand All @@ -27,7 +27,7 @@ In the protocol, governance structures are made up of two key elements:
<img src="/img/content/academy/zone-governance-1.webp" alt="Governance elements for Zone in Axone Protocol" style={{ maxHeight: "340px" }}></img>
</div>

Here are the five steps to create a zone governance in the Dataverse:
Here are the five steps to create a zone governance in the Dataverse:

<div style={{ display: "flex", justifyContent: "center" }}>
<img src="/img/content/academy/zone-governance-2.webp" alt="Steps to create a zone's governance" style={{ maxHeight: "340px" }}></img>
Expand All @@ -54,7 +54,7 @@ Governance rules of the Collaborative AI zone:
|-------------|----------------|------------------------------------------------------|
| Chapter | 1 | Collaborative AI zone |
| Section | 1.1 | Zone Governance |
| Sub-section | 1.1.1 | Governers |
| Sub-section | 1.1.1 | Governors |
| Article | 1.1.1.1 | Conditions to amend the rules |
| Paragraph | 1.1.1.1.1 | Governance can only be amended by the identity `did:key:zQ3shs7auhJSmVJpiUbQWco6bxxEhSqWnVEPvaBHBRvBKw6Q3`|

Expand Down Expand Up @@ -218,9 +218,9 @@ The Governance VP is a specific type of VP that details the governance rules app
- Association with Codified Governance: It associates the resource with a URI that refers to the codified governance rules (governance as code). This URI points to a program in Prolog language that explicitly defines the governance rules.
- Textual Description of the Rules: In addition to the link to the codified rules, the VP provides a structured and hierarchical textual explanation of the governance rules, as set out in the Prolog program.

This bimodal approach not only guarantees the clarity and accessibility of the governance rules for human users but also ensures their direct and functional on-chain integration. The VP of Governance therefore plays a crucial role in clarifying and implementing governance guidelines for resources within the Axone dataverse.
This bimodal approach not only guarantees the clarity and accessibility of the governance rules for human users but also ensures their direct and functional on-chain integration. The VP of Governance therefore plays a crucial role in clarifying and implementing governance guidelines for resources within the Axone Dataverse.

Governance VPs play an essential role in the dataverse, applying universally to various categories of resources, such as [datasets, services](/academy/part-2/resource-governance), and zones.
Governance VPs play an essential role in the Dataverse, applying universally to various categories of resources, such as [datasets, services](/academy/part-2/resource-governance), and zones.

Instantiate the template [credential-governance-text](https://github.com/okp4/ontology/blob/main/src/example/governance/collab-AI-zone-governance.jsonld).

Expand Down Expand Up @@ -297,7 +297,7 @@ Note that as you interact with the Axone blockchain, you must pay fees in $AXON
With:
- `CONTRACT_ADDR` : dataverse contract address (always the same)
- `CONTRACT_ADDR` : Dataverse contract address (always the same)
- `MY_ADDR` : registrant okp4 address
- `vc.nq` : name of the verifiable credential signed in RDF in N-Quads format
Expand All @@ -308,5 +308,5 @@ The command returns the hash of the transaction. You can find more details of th
## Delete a zone in the Dataverse
The deletion of a zone in the Axone Dataverse is carried out exclusively by deleting the governance VP associated with this zone. This deletion action can only be initiated following the rules established by the governance of the zone.
It is essential to stress the primacy of governance in this context. Suppose the established governance system does not designate a specific authority empowered to revoke the VP of Governance (or, more generally, the conditions that must be satisfied for its realization). In that case, the result is that the zone remains irrevocably integrated into the dataverse. This provision highlights the crucial importance of a systematic design of governance rules, particularly concerning the mechanisms for modifying and revoking zones.
It is essential to stress the primacy of governance in this context. Suppose the established governance system does not designate a specific authority empowered to revoke the VP of Governance (or, more generally, the conditions that must be satisfied for its realization). In that case, the result is that the zone remains irrevocably integrated into the Dataverse. This provision highlights the crucial importance of a systematic design of governance rules, particularly concerning the mechanisms for modifying and revoking zones.
22 changes: 11 additions & 11 deletions docs/faq/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ sidebar_position: 1

Axone is the first settlement layer for off-chain workflows using shared resources. In other words, it is an open-source and public protocol that enables the sharing and orchestration of digital off-chain resources (datasets, algorithms, storage, computation resources…) while enforcing their associated governance rules.

### How does Axone work in a few words ?
### How does Axone work in a few words?

Axone is a custom blockchain facilitating digital resource sharing with auditability and adherence to consent rules. It establishes trust through decentralization, offers a flexible incentive system, and reduces digital ecosystem fragmentation by enabling 'Anything as a Service'. The protocol introduces Zones for resource orchestration and utilizes an on-chain ontology for standardized interpretation of diverse elements. With smart contracts and modules, it is the orchestrator of workflows running on shared resources for any applications.

### What makes Axone a protocol ?
### What makes Axone a protocol?

Axone serves as a set of rules and conventions that facilitate interoperability and coordination among diverse digital resources, systems, and entities. It allows for the establishment of rules, consents, and conditions for resource sharing, yet it doesn't focus on any specific use case. These are agnostic, trustless primitives that form the foundation for numerous other application and layer that can be built on top. Axone stands as the base settlement layer for off-chain workflows involving shared resources

Expand Down Expand Up @@ -49,15 +49,15 @@ Axone's goal is to be the leading decentralized data intermediary by enabling a

## General Questions

### What is a Zone ?
### What is a Zone?

A Zone is a conceptual framework defined by a set of rules, within which the recognized digital resources are compatible with these rules, considering the associated consents. Thus, the recognition of resources within a Zone relies on the dynamic evaluation of the conformity of the rules and consents of the resources.

The primary objective of Zones is to facilitate the coordination of heterogeneous systems and resources. Zones aim to integrate all systems, both on-chain and off-chain.

More information [here](https://docs.okp4.network/whitepaper/solution#protocol-overview)

### What types of resources can be shared ?
### What types of resources can be shared?

As an agnostic infrastructure, Axone has no limitations on the types of resources it can be referenced, it opens doors to a wide range of possibilities.

Expand All @@ -79,7 +79,7 @@ The absence of a direct link between Zones and resources allows for significant

In summary, the distinction between Zones and resources enables the Axone ecosystem to be dynamic, scalable, and capable of accommodating a variety of rules and conditions for each Zone, thereby fostering value creation and free interaction among participants and digital resources.

### What is the Dataverse ?
### What is the Dataverse?

The Dataverse is an ever-expanding universe comprised of all the digital resources, such as datasets, and digital services such as infrastructure services, processing services or any other digital service referenced in the Axone Blockchain.
All resources, services and Zones are found within the same universe, the Dataverse. The on-chain Ontology is the semantic representation of the Dataverse.
Expand Down Expand Up @@ -108,11 +108,11 @@ Dedicated documentation [here](https://docs.okp4.network/whitepaper/solution#ont

And deep-dive article [here](https://blog.okp4.network/okp4-knowledge-sharing-through-ontology-driven-dataverse-a-new-approach-to-knowledge-description-f9b81d4484c8)

### Who can share and consume these resources ?
### Who can share and consume these resources?

Anyone can share resources and define associated consent rules. As an open and public protocol, everyone has access to the resources referenced in the protocol and can use them, according to the access rights and conditions defined in the rules of the concerned Zone and resources.

### Is Axone private by design ?
### Is Axone private by design?

No, Axone is agnostic by design. It provides the flexibility for privacy-focused applications to be built on top of it. This means that privacy-enhancing features and services can be implemented within Axone, allowing developers to tailor privacy settings to their specific needs and use cases. It's a versatile foundation that can support a wide range of applications, whether they prioritize privacy or other aspects of data sharing and orchestration.

Expand Down Expand Up @@ -248,7 +248,7 @@ The Logic module is designed to primarily address logical queries based on facts

## Token

### What is the utility of the $AXON token ?
### What is the utility of the $AXON token?

The $AXON is the fee token of the Axone blockchain, it is required to submit transactions to the network of validators.

Expand Down Expand Up @@ -285,7 +285,7 @@ Axone is a sandbox for human coordination experiments in the off-chain world. Yo

## Utilization

### Can you describe how the data transfer works ?
### Can you describe how the data transfer works?

First, let me remind that the data is off-chain, only the data's metadata (its description) is on-chain and integrated in the ontology.

Expand All @@ -302,13 +302,13 @@ To sum it up, from the moment a consumer places a request to the final reporting

Not necessarily, there are several ways to process data without transferring it to the end consumer, or even to third-party service providers: Trusted Execution Environments (TEE), Multi-Party Computation (MPC), Edge computing, and more. Implementations of these technologies are digital services that can be used within workflows. Once again, it's up to the provider to choose the consent rules related to the resources they want to share and especially how they can be processed.

### Axone is the set of instructions that could be used for data pipelines. How can I build a Data Platform with Axone ?
### Axone is the set of instructions that could be used for data pipelines. How can I build a Data Platform with Axone?

The answer depends on the Design Pattern you opt for: batching, micro batching, streaming, hybrid, or any other. Depending on the most suitable choice for the datasets you intend to collect and process, you'll need to pick specific tools. For instance, within the Apache series, options such as AIRFLOW, SPARK, STORM, KAFKA, FLINK, or even other open-source or proprietary solutions could come into play.

Both the team and community will reference implementations of these tools alongside the necessary connectors for communication. This will facilitate the seamless construction of your own process by interconnecting services that best align with your use case.

### Can you illustrate it ?
### Can you illustrate it?

For example, when you want to extract data from nodes for analytical purposes, a batching collection approach every 6-12 hours might be ideal, followed by data processing and storage in a Data Warehouse solution. Conversely, when extracting data from nodes for monitoring purposes, a streaming or micro batching process might be more suitable, with the data being stored in a Data Lake solution.

Expand Down
Loading

0 comments on commit 963ac7c

Please sign in to comment.