README
¶
axone-sdk
🤔 What is Axone SDK?
Axone SDK is the official software development kit (SDK) for the Axone Protocol. It provides a set of tools and libraries to interact with the Axone Protocol and its ecosystem and enables developers to build applications on top of the Axone Protocol.
The Axone SDK is written in Go and is designed to be modular and extensible. It is built with a focus on security, performance, and ease of use.
Features
- Transaction management
- Creation, signing, and broadcasting of transactions to a Cosmos SDK-based blockchain.
- Key management
- Support for keys with DIDs.
- Verifiable Credential lifecycle
- Parsing, verification, issuance, and signing of Verifiable Credentials.
- Axone protocol interactions
- Retrieval of the governance address of a resource.
- Listing of permitted actions for a resource identified by its DID.
- Verification of whether a specific action is permitted for a given resource.
- Axone storage services
- Provision of core logic for Axone protocol-compliant storage services.
- Authentication
- Support for authentication using Verifiable Credentials and JWT.
🐛 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. We appreciate any help you're willing to give!
Don't hesitate to ask if you are having trouble setting up your own project or if you have any questions about the SDK. Mentors and maintainers are here to help!
🤝 Community
The AXONE Discord Server 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.
😍 You want to get involved?
Please check out Axone health files :
Directories
¶
| Path | Synopsis |
|---|---|
|
Package auth aims to provide authentication primitives against applications and services of the Axone network.
|
Package auth aims to provide authentication primitives against applications and services of the Axone network. |
|
jwt
Package jwt provides a means to manage JWT tokens on top of Axone network authentication mechanisms.
|
Package jwt provides a means to manage JWT tokens on top of Axone network authentication mechanisms. |
|
Package credential aims to provide a set of tools to work with verifiable credentials.
|
Package credential aims to provide a set of tools to work with verifiable credentials. |
|
template
Package template provides some predefined descriptors used to issue verifiable credentials, they are compliant with the Axone Ontology.
|
Package template provides some predefined descriptors used to issue verifiable credentials, they are compliant with the Axone Ontology. |
|
Package dataverse provides programmatic access to the Axone protocol, it carries the high level logic to interacts with its components hiding the low level details.
|
Package dataverse provides programmatic access to the Axone protocol, it carries the high level logic to interacts with its components hiding the low level details. |
|
Package http provides an HTTP server with a configurable server and router.
|
Package http provides an HTTP server with a configurable server and router. |
|
Package keys provides cryptographic key management primitives.
|
Package keys provides cryptographic key management primitives. |
|
Package provider aims to establish common interfaces for recurrent type of services referenced in the Axone protocol to ease their implementation by taking care of the core logic.
|
Package provider aims to establish common interfaces for recurrent type of services referenced in the Axone protocol to ease their implementation by taking care of the core logic. |
|
storage
Package storage provides the core logic needed to implement storage services in the Axone protocol.
|
Package storage provides the core logic needed to implement storage services in the Axone protocol. |
|
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
Package tx carries the logic to create, sign and broadcast transactions to a Cosmos SDK based blockchain.
|
Package tx carries the logic to create, sign and broadcast transactions to a Cosmos SDK based blockchain. |