@agoric/casting 0.3.5-pismo-dev-0d5327f.0 → 0.4.1-dev-bf4b59f.0

package/src/leader-netconfig.js

@@ -1,4 +1,3 @@
-// @ts-check
 /* global fetch */
 import { makeRoundRobinLeader } from './leader.js';
 import {
@@ -6,8 +5,9 @@ import {
   DEFAULT_JITTER,
   DEFAULT_RETRY_CALLBACK,
 } from './defaults.js';
+import { assertNetworkConfig } from './netconfig.js';
 
-const { details: X } = assert;
+const { Fail } = assert;
 
 /**
  * @param {string[]} rpcAddrs
@@ -15,10 +15,10 @@ const { details: X } = assert;
  * @returns {import('./types.js').Leader}
  */
 export const makeLeaderFromRpcAddresses = (rpcAddrs, leaderOptions) => {
-  assert(Array.isArray(rpcAddrs), X`rpcAddrs ${rpcAddrs} must be an array`);
+  Array.isArray(rpcAddrs) || Fail`rpcAddrs ${rpcAddrs} must be an array`;
 
   const rpcHrefs = rpcAddrs.map(rpcAddr => {
-    assert.typeof(rpcAddr, 'string', X`rpcAddr ${rpcAddr} must be a string`);
+    typeof rpcAddr === 'string' || Fail`rpcAddr ${rpcAddr} must be a string`;
     // Don't remove explicit port numbers from the URL, because the Cosmos
     // `--node=xxx` flag requires them (it doesn't just assume that
     // `--node=https://testnet.rpc.agoric.net` is the same as
@@ -50,7 +50,9 @@ export const makeLeaderFromNetworkConfig = (netconfigURL, options = {}) => {
       const response = await fetch(netconfigURL, {
         headers: { accept: 'application/json' },
       });
-      const { rpcAddrs } = await response.json();
+      const networkConfig = await response.json();
+      assertNetworkConfig(harden(networkConfig));
+      const { rpcAddrs } = networkConfig;
       // Our part succeeded, so reset the attempt counter.
       attempt = 0;
       return makeLeaderFromRpcAddresses(rpcAddrs, options);
@@ -77,4 +79,3 @@ export const makeLeader = (bootstrap = DEFAULT_BOOTSTRAP, options) => {
   }
   return makeLeaderFromRpcAddresses([bootstrap], options);
 };
-/** @typedef {ReturnType<typeof makeLeader>} Leader */

package/src/leader.d.ts

@@ -0,0 +1,2 @@
+export function makeRoundRobinLeader(endpoints: string[], leaderOptions?: import('./types.js').LeaderOptions): import("./types.js").Leader;
+//# sourceMappingURL=leader.d.ts.map

package/src/leader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"leader.d.ts","sourceRoot":"","sources":["leader.js"],"names":[],"mappings":"AAWO,gDAHI,MAAM,EAAE,kBACR,OAAO,YAAY,EAAE,aAAa,+BA2E5C"}

package/src/leader.js

@@ -1,4 +1,3 @@
-// @ts-check
 import { E, Far } from '@endo/far';
 import { DEFAULT_RETRY_CALLBACK, DEFAULT_JITTER } from './defaults.js';
 import { shuffle } from './shuffle.js';

package/src/main.d.ts

@@ -0,0 +1,9 @@
+export * from "./types.js";
+export * from "./defaults.js";
+export * from "./leader-netconfig.js";
+export * from "./follower.js";
+export * from "./follower-cosmjs.js";
+export * from "./casting-spec.js";
+export * from "./leader.js";
+export * from "./iterable.js";
+//# sourceMappingURL=main.d.ts.map

package/src/main.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["main.js"],"names":[],"mappings":""}

package/src/main.js

@@ -1,3 +1,5 @@
+// @jessie-check
+
 // eslint-disable-next-line import/export
 export * from './types.js'; // no named exports
 export * from './defaults.js';

package/src/netconfig.d.ts

@@ -0,0 +1,47 @@
+/**
+ * @typedef {object} NetworkConfig
+ * `peers` and `seeds` are only used for configuring full nodes participating in
+ * the chain’s p2p network, not for rpc clients.  The `gci` is needed for rpc
+ * “light clients” to prove the ancestry of data fetched from the rpc node.
+ *
+ * @property {string[]} rpcAddrs endpoints serving https://docs.tendermint.com/v0.34/rpc/
+ * @property {string} chainName e.g. agoric-3
+ * @property {string[]} [apiAddrs] overrides for REST endpoints of RPC servers https://docs.cosmos.network/main/run-node/interact-node#using-the-rest-endpoints
+ * @property {string} [gci] - "global chain identifier", a hash of the genesis block
+ * @property {string[]} [peers] - a list of nodes used to start the p2p gossip (stored in a per-node “address book”, which is a file stored in that node’s data directory)
+ * @property {string[]} [seeds] - nodes which tell you about other peers but don't gossip actual data
+ */
+export const NetworkConfigShape: import("@endo/patterns").Matcher;
+export function assertNetworkConfig(specimen: unknown): asserts specimen is NetworkConfig;
+/**
+ * `peers` and `seeds` are only used for configuring full nodes participating in
+ * the chain’s p2p network, not for rpc clients.  The `gci` is needed for rpc
+ * “light clients” to prove the ancestry of data fetched from the rpc node.
+ */
+export type NetworkConfig = {
+    /**
+     * endpoints serving https://docs.tendermint.com/v0.34/rpc/
+     */
+    rpcAddrs: string[];
+    /**
+     * e.g. agoric-3
+     */
+    chainName: string;
+    /**
+     * overrides for REST endpoints of RPC servers https://docs.cosmos.network/main/run-node/interact-node#using-the-rest-endpoints
+     */
+    apiAddrs?: string[] | undefined;
+    /**
+     * - "global chain identifier", a hash of the genesis block
+     */
+    gci?: string | undefined;
+    /**
+     * - a list of nodes used to start the p2p gossip (stored in a per-node “address book”, which is a file stored in that node’s data directory)
+     */
+    peers?: string[] | undefined;
+    /**
+     * - nodes which tell you about other peers but don't gossip actual data
+     */
+    seeds?: string[] | undefined;
+};
+//# sourceMappingURL=netconfig.d.ts.map

package/src/netconfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"netconfig.d.ts","sourceRoot":"","sources":["netconfig.js"],"names":[],"mappings":"AAKA;;;;;;;;;;;;GAYG;AACH,kEAWE;AAQK,8CAJI,OAAO,qCAKuB;;;;;;;;;;cA3B3B,MAAM,EAAE;;;;eACR,MAAM"}

package/src/netconfig.js

@@ -0,0 +1,40 @@
+// @jessie-check
+
+import { mustMatch, M } from '@agoric/store';
+
+// NB: keep type and shape in sync manually until https://github.com/Agoric/agoric-sdk/issues/6160
+/**
+ * @typedef {object} NetworkConfig
+ * `peers` and `seeds` are only used for configuring full nodes participating in
+ * the chain’s p2p network, not for rpc clients.  The `gci` is needed for rpc
+ * “light clients” to prove the ancestry of data fetched from the rpc node.
+ *
+ * @property {string[]} rpcAddrs endpoints serving https://docs.tendermint.com/v0.34/rpc/
+ * @property {string} chainName e.g. agoric-3
+ * @property {string[]} [apiAddrs] overrides for REST endpoints of RPC servers https://docs.cosmos.network/main/run-node/interact-node#using-the-rest-endpoints
+ * @property {string} [gci] - "global chain identifier", a hash of the genesis block
+ * @property {string[]} [peers] - a list of nodes used to start the p2p gossip (stored in a per-node “address book”, which is a file stored in that node’s data directory)
+ * @property {string[]} [seeds] - nodes which tell you about other peers but don't gossip actual data
+ */
+export const NetworkConfigShape = M.splitRecord(
+  harden({
+    chainName: M.string(),
+    rpcAddrs: M.arrayOf(M.string()),
+  }),
+  harden({
+    apiAddrs: M.arrayOf(M.string()),
+    gci: M.string(),
+    peers: M.arrayOf(M.string()),
+    seeds: M.arrayOf(M.string()),
+  }),
+);
+harden(NetworkConfigShape);
+
+/**
+ * @param {unknown} specimen
+ * @returns {asserts specimen is NetworkConfig}
+ */
+
+export const assertNetworkConfig = specimen =>
+  mustMatch(specimen, NetworkConfigShape);
+harden(assertNetworkConfig);

package/src/shuffle.d.ts

@@ -0,0 +1,2 @@
+export function shuffle<T>(a: T[]): void;
+//# sourceMappingURL=shuffle.d.ts.map

package/src/shuffle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shuffle.d.ts","sourceRoot":"","sources":["shuffle.js"],"names":[],"mappings":"AAMO,yCAON"}

package/src/shuffle.js

@@ -1,5 +1,3 @@
-// @ts-check
-
 /**
  * Modern version of Fisher-Yates shuffle algorithm (in-place).
  *

package/src/types.d.ts

@@ -0,0 +1,54 @@
+export type ERef<T> = import('@endo/far').ERef<T>;
+export type LeaderOptions = {
+    retryCallback?: ((where: string, err: any, attempt?: number) => Promise<void>) | null | undefined;
+    jitter?: ((where: string) => Promise<void>) | undefined;
+    keepPolling?: ((where: string) => Promise<boolean>) | undefined;
+};
+export type CastingChange = {
+    blockHeight?: number | undefined;
+    values: Uint8Array[];
+};
+export type Leader = {
+    retry: (where: string, error: any, attempt?: number) => Promise<void>;
+    jitter: (where: string) => Promise<void>;
+    getOptions: () => LeaderOptions;
+    mapEndpoints: <T>(where: string, callback: (endpoint: string) => Promise<T>) => Promise<T[]>;
+    watchCasting: (spec: ERef<CastingSpec>) => Promise<Follower<CastingChange>>;
+};
+export type LeaderOrMaker = ERef<Leader> | (() => ERef<Leader>);
+export type Follower<T> = {
+    getLatestIterable: () => Promise<AsyncIterable<T>>;
+    getEachIterable: (options?: IterateEachOptions) => Promise<AsyncIterable<T>>;
+    getReverseIterable: (options?: IterateEachOptions) => Promise<AsyncIterable<T>>;
+};
+export type ValueFollowerElement<T> = {
+    value: T;
+    blockHeight: number;
+    currentBlockHeight: number;
+};
+export type Unserializer = Pick<import('@endo/marshal').Marshal<unknown>, 'fromCapData' | 'unserialize'>;
+export type Crasher = {
+    crash: (...args: unknown[]) => void;
+};
+export type FollowerOptions = {
+    unserializer?: import("@endo/far").FarRef<Unserializer, import("@endo/eventual-send").DataOnly<Unserializer>> | null | undefined;
+    decode?: ((text: string) => any) | undefined;
+    proof?: "strict" | "optimistic" | "none" | undefined;
+    crasher?: import("@endo/far").FarRef<Crasher, import("@endo/eventual-send").DataOnly<Crasher>> | undefined;
+};
+export type CastingSpec = {
+    storeName?: string | undefined;
+    storeSubkey?: Uint8Array | undefined;
+    dataPrefixBytes?: Uint8Array | undefined;
+    noDataValue?: Uint8Array | undefined;
+    subscription?: ERef<Subscription<any>> | undefined;
+    notifier?: ERef<Notifier<any>> | undefined;
+};
+export type IterateEachOptions = {
+    height?: number | undefined;
+};
+export type StreamCell<T> = {
+    blockHeight: number;
+    values: Array<T>;
+};
+//# sourceMappingURL=types.d.ts.map

package/src/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.js"],"names":[],"mappings":"sBAO0B,OAAO,WAAW,EAAE,IAAI,CAAC,CAAC,CAAC;;6BAIvB,MAAM,OAAO,GAAG,YAAY,MAAM,KAAK,QAAQ,IAAI,CAAC;sBAC5D,MAAM,KAAK,QAAQ,IAAI,CAAC;2BACxB,MAAM,KAAK,QAAQ,OAAO,CAAC;;;;YAMnC,UAAU,EAAE;;;mBAKJ,MAAM,SAAS,GAAG,YAAY,MAAM,KAAK,QAAQ,IAAI,CAAC;oBACtD,MAAM,KAAK,QAAQ,IAAI,CAAC;gBAChC,MAAM,aAAa;6BACR,MAAM,uBAAuB,MAAM;yBACvC,KAAK,WAAW,CAAC,KAAK,QAAQ,SAAS,aAAa,CAAC,CAAC;;4BAG7D,KAAK,MAAM,CAAC,GAAG,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC;;uBAKnC,MAAM,QAAQ,cAAc,CAAC,CAAC,CAAC;gCACpB,kBAAkB,KAAK,QAAQ,cAAc,CAAC,CAAC,CAAC;mCAChD,kBAAkB,KAAK,QAAQ,cAAc,CAAC,CAAC,CAAC;;;WAO3D,CAAC;iBACD,MAAM;wBACN,MAAM;;2BAIP,KAAK,OAAO,eAAe,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,aAAa,GAAG,aAAa,CAAC;;qBAKlE,OAAO,EAAE,KAAK,IAAI;;;;qBAMrB,MAAM,KAAK,GAAG;;;;;;;;;;;;;;;;iBAuBrB,MAAM;YACN,MAAM,CAAC,CAAC"}

package/src/types.js

@@ -1,4 +1,4 @@
-// @ts-check
+// @jessie-check
 
 // Make this a module.
 import '@agoric/notifier';
@@ -49,8 +49,7 @@ export {};
  */
 
 /**
- * @typedef {object} Unserializer
- * @property {(data: import('@endo/marshal').CapData<unknown>) => any} unserialize
+ * @typedef {Pick<import('@endo/marshal').Marshal<unknown>, 'fromCapData' | 'unserialize'>} Unserializer
  */
 
 /**
@@ -71,6 +70,7 @@ export {};
  * @property {string} [storeName]
  * @property {Uint8Array} [storeSubkey]
  * @property {Uint8Array} [dataPrefixBytes]
+ * @property {Uint8Array} [noDataValue]
  * @property {ERef<Subscription<any>>} [subscription]
  * @property {ERef<Notifier<any>>} [notifier]
  */

package/test/deploy.js

@@ -1,7 +1,7 @@
 import { E } from '@endo/far';
 import { iterateLatest, makeFollower } from '../src/main.js';
 
-const COLLATERAL = 'IbcATOM';
+const COLLATERAL = 'ATOM';
 const getVaultManagerMetrics = async (homeP, { cache, lookup }) => {
   const zoe = E.get(homeP).zoe;
   const publicFacet = cache(`publicFacet.vault`, () =>
@@ -24,7 +24,6 @@ const getVaultManagerMetrics = async (homeP, { cache, lookup }) => {
 export default async (homeP, { cache, lookup, makeDefaultLeader }) => {
   // const storeKey = getStoreKeyFromCache(homeP, { cache, lookup });
   const storeKey = getVaultManagerMetrics(homeP, { cache, lookup });
-  // const storeKey = ':published.amm.metrics';
 
   console.log('storeKey', await storeKey);
 

package/test/fake-rpc-server.js

@@ -1,4 +1,3 @@
-// @ts-check
 import { Buffer } from 'buffer';
 import './lockdown.js';
 
@@ -9,6 +8,8 @@ import express from 'express';
 
 import { toAscii, toBase64 } from '@cosmjs/encoding';
 
+const chainName = 'fakeChain';
+
 let lastPort = 8989;
 
 /**
@@ -95,11 +96,13 @@ export const startFakeServer = (t, fakeValues, options = {}) => {
     app.use(express.json());
     app.get('/bad-network-config', (req, res) => {
       res.json({
+        chainName,
         rpcAddrs: 'not an array',
       });
     });
     app.get('/network-config', (req, res) => {
       res.json({
+        chainName,
         rpcAddrs: [`http://localhost:${PORT}/tendermint-rpc`],
       });
     });
@@ -162,7 +165,7 @@ export const startFakeServer = (t, fakeValues, options = {}) => {
           if (batchSize > 0) {
             // Return a JSON stream cell.
             const serializedValues = values.map(val =>
-              JSON.stringify(marshaller.serialize(val)),
+              JSON.stringify(marshaller.toCapData(val)),
             );
             responseValue = {
               blockHeight: String(desiredHeight - 1),
@@ -170,7 +173,7 @@ export const startFakeServer = (t, fakeValues, options = {}) => {
             };
           } else {
             // Return a single naked value.
-            responseValue = marshaller.serialize(values[0]);
+            responseValue = marshaller.toCapData(values[0]);
           }
           const responseValueBase64 = encode(responseValue);
           const result = {

package/test/test-mvp.js

@@ -138,7 +138,7 @@ test('bad network config', async t => {
         jitter: null,
       }),
     {
-      message: /rpcAddrs .* must be an array/,
+      message: /rpcAddrs.*Must be a copyArray/,
     },
   );
 });

package/test/test-netconfig.js

@@ -0,0 +1,48 @@
+import { test } from './prepare-test-env-ava.js';
+import { assertNetworkConfig } from '../src/netconfig.js';
+
+test('https://main.agoric.net/network-config 2022-10-27', t => {
+  /**
+   * @type {import('@agoric/casting/src/netconfig.js').NetworkConfig}
+   */
+  const specimen = {
+    chainName: 'agoric-3',
+    gci: 'edef208d407403e6f478bc33dcf7bb294febc5bc6a423c720f0c9c50da5176d5',
+    peers: [
+      'a26158a5cbb1df581dd6843ac427191af76d6d5d@104.154.240.50:26656',
+      '6e26a1b4afa6889f841d7957e8c2b5d50d32d485@95.216.53.26:26656',
+    ],
+    rpcAddrs: ['https://agoric-rpc.polkachu.com:443'],
+    apiAddrs: ['https://agoric-api.polkachu.com:443'],
+    // @ts-expect-error extraneous
+    oldRpcAddrs: ['https://main.rpc.agoric.net:443'],
+    seeds: [],
+  };
+  t.notThrows(() => assertNetworkConfig(harden(specimen)));
+});
+
+test('https://ollinet.agoric.net/network-config 2022-10-27', t => {
+  /**
+   * @type {import('@agoric/casting/src/netconfig.js').NetworkConfig}
+   */
+  const specimen = {
+    chainName: 'agoricollinet-44',
+    gci: 'https://ollinet.rpc.agoric.net:443/genesis',
+    peers: ['fb86a0993c694c981a28fa1ebd1fd692f345348b@34.67.167.8:26656'],
+    rpcAddrs: ['https://ollinet.rpc.agoric.net:443'],
+    seeds: ['0f04c4610b7511a64b8644944b907416db568590@34.172.146.145:26656'],
+  };
+  t.notThrows(() => assertNetworkConfig(harden(specimen)));
+});
+
+test('https://ollinet.agoric.net/network-config 2022-10-27 minus rpcAddrs', t => {
+  const specimen = {
+    chainName: 'agoricollinet-44',
+    gci: 'https://ollinet.rpc.agoric.net:443/genesis',
+    peers: ['fb86a0993c694c981a28fa1ebd1fd692f345348b@34.67.167.8:26656'],
+    seeds: ['0f04c4610b7511a64b8644944b907416db568590@34.172.146.145:26656'],
+  };
+  t.throws(() => assertNetworkConfig(harden(specimen)), {
+    message: /Must have missing properties \["rpcAddrs"\]/,
+  });
+});