feat/spike: CosmWasm Pool Type and Module #4675

p0mvn · 2023-03-20T02:48:13Z

Closes: #4389

What is the purpose of the change

The CosmWasm Pool Module is an extension for the Osmosis pools, aiming to create a custom module that allows users to create and manage liquidity pools backed by CosmWasm smart contracts. The feature enables developers to build and deploy custom smart contracts that can be integrated with the rest of the pool types on the Osmosis chain.

The module is built on top of the CosmWasm smart contracting platform, which provides a secure and efficient way to develop and execute WebAssembly (Wasm) smart contracts on the Cosmos SDK.

Having pools in CosmWasm provides several benefits, one of which is avoiding the need for chain upgrades when introducing new functionalities or modifying existing ones related to liquidity pools. This advantage is particularly important in the context of speed of development and iteration.

An example of a CosmWasm pool type: https://github.com/osmosis-labs/transmuter

Brief Changelog

Testing and Verifying

TBD after getting concept-ACK from @iboss-ptk

Open Quesitons

What to do with the creatorAddress in InitializePool?
How to resolve codec issues around PoolI

Currently, getting the following:

go test -mod=readonly -tags='ledger test_ledger_mock norace' github.com/osmosis-labs/osmosis/v15/x/mint/client/cli
--- FAIL: TestIntegrationTestSuite (5.07s)
    cli_test.go:29: setting up integration test suite
    network.go:173: acquiring test network lock
    network.go:178: created temporary directory: /tmp/TestIntegrationTestSuite1806756216/001/osmosis-code-test361649419
    network.go:187: preparing test network...
    network.go:381: starting test network...
    network.go:383: 
                Error Trace:    /root/go/pkg/mod/github.com/osmosis-labs/[email protected]/testutil/network/network.go:383
                                                        /root/osmosis/x/mint/client/cli/cli_test.go:33
                                                        /root/go/pkg/mod/github.com/stretchr/[email protected]/suite/suite.go:154
                                                        /root/osmosis/x/mint/client/cli/cli_test.go:124
                Error:          Received unexpected error:
                                unable to create codec descriptor: unable to get proto name for implementing type / for interface osmosis.poolmanager.v1beta1.PoolI
                Test:           TestIntegrationTestSuite
FAIL
FAIL    github.com/osmosis-labs/osmosis/v15/x/mint/client/cli   5.137s
FAIL

The reason is because the struct implementing PoolI is a Go Struct. This is done so that Pool struct can have a field for WasmKeeper. Otherwise, the pool struct is unable to interact with the contract for querying spot price and other pool operations.

UPDATE: #4675 (comment)

Documentation and Release Note

Does this pull request introduce a new feature or user-facing behavior changes? yes
Is a relevant changelog entry added to the Unreleased section in CHANGELOG.md? TBD
How is the feature or change documented? yes

p0mvn · 2023-03-20T04:44:31Z

x/cosmwasmpool/model/codec.go

+	registry.RegisterInterface(
+		"osmosis.poolmanager.v1beta1.PoolI",
+		(*poolmanagertypes.PoolI)(nil),
+		&CosmWasmPool{},
+	)
+	registry.RegisterInterface(
+		"osmosis.cosmwasmpool.v1beta1.CosmWasmExtension",
+		(*types.CosmWasmExtension)(nil),
+		&CosmWasmPool{},


This code block is the reason why fdc16a4 is needed.

I'm open to suggestions on how to reduce the need for the boilerplate in fdc16a4

The way this works is that there is a proto-generated CosmWasmPool model that is written to state. It only implements PoolI and CosmWasmExtensions for registering interfaces.

There is also a Go struct wrapper Pool. It is not proto-generated because it must contain WasmKeeper for interacting with the contract. As a result, I'm unable to RegisterInterfaces for Pool and have to rely on the verbose hack in fdc16a4

iboss-ptk

What to do with the creatorAddress in InitializePool?

creatorAddress should essentially be the same as contract initiator I suppose? Unless I'm missing anything.

referring to question asked in Slack:

Use Go mocks for the wasmKeeper and contractKeeper to mock out the responses of instantiate msg, query msg and sudo msg in tests

I think this makes a lot of sense for as unit tests

What is the ETA on the contract that I can use for testing this?

I will make transmuter conform pool interface within this week. Will quickly release and document new beaker features and back to this task :)

please also refer to:
#4389 (comment)

p0mvn · 2023-03-27T00:18:58Z

x/cosmwasmpool/pool_module_test.go

+			// Assert that pool and swapper balances are changes
+			// TODO / Question for Boss: this check is failint because the originalPoolBalance is empty.
+			// I would expect it to equal to coins that were added to the pool in the beginning of the test
+			// via the join pool message (tc.initialCoins).
+			expectedPoolBalances := originalPoolBalances.Add(tc.tokenIn).Sub(sdk.NewCoins(tc.expectedTokenOut))
+			afterSwapPoolBalances := s.App.BankKeeper.GetAllBalances(s.Ctx, sdk.AccAddress(pool.GetContractAddress()))
+
+			s.Require().Equal(expectedPoolBalances.String(), afterSwapPoolBalances.String())


@iboss-ptk it seems to me that pool's balances are not updated upon joining the pool. Should this be handles inside a contract? That is when a user executes join message via contract, the pool's balance is updated with the joined tokens?

github-actions · 2023-04-14T00:02:12Z

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!

… into roman/cosmwasm-pool

p0mvn · 2023-05-28T22:04:15Z

Closing in favor of: #5327

p0mvn added 2 commits March 19, 2023 22:34

feat/spike: CosmWasm Pool Type

77efd89

lint

a9bb029

p0mvn requested a review from iboss-ptk March 20, 2023 02:48

github-actions bot added C:app-wiring Changes to the app folder C:CLI C:docs Improvements or additions to documentation C:x/gamm Changes, features and bugs related to the gamm module. C:x/poolmanager labels Mar 20, 2023

p0mvn added the V:state/breaking State machine breaking PR label Mar 20, 2023

improve module README

9dc9746

p0mvn mentioned this pull request Mar 20, 2023

[EPIC]: CosmWasm Pool Type #4389

Closed

TestInitializePool

cb87d61

p0mvn commented Mar 20, 2023

View reviewed changes

p0mvn mentioned this pull request Mar 20, 2023

feat(CL): x/poolmanager spot price query for concentrated liquidity #4682

Merged

iboss-ptk reviewed Mar 21, 2023

View reviewed changes

iboss-ptk mentioned this pull request Mar 24, 2023

CosmWasm pool type integration osmosis-labs/transmuter#3

Merged

p0mvn force-pushed the roman/cosmwasm-pool branch from fdc16a4 to 8804f74 Compare March 26, 2023 18:48

github-actions bot removed the C:x/gamm Changes, features and bugs related to the gamm module. label Mar 26, 2023

p0mvn commented Mar 27, 2023

View reviewed changes

p0mvn mentioned this pull request Mar 28, 2023

feat: x/cosmwasmpool proto and query boilerplate #4764

Merged

p0mvn force-pushed the roman/cosmwasm-pool branch 2 times, most recently from 69e638c to 7e5c034 Compare March 30, 2023 01:26

p0mvn mentioned this pull request Mar 30, 2023

feat(osmoutils): cosmwasm query and message wrappers #4791

Merged

progress

2594331

p0mvn force-pushed the roman/cosmwasm-pool branch from d229d1c to 2594331 Compare March 30, 2023 03:31

p0mvn mentioned this pull request Mar 30, 2023

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

Merged

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

github-actions bot closed this Apr 21, 2023

Merge branch 'main' into roman/cosmwasm-pool

9d71095

p0mvn reopened this May 26, 2023

p0mvn added 2 commits May 26, 2023 00:17

merge

e2c104c

Merge branch 'roman/cosmwasm-pool' of github.com:osmosis-labs/osmosis…

162e124

… into roman/cosmwasm-pool

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

Merge branch 'main' into roman/cosmwasm-pool

008f1cf

github-actions bot removed the C:docs Improvements or additions to documentation label May 26, 2023

p0mvn added 11 commits May 26, 2023 20:20

fix TestCalcOutAmtGivenIn_SwapOutAmtGivenIn

d810ed2

lates - reset this commit when continuing

87bd019

TestCalcInAmtGivenOut_SwapInAmtGivenOut

de97f86

clean up tests

856eb89

implement GetPools

e40f76e

updates

6841b01

clean up

9b3b2c5

TestGetTotalPoolLiquidity

3999d23

clean up

c073b54

clean up

b9da703

updates

40beee1

github-actions bot removed the Stale label May 27, 2023

p0mvn closed this May 28, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat/spike: CosmWasm Pool Type and Module #4675

feat/spike: CosmWasm Pool Type and Module #4675

p0mvn commented Mar 20, 2023 •

edited

Loading

p0mvn Mar 20, 2023

iboss-ptk left a comment •

edited

Loading

p0mvn Mar 27, 2023

github-actions bot commented Apr 14, 2023

p0mvn commented May 28, 2023

feat/spike: CosmWasm Pool Type and Module #4675

feat/spike: CosmWasm Pool Type and Module #4675

Conversation

p0mvn commented Mar 20, 2023 • edited Loading

What is the purpose of the change

Brief Changelog

Testing and Verifying

Open Quesitons

Documentation and Release Note

p0mvn Mar 20, 2023

Choose a reason for hiding this comment

iboss-ptk left a comment • edited Loading

Choose a reason for hiding this comment

p0mvn Mar 27, 2023

Choose a reason for hiding this comment

github-actions bot commented Apr 14, 2023

p0mvn commented May 28, 2023

p0mvn commented Mar 20, 2023 •

edited

Loading

iboss-ptk left a comment •

edited

Loading