mirror of
https://github.com/onsonr/sonr.git
synced 2025-03-10 21:09:11 +00:00
63 lines
1.3 KiB
Markdown
63 lines
1.3 KiB
Markdown
# `x/macaroon`
|
|
|
|
The Macaroon module is responsible for providing decentralized access control and service authorization for the Sonr ecosystem.
|
|
|
|
## Concepts
|
|
|
|
## State
|
|
|
|
Specify and describe structures expected to marshalled into the store, and their keys
|
|
|
|
### Account State
|
|
|
|
The Account state includes the user's public key, associated wallets, and other identification details. It is stored using the user's DID as the key.
|
|
|
|
### Credential State
|
|
|
|
The Credential state includes the claims about a subject and is stored using the credential ID as the key.
|
|
|
|
## State Transitions
|
|
|
|
Standard state transition operations triggered by hooks, messages, etc.
|
|
|
|
## Messages
|
|
|
|
Specify message structure(s) and expected state machine behaviour(s).
|
|
|
|
## Begin Block
|
|
|
|
Specify any begin-block operations.
|
|
|
|
## End Block
|
|
|
|
Specify any end-block operations.
|
|
|
|
## Hooks
|
|
|
|
Describe available hooks to be called by/from this module.
|
|
|
|
## Events
|
|
|
|
List and describe event tags used.
|
|
|
|
## Client
|
|
|
|
List and describe CLI commands and gRPC and REST endpoints.
|
|
|
|
## Params
|
|
|
|
List all module parameters, their types (in JSON) and identitys.
|
|
|
|
## Future Improvements
|
|
|
|
Describe future improvements of this module.
|
|
|
|
## Tests
|
|
|
|
Acceptance tests.
|
|
|
|
## Appendix
|
|
|
|
Supplementary details referenced elsewhere within the spec.
|
|
his is a module base generated with [`spawn`](https://github.com/rollchains/spawn).
|