Merge pull request #515 from CosmWasm/update-types

Update types to cosmwasm 2.0 version

docs/MIGRATING.md

@@ -33,6 +33,15 @@
   whether the given string is a valid address. This was previously done
   internally using separate calls to `CanonicalizeAddress` and `HumanizeAddress`
   but can be done more efficiently using a single call.
+- The IBC `TransferMsg` now includes an optional `Memo` field.
+- `SubMsgResponse` now has an additional `MsgResponses` field, mirroring the
+  Cosmos SDK
+- The types `Events`, `EventAttributes`, `Delegations`, `IBCChannels`,
+  `Validators`, `MsgResponses` and `Coins` were replaced with a generic
+  `Array[C]` type. This new type is a wrapper around a `[]C`. One difference to
+  the old behavior is that the new type will unmarshal to an empty slice when
+  the JSON value is `null` or `[]`. Previously, both cases resulted in a `nil`
+  value.
 
 ## Renamings
 

ibc_test.go

@@ -96,7 +96,7 @@ func TestIBCHandshake(t *testing.T) {
 	// instantiate it with this store
 	store := api.NewLookup(gasMeter1)
 	goapi := api.NewMockAPI()
-	balance := types.Coins{}
+	balance := types.Array[types.Coin]{}
 	querier := api.DefaultQuerier(api.MOCK_CONTRACT_ADDR, balance)
 
 	// instantiate
@@ -169,7 +169,7 @@ func TestIBCPacketDispatch(t *testing.T) {
 	// instantiate it with this store
 	store := api.NewLookup(gasMeter1)
 	goapi := api.NewMockAPI()
-	balance := types.Coins{}
+	balance := types.Array[types.Coin]{}
 	querier := api.DefaultQuerier(api.MOCK_CONTRACT_ADDR, balance)
 
 	// instantiate
@@ -210,9 +210,9 @@ func TestIBCPacketDispatch(t *testing.T) {
 		ID: id,
 		Result: types.SubMsgResult{
 			Ok: &types.SubMsgResponse{
-				Events: types.Events{{
+				Events: types.Array[types.Event]{{
 					Type: "instantiate",
-					Attributes: types.EventAttributes{
+					Attributes: types.Array[types.EventAttribute]{
 						{
 							Key:   "_contract_address",
 							Value: REFLECT_ADDR,
@@ -249,7 +249,7 @@ func TestIBCPacketDispatch(t *testing.T) {
 			Msgs: []types.CosmosMsg{{
 				Bank: &types.BankMsg{Send: &types.SendMsg{
 					ToAddress: "my-friend",
-					Amount:    types.Coins{types.NewCoin(12345678, "uatom")},
+					Amount:    types.Array[types.Coin]{types.NewCoin(12345678, "uatom")},
 				}},
 			}},
 		},

internal/api/api_test.go

@@ -24,7 +24,7 @@ func TestValidateAddressFailure(t *testing.T) {
 	// instantiate it with this store
 	store := NewLookup(gasMeter)
 	api := NewMockAPI()
-	querier := DefaultQuerier(MOCK_CONTRACT_ADDR, types.Coins{types.NewCoin(100, "ATOM")})
+	querier := DefaultQuerier(MOCK_CONTRACT_ADDR, types.Array[types.Coin]{types.NewCoin(100, "ATOM")})
 	env := MockEnvBin(t)
 	info := MockInfoBin(t, "creator")
 

internal/api/iterator_test.go

@@ -31,7 +31,7 @@ func setupQueueContractWithData(t *testing.T, cache Cache, values ...int) queueD
 	// instantiate it with this store
 	store := NewLookup(gasMeter1)
 	api := NewMockAPI()
-	querier := DefaultQuerier(MOCK_CONTRACT_ADDR, types.Coins{types.NewCoin(100, "ATOM")})
+	querier := DefaultQuerier(MOCK_CONTRACT_ADDR, types.Array[types.Coin]{types.NewCoin(100, "ATOM")})
 	env := MockEnvBin(t)
 	info := MockInfoBin(t, "creator")
 	msg := []byte(`{}`)

internal/api/lib_test.go

@@ -292,7 +292,7 @@ func TestGetMetrics(t *testing.T) {
 	igasMeter := types.GasMeter(gasMeter)
 	store := NewLookup(gasMeter)
 	api := NewMockAPI()
-	querier := DefaultQuerier(MOCK_CONTRACT_ADDR, types.Coins{types.NewCoin(100, "ATOM")})
+	querier := DefaultQuerier(MOCK_CONTRACT_ADDR, types.Array[types.Coin]{types.NewCoin(100, "ATOM")})
 	env := MockEnvBin(t)
 	info := MockInfoBin(t, "creator")
 	msg1 := []byte(`{"verifier": "fred", "beneficiary": "bob"}`)
@@ -397,7 +397,7 @@ func TestInstantiate(t *testing.T) {
 	// instantiate it with this store
 	store := NewLookup(gasMeter)
 	api := NewMockAPI()
-	querier := DefaultQuerier(MOCK_CONTRACT_ADDR, types.Coins{types.NewCoin(100, "ATOM")})
+	querier := DefaultQuerier(MOCK_CONTRACT_ADDR, types.Array[types.Coin]{types.NewCoin(100, "ATOM")})
 	env := MockEnvBin(t)
 	info := MockInfoBin(t, "creator")
 	msg := []byte(`{"verifier": "fred", "beneficiary": "bob"}`)
@@ -424,7 +424,7 @@ func TestExecute(t *testing.T) {
 	// instantiate it with this store
 	store := NewLookup(gasMeter1)
 	api := NewMockAPI()
-	balance := types.Coins{types.NewCoin(250, "ATOM")}
+	balance := types.Array[types.Coin]{types.NewCoin(250, "ATOM")}
 	querier := DefaultQuerier(MOCK_CONTRACT_ADDR, balance)
 	env := MockEnvBin(t)
 	info := MockInfoBin(t, "creator")
@@ -489,7 +489,7 @@ func TestExecutePanic(t *testing.T) {
 	// instantiate it with this store
 	store := NewLookup(gasMeter1)
 	api := NewMockAPI()
-	balance := types.Coins{types.NewCoin(250, "ATOM")}
+	balance := types.Array[types.Coin]{types.NewCoin(250, "ATOM")}
 	querier := DefaultQuerier(MOCK_CONTRACT_ADDR, balance)
 	env := MockEnvBin(t)
 	info := MockInfoBin(t, "creator")
@@ -518,7 +518,7 @@ func TestExecuteUnreachable(t *testing.T) {
 	// instantiate it with this store
 	store := NewLookup(gasMeter1)
 	api := NewMockAPI()
-	balance := types.Coins{types.NewCoin(250, "ATOM")}
+	balance := types.Array[types.Coin]{types.NewCoin(250, "ATOM")}
 	querier := DefaultQuerier(MOCK_CONTRACT_ADDR, balance)
 	env := MockEnvBin(t)
 	info := MockInfoBin(t, "creator")
@@ -702,7 +702,7 @@ func TestExecuteUserErrorsInApiCalls(t *testing.T) {
 	igasMeter1 := types.GasMeter(gasMeter1)
 	// instantiate it with this store
 	store := NewLookup(gasMeter1)
-	balance := types.Coins{types.NewCoin(250, "ATOM")}
+	balance := types.Array[types.Coin]{types.NewCoin(250, "ATOM")}
 	querier := DefaultQuerier(MOCK_CONTRACT_ADDR, balance)
 	env := MockEnvBin(t)
 	info := MockInfoBin(t, "creator")
@@ -733,7 +733,7 @@ func TestMigrate(t *testing.T) {
 	// instantiate it with this store
 	store := NewLookup(gasMeter)
 	api := NewMockAPI()
-	balance := types.Coins{types.NewCoin(250, "ATOM")}
+	balance := types.Array[types.Coin]{types.NewCoin(250, "ATOM")}
 	querier := DefaultQuerier(MOCK_CONTRACT_ADDR, balance)
 	env := MockEnvBin(t)
 	info := MockInfoBin(t, "creator")
@@ -778,7 +778,7 @@ func TestMultipleInstances(t *testing.T) {
 	igasMeter1 := types.GasMeter(gasMeter1)
 	store1 := NewLookup(gasMeter1)
 	api := NewMockAPI()
-	querier := DefaultQuerier(MOCK_CONTRACT_ADDR, types.Coins{types.NewCoin(100, "ATOM")})
+	querier := DefaultQuerier(MOCK_CONTRACT_ADDR, types.Array[types.Coin]{types.NewCoin(100, "ATOM")})
 	env := MockEnvBin(t)
 	info := MockInfoBin(t, "regen")
 	msg := []byte(`{"verifier": "fred", "beneficiary": "bob"}`)
@@ -832,7 +832,7 @@ func TestSudo(t *testing.T) {
 	// instantiate it with this store
 	store := NewLookup(gasMeter1)
 	api := NewMockAPI()
-	balance := types.Coins{types.NewCoin(250, "ATOM")}
+	balance := types.Array[types.Coin]{types.NewCoin(250, "ATOM")}
 	querier := DefaultQuerier(MOCK_CONTRACT_ADDR, balance)
 	env := MockEnvBin(t)
 	info := MockInfoBin(t, "creator")
@@ -862,7 +862,7 @@ func TestSudo(t *testing.T) {
 	require.NotNil(t, dispatch.Bank.Send, "%#v", dispatch)
 	send := dispatch.Bank.Send
 	assert.Equal(t, "community-pool", send.ToAddress)
-	expectedPayout := types.Coins{types.NewCoin(700, "gold")}
+	expectedPayout := types.Array[types.Coin]{types.NewCoin(700, "gold")}
 	assert.Equal(t, expectedPayout, send.Amount)
 }
 
@@ -891,7 +891,7 @@ func TestDispatchSubmessage(t *testing.T) {
 		ID: id,
 		Msg: types.CosmosMsg{Bank: &types.BankMsg{Send: &types.SendMsg{
 			ToAddress: "friend",
-			Amount:    types.Coins{types.NewCoin(1, "token")},
+			Amount:    types.Array[types.Coin]{types.NewCoin(1, "token")},
 		}}},
 		ReplyOn: types.ReplyAlways,
 	}
@@ -940,9 +940,9 @@ func TestReplyAndQuery(t *testing.T) {
 
 	var id uint64 = 1234
 	data := []byte("foobar")
-	events := types.Events{{
+	events := types.Array[types.Event]{{
 		Type: "message",
-		Attributes: types.EventAttributes{{
+		Attributes: types.Array[types.EventAttribute]{{
 			Key:   "signer",
 			Value: "caller-addr",
 		}},
@@ -1067,7 +1067,7 @@ func TestQuery(t *testing.T) {
 	igasMeter1 := types.GasMeter(gasMeter1)
 	store := NewLookup(gasMeter1)
 	api := NewMockAPI()
-	querier := DefaultQuerier(MOCK_CONTRACT_ADDR, types.Coins{types.NewCoin(100, "ATOM")})
+	querier := DefaultQuerier(MOCK_CONTRACT_ADDR, types.Array[types.Coin]{types.NewCoin(100, "ATOM")})
 	env := MockEnvBin(t)
 	info := MockInfoBin(t, "creator")
 	msg := []byte(`{"verifier": "fred", "beneficiary": "bob"}`)
@@ -1110,7 +1110,7 @@ func TestHackatomQuerier(t *testing.T) {
 	igasMeter := types.GasMeter(gasMeter)
 	store := NewLookup(gasMeter)
 	api := NewMockAPI()
-	initBalance := types.Coins{types.NewCoin(1234, "ATOM"), types.NewCoin(65432, "ETH")}
+	initBalance := types.Array[types.Coin]{types.NewCoin(1234, "ATOM"), types.NewCoin(65432, "ETH")}
 	querier := DefaultQuerier("foobar", initBalance)
 
 	// make a valid query to the other address
@@ -1153,7 +1153,7 @@ func TestCustomReflectQuerier(t *testing.T) {
 	igasMeter := types.GasMeter(gasMeter)
 	store := NewLookup(gasMeter)
 	api := NewMockAPI()
-	initBalance := types.Coins{types.NewCoin(1234, "ATOM")}
+	initBalance := types.Array[types.Coin]{types.NewCoin(1234, "ATOM")}
 	querier := DefaultQuerier(MOCK_CONTRACT_ADDR, initBalance)
 	// we need this to handle the custom requests from the reflect contract
 	innerQuerier := querier.(*MockQuerier)

internal/api/mocks.go

@@ -412,8 +412,8 @@ type MockQuerier struct {
 
 var _ types.Querier = &MockQuerier{}
 
-func DefaultQuerier(contractAddr string, coins types.Coins) types.Querier {
-	balances := map[string]types.Coins{
+func DefaultQuerier(contractAddr string, coins types.Array[types.Coin]) types.Querier {
+	balances := map[string]types.Array[types.Coin]{
 		contractAddr: coins,
 	}
 	return &MockQuerier{
@@ -449,11 +449,11 @@ func (q MockQuerier) GasConsumed() uint64 {
 }
 
 type BankQuerier struct {
-	Balances map[string]types.Coins
+	Balances map[string]types.Array[types.Coin]
 }
 
-func NewBankQuerier(balances map[string]types.Coins) BankQuerier {
-	bal := make(map[string]types.Coins, len(balances))
+func NewBankQuerier(balances map[string]types.Array[types.Coin]) BankQuerier {
+	bal := make(map[string]types.Array[types.Coin], len(balances))
 	for k, v := range balances {
 		dst := make([]types.Coin, len(v))
 		copy(dst, v)
@@ -540,7 +540,7 @@ func (q ReflectCustom) Query(request json.RawMessage) ([]byte, error) {
 
 func TestBankQuerierAllBalances(t *testing.T) {
 	addr := "foobar"
-	balance := types.Coins{types.NewCoin(12345678, "ATOM"), types.NewCoin(54321, "ETH")}
+	balance := types.Array[types.Coin]{types.NewCoin(12345678, "ATOM"), types.NewCoin(54321, "ETH")}
 	q := DefaultQuerier(addr, balance)
 
 	// query existing account
@@ -576,7 +576,7 @@ func TestBankQuerierAllBalances(t *testing.T) {
 
 func TestBankQuerierBalance(t *testing.T) {
 	addr := "foobar"
-	balance := types.Coins{types.NewCoin(12345678, "ATOM"), types.NewCoin(54321, "ETH")}
+	balance := types.Array[types.Coin]{types.NewCoin(12345678, "ATOM"), types.NewCoin(54321, "ETH")}
 	q := DefaultQuerier(addr, balance)
 
 	// query existing account with matching denom

lib_test.go

@@ -139,7 +139,7 @@ func TestHappyPath(t *testing.T) {
 	// instantiate it with this store
 	store := api.NewLookup(gasMeter1)
 	goapi := api.NewMockAPI()
-	balance := types.Coins{types.NewCoin(250, "ATOM")}
+	balance := types.Array[types.Coin]{types.NewCoin(250, "ATOM")}
 	querier := api.DefaultQuerier(api.MOCK_CONTRACT_ADDR, balance)
 
 	// instantiate
@@ -184,7 +184,7 @@ func TestEnv(t *testing.T) {
 	// instantiate it with this store
 	store := api.NewLookup(gasMeter1)
 	goapi := api.NewMockAPI()
-	balance := types.Coins{types.NewCoin(250, "ATOM")}
+	balance := types.Array[types.Coin]{types.NewCoin(250, "ATOM")}
 	querier := api.DefaultQuerier(api.MOCK_CONTRACT_ADDR, balance)
 
 	// instantiate
@@ -264,7 +264,7 @@ func TestGetMetrics(t *testing.T) {
 	// instantiate it with this store
 	store := api.NewLookup(gasMeter1)
 	goapi := api.NewMockAPI()
-	balance := types.Coins{types.NewCoin(250, "ATOM")}
+	balance := types.Array[types.Coin]{types.NewCoin(250, "ATOM")}
 	querier := api.DefaultQuerier(api.MOCK_CONTRACT_ADDR, balance)
 
 	env := api.MockEnv()

types/env.go

@@ -39,5 +39,5 @@ type MessageInfo struct {
 	// Bech32 encoded sdk.AccAddress executing the contract
 	Sender HumanAddress `json:"sender"`
 	// Amount of funds send to the contract along with this message
-	Funds Coins `json:"funds"`
+	Funds Array[Coin] `json:"funds"`
 }

types/env_test.go

@@ -34,10 +34,14 @@ func TestMessageInfoHandlesMissingCoins(t *testing.T) {
 	require.NoError(t, err)
 
 	// we can unmarshal it properly into struct
+	expected := MessageInfo{
+		Sender: "baz",
+		Funds:  []Coin{},
+	}
 	var recover MessageInfo
 	err = json.Unmarshal(bz, &recover)
 	require.NoError(t, err)
-	assert.Equal(t, info, recover)
+	assert.Equal(t, expected, recover)
 
 	// make sure "funds":[] is in JSON
 	var raw map[string]json.RawMessage

types/ibc_test.go

@@ -92,3 +92,28 @@ func TestIbcTimeoutDeserialization(t *testing.T) {
 		Timestamp: 0,
 	}, timeout4)
 }
+
+func TestIbcReceiveResponseDeserialization(t *testing.T) {
+	var err error
+
+	// without acknowledgement
+	var resp IBCReceiveResponse
+	err = json.Unmarshal([]byte(`{"acknowledgement":null,"messages":[],"attributes":[],"events":[]}`), &resp)
+	require.NoError(t, err)
+	assert.Equal(t, IBCReceiveResponse{
+		Acknowledgement: nil,
+		Messages:        []SubMsg{},
+		Attributes:      []EventAttribute{},
+		Events:          []Event{},
+	}, resp)
+
+	// with acknowledgement
+	err = json.Unmarshal([]byte(`{"acknowledgement":"YWNr","messages":[],"attributes":[],"events":[]}`), &resp)
+	require.NoError(t, err)
+	assert.Equal(t, IBCReceiveResponse{
+		Acknowledgement: []byte("ack"),
+		Messages:        []SubMsg{},
+		Attributes:      []EventAttribute{},
+		Events:          []Event{},
+	}, resp)
+}