Cosmwasmpool spec #4810

iboss-ptk · 2023-03-31T14:44:58Z

What is the purpose of the change

Adding specification to CosmWasm pool

p0mvn

Great work and thank you @iboss-ptk .

Left some questions and comments. Let me know what you think

p0mvn · 2023-03-31T15:13:03Z

x/cosmwasmpool/README.md

+The CosmWasm contract that is to be instanitiated needs to implement [CosmWasm Pool Contract Interface](#cosmwasm-pool-contract-interface) and store it on chain first. Then new pool can be created by sending `MsgCreateCosmWasmPool`.
+
+
+`MsgCreateCosmWasmPool` contains `InstantiateMsg`, which is a message that will be passed to the CosmWasm contract when it is instantiated. The structure of the message is defined by the contract developer, and can contain any information that the contract needs to be instantiated. JSON format is used for `InstantiateMsg`.


Should we decide on how code id should be handled?

I think we should be saving the code id on chain but having the flexibility to upgrade it via gov prop. WDYT?

Not sure if we need to save code id if we already save address, since we can query it from wasm module unless we have explicit need to store.

For gov prop, I think it would be nice if we can have prop type where it does

store code and init pool

store code and migrate

Else we need 2 separated gov prop every time adding / upgrading new pool type. It might not be very frequent but if it's not too hard to do I think it make sense to have them.

I was thinking that it might be useful from a security standpoint.

However, on more thought, I agree that it is not needed.

We can make only admin (module account) be allowed to migrate a contract. The migration is controlled by governance.

store code and migrate

I agree on having this.

store code and init pool

Why would we also init pool? Shouldn't that be done by MsgCreateCosmWasmPool separately?

Once we agree on this, could you please update the spec for migration logic and gov props?

Why would we also init pool? Shouldn't that be done by MsgCreateCosmWasmPool separately?

MsgCreateCosmWasmPool only create pool out of existing code stored on chain.

x/cosmwasmpool/README.md

p0mvn · 2023-03-31T15:29:35Z

x/cosmwasmpool/README.md

+    /// GetTotalShares returns the total number of LP shares in the pool
+    #[returns(TotalSharesResponse)]
+    GetTotalShares {},


This is not on the PoolI anymore. Ref: #4801

So total pool liquidity is still in PoolModuleI, total shares is removed from all generic interface.

What's the difference between PoolI and PoolModuleI?

PoolI is a pool interface that is implemented by pool models. These pool models are also written to state.

Examples of pool models:

balancer

stableswap

concentrated liquidity

we are going to add a cosmwasm pool model.

PoolModuleI is an interface implemented by the SDK module keepers encapsulating these pool models.

We have:

x/gamm keeper

x/concentrated-liquidity keeper

we are going to add:

x/cosmwasm keeper

x/cosmwasmpool/README.md

nicolaslara

This looks great! I think using sylvia's interfaces on transmuter will be helpful. There can be a Pool trait that any struct can implement to become a pool

Co-authored-by: Roman <[email protected]>

iboss-ptk · 2023-04-03T10:57:36Z

This looks great! I think using sylvia's interfaces on transmuter will be helpful. There can be a Pool trait that any struct can implement to become a pool

Exactly! Planning on extracting what described in spec as sylvia pool interface! @nicolaslara

p0mvn · 2023-04-03T15:21:34Z

What is the plan with incentives for x/cosmwasm pools? Could you document that as well, please? @iboss-ptk

iboss-ptk · 2023-04-04T11:03:36Z

What is the plan with incentives for x/cosmwasm pools? Could you document that as well, please? @iboss-ptk

@p0mvn will look into it!

p0mvn · 2023-04-04T16:00:43Z

Just thought of another consideration - we should probably mention how twap is handled. It probably does not make sense to have it integrated it for transmuter but might be worthwhile for other pools

iboss-ptk · 2023-04-07T10:41:30Z

@p0mvn Add more info about incentives, I'm not really familiar with the module, let me know if I miss anything or it's unclear.

github-actions · 2023-04-22T00:02:06Z

This pull request has been automatically marked as stale because it has not had any recent activity. It will be closed if no further activity occurs. Thank you!

github-actions · 2023-05-11T00:02:24Z

This pull request has been automatically marked as stale because it has not had any recent activity. It will be closed if no further activity occurs. Thank you!

p0mvn · 2023-05-22T13:05:01Z

x/cosmwasmpool/README.md

+}
+```
+
+(TBD) On how to handle the deactivation operationally.


We can have a gov prop + sudo message for toggling the is_active flag. WDYT?

p0mvn · 2023-05-22T13:49:00Z

I propose that we do not integrate this pool type into x/twap for now. No specific code changes should be required for this but can you please update the spec? Should be as simple as mentioning that x/twap is not implemented for cosmwasm pools but can be in the future if there is a need

p0mvn · 2023-05-23T01:27:27Z

TODO for me: check if we can use tokenfactory for representing shares

p0mvn

LGTM. Thank you @iboss-ptk

I will be submitting further updates in future PRs

* spec: creating cosmwasm pool * spec: swap * spec: deactivating * spec: cosmwasm pool contract interface * Update x/cosmwasmpool/README.md Co-authored-by: Roman <[email protected]> * decide on keeping swap on sudo and rephrase sudo's problem as spec * remove get total shares * update create pool flow per comment * update explanation on ensuring token in * update incentives & shares section * update swap_fee explanation * mention about no twap integration --------- Co-authored-by: Roman <[email protected]>

iboss-ptk requested a review from p0mvn March 31, 2023 14:45

github-actions bot added C:docs Improvements or additions to documentation C:x/concentrated-liquidity labels Mar 31, 2023

iboss-ptk added 4 commits March 31, 2023 21:48

spec: creating cosmwasm pool

2ae7e96

spec: swap

ea224b0

spec: deactivating

b42923f

spec: cosmwasm pool contract interface

3014f77

iboss-ptk force-pushed the cosmwasmpool-spec branch from 7d1f8df to 3014f77 Compare March 31, 2023 14:48

github-actions bot removed the C:x/concentrated-liquidity label Mar 31, 2023

p0mvn added the V:state/compatible/no_backport State machine compatible PR, depends on prior breaks label Mar 31, 2023

p0mvn reviewed Mar 31, 2023

View reviewed changes

p0mvn requested review from nicolaslara and czarcas7ic March 31, 2023 15:32

p0mvn mentioned this pull request Mar 31, 2023

feat/docs(CWPool): contract messages and basic readme #4792

Merged

nicolaslara reviewed Apr 3, 2023

View reviewed changes

x/cosmwasmpool/README.md Show resolved Hide resolved

nicolaslara reviewed Apr 3, 2023

View reviewed changes

x/cosmwasmpool/README.md Outdated Show resolved Hide resolved

nicolaslara reviewed Apr 3, 2023

View reviewed changes

Update x/cosmwasmpool/README.md

bd7c44a

Co-authored-by: Roman <[email protected]>

iboss-ptk added 4 commits April 3, 2023 18:28

decide on keeping swap on sudo and rephrase sudo's problem as spec

3eab685

remove get total shares

1d54cc6

update create pool flow per comment

185d8f9

update explanation on ensuring token in

6f7ba34

update incentives & shares section

1efdfc0

github-actions bot added the Stale label Apr 22, 2023

update swap_fee explanation

c9fc457

github-actions bot removed the Stale label Apr 26, 2023

github-actions bot added the Stale label May 11, 2023

p0mvn removed the Stale label May 11, 2023

p0mvn reviewed May 22, 2023

View reviewed changes

mention about no twap integration

e2181f9

p0mvn mentioned this pull request May 28, 2023

feat: x/cosmwasmpool module and transmuter integration #5327

Closed

6 tasks

Merge branch 'main' into cosmwasmpool-spec

5e5505a

p0mvn added the A:no-changelog label May 29, 2023

p0mvn approved these changes May 29, 2023

View reviewed changes

p0mvn merged commit 36c7d81 into main May 29, 2023

p0mvn deleted the cosmwasmpool-spec branch May 29, 2023 18:16

p0mvn mentioned this pull request May 29, 2023

docs(x/cosmwasmpool): code id whitelist via gov props #5346

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Cosmwasmpool spec #4810

Cosmwasmpool spec #4810

iboss-ptk commented Mar 31, 2023

p0mvn left a comment

p0mvn Mar 31, 2023

iboss-ptk Apr 3, 2023 •

edited

Loading

p0mvn May 22, 2023

p0mvn May 22, 2023

iboss-ptk May 23, 2023

p0mvn Mar 31, 2023

iboss-ptk Apr 3, 2023

p0mvn May 22, 2023

nicolaslara left a comment

iboss-ptk commented Apr 3, 2023

p0mvn commented Apr 3, 2023 •

edited

Loading

iboss-ptk commented Apr 4, 2023 •

edited

Loading

p0mvn commented Apr 4, 2023

iboss-ptk commented Apr 7, 2023

github-actions bot commented Apr 22, 2023

github-actions bot commented May 11, 2023

p0mvn May 22, 2023

iboss-ptk May 23, 2023

p0mvn commented May 22, 2023

p0mvn commented May 23, 2023

p0mvn left a comment

		The CosmWasm contract that is to be instanitiated needs to implement [CosmWasm Pool Contract Interface](#cosmwasm-pool-contract-interface) and store it on chain first. Then new pool can be created by sending `MsgCreateCosmWasmPool`.


		`MsgCreateCosmWasmPool` contains `InstantiateMsg`, which is a message that will be passed to the CosmWasm contract when it is instantiated. The structure of the message is defined by the contract developer, and can contain any information that the contract needs to be instantiated. JSON format is used for `InstantiateMsg`.

Cosmwasmpool spec #4810

Cosmwasmpool spec #4810

Conversation

iboss-ptk commented Mar 31, 2023

What is the purpose of the change

p0mvn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

iboss-ptk Apr 3, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolaslara left a comment

Choose a reason for hiding this comment

iboss-ptk commented Apr 3, 2023

p0mvn commented Apr 3, 2023 • edited Loading

iboss-ptk commented Apr 4, 2023 • edited Loading

p0mvn commented Apr 4, 2023

iboss-ptk commented Apr 7, 2023

github-actions bot commented Apr 22, 2023

github-actions bot commented May 11, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

p0mvn commented May 22, 2023

p0mvn commented May 23, 2023

p0mvn left a comment

Choose a reason for hiding this comment

iboss-ptk Apr 3, 2023 •

edited

Loading

p0mvn commented Apr 3, 2023 •

edited

Loading

iboss-ptk commented Apr 4, 2023 •

edited

Loading