@agoric/cosmos 0.35.0-upgrade-14-dev-c8f9e7b.0 → 0.35.0-upgrade-16a-dev-fb592e4.0

package/x/lien/keeper/account.go

@@ -1,290 +0,0 @@
-package keeper
-
-import (
-	"time"
-
-	"github.com/Agoric/agoric-sdk/golang/cosmos/x/lien/types"
-
-	codectypes "github.com/cosmos/cosmos-sdk/codec/types"
-	sdk "github.com/cosmos/cosmos-sdk/types"
-	authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
-	vestexported "github.com/cosmos/cosmos-sdk/x/auth/vesting/exported"
-	"github.com/gogo/protobuf/proto"
-)
-
-// omniAccount is the full expected interface of non-module accounts.
-// In addition to the methods declared in authtypes.AccountI, additional
-// expectations are enforced dynamically through casting and reflection:
-//
-//   - non-module accounts are expected to obey the GenesisAccount interface,
-//     i.e. to have a Validate() method;
-//
-//   - UnpackInterfacesMessage is needed for unpacking accounts embedded
-//     in an Any message;
-//
-//   - MarshalYAML() is used for String rendering;
-//
-//   - protobuf Messages are expected to implement a number of "XXX"-prefixed
-//     methods not visible in the Message interface.
-//
-// Declaring the expected methods here allows them to implicitly fall through
-// to an embedded omniAccount.
-//
-// Note that this interface will have to adapt to updated expectations in
-// the cosmos-sdk or protobuf library.
-type omniAccount interface {
-	authtypes.GenesisAccount
-	codectypes.UnpackInterfacesMessage
-	MarshalYAML() (interface{}, error)
-	XXX_DiscardUnknown()
-	XXX_Marshal([]byte, bool) ([]byte, error)
-	XXX_Merge(proto.Message)
-	XXX_Size() int
-	XXX_Unmarshal([]byte) error
-}
-
-// omniVestingAccount is an omniAccount plus vesting methods.
-type omniVestingAccount interface {
-	omniAccount
-	vestexported.VestingAccount
-}
-
-// omniGrantAccount is an omniAccount plus GrantAccount methods.
-type omniGrantAccount interface {
-	omniAccount
-	vestexported.GrantAccount
-}
-
-// omniClawbackAccount is an omniAccount plus Clawback methods.
-type omniClawbackAccount interface {
-	omniAccount
-	vestexported.ClawbackVestingAccountI
-}
-
-// unlockedVestingAccount extends an omniAccount to be a vesting account
-// by simulating an original vesting amount of zero. It inherets the marshal
-// behavior of the wrapped account. It uses the lien structure to track
-// delegation.
-type unlockedVestingAccount struct {
-	omniAccount
-	lien *types.Lien
-}
-
-var _ omniVestingAccount = unlockedVestingAccount{}
-
-// LockedCoins implements the vestexported.VestingAccount interface.
-func (uva unlockedVestingAccount) LockedCoins(ctx sdk.Context) sdk.Coins {
-	return sdk.NewCoins()
-}
-
-// TrackDelegation implements the vestexported.VestingAccount interface.
-func (uva unlockedVestingAccount) TrackDelegation(blockTime time.Time, balance, amount sdk.Coins) {
-	if !amount.IsAllLTE(balance) {
-		panic("insufficient funds")
-	}
-	uva.lien.Delegated = uva.lien.Delegated.Add(amount...)
-}
-
-// TrackUndelegation implements the vestexported.VestingAccount interface.
-func (uva unlockedVestingAccount) TrackUndelegation(amount sdk.Coins) {
-	// max(delegated - amount, 0) == delegated - min(delegated, amount)
-	uva.lien.Delegated = uva.lien.Delegated.Sub(uva.lien.Delegated.Min(amount)...)
-}
-
-// GetVestedCoins implements the vestexported.VestingAccount interface.
-func (uva unlockedVestingAccount) GetVestedCoins(blockTime time.Time) sdk.Coins {
-	return sdk.NewCoins()
-}
-
-// GetVestingCoins implements the vestexported.VestingAccount interface.
-func (uva unlockedVestingAccount) GetVestingCoins(blockTime time.Time) sdk.Coins {
-	return sdk.NewCoins()
-}
-
-// GetStartTime implements the vestexported.VestingAccount interface.
-func (uva unlockedVestingAccount) GetStartTime() int64 {
-	return 0
-}
-
-// GetEndTime implements the vestexported.VestingAccount interface.
-func (uva unlockedVestingAccount) GetEndTime() int64 {
-	return 0
-}
-
-// GetOriginalVesting implements the vestexported.VestingAccount interface.
-func (uva unlockedVestingAccount) GetOriginalVesting() sdk.Coins {
-	return sdk.NewCoins()
-}
-
-// GetDelegatedFree implements the vestexported.VestingAccount interface.
-func (uva unlockedVestingAccount) GetDelegatedFree() sdk.Coins {
-	return uva.lien.Delegated
-}
-
-// GetDelegatedVesting implements the vestexported.VestingAccount interface.
-func (uva unlockedVestingAccount) GetDelegatedVesting() sdk.Coins {
-	return sdk.NewCoins()
-}
-
-// XXX_MessageName implements the method used by the gogoproto extension
-// for grpc-gateway compatibility.
-func (uva unlockedVestingAccount) XXX_MessageName() string {
-	return proto.MessageName(uva.omniAccount)
-}
-
-// fakeGrantAccount extends an omniVestingAccount to be a GrantAccount.
-type fakeGrantAccount struct {
-	omniVestingAccount
-}
-
-var _ omniGrantAccount = fakeGrantAccount{}
-
-// AddGrant implements the vestexported.GrantAccount interface.
-func (fga fakeGrantAccount) AddGrant(ctx sdk.Context, grantAction vestexported.AddGrantAction) error {
-	return grantAction.AddToAccount(ctx, fga.omniVestingAccount) // XXX or just fail here
-}
-
-// fakeClawbackAccount extends an omniGrantAccount to be a clawback account.
-type fakeClawbackAccount struct {
-	omniGrantAccount
-}
-
-var _ omniClawbackAccount = fakeClawbackAccount{}
-
-// GetUnlockedOnly implements the vestexported.ClawbackVestingAccountI interface.
-func (fca fakeClawbackAccount) GetUnlockedOnly(blockTime time.Time) sdk.Coins {
-	return fca.omniGrantAccount.GetVestedCoins(blockTime)
-}
-
-// GetVestedOnly implements the vestexported.ClawbackVestingAccountI interface.
-func (fca fakeClawbackAccount) GetVestedOnly(blockTime time.Time) sdk.Coins {
-	return fca.omniGrantAccount.GetOriginalVesting()
-}
-
-// Clawback implements the vestexported.ClawbackVestingAccountI interface.
-func (fca fakeClawbackAccount) Clawback(ctx sdk.Context, action vestexported.ClawbackAction) error {
-	return action.TakeFromAccount(ctx, fca.omniGrantAccount) // XXX or just fail here
-}
-
-// PostReward implements the vestexported.ClawbackVestingAccountI interface.
-func (fca fakeClawbackAccount) PostReward(ctx sdk.Context, reward sdk.Coins, action vestexported.RewardAction) error {
-	// perform no action here, but lienAccount can divert lien
-	return nil
-}
-
-// ReturnGrants implements the vestexported.ClawbackVestingAccountI interface.
-func (fca fakeClawbackAccount) ReturnGrants(ctx sdk.Context, action vestexported.ReturnGrantAction) error {
-	return action.TakeGrants(ctx, fca.omniGrantAccount) // XXX or just fail here
-}
-
-// LienAccount wraps an omniClawbackAccount to implement lien encumbrance.
-// The LockedCoins() method is the maximum of the coins locked for
-// liens, and the coins locked in the underlying VestingAccount.
-// It inherits the marshaling behavior of the wrapped account.
-// In particular, the Lien account must be passed by pointer because of
-// expectations from the proto library.
-type LienAccount struct {
-	omniClawbackAccount
-	lienKeeper Keeper
-	lien       types.Lien
-}
-
-var _ omniClawbackAccount = &LienAccount{}
-
-// LockedCoins implements the method from the VestingAccount interface.
-// It takes the maximum of the coins locked for liens and the coins
-// locked in the wrapped VestingAccount, but limited to the current
-// account balance.
-func (la *LienAccount) LockedCoins(ctx sdk.Context) sdk.Coins {
-	wrappedLocked := la.omniClawbackAccount.LockedCoins(ctx)
-	lienedLocked := la.LienedLockedCoins(ctx)
-	encumbered := wrappedLocked.Max(lienedLocked)
-	balance := la.lienKeeper.GetAllBalances(ctx, la.GetAddress())
-	return balance.Min(encumbered)
-}
-
-// LienedLockedCoins returns the coins which are locked on the lien/vesting dimension,
-// which is the raw unvested amount, plus the raw liened amount, less the net amount
-// delegated.
-func (la *LienAccount) LienedLockedCoins(ctx sdk.Context) sdk.Coins {
-	delegated := la.GetDelegatedFree().Add(la.GetDelegatedVesting()...)
-	liened := la.lien.Coins
-	acc := la.omniClawbackAccount.(authtypes.AccountI)
-	if clawback, ok := acc.(vestexported.ClawbackVestingAccountI); ok {
-		liened = liened.Add(clawback.GetOriginalVesting().Sub(clawback.GetVestedOnly(ctx.BlockTime())...)...)
-	}
-	// Since coins can't go negative, even transiently, use the
-	// identity A + B = max(A, B) + min(A, B)
-	//    max(0, A - B) = max(B, A) - B = A - min(A, B)
-	return liened.Sub(liened.Min(delegated)...)
-}
-
-// XXX_MessageName provides the message name for JSON serialization.
-// See proto.MessageName().
-func (la *LienAccount) XXX_MessageName() string {
-	// Use the embedded account's message name for JSON serialization.
-	return proto.MessageName(la.omniClawbackAccount)
-}
-
-// NewAccountWrapper returns an AccountWrapper which wraps any account
-// to be a LienAccount associated with the given Keeper, then unwraps
-// any layers that the Wrap added.
-func NewAccountWrapper(lk Keeper) types.AccountWrapper {
-	return types.AccountWrapper{
-		Wrap: func(ctx sdk.Context, acc authtypes.AccountI) authtypes.AccountI {
-			if acc == nil {
-				return nil
-			}
-			omni, ok := acc.(omniAccount)
-			if !ok {
-				// don't wrap non-omni accounts, e.g. module accounts
-				return acc
-			}
-			addr := acc.GetAddress()
-			lien := lk.GetLien(ctx, addr)
-			if lien.Coins.IsZero() {
-				// don't wrap unless there is a lien
-				return acc
-			}
-			lienAcc := LienAccount{
-				lienKeeper: lk,
-				lien:       lien,
-			}
-			vestingAcc, ok := omni.(omniVestingAccount)
-			if !ok {
-				// Make non-vesting accounts appear to be vesting
-				// (need to give a pointer to the Lien - this is why the LienAccount
-				// holding it is created first).
-				vestingAcc = unlockedVestingAccount{omniAccount: omni, lien: &lienAcc.lien}
-			}
-			grantAcc, ok := vestingAcc.(omniGrantAccount)
-			if !ok {
-				// Make other vesting accounts appear to be GrantAccounts.
-				grantAcc = fakeGrantAccount{omniVestingAccount: vestingAcc}
-			}
-			clawbackAcc, ok := grantAcc.(omniClawbackAccount)
-			if !ok {
-				// Make GrantAccounts appear to be ClawbackAccounts.
-				clawbackAcc = fakeClawbackAccount{omniGrantAccount: grantAcc}
-			}
-			lienAcc.omniClawbackAccount = clawbackAcc
-			return &lienAcc
-		},
-		Unwrap: func(ctx sdk.Context, acc authtypes.AccountI) authtypes.AccountI {
-			if la, ok := acc.(*LienAccount); ok {
-				lk.SetLien(ctx, la.GetAddress(), la.lien)
-				acc = la.omniClawbackAccount
-			}
-			if fca, ok := acc.(fakeClawbackAccount); ok {
-				acc = fca.omniGrantAccount
-			}
-			if fga, ok := acc.(fakeGrantAccount); ok {
-				acc = fga.omniVestingAccount
-			}
-			if uva, ok := acc.(unlockedVestingAccount); ok {
-				acc = uva.omniAccount
-			}
-			return acc
-		},
-	}
-}

package/x/lien/keeper/keeper.go

@@ -1,255 +0,0 @@
-package keeper
-
-import (
-	"fmt"
-	"math"
-
-	"github.com/Agoric/agoric-sdk/golang/cosmos/x/lien/types"
-
-	"github.com/cosmos/cosmos-sdk/codec"
-	storetypes "github.com/cosmos/cosmos-sdk/store/types"
-	sdk "github.com/cosmos/cosmos-sdk/types"
-	vestexported "github.com/cosmos/cosmos-sdk/x/auth/vesting/exported"
-	stakingTypes "github.com/cosmos/cosmos-sdk/x/staking/types"
-
-	vm "github.com/Agoric/agoric-sdk/golang/cosmos/vm"
-)
-
-type Keeper interface {
-	GetAccountWrapper() types.AccountWrapper
-	GetLien(ctx sdk.Context, addr sdk.AccAddress) types.Lien
-	SetLien(ctx sdk.Context, addr sdk.AccAddress, lien types.Lien)
-	IterateLiens(ctx sdk.Context, cb func(addr sdk.AccAddress, lien types.Lien) bool)
-	ChangeLien(ctx sdk.Context, addr sdk.AccAddress, denom string, delta sdk.Int) (sdk.Int, error)
-	GetAccountState(ctx sdk.Context, addr sdk.AccAddress) types.AccountState
-	BondDenom(ctx sdk.Context) string
-	GetAllBalances(ctx sdk.Context, addr sdk.AccAddress) sdk.Coins
-	GetDelegatorDelegations(ctx sdk.Context, delegator sdk.AccAddress, maxRetrieve uint16) []stakingTypes.Delegation
-	GetValidator(ctx sdk.Context, valAddr sdk.ValAddress) (stakingTypes.Validator, bool)
-}
-
-// keeperImpl implements the lien keeper.
-// The accountKeeper field must be the same one that the bankKeeper and
-// stakingKeeper use.
-type keeperImpl struct {
-	key storetypes.StoreKey
-	cdc codec.Codec
-
-	accountKeeper *types.WrappedAccountKeeper
-	bankKeeper    types.BankKeeper
-	stakingKeeper types.StakingKeeper
-
-	pushAction vm.ActionPusher
-}
-
-// NewKeeper returns a new Keeper.
-// The ak must be the same accout keeper that the bk and sk use.
-func NewKeeper(cdc codec.Codec, key storetypes.StoreKey, ak *types.WrappedAccountKeeper, bk types.BankKeeper, sk types.StakingKeeper,
-	pushAction vm.ActionPusher) Keeper {
-	return keeperImpl{
-		key:           key,
-		cdc:           cdc,
-		accountKeeper: ak,
-		bankKeeper:    bk,
-		stakingKeeper: sk,
-		pushAction:    pushAction,
-	}
-}
-
-// GetAccountWrapper returns an AccountWrapper that wrap/unwrap accounts
-// with lienAccount specifying this keeper.
-func (lk keeperImpl) GetAccountWrapper() types.AccountWrapper {
-	return NewAccountWrapper(lk)
-}
-
-// GetLien returns the lien stored for an account.
-// Defaults to a lien of zero.
-func (lk keeperImpl) GetLien(ctx sdk.Context, addr sdk.AccAddress) types.Lien {
-	store := ctx.KVStore(lk.key)
-	bz := store.Get(types.LienByAddressKey(addr))
-	if bz == nil {
-		return types.Lien{}
-	}
-	var lien types.Lien
-	lk.cdc.MustUnmarshal(bz, &lien)
-	return lien
-}
-
-// SetLien sets the lien stored for an account.
-// Deletes the entry if the new lien is zero.
-func (lk keeperImpl) SetLien(ctx sdk.Context, addr sdk.AccAddress, lien types.Lien) {
-	store := ctx.KVStore(lk.key)
-	key := types.LienByAddressKey(addr)
-	if lien.Coins.IsZero() {
-		store.Delete(key)
-		return
-	}
-	bz := lk.cdc.MustMarshal(&lien)
-	store.Set(key, bz)
-}
-
-// IterateLiens calls cb() on all nonzero liens in the store.
-// Stops early if cb() returns true.
-func (lk keeperImpl) IterateLiens(ctx sdk.Context, cb func(addr sdk.AccAddress, lien types.Lien) bool) {
-	store := ctx.KVStore(lk.key)
-	iterator := store.Iterator(nil, nil)
-	defer iterator.Close()
-	for ; iterator.Valid(); iterator.Next() {
-		addr := types.LienByAddressDecodeKey(iterator.Key())
-		var lien types.Lien
-		lk.cdc.MustUnmarshal(iterator.Value(), &lien)
-		if cb(addr, lien) {
-			break
-		}
-	}
-}
-
-// ChangeLien changes the liened amount of a single denomination in the given account.
-// Either the old or new amount of the denomination can be zero.
-// Liens can always be decreased, but to increase a lien, the new total amount must
-// be vested and either bonded (for the staking token) or in the bank (for other tokens).
-// The total lien can have several different denominations. Each is adjusted
-// independently.
-//
-// The delta is given as a raw Int instead of a Coin since it may be negative.
-func (lk keeperImpl) ChangeLien(ctx sdk.Context, addr sdk.AccAddress, denom string, delta sdk.Int) (sdk.Int, error) {
-	oldLien := lk.GetLien(ctx, addr)
-	oldCoins := oldLien.Coins
-	oldAmt := oldCoins.AmountOf(denom)
-	if delta.IsZero() {
-		// no-op, no need to do anything
-		return oldAmt, nil
-	}
-	newAmt := oldAmt.Add(delta)
-	if newAmt.IsNegative() {
-		return oldAmt, fmt.Errorf("lien delta of %s is larger than existing balance %s", delta, oldAmt)
-	}
-	newCoin := sdk.NewCoin(denom, newAmt)
-	newCoins := oldCoins.Sub(sdk.NewCoins(sdk.NewCoin(denom, oldAmt))...).Add(newCoin)
-	newLien := types.Lien{
-		Coins:     newCoins,
-		Delegated: oldLien.Delegated,
-	}
-
-	if delta.IsPositive() {
-		// See if it's okay to increase the lien.
-		// Lien can be increased if the new amount is vested,
-		// not already liened, and if it's the bond denom,
-		// must be staked.
-		state := lk.GetAccountState(ctx, addr)
-		if denom == lk.BondDenom(ctx) {
-			bonded := state.Bonded.AmountOf(denom)
-			unvested := state.Unvested.AmountOf(denom)
-			if !newAmt.Add(unvested).LTE(bonded) {
-				return oldAmt, fmt.Errorf("want to lien %s but only %s vested and bonded", newCoin, bonded.Sub(unvested))
-			}
-			newDelegated := bonded.Add(state.Unbonding.AmountOf(denom))
-			newLien.Delegated = sdk.NewCoins(sdk.NewCoin(denom, newDelegated))
-		} else {
-			inBank := lk.bankKeeper.GetBalance(ctx, addr, denom)
-			if !newAmt.LTE(inBank.Amount) {
-				return oldAmt, fmt.Errorf("want to lien %s but only %s available", newCoin, inBank)
-			}
-		}
-	}
-	lk.SetLien(ctx, addr, newLien)
-	return newAmt, nil
-}
-
-// GetAccountState retrieves the AccountState for addr.
-func (lk keeperImpl) GetAccountState(ctx sdk.Context, addr sdk.AccAddress) types.AccountState {
-	bonded := lk.getBonded(ctx, addr)
-	unbonding := lk.getUnbonding(ctx, addr)
-	locked, unvested := lk.getLockedUnvested(ctx, addr)
-	liened := lk.GetLien(ctx, addr).Coins
-	total := lk.bankKeeper.GetAllBalances(ctx, addr).Add(bonded...).Add(unbonding...)
-	return types.AccountState{
-		Total:     total,
-		Bonded:    bonded,
-		Unbonding: unbonding,
-		Locked:    locked,
-		Liened:    liened,
-		Unvested:  unvested,
-	}
-}
-
-// getBonded returns the bonded tokens delegated by addr.
-func (lk keeperImpl) getBonded(ctx sdk.Context, addr sdk.AccAddress) sdk.Coins {
-	bonded := sdk.NewCoins()
-	delegations := lk.stakingKeeper.GetDelegatorDelegations(ctx, addr, math.MaxUint16)
-	for _, d := range delegations {
-		validatorAddr, err := sdk.ValAddressFromBech32(d.ValidatorAddress)
-		if err != nil {
-			panic(err)
-		}
-		validator, found := lk.stakingKeeper.GetValidator(ctx, validatorAddr)
-		if !found {
-			panic("validator not found")
-		}
-		shares := d.GetShares()
-		tokens := validator.TokensFromShares(shares)
-		bonded = bonded.Add(sdk.NewCoin(lk.stakingKeeper.BondDenom(ctx), tokens.RoundInt())) // XXX rounding?
-	}
-	return bonded
-}
-
-// getUnbonding returns the unbonding tokens delegated by addr.
-func (lk keeperImpl) getUnbonding(ctx sdk.Context, addr sdk.AccAddress) sdk.Coins {
-	unbonding := sdk.NewCoins()
-	unbondings := lk.stakingKeeper.GetUnbondingDelegations(ctx, addr, math.MaxUint16)
-	for _, u := range unbondings {
-		amt := sdk.NewInt(0)
-		for _, e := range u.Entries {
-			amt = amt.Add(e.Balance)
-		}
-		unbonding = unbonding.Add(sdk.NewCoin(lk.stakingKeeper.BondDenom(ctx), amt))
-	}
-	return unbonding
-}
-
-// getLocked returns the number of locked tokens in account addr.
-// This reflects the VestingCoins in the underlying VestingAccount,
-// if any, not the LienAccount wrapping it.
-func (lk keeperImpl) getLockedUnvested(ctx sdk.Context, addr sdk.AccAddress) (sdk.Coins, sdk.Coins) {
-	account := lk.accountKeeper.GetAccount(ctx, addr)
-	if account == nil {
-		// account doesn't exist
-		return sdk.NewCoins(), sdk.NewCoins()
-	}
-	if lienAccount, ok := account.(LienAccount); ok {
-		// unwrap the lien wrapper
-		account = lienAccount.omniClawbackAccount
-	}
-	if clawbackAccount, ok := account.(vestexported.ClawbackVestingAccountI); ok {
-		original := clawbackAccount.GetOriginalVesting()
-		unlocked := clawbackAccount.GetUnlockedOnly(ctx.BlockTime())
-		vested := clawbackAccount.GetVestedOnly(ctx.BlockTime())
-		return original.Sub(unlocked...), original.Sub(vested...)
-	}
-	if vestingAccount, ok := account.(vestexported.VestingAccount); ok {
-		return vestingAccount.GetVestingCoins(ctx.BlockTime()), sdk.NewCoins()
-	}
-	return sdk.NewCoins(), sdk.NewCoins()
-}
-
-// The following methods simply proxy the eponymous staking keeper queries.
-
-// BondDenom returns the denom used for staking.
-func (lk keeperImpl) BondDenom(ctx sdk.Context) string {
-	return lk.stakingKeeper.BondDenom(ctx)
-}
-
-func (lk keeperImpl) GetAllBalances(ctx sdk.Context, addr sdk.AccAddress) sdk.Coins {
-	return lk.bankKeeper.GetAllBalances(ctx, addr)
-}
-
-// GetDelegatorDelegations returns the delegator's delegations.
-// Returns up to the specified number of delegations.
-func (lk keeperImpl) GetDelegatorDelegations(ctx sdk.Context, delegator sdk.AccAddress, maxRetrieve uint16) []stakingTypes.Delegation {
-	return lk.stakingKeeper.GetDelegatorDelegations(ctx, delegator, maxRetrieve)
-}
-
-// GetValidator returns the named validator, if found.
-func (lk keeperImpl) GetValidator(ctx sdk.Context, valAddr sdk.ValAddress) (stakingTypes.Validator, bool) {
-	return lk.stakingKeeper.GetValidator(ctx, valAddr)
-}