app

README

Shareledger

Shareledger is a custom-designed distributed blockchain with Tendermint as a Byzantine-Fault Tolerant State Machine. ShareLedger provides essential building blocks for any rental/sharing services on top of it.

ShareLedger currently ultilizes a dual-token mechanism, SharePay (SHRP) and ShareToken (SHR). The former provides a stable currency for any additional services running on top of ShareLedger while the latter acts as an ultility token.

Install Shareledger

The fatest and easiest way to install Shareledger is to run our os-specfic application which guides you through four steps to setup and run a MasterNode. TO BE RELEASED

From Binary

To download pre-built binaries, see the releases page.

From Source

Requirements

• go - compile tool. Version >=1.15
• make - compile tool

Get Source Code

git clone https://github.com/sharering/shareledger.git
cd shareledger

Compile (Work on Linux only)

make build

This will compile ShareLedger and put the binary in ./build

Run

• To start a ShareLedger node

./shareledger init
./shareledger start

• Start single node for testing purpose: start single node

  Run ./build/shareledger -h to get more detailed information on how to execute ShareLedger

---

Notes

• Get code from branch feature/upgrade-2019-10-22

Documentation

Index

• Variables
• func MakeCodec() *codec.Codec
• func NewshareledgerApp(logger log.Logger, db dbm.DB, baseAppOptions ...func(*bam.BaseApp)) *shareledgerApp
• type GenesisState
  • func NewDefaultGenesisState() GenesisState

Variables

var (
	// default home directories for the application CLI
	DefaultCLIHome = os.ExpandEnv("$HOME/.slcli")

	// DefaultNodeHome sets the folder where the applcation data and configuration will be stored
	DefaultNodeHome = os.ExpandEnv("$HOME/.shareledger")

	// NewBasicManager is in charge of setting up basic module elements
	ModuleBasics = module.NewBasicManager(
		genutil.AppModuleBasic{},
		auth.AppModuleBasic{},
		bank.AppModuleBasic{},
		staking.AppModuleBasic{},
		distr.AppModuleBasic{},
		params.AppModuleBasic{},
		slashing.AppModuleBasic{},
		supply.AppModuleBasic{},

		gentlemint.AppModule{},
		electoral.AppModule{},
		asset.AppModule{},
		booking.AppModule{},
		identity.AppModule{},
		id.AppModule{},
		document.AppModule{},
	)
)

Functions

func MakeCodec

func MakeCodec() *codec.Codec

MakeCodec generates the necessary codecs for Amino

func NewshareledgerApp

func NewshareledgerApp(
	logger log.Logger, db dbm.DB, baseAppOptions ...func(*bam.BaseApp),
) *shareledgerApp

NewshareledgerApp is a constructor function for shareledgerApp

Types

type GenesisState

type GenesisState map[string]json.RawMessage

GenesisState represents chain state at the start of the chain. Any initial state (account balances) are stored here.

func NewDefaultGenesisState

func NewDefaultGenesisState() GenesisState