Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions clients/web3-wallet/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Changelog

## 1.0.0 - 2026-07-24

### Changed (1)

- Modified response for `getGasLimit()` (`POST /api/v1/dex/pre-transaction/gas-limit`):
- `data`: property `energyFee` added
- `data`: property `energyRequired` added
- `data`: property `freeBandwidth` added
- `data`: property `freeEnergy` added
- `data`: property `bandwidthFee` added
- `data`: property `bandwidthRequired` added
617 changes: 617 additions & 0 deletions clients/web3-wallet/docs/AddressPortfolioApi.md

Large diffs are not rendered by default.

11 changes: 11 additions & 0 deletions clients/web3-wallet/docs/BinanceChainId.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@


# BinanceChainId

## Enum


* `CT_501` (value: `"CT_501"`)



6 changes: 3 additions & 3 deletions clients/web3-wallet/docs/BroadcastTransactionsRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**binanceChainId** | **String** | Unique chain identifier (e.g. \"1\"=Ethereum, \"56\"=BSC, \"CT_501\"=Solana). | |
|**signedTransaction** | **String** | Client-signed raw transaction. EVM chains use a hex-encoded RLP transaction; Solana uses a base64-encoded signed transaction. | |
|**address** | **String** | Sender wallet address. Used for status attribution and signature verification. | |
|**binanceChainId** | **String** | Unique chain identifier (e.g. \"1\"=Ethereum, \"56\"=BSC, \"CT_501\"=Solana, \"CT_195\"=Tron). | |
|**signedTransaction** | **String** | Client-signed raw transaction. Format depends on `binanceChainId`: - **EVM chains**: hex-encoded RLP transaction (e.g. `0xf86c...`). - **Solana (`CT_501`)**: base64-encoded signed transaction. - **Tron (`CT_195`)**: JSON string of the signed transaction returned by a Tron signer, containing `raw_data` (with `contract[].parameter.value.owner_address`) and a `signature` array. Example: `{\"raw_data\":{\"contract\":[{\"type\":\"TriggerSmartContract\",\"parameter\":{\"value\":{\"owner_address\":\"T...\",\"contract_address\":\"T...\",\"data\":\"<calldata hex>\",\"call_value\":0}}}]},\"signature\":[\"...\"]}`. Note for Tron: `signedTransaction` is NOT the calldata hex passed to `simulate` / `getGasLimit` under `tronTx.triggerSmartContractParams.data`. The signer is extracted from `raw_data.contract[0].parameter.value.owner_address` and must match `address`; passing calldata hex here will be rejected with `code=40001, invalid signedTransaction: failed to parse Tron signedTransaction: syntax error`. | |
|**address** | **String** | Sender wallet address. Used for status attribution and signature verification. On Tron and Solana the address is case-sensitive base58check. | |
|**enableMevProtection** | **Boolean** | When true, route the transaction through a private mempool for MEV protection. | [optional] |


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**orderId** | **String** | Internal order identifier. Use this to query on-chain status via the post-transaction service. | [optional] |
|**txHash** | **String** | On-chain transaction hash. | [optional] |
|**txHash** | **String** | On-chain transaction hash. EVM chains return a hex hash; Tron returns a base58check hash; Solana returns a base58 hash. | [optional] |



17 changes: 17 additions & 0 deletions clients/web3-wallet/docs/BuildSolanaSwapInstructionsResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@


# BuildSolanaSwapInstructionsResponse


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**code** | **Integer** | | [optional] |
|**msg** | **String** | | [optional] |
|**data** | [**BuildSolanaSwapInstructionsResponseData**](BuildSolanaSwapInstructionsResponseData.md) | | [optional] |
|**timestamp** | **Long** | | [optional] |
|**success** | **Boolean** | | [optional] |



Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@


# BuildSolanaSwapInstructionsResponseData


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**addressLookupTableAccount** | **List<String>** | Address Lookup Table addresses (Base58) referenced by the transaction, including the platform-injected custom ALT. The caller must fetch each ALT account (`getAccountInfo`) and pass the parsed lookup data when compiling the v0 message. | [optional] |
|**instructionLists** | [**List<BuildSolanaSwapInstructionsResponseDataInstructionListsInner>**](BuildSolanaSwapInstructionsResponseDataInstructionListsInner.md) | Ordered uncompiled instructions to assemble into the v0 transaction. | [optional] |
|**routerResult** | [**BuildSolanaSwapInstructionsResponseDataRouterResult**](BuildSolanaSwapInstructionsResponseDataRouterResult.md) | | [optional] |
|**tx** | [**BuildSolanaSwapInstructionsResponseDataTx**](BuildSolanaSwapInstructionsResponseDataTx.md) | | [optional] |



Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@


# BuildSolanaSwapInstructionsResponseDataInstructionListsInner


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**programId** | **String** | Program that owns the instruction (Base58). | [optional] |
|**data** | **String** | Instruction data, Base64-encoded. May be an empty string for instructions without data. | [optional] |
|**accounts** | [**List<BuildSolanaSwapInstructionsResponseDataInstructionListsInnerAccountsInner>**](BuildSolanaSwapInstructionsResponseDataInstructionListsInnerAccountsInner.md) | Accounts referenced by the instruction, in ABI order. | [optional] |



Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@


# BuildSolanaSwapInstructionsResponseDataInstructionListsInnerAccountsInner


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**pubkey** | **String** | Account public key (Base58). | [optional] |
|**isSigner** | **Boolean** | Whether the account must sign the transaction. | [optional] |
|**isWritable** | **Boolean** | Whether the account is writable. | [optional] |



Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@


# BuildSolanaSwapInstructionsResponseDataRouterResult

Routing result (same shape and semantics as `/swap`'s `routerResult`).

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**binanceChainId** | **String** | Chain identifier (always `CT_501`). | [optional] |
|**vendorName** | **String** | Vendor that supplied the executed quote (Solana vendors include Jupiter, LiquidMesh). | [optional] |
|**fromTokenAmount** | **String** | Sell-token amount (smallest unit, integer string). | [optional] |
|**toTokenAmount** | **String** | Estimated buy-token amount (smallest unit, integer string). | [optional] |
|**tradeFee** | **String** | Estimated network fee in USD. | [optional] |
|**estimateGasFee** | **String** | Estimated compute units for the transaction (echoes `computeUnitLimit`). | [optional] |
|**router** | **String** | Routing path description, mints joined with \"--\". | [optional] |
|**priceImpactPercent** | **String** | Price impact percentage. | [optional] |
|**dexRouterList** | [**List<BuildSolanaSwapInstructionsResponseDataRouterResultDexRouterListInner>**](BuildSolanaSwapInstructionsResponseDataRouterResultDexRouterListInner.md) | Routing path segments (same shape as `/quote`'s `dexRouterList`). | [optional] |
|**fromToken** | [**BuildSolanaSwapInstructionsResponseDataRouterResultFromToken**](BuildSolanaSwapInstructionsResponseDataRouterResultFromToken.md) | | [optional] |
|**toToken** | [**BuildSolanaSwapInstructionsResponseDataRouterResultToToken**](BuildSolanaSwapInstructionsResponseDataRouterResultToToken.md) | | [optional] |



Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@


# BuildSolanaSwapInstructionsResponseDataRouterResultDexRouterListInner


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**dexProtocol** | [**BuildSolanaSwapInstructionsResponseDataRouterResultDexRouterListInnerDexProtocol**](BuildSolanaSwapInstructionsResponseDataRouterResultDexRouterListInnerDexProtocol.md) | | [optional] |
|**fromToken** | [**BuildSolanaSwapInstructionsResponseDataRouterResultDexRouterListInnerFromToken**](BuildSolanaSwapInstructionsResponseDataRouterResultDexRouterListInnerFromToken.md) | | [optional] |
|**fromTokenIndex** | **String** | | [optional] |
|**toToken** | [**BuildSolanaSwapInstructionsResponseDataRouterResultDexRouterListInnerToToken**](BuildSolanaSwapInstructionsResponseDataRouterResultDexRouterListInnerToToken.md) | | [optional] |
|**toTokenIndex** | **String** | | [optional] |



Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@


# BuildSolanaSwapInstructionsResponseDataRouterResultDexRouterListInnerDexProtocol


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**dexName** | **String** | | [optional] |
|**percent** | **String** | | [optional] |



Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@


# BuildSolanaSwapInstructionsResponseDataRouterResultDexRouterListInnerFromToken


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**tokenContractAddress** | **String** | | [optional] |
|**tokenSymbol** | **String** | | [optional] |



Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@


# BuildSolanaSwapInstructionsResponseDataRouterResultDexRouterListInnerToToken


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**tokenContractAddress** | **String** | | [optional] |
|**tokenSymbol** | **String** | | [optional] |



Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@


# BuildSolanaSwapInstructionsResponseDataRouterResultFromToken

Sell-token metadata.

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**tokenContractAddress** | **String** | | [optional] |
|**tokenSymbol** | **String** | | [optional] |
|**decimal** | **String** | | [optional] |



Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@


# BuildSolanaSwapInstructionsResponseDataRouterResultToToken

Buy-token metadata.

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**tokenContractAddress** | **String** | | [optional] |
|**tokenSymbol** | **String** | | [optional] |
|**decimal** | **String** | | [optional] |



Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@


# BuildSolanaSwapInstructionsResponseDataTx

Transaction summary (no `data` field — replaced by `instructionLists`). Contains the fields the caller needs to display or audit before signing.

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**from** | **String** | User wallet address (transaction sender / fee payer). | [optional] |
|**to** | **String** | Platform Router program address (the swap target program). | [optional] |
|**minReceiveAmount** | **String** | Minimum buy-token amount the user accepts at the slippage limit (smallest unit, integer string). | [optional] |
|**slippagePercent** | **String** | Slippage value applied to this transaction (percentage string). | [optional] |



2 changes: 2 additions & 0 deletions clients/web3-wallet/docs/BuildSwapTransactionResponseData.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
|------------ | ------------- | ------------- | -------------|
|**routerResult** | [**BuildSwapTransactionResponseDataRouterResult**](BuildSwapTransactionResponseDataRouterResult.md) | | [optional] |
|**tx** | [**BuildSwapTransactionResponseDataTx**](BuildSwapTransactionResponseDataTx.md) | | [optional] |
|**executionMode** | **String** | Execution mode for this swap. `SWAP` = sign the `tx` object and broadcast to the chain. `RFQ` = sign `rfq.typedDataToSign` with EIP-712 (`eth_signTypedData_v4`), then submit via `POST /order/submit` and poll `GET /order/{orderId}` for settlement status. Equity / RWA tokens always return `RFQ`. | [optional] |
|**rfq** | [**BuildSwapTransactionResponseDataRfq**](BuildSwapTransactionResponseDataRfq.md) | | [optional] |



18 changes: 18 additions & 0 deletions clients/web3-wallet/docs/BuildSwapTransactionResponseDataRfq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@


# BuildSwapTransactionResponseDataRfq

RFQ order payload. Present only when `executionMode=RFQ`. Contains the EIP-712 typed data to sign, the target vendor, the signing scheme, and (when requested) the approve transaction data.

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**vendor** | **String** | RFQ vendor that will settle this order on-chain. Pass this as the `vendor` field in `POST /order/submit`. | [optional] |
|**txType** | **String** | Transaction type for this RFQ order. Currently always `EIP712` (all three RFQ vendors use EIP-712 typed-data signing); reserved for future signing schemes. | [optional] |
|**typedDataToSign** | **String** | EIP-712 typed data payload for `eth_signTypedData_v4`, serialized as a hex string (or JSON-encoded string). Sign with the wallet that matches `userWalletAddress` from `/quote`. Pass the resulting signature as `userSignature` in `POST /order/submit`. | [optional] |
|**signingScheme** | **String** | Signing scheme required by this vendor. Pass this as `signingScheme` in `POST /order/submit`. | [optional] |
|**signatureData** | **List<String>** | Approve transaction data, present only when `approveTransaction=true` was passed and the from-token is an EVM ERC-20. Each element is a JSON string containing `approveContract` (the spender address, resolved per vendor: InchFusion→router, PcsXRfq→Permit2, CowSwap→VaultRelayer) and `approveTxCalldata` (the ERC-20 `approve()` calldata). Empty list otherwise. | [optional] |



Loading
Loading