Hello, Builders!
We're excited to announce several important updates to our Omnistone protocol definitions. Please note that these are only proto changes at this time and will be integrated into the SDK soon. In the meantime, review the details below to ensure your integration logic remains compatible.
---
1. Identifier and Field Updates
• Both
quote_id and rfq_id are now defined as 32-byte values.• Quote and Trade Request Updates:
- Removed the field
resolver_amount from QuoteRequestedEvent.- Added
gas_budget to Quote.- Added
outgoing_tx_hash to TrackTradeRequest.---
2. ChunkStatus and Trade Status Modifications
• Added the field
protocol.• Removed the field
result_details_json.• Added the field
tx_hash.• Trade Status Adjustments:
- Renamed
FillingTrade to Swapping.- Removed
outgoing_tx_hash from both Transferring and Swapping.- Introduced a new status called AwaitingFill.
• BuildTransferRequest Update:
- Dropped the field
max_slippage_bps.---
3. Types and Schema Alterations
• Dropped the file
condition.proto.• Added a new message called
RequestSettlementParams.• QuoteRequest Enhancements:
- Added the field
settlement_params.• Swap Entities Adjustments:
- Removed the field
extra_data_json from SwapRoute, SwapStep, and SwapChunk.- Added new fields
extra_version and extra to SwapChunk.---
4. Resolver API Modifications
• Dropped the message
TransferBodyRequestedEvent and removed its corresponding field transfer_body_requested from ResolverEvent.• Dropped the message
UpdateTransferBodyRequest and removed its corresponding field update_transfer_body from ResolverRequest.• Transaction Building:
- Part of the API related to transaction building has been removed from the resolver.
---
5. Trader API Updates
• Dropped the file
asset.proto, thereby completely removing the API for working with assets.• Transaction Schema Revision:
- Renamed
TransactionResponse to Transaction and moved it to transaction.proto.---
Why This Matters
These changes enhance our platform's consistency, reduce complexities in transaction building, and align with our long-term API roadmap. Since these updates are only at the proto level for now, they won't immediately affect the SDK, but you should update your projects accordingly to avoid any future integration issues.
What You Need To Do
- Review your current integrations to ensure your logic reflects these updated fields and removed functionalities.
- Adjust any references to fields that have been added, removed, or renamed.
For more details and to review the updated proto definitions, please visit our GitHub repository:
https://github.com/ston-fi/omniston-api/tree/main/proto/omni/v1beta6
If you have any questions or run into any issues, please reach out to our team.
Happy building!