README
¶
Akachain Gringotts
Gringotts is going to be THE only known bank of the private token world and it is maintained primarily by the akachain team. Wizards, witches and even muggles keep their tokens and other valuables in digital wallets that are protected by strong security measures.
Joke aside, gringotts provides a core smart contract package to build a private token management system on Hyperledger Fabric. Basically, it helps you to issue any arbitrary tokens, manage their life cycles and exchange among themselves. It is nice.
1. Development guide
We welcome contributions to the Gringotts system in any forms. For coding-related matter, please follow the guide below.
Documentation
Package descriptions and API documents are generated using godoc, please follow the standard golang document standards for coding and commenting.
License
Gringotts source code are made available under the MIT license, located in the LICENSE file. You can do whatever you want with them, we do not bother. But if you have some nice idea that wants to share back with us, please do.
To adding MIT license header to new source code files, please use the following snippet
go get -u github.com/google/addlicense
addlicense -c akachain -l mit -y 2021 .
2. Collaboration guide
If you are interested in this project, please send us an email to admin@akachain.io
Documentation
¶
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package DTO (Data Transfer Object) contains data objects that are passed between the handler layer and the service request.
|
Package DTO (Data Transfer Object) contains data objects that are passed between the handler layer and the service request. |
|
The entity package contains all structured entities that are defined in the Gringotts system.
|
The entity package contains all structured entities that are defined in the Gringotts system. |
|
Package errorcode contains a list of pre-defined error code to return to client
|
Package errorcode contains a list of pre-defined error code to return to client |
|
Package glossary contains a collection of constants that are used throughout the whole project
|
Package glossary contains a collection of constants that are used throughout the whole project |
|
doc
Package doc contains prefixes for state database document.
|
Package doc contains prefixes for state database document. |
|
transaction
Package transaction contains pre-defined constants relating to token transaction.
|
Package transaction contains pre-defined constants relating to token transaction. |
|
Package handler take request from the smart contract API and pass the DTO object to the service layer.
|
Package handler take request from the smart contract API and pass the DTO object to the service layer. |
|
Package helper contains common library functions that are shared among business related functions.
|
Package helper contains common library functions that are shared among business related functions. |
|
glogger
Package Gringotts Logger (glogger) contains a singleton logging instance to use throughout the project.
|
Package Gringotts Logger (glogger) contains a singleton logging instance to use throughout the project. |
|
pkg
|
|
|
query
Package query contains all query string used throughout the project.
|
Package query contains all query string used throughout the project. |
|
Repository Package follow the repository pattern https://www.c-sharpcorner.com/UploadFile/b1df45/getting-started-with-repository-pattern-using-C-Sharp/ It provides a generic interface to interact with our entities
|
Repository Package follow the repository pattern https://www.c-sharpcorner.com/UploadFile/b1df45/getting-started-with-repository-pattern-using-C-Sharp/ It provides a generic interface to interact with our entities |
|
base
The basic repository implementation use utility functions in akc-go-sdk
|
The basic repository implementation use utility functions in akc-go-sdk |