feat: fusdc advancer #10420
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,124 +1,234 @@ | ||
| import { AmountMath, AmountShape, PaymentShape } from '@agoric/ertp'; | ||
| import { assertAllDefined } from '@agoric/internal'; | ||
| import { ChainAddressShape } from '@agoric/orchestration'; | ||
| import { pickFacet } from '@agoric/vat-data'; | ||
| import { VowShape } from '@agoric/vow'; | ||
| import { q } from '@endo/errors'; | ||
| import { E } from '@endo/far'; | ||
| import { M } from '@endo/patterns'; | ||
| import { CctpTxEvidenceShape, EudParamShape } from '../typeGuards.js'; | ||
| import { addressTools } from '../utils/address.js'; | ||
|
|
||
| const { isGTE } = AmountMath; | ||
|
|
||
| /** | ||
| * @import {HostInterface} from '@agoric/async-flow'; | ||
| * @import {NatAmount} from '@agoric/ertp'; | ||
| * @import {ChainAddress, ChainHub, Denom, DenomAmount, OrchestrationAccount} from '@agoric/orchestration'; | ||
| * @import {VowTools} from '@agoric/vow'; | ||
| * @import {Zone} from '@agoric/zone'; | ||
| * @import {CctpTxEvidence, LogFn} from '../types.js'; | ||
| * @import {StatusManager} from './status-manager.js'; | ||
| */ | ||
|
|
||
| /** | ||
| * Expected interface from LiquidityPool | ||
|
|
||
| * | ||
| * @typedef {{ | ||
| * lookupBalance(): NatAmount; | ||
| * borrow(amount: Amount<"nat">): Promise<Payment<"nat">>; | ||
| * repay(payments: PaymentKeywordRecord): Promise<void> | ||
| * }} AssetManagerFacet | ||
| */ | ||
|
|
||
| /** | ||
| * @typedef {{ | ||
| * chainHub: ChainHub; | ||
| * log: LogFn; | ||
| * statusManager: StatusManager; | ||
| * usdc: { brand: Brand<'nat'>; denom: Denom; }; | ||
| * vowTools: VowTools; | ||
| * }} AdvancerKitPowers | ||
| */ | ||
|
|
||
| /** type guards internal to the AdvancerKit */ | ||
| const AdvancerKitI = harden({ | ||
| advancer: M.interface('AdvancerI', { | ||
| handleTransactionEvent: M.callWhen(CctpTxEvidenceShape).returns(), | ||
| }), | ||
| depositHandler: M.interface('DepositHandlerI', { | ||
| onFulfilled: M.call(AmountShape, { | ||
| destination: ChainAddressShape, | ||
| payment: PaymentShape, | ||
| }).returns(VowShape), | ||
| onRejected: M.call(M.error(), { | ||
| destination: ChainAddressShape, | ||
| payment: PaymentShape, | ||
| }).returns(), | ||
| }), | ||
| transferHandler: M.interface('TransferHandlerI', { | ||
| // TODO confirm undefined, and not bigint (sequence) | ||
| onFulfilled: M.call(M.undefined(), { | ||
| amount: AmountShape, | ||
| destination: ChainAddressShape, | ||
| }).returns(M.undefined()), | ||
| onRejected: M.call(M.error(), { | ||
| amount: AmountShape, | ||
| destination: ChainAddressShape, | ||
| }).returns(M.undefined()), | ||
| }), | ||
| }); | ||
|
|
||
| /** | ||
| * @param {Zone} zone | ||
| * @param {AdvancerKitPowers} caps | ||
| */ | ||
| export const prepareAdvancerKit = ( | ||
| zone, | ||
| { chainHub, log, statusManager, usdc, vowTools: { watch, when } }, | ||
| ) => { | ||
| assertAllDefined({ | ||
| chainHub, | ||
| statusManager, | ||
| watch, | ||
| when, | ||
| }); | ||
|
|
||
| /** @param {bigint} value */ | ||
| const toAmount = value => AmountMath.make(usdc.brand, value); | ||
|
|
||
| return zone.exoClassKit( | ||
| 'Fast USDC Advancer', | ||
| AdvancerKitI, | ||
| /** | ||
| * @param {{ | ||
| * assetManagerFacet: AssetManagerFacet; | ||
| * poolAccount: ERef<HostInterface<OrchestrationAccount<{chainId: 'agoric'}>>>; | ||
| * }} config | ||
| */ | ||
| config => harden(config), | ||
| { | ||
| advancer: { | ||
| /** | ||
| * Must perform a status update for every observed transaction. | ||
| * | ||
| * We do not expect any callers to depend on the settlement of | ||
turadg marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * `handleTransactionEvent` - errors caught are communicated to the | ||
| * `StatusManager` - so we don't need to concern ourselves with | ||
| * preserving the vow chain for callers. | ||
| * | ||
| * @param {CctpTxEvidence} evidence | ||
| */ | ||
| async handleTransactionEvent(evidence) { | ||
| await null; | ||
| try { | ||
| // TODO poolAccount might be a vow we need to unwrap | ||
| const { assetManagerFacet, poolAccount } = this.state; | ||
| const { recipientAddress } = evidence.aux; | ||
| const { EUD } = addressTools.getQueryParams( | ||
| recipientAddress, | ||
| EudParamShape, | ||
| ); | ||
|
|
||
| // this will throw if the bech32 prefix is not found, but is handled by the catch | ||
| const destination = chainHub.makeChainAddress(EUD); | ||
| const requestedAmount = toAmount(evidence.tx.amount); | ||
|
|
||
| // TODO: consider skipping and using `borrow()`s internal balance check | ||
| const poolBalance = assetManagerFacet.lookupBalance(); | ||
| if (!isGTE(poolBalance, requestedAmount)) { | ||
| log( | ||
| `Insufficient pool funds`, | ||
| `Requested ${q(requestedAmount)} but only have ${q(poolBalance)}`, | ||
| ); | ||
| statusManager.observe(evidence); | ||
|
There was a problem hiding this comment. I suppose we'll want to log this even to vstorage. But let's come back to it after getting more clarity with product on all the error handling and what the end user needs to see from it. We have that on the schedule. |
||
| return; | ||
| } | ||
|
|
||
| try { | ||
| // Mark as Advanced since `transferV` initiates the advance. | ||
| // Will throw if we've already .skipped or .advanced this evidence. | ||
| statusManager.advance(evidence); | ||
| } catch (e) { | ||
| // Only anticipated error is `assertNotSeen`, so intercept the | ||
| // catch so we don't call .skip which also performs this check | ||
| log('Advancer error:', q(e).toString()); | ||
| return; | ||
| } | ||
|
|
||
| try { | ||
| const payment = await assetManagerFacet.borrow(requestedAmount); | ||
| const depositV = E(poolAccount).deposit(payment); | ||
| void watch(depositV, this.facets.depositHandler, { | ||
| destination, | ||
| payment, | ||
| }); | ||
| } catch (e) { | ||
| // `.borrow()` might fail if the balance changes since we | ||
| // requested it. TODO - how to handle this? change ADVANCED -> OBSERVED? | ||
| // Note: `depositHandler` handles the `.deposit()` failure | ||
| log('🚨 advance borrow failed', q(e).toString()); | ||
| } | ||
| } catch (e) { | ||
| log('Advancer error:', q(e).toString()); | ||
| statusManager.observe(evidence); | ||
| } | ||
| }, | ||
| }, | ||
| depositHandler: { | ||
| /** | ||
| * @param {NatAmount} amount amount returned from deposit | ||
| * @param {{ destination: ChainAddress; payment: Payment<'nat'> }} ctx | ||
| */ | ||
| onFulfilled(amount, { destination }) { | ||
| const { poolAccount } = this.state; | ||
| const transferV = E(poolAccount).transfer( | ||
| destination, | ||
| /** @type {DenomAmount} */ ({ | ||
| denom: usdc.denom, | ||
| value: amount.value, | ||
| }), | ||
| ); | ||
| return watch(transferV, this.facets.transferHandler, { | ||
| destination, | ||
| amount, | ||
| }); | ||
| }, | ||
| /** | ||
| * @param {Error} error | ||
| * @param {{ destination: ChainAddress; payment: Payment<'nat'> }} ctx | ||
| */ | ||
| onRejected(error, { payment }) { | ||
| // TODO return live payment from ctx to LP | ||
| log('🚨 advance deposit failed', q(error).toString()); | ||
| log('TODO live payment to return to LP', q(payment).toString()); | ||
| }, | ||
| }, | ||
| transferHandler: { | ||
| /** | ||
| * @param {undefined} result TODO confirm this is not a bigint (sequence) | ||
| * @param {{ destination: ChainAddress; amount: NatAmount; }} ctx | ||
| */ | ||
| onFulfilled(result, { destination, amount }) { | ||
| // TODO vstorage update? | ||
| log( | ||
| 'Advance transfer fulfilled', | ||
| q({ amount, destination, result }).toString(), | ||
| ); | ||
| }, | ||
| onRejected(error) { | ||
| // XXX retry logic? | ||
| // What do we do if we fail, should we keep a Status? | ||
| log('Advance transfer rejected', q(error).toString()); | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| stateShape: harden({ | ||
| assetManagerFacet: M.remotable(), | ||
| poolAccount: M.or(VowShape, M.remotable()), | ||
|
There was a problem hiding this comment. This seems like it'll depend on:
|
||
| }), | ||
| }, | ||
| ); | ||
| }; | ||
| harden(prepareAdvancerKit); | ||
|
|
||
| /** | ||
| * @param {Zone} zone | ||
| * @param {AdvancerKitPowers} caps | ||
| */ | ||
| export const prepareAdvancer = (zone, caps) => { | ||
| const makeAdvancerKit = prepareAdvancerKit(zone, caps); | ||
| return pickFacet(makeAdvancerKit, 'advancer'); | ||
| }; | ||
| harden(prepareAdvancer); | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
out of scope, but this helper should move eventually. It's about Exos, not vat data.
We could move it down to
@agoric/internalbut that is meant to not be consumed externally and this is valuable to other contract authors.I wonder if it belongs in Endo.