Feat/update amm v3 sdk #303
Conversation
WalkthroughThe recent updates introduce significant changes to the Oraiswap contract ecosystem, including a new version release for both the SDK and build packages. Key enhancements involve expanded incentive management functionalities within the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant OraiswapV3Interface
participant OraiswapV3ReadOnlyInterface
User->>OraiswapV3Interface: createIncentive(params)
OraiswapV3Interface-->>OraiswapV3ReadOnlyInterface: Incentive created
User->>OraiswapV3Interface: updateIncentive(params)
OraiswapV3Interface-->>OraiswapV3ReadOnlyInterface: Incentive updated
User->>OraiswapV3Interface: claimIncentive(index)
OraiswapV3Interface-->>User: Incentive claimed
User->>OraiswapV3ReadOnlyInterface: positionIncentives(index, ownerId)
OraiswapV3ReadOnlyInterface-->>User: Returns incentive details
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
|
Code Coverage SummaryDiff against mainResults for commit: decdf29 Minimum allowed coverage is ♻️ This comment has been updated with latest results |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
packages/contracts-build/data/oraiswap-v3.wasmis excluded by!**/*.wasm
Files selected for processing (5)
- packages/contracts-build/package.json (1 hunks)
- packages/contracts-build/src/index.ts (1 hunks)
- packages/contracts-sdk/package.json (1 hunks)
- packages/contracts-sdk/src/OraiswapV3.client.ts (7 hunks)
- packages/contracts-sdk/src/OraiswapV3.types.ts (7 hunks)
Files skipped from review due to trivial changes (2)
- packages/contracts-build/package.json
- packages/contracts-sdk/package.json
Additional context used
Biome
packages/contracts-sdk/src/OraiswapV3.client.ts
[error] 9-9: Do not shadow the global "Boolean" property.
Consider renaming this variable. It's easy to confuse the origin of variables when they're named after a known global.
(lint/suspicious/noShadowRestrictedNames)
Additional comments not posted (25)
packages/contracts-build/src/index.ts (1)
18-19: LGTM! Ensure consistency across the codebase.The addition of "oraiswap-v3" to the
ContractNametype is correct.Verify that all references to
ContractNamethroughout the codebase are updated to handle this new contract name.Verification successful
Verification successful.
The
ContractNametype includes "oraiswap-v3", and the functions that useContractNameare designed to handle different contract names dynamically. No issues found with the handling of "oraiswap-v3".
packages/contracts-build/src/index.tsScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all references to `ContractName` handle the new "oraiswap-v3" contract name. # Test: Search for `ContractName` usage. Expect: References to "oraiswap-v3". rg --type ts 'ContractName'Length of output: 277
Script:
#!/bin/bash # Extract and inspect lines around each reference to `ContractName` to verify if "oraiswap-v3" is handled appropriately. # Extract lines around the definition of `ContractName` rg --type ts -A 5 -B 5 'export type ContractName' packages/contracts-build/src/index.ts # Extract lines around the usage of `ContractName` in `getContractDir` rg --type ts -A 5 -B 5 'getContractDir' packages/contracts-build/src/index.ts # Extract lines around the usage of `ContractName` in the object with an optional `contractName` property rg --type ts -A 5 -B 5 'contractName?: ContractName' packages/contracts-build/src/index.tsLength of output: 1288
packages/contracts-sdk/src/OraiswapV3.types.ts (13)
114-121: New incentive creation message type looks good.The
create_incentivemessage type is well-defined and includes necessary fields for pool key, reward per second, reward token, and optional fields for start timestamp and total reward.
123-129: New incentive update message type looks good.The
update_incentivemessage type is well-defined and includes necessary fields for incentive ID, pool key, and optional fields for remaining reward, reward per second, and start timestamp.
131-133: New incentive claim message type looks good.The
claim_incentivemessage type is well-defined and includes necessary fields for the index.
149-157: New AssetInfo type looks good.The
AssetInfotype is well-defined and can represent either a token or a native token, enhancing asset handling flexibility.
301-304: New position incentives query type looks good.The
position_incentivesquery type is well-defined and includes necessary fields for index and owner ID.
Line range hint
327-336:
Addition of incentives field to Position interface looks good.The
incentivesfield in thePositioninterface is well-defined and allows tracking of incentives associated with each position.
337-341: New PositionIncentives interface looks good.The
PositionIncentivesinterface is well-defined and includes necessary fields for incentive growth, ID, and pending rewards.
367-372: Addition of incentives field to Pool interface looks good.The
incentivesfield in thePoolinterface is well-defined and allows tracking of incentives related to the pool.
373-381: New IncentiveRecord interface looks good.The
IncentiveRecordinterface is well-defined and includes necessary fields for incentive ID, growth metrics, and reward specifics.
418-421: New TickIncentive interface looks good.The
TickIncentiveinterface is well-defined and includes necessary fields for incentive growth and ID.
387-388: New Uint128 type looks good.The
Uint128type definition is simple and correct.
388-389: New ArrayOfAsset type looks good.The
ArrayOfAssettype definition is simple and correct.
389-392: New Asset interface looks good.The
Assetinterface is well-defined and includes necessary fields for amount and asset info.packages/contracts-sdk/src/OraiswapV3.client.ts (11)
179-185: New positionIncentives method in OraiswapV3ReadOnlyInterface looks good.The
positionIncentivesmethod is well-defined and includes necessary parameters for index and owner ID.
219-219: Binding the positionIncentives method in OraiswapV3QueryClient looks good.The
positionIncentivesmethod is correctly bound in theOraiswapV3QueryClientconstructor.
560-573: Implementation of positionIncentives method in OraiswapV3QueryClient looks good.The
positionIncentivesmethod is correctly implemented and queries the contract for position incentives.
733-745: New createIncentive method in OraiswapV3Interface looks good.The
createIncentivemethod is well-defined and includes necessary parameters for pool key, reward per second, reward token, start timestamp, and total reward.
746-752: New updateIncentive method in OraiswapV3Interface looks good.The
updateIncentivemethod is well-defined and includes necessary parameters for incentive ID, pool key, remaining reward, reward per second, and start timestamp.
753-758: New updateIncentive method in OraiswapV3Interface looks good.The
updateIncentivemethod is well-defined and includes necessary parameters for incentive ID, pool key, remaining reward, reward per second, and start timestamp.
759-763: New claimIncentive method in OraiswapV3Interface looks good.The
claimIncentivemethod is well-defined and includes necessary parameters for the index.
796-798: Binding the new incentive methods in OraiswapV3Client looks good.The
createIncentive,updateIncentive, andclaimIncentivemethods are correctly bound in theOraiswapV3Clientconstructor.
1107-1129: Implementation of createIncentive method in OraiswapV3Client looks good.The
createIncentivemethod is correctly implemented and sends the appropriate execute message to the contract.
1130-1152: Implementation of updateIncentive method in OraiswapV3Client looks good.The
updateIncentivemethod is correctly implemented and sends the appropriate execute message to the contract.
1153-1163: Implementation of claimIncentive method in OraiswapV3Client looks good.The
claimIncentivemethod is correctly implemented and sends the appropriate execute message to the contract.
| @@ -6,7 +6,7 @@ | |||
|
|
|||
| import { CosmWasmClient, SigningCosmWasmClient, ExecuteResult } from "@cosmjs/cosmwasm-stargate"; | |||
| import { Coin, StdFee } from "@cosmjs/amino"; | |||
| import {Percentage, InstantiateMsg, ExecuteMsg, Addr, Liquidity, SqrtPrice, TokenAmount, Binary, Expiration, Timestamp, Uint64, PoolKey, FeeTier, SwapHop, NftExtensionMsg, QueryMsg, MigrateMsg, FeeGrowth, AllNftInfoResponse, OwnerOfResponse, Approval, NftInfoResponse, Position, TokensResponse, ApprovedForAllResponse, Boolean, ArrayOfFeeTier, ArrayOfLiquidityTick, LiquidityTick, Uint32, NumTokensResponse, Pool, ArrayOfPoolWithPoolKey, PoolWithPoolKey, ArrayOfPositionTick, PositionTick, ArrayOfPosition, QuoteResult, Tick, ArrayOfTupleOfUint16AndUint64} from "./OraiswapV3.types"; | |||
| import {Percentage, InstantiateMsg, ExecuteMsg, Addr, Liquidity, SqrtPrice, TokenAmount, Binary, Expiration, Timestamp, Uint64, AssetInfo, PoolKey, FeeTier, SwapHop, NftExtensionMsg, QueryMsg, MigrateMsg, FeeGrowth, AllNftInfoResponse, OwnerOfResponse, Approval, NftInfoResponse, Position, PositionIncentives, TokensResponse, ApprovedForAllResponse, Boolean, ArrayOfFeeTier, ArrayOfLiquidityTick, LiquidityTick, Uint32, NumTokensResponse, Pool, IncentiveRecord, ArrayOfPoolWithPoolKey, PoolWithPoolKey, Uint128, ArrayOfAsset, Asset, ArrayOfPositionTick, PositionTick, ArrayOfPosition, QuoteResult, Tick, TickIncentive, ArrayOfTupleOfUint16AndUint64} from "./OraiswapV3.types"; | |||
There was a problem hiding this comment.
Consider renaming the Boolean type to avoid shadowing the global Boolean property.
Shadowing global properties can lead to confusion and potential bugs.
- Boolean
+ CustomBooleanCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| import {Percentage, InstantiateMsg, ExecuteMsg, Addr, Liquidity, SqrtPrice, TokenAmount, Binary, Expiration, Timestamp, Uint64, AssetInfo, PoolKey, FeeTier, SwapHop, NftExtensionMsg, QueryMsg, MigrateMsg, FeeGrowth, AllNftInfoResponse, OwnerOfResponse, Approval, NftInfoResponse, Position, PositionIncentives, TokensResponse, ApprovedForAllResponse, Boolean, ArrayOfFeeTier, ArrayOfLiquidityTick, LiquidityTick, Uint32, NumTokensResponse, Pool, IncentiveRecord, ArrayOfPoolWithPoolKey, PoolWithPoolKey, Uint128, ArrayOfAsset, Asset, ArrayOfPositionTick, PositionTick, ArrayOfPosition, QuoteResult, Tick, TickIncentive, ArrayOfTupleOfUint16AndUint64} from "./OraiswapV3.types"; | |
| import {Percentage, InstantiateMsg, ExecuteMsg, Addr, Liquidity, SqrtPrice, TokenAmount, Binary, Expiration, Timestamp, Uint64, AssetInfo, PoolKey, FeeTier, SwapHop, NftExtensionMsg, QueryMsg, MigrateMsg, FeeGrowth, AllNftInfoResponse, OwnerOfResponse, Approval, NftInfoResponse, Position, PositionIncentives, TokensResponse, ApprovedForAllResponse, CustomBoolean, ArrayOfFeeTier, ArrayOfLiquidityTick, LiquidityTick, Uint32, NumTokensResponse, Pool, IncentiveRecord, ArrayOfPoolWithPoolKey, PoolWithPoolKey, Uint128, ArrayOfAsset, Asset, ArrayOfPositionTick, PositionTick, ArrayOfPosition, QuoteResult, Tick, TickIncentive, ArrayOfTupleOfUint16AndUint64} from "./OraiswapV3.types"; |
Tools
Biome
[error] 9-9: Do not shadow the global "Boolean" property.
Consider renaming this variable. It's easy to confuse the origin of variables when they're named after a known global.
(lint/suspicious/noShadowRestrictedNames)
Summary by CodeRabbit
New Features
@oraichain/oraidex-contracts-buildand@oraichain/oraidex-contracts-sdkpackages.Bug Fixes