feat(gnovm): add Coin constructor and more functionality

examples/gno.land/r/demo/boards/public.gno

@@ -33,7 +33,7 @@ func CreateBoard(name string) BoardID {
 
 func checkAnonFee() bool {
  sent := std.GetOrigSend()
- anonFeeCoin := std.Coin{"ugnot", int64(gDefaultAnonFee)}
+ anonFeeCoin := std.NewCoin("ugnot", int64(gDefaultAnonFee))
  if len(sent) == 1 && sent[0].IsGTE(anonFeeCoin) {
  return true
  }

examples/gno.land/r/demo/users/users.gno

@@ -35,7 +35,7 @@ func Register(inviter std.Address, name string, profile string) {
  panic("should not happen") // because std.AssertOrigCall().
  }
  sentCoins := std.GetOrigSend()
- minCoin := std.Coin{"ugnot", minFee}
+ minCoin := std.NewCoin("ugnot", minFee)
  if inviter == "" {
  // banker := std.GetBanker(std.BankerTypeOrigSend)
  if len(sentCoins) == 1 && sentCoins[0].IsGTE(minCoin) {

examples/gno.land/r/demo/users/z_0_filetest.gno

@@ -7,10 +7,10 @@ import (
 )
 
 func main() {
- std.TestSetOrigSend(std.Coins{{"dontcare", 1}}, nil)
+ std.TestSetOrigSend(std.Coins{std.NewCoin("dontcare", 1)}, nil)
  users.Register("", "gnouser", "my profile")
  println("done")
 }
 
 // Error:
-// invalid coin denominations: dontcare
+// comparing different denominations: dontcare, ugnot

examples/gno.land/r/gnoland/faucet/admin.gno

@@ -25,7 +25,7 @@ func AdminSetTransferLimit(amount int64) string {
  if err := assertIsAdmin(); err != nil {
  return err.Error()
  }
- gLimit = std.Coin{Denom: "ugnot", Amount: amount}
+ gLimit = std.NewCoin("ugnot", amount)
  return ""
 }
 

examples/gno.land/r/gnoland/faucet/faucet.gno

@@ -21,7 +21,7 @@ var (
  gTotalTransfers = uint(0)
 
  // per request limit, 350 gnot
- gLimit std.Coin = std.Coin{"ugnot", 350000000}
+ gLimit std.Coin = std.NewCoin("ugnot", 350000000)
 )
 
 func Transfer(to std.Address, send int64) string {
@@ -37,7 +37,7 @@ func Transfer(to std.Address, send int64) string {
  if send > gLimit.Amount {
  return errors.New("Per request limit " + gLimit.String() + " exceed").Error()
  }
- sendCoins := std.Coins{std.Coin{Denom: "ugnot", Amount: send}}
+ sendCoins := std.Coins{std.NewCoin("ugnot", send)}
 
  gTotalTransferred = gTotalTransferred.Add(sendCoins)
  gTotalTransfers++

gnovm/stdlibs/std/coins.gno

@@ -1,6 +1,8 @@
 package std
 
-import "strconv"
+import (
+ "strconv"
+)
 
 // NOTE: this is selectly copied over from pkgs/std/coin.go
 // TODO: import all functionality(?).
@@ -13,21 +15,77 @@ type Coin struct {
  Amount int64 `json:"amount"`
 }
 
+// NewCoin returns a new coin with a denomination and amount
+func NewCoin(denom string, amount int64) Coin {
+ return Coin{
+ Denom: denom,
+ Amount: amount,
+ }
+}
+
+// String provides a human-readable representation of a coin
 func (c Coin) String() string {
+ if c.IsZero() {
+ return ""
+ }
+
  return strconv.Itoa(int(c.Amount)) + c.Denom
 }
 
+// IsGTE returns true if they are the same type and the receiver is
+// an equal or greater value
 func (c Coin) IsGTE(other Coin) bool {
  if c.Denom != other.Denom {
- panic("invalid coin denominations: " + c.Denom)
+ panic("comparing different denominations: " + c.Denom + ", " + other.Denom)
  }
  return c.Amount >= other.Amount
 }
 
+// IsLT returns true if they are the same type and the receiver is
+// a smaller value
+func (c Coin) IsLT(other Coin) bool {
+ if c.Denom != other.Denom {
+ panic("comparing different denominations: " + c.Denom + ", " + other.Denom)
+ }
+ return c.Amount < other.Amount
+}
+
+// IsEqual returns true if the two sets of Coins have the same value
+func (c Coin) IsEqual(other Coin) bool {
+ if c.Denom != other.Denom {
+ panic("comparing different denominations: " + c.Denom + ", " + other.Denom)
+ }
+ return c.Amount == other.Amount
+}
+
+// IsZero returns if this represents no money
+func (c Coin) IsZero() bool {
+ return c.Amount == 0
+}
+
+func NewCoins(val ...interface{}) Coins {
+ if len(val)%2 != 0 {
+ panic("invalid number of arguments")
+ }
+
+ cz := Coins{}
+ for i := 0; i < len(val)-1; i++ {
+ denom := val[i].(string)
+ amt := val[i+1].(int64)
+ cz = append(cz, NewCoin(denom, amt))
+ }
+
+ return cz
+}
+
 // Coins is a set of Coin, one per currency
 type Coins []Coin
 
 func (cz Coins) String() string {
+ if len(cz) == 0 {
+ return ""
+ }
+
  res := ""
  for i, c := range cz {
  if i > 0 {
@@ -47,9 +105,9 @@ func (cz Coins) AmountOf(denom string) int64 {
  return 0
 }
 
-func (a Coins) Add(b Coins) Coins {
+func (cz Coins) Add(b Coins) Coins {
  c := Coins{}
- for _, ac := range a {
+ for _, ac := range cz {
  bc := b.AmountOf(ac.Denom)
  ac.Amount += bc
  c = append(c, ac)

gnovm/stdlibs/stdshim/coins.gno

@@ -1,9 +1,12 @@
 package std
 
-import "strconv"
+import (
+ "strconv"
+)
 
 // NOTE: this is selectly copied over from pkgs/std/coin.go
 // TODO: import all functionality(?).
+// TODO: implement Coin/Coins constructors.
 
 // Coin hold some amount of one currency.
 // A negative amount is invalid.
@@ -12,21 +15,62 @@ type Coin struct {
  Amount int64 `json:"amount"`
 }
 
+// NewCoin returns a new coin with a denomination and amount
+func NewCoin(denom string, amount int64) Coin {
+ return Coin{
+ Denom: denom,
+ Amount: amount,
+ }
+}
+
+// String provides a human-readable representation of a coin
 func (c Coin) String() string {
+ if c.IsZero() {
+ return ""
+ }
+
  return strconv.Itoa(int(c.Amount)) + c.Denom
 }
 
+// IsGTE returns true if they are the same type and the receiver is
+// an equal or greater value
 func (c Coin) IsGTE(other Coin) bool {
  if c.Denom != other.Denom {
- panic("invalid coin denominations: " + c.Denom)
+ panic("comparing different denominations: " + c.Denom + ", " + other.Denom)
  }
  return c.Amount >= other.Amount
 }
 
+// IsLT returns true if they are the same type and the receiver is
+// a smaller value
+func (c Coin) IsLT(other Coin) bool {
+ if c.Denom != other.Denom {
+ panic("comparing different denominations: " + c.Denom + ", " + other.Denom)
+ }
+ return c.Amount < other.Amount
+}
+
+// IsEqual returns true if the two sets of Coins have the same value
+func (c Coin) IsEqual(other Coin) bool {
+ if c.Denom != other.Denom {
+ panic("comparing different denominations: " + c.Denom + ", " + other.Denom)
+ }
+ return c.Amount == other.Amount
+}
+
+// IsZero returns if this represents no money
+func (c Coin) IsZero() bool {
+ return c.Amount == 0
+}
+
 // Coins is a set of Coin, one per currency
 type Coins []Coin
 
 func (cz Coins) String() string {
+ if len(cz) == 0 {
+ return ""
+ }
+
  res := ""
  for i, c := range cz {
  if i > 0 {
@@ -46,9 +90,9 @@ func (cz Coins) AmountOf(denom string) int64 {
  return 0
 }
 
-func (a Coins) Add(b Coins) Coins {
+func (cz Coins) Add(b Coins) Coins {
  c := Coins{}
- for _, ac := range a {
+ for _, ac := range cz {
  bc := b.AmountOf(ac.Denom)
  ac.Amount += bc
  c = append(c, ac)
@@ -62,4 +106,13 @@ func (a Coins) Add(b Coins) Coins {
  return c
 }
 
-// TODO implement Coin/Coins constructors.
+// expand for usage within natively bound functions.
+func (cz Coins) expandNative() (denoms []string, amounts []int64) {
+ denoms = make([]string, len(cz))
+ amounts = make([]int64, len(cz))
+ for i, coin := range cz {
+ denoms[i] = coin.Denom
+ amounts[i] = coin.Amount
+ }
+ return denoms, amounts
+}

gnovm/tests/files/zrealm_natbind0.gno

@@ -141,7 +141,7 @@ func main() {
 // "Closure": {
 // "@type": "/gno.RefValue",
 // "Escaped": true,
-// "ObjectID": "a7f5397443359ea76c50be82c77f1f893a060925:7"
+// "ObjectID": "a7f5397443359ea76c50be82c77f1f893a060925:8"
 // },
 // "FileName": "native.gno",
 // "IsMethod": false,