All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- #3608 Make it possible to state export from any directory.
- #3611 Introduce osmocli, to automate thousands of lines of CLI boilerplate
- #3634 (Makefile) Ensure correct golang version in make build and make install. (Thank you @jhernandezb )
This release includes stableswap, and expands the IBC safety & composability functionality of Osmosis. The primary features are:
- Gamm:
- Introduction of the stableswap pool type
- Multi-hop swapfee reduction
- Filtered queries to help front-ends
- Adding a spot price v2 query
- spotprice v1beta1 had baseassetdenom and quoteassetdenom backwards.
- All contracts and integrators should switch to the v2 query from now on.
- Adding more queries for contract developers
- Force unpooling is now enableable by governance
- IBC features
- Upgrade to IBC v3.4.0
- Added IBC rate limiting, to increase safety of bridged assets
- Allow ICS-20 to call into cosmwasm contracts
- Cosmwasm
- Upgrade to cosmwasm v0.29.x
- Inclusion of requested queries for contract developers
- #2739,#3356 Add pool type query, and add it to stargate whitelist
- #2956 Add queries for calculating amount of shares/tokens you get by providing X tokens/shares when entering/exiting a pool
- #3217 Add
CalcJoinPoolShares
,CalcExitPoolCoinsFromShares
,CalcJoinPoolNoSwapShares
to the registered Stargate queries list. - #3313 Upgrade to IBC v3.4.0, allowing for IBC transfers with metadata.
- #3335 Add v2 spot price queries
- The v1beta1 queries actually have base asset and quote asset reversed, so you were always getting 1/correct spot price. People fixed this by reordering the arguments.
- This PR adds v2 queries for doing the correct thing, and giving people time to migrate from v1beta1 queries to v2.
- It also changes cosmwasm to only allow the v2 queries, as no contracts on Osmosis mainnet uses the v1beta1 queries.
- #2803 Fix total pool liquidity CLI query.
- #2914 Remove out of gas panics from node logs
- #2937 End block ordering - staking after gov and module sorting.
- #2923 TWAP calculation now errors if it uses records that have errored previously.
- #3312 Add better panic catches within GAMM txs
- #2804 Improve error handling and messages when parsing pool assets.
- #3035 Remove
PokePool
fromPoolI
interface. Define on a new WeightedPoolExtension` instead. - #3214 Add basic CLI query support for TWAP.
This release includes several cosmwasm-developer and appchain-ecosystem affecting upgrades:
- TWAP - Time weighted average prices for all AMM pools
- Cosmwasm contract developer facing features
- Enabling select queries for cosmwasm contracts
- Add message responses to gamm messages, to remove the neccessity of bindings
- Allow specifying denom metadata from tokenfactory
- Enabling Interchain accounts (for real this time)
- Upgrading IBC to v3.3.0
- Consistently makes authz work with ledger for all messages
The release also contains the following changes affecting Osmosis users and node operators
- Fixing State Sync
- Enabling expedited proposals
This upgrade also adds a number of safety and API boundary improving changes to the codebase. While not state machine breaking, this release also includes the revamped Osmosis simulator, which acts as a fuzz testing tool tailored for the SDK state machine.
- #2477 Tokenfactory burn msg clash with sdk
- TypeMsgBurn: from "burn" to "tf_burn"
- TypeMsgMint: from "mint" to "tf_mint"
- #2222 Add scaling factors to MsgCreateStableswapPool
- #1889 Add proto responses to gamm LP messages:
- MsgJoinPoolResponse: share_out_amount and token_in fields
- MsgExitPoolResponse: token_out field
- #1825 Fixes Interchain Accounts (host side) by adding it to AppModuleBasics
- #1994 Removed bech32ibc module
- #2016 Add fixed 10000 gas cost for each Balancer swap
- #2193 Add TwapKeeper to the Osmosis app
- #2227 Enable charging fee in base denom for
CreateGauge
andAddToGauge
. - #2283 x/incentives: refactor
CreateGauge
andAddToGauge
fees to use txfees denom - #2206 Register all Amino interfaces and concrete types on the authz Amino codec. This will allow the authz module to properly serialize and de-serializes instances using Amino.
- #2405 Make SpotPrice have a max value of 2^160, and no longer be able to panic
- #2473 x/superfluid
AddNewSuperfluidAsset
now returns error, if any occurs instead of ignoring it. - #2714 Upgrade wasmd to v0.28.0.
- Remove x/Bech32IBC
- #2160 Clean up GAMM keeper (move
x/gamm/keeper/params.go
contents intox/gamm/keeper/keeper.go
, replace all uses ofPoolNumber
withPoolId
, moveSetStableSwapScalingFactors
to stableswap package, and delete marshal_bench_test.go and grpc_query_internal_test.go) - #1987 Remove
GammKeeper.GetNextPoolNumberAndIncrement
in favor of the non-mutativeGammKeeper.GetNextPoolNumber
. - #1667 Move wasm-bindings code out of app package into its own root level package.
- #2013 Make
SetParams
,SetPool
,SetTotalLiquidity
, andSetDenomLiquidity
GAMM APIs private - #1857 x/mint rename GetLastHalvenEpochNum to GetLastReductionEpochNum
- #2133 Add
JoinPoolNoSwap
andCalcJoinPoolNoSwapShares
to GAMM pool interface and routeJoinPoolNoSwap
in pool_service.go to new method in pool interface - #2353 Re-enable stargate query via whitelsit
- #2394 Remove unused interface methods from expected keepers of each module
- #2390 x/mint remove unused mintCoins parameter from AfterDistributeMintedCoin
- #2418 x/mint remove SetInitialSupplyOffsetDuringMigration from keeper
- #2417 x/mint unexport keeper
SetLastReductionEpochNum
,getLastReductionEpochNum
,CreateDeveloperVestingModuleAccount
, andMintCoins
- #2587 remove encoding config argument from NewOsmosisApp x
- #2387 Upgrade to IBC v3.2.0, which allows for sending/receiving IBC tokens with slashes.
- [#1312] Stableswap: Createpool logic
- [#1230] Stableswap CFMM equations
- [#1429] solver for multi-asset CFMM
- [#1539] Superfluid: Combine superfluid and staking query on querying delegation by delegator
- [#2223] Tokenfactory: Add SetMetadata functionality
- #2086
ReplacePoolIncentivesProposal
ProposalType() returns correct value ofProposalTypeReplacePoolIncentives
instead ofProposalTypeUpdatePoolIncentives
- 1930 Ensure you can't
JoinPoolNoSwap
tokens that are not in the pool - 2186 Remove liquidity event that was emitted twice per message.
- #2515 Emit events from functions implementing epoch hooks'
panicCatchingEpochHook
cacheCtx - #2526 EpochHooks interface methods (and hence modules implementing the hooks) return error instead of panic
- #1893 Change
EpochsKeeper.SetEpochInfo
toAddEpochInfo
, which has more safety checks with it. (Makes it suitable to be called within upgrades) - #2396 x/mint remove unused mintCoins parameter from AfterDistributeMintedCoin
- #2399 Remove unused interface methods from expected keepers of each module
- #2401 Update Go import paths to v11
- 2291 Remove liquidity event that was emitted twice per message
- 2288 Fix swagger docs and swagger generation
- #2237 Enable charging fee in base denom for
CreateGauge
andAddToGauge
.
- #2245 Upgrade SDK for to v0.45.0x-osmo-v9.2. Major changes:
- Minimum deposit on proposer at submission time: osmosis-labs/cosmos-sdk#302
- #2214 Speedup epoch distribution, superfluid component
- 2011 Fix bug in TokenFactory initGenesis, relating to denom creation fee param.
- #1937 Change
lockupKeeper.ExtendLock
to take in lockID instead of the direct lock struct. - #2030 Rename lockup keeper
ResetAllLocks
toInitializeAllLocks
andResetAllSyntheticLocks
toInitializeAllSyntheticLocks
.
- #2146 Upgrade SDK for to v0.45.0x-osmo-v9.1. Major changes:
- Concurrency query client option: osmosis-labs/cosmos-sdk#281
- Remove redacted message fix: osmosis-labs/cosmos-sdk#284
- Reduce commit store logs (change to Debug): osmosis-labs/cosmos-sdk#282
- Bring back the cliff vesting command: osmosis-labs/cosmos-sdk#272
- Allow ScheduleUpgrade to come from same block: osmosis-labs/cosmos-sdk#261
This release contains minor CLI bug fixes.
- Restores vesting by duration command
- Fixes pagination in x/incentives module queries
- #1699 Fixes bug in sig fig rounding on spot price queries for small values
- #1671 Remove methods that constitute AppModuleSimulation APIs for several modules' AppModules, which implemented no-ops
- #1671 Add hourly epochs to
x/epochs
DefaultGenesis. - #1665 Delete app/App interface, instead use simapp.App
- #1630 Delete the v043_temp module, now that we're on an updated SDK version.
- 1700 Upgrade sdk fork with missing snapshot manager fix.
- 1716 Fix secondary over-LP shares bug with uneven swap amounts in
CalcJoinPoolShares
. - 1759 Fix pagination filter in incentives query.
- 1698 Register wasm snapshotter extension.
- 1931 Add explicit check for input denoms to
CalcJoinPoolShares
The Nitrogen release brings with it a number of features enabling further cosmwasm development work in Osmosis. It including breaking changes to the GAMM API's, many developer and node operator improvements for Cosmwasm & IBC, along with new txfee and governance features. In addition to various bug fixes and code quality improvements.
API changes were done to enable more CFMM's to be implemented within the existing framework. Integrators will have to update their messages and queries to adapt, please see https://github.com/osmosis-labs/osmosis/blob/main/x/gamm/breaking_changes_notes.md
- #1191, #1555 Superfluid stakers now have their votes override their validators votes
- sdk #239 Governance can set a distinct voting period for every proposal type.
- #1535 Upgrade to IBC v3
- #1564 Enable Interchain account host module
- See here for the supported messages
#1145 Non-osmo txfees now get swapped into osmo everyday at epoch, and then distributed to stakers.
Upgrade from wasmd v0.23.x to v0.27.0. This has the following features:
- State sync now works for cosmwasm state
- Cosmwasm builds on M1 macs
- Many security fixes
The TokenFactory module is added to the chain, making it possible for users and contracts to make new native tokens. Cosmwasm bindings have been added, to make swapping and creating these new tokens easier within the contract ecosystem.
- #1640 fix: localosmosis to work for testing cosmwasm contracts
- #1629 Fix bug in the airdrop claim script
- #1570 upgrade sdk with app version fix for state-sync
- #1554 local dev environment
- #1541 Add arm64 support to Docker
- #1535 upgrade wasmd to v0.27.0.rc3-osmo and ibc-go to v3
- State sync now works for cosmwasm state
- Cosmwasm builds on M1 macs
- #1435
x/tokenfactory
create denom fee for spam resistance - #1253 Add a message to increase the duration of a bonded lock.
- #1656 Change camelCase to snake_case in proto.
- #1632 augment SuperfluidDelegationsByDelegator query, return osmo equivilent is staked via superfluid
- #1723 fix number of LP shares returned from stableswap pool
This upgrade is a patch that must be hard forked in, as on-chain governance of Osmosis approved proposal 227 and proposal 228.
This upgrade includes:
- Adding height-gated AnteHandler message filter to filter unpooling tx pre-upgrade.
- At block height 4402000 accelerates prop 225, which in turn moves incentives from certain pools according to props 222-224
- Adds a msg allowing unpooling of UST pools.
- This procedure is initiated by whitelisting pools 560, 562, 567, 578, 592, 610, 612, 615, 642, 679, 580, 635.
- Unpooling allows exiting whitelisted pools directly, finish unbonding duration with the exited tokens instead of having to wait unbonding duration to swap LP shares back to collaterals.
- This procedure also includes locks that were already unbonding pre-upgrade and locks that were superfluid delegated.
Every node should upgrade their software version to v8.0.0 before the upgrade block height 4402000. If you use cosmovisor, simply swap out the binary at upgrades/v7/bin to be v8.0.0, and restart the node. Do check cosmovisor version returns v8.0.0
- {Across many PRs} Initiate emergency upgrade
- [#1481] Emergency upgrade as of prop [226] (https://www.mintscan.io/osmosis/proposals/226)
- [#1482] Checking Whitelisted Pools contain UST
- [#1486] Update whitelisted pool IDs
- [#1262] Add a forceprune command to the binaries, that prunes golevelDB data better
- [#1154] Database stability improvements
- [#840] Move lock.go functions into iterator.go, lock_refs.go and store.go
- [#916] And a fn for Unbond and Burn tokens
- [#908] Superfluid slashing code
- [#904] LockAndSuperfluidDelegate
- [#1428] fix: pool params query (backport #1315)
- [#1390] upgrade sdk to v0.45.0x-osmo-v7.9
- [#1087] Test improvisation for Superfluid (backport #1070)
- [#1022] upgrade iavl to v0.17.3-osmo-v4
- #1378 add .gitpod.yml
- #1262 Add a
forceprune
command to the binaries, that prunes golevelDB data better. - #1244 Refactor
x/gamm
'sExitSwapExternAmountOut
. - #1107 Update to wasmvm v0.24.0, re-enabling building on M1 macs!
- #1292 CLI account-locked-duration
- #1442 Use latest tm-db release for badgerdb and rocksdb improvments
- #1379 Introduce
Upgrade
andFork
structs, to simplify upgrade logic. - #1363 Switch e2e test setup to create genesis and configs via Dockertest
- #1335 Add utility for deriving total orderings from partial orderings.
- #1308 Make panics inside of epochs no longer chain halt by default.
- #1286 Fix release build scripts.
- #1203 cleanup Makefile and ci workflows
- #1177 upgrade to go 1.18
- #1193 Setup e2e tests on a single chain; add balances query test
- #1095 Fix authz being unable to use lockup & superfluid types.
- #1105 Add GitHub Actions to automatically push the osmosis Docker image
- #1114 Improve CI: remove duplicate runs of test worflow
- #1127 Stricter Linting: bump golangci-lint version and enable additional linters.
- #1184 Fix endtime event output on BeginUnlocking
- #1052 Eugen/cherry pick superfluid test scaffolding updates
- #1070 Test improvisation for Superfluid
- #1084 Superfluid Misc: Improve grpc_query
- #1081 Genesis upgrade and add invariant cherry pick
- #1088 Genesis import export check for superfluid
- #1101 Minor PR adding some code comments
- #1154 Database stability improvements
- sdk-#136 add after validator slash hook
- sdk-#137 backport feat: Modify grpc gateway to be concurrent
- sdk-#146 extra logs during commit
- sdk-#151 fix logs related to store keys and commit hash
- sdk-#140 refactor: snapshot and pruning functionality
- sdk-#156 feat: implement querying for commit hash and proofs
- sdk-#155 fix: commit info data race
- sdk-#158 Fixes the go race tests
- sdk-#160 increase setupBaseAppWithSnapshots timeout to 90 seconds
- sdk-#161 upgrade iavl to v0.17.3-osmo-v7 with lowered fast node cache size
- iavl-35 avoid clearing fast node cache during pruning
- iavl-36 fix data race related to VersionExists
- iavl-37 hardcode fast node cache size to 100k
- sdk-#135 upgrade iavl to v0.17.3-osmo-v5 with concurrent map write fix
- iavl-34 fix concurrent map panic when querying and committing
- #1022 upgrade iavl to v0.17.3-osmo-v4 - fix state export at an old height
- #988 Make
SuperfluidUndelegationsByDelegator
query also return synthetic locks - #984 Add wasm support to Dockerfile
This release fixes an instance of undefined behaviour present in v7.0.0.
Parts of the code use a function called ApplyFuncIfNoErr
whose purpose is to catch errors, and if found undo state updates during its execution.
It is intended to also catch panics and undo the problematic code's execution.
Right now a panic in this code block would halt the node, as it would not know how to proceed.
(But no state change would be committed)
The Osmosis Carbon Release! The changes are primarily
The large features include:
- Superfluid Staking - Allowing LP shares be staked to help secure the network
- Adding permissioned cosmwasm to the chain
- IAVL speedups, greatly improving epoch and query performance
- Local mempool filters to charge higher gas for arbitrage txs
- Allow partial unlocking of non-superfluid'd locks
Upgrade instructions for node operators can be found here
The v7 release introduces Superfluid Staking! This allows governance-approved LP shares to be staked to help secure the network.
- {Across many PRs} Add superfluid staking
- #893 Allow (non-superfluid'd) locks to be partially unlocked.
- #828 Move docs to their own repository, https://github.com/osmosis-labs/docs
- #804 Make the Osmosis repo use proper golang module versioning in self-package imports. (Enables other go projects to easily import Osmosis tags)
- #782 Upgrade to cosmos SDK v0.45.0
- #777 Add framework for mempool filters for charging different gas rates, add mempool filter for higher gas txs.
- #772 Fix SDK bug where incorrect sequence number txs wouldn't get removed from blocks.
- #769 Add governance permissioned cosmwasm module
- #680,#697 Change app.go file structure to mitigate risk of keeper reference vs keeper struct bugs. (What caused Osmosis v5 -> v6)
- #924 Fix long standing problems with total supply query over-reporting the number of osmo.
- #872 Add a helper for BeginBlock/EndBlock code to have code segments that atomically revert state if any part errors.
- #869 Update Dockerfile to use distroless base image.
- #855 Ensure gauges can only be created for assets that exist on chain.
- #766 Consolidate code between InitGenesis and CreateGauge
- #763 Add rocksDB options to Makefile.
- #740 Simplify AMM swap math / file structure.
- #731 Add UpdateFeeToken proposal handler to app.go
- #686 Add silence usage to cli to surpress unnecessary help logs
- #652 Add logic for deleting a pool
- #541 Start generalizing the AMM infrastructure
- sdk-#119 Add bank supply offsets to let applications have some minted tokens not count in total supply.
- sdk-#117 Add an instant undelegate method to staking, for use in superfluid.
- sdk-#116 Fix the slashing hooks to be correct.
- sdk-#108 upgrade to IAVL fast storage on v0.45.0x-osmo-v7-fast
- wasmd-v.022.0-osmo-v7.2 Upgrade SDK and IAVL dependencies to use fast storage
-#907 Upgrade IAVL and SDK with RAM improvements and bug fixes for v6.4.0
- sdk-#114 upgrading iavl with ram optimizations during migration, and extra logs and fixes for "version X was already saved to a different hash" and "insufficient funds" bugs
- iavl-19 force GC, no cache during migration, auto heap profile
-
#859 CLI, update default durations to be in better units.
-
#Unknown Switch to SDK branch with vesting by duration
- #795 Annotate app.go
- #791 Change to dependabot config to only upgrade patch version of tendermint
- #766 Consolidate code between InitGenesis and CreateGauge
- #845 Upgrade iavl and sdk with fast storage
- #724 Make an ante-handler filter for recognizing High gas txs, and having a min gas price for them.
- #795 Annotate app.go
- #791 Change to dependabot config to only upgrade patch version of tendermint
- #766 Consolidate code between InitGenesis and CreateGauge
- sdk-#100 Upgrade iavl with fast storage
- iavl-5 Fast storage optimization for queries and iterations
- sdk-#58 Fix a bug where recheck would not remove txs with invalid sequence numbers
- #765 Fix a bug in
Makefile
regarding the location of localtestnet docker image.
- Update to Tendermint v0.34.15
- Increase p2p timeouts to alleviate p2p network breaking at epoch
- #741 Allow node operators to set a second min gas price for arbitrage txs.
- #623 Use gosec for staticly linting for common non-determinism issues in SDK applications.
- #722 reuse code for parsing integer slices from string
- #704 fix rocksdb
- #666 Fix the
--log-level
and--log-format
commands onosmosisd start
- #655 Make the default genesis for pool-incentives work by default
- 97ac2a8 Fix InitGenesis bug for gauges
- sdk-#52 Fix inconsistencies in default pruning config, and change defaults. Fix pruning=everything defaults.
- previously default was actually keeping 3 weeks of state, and every 100th state. (Not that far off from archive nodes)
- pruning=default now changed to 1 week of state (100k blocks), and keep-every=0. (So a constant number of states stored)
- pruning=everything now stores the last 10 states, to avoid db corruption errors plaguing everyone who used it. This isn't a significant change, because the pruning interval was anyways 10 blocks, so your node had to store 10 blocks of state anyway.
- sdk-#51 Add hooks for superfluid staking
- sdk-#50 Make it possible to better permission the bank keeper's minting ability
This upgrade fixes a bug in the v5.0.0 upgrade's app.go, which prevents new IBC channels from being created.
This binary is compatible with v5.0.0 until block height 2464000
, estimated to be at 4PM UTC Monday December 20th.
- Patch - Revert back to passing in the correct staking keeper into the IBC keeper constructor.
- Height gating change - Height gate the change in IBC, to make the v6.0.0 binary compatible until upgrade height.
v5.0.0 - Boron upgrade
The Osmosis Boron release is made!
Notable features include:
- Upgrading from SDK v0.42 to SDK v0.44, bringing efficiency improvements, integrations and Rosetta support.
- Bringing in the new modules Bech32IBC, Authz, TxFees
- Upgrading to IBC v2, allowing for improved Ethereum Bridge and CosmWasm support
- Implementing Osmosis chain governance's Proposal 32
- Large suite of gas bugs fixed. (Including several that we have not seen on chain)
- More queries exposed to aid node operators.
- Blocking the OFAC banned Ethereum addresses.
- Several (linear factor) epoch time improvements. (Most were present in v4.2.0)
Upgrade instructions for node operators can be found here
- #637 Add Bech32IBC
- #610 Upgrade to Cosmos SDK v0.44.x
- Numerous large updates, such as making module accounts be 32 bytes, Rosetta support, etc.
- Adds & integrates the Authz module See: SDK v0.43.0 Release Notes For more details
- #610 Upgrade to IBC-v2
- #560 Implements Osmosis prop32 -- clawing back the final 20% of unclaimed osmo and ion airdrop.
- #394 Allow whitelisted tx fee tokens based on conversion rate to OSMO
- Commit db450f0 Add blocking of OFAC banned Ethereum addresses
- {In the Osmosis-labs SDK fork}
- Increase default IAVL cache size to be in the hundred megabyte range
- Significantly improve CacheKVStore speed problems, reduced IBC upgrade time from 2hrs to 5min
- Add debug info to make it clear whats happening during upgrade
- (From a series of commits) Fixes to the claims module to only do the reclaim logic once, not every block.
- (From a series of commits) More logging to the claims module.
- #563 Allow zero-weight pool-incentive distribution records
- #562 Store block height in epochs module for easier debugging
- #544 Update total liquidity tracking to be denom basis, lowering create pool and join pool gas.
- #540 Fix git lfs links
- #517 Linear time improvement for epoch time
- #515 Add debug command for converting secp pubkeys
- #510 Performance improvement for gauge distribution
- #505 Fix bug in incentives epoch distribution events, used to use raw address, now uses bech32 addr
- #464 Increase maximum outbound peers for validator nodes
- #444 Add script for state sync
- #409 Reduce epoch time growth rate for re-locking assets
- Significantly speedup epoch times
- Fix bug in the lockup module code that caused it to take a linear amount of gas.
- Make unbonding tokens from the lockup module get automatically claimed when unbonding is done.
- Add events for all tx types in the gamm module.
- Add events for adding LP rewards.
- Make queries to bank total chain balance account for developer vesting correctly.
- Add ability for nodes to query the total amount locked for each denomination.
- Embedded seeds in init.go
- Added changelog and info about changelog format.
- Fix accumulation store only counting bonded tokens, not unbonding tokens, that prevented the front-end from using more correct APY estimates. (Previously, the front-end could only underestimate rewards)
v3.2.0 - 2021-06-28
- Update the cosmos-sdk version we modify to v0.42.9
- Fix a bug in the min commission rate code that allows validators to be created with commission rates less than the minimum.
- Automatically upgrade any validator with less than the minimum comission rate to the minimum at upgrade time.
- Unbrick on-chain governance, by fixing the deposit parameter to use
uosmo
instead ofosmo
.
v1.0.2 - 2021-06-18
This release improves the CLI UX of creating and querying gauges.
v1.0.1 - 2021-06-17
This release fixes a bug in osmosisd version
always displaying 0.0.1.
v1.0.0 - 2021-06-16
Initial Release!