app

README

BEPSwap Statechain

=======================

Swap any two coins (BEP2 Assets) on Binance Chain using a statechain built with CosmosSDK.

The BEPSwap statechain comes to consensus about events observed on Binance Chain, and then applies logic to these finalised events. Each event causes a state change in the statechain, and some events also result in an output transaction which require assets to be moved. These output transactions are then batched, signed by a threshold signature scheme protocol and broadcast back to Binance Chain.

The BEPSwap statechain can be thought of an elaborate multi-signature wallet on Binance Chain, which has joint custody of assets and strict, deterministic caveats on how to spend. All BEPSwap validators have a co-located Observer and Signer, which together mean they can all agree on what assets they control, what requests for spending are made by users, and how to perform these spends.

Transactions

The BEPSwap Statechain facilitates the following transactions, which are made on Binance Chain, and replayed into the statechain via the Observers:

• CREATE POOL: Anyone can create a new BEP2 Pool
• STAKE: Anyone can stake assets in those pools
• WITHDRAW: Anyone who is staking can withdraw their claim on the pool
• SWAP: Anyone can send in assets and swap to another, including sending to a destination address, and including optional price protection.
• ADD: Anyone can add assets into the pool, which can be claimed by stakers
• GAS: Anyone can add BNB gas to ensure transactions can be processed
• ADMIN: Whitelisted admins can request to change global and pool-based parameters, but majority consensus is required.

The Staking, Withdrawing and Swapping logic is based on the XYK continuous liquidity pool concept.

Setup

Ensure you have a recent version of go (ie `1.121) and enabled go modules

export GO111MODULE=on

And have GOBIN in your PATH

export GOBIN=$GOPATH/bin

Automated Install

To install easily, run the following command...

make setup

Manual Install

Install via this make command.

make install

Once you've installed sscli and ssd, check that they are there.

sscli help
ssd help

Configuration

Next configure your chain.

# Initialize configuration files and genesis file
# moniker is the name of your node
ssd init <moniker> --chain-id sschain

# Copy the Address output here and save it for later use
# [optional] add "--ledger" at the end to use a Ledger Nano S
sscli keys add jack

# Copy the Address output here and save it for later use
sscli keys add alice

# Add both accounts, with coins to the genesis file
ssd add-genesis-account $(sscli keys show jack -a) 1000rune,100000000stake
rune add-genesis-account $(sscli keys show alice -a) 1000rune,100000000stake

# Configure your CLI to eliminate need for chain-id flag
sscli config chain-id sschain
sscli config output json
sscli config indent true
sscli config trust-node true

ssd gentx --name jack

Start

There are three services you may want to start.

Daemon

This runs the backend

make start

REST API Service

Starts an HTTP service to service requests to the backend.

make start-rest

CORS Proxy

For making requests in a browser to the API backend, you'll need to start a proxy in front of the API service to give proper CORS headers. This is because CORS support in Cosmos was removed. In the meantime, use cors.io as a proxy.

Documentation

Index

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

Variables

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

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

	// ModuleBasicManager is in charge of setting up basic module elemnets
	ModuleBasics = module.NewBasicManager(
		genaccounts.AppModuleBasic{},
		auth.AppModuleBasic{},
		bank.AppModuleBasic{},
		params.AppModuleBasic{},
		supply.AppModuleBasic{},
		swapservice.AppModule{},
	)
)

Functions

func MakeCodec

func MakeCodec() *codec.Codec

MakeCodec generates the necessary codecs for Amino

func NewSwapServiceApp

func NewSwapServiceApp(logger log.Logger, db dbm.DB, baseAppOptions ...func(*bam.BaseApp)) *swapServiceApp

NewSwapServiceApp is a constructor function for swapServiceApp

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