WT-1727 Update smart checkout output interfaces #924
Conversation
| * @property {SuccessStatus | FailedStatus | InsufficientFundsStatus} status - The status of the action. | ||
| * @property {Array<SmartCheckoutSufficient | SmartCheckoutInsufficient>} smartCheckoutResult - The result of the smart checkout. | ||
| */ | ||
| export type ActionResult = { |
There was a problem hiding this comment.
I can't remember if we discussed this in your types review meeting but ActionResult seems like a very generic name which doesn't give much context as to what it is describing. I wonder if this is worth reviewing?
I think we can reduce the layers here by making a BuyResult, SellResult and CancelResult.
Then further down the orders type won't have to be this | that | that
There was a problem hiding this comment.
Yeah I raised this but dont think I got much of an opinion on it - but I agree its super generic so I'll update this
| @@ -131,13 +131,14 @@ export const SmartCheckoutForm = ({ checkout, provider }: SmartCheckoutProps) => | |||
| setLoading(true); | |||
|
|
|||
| try { | |||
| checkout.smartCheckout( | |||
| const result = await checkout.smartCheckout( | |||
There was a problem hiding this comment.
Oh nice, I noticed the await in my current branch, def helps with the loading state!
| asset: { | ||
| balance: BigNumber.from(10), | ||
| formattedBalance: '10', | ||
| fundingItem: { |
There was a problem hiding this comment.
This is looking good! 👍
| { | ||
| gasFee: { | ||
| estimatedAmount: BigNumber; | ||
| token?: TokenInfo; | ||
| }; | ||
| bridgeFee: { | ||
| estimatedAmount: BigNumber; | ||
| token?: TokenInfo; | ||
| }; | ||
| totalFees: BigNumber; | ||
| } |
There was a problem hiding this comment.
Do we have a type for this object?
There was a problem hiding this comment.
thanks, yea we do - just pushed update
|
|
||
| /** | ||
| * Interface representing the parameters for {@link Checkout.sell} | ||
| * @property {Web3Provider} provider - The provider to use for the sell. | ||
| * @property {Array<SellOrder>} orders - An array of sell orders to execute. | ||
| * Only currently actions the first order in the array until we support batch processing. | ||
| * Currently only actions the first order in the array until batch processing is supported. |
There was a problem hiding this comment.
Perhaps say only 'processes' the first order to be inline with batch processing
| token: { | ||
| ...requiredBalance.token, | ||
| ...required.token, | ||
| }, |
| fundsRequired: { | ||
| amount: required.balance, | ||
| formattedAmount: required.formattedBalance, | ||
| }, |
There was a problem hiding this comment.
should this be the delta?
Summary
Updates smart checkout, buy, sell and cancel endpoints to align to this doc