Skip to content

skysellrequest.md

Latest commit

 

History

History
25 lines (20 loc) · 5.25 KB

skysellrequest.md

File metadata and controls

25 lines (20 loc) · 5.25 KB

SkySellRequest

Example Usage

import { SkySellRequest } from "@compass-labs/api-sdk/models/components";

let value: SkySellRequest = {
  tokenOut: "DAI",
  amount: 1.5,
  chain: "ethereum",
  sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
};

Fields

Field Type Required Description Example
actionType string ➖ N/A
tokenOut components.SkySellRequestTokenOut ✔️ The token you would like to swap 1:1 with USDS. Choose from DAI or USDC.
amount components.SkySellRequestAmount ✔️ The amount of USDS you would like to sell 1:1 for 'token_out'. 1.5
chain components.SkySellRequestChain ✔️ N/A
sender string ✔️ The address of the transaction sender. 0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B
estimateGas boolean ➖ Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed.