Skip to content

Commit 2a160ed

Browse files
colin-axnercolin-axner
authored
ICA OnChanOpenTry update + tests (#299)
* update OnChanOpenTry to match ICS specs * write OnChanOpenTry and OnChanOpenAck tests * update comment
1 parent a9cdf5a commit 2a160ed

File tree

6 files changed

+193
-23
lines changed

6 files changed

+193
-23
lines changed

‎modules/apps/27-interchain-accounts/keeper/account.go

+4-3
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,13 @@ func (k Keeper) InitInterchainAccount(ctx sdk.Context, connectionId, owner strin
4141
}
4242

4343
// Register interchain account if it has not already been created
44-
func (k Keeper) RegisterInterchainAccount(ctx sdk.Context, portId string) (types.InterchainAccountI, error) {
44+
func (k Keeper) RegisterInterchainAccount(ctx sdk.Context, portId string) {
4545
address := k.GenerateAddress(portId)
4646
account := k.accountKeeper.GetAccount(ctx, address)
4747

4848
if account != nil {
49-
return nil, sdkerrors.Wrap(types.ErrAccountAlreadyExist, account.String())
49+
// account already created, return no-op
50+
return
5051
}
5152

5253
interchainAccount := types.NewInterchainAccount(
@@ -57,7 +58,7 @@ func (k Keeper) RegisterInterchainAccount(ctx sdk.Context, portId string) (types
5758
k.accountKeeper.SetAccount(ctx, interchainAccount)
5859
_ = k.SetInterchainAccountAddress(ctx, portId, interchainAccount.Address)
5960

60-
return interchainAccount, nil
61+
return
6162
}
6263

6364
func (k Keeper) SetInterchainAccountAddress(ctx sdk.Context, portId string, address string) string {

‎modules/apps/27-interchain-accounts/keeper/handshake.go

+16-11
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ import (
1818
// there must not be an active channel for the specfied port identifier,
1919
// and the interchain accounts module must be able to claim the channel
2020
// capability.
21+
//
22+
// Controller Chain
2123
func (k Keeper) OnChanOpenInit(
2224
ctx sdk.Context,
2325
order channeltypes.Order,
@@ -50,9 +52,10 @@ func (k Keeper) OnChanOpenInit(
5052
return nil
5153
}
5254

53-
// register account (if it doesn't exist)
54-
// check if counterpary version is the same
55-
// TODO: remove ics27-1 hardcoded
55+
// OnChanOpenTry performs basic validation of the ICA channel
56+
// and registers a new interchain account (if it doesn't exist).
57+
//
58+
// Host Chain
5659
func (k Keeper) OnChanOpenTry(
5760
ctx sdk.Context,
5861
order channeltypes.Order,
@@ -67,19 +70,21 @@ func (k Keeper) OnChanOpenTry(
6770
if order != channeltypes.ORDERED {
6871
return sdkerrors.Wrapf(channeltypes.ErrInvalidChannelOrdering, "invalid channel ordering: %s, expected %s", order.String(), channeltypes.ORDERED.String())
6972
}
73+
if version != types.Version {
74+
return sdkerrors.Wrapf(types.ErrInvalidVersion, "got: %s, expected %s", version, types.Version)
75+
}
76+
if counterpartyVersion != types.Version {
77+
return sdkerrors.Wrapf(types.ErrInvalidVersion, "invalid counterparty version: %s, expected %s", counterpartyVersion, types.Version)
78+
}
7079

71-
// TODO: Check counterparty version
72-
// if counterpartyVersion != types.Version {
73-
// return sdkerrors.Wrapf(porttypes.ErrInvalidPort, "invalid counterparty version: %s, expected %s", counterpartyVersion, "ics20-1")
74-
// }
75-
76-
// Claim channel capability passed back by IBC module
80+
// On the host chain the capability may only be claimed during the OnChanOpenTry
81+
// The capability being claimed in OpenInit is for a controller chain (the port is different)
7782
if err := k.ClaimCapability(ctx, chanCap, host.ChannelCapabilityPath(portID, channelID)); err != nil {
78-
return sdkerrors.Wrap(channeltypes.ErrChannelCapabilityNotFound, err.Error())
83+
return err
7984
}
8085

8186
// Register interchain account if it does not already exist
82-
_, _ = k.RegisterInterchainAccount(ctx, counterparty.PortId)
87+
k.RegisterInterchainAccount(ctx, counterparty.PortId)
8388
return nil
8489
}
8590

‎modules/apps/27-interchain-accounts/keeper/handshake_test.go

+134
Original file line numberDiff line numberDiff line change
@@ -96,3 +96,137 @@ func (suite *KeeperTestSuite) TestOnChanOpenInit() {
9696
})
9797
}
9898
}
99+
100+
// ChainA is controller, ChainB is host chain
101+
func (suite *KeeperTestSuite) TestOnChanOpenTry() {
102+
var (
103+
channel *channeltypes.Channel
104+
path *ibctesting.Path
105+
chanCap *capabilitytypes.Capability
106+
counterpartyVersion string
107+
)
108+
109+
testCases := []struct {
110+
name string
111+
malleate func()
112+
expPass bool
113+
}{
114+
115+
{
116+
"success", func() {}, true,
117+
},
118+
{
119+
"invalid order - UNORDERED", func() {
120+
channel.Ordering = channeltypes.UNORDERED
121+
}, false,
122+
},
123+
{
124+
"invalid version", func() {
125+
channel.Version = "version"
126+
}, false,
127+
},
128+
{
129+
"invalid counterparty version", func() {
130+
counterpartyVersion = "version"
131+
}, false,
132+
},
133+
{
134+
"capability already claimed", func() {
135+
err := suite.chainB.GetSimApp().ScopedICAKeeper.ClaimCapability(suite.chainB.GetContext(), chanCap, host.ChannelCapabilityPath(path.EndpointB.ChannelConfig.PortID, path.EndpointB.ChannelID))
136+
suite.Require().NoError(err)
137+
}, false,
138+
},
139+
}
140+
141+
for _, tc := range testCases {
142+
tc := tc
143+
144+
suite.Run(tc.name, func() {
145+
suite.SetupTest() // reset
146+
path = NewICAPath(suite.chainA, suite.chainB)
147+
owner := "owner"
148+
counterpartyVersion = types.Version
149+
suite.coordinator.SetupConnections(path)
150+
151+
err := InitInterchainAccount(path.EndpointA, owner)
152+
suite.Require().NoError(err)
153+
154+
// default values
155+
counterparty := channeltypes.NewCounterparty(path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID)
156+
channel = &channeltypes.Channel{
157+
State: channeltypes.TRYOPEN,
158+
Ordering: channeltypes.ORDERED,
159+
Counterparty: counterparty,
160+
ConnectionHops: []string{path.EndpointB.ConnectionID},
161+
Version: types.Version,
162+
}
163+
164+
chanCap, err = suite.chainB.App.GetScopedIBCKeeper().NewCapability(suite.chainB.GetContext(), host.ChannelCapabilityPath(path.EndpointB.ChannelConfig.PortID, path.EndpointB.ChannelID))
165+
suite.Require().NoError(err)
166+
167+
tc.malleate() // explicitly change fields in channel and testChannel
168+
169+
err = suite.chainB.GetSimApp().ICAKeeper.OnChanOpenTry(suite.chainB.GetContext(), channel.Ordering, channel.GetConnectionHops(),
170+
path.EndpointB.ChannelConfig.PortID, path.EndpointB.ChannelID, chanCap, channel.Counterparty, channel.GetVersion(),
171+
counterpartyVersion,
172+
)
173+
174+
if tc.expPass {
175+
suite.Require().NoError(err)
176+
} else {
177+
suite.Require().Error(err)
178+
}
179+
180+
})
181+
}
182+
}
183+
184+
// ChainA is controller, ChainB is host chain
185+
func (suite *KeeperTestSuite) TestOnChanOpenAck() {
186+
var (
187+
path *ibctesting.Path
188+
counterpartyVersion string
189+
)
190+
191+
testCases := []struct {
192+
name string
193+
malleate func()
194+
expPass bool
195+
}{
196+
197+
{
198+
"success", func() {}, true,
199+
},
200+
}
201+
202+
for _, tc := range testCases {
203+
tc := tc
204+
205+
suite.Run(tc.name, func() {
206+
suite.SetupTest() // reset
207+
path = NewICAPath(suite.chainA, suite.chainB)
208+
owner := "owner"
209+
counterpartyVersion = types.Version
210+
suite.coordinator.SetupConnections(path)
211+
212+
err := InitInterchainAccount(path.EndpointA, owner)
213+
suite.Require().NoError(err)
214+
215+
err = path.EndpointB.ChanOpenTry()
216+
suite.Require().NoError(err)
217+
218+
tc.malleate() // explicitly change fields in channel and testChannel
219+
220+
err = suite.chainA.GetSimApp().ICAKeeper.OnChanOpenAck(suite.chainA.GetContext(),
221+
path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID, counterpartyVersion,
222+
)
223+
224+
if tc.expPass {
225+
suite.Require().NoError(err)
226+
} else {
227+
suite.Require().Error(err)
228+
}
229+
230+
})
231+
}
232+
}

‎modules/apps/27-interchain-accounts/keeper/keeper.go

+5
Original file line numberDiff line numberDiff line change
@@ -161,3 +161,8 @@ func (k Keeper) IsActiveChannel(ctx sdk.Context, portId string) bool {
161161
_, found := k.GetActiveChannel(ctx, portId)
162162
return found
163163
}
164+
165+
// AuthenticateCapability wraps the scopedKeeper's AuthenticateCapability function
166+
func (k Keeper) AuthenticateCapability(ctx sdk.Context, cap *capabilitytypes.Capability, name string) bool {
167+
return k.scopedKeeper.AuthenticateCapability(ctx, cap, name)
168+
}

‎modules/apps/27-interchain-accounts/keeper/keeper_test.go

+24
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import (
66
"github.com/stretchr/testify/suite"
77

88
"github.com/cosmos/ibc-go/modules/apps/27-interchain-accounts/types"
9+
channeltypes "github.com/cosmos/ibc-go/modules/core/04-channel/types"
910
ibctesting "github.com/cosmos/ibc-go/testing"
1011
)
1112

@@ -31,10 +32,33 @@ func NewICAPath(chainA, chainB *ibctesting.TestChain) *ibctesting.Path {
3132
path := ibctesting.NewPath(chainA, chainB)
3233
path.EndpointA.ChannelConfig.PortID = types.PortID
3334
path.EndpointB.ChannelConfig.PortID = types.PortID
35+
path.EndpointA.ChannelConfig.Order = channeltypes.ORDERED
36+
path.EndpointB.ChannelConfig.Order = channeltypes.ORDERED
37+
path.EndpointA.ChannelConfig.Version = types.Version
38+
path.EndpointB.ChannelConfig.Version = types.Version
3439

3540
return path
3641
}
3742

43+
// InitInterchainAccount is a helper function for starting the channel handshake
44+
func InitInterchainAccount(endpoint *ibctesting.Endpoint, owner string) error {
45+
portID := endpoint.Chain.GetSimApp().ICAKeeper.GeneratePortId(owner, endpoint.ConnectionID)
46+
channelSequence := endpoint.Chain.App.GetIBCKeeper().ChannelKeeper.GetNextChannelSequence(endpoint.Chain.GetContext())
47+
48+
if err := endpoint.Chain.GetSimApp().ICAKeeper.InitInterchainAccount(endpoint.Chain.GetContext(), endpoint.ConnectionID, owner); err != nil {
49+
return err
50+
}
51+
52+
// commit state changes for proof verification
53+
endpoint.Chain.App.Commit()
54+
endpoint.Chain.NextBlock()
55+
56+
// update port/channel ids
57+
endpoint.ChannelID = channeltypes.FormatChannelIdentifier(channelSequence)
58+
endpoint.ChannelConfig.PortID = portID
59+
return nil
60+
}
61+
3862
func TestKeeperTestSuite(t *testing.T) {
3963
suite.Run(t, new(KeeperTestSuite))
4064
}

‎modules/apps/27-interchain-accounts/types/errors.go

+10-9
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,14 @@ import (
55
)
66

77
var (
8-
ErrUnknownPacketData = sdkerrors.Register(ModuleName, 1, "Unknown packet data")
9-
ErrAccountAlreadyExist = sdkerrors.Register(ModuleName, 2, "Account already exist")
10-
ErrPortAlreadyBound = sdkerrors.Register(ModuleName, 3, "Port is already bound for address")
11-
ErrUnsupportedChain = sdkerrors.Register(ModuleName, 4, "Unsupported chain")
12-
ErrInvalidOutgoingData = sdkerrors.Register(ModuleName, 5, "Invalid outgoing data")
13-
ErrInvalidRoute = sdkerrors.Register(ModuleName, 6, "Invalid route")
14-
ErrInterchainAccountNotFound = sdkerrors.Register(ModuleName, 7, "Interchain account not found")
15-
ErrInterchainAccountAlreadySet = sdkerrors.Register(ModuleName, 8, "Interchain Account is already set")
16-
ErrActiveChannelNotFound = sdkerrors.Register(ModuleName, 9, "No active channel for this owner")
8+
ErrUnknownPacketData = sdkerrors.Register(ModuleName, 2, "unknown packet data")
9+
ErrAccountAlreadyExist = sdkerrors.Register(ModuleName, 3, "account already exist")
10+
ErrPortAlreadyBound = sdkerrors.Register(ModuleName, 4, "port is already bound for address")
11+
ErrUnsupportedChain = sdkerrors.Register(ModuleName, 5, "unsupported chain")
12+
ErrInvalidOutgoingData = sdkerrors.Register(ModuleName, 6, "invalid outgoing data")
13+
ErrInvalidRoute = sdkerrors.Register(ModuleName, 7, "invalid route")
14+
ErrInterchainAccountNotFound = sdkerrors.Register(ModuleName, 8, "Interchain Account not found")
15+
ErrInterchainAccountAlreadySet = sdkerrors.Register(ModuleName, 9, "Interchain Account is already set")
16+
ErrActiveChannelNotFound = sdkerrors.Register(ModuleName, 10, "no active channel for this owner")
17+
ErrInvalidVersion = sdkerrors.Register(ModuleName, 11, "invalid interchain accounts version")
1718
)

0 commit comments

Comments
 (0)