-
Notifications
You must be signed in to change notification settings - Fork 212
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(orchestrate): membrane friendly wrapper for agoricNames
* Perform remote calls to agoricNames in membrane-friendly way. This is an * interim approach until #9541, * #9322, or * #9519
- Loading branch information
1 parent
ba6eb45
commit 653bde3
Showing
4 changed files
with
164 additions
and
23 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
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,96 @@ | ||
| import { VowShape } from '@agoric/vow'; | ||
| import { E } from '@endo/far'; | ||
| import { M, makeCopyMap } from '@endo/patterns'; | ||
| import { BrandShape } from '@agoric/ertp'; | ||
|
|
||
| const { Fail } = assert; | ||
|
|
||
| /** | ||
| * @import {NameHub} from '@agoric/vats'; | ||
| * @import {AssetInfo} from '@agoric/vats/src/vat-bank.js'; | ||
| * @import {Remote} from '@agoric/internal'; | ||
| * @import {Vow, VowTools} from '@agoric/vow'; | ||
| * @import {Zone} from '@agoric/zone'; | ||
| */ | ||
|
|
||
| /** | ||
| * Perform remote calls to agoricNames in membrane-friendly way. This is an | ||
| * interim approach until https://github.com/Agoric/agoric-sdk/issues/9541, | ||
| * https://github.com/Agoric/agoric-sdk/pull/9322, or | ||
| * https://github.com/Agoric/agoric-sdk/pull/9519 | ||
| * | ||
| * XXX consider exposing `has`, `entries`, `keys`, `values` from `NameHub` | ||
| * | ||
| * @param {Zone} zone | ||
| * @param {{ agoricNames: Remote<NameHub>; vowTools: VowTools }} powers | ||
| */ | ||
| export const makeResumableAgoricNamesHack = ( | ||
| zone, | ||
| { agoricNames, vowTools: { watch } }, | ||
| ) => { | ||
| const makeResumableAgoricNamesHackKit = zone.exoClassKit( | ||
| 'ResumableAgoricNamesHack', | ||
| { | ||
| public: M.interface('ResumableAgoricNamesHackI', { | ||
| lookup: M.call().rest(M.arrayOf(M.string())).returns(VowShape), | ||
| findBrandInVBank: M.call(BrandShape).returns(VowShape), | ||
| }), | ||
| vbankAssetEntriesWatcher: M.interface('vbankAssetEntriesWatcher', { | ||
| onFulfilled: M.call(M.arrayOf(M.record())) | ||
| .optional({ brand: BrandShape }) | ||
| .returns(VowShape), | ||
| }), | ||
| }, | ||
| () => ({ | ||
| vbankAssetsByBrand: zone.mapStore('vbankAssetsByBrand', { | ||
| keyShape: BrandShape, | ||
| valueShape: M.any(), | ||
| }), | ||
| }), | ||
| { | ||
| vbankAssetEntriesWatcher: { | ||
| /** | ||
| * @param {AssetInfo[]} assets | ||
| * @param {{ brand: Brand<'nat'> }} ctx | ||
| */ | ||
| onFulfilled(assets, { brand }) { | ||
| const { vbankAssetsByBrand } = this.state; | ||
| vbankAssetsByBrand.addAll(makeCopyMap(assets.map(a => [a.brand, a]))); | ||
| if (!vbankAssetsByBrand.has(brand)) { | ||
| return watch( | ||
| Promise.reject( | ||
| Fail`brand ${brand} not in agoricNames.vbankAsset`, | ||
| ), | ||
| ); | ||
| } | ||
| return watch(vbankAssetsByBrand.get(brand)); | ||
| }, | ||
| }, | ||
| public: { | ||
| /** @param {...string} args */ | ||
| lookup(...args) { | ||
| return watch(E(agoricNames).lookup(...args)); | ||
| }, | ||
| /** | ||
| * @param {Brand<'nat'>} brand | ||
| * @returns {Vow<AssetInfo>} | ||
| */ | ||
| findBrandInVBank(brand) { | ||
| const { vbankAssetsByBrand } = this.state; | ||
| if (vbankAssetsByBrand.has(brand)) { | ||
| return watch(vbankAssetsByBrand.get(brand)); | ||
| } | ||
| const vbankAssetNameHubP = E(agoricNames).lookup('vbankAsset'); | ||
| const vbankAssetEntriesP = E(vbankAssetNameHubP).values(); | ||
| return watch( | ||
| vbankAssetEntriesP, | ||
| this.facets.vbankAssetEntriesWatcher, | ||
| { brand }, | ||
| ); | ||
| }, | ||
| }, | ||
| }, | ||
| ); | ||
| return makeResumableAgoricNamesHackKit().public; | ||
| }; | ||
| /** @typedef {ReturnType<typeof makeResumableAgoricNamesHack>} AgNamesTools */ |
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
52 changes: 52 additions & 0 deletions
52
packages/orchestration/test/exos/agoric-names-tools.test.ts
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,52 @@ | ||
| import { test } from '@agoric/zoe/tools/prepare-test-env-ava.js'; | ||
|
|
||
| import { E } from '@endo/far'; | ||
| import { V } from '@agoric/vow/vat.js'; | ||
| import { makeHeapZone } from '@agoric/zone'; | ||
| import { withAmountUtils } from '@agoric/zoe/tools/test-utils.js'; | ||
| import { makeIssuerKit } from '@agoric/ertp'; | ||
| import { makeResumableAgoricNamesHack } from '../../src/exos/agoric-names-tools.js'; | ||
| import { commonSetup } from '../supports.js'; | ||
|
|
||
| test('agoric names tools', async t => { | ||
| const { | ||
| bootstrap: { agoricNames, agoricNamesAdmin, bankManager, vowTools }, | ||
| brands: { ist }, | ||
| } = await commonSetup(t); | ||
|
|
||
| const zone = makeHeapZone(); | ||
| const agNamesTools = makeResumableAgoricNamesHack(zone, { | ||
| agoricNames, | ||
| vowTools, | ||
| }); | ||
|
|
||
| const chainEntry = await V.when(agNamesTools.lookup('chain', 'celestia')); | ||
| t.like(chainEntry, { chainId: 'celestia' }); | ||
|
|
||
| const istDenom = await V.when(agNamesTools.findBrandInVBank(ist.brand)); | ||
| t.like(istDenom, { denom: 'uist' }); | ||
|
|
||
| const moolah = withAmountUtils(makeIssuerKit('MOO')); | ||
|
|
||
| await t.throwsAsync(V.when(agNamesTools.findBrandInVBank(moolah.brand)), { | ||
| message: /brand(.*?)not in agoricNames.vbankAsset/, | ||
| }); | ||
|
|
||
| await E(E(agoricNamesAdmin).lookupAdmin('vbankAsset')).update( | ||
| 'umoo', | ||
| /** @type {AssetInfo} */ harden({ | ||
| brand: moolah.brand, | ||
| issuer: moolah.issuer, | ||
| issuerName: 'MOO', | ||
| denom: 'umoo', | ||
| proposedName: 'MOO', | ||
| displayInfo: { decimals: 6, symbol: 'MOO' }, | ||
| }), | ||
| ); | ||
|
|
||
| t.like( | ||
| await V.when(agNamesTools.findBrandInVBank(moolah.brand)), | ||
| { denom: 'umoo' }, | ||
| 'refresh stale cache for new assets', | ||
| ); | ||
| }); |