app

README

LinkedUp

A blockchain based game for SF Blockchain week. The game is run on it's own blockchain using the Cosmos-Sdk.

Table of Contents

• Background
• Usage
• Contributing
• License

Background

LinkedUp is a networking game built for SF Blockchain Week 2019. The game runs on a Cosmos blockchain, and rewards players for establishing social connections between each other at the conference.

The game addresses two challenges - player onboarding and wallet installation. Players use ephemeral wallets to play the game, and a key escrow service provides key recovery as well as facilitating player onboarding. This escrow service also provides administrative functions useful for day-of operations. These functions should become less necessary as we learn more about how the game works in practice.

Usage

Running in Docker

To get up and running with docker:

docker-compose up --build

LocalStack may depend on the presence of a /tmp/localstack directory on your system. If needed, ensure its presence:

mkdir -p /tmp/localstack

Make sure to edit /etc/hosts to make localstack an alias for 127.0.0.1

127.0.0.1	localhost
127.0.0.1	localstack
255.255.255.255	broadcasthost

Email Functionality

SES-based email sending functionality depends on AWS API keys. When run deployed in AWS these will be provided by the instance role. For development purposes you'll need to provide your own. See the linkedup-content repository for the email templates - they can be installed using:

aws ses create-template --template "`cat path/to/rekey.json`" --region us-west-2

Contributing

Build and Test

To build the project:

make all

Before you can run the tests you'll need to set up the runtime environment so the system can connect with Eventbrite. To do that, export the environment variable EVENTBRITE_AUTH containing your Eventbrite access token. In addition, the system needs to know which Eventbrite event to work with. Set that in EVENTBRITE_EVENT.

export EVENTBRITE_EVENT="3414213431"
export EVENTBRITE_AUTH="ewifkjaweklfheaklj"

To lint and test:

make test

Running the Key Service

The key service runs alongside lyd and lycli to facilitate keying accounts and email onboarding. The key service hosts two http endpoints

The usage for the key service is shown below

Usage:
  ks [flags]

Flags:
      --port int                    port to bind the rekey service (default 1337)
      --longy-chain-id string       chain-id of the running longy game (default "longychain")
      --longy-masterkey string      hex encoded master private key (default "fc613b4dfd6736a7bd268c8a0e74ed0d1c04a959f59dd74ef2874983fd443fca")
      --longy-restservice string    scheme://host:port of the full node rest client (default "http://localhost:1317")
	  --longy-app-url              scheme://host of the client web app

      --eventbrite-auth string      eventbrite authorization token
      --eventbrite-event int        id associated with the eventbrite event

      --aws-content-bucket string   content bucket for user uploads (default "linkedup-user-content")
      --email-mock                  print email URLs instead of emailing
      --localstack                  use localstack instead of aws; implies --email-mock

The configruation can also be set through environment variables. the - characters replaced by _ and all uppercase.
i.e STMP_SERVER or EVENTBRITE_AUTH

Email Data Testing

Running the key service with the --email-mock flag will cause email template parameters to be logged instead of sent to an email system.

Using LocalStack

Running the key service with the --localstack flag will cause AWS-backed drivers to look for LocalStack services on the localstack host instead. It implies --email-mock.

Bonus

Start a bonus period ./bin/lycli tx longy create-bonus <multiplier> --longy-rest-url="http://chain.linkedup.sfbw.io"

End a bonus period ./bin/lycli tx longy clear-bonus --longy-rest-url="https://chain.linkedup.sfbw.io"

API

The API for the game and the Postman Collections for it can be found in the wiki

Running database tests

The database tests depend on a local DynamoDB instance running on port 8000. To enable the tests, first launch the DynamoDB service:

docker run --rm -p 8000:8000 amazon/dynamodb-local

Then run the suite in an environment with:

ENABLE_DB_TESTS=true

eg:

ENABLE_DB_TESTS=true
make test

Opening a Pull Request

Pull requests are welcome!

When opening a pull request, make sure the tests and linters pass by running

make test

Once the tests all pass, submit a PR and we'll take a look.

Want to contribute but unsure how?

Check out the issues page for ideas on what to work on. If this is your first time contributing, look for issues with the "good first issue" tag.

License

MIT

Documentation

Index

• Variables
• func MakeCodec() *codec.Codec
• type GenesisState
  • func NewDefaultGenesisState() GenesisState
• type LongyApp
  • func NewLongyApp(logger log.Logger, db dbm.DB, baseAppOptions ...func(*bam.BaseApp)) *LongyApp
  • func (app *LongyApp) BeginBlocker(ctx sdk.Context, req abci.RequestBeginBlock) abci.ResponseBeginBlock
  • func (app *LongyApp) EndBlocker(ctx sdk.Context, req abci.RequestEndBlock) abci.ResponseEndBlock
  • func (app *LongyApp) ExportAppStateAndValidators(forZeroHeight bool, jailWhiteList []string) (appState json.RawMessage, validators []tmtypes.GenesisValidator, err error)
  • func (app *LongyApp) InitChainer(ctx sdk.Context, req abci.RequestInitChain) abci.ResponseInitChain
  • func (app *LongyApp) LoadHeight(height int64) error
  • func (app *LongyApp) ModuleAccountAddrs() map[string]bool

Variables

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

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

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

		longy.AppModule{},
	)
)

Functions

func MakeCodec

func MakeCodec() *codec.Codec

MakeCodec generates the necessary codecs for Amino

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

NewDefaultGenesisState returns the combined default genesis file fo the modules

type LongyApp

type LongyApp struct {
	*bam.BaseApp
	// contains filtered or unexported fields
}

LongyApp is our app structure

func NewLongyApp

func NewLongyApp(
	logger log.Logger, db dbm.DB, baseAppOptions ...func(*bam.BaseApp),
) *LongyApp

NewLongyApp is a constructor function for LongyApp nolint: dupl

func (*LongyApp) BeginBlocker

func (app *LongyApp) BeginBlocker(ctx sdk.Context, req abci.RequestBeginBlock) abci.ResponseBeginBlock

BeginBlocker performs begin block functionality for all modules. nolint: gocritic

func (*LongyApp) EndBlocker

func (app *LongyApp) EndBlocker(ctx sdk.Context, req abci.RequestEndBlock) abci.ResponseEndBlock

EndBlocker performs end block functionality for all modules nolint: gocritic

func (*LongyApp) ExportAppStateAndValidators

func (app *LongyApp) ExportAppStateAndValidators(forZeroHeight bool, jailWhiteList []string,
) (appState json.RawMessage, validators []tmtypes.GenesisValidator, err error)

ExportAppStateAndValidators returns the app state for export

func (*LongyApp) InitChainer

func (app *LongyApp) InitChainer(ctx sdk.Context, req abci.RequestInitChain) abci.ResponseInitChain

InitChainer initializes the chain from the genesis state nolint: gocritic

func (*LongyApp) LoadHeight

func (app *LongyApp) LoadHeight(height int64) error

LoadHeight loads the app version

func (*LongyApp) ModuleAccountAddrs

func (app *LongyApp) ModuleAccountAddrs() map[string]bool

ModuleAccountAddrs returns all the app's module account addresses.