README
¶
Minter is a global rewards and loyalty points network powered by a fast blockchain. Any brand, community, or blogger can create their own coins and launch their reward or loyalty system in minutes.
NOTE: This is alpha software. Please contact us if you intend to run it in production.
Installation
Docker
-
Grab latest docker-compose, save docker-compose.yml and run
docker-compose up -d. To run it in production we recommend to use bind host mount instead of volume. -
To build from source clone this repo, make your changes and run
docker-compose up --build -d
Manual
You can get official installation instructions in our docs.
-
Download Minter Node
Get latest binary build suitable for your architecture and unpack it to desired folder.
-
Run Minter Node
./minter node
Resources
- Documentation
- Official site
- About Minter Blockchain
- Minter Console
- Minter Explorer
- Telegram Bot Wallet
- Android Wallet
Related repositories
- minter-go-node-docs - Docs for Minter Node
- node-grpc-gateway - gRPC interface and Swagger for Node API v2
Community
- Telegram Channel (English)
- Telegram Channel (Russian)
- Telegram Chat (English)
- Telegram Chat (Russian)
Versioning
SemVer
Minter uses SemVer to determine when and how the version changes. According to SemVer, anything in the public API can change at any time before version 1.0.0
To provide some stability to Minter users in these 0.X.X days, the MINOR version is used to signal breaking changes across a subset of the total public API. This subset includes all interfaces exposed to other processes, but does not include the in-process Go APIs.
Upgrades
In an effort to avoid accumulating technical debt prior to 1.0.0, we do not guarantee that breaking changes (ie. bumps in the MINOR version) will work with existing blockchain. In these cases you will have to start a new blockchain, or write something custom to get the old data into the new chain.
However, any bump in the PATCH version should be compatible with existing histories (if not please open an issue).
Directories
¶
| Path | Synopsis |
|---|---|
|
cli
|
|
|
cmd
|
|
|
minter
command
|
|
|
core
|
|
|
types
Package common contains various helper functions.
|
Package common contains various helper functions. |
|
bn256
Package bn256 implements a particular bilinear group at the 128-bit security level.
|
Package bn256 implements a particular bilinear group at the 128-bit security level. |
|
bn256/cloudflare
Package bn256 implements a particular bilinear group at the 128-bit security level.
|
Package bn256 implements a particular bilinear group at the 128-bit security level. |
|
bn256/google
Package bn256 implements a particular bilinear group.
|
Package bn256 implements a particular bilinear group. |
|
secp256k1
Package secp256k1 wraps the bitcoin secp256k1 C library.
|
Package secp256k1 wraps the bitcoin secp256k1 C library. |
|
Package hexutil implements hex encoding with Mx prefix.
|
Package hexutil implements hex encoding with Mx prefix. |
|
Package math provides integer math utilities.
|
Package math provides integer math utilities. |
|
Package rlp implements the RLP serialization format.
|
Package rlp implements the RLP serialization format. |
|
rpc
|
|
|
lib
HTTP RPC server supporting calls via uri params, jsonrpc, and jsonrpc over websockets Client Requests Suppose we want to expose the rpc function `HelloWorld(name string, num int)`.
|
HTTP RPC server supporting calls via uri params, jsonrpc, and jsonrpc over websockets Client Requests Suppose we want to expose the rpc function `HelloWorld(name string, num int)`. |
|
lib/server
Commons for HTTP handling
|
Commons for HTTP handling |