Skip to content

CHANGELOG.md

Latest commit

 

History

History
415 lines (277 loc) · 17.2 KB

CHANGELOG.md

File metadata and controls

415 lines (277 loc) · 17.2 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog.

[Unreleased]

Added

  • BasicOrder trigger-order fields from frontendOpenOrders: is_trigger, trigger_px, trigger_condition, is_position_tpsl
  • OrderResponseStatus::WaitingForTrigger and WaitingForFill order response variants
  • Exchange actions sendToEvmWithData, topUpIsolatedOnlyMargin, claimRewards, authorizeAqav2Role, and validatorL1Stream, with HttpClient methods for each
  • Deployer actions in the new hypercore::types::deploy module: HIP-1/HIP-2 spotDeploy, HIP-3 perpDeploy, and HIP-4 outcome deployment and settlement, reachable via HttpClient::spot_deploy, perp_deploy, and activate_outcome_deployer
  • WebSocket post requests: Connection::post and ConnectionHandle::post send info requests and signed actions over an open socket, with replies arriving as Incoming::Post
  • Info requests userDexAbstraction and outcomeTemplates, via HttpClient::user_dex_abstraction and outcome_templates
  • fast flag on BatchCancel and BatchCancelCloid, serialized as f and omitted when false
  • Optional destination on the reserveRequestWeight action, to credit reserved capacity to another account
  • New example: examples/hypercore/websocket_post.rs
  • Two ignored live-audit tests, info_requests_are_still_answered and deployer_action_shapes_are_still_accepted, that walk the SDK's surface against the real API
  • Single-order modify action, as Action::Modify and HttpClient::modify_order. batchModify was the only form covered before
  • always_place on Modify and BatchModify, serialized as a and omitted when false, which places the replacement order even if the cancel failed
  • spotDeploy variants setTokenAnnotation and setDeployerLabel
  • outcomeDeploy variant setSubDeployers, which grants a sub-deployer one HIP-4 action
  • Eighteen undocumented exchange actions the exchange accepts but the docs do not mention, each with an HttpClient method: borrowLend, createSubAccount, subAccountModify, subAccountTransfer, subAccountSpotTransfer, createVault, vaultModify, vaultDistribute, setDisplayName, setReferrer, registerReferrer, spotUser, finalizeEvmContract, CSignerAction, CValidatorAction, linkStakingUser, stakingLinkDisableTradingUser, and userPortfolioMargin
  • Nineteen undocumented info requests, each with an HttpClient method: exchangeStatus, gossipRootIps, isVip, leadingVaults, legalCheck, liquidatable, marginTable, maxMarketOrderNtls, preTransferCheck, recentTrades, subAccounts2, twapHistory, usdcRouting, userBorrowLendInterest, userTwapSliceFillsByTime, validatorL1Votes, validatorSummaries, vaultSummaries, and webData2
  • WS subscriptions assetCtxs, spotAssetCtxs, and userHistoricalOrders
  • Incoming::Error, carrying the error channel. A rejected subscription used to be logged and dropped, so a removed subscription looked like a feed that never sent anything
  • Live-audit tests subscriptions_are_still_accepted and undocumented_action_shapes_are_accepted, covering the two surfaces the existing audits missed
  • PredictedFundingVenue::funding_interval_hours, the funding interval the exchange reports per venue. Optional: 19 of 627 venue payloads on mainnet omit it

Removed

  • HttpClient::aligned_quote_token_info and InfoRequest::AlignedQuoteTokenInfo. The endpoint no longer exists: mainnet and testnet both reject it with the same error they give an unknown request type, and it is absent from the docs
  • Breaking: Subscription::WebData2 and Incoming::WebData2. The exchange rejects the subscription; webData3 replaces it. The webData2 info request still works and is now available as HttpClient::web_data2

Changed

  • Breaking: HttpClient::predicted_fundings now returns Option<PredictedFundingVenue> for each venue. The exchange sends null when a coin is not listed on a venue, which failed to deserialize with invalid type: null, expected struct PredictedFundingVenue. On mainnet 69 of 696 venue slots are null, so the endpoint was unusable. None means the coin is not listed there, not a zero funding rate
  • Breaking: BatchCancel and BatchCancelCloid gained a fast field, so struct literals need fast: false
  • Breaking: BatchModify gained an always_place field, so struct literals need always_place: false
  • Breaking: HIP-4 outcome deployment moved from SpotDeployAction::Outcome to its own Action::OutcomeDeploy, sent as {"type": "outcomeDeploy", ...}. The exchange stopped parsing the old nesting. Use HttpClient::outcome_deploy
  • Breaking: HttpClient::reserve_request_weight takes a destination: Option<Address> argument
  • Response, OkResponse, OrderResponseStatus, and ActionRequest now derive Clone; Response, OkResponse, and OrderResponseStatus also derive Serialize
  • OkResponse gained CreateSubAccount and CreateVault, which carry the address the exchange assigns
  • All three signing paths (sign, sign_sync, prehash) now share one exhaustive match over Action, so adding an action is one edit instead of three

Dependencies

  • Refreshed every dependency to its latest release. base64 0.22 -> 0.23 and hex-literal 0.4 -> 1 in the SDK, iroh-mdns-address-lookup 0.4 -> 0.5 in hypecli, plus a full lockfile update
  • Breaking: MSRV raised to 1.94.1 on both crates. alloy 2.4 already required it, so the declared 1.85.0 had not been buildable for a while and was holding back updates to serde_with, ruint, icu_* and the aws-* tree

[v0.2.10]

Added

  • Optional nSigFigs and mantissa parameters on the L2Book WS subscription for price-level aggregation
  • Outcome (prediction) market support: OutcomeMeta, OutcomeInfo, OutcomeQuestion, OutcomeSideSpec types
  • HttpClient::outcome_meta() and standalone hypercore::outcome_meta() for querying HIP-4 markets
  • HyperCore WS subscriptions for userEvents, userTwapSliceFills, userTwapHistory, activeAssetData, and webData2
  • New typed WS payloads for user events, TWAP slice/history streams, and active asset data
  • Forward-compatible fallback parsing for unknown userEvents payload variants
  • New example: examples/hypercore/websocket-user-events.rs

Fixed

  • Parse channel "user" fill notifications as UserEvents on WebSocket
  • Fix OutcomeMarket::market to store full asset ID (including 100_000_000 offset)
  • Consolidate AbstractionMode into types/api.rs, remove wrapper type

Changed

  • Extended WebSocket docs/snippets in README and crate docs to include advanced user streams
  • Added serde test coverage for the new WS channels and payload schemas

[v0.2.9]

Added

  • Agent-signed send asset (AgentSendAsset) action type with L1/RMP signing
  • Order write priority support via BatchOrder.grouping = OrderGrouping::PriorityRate(bps)

Changed

  • GossipPriorityBid.max_gas serialization fixed to use decimal string format
  • Dynamic HYPE decimals used for priority bid conversions in CLI and examples

[v0.2.8]

Added

  • Gossip priority auction support: Dutch auction bids for read-priority gossip data
    • GossipPriorityBid action type with RMP-based signing
    • GossipPriorityAuctionStatus response type and info request
    • HttpClient::gossip_priority_bid() and HttpClient::gossip_priority_auction_status() methods
    • Example: examples/hypercore/priority-fee-bid.rs
    • hypecli prio bid command for CLI priority bidding

Changed

  • Improved HTTP error handling and response parsing
  • Morpho vault APY: avoid panic on insufficient data; added get_pool_address for Uniswap pools
  • Support spot asset in order/position listings

[v0.2.7]

Added

  • Vault deposit and withdraw: HttpClient::vault_transfer(), VaultTransfer action type
  • Refactored vault CLI to use subcommands (deposit/withdraw)

Fixed

  • Use max timestamp for TVL in vault details to prevent incorrect calculations

Changed

  • Updated http.rs doc comments for improved accuracy

[v0.2.6]

Added

  • dex parameter to WebData2 subscription and incoming types for multi-DEX WebSocket data
  • OrderUpdate is now generic over the order type for flexible deserialization
  • Aligned quote token and deployer fee fields on perpetual markets
  • Growth mode field on perpetual markets

Fixed

  • Handle panics when metadata references indices beyond array bounds
  • Serialize OidOrCloid::Right as hex string for correct action hash computation
  • Skip serializing zero cloid in OrderRequest to match server hashing behavior

Changed

  • Refactored PriceTick to provide public constructors (for_perp(), for_spot())

[v0.2.5]

Added

  • HttpClient::user_fills_by_time() — query fills within a time range
  • Advanced WebSocket user stream subscriptions: UserEvents, UserFills, UserTwapSliceFills, UserTwapHistory, ActiveAssetCtx, WebData2
  • Tolerate missing TWAP history descriptions gracefully

Changed

  • Filter out non-text WebSocket frames (binary frames are logged as warnings instead of causing errors)

[v0.2.4]

Added

  • users field, taker_address(), and maker_address() on Trade struct for identifying trade participants

Fixed

  • CLOID serialization fix for correct action hash matching between client and server

[v0.2.3]

Added

  • Outcome market support: OutcomeMeta, OutcomeInfo, OutcomeQuestion, OutcomeSideSpec types
  • HttpClient::outcome_meta() and standalone hypercore::outcome_meta() for querying outcome markets

[v0.2.2]

Added

  • update_leverage action and HttpClient::update_leverage() client method
  • Noop action for nonce invalidation
  • EVM user modify (EvmUserModify) action for toggling big blocks
  • Account abstraction mode: AbstractionMode query and set via agent-signed and user-signed actions
  • Subaccount, vault details, user vault equities, and user role info calls
  • ClearinghouseState and funding_history endpoints
  • UpdateIsolatedMargin action type with signature recovery support
  • UserRole enum replacing string-based role responses
  • WebSocket connection status events: Event::Connected, Event::Disconnected, Event::Message
  • NonceHandler concurrency fix for atomic nonce generation
  • NoCross margin mode added to perpetual universe items
  • Reply to server pings on WebSocket; force reconnect after missed pongs

Documentation

  • Added AI agent instructions pointing to skills folder
  • Added curl install command to README
  • Enhanced trading skill with HIP-3 DEX listing and trading guidance

Changed

  • Unified asset format for subscribe commands in hypecli
  • Use FromStr for CLOID parsing instead of manual hex decode
  • Simplified hypecli send command
  • Added --skip-hip3 flag to balance command
  • Made user a positional argument in balance command

Fixed

  • Morpho deposits: fix totalAssets = deposits calculation
  • Fix yawc dependency version

[v0.2.1]

Added

  • Multi-signature transaction support in hypersdk
    • Action::sign(), sign_sync(), prehash(), and recover() directly on Action
    • Split types.rs into modular structure: types/mod.rs, types/api.rs, types/solidity.rs
    • Signature recovery and prehash functionality
    • multi_sig_config() and api_agents() HTTP client methods

Changed

  • Breaking: Removed Signable trait; moved signing logic to Action enum
  • Refactored signing module from 700+ lines to ~26 lines

[v0.2.0]

Changed

  • Breaking: Morpho APY calculations now use generic types for high precision arithmetic
    • PoolApy and VaultApy are generic over T128 type parameter
    • apy() methods require conversion functions
  • Added Cancel variant to OkResponse enum

Dependencies

  • Force rustls as TLS backend across the project
  • Updated reqwest to v0.13

[v0.1.5] - 2026-01-12

Added

  • Added Cancel variant to OkResponse enum for order cancellation responses
  • Added test case for cancel response deserialization
  • Added credentials example showing common argument patterns across examples
  • Made signing module public (pub mod signing)

Changed

  • Breaking: Morpho APY calculations now use generic types for high precision arithmetic
    • PoolApy and VaultApy are now generic over T128 type parameter
    • apy() methods require conversion functions to handle custom numeric types (f64, Decimal, etc.)
    • Enables arbitrary precision calculations for financial computations
  • Refactored examples to use common credential and argument handling patterns
  • Updated morpho examples to use new generic APY API with explicit conversions

Fixed

  • Fixed API type structs for cancellation and modification responses

Dependencies

  • hypecli v0.1.3: Updated dependencies including alloy and hypersdk versions

Files Changed: 24 files, +556 insertions, -249 deletions

[v0.1.4] - 2026-01-10

Added

  • Created new types/api.rs module with core API request/response types (788 lines)
  • Added types/solidity.rs module for Solidity type conversions
  • Added signature recovery functionality to Action enum (recover() method)
  • Added prehash() method to Action for obtaining signing hashes without signing
  • Added methods to HttpClient: multi_sig_config(), api_agents()

Changed

  • Breaking: Removed Signable trait in favor of methods directly on Action enum
    • Actions now implement sign(), sign_sync(), prehash(), and recover() directly
    • Simplified signing API with unified interface through Action enum
  • Breaking: Split types.rs into modular structure: types/mod.rs, types/api.rs, types/solidity.rs
  • Reorganized HTTP client to use new type organization
  • Refactored signing module, reducing from 700+ lines to ~26 lines by moving logic to Action
  • hypecli: Switched to simple P2P connections instead of gossip protocol in iroh integration
  • hypecli: Enhanced multisig handling with improved error handling and flow

Documentation

  • Added comprehensive module-level documentation for types/api.rs
  • Improved signing module documentation explaining new architecture
  • Updated README with 33 lines of new content

Dependencies

  • hypecli: Upgraded to hypersdk 0.1.3
  • hypecli: Force rustls for TLS (added reqwest-rustls-tls feature)
  • hypecli: Updated dependency versions in Cargo.lock (344 fewer lines after optimization)

Files Changed: 14 files, +1477 insertions, -2072 deletions

[v0.1.3] - 2026-01-10

Changed

  • Forced rustls as TLS backend across the project
  • Updated reqwest to v0.13
  • Updated hypecli README (288 lines reduced, streamlined documentation)
  • Refactored multisig module in hypecli (266 lines changed)

Fixed

  • Removed musl target from release workflow
  • hypecli: Force connection to endpoint during signing operations

Dependencies

  • Updated various dependency versions in hypecli Cargo.lock

Files Changed: 9 files, +290 insertions, -459 deletions

[v0.1.2] - 2026-01-10

Added

  • hypecli: New command-line tool for Hyperliquid interactions
    • Added balances, markets, morpho, and multisig modules
    • P2P multisig coordination using iroh-gossip
    • Support for converting accounts to/from multisig
    • User and multisig conversion commands
  • HTTP Client: New multisig-related functionality
    • multi_sig_config() - Query multisig configuration
    • api_agents() - Retrieve API agents for a user
  • Signing: Support for multisig actions and agent approvals
    • ApproveAgent action type
    • ConvertToMultiSigUser action type
    • Enhanced MultiSigAction handling

Changed

  • Exposed additional types and functions in hypercore module for public API
  • Updated function signatures for improved API clarity
  • Enhanced HTTP client methods with better error handling

Fixed

  • Fixed multisig signing flow for mainnet deployment
  • Resolved test failures and compiler warnings

Dependencies

  • Added iroh-gossip, iroh-tickets for P2P coordination
  • Added various CLI dependencies (clap, rpassword, indicatif)

Files Changed: 20 files, +5632 insertions, -1163 deletions

[v0.1.1] - 2026-01-08

Added

  • WebSocket Candle Feed: Real-time candlestick data streaming
    • candle_snapshot() - Get historical candle data
    • WebSocket subscription for live candle updates
    • Example: examples/hypercore/websocket-candles.rs
  • NonceHandler: Thread-safe nonce generation utility
    • Atomic timestamp-based nonce generation
    • Prevents replay attacks with monotonic increasing nonces
    • Comprehensive documentation with usage examples
  • Examples: Added market listing example (examples/hypercore/list-markets.rs)

Changed

  • Improved WebSocket connection handling and reconnection logic

Fixed

  • Fixed issues in example code

Documentation

  • Comprehensive NonceHandler documentation with thread-safety guarantees
  • Improved crate-level documentation for docs.rs
  • Added "Design choices" section to README
  • Enhanced example documentation
  • Fixed README examples

Chore

  • Removed Cargo.lock from version control (added to .gitignore)
  • Updated CI workflow

Files Changed: 25 files, +1377 insertions, -6157 deletions (large reduction due to Cargo.lock removal)