Scout

.github/workflows/nodejs.yml

@@ -8,7 +8,10 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
-      - uses: volta-cli/action@v1
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
       - run: npm ci --no-audit
       - run: npm run lint --if-present
       - run: npm test

README.md

@@ -35,23 +35,25 @@ now it takes 220 seconds:
 npm install
 npm test
 npm run build
-time node build/src/birdsEyeAnalysis.js __tests__/fixture-300.csv > birdseye-30.log
-time node build/src/birdsEyeAnalysis.js __tests__/fixture-300.csv > birdseye-300.log
-time node build/src/birdsEyeAnalysis.js __tests__/fixture-3000.csv > birdseye-3k.log
-time node build/src/birdsEyeAnalysis.js __tests__/fixture-30000.csv > birdseye-30k.log
-time node build/src/birdsEyeAnalysis.js __tests__/fixture-300000.csv > birdseye-300k.log
-
-PROBING_REPORT=1 time node build/src/analysis.js __tests__/fixture-30.csv > jerboa-30.log
-PROBING_REPORT=1 time node build/src/analysis.js __tests__/fixture-300.csv > jerboa-300.log
-PROBING_REPORT=1 time node build/src/analysis.js __tests__/fixture-3000.csv > jerboa-3k.log
-PROBING_REPORT=1 time node build/src/analysis.js __tests__/fixture-30000.csv > jerboa-30k.log
-PROBING_REPORT=1 time node build/src/analysis.js __tests__/fixture-300000.csv > jerboa-300k.log
-
-diff ./jerboa-30.log ./birdseye-30.log
-diff ./jerboa-300.log ./birdseye-300.log
-diff ./jerboa-3k.log ./birdseye-3k.log
-diff ./jerboa-30k.log ./birdseye-30k.log
-diff ./jerboa-300k.log ./birdseye-300k.log
+npm start
+
+time node build/src/birdsEyeAnalysis.js __tests__/fixture-30.csv > birdseye-30.out
+time node build/src/birdsEyeAnalysis.js __tests__/fixture-300.csv > birdseye-300.out
+time node build/src/birdsEyeAnalysis.js __tests__/fixture-3k.csv > birdseye-3k.out
+time node build/src/birdsEyeAnalysis.js __tests__/fixture-30k.csv > birdseye-30k.out
+time node build/src/birdsEyeAnalysis.js __tests__/fixture-300k.csv > birdseye-300k.out
+
+PROBING_REPORT=1 time node build/src/main.js __tests__/fixture-30.csv > jerboa-30.out
+PROBING_REPORT=1 time node build/src/main.js __tests__/fixture-300.csv > jerboa-300.out
+PROBING_REPORT=1 time node build/src/main.js __tests__/fixture-3k.csv > jerboa-3k.out
+PROBING_REPORT=1 time node build/src/main.js __tests__/fixture-30k.csv > jerboa-30k.out
+PROBING_REPORT=1 time node build/src/main.js __tests__/fixture-300k.csv > jerboa-300k.out
+
+diff ./jerboa-30.out ./birdseye-30.out
+diff ./jerboa-300.out ./birdseye-300.out
+diff ./jerboa-3k.out ./birdseye-3k.out
+diff ./jerboa-30k.out ./birdseye-30k.out
+diff ./jerboa-300k.out ./birdseye-300k.out
 ```
 
-The diff output is expected to show that BirdsEyeAnalysis does more netting, because it nets after every transfer, and Jerboa only nets the balances after all transfers are finished.
+The diff output is expected to show that BirdsEyeAnalysis does more netting, because it nets after every transfer, and Jerboa only nets the balances after all transfers are finished.

__tests__/DLD.test.ts

@@ -40,7 +40,10 @@ async function readCsv(callback: (from: string, to: string, amount: number) => v
 describe('DLD', () => {
   it('finds loops', async () => {
     const dld = new DLD();
-    await readCsv(dld.graph.addWeight.bind(dld.graph));
+    await readCsv((source: string, target: string, weight: number) => {
+      dld.graph.addWeight(source,target, weight);
+      dld.graph.messaging.runTasks();
+    });
     dld.runWorm();
     let totalNum = 0;
     let totalAmount = 0;
@@ -51,18 +54,9 @@ describe('DLD', () => {
       }
     });
     expect([totalNum, totalAmount, dld.graph.stats]).toEqual([
-      1,
-      30,
-      {
-        "2": {
-        "numFound": 1,
-        "totalAmount": 0.5,
-        },
-        "3": {
-          "numFound": 1,
-          "totalAmount": 10,
-        },
-      },
+      0,
+      0,
+      {},
     ]);
   });
 });

__tests__/Graph.test.ts

@@ -59,6 +59,7 @@ describe('addWeight', () => {
   it('nets a higher amount', () => {
     const graph = new Graph();
     graph.addWeight('a', 'b', 3);
+    graph.messaging.runTasks();
     graph.addWeight('b', 'a', 7);
     graph.messaging.runTasks();
     expect(graph.getBalances()).toEqual({
@@ -73,6 +74,7 @@ describe('addWeight', () => {
   it('nets a lower amount', () => {
     const graph = new Graph();
     graph.addWeight('a', 'b', 3);
+    graph.messaging.runTasks();
     graph.addWeight('b', 'a', 2);
     graph.messaging.runTasks();
     expect(graph.getBalances()).toEqual({
@@ -87,6 +89,7 @@ describe('addWeight', () => {
   it('nets an equal amount', () => {
     const graph = new Graph();
     graph.addWeight('a', 'b', 3);
+    graph.messaging.runTasks();
     graph.addWeight('b', 'a', 3);
     graph.messaging.runTasks();
     expect(graph.getBalances()).toEqual({

__tests__/Jerboa.test.ts

@@ -1,4 +1,4 @@
-import { Jerboa } from '../src/Jerboa.js';
+import { Jerboa, ProbeMessage } from '../src/Jerboa.js';
 import { Graph } from '../src/Graph.js';
 import { Messaging } from '../src/Messaging.js';
 // jest.mock('../src/Graph.js');
@@ -10,7 +10,7 @@ describe('Jerboa', () => {
   it ('returns false if it cannot initiate a probe', () => {
     const graph = new Graph();
     const a = new Jerboa('a', graph);
-    const result = a.startProbe();
+    const result = a.startProbe('probe-id');
     expect(result).toEqual(false);
   });
   it ('initiates a probe if it can', () => {
@@ -19,37 +19,53 @@ describe('Jerboa', () => {
     graph.messaging.sendMessage = jest.fn();
     const a = new Jerboa('a', graph);
     a.addWeight('b', 9);
-    expect(graph.messaging.sendMessage).toHaveBeenCalledWith('a', 'b', ['transfer', '9']);
-    const result = a.startProbe();
+    expect(graph.messaging.sendMessage).toHaveBeenCalledWith('a', 'b', {"amount": 9, "command": "transfer"});
+    const result = a.startProbe('probe-id');
     expect(result).toEqual(true);
-    expect(graph.messaging.sendMessage).toHaveBeenCalledWith('a', 'b', ['probe', '[]', '[]']);
+    expect(graph.messaging.sendMessage).toHaveBeenCalledWith('a', 'b', { command: 'probe', probeId: 'probe-id', incarnation: 0, debugInfo: {"path":[],"backtracked":[]} });
   });
   it('forwards a probe if it can', () => {
     const graph = new Graph();
     graph.messaging = new Messaging(graph);
     graph.messaging.sendMessage = jest.fn();
     const a = new Jerboa('a', graph);
     a.addWeight('b', 9);
-    expect(graph.messaging.sendMessage).toHaveBeenCalledWith('a', 'b', ['transfer', '9']);
-    a.receiveMessage('x', ['probe', JSON.stringify(['b', 'c']), '[]']);
-    expect(graph.messaging.sendMessage).toHaveBeenCalledWith('a', 'b', ['probe', JSON.stringify(['b', 'c', 'x']), '[]']);
+    expect(graph.messaging.sendMessage).toHaveBeenCalledWith('a', 'b', {"amount": 9, "command": "transfer"});
+    a.receiveMessage('x', { command: 'probe', probeId: '1', incarnation: 123, debugInfo: { path: ['b', 'c'], backtracked: [] } } as ProbeMessage);
+    expect(graph.messaging.sendMessage).toHaveBeenCalledWith('a', 'b', { command: 'probe', probeId: '1', incarnation: 123, debugInfo: { path: ['b', 'c', 'x'], backtracked: []} });
   });
   it('splices off a loop if it can', () => {
     const graph = new Graph();
     graph.messaging = new Messaging(graph);
     graph.messaging.sendMessage = jest.fn();
-    const a = new Jerboa('a', graph);
-    a.addWeight('b', 9);
-    expect(graph.messaging.sendMessage).toHaveBeenCalledWith('a', 'b', ['transfer', '9']);
-    a.receiveMessage('x', ['probe', JSON.stringify(['b', 'c', 'a', 'd']), '[]']); // so the loop is a-d-x-a and b-c-a is the old prefix
-    expect(graph.messaging.sendMessage).toHaveBeenCalledWith('a', 'b', ['probe', JSON.stringify(['b', 'c']), '[]']);
+    // rather than calling `new Jerboa('d'), getting the Jerboas from the graph
+    // will allow them to query each other for debugging
+    // do note though that since we mocked graph.messaging, messages sent by these
+    // nodes will still not arrive:
+    const d = graph.getNode('d');
+    const e = graph.getNode('e');
+    const f = graph.getNode('f');
+    d.addWeight('e', 9);
+    e.receiveMessage('d', { command: 'transfer', amount: 9 });
+    e.addWeight('f', 9);
+    f.receiveMessage('e', { command: 'transfer', amount: 9 });
+    f.addWeight('d', 9);
+    d.receiveMessage('f', { command: 'transfer', amount: 9 });
+    expect(d.getBalances()).toEqual({ e: 9, f: -9 });
+    expect(e.getBalances()).toEqual({ f: 9, d: -9 });
+    expect(f.getBalances()).toEqual({ d: 9, e: -9 });
+    expect(graph.messaging.sendMessage).toHaveBeenCalledWith('d', 'e', {"amount": 9, "command": "transfer"});
+    d.receiveMessage('c', { command: 'probe', probeId: 'probe-id', incarnation: 0, debugInfo: { path: ['a', 'b'], backtracked: [] } });
+    expect(graph.messaging.sendMessage).toHaveBeenCalledWith('d', 'e', { command: 'probe', probeId: 'probe-id', incarnation: 0, debugInfo: { path: ['a', 'b', 'c'], backtracked: [] } });
+    d.receiveMessage('f', { command: 'probe', probeId: 'probe-id', incarnation: 0, debugInfo: { path: ['a', 'b', 'c', 'd', 'e'], backtracked: [] } }); // so the probe has P-looped as: a-b-c-[d-e-f-d]
+    expect(graph.messaging.sendMessage).toHaveBeenCalledWith('d', 'f', { command: 'scout', probeId: 'probe-id', maxIncarnation: 0, amount: 9, debugInfo: { loop: ['d', 'e', 'f', 'd']} });
   });
   it ('replies with nack if it is a leaf', () => {
     const graph = new Graph();
     graph.messaging = new Messaging(graph);
     graph.messaging.sendMessage = jest.fn();
     const a = new Jerboa('a', graph);
-    a.receiveMessage('x', ['probe', '[]', '[]']);
-    expect(graph.messaging.sendMessage).toHaveBeenCalledWith('a', 'x', ['nack', JSON.stringify([]), '[]']);
+    a.receiveMessage('x', { command: 'probe', probeId: 'probe-id', incarnation: 0, debugInfo: { path: [], backtracked: [] } });
+    expect(graph.messaging.sendMessage).toHaveBeenCalledWith('a', 'x', { command: 'nack', probeId: 'probe-id', incarnation: 0, debugInfo: { path: [], backtracked: []} });
   });
 });

birdseye-30.out

@@ -0,0 +1,24 @@
+Opening __tests__/fixture-30.csv
+backtracked [ '5', '6' ] [ '8' ]
+found loop  [] [ '5', '6', '9', '5' ]
+backtracked [ '5' ] [ '6' ]
+finished    [] [ '5', '8' ]
+backtracked [ '9' ] [ '5' ]
+finished    [] [ '9', '8' ]
+backtracked [ '10' ] [ '5' ]
+finished    [] [ '10', '11' ]
+finished    [] [ '12', '13' ]
+finished    [] [ '14', '5' ]
+finished    [] [ '15', '16' ]
+finished    [] [ '17', '11' ]
+finished    [] [ '18', '16' ]
+Done after 23 steps
+{
+  '2': { numFound: 7, totalAmount: 52.5 },
+  '3': { numFound: 1, totalAmount: 10 }
+}
+Graph has 0 nodes and 0 links left
+After 22 transactions with a total amount of 0 million
+0 million (8%) was immediately netted bilaterally
+And a further 0 million (5%) was netted in 1 loops
+Leaving 0 million (87%) to be settled out of band