-
Notifications
You must be signed in to change notification settings - Fork 214
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: generic chain with sendAnywhere demo contract (#9460)
closes #9187 ## Description DRAFT until - [x] what to do about the way `transfer()` maps chainId to transferChannel? - [x] clean up git history - [x] update other facade callers - [x] integrate more fully with well-known chains: hot-new-chain gets added and "Nothing breaks." - [x] what to do with facade contract upgrade test, now that chainInfos is a caller thing? ### Security Considerations <!-- Does this change introduce new assumptions or dependencies that, if violated, could introduce security vulnerabilities? How does this PR change the boundaries between mutually-suspicious components? What new authorities are introduced by this change, perhaps by new API calls? --> ### Scaling Considerations <!-- Does this change require or encourage significant increase in consumption of CPU cycles, RAM, on-chain storage, message exchanges, or other scarce resources? If so, can that be prevented or mitigated? --> ### Documentation Considerations <!-- Give our docs folks some hints about what needs to be described to downstream users. Backwards compatibility: what happens to existing data or deployments when this code is shipped? Do we need to instruct users to do something to upgrade their saved data? If there is no upgrade path possible, how bad will that be for users? --> ### Testing Considerations <!-- Every PR should of course come with tests of its own functionality. What additional tests are still needed beyond those unit tests? How does this affect CI, other test automation, or the testnet? --> ### Upgrade Considerations <!-- What aspects of this PR are relevant to upgrading live production systems, and how should they be addressed? -->
- Loading branch information
Showing
17 changed files
with
713 additions
and
174 deletions.
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
168 changes: 168 additions & 0 deletions
168
packages/orchestration/src/examples/sendAnywhere.contract.js
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 |
|---|---|---|
| @@ -0,0 +1,168 @@ | ||
| import { makeDurableZone } from '@agoric/zone/durable.js'; | ||
| import { M, mustMatch } from '@endo/patterns'; | ||
| import { InvitationShape } from '@agoric/zoe/src/typeGuards.js'; | ||
| import { E } from '@endo/far'; | ||
| import { withdrawFromSeat } from '@agoric/zoe/src/contractSupport/zoeHelpers.js'; | ||
|
|
||
| import { AmountShape } from '@agoric/ertp'; | ||
| import { prepareRecorderKitMakers } from '@agoric/zoe/src/contractSupport/recorder.js'; | ||
| import { CosmosChainInfoShape } from '../typeGuards.js'; | ||
| import { makeOrchestrationFacade } from '../facade.js'; | ||
| import { prepareLocalChainAccountKit } from '../exos/local-chain-account-kit.js'; | ||
| import { makeChainHub } from '../utils/chainHub.js'; | ||
|
|
||
| const { entries } = Object; | ||
| const { Fail } = assert; | ||
|
|
||
| /** | ||
| * @import {Baggage} from '@agoric/vat-data'; | ||
| * @import {CosmosChainInfo, IBCConnectionInfo} from '../cosmos-api'; | ||
| * @import {TimerService, TimerBrand} from '@agoric/time'; | ||
| * @import {LocalChain} from '@agoric/vats/src/localchain.js'; | ||
| * @import {OrchestrationService} from '../service.js'; | ||
| * @import {NameHub} from '@agoric/vats'; | ||
| * @import {Remote} from '@agoric/vow'; | ||
| */ | ||
|
|
||
| /** | ||
| * @typedef {{ | ||
| * localchain: Remote<LocalChain>; | ||
| * orchestrationService: Remote<OrchestrationService>; | ||
| * storageNode: Remote<StorageNode>; | ||
| * timerService: Remote<TimerService>; | ||
| * agoricNames: Remote<NameHub>; | ||
| * }} OrchestrationPowers | ||
| */ | ||
|
|
||
| export const SingleAmountRecord = M.and( | ||
| M.recordOf(M.string(), AmountShape, { | ||
| numPropertiesLimit: 1, | ||
| }), | ||
| M.not(harden({})), | ||
| ); | ||
|
|
||
| /** | ||
| * @param {ZCF} zcf | ||
| * @param {OrchestrationPowers & { | ||
| * marshaller: Marshaller; | ||
| * }} privateArgs | ||
| * @param {Baggage} baggage | ||
| */ | ||
| export const start = async (zcf, privateArgs, baggage) => { | ||
| const zone = makeDurableZone(baggage); | ||
|
|
||
| const chainHub = makeChainHub(privateArgs.agoricNames); | ||
|
|
||
| // TODO once durability is settled, provide some helpers to reduce boilerplate | ||
| const { marshaller, ...orchPowers } = privateArgs; | ||
| const { makeRecorderKit } = prepareRecorderKitMakers(baggage, marshaller); | ||
| const makeLocalChainAccountKit = prepareLocalChainAccountKit( | ||
| zone, | ||
| makeRecorderKit, | ||
| zcf, | ||
| privateArgs.timerService, | ||
| chainHub, | ||
| ); | ||
| const { orchestrate } = makeOrchestrationFacade({ | ||
| zcf, | ||
| zone, | ||
| chainHub, | ||
| makeLocalChainAccountKit, | ||
| ...orchPowers, | ||
| }); | ||
|
|
||
| let contractAccount; | ||
|
|
||
| const findBrandInVBank = async brand => { | ||
| const assets = await E( | ||
| E(privateArgs.agoricNames).lookup('vbankAsset'), | ||
| ).values(); | ||
| const it = assets.find(a => a.brand === brand); | ||
| it || Fail`brand ${brand} not in agoricNames.vbankAsset`; | ||
| return it; | ||
| }; | ||
|
|
||
| /** @type {OfferHandler} */ | ||
| const sendIt = orchestrate( | ||
| 'sendIt', | ||
| { zcf }, | ||
| // eslint-disable-next-line no-shadow -- this `zcf` is enclosed in a membrane | ||
| async (orch, { zcf }, seat, offerArgs) => { | ||
| mustMatch( | ||
| offerArgs, | ||
| harden({ chainName: M.scalar(), destAddr: M.string() }), | ||
| ); | ||
| const { chainName, destAddr } = offerArgs; | ||
| const { give } = seat.getProposal(); | ||
| const [[kw, amt]] = entries(give); | ||
| const { denom } = await findBrandInVBank(amt.brand); | ||
| const chain = await orch.getChain(chainName); | ||
|
|
||
| // XXX ok to use a heap var crossing the membrane scope this way? | ||
| if (!contractAccount) { | ||
| const agoricChain = await orch.getChain('agoric'); | ||
| contractAccount = await agoricChain.makeAccount(); | ||
| } | ||
|
|
||
| const info = await chain.getChainInfo(); | ||
| const { chainId } = info; | ||
| const { [kw]: pmtP } = await withdrawFromSeat(zcf, seat, give); | ||
| await E.when(pmtP, pmt => contractAccount.deposit(pmt, amt)); | ||
| await contractAccount.transfer( | ||
| { denom, value: amt.value }, | ||
| { | ||
| address: destAddr, | ||
| addressEncoding: 'bech32', | ||
| chainId, | ||
| }, | ||
| ); | ||
| }, | ||
| ); | ||
|
|
||
| const publicFacet = zone.exo( | ||
| 'Send PF', | ||
| M.interface('Send PF', { | ||
| makeSendInvitation: M.callWhen().returns(InvitationShape), | ||
| }), | ||
| { | ||
| makeSendInvitation() { | ||
| return zcf.makeInvitation( | ||
| sendIt, | ||
| 'send', | ||
| undefined, | ||
| M.splitRecord({ give: SingleAmountRecord }), | ||
| ); | ||
| }, | ||
| }, | ||
| ); | ||
|
|
||
| let nonce = 0n; | ||
| const ConnectionInfoShape = M.record(); // TODO | ||
| const creatorFacet = zone.exo( | ||
| 'Send CF', | ||
| M.interface('Send CF', { | ||
| addChain: M.callWhen(CosmosChainInfoShape, ConnectionInfoShape).returns( | ||
| M.scalar(), | ||
| ), | ||
| }), | ||
| { | ||
| /** | ||
| * @param {CosmosChainInfo} chainInfo | ||
| * @param {IBCConnectionInfo} connectionInfo | ||
| */ | ||
| async addChain(chainInfo, connectionInfo) { | ||
| const chainKey = `${chainInfo.chainId}-${(nonce += 1n)}`; | ||
| const agoricChainInfo = await chainHub.getChainInfo('agoric'); | ||
| chainHub.registerChain(chainKey, chainInfo); | ||
| chainHub.registerConnection( | ||
| agoricChainInfo.chainId, | ||
| chainInfo.chainId, | ||
| connectionInfo, | ||
| ); | ||
| return chainKey; | ||
| }, | ||
| }, | ||
| ); | ||
|
|
||
| return { publicFacet, creatorFacet }; | ||
| }; |
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
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.