Skip to content

Commit 9aa9584

Browse files
committed
feat(contracts): update axone-protocol/contracts contracts documentation
1 parent 2381f2f commit 9aa9584

File tree

2 files changed

+95
-44
lines changed

2 files changed

+95
-44
lines changed

contracts/axone-dummy.md

Lines changed: 0 additions & 44 deletions
This file was deleted.

contracts/axone-gov.md

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
# AXONE Governance Contract
2+
3+
A governance contract built using the Abstract SDK for the AXONE protocol.
4+
5+
This contract provides governance capabilities built on top of the Abstract SDK framework, integrating with the AXONE ecosystem.
6+
7+
## Features
8+
9+
- Governance functionality using Abstract SDK
10+
- Integration with AXONE protocol
11+
- CosmWasm-based smart contract
12+
13+
## Usage
14+
15+
This contract can be instantiated and used within the AXONE blockchain network to provide governance capabilities.
16+
17+
## Development
18+
19+
This contract follows AXONE development patterns and uses the cargo-make build system. Use `cargo make` commands for building, testing, and schema generation.
20+
21+
## InstantiateMsg
22+
23+
App instantiate message
24+
25+
| variant | description |
26+
| -------------- | ----------------------------------- |
27+
| InstantiateMsg | **object**. App instantiate message |
28+
29+
## ExecuteMsg
30+
31+
App execute messages
32+
33+
### ExecuteMsg::update_config
34+
35+
| parameter | description |
36+
| --------------- | -------------------------- |
37+
| `update_config` | _(Required.) _ **object**. |
38+
39+
### ExecuteMsg::increment
40+
41+
Increment count by 1
42+
43+
| parameter | description |
44+
| ----------- | -------------------------- |
45+
| `increment` | _(Required.) _ **object**. |
46+
47+
### ExecuteMsg::reset
48+
49+
Admin method - reset count
50+
51+
| parameter | description |
52+
| ------------- | --------------------------------------------------- |
53+
| `reset` | _(Required.) _ **object**. |
54+
| `reset.count` | _(Required.) _ **integer**. Count value after reset |
55+
56+
## QueryMsg
57+
58+
App query messages
59+
60+
### QueryMsg::config
61+
62+
| parameter | description |
63+
| --------- | -------------------------- |
64+
| `config` | _(Required.) _ **object**. |
65+
66+
### QueryMsg::count
67+
68+
| parameter | description |
69+
| --------- | -------------------------- |
70+
| `count` | _(Required.) _ **object**. |
71+
72+
## MigrateMsg
73+
74+
### MigrateMsg::MigrateMsg
75+
76+
| parameter | description |
77+
| --------- | ----------- |
78+
79+
## Responses
80+
81+
### config
82+
83+
| type |
84+
| ----------- |
85+
| **object**. |
86+
87+
### count
88+
89+
| property | description |
90+
| -------- | --------------------------- |
91+
| `count` | _(Required.) _ **integer**. |
92+
93+
---
94+
95+
_Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `axone-gov.json` (`68d5c80810cc40b0`)_

0 commit comments

Comments
 (0)