Merge pull request #2974 from Agoric/mfig-2960-virtual-purses

feat: first cut at a virtual purse API

Author: michaelfig

golang/cosmos/app/app.go

@@ -92,6 +92,7 @@ import (
 	gaiaappparams "github.com/Agoric/agoric-sdk/golang/cosmos/app/params"
 	"github.com/Agoric/agoric-sdk/golang/cosmos/x/dibc"
 	"github.com/Agoric/agoric-sdk/golang/cosmos/x/swingset"
+	"github.com/Agoric/agoric-sdk/golang/cosmos/x/vpurse"
 
 	// unnamed import of statik for swagger UI support
 	_ "github.com/cosmos/cosmos-sdk/client/docs/statik"
@@ -123,6 +124,7 @@ var (
 		ibc.AppModuleBasic{},
 		swingset.AppModuleBasic{},
 		dibc.AppModuleBasic{},
+		vpurse.AppModuleBasic{},
 		upgrade.AppModuleBasic{},
 		evidence.AppModuleBasic{},
 		transfer.AppModuleBasic{},
@@ -138,6 +140,7 @@ var (
 		stakingtypes.NotBondedPoolName: {authtypes.Burner, authtypes.Staking},
 		govtypes.ModuleName:            {authtypes.Burner},
 		ibctransfertypes.ModuleName:    {authtypes.Minter, authtypes.Burner},
+		vpurse.ModuleName:              {authtypes.Minter, authtypes.Burner},
 	}
 )
 
@@ -155,7 +158,8 @@ type GaiaApp struct { // nolint: golint
 	appCodec          codec.Marshaler
 	interfaceRegistry types.InterfaceRegistry
 
-	ibcPort int
+	ibcPort    int
+	vpursePort int
 
 	invCheckPeriod uint
 
@@ -184,6 +188,7 @@ type GaiaApp struct { // nolint: golint
 
 	SwingSetKeeper swingset.Keeper
 	DibcKeeper     dibc.Keeper
+	VpurseKeeper   vpurse.Keeper
 
 	// make scoped keepers public for test purposes
 	ScopedIBCKeeper      capabilitykeeper.ScopedKeeper
@@ -240,7 +245,9 @@ func NewAgoricApp(
 		authtypes.StoreKey, banktypes.StoreKey, stakingtypes.StoreKey,
 		minttypes.StoreKey, distrtypes.StoreKey, slashingtypes.StoreKey,
 		govtypes.StoreKey, paramstypes.StoreKey, ibchost.StoreKey, upgradetypes.StoreKey,
-		evidencetypes.StoreKey, ibctransfertypes.StoreKey, swingset.StoreKey, dibc.StoreKey, capabilitytypes.StoreKey,
+		evidencetypes.StoreKey, ibctransfertypes.StoreKey,
+		swingset.StoreKey, dibc.StoreKey, vpurse.StoreKey,
+		capabilitytypes.StoreKey,
 	)
 	tkeys := sdk.NewTransientStoreKeys(paramstypes.TStoreKey)
 	memKeys := sdk.NewMemoryStoreKeys(capabilitytypes.MemStoreKey)
@@ -325,6 +332,7 @@ func NewAgoricApp(
 
 	// This function is tricky to get right, so we build it ourselves.
 	callToController := func(ctx sdk.Context, str string) (string, error) {
+		app.MustInitController(ctx)
 		defer swingset.SetControllerContext(ctx)()
 		return sendToController(true, str)
 	}
@@ -355,6 +363,14 @@ func NewAgoricApp(
 	ibcRouter.AddRoute(dibc.ModuleName, dibcModule)
 	app.IBCKeeper.SetRouter(ibcRouter)
 
+	app.VpurseKeeper = vpurse.NewKeeper(
+		appCodec, keys[vpurse.StoreKey],
+		app.BankKeeper,
+		callToController,
+	)
+	vpurseModule := vpurse.NewAppModule(app.VpurseKeeper)
+	app.vpursePort = swingset.RegisterPortHandler("bank", vpurse.NewPortHandler(app.VpurseKeeper))
+
 	// create evidence keeper with router
 	evidenceKeeper := evidencekeeper.NewKeeper(
 		appCodec, keys[evidencetypes.StoreKey], &app.StakingKeeper, app.SlashingKeeper,
@@ -396,6 +412,7 @@ func NewAgoricApp(
 		params.NewAppModule(app.ParamsKeeper),
 		swingset.NewAppModule(app.SwingSetKeeper),
 		dibcModule,
+		vpurseModule,
 		transferModule,
 	)
 
@@ -407,7 +424,7 @@ func NewAgoricApp(
 		upgradetypes.ModuleName, minttypes.ModuleName, distrtypes.ModuleName, slashingtypes.ModuleName,
 		evidencetypes.ModuleName, stakingtypes.ModuleName, ibchost.ModuleName, swingset.ModuleName,
 	)
-	app.mm.SetOrderEndBlockers(swingset.ModuleName, crisistypes.ModuleName, govtypes.ModuleName, stakingtypes.ModuleName)
+	app.mm.SetOrderEndBlockers(vpurse.ModuleName, swingset.ModuleName, crisistypes.ModuleName, govtypes.ModuleName, stakingtypes.ModuleName)
 
 	// NOTE: The genutils module must occur after staking so that pools are
 	// properly initialized with tokens from genesis accounts.
@@ -417,7 +434,9 @@ func NewAgoricApp(
 	app.mm.SetOrderInitGenesis(
 		capabilitytypes.ModuleName, authtypes.ModuleName, banktypes.ModuleName, distrtypes.ModuleName, stakingtypes.ModuleName,
 		slashingtypes.ModuleName, govtypes.ModuleName, minttypes.ModuleName, crisistypes.ModuleName,
-		ibchost.ModuleName, genutiltypes.ModuleName, evidencetypes.ModuleName, swingset.ModuleName, ibctransfertypes.ModuleName,
+		ibchost.ModuleName, genutiltypes.ModuleName, evidencetypes.ModuleName,
+		ibctransfertypes.ModuleName,
+		vpurse.ModuleName, swingset.ModuleName,
 	)
 
 	app.mm.RegisterInvariants(&app.CrisisKeeper)
@@ -484,10 +503,14 @@ func NewAgoricApp(
 }
 
 type cosmosInitAction struct {
-	Type        string `json:"type"`
-	IBCPort     int    `json:"ibcPort"`
-	StoragePort int    `json:"storagePort"`
-	ChainID     string `json:"chainID"`
+	Type             string `json:"type"`
+	IBCPort          int    `json:"ibcPort"`
+	StoragePort      int    `json:"storagePort"`
+	VPursePort       int    `json:"vpursePort"`
+	ChainID          string `json:"chainID"`
+	BootstrapAddress string `json:"bootstrapAddress"`
+	BootstrapValue   string `json:"bootstrapValue"`
+	DonationValue    string `json:"donationValue"`
 }
 
 // MakeCodecs constructs the *std.Codec and *codec.LegacyAmino instances used by
@@ -507,12 +530,27 @@ func (app *GaiaApp) MustInitController(ctx sdk.Context) {
 	}
 	app.controllerInited = true
 
+	var bootstrapAddr sdk.AccAddress
+	gs := app.VpurseKeeper.GetGenesis(ctx)
+	if len(gs.BootstrapAddress) > 0 {
+		ba, err := sdk.AccAddressFromBech32(gs.BootstrapAddress)
+		if err != nil {
+			fmt.Fprintln(os.Stderr, "Cannot get bootstrap addr", err)
+			os.Exit(1)
+		}
+		bootstrapAddr = ba
+	}
+
 	// Begin initializing the controller here.
 	action := &cosmosInitAction{
-		Type:        "AG_COSMOS_INIT",
-		IBCPort:     app.ibcPort,
-		StoragePort: swingset.GetPort("storage"),
-		ChainID:     ctx.ChainID(),
+		Type:             "AG_COSMOS_INIT",
+		VPursePort:       app.vpursePort,
+		IBCPort:          app.ibcPort,
+		StoragePort:      swingset.GetPort("storage"),
+		ChainID:          ctx.ChainID(),
+		BootstrapAddress: bootstrapAddr.String(),
+		BootstrapValue:   gs.BootstrapValue.String(),
+		DonationValue:    gs.DonationValue.String(),
 	}
 	bz, err := json.Marshal(action)
 	if err == nil {
@@ -526,7 +564,6 @@ func (app *GaiaApp) MustInitController(ctx sdk.Context) {
 
 // BeginBlocker application updates every begin block
 func (app *GaiaApp) BeginBlocker(ctx sdk.Context, req abci.RequestBeginBlock) abci.ResponseBeginBlock {
-	app.MustInitController(ctx)
 	return app.mm.BeginBlock(ctx, req)
 }
 
@@ -556,7 +593,6 @@ func updateTransferPort(gs GenesisState, reservedPort, newPort string) error {
 
 // InitChainer application update at chain initialization
 func (app *GaiaApp) InitChainer(ctx sdk.Context, req abci.RequestInitChain) abci.ResponseInitChain {
-	app.MustInitController(ctx)
 	var genesisState GenesisState
 	if err := tmjson.Unmarshal(req.AppStateBytes, &genesisState); err != nil {
 		panic(err)

golang/cosmos/proto/agoric/vpurse/genesis.proto

@@ -0,0 +1,28 @@
+syntax = "proto3";
+package agoric.vpurse;
+
+import "gogoproto/gogo.proto";
+
+option go_package = "github.com/Agoric/agoric-sdk/golang/cosmos/x/vpurse/types";
+
+message GenesisState {
+    option (gogoproto.equal) = false;
+
+    // These are passed as part of the AG_COSMOS_INIT message.
+    // They are plumbed through to configure the bootstrap of the treasury:
+    
+    // Cosmos-SDK layer bech32 address to receive bootstrap_value urun.
+    string bootstrap_address = 1;
+
+    // Number of urun to have the treasury send to bootstrap_address.
+    string bootstrap_value = 2 [
+        (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int",
+        (gogoproto.nullable)   = false
+    ];
+
+    // Number of urun to send from bootstrap_address to new ag-solo clients.
+    string donation_value = 3 [
+        (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int",
+        (gogoproto.nullable)   = false
+    ];
+}

golang/cosmos/proto/agoric/vpurse/msgs.proto

@@ -0,0 +1,7 @@
+syntax = "proto3";
+package agoric.vpurse;
+
+option go_package = "github.com/Agoric/agoric-sdk/golang/cosmos/x/vpurse/types";
+
+service Msg {
+}

golang/cosmos/x/vpurse/alias.go

@@ -0,0 +1,22 @@
+package vpurse
+
+import (
+	"github.com/Agoric/agoric-sdk/golang/cosmos/x/vpurse/keeper"
+	"github.com/Agoric/agoric-sdk/golang/cosmos/x/vpurse/types"
+)
+
+const (
+	ModuleName = types.ModuleName
+	RouterKey  = types.RouterKey
+	StoreKey   = types.StoreKey
+)
+
+var (
+	NewKeeper     = keeper.NewKeeper
+	ModuleCdc     = types.ModuleCdc
+	RegisterCodec = types.RegisterCodec
+)
+
+type (
+	Keeper = keeper.Keeper
+)

golang/cosmos/x/vpurse/genesis.go

@@ -0,0 +1,61 @@
+package vpurse
+
+import (
+	// "fmt"
+
+	"fmt"
+
+	"github.com/Agoric/agoric-sdk/golang/cosmos/x/vpurse/types"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	abci "github.com/tendermint/tendermint/abci/types"
+)
+
+func NewGenesisState() *types.GenesisState {
+	return &types.GenesisState{
+		BootstrapAddress: "",
+		BootstrapValue:   sdk.NewInt(0),
+		DonationValue:    sdk.NewInt(0),
+	}
+}
+
+func ValidateGenesis(data *types.GenesisState) error {
+	if data == nil {
+		return fmt.Errorf("vpurse genesis data cannot be nil")
+	}
+	if len(data.BootstrapAddress) > 0 {
+		if _, err := sdk.AccAddressFromBech32(data.BootstrapAddress); err != nil {
+			return fmt.Errorf("vpurse genesis invalid bootstrapAdddress %s: %w", data.BootstrapAddress, err)
+		}
+	}
+	if data.BootstrapValue.IsNil() {
+		return fmt.Errorf("vpurse genesis bootstrapValue cannot be nil")
+	}
+	if data.BootstrapValue.IsNegative() {
+		return fmt.Errorf("vpurse genesis bootstrapValue %s cannot be negative", data.DonationValue.String())
+	}
+	if data.DonationValue.IsNil() {
+		return fmt.Errorf("vpurse genesis donationValue cannot be nil")
+	}
+	if data.DonationValue.IsNegative() {
+		return fmt.Errorf("vpurse genesis donationValue %s cannot be negative", data.DonationValue.String())
+	}
+	return nil
+}
+
+func DefaultGenesisState() *types.GenesisState {
+	gs := NewGenesisState()
+	fmt.Println("default gen", gs)
+	return gs
+}
+
+func InitGenesis(ctx sdk.Context, keeper Keeper, data *types.GenesisState) []abci.ValidatorUpdate {
+	keeper.SetGenesis(ctx, *data)
+	fmt.Println("initialising gen", *data)
+	return []abci.ValidatorUpdate{}
+}
+
+func ExportGenesis(ctx sdk.Context, k Keeper) *types.GenesisState {
+	gs := k.GetGenesis(ctx)
+	fmt.Println("exporting gen", gs)
+	return &gs
+}

golang/cosmos/x/vpurse/handler.go

@@ -0,0 +1,29 @@
+package vpurse
+
+import (
+	"fmt"
+
+	"github.com/Agoric/agoric-sdk/golang/cosmos/x/swingset"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
+)
+
+// NewHandler returns a handler for "vpurse" type messages.
+func NewHandler(keeper Keeper) sdk.Handler {
+	return func(ctx sdk.Context, msg sdk.Msg) (*sdk.Result, error) {
+		if swingset.IsSimulation(ctx) {
+			// We don't support simulation.
+			return &sdk.Result{}, nil
+		} else {
+			// The simulation was done, so now allow infinite gas.
+			ctx = ctx.WithGasMeter(sdk.NewInfiniteGasMeter())
+		}
+
+		switch msg := msg.(type) {
+		default:
+			errMsg := fmt.Sprintf("Unrecognized vpurse Msg type: %v", msg.Type())
+			return nil, sdkerrors.Wrap(sdkerrors.ErrUnknownRequest, errMsg)
+		}
+	}
+}

golang/cosmos/x/vpurse/keeper/keeper.go

@@ -0,0 +1,69 @@
+package keeper
+
+import (
+	"github.com/cosmos/cosmos-sdk/codec"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+
+	bankkeeper "github.com/cosmos/cosmos-sdk/x/bank/keeper"
+
+	"github.com/Agoric/agoric-sdk/golang/cosmos/x/vpurse/types"
+)
+
+const genesis string = "genesis"
+
+// Keeper maintains the link to data storage and exposes getter/setter methods for the various parts of the state machine
+type Keeper struct {
+	storeKey sdk.StoreKey
+	cdc      codec.Marshaler
+
+	bankKeeper bankkeeper.Keeper
+
+	// CallToController dispatches a message to the controlling process
+	CallToController func(ctx sdk.Context, str string) (string, error)
+}
+
+// NewKeeper creates a new vpurse Keeper instance
+func NewKeeper(
+	cdc codec.Marshaler, key sdk.StoreKey,
+	bankKeeper bankkeeper.Keeper,
+	callToController func(ctx sdk.Context, str string) (string, error),
+) Keeper {
+
+	return Keeper{
+		storeKey:         key,
+		cdc:              cdc,
+		bankKeeper:       bankKeeper,
+		CallToController: callToController,
+	}
+}
+
+func (k Keeper) GetGenesis(ctx sdk.Context) types.GenesisState {
+	store := ctx.KVStore(k.storeKey)
+	bz := store.Get([]byte(genesis))
+	var gs types.GenesisState
+	k.cdc.MustUnmarshalBinaryLengthPrefixed(bz, &gs)
+	return gs
+}
+
+func (k Keeper) SetGenesis(ctx sdk.Context, data types.GenesisState) {
+	store := ctx.KVStore(k.storeKey)
+	store.Set([]byte(genesis), k.cdc.MustMarshalBinaryLengthPrefixed(&data))
+}
+
+func (k Keeper) GetBalance(ctx sdk.Context, addr sdk.AccAddress, denom string) sdk.Coin {
+	return k.bankKeeper.GetBalance(ctx, addr, denom)
+}
+
+func (k Keeper) SendCoins(ctx sdk.Context, addr sdk.AccAddress, amt sdk.Coins) error {
+	if err := k.bankKeeper.MintCoins(ctx, types.ModuleName, amt); err != nil {
+		return err
+	}
+	return k.bankKeeper.SendCoinsFromModuleToAccount(ctx, types.ModuleName, addr, amt)
+}
+
+func (k Keeper) GrabCoins(ctx sdk.Context, addr sdk.AccAddress, amt sdk.Coins) error {
+	if err := k.bankKeeper.SendCoinsFromAccountToModule(ctx, addr, types.ModuleName, amt); err != nil {
+		return err
+	}
+	return k.bankKeeper.BurnCoins(ctx, types.ModuleName, amt)
+}