refactor(renaming)!: rebrand from okp4 to axone

axone-protocol · May 14, 2024 · 3dcd870 · 3dcd870
1 parent f15ab03
commit 3dcd870
Show file tree

Hide file tree

Showing 8 changed files with 363 additions and 363 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/README.md b/README.md
@@ -1,18 +1,18 @@
-# 📜 OKP4 Smart Contracts
+# 📜 AXONE Smart Contracts
 
-> [CosmWasm](https://cosmwasm.com) contracts for the [OKP4 network](http://okp4.network).
+> [CosmWasm](https://cosmwasm.com) contracts for the [AXONE network](http://axone.xyz).
 
-[![build](https://img.shields.io/github/actions/workflow/status/okp4/contracts/build.yml?label=build&style=for-the-badge&logo=github)](https://github.com/okp4/contracts/actions/workflows/build.yml)
-[![lint](https://img.shields.io/github/actions/workflow/status/okp4/contracts/lint.yml?label=lint&style=for-the-badge&logo=github)](https://github.com/okp4/contracts/actions/workflows/lint.yml)
-[![test](https://img.shields.io/github/actions/workflow/status/okp4/contracts/test.yml?label=test&style=for-the-badge&logo=github)](https://github.com/okp4/contracts/actions/workflows/test.yml)
-[![coverage](https://img.shields.io/codecov/c/github/okp4/contracts?style=for-the-badge)](https://app.codecov.io/gh/okp4/contracts)
+[![build](https://img.shields.io/github/actions/workflow/status/axone-protocol/contracts/build.yml?label=build&style=for-the-badge&logo=github)](https://github.com/axone-protocol/contracts/actions/workflows/build.yml)
+[![lint](https://img.shields.io/github/actions/workflow/status/axone-protocol/contracts/lint.yml?label=lint&style=for-the-badge&logo=github)](https://github.com/axone-protocol/contracts/actions/workflows/lint.yml)
+[![test](https://img.shields.io/github/actions/workflow/status/axone-protocol/contracts/test.yml?label=test&style=for-the-badge&logo=github)](https://github.com/axone-protocol/contracts/actions/workflows/test.yml)
+[![coverage](https://img.shields.io/codecov/c/github/axone-protocol/contracts?style=for-the-badge)](https://app.codecov.io/gh/axone-protocol/contracts)
 [![conventional commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=for-the-badge&logo=conventionalcommits)](https://conventionalcommits.org)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge)](https://github.com/semantic-release/semantic-release)
 [![license](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg?style=for-the-badge)](https://opensource.org/licenses/BSD-3-Clause)
 
 ## ✨ Smart Contracts
 
-This repository hosts Smart Contracts that are deployed on the [OKP4 network](http://okp4.network). But they are compatible with any
+This repository hosts Smart Contracts that are deployed on the [AXONE network](http://axone.xyz). But they are compatible with any
 [Cosmos blockchains](https://cosmos.network/) that uses the [CosmWasm](https://cosmwasm.com/) framework.
 
 ### 🗄️ Storage oriented Smart Contracts
@@ -23,17 +23,17 @@ This repository hosts Smart Contracts that are deployed on the [OKP4 network](ht
 <table>
   <tr>
     <th rowspan="4">
-      <a href="https://docs.okp4.network/contracts/next/okp4-objectarium"><img align="center" width="350" src="etc/objectarium.webp" alt="objectarium" /></a>
-      <br/><sub><a href="https://docs.okp4.network/contracts/next/okp4-objectarium">→ Tech documentation</a></sub>
+      <a href="https://docs.axone.xyz/contracts/next/axone-objectarium"><img align="center" width="350" src="etc/objectarium.webp" alt="objectarium" /></a>
+      <br/><sub><a href="https://docs.axone.xyz/contracts/next/axone-objectarium">→ Tech documentation</a></sub>
     </th>
   </tr>
   <tr>
     <td>
       <a href="#---mature-stage">
       <img alt="status: mature" src="https://img.shields.io/badge/status-🐥-black?style=for-the-badge" />
       </a>
-      <a href="https://github.com/okp4/contracts/releases" target="_blank">
-      <img alt="version" src="https://img.shields.io/github/v/release/okp4/contracts?style=for-the-badge&logo=github"/>
+      <a href="https://github.com/axone-protocol/contracts/releases" target="_blank">
+      <img alt="version" src="https://img.shields.io/github/v/release/axone-protocol/contracts?style=for-the-badge&logo=github"/>
     </a>
     </td>
   </tr>
@@ -56,17 +56,17 @@ This repository hosts Smart Contracts that are deployed on the [OKP4 network](ht
 <table>
   <tr>
     <th rowspan="4">
-      <a href="https://docs.okp4.network/contracts/next/okp4-cognitarium"><img align="center" width="350" src="etc/cognitarium.webp" alt="cognitarium" /></a>
-      <br/><sub><a href="https://docs.okp4.network/contracts/next/okp4-cognitarium">→ Tech documentation</a></sub>
+      <a href="https://docs.axone.xyz/contracts/next/axone-cognitarium"><img align="center" width="350" src="etc/cognitarium.webp" alt="cognitarium" /></a>
+      <br/><sub><a href="https://docs.axone.xyz/contracts/next/axone-cognitarium">→ Tech documentation</a></sub>
     </th>
   </tr>
     <tr>
     <td>
       <a href="#---intermediate-stage">
       <img alt="status: intermediate" src="https://img.shields.io/badge/status-🐣-black?style=for-the-badge" />
       </a>
-      <a href="https://github.com/okp4/contracts/releases" target="_blank">
-      <img alt="version" src="https://img.shields.io/github/v/release/okp4/contracts?style=for-the-badge&logo=github"/>
+      <a href="https://github.com/axone-protocol/contracts/releases" target="_blank">
+      <img alt="version" src="https://img.shields.io/github/v/release/axone-protocol/contracts?style=for-the-badge&logo=github"/>
     </a>
     </td>
   </tr>
@@ -91,17 +91,17 @@ This repository hosts Smart Contracts that are deployed on the [OKP4 network](ht
 <table>
   <tr>
     <th rowspan="4">
-      <a href="https://docs.okp4.network/contracts/next/okp4-law-stone"><img align="center" width="350" src="etc/law-stone.webp" alt="law-stone" /></a>
-      <br/><sub><a href="https://docs.okp4.network/contracts/next/okp4-law-stone">→ Tech documentation</a></sub>
+      <a href="https://docs.axone.xyz/contracts/next/axone-law-stone"><img align="center" width="350" src="etc/law-stone.webp" alt="law-stone" /></a>
+      <br/><sub><a href="https://docs.axone.xyz/contracts/next/axone-law-stone">→ Tech documentation</a></sub>
     </th>
   </tr>
   <tr>
     <td>
       <a href="#---mature-stage">
       <img alt="status: mature" src="https://img.shields.io/badge/status-🐥-black?style=for-the-badge" />
       </a>
-      <a href="https://github.com/okp4/contracts/releases" target="_blank">
-      <img alt="version" src="https://img.shields.io/github/v/release/okp4/contracts?style=for-the-badge&logo=github"/>
+      <a href="https://github.com/axone-protocol/contracts/releases" target="_blank">
+      <img alt="version" src="https://img.shields.io/github/v/release/axone-protocol/contracts?style=for-the-badge&logo=github"/>
     </a>
     </td>
   </tr>
@@ -128,23 +128,23 @@ This repository hosts Smart Contracts that are deployed on the [OKP4 network](ht
 <table>
   <tr>
     <th rowspan="4">
-      <a href="https://docs.okp4.network/contracts/next/okp4-dataverse"><img align="center" width="350" src="etc/dataverse.webp" alt="dataverse" /></a>
-      <br/><sub><a href="https://docs.okp4.network/contracts/next/okp4-dataverse">→ Tech documentation</a></sub>
+      <a href="https://docs.axone.xyz/contracts/next/axone-dataverse"><img align="center" width="350" src="etc/dataverse.webp" alt="dataverse" /></a>
+      <br/><sub><a href="https://docs.axone.xyz/contracts/next/axone-dataverse">→ Tech documentation</a></sub>
     </th>
   </tr>
   <tr>
     <td>
       <a href="#---genesis-stage">
       <img alt="status: genesis" src="https://img.shields.io/badge/status-💥-black?style=for-the-badge" />
       </a>
-      <a href="https://github.com/okp4/contracts/releases" target="_blank">
-      <img alt="version" src="https://img.shields.io/github/v/release/okp4/contracts?style=for-the-badge&logo=github"/>
+      <a href="https://github.com/axone-protocol/contracts/releases" target="_blank">
+      <img alt="version" src="https://img.shields.io/github/v/release/axone-protocol/contracts?style=for-the-badge&logo=github"/>
     </a>
     </td>
   </tr>
   <tr>
     <td>
-<p>A Smart Contract responsible for overseeing and managing the <a href="https://docs.okp4.network/whitepaper/solution#the-dataverse">Dataverse</a> within the <a href="https://okp4.network">OKP4 network</a>.</p><p>The Dataverse is an ever-expanding universe that encompasses a wide range of Digital Resources, including datasets, data processing algorithms, ML algorithm, storage resources, computational resources, identity management solutions, orchestration engines, oracles, and many other resources recorded on the blockchain.</p>
+<p>A Smart Contract responsible for overseeing and managing the <a href="https://docs.axone.xyz/whitepaper/solution#the-dataverse">Dataverse</a> within the <a href="https://axone.xyz">AXONE network</a>.</p><p>The Dataverse is an ever-expanding universe that encompasses a wide range of Digital Resources, including datasets, data processing algorithms, ML algorithm, storage resources, computational resources, identity management solutions, orchestration engines, oracles, and many other resources recorded on the blockchain.</p>
     </td>
   </tr>
   <tr>
@@ -415,15 +415,15 @@ git commit -am "docs: update generated documentation"
 So you want to contribute? Great! ❤️ We appreciate any help you're willing to give. Don't hesitate to open issues and/or
 submit pull requests.
 
-We believe that collaboration is key to the success of the OKP4 project. Join our Community discussions on the [Community Repository](https://github.com/okp4/community) to:
+We believe that collaboration is key to the success of the AXONE project. Join our Community discussions on the [Community Repository](https://github.com/axone-protocol/community) to:
 
 - Engage in conversations with peers and experts.
-- Share your insights and experiences with OKP4.
+- Share your insights and experiences with AXONE.
 - Learn from others and expand your knowledge of the protocol.
 
-The Community Repository serves as a hub for discussions, questions, and knowledge-sharing related to OKP4. We encourage you to actively participate and contribute to the growth of our community.
+The Community Repository serves as a hub for discussions, questions, and knowledge-sharing related to AXONE. We encourage you to actively participate and contribute to the growth of our community.
 
-Please check out OKP4 health files:
+Please check out AXONE health files:
 
-- [Contributing](https://github.com/okp4/.github/blob/main/CONTRIBUTING.md)
-- [Code of conduct](https://github.com/okp4/.github/blob/main/CODE_OF_CONDUCT.md)
+- [Contributing](https://github.com/axone-protocol/.github/blob/main/CONTRIBUTING.md)
+- [Code of conduct](https://github.com/axone-protocol/.github/blob/main/CODE_OF_CONDUCT.md)
diff --git a/contracts/axone-dataverse/README.md b/contracts/axone-dataverse/README.md
@@ -41,4 +41,4 @@ Claims are submitted in the form of [Verifiable Presentations (VPs)](https://www
 
 ## Dependencies
 
-Given its role and status, this smart contract serves as the primary access point for the OKP4 protocol to manage all on-chain stored resources. To fulfill its tasks, the smart contract relies on other smart contracts within the OKP4 ecosystem. Notably, it uses the `Cognitarium` smart contract for persisting the Dataverse representation in an ontological form and the `Law Stone` smart contract to establish governance rules.
+Given its role and status, this smart contract serves as the primary access point for the AXONE protocol to manage all on-chain stored resources. To fulfill its tasks, the smart contract relies on other smart contracts within the AXONE ecosystem. Notably, it uses the `Cognitarium` smart contract for persisting the Dataverse representation in an ontological form and the `Law Stone` smart contract to establish governance rules.
diff --git a/contracts/axone-law-stone/README.md b/contracts/axone-law-stone/README.md
@@ -2,14 +2,14 @@
 
 ## Overview
 
-The `okp4-law-stone` smart contract aims to provide GaaS (i.e. Governance as a Service) in any [Cosmos blockchains](https://cosmos.network/) using the [CosmWasm](https://cosmwasm.com/) framework and the [Logic](https://docs.okp4.network/modules/next/logic) OKP4 module.
+The `axone-law-stone` smart contract aims to provide GaaS (i.e. Governance as a Service) in any [Cosmos blockchains](https://cosmos.network/) using the [CosmWasm](https://cosmwasm.com/) framework and the [Logic](https://docs.axone.xyz/modules/next/logic) AXONE module.
 
 This contract is built around a Prolog program describing the law by rules and facts. The law stone is immutable, this means it can only be questioned, there are no update mechanisms.
 
-The `okp4-law-stone` responsibility is to guarantee the availability of its rules in order to question them, but not to ensure the rules application.
+The `axone-law-stone` responsibility is to guarantee the availability of its rules in order to question them, but not to ensure the rules application.
 
-To ensure reliability over time, the associated Prolog program is stored and pinned in a `okp4-objectarium` contract. Moreover, all the eventual loaded files must be stored in a `okp4-objectarium` contract as well, allowing the contract to pin them.
+To ensure reliability over time, the associated Prolog program is stored and pinned in a `axone-objectarium` contract. Moreover, all the eventual loaded files must be stored in a `axone-objectarium` contract as well, allowing the contract to pin them.
 
-To be able to free the underlying resources (i.e. objects in `okp4-objectarium`) if not used anymore, the contract admin can break the stone.
+To be able to free the underlying resources (i.e. objects in `axone-objectarium`) if not used anymore, the contract admin can break the stone.
 
-➡️ Checkout the [examples](https://github.com/okp4/contracts/tree/main/contracts/okp4-law-stone/examples/) for usage information.
+➡️ Checkout the [examples](https://github.com/axone-protocol/contracts/tree/main/contracts/axone-law-stone/examples/) for usage information.
diff --git a/contracts/axone-objectarium/README.md b/contracts/axone-objectarium/README.md
@@ -23,17 +23,17 @@ Features like pinning, unpinning, and discarding objects offer a strategic way t
 
 ## Rationale
 
-In a sense, we can consider blockchains built on the [Cosmos L0](https://docs.cosmos.network/main) layer as decentralized databases, and their nature can be shaped and modeled through the smart contracts or modules. Given this, it provides a great opportunity to address the wide range of data management needs. One such important area is the management of unstructured, immutable data, which is written once but accessed frequently — commonly known as object storage. This is the primary focus of `okp4-objectarium`: a specialized smart contract designed to offer a versatile and efficient approach to handling *on-chain*, *unstructured*, *immutable* data in a *decentralized* manner.
+In a sense, we can consider blockchains built on the [Cosmos L0](https://docs.cosmos.network/main) layer as decentralized databases, and their nature can be shaped and modeled through the smart contracts or modules. Given this, it provides a great opportunity to address the wide range of data management needs. One such important area is the management of unstructured, immutable data, which is written once but accessed frequently — commonly known as object storage. This is the primary focus of `axone-objectarium`: a specialized smart contract designed to offer a versatile and efficient approach to handling *on-chain*, *unstructured*, *immutable* data in a *decentralized* manner.
 
 ## Terminology
 
 ### Object
 
-In the context of the `okp4-objectarium` smart contract, an `object` refers to a piece of data stored on the blockchain. It can represent various types of information, such as documents, binary files, or any other digital content. Objects are immutable once stored and are identified by their cryptographic hash, which can be generated using algorithms like MD5 or SHA256. This ensures the integrity and security of the stored data, as any modification to the object would result in a different hash value.
+In the context of the `axone-objectarium` smart contract, an `object` refers to a piece of data stored on the blockchain. It can represent various types of information, such as documents, binary files, or any other digital content. Objects are immutable once stored and are identified by their cryptographic hash, which can be generated using algorithms like MD5 or SHA256. This ensures the integrity and security of the stored data, as any modification to the object would result in a different hash value.
 
 ### Bucket
 
-The smart contract is organized around buckets. A bucket represents a logical container within the `okp4-objectarium` smart contract instance that groups related Objects together. It acts as a storage unit for Objects and provides a context for managing and organizing them. Each bucket has a unique name and is associated with a set of configurations and limits that define its behaviour and characteristics.
+The smart contract is organized around buckets. A bucket represents a logical container within the `axone-objectarium` smart contract instance that groups related Objects together. It acts as a storage unit for Objects and provides a context for managing and organizing them. Each bucket has a unique name and is associated with a set of configurations and limits that define its behaviour and characteristics.
 
 ### Pin
 
@@ -43,9 +43,9 @@ Pin refers to a mechanism that allows users to mark or "pin" specific objects wi
 
 The unstructured nature of the data stored in the chain opens up a plethora of possibilities for decentralized applications that require this type of versatile storage.
 
-### In the OKP4 protocol
+### In the AXONE protocol
 
-The primary function of this smart contract within the OKP4 protocol is to enable the persistence of governance rules, which are encoded in Prolog. These programs are stored in an immutable format within the protocol and can be referenced by their unique identifiers in situations where there is a need to refer to these rules.
+The primary function of this smart contract within the AXONE protocol is to enable the persistence of governance rules, which are encoded in Prolog. These programs are stored in an immutable format within the protocol and can be referenced by their unique identifiers in situations where there is a need to refer to these rules.
 
 ### In the wild world
 
@@ -55,7 +55,7 @@ A plethora of possibilities opens up for decentralized applications (dApps) that
 
 ### Instantiation
 
-The `okp4-objectarium` can be instantiated as follows, refer to the schema for more information on configuration, limits and pagination configuration:
+The `axone-objectarium` can be instantiated as follows, refer to the schema for more information on configuration, limits and pagination configuration:
 
 ```bash
 axoned tx wasm instantiate $CODE_ID \
@@ -122,7 +122,7 @@ We can also list the objects, eventually filtering on the object owner:
 
 ```bash
 axoned query wasm contract-state smart $CONTRACT_ADDR \
-    "{\"objects\": {\"address\": \"okp41p8u47en82gmzfm259y6z93r9qe63l25dfwwng6\"}}"
+    "{\"objects\": {\"address\": \"axone1p8u47en82gmzfm259y6z93r9qe63l25d858vqu\"}}"
 ```
 
 And navigate in a cursor based pagination:
Original file line number	Diff line number	Diff line change
Expand Up		@@ -41,4 +41,4 @@ Claims are submitted in the form of [Verifiable Presentations (VPs)](https://www

		## Dependencies

		Given its role and status, this smart contract serves as the primary access point for the OKP4 protocol to manage all on-chain stored resources. To fulfill its tasks, the smart contract relies on other smart contracts within the OKP4 ecosystem. Notably, it uses the `Cognitarium` smart contract for persisting the Dataverse representation in an ontological form and the `Law Stone` smart contract to establish governance rules.
		Given its role and status, this smart contract serves as the primary access point for the AXONE protocol to manage all on-chain stored resources. To fulfill its tasks, the smart contract relies on other smart contracts within the AXONE ecosystem. Notably, it uses the `Cognitarium` smart contract for persisting the Dataverse representation in an ontological form and the `Law Stone` smart contract to establish governance rules.