Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/axone-protocol/axoned
⛓️ Axone blockchain 💫
https://github.com/axone-protocol/axoned
ai blockchain contribution-welcome cosmos-sdk golang help-wanted orchestration
Last synced: 4 days ago
JSON representation
⛓️ Axone blockchain 💫
- Host: GitHub
- URL: https://github.com/axone-protocol/axoned
- Owner: axone-protocol
- License: apache-2.0
- Created: 2022-01-31T17:32:05.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-30T10:45:51.000Z (2 months ago)
- Last Synced: 2024-08-31T11:43:12.349Z (2 months ago)
- Topics: ai, blockchain, contribution-welcome, cosmos-sdk, golang, help-wanted, orchestration
- Language: Go
- Homepage: https://axone.xyz
- Size: 5.9 MB
- Stars: 162
- Watchers: 6
- Forks: 121
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ccamel - axone-protocol/axoned - ⛓️ Axone blockchain 💫 (Go)
README
[](https://axone.xyz)
# Axone - Orchestration Layer for AI
[](https://github.com/axone-protocol/axoned/actions/workflows/lint.yml)
[](https://github.com/axone-protocol/axoned/actions/workflows/build.yml)
[](https://github.com/axone-protocol/axoned/actions/workflows/test.yml)
[](https://codecov.io/gh/axone-protocol/axoned)
[](https://hub.docker.com/r/axoneprotocol/axoned)
[](https://discord.gg/axone)
[](https://conventionalcommits.org)
[](https://github.com/semantic-release/semantic-release)
[](https://github.com/axone-protocol/.github/blob/main/CODE_OF_CONDUCT.md)
[](https://opensource.org/licenses/Apache-2.0)
> `Axone` is a public [dPoS](https://en.bitcoinwiki.org/wiki/DPoS) layer 1 specifically designed for connecting, sharing, and monetizing any resources in the AI stack. It is an open network dedicated to collaborative AI workflow management that is universally compatible with any data, model, or infrastructure. Data, algorithms, storage, compute, APIs... Anything on-chain and off-chain can be shared.
## The protocol
`axoned` is the node of the [AXONE](https://axone.xyz) network built on the [Cosmos SDK] 💫 & [Tendermint] consensus, which allows companies & individuals to define on-chain rules, share any off-chain resources & create a new generation of applications on top of them.
Read more in the [introduction blog post](https://blog.axone.xyz/). For a high-level overview of the AXONE protocol and network economics, check out the [white paper](https://docs.axone.xyz/docs/whitepaper/abstract).
## Want to become a validator?
Validators are responsible for securing the axone network. Validator responsibilities include maintaining a functional [node](https://docs.axone.xyz/docs/nodes/run-node) with constant uptime and providing a sufficient amount of $AXONE as stake. In exchange for this service, validators receive block rewards and transaction fees.
Want to become a validator? 👉 [Checkout the documentation!](https://docs.axone.xyz/docs/nodes/introduction)
Looking for a network to join ? 👉 [Checkout the networks!](https://github.com/axone-protocol/networks)
## Supported platforms
The `axoned` blockchain currently supports the following builds:
| **Platform** | **Arch** | **Status** |
|--------------|----------|:----------------------:|
| Darwin | amd64 | ✅ |
| Darwin | arm64 | ✅ |
| Linux | amd64 | ✅ |
| Linux | arm64 | ✅ |
| Windows | amd64 | ️🚫
Not supported |
> Note: as the blockchain depends on [CosmWasm/wasmvm](https://github.com/CosmWasm/wasmvm), we only support the targets
> supported by this project.
## Releases
All releases can be found [here](https://github.com/axone-protocol/axoned/releases).
`axoned` follows the [Semantic Versioning 2.0.0](https://semver.org/) to determine when and how the version changes, and
we also apply the philosophical principles of [release early - release often](https://en.wikipedia.org/wiki/Release_early,_release_often).
## Install
### From release
```sh
curl https://i.jpillora.com/axone-protocol/axoned! | bash
```
### From source
```sh
make install
```
### Using docker
```sh
docker run -ti --rm axoneprotocol/axoned --help
```
## Developing & contributing
`axoned` is written in [Go] and built using [Cosmos SDK]. A number of smart contracts are also deployed on the
AXONE blockchain and hosted in the [axone-protocol/contracts](https://github.com/axone-protocol/contracts) project.
### Prerequisites
- install [Go] `1.23+` following instructions from the [official Go documentation](https://golang.org/doc/install);
- use [gofumpt](https://github.com/mvdan/gofumpt) as formatter. You can integrate it in your favorite IDE following these [instructions](https://github.com/mvdan/gofumpt#installation) or invoke the makefile `make format-go`;
- verify that [Docker] is properly installed and if not, follow the [instructions](https://docs.docker.com) for your environment;
- verify that [`make`](https://fr.wikipedia.org/wiki/Make) is properly installed if you intend to use the provided `Makefile`.
### Makefile
The project comes with a convenient `Makefile` that helps you to build, install, lint and test the project.
```text
$ make
Targets:
Lint:
lint Lint all available linters
lint-go Lint go source code
lint-proto Lint proto files
Format:
format Run all available formatters
format-go Format go files
format-proto Format proto files
Build:
build Build all available artefacts (executable, docker image, etc.)
build-go Build node executable for the current environment (default build)
build-go-all Build node executables for all available environments
Install:
install Install node executable
Test:
test Pass all the tests
test-go Pass the test for the go source code
Chain:
chain-init Initialize the blockchain with default settings.
chain-start Start the blockchain with existing configuration (see chain-init)
chain-stop Stop the blockchain
chain-upgrade Test the chain upgrade from the given FROM_VERSION to the given TO_VERSION. You can pass also the proposal json file on PROPOSAL var
Clean:
clean Remove all the files from the target folder
Proto:
proto Generate all resources for proto files (go, doc, etc.)
proto-gen Generate all the code from the Protobuf files
Documentation:
doc Generate all the documentation
doc-proto Generate the documentation from the Protobuf files
doc-command Generate markdown documentation for the command
doc-predicate Generate markdown documentation for all the predicates (module logic)
Mock:
mock Generate all the mocks (for tests)
Release:
release-assets Generate release assets
Help:
help Show this help.
This Makefile depends on docker. To install it, please follow the instructions:
- for macOS: https://docs.docker.com/docker-for-mac/install/
- for Windows: https://docs.docker.com/docker-for-windows/install/
- for Linux: https://docs.docker.com/engine/install/
```
### Build
To build the `axoned` node, invoke the goal `build` of the `Makefile`:
```sh
make build
```
The binary will be generated under the folder `target/dist`.
### Run a local network
To initialize a local network configuration, invoke the goal `chain-init` of the `Makefile`:
```sh
make chain-init
```
The node home directory will be generated under the folder `target/deployment/localnet`. The configuration contains a single validator node.
To start the network, invoke the goal `chain-start` of the `Makefile`:
```sh
make chain-start
```
A wallet is preconfigured with some tokens, you can use it as follows:
```sh
axoned --home target/deployment/localnet tx bank send validator [to_address] [amount]
```
## Bug reports & feature requests
If you notice anything not behaving how you expected, if you would like to make a suggestion or would like
to request a new feature, please open a [**new issue**](https://github.com/axone-protocol/axoned/issues/new/choose). We appreciate any help
you're willing to give!
> Don't hesitate to ask if you are having trouble setting up your project repository, creating your first branch or
> configuring your development environment. Mentors and maintainers are here to help!
## Audit
| Date | Auditor | Version | Report |
|---|---|---|---|
| 2024/08/22 | [BlockApex](https://blockapex.io/) | [2f0f84d (v10.0.0)](https://github.com/axone-protocol/axoned/tree/2f0f84d369852bdb178e299a88c1b8eeb0654b8e) | [Axone Blockchain - Final Audit Report.pdf](https://github.com/BlockApex/Audit-Reports/blob/15d8765ac45b4a83bb2f1446fc9bf869c123f8d2/Axone%20Blockchain%20-%20Final%20Audit%20Report.pdf)|
## Community
The [**AXONE Discord Server**](https://discord.gg/axone) is our primary chat channel for the open-source community,
software developers and node operators.
Please reach out to us and say hi 👋, we're happy to help there.
[Cosmos SDK]: https://v1.cosmos.network/sdk
[Docker]: https://www.docker.com/
[Go]: https://go.dev
[Tendermint]: https://tendermint.com/
## You want to get involved? 😍
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 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 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 AXONE. We encourage you to actively participate and contribute to the growth of our community.
Please check out AXONE health files:
- [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)