@jsm-mit/tigi-sharded-package 0.5.0 → 0.5.1

package/declarations/coordinator/coordinator.did

@@ -14,6 +14,82 @@ type CanisterArgs = record { canister : principal };
 // composes the arguments and keeps the logic, the coordinator only forwards. A new
 // method of the chat group is a new case here, never a free method name.
 type ChatAdminMethod = variant { updateRoom; createRoom; deleteRoom };
+// KO-21: the chat coordinator's reminder (`chatBillDue : (ChatBillDue) -> ()`), as the chat
+// sends it (chat-sharded `coordinator/src/types.rs`).
+type ChatBillDue = record {
+  // The chat's UTC day of the run.
+  day : nat64;
+  // The first reminder of this unpaid bill.
+  dueSinceNs : nat64;
+  // Cycles due now: every billed day not paid.
+  bill : nat;
+  // From then on `post` in the project fails while the bill stays unpaid.
+  blockAtNs : nat64;
+  projectId : text;
+  // The chat core: `payProjectBill` goes there.
+  payTo : principal;
+  multiplierPermille : nat32;
+};
+// KO-22: the last chat bill this coordinator paid, and every one together.
+type ChatBillPaid = record {
+  day : nat64;
+  paidAtNs : nat64;
+  paidTotal : nat;
+  amount : nat;
+};
+// KO-22: the last reminder and what became of it. Stored in `Config.chatBill`.
+type ChatBillRun = record {
+  day : nat64;
+  updatedAtNs : nat64;
+  dueSinceNs : nat64;
+  // What the reminder named.
+  reminded : nat;
+  blockAtNs : nat64;
+  step : ChatBillStep;
+  // D8: the driver rooms (`drv-…`) of the bill, and how many batches of them the core
+  // took so far.
+  driverRooms : opt nat32;
+  receivedAtNs : nat64;
+  projectId : text;
+  batchesSent : opt nat32;
+  payTo : principal;
+  // D8: cycles the coordinator keeps paying — the project's other rooms, pool canisters,
+  // rooms of no driver canister.
+  absorbed : opt nat;
+  // What the chat core took (`payProjectBill`).
+  accepted : opt nat;
+  // The bill as `getProjectBill` said it — what is paid.
+  amount : opt nat;
+  // D8: cycles that went into the drivers' accounts.
+  passed : opt nat;
+  // Why it is not paid, or why the shares wait.
+  problem : opt text;
+};
+// KO-22: where a payment of a chat bill is. Stored before every await (record-driven).
+type ChatBillStep = variant {
+  // Reading the core's chat config, the chat core, the bill.
+  reading;
+  // Paid and passed on.
+  done;
+  // Not paid: `problem` says why (an alarm). The next reminder tries again.
+  unpaid;
+  // Paid; the drivers' shares are on their way to the core (D8).
+  sharing;
+  // The bill read was 0: nothing to pay.
+  nothingDue;
+  // The reminder is taken; the payment is not started.
+  received;
+  // `payProjectBill` is on its way with the cycles.
+  paying;
+};
+// KO-21: the copy of the core's chat config (`getChatConfig`): who may remind, which
+// project is ours. Read from the core after an upgrade, by hand, and when a reminder comes
+// from another caller (at most once an hour).
+type ChatLink = record {
+  chatCoordinatorId : principal;
+  readAtNs : nat64;
+  projectId : text;
+};
 type CommitWasmArgs = record {
   // Of the whole module. The coordinator refuses a module that does not match.
   sha256 : blob;
@@ -61,9 +137,15 @@ type Config = record {
   // What a new worker starts with, and what a worker or the core gets when it reports a
   // low balance. A worker asks below half of it.
   cyclesPerWorker : nat;
+  // KO-22: the last chat bill paid, with the total.
+  chatBillPaid : opt ChatBillPaid;
+  // KO-22: the last chat bill reminder and its payment.
+  chatBill : opt ChatBillRun;
   // false (STAGE, local): the coordinator never creates a worker or splits by itself,
   // whatever the load; the levels are only shown (KO-7). true (prod): it does.
   spread : bool;
+  // KO-21: the copy of the core's chat config. None = not read yet.
+  chatLink : opt ChatLink;
   nextEventId : nat64;
   // The ONE superadmin of a LIVE group: a person, who hands the role over on a request.
   superadmin : opt principal;
@@ -375,16 +457,17 @@ type Result_1 = variant { Ok : Roles; Err : CoordinatorError };
 type Result_10 = variant { Ok : vec WorkerLive; Err : CoordinatorError };
 type Result_11 = variant { Ok : bool; Err : CoordinatorError };
 type Result_12 = variant { Ok : vec WorkerRecord; Err : CoordinatorError };
-type Result_13 = variant { Ok : CoreRecord; Err : CoordinatorError };
-type Result_14 = variant { Ok : WorkerStatus; Err : CoordinatorError };
-type Result_15 = variant { Ok : Dependents; Err : CoordinatorError };
-type Result_16 = variant { Ok : Config; Err : CoordinatorError };
-type Result_17 = variant { Ok : SetWorkerConfigResult; Err : CoordinatorError };
-type Result_18 = variant { Ok : WorkerView; Err : CoordinatorError };
-type Result_19 = variant { Ok : SplitResult; Err : CoordinatorError };
+type Result_13 = variant { Ok : opt ChatLink; Err : CoordinatorError };
+type Result_14 = variant { Ok : CoreRecord; Err : CoordinatorError };
+type Result_15 = variant { Ok : WorkerStatus; Err : CoordinatorError };
+type Result_16 = variant { Ok : Dependents; Err : CoordinatorError };
+type Result_17 = variant { Ok : Config; Err : CoordinatorError };
+type Result_18 = variant { Ok : SetWorkerConfigResult; Err : CoordinatorError };
+type Result_19 = variant { Ok : WorkerView; Err : CoordinatorError };
 type Result_2 = variant { Ok : vec PrefixEntry; Err : CoordinatorError };
-type Result_20 = variant { Ok : nat; Err : CoordinatorError };
-type Result_21 = variant { Ok : nat64; Err : CoordinatorError };
+type Result_20 = variant { Ok : SplitResult; Err : CoordinatorError };
+type Result_21 = variant { Ok : nat; Err : CoordinatorError };
+type Result_22 = variant { Ok : nat64; Err : CoordinatorError };
 type Result_3 = variant { Ok : WasmInfo; Err : CoordinatorError };
 type Result_4 = variant { Ok : principal; Err : CoordinatorError };
 type Result_5 = variant { Ok : DeletedWorker; Err : CoordinatorError };
@@ -542,6 +625,11 @@ service : (InitArgs) -> {
   // A prefix to a worker, by hand: new reports and requests of the area go there from now
   // on.
   assignPrefix : (AssignPrefixArgs) -> (Result_2);
+  // KO-21: the chat coordinator reminds this coordinator of the chat bill of its project.
+  // Only the chat coordinator of the core's chat config (a trap otherwise; ingress refused in
+  // `inspect_message`). Answers at once: the payment runs in a task of its own (KO-22). Once
+  // per chat day.
+  chatBillDue : (ChatBillDue) -> ();
   // DEPLOYED → LIVE: the caller becomes THE superadmin. In prod the deploy admins lose
   // their rights here, in the coordinator and in the core.
   claimSuperadmin : () -> (Result_1);
@@ -622,10 +710,12 @@ service : (InitArgs) -> {
   locateGeohashes : (GeohashesArgs) -> (vec opt principal) query;
   // A superadmin reads the query load of every installed worker now.
   readQueryLoads : () -> (Result_12);
+  // KO-24: the superadmin reads the core's chat config again (the front's button).
+  refreshChatLink : () -> (Result_13);
   // What the management canister says of the core: its balance and its module.
-  refreshCore : () -> (Result_13);
+  refreshCore : () -> (Result_14);
   // What a worker says of itself now. The coordinator keeps the memory and the cycles.
-  refreshWorker : (CanisterArgs) -> (Result_14);
+  refreshWorker : (CanisterArgs) -> (Result_15);
   removeCoreAdmin : (PrincipalArgs) -> (Result);
   removeDeployAdmin : (PrincipalArgs) -> (Result_1);
   // KO-10, C-11: the core's balance is below `lowCyclesBelow`: it gets `cyclesPerWorker`,
@@ -653,23 +743,23 @@ service : (InitArgs) -> {
   // installed again from scratch — the same ids, the same cycles, no create fee — and the
   // map starts again: the first worker holds the world. One canister at a time; refused
   // while a split, a drain or an upgrade runs.
-  resetGroup : () -> (Result_15);
+  resetGroup : () -> (Result_16);
   // Changes what a superadmin may: `spread`, the cycles of a worker, the own reserve,
   // `maxWorkers`, the query thresholds. Only the fields given are changed.
-  setConfig : (SetConfigArgs) -> (Result_16);
+  setConfig : (SetConfigArgs) -> (Result_17);
   setCoreLoggingEnabled : (CoreLoggingArgs) -> (Result_11);
   // KO-19: the superadmin sets the thresholds of the fee multiplier (cycles per canister).
-  setFeeThresholds : (FeeThresholds) -> (Result_16);
+  setFeeThresholds : (FeeThresholds) -> (Result_17);
   // The config of the workers of the group: the load thresholds, logging. Only the fields
   // given are changed. The result is stored, given to every worker that has its code, and
   // to every worker created later.
-  setWorkerConfig : (WorkerConfigArgs) -> (Result_17);
+  setWorkerConfig : (WorkerConfigArgs) -> (Result_18);
   // Opens a worker to the prefixes of a split again, or closes it without giving anything
   // away.
-  setWorkerOpen : (SetWorkerOpenArgs) -> (Result_18);
+  setWorkerOpen : (SetWorkerOpenArgs) -> (Result_19);
   // A superadmin splits a worker now, whatever its load and `spread` (KO-17): a fresh worker
   // takes about half of its prefixes. Answers with the new worker and the prefixes it got.
-  splitWorker : (CanisterArgs) -> (Result_19);
+  splitWorker : (CanisterArgs) -> (Result_20);
   // A worker of the group sends its cycles here before it is deleted (`giveBackCycles`).
   // The workers only: somebody else's cycles are refused (they go back to the sender).
   takeCycles : () -> (nat);
@@ -677,9 +767,9 @@ service : (InitArgs) -> {
   // accepted and counted. No per-driver data: the bills are the core's. Only the core.
   takeFeeCycles : () -> (nat);
   // Cycles for the core, by hand: `cyclesPerWorker`, like a worker's top-up.
-  topUpCore : () -> (Result_20);
+  topUpCore : () -> (Result_21);
   // Cycles for a worker, by hand.
-  topUpWorker : (CanisterArgs) -> (Result_20);
+  topUpWorker : (CanisterArgs) -> (Result_21);
   // KO-11: a new build of the core: stop → upgrade → start; its state stays (C-12).
   upgradeCore : () -> (Result_3);
   // KO-11: a new worker build on a worker that runs: stop → upgrade → start. Its state
@@ -687,10 +777,10 @@ service : (InitArgs) -> {
   // a split or a drain holds the worker.
   upgradeWorker : (CanisterArgs) -> (Result_3);
   // The core wasm, in chunks like the worker's.
-  uploadCoreWasmChunk : (WasmChunkArgs) -> (Result_21);
+  uploadCoreWasmChunk : (WasmChunkArgs) -> (Result_22);
   // One chunk of a NEW worker wasm. The first chunk (index 0) drops what was uploaded
   // before; the module counts only after `commitWorkerWasm`.
-  uploadWorkerWasmChunk : (WasmChunkArgs) -> (Result_21);
+  uploadWorkerWasmChunk : (WasmChunkArgs) -> (Result_22);
   // KO-1, KO-2: the worker of the area a geohash lies in — the longest prefix of the map
   // wins. None = no installed worker serves the area (no worker yet, or its worker is being
   // installed). Uncertified: the package checks the answer against `listWorkers`, and a

package/declarations/coordinator/coordinator.did.d.ts

@@ -30,6 +30,142 @@ export interface CanisterArgs { 'canister' : Principal }
 export type ChatAdminMethod = { 'updateRoom' : null } |
   { 'createRoom' : null } |
   { 'deleteRoom' : null };
+/**
+ * KO-21: the chat coordinator's reminder (`chatBillDue : (ChatBillDue) -> ()`), as the chat
+ * sends it (chat-sharded `coordinator/src/types.rs`).
+ */
+export interface ChatBillDue {
+  /**
+   * The chat's UTC day of the run.
+   */
+  'day' : bigint,
+  /**
+   * The first reminder of this unpaid bill.
+   */
+  'dueSinceNs' : bigint,
+  /**
+   * Cycles due now: every billed day not paid.
+   */
+  'bill' : bigint,
+  /**
+   * From then on `post` in the project fails while the bill stays unpaid.
+   */
+  'blockAtNs' : bigint,
+  'projectId' : string,
+  /**
+   * The chat core: `payProjectBill` goes there.
+   */
+  'payTo' : Principal,
+  'multiplierPermille' : number,
+}
+/**
+ * KO-22: the last chat bill this coordinator paid, and every one together.
+ */
+export interface ChatBillPaid {
+  'day' : bigint,
+  'paidAtNs' : bigint,
+  'paidTotal' : bigint,
+  'amount' : bigint,
+}
+/**
+ * KO-22: the last reminder and what became of it. Stored in `Config.chatBill`.
+ */
+export interface ChatBillRun {
+  'day' : bigint,
+  'updatedAtNs' : bigint,
+  'dueSinceNs' : bigint,
+  /**
+   * What the reminder named.
+   */
+  'reminded' : bigint,
+  'blockAtNs' : bigint,
+  'step' : ChatBillStep,
+  /**
+   * D8: the driver rooms (`drv-…`) of the bill, and how many batches of them the core
+   * took so far.
+   */
+  'driverRooms' : [] | [number],
+  'receivedAtNs' : bigint,
+  'projectId' : string,
+  'batchesSent' : [] | [number],
+  'payTo' : Principal,
+  /**
+   * D8: cycles the coordinator keeps paying — the project's other rooms, pool canisters,
+   * rooms of no driver canister.
+   */
+  'absorbed' : [] | [bigint],
+  /**
+   * What the chat core took (`payProjectBill`).
+   */
+  'accepted' : [] | [bigint],
+  /**
+   * The bill as `getProjectBill` said it — what is paid.
+   */
+  'amount' : [] | [bigint],
+  /**
+   * D8: cycles that went into the drivers' accounts.
+   */
+  'passed' : [] | [bigint],
+  /**
+   * Why it is not paid, or why the shares wait.
+   */
+  'problem' : [] | [string],
+}
+/**
+ * KO-22: where a payment of a chat bill is. Stored before every await (record-driven).
+ */
+export type ChatBillStep = {
+    /**
+     * Reading the core's chat config, the chat core, the bill.
+     */
+    'reading' : null
+  } |
+  {
+    /**
+     * Paid and passed on.
+     */
+    'done' : null
+  } |
+  {
+    /**
+     * Not paid: `problem` says why (an alarm). The next reminder tries again.
+     */
+    'unpaid' : null
+  } |
+  {
+    /**
+     * Paid; the drivers' shares are on their way to the core (D8).
+     */
+    'sharing' : null
+  } |
+  {
+    /**
+     * The bill read was 0: nothing to pay.
+     */
+    'nothingDue' : null
+  } |
+  {
+    /**
+     * The reminder is taken; the payment is not started.
+     */
+    'received' : null
+  } |
+  {
+    /**
+     * `payProjectBill` is on its way with the cycles.
+     */
+    'paying' : null
+  };
+/**
+ * KO-21: the copy of the core's chat config (`getChatConfig`): who may remind, which
+ * project is ours. Read from the core after an upgrade, by hand, and when a reminder comes
+ * from another caller (at most once an hour).
+ */
+export interface ChatLink {
+  'chatCoordinatorId' : Principal,
+  'readAtNs' : bigint,
+  'projectId' : string,
+}
 export interface CommitWasmArgs {
   /**
    * Of the whole module. The coordinator refuses a module that does not match.
@@ -111,11 +247,23 @@ export interface Config {
    * low balance. A worker asks below half of it.
    */
   'cyclesPerWorker' : bigint,
+  /**
+   * KO-22: the last chat bill paid, with the total.
+   */
+  'chatBillPaid' : [] | [ChatBillPaid],
+  /**
+   * KO-22: the last chat bill reminder and its payment.
+   */
+  'chatBill' : [] | [ChatBillRun],
   /**
    * false (STAGE, local): the coordinator never creates a worker or splits by itself,
    * whatever the load; the levels are only shown (KO-7). true (prod): it does.
    */
   'spread' : boolean,
+  /**
+   * KO-21: the copy of the core's chat config. None = not read yet.
+   */
+  'chatLink' : [] | [ChatLink],
   'nextEventId' : bigint,
   /**
    * The ONE superadmin of a LIVE group: a person, who hands the role over on a request.
@@ -563,26 +711,28 @@ export type Result_11 = { 'Ok' : boolean } |
   { 'Err' : CoordinatorError };
 export type Result_12 = { 'Ok' : Array<WorkerRecord> } |
   { 'Err' : CoordinatorError };
-export type Result_13 = { 'Ok' : CoreRecord } |
+export type Result_13 = { 'Ok' : [] | [ChatLink] } |
   { 'Err' : CoordinatorError };
-export type Result_14 = { 'Ok' : WorkerStatus } |
+export type Result_14 = { 'Ok' : CoreRecord } |
   { 'Err' : CoordinatorError };
-export type Result_15 = { 'Ok' : Dependents } |
+export type Result_15 = { 'Ok' : WorkerStatus } |
   { 'Err' : CoordinatorError };
-export type Result_16 = { 'Ok' : Config } |
+export type Result_16 = { 'Ok' : Dependents } |
   { 'Err' : CoordinatorError };
-export type Result_17 = { 'Ok' : SetWorkerConfigResult } |
+export type Result_17 = { 'Ok' : Config } |
   { 'Err' : CoordinatorError };
-export type Result_18 = { 'Ok' : WorkerView } |
+export type Result_18 = { 'Ok' : SetWorkerConfigResult } |
   { 'Err' : CoordinatorError };
-export type Result_19 = { 'Ok' : SplitResult } |
+export type Result_19 = { 'Ok' : WorkerView } |
   { 'Err' : CoordinatorError };
 export type Result_2 = { 'Ok' : Array<PrefixEntry> } |
   { 'Err' : CoordinatorError };
-export type Result_20 = { 'Ok' : bigint } |
+export type Result_20 = { 'Ok' : SplitResult } |
   { 'Err' : CoordinatorError };
 export type Result_21 = { 'Ok' : bigint } |
   { 'Err' : CoordinatorError };
+export type Result_22 = { 'Ok' : bigint } |
+  { 'Err' : CoordinatorError };
 export type Result_3 = { 'Ok' : WasmInfo } |
   { 'Err' : CoordinatorError };
 export type Result_4 = { 'Ok' : Principal } |
@@ -826,6 +976,13 @@ export interface _SERVICE {
    * on.
    */
   'assignPrefix' : ActorMethod<[AssignPrefixArgs], Result_2>,
+  /**
+   * KO-21: the chat coordinator reminds this coordinator of the chat bill of its project.
+   * Only the chat coordinator of the core's chat config (a trap otherwise; ingress refused in
+   * `inspect_message`). Answers at once: the payment runs in a task of its own (KO-22). Once
+   * per chat day.
+   */
+  'chatBillDue' : ActorMethod<[ChatBillDue], undefined>,
   /**
    * DEPLOYED → LIVE: the caller becomes THE superadmin. In prod the deploy admins lose
    * their rights here, in the coordinator and in the core.
@@ -958,14 +1115,18 @@ export interface _SERVICE {
    * A superadmin reads the query load of every installed worker now.
    */
   'readQueryLoads' : ActorMethod<[], Result_12>,
+  /**
+   * KO-24: the superadmin reads the core's chat config again (the front's button).
+   */
+  'refreshChatLink' : ActorMethod<[], Result_13>,
   /**
    * What the management canister says of the core: its balance and its module.
    */
-  'refreshCore' : ActorMethod<[], Result_13>,
+  'refreshCore' : ActorMethod<[], Result_14>,
   /**
    * What a worker says of itself now. The coordinator keeps the memory and the cycles.
    */
-  'refreshWorker' : ActorMethod<[CanisterArgs], Result_14>,
+  'refreshWorker' : ActorMethod<[CanisterArgs], Result_15>,
   'removeCoreAdmin' : ActorMethod<[PrincipalArgs], Result>,
   'removeDeployAdmin' : ActorMethod<[PrincipalArgs], Result_1>,
   /**
@@ -1007,33 +1168,33 @@ export interface _SERVICE {
    * map starts again: the first worker holds the world. One canister at a time; refused
    * while a split, a drain or an upgrade runs.
    */
-  'resetGroup' : ActorMethod<[], Result_15>,
+  'resetGroup' : ActorMethod<[], Result_16>,
   /**
    * Changes what a superadmin may: `spread`, the cycles of a worker, the own reserve,
    * `maxWorkers`, the query thresholds. Only the fields given are changed.
    */
-  'setConfig' : ActorMethod<[SetConfigArgs], Result_16>,
+  'setConfig' : ActorMethod<[SetConfigArgs], Result_17>,
   'setCoreLoggingEnabled' : ActorMethod<[CoreLoggingArgs], Result_11>,
   /**
    * KO-19: the superadmin sets the thresholds of the fee multiplier (cycles per canister).
    */
-  'setFeeThresholds' : ActorMethod<[FeeThresholds], Result_16>,
+  'setFeeThresholds' : ActorMethod<[FeeThresholds], Result_17>,
   /**
    * The config of the workers of the group: the load thresholds, logging. Only the fields
    * given are changed. The result is stored, given to every worker that has its code, and
    * to every worker created later.
    */
-  'setWorkerConfig' : ActorMethod<[WorkerConfigArgs], Result_17>,
+  'setWorkerConfig' : ActorMethod<[WorkerConfigArgs], Result_18>,
   /**
    * Opens a worker to the prefixes of a split again, or closes it without giving anything
    * away.
    */
-  'setWorkerOpen' : ActorMethod<[SetWorkerOpenArgs], Result_18>,
+  'setWorkerOpen' : ActorMethod<[SetWorkerOpenArgs], Result_19>,
   /**
    * A superadmin splits a worker now, whatever its load and `spread` (KO-17): a fresh worker
    * takes about half of its prefixes. Answers with the new worker and the prefixes it got.
    */
-  'splitWorker' : ActorMethod<[CanisterArgs], Result_19>,
+  'splitWorker' : ActorMethod<[CanisterArgs], Result_20>,
   /**
    * A worker of the group sends its cycles here before it is deleted (`giveBackCycles`).
    * The workers only: somebody else's cycles are refused (they go back to the sender).
@@ -1047,11 +1208,11 @@ export interface _SERVICE {
   /**
    * Cycles for the core, by hand: `cyclesPerWorker`, like a worker's top-up.
    */
-  'topUpCore' : ActorMethod<[], Result_20>,
+  'topUpCore' : ActorMethod<[], Result_21>,
   /**
    * Cycles for a worker, by hand.
    */
-  'topUpWorker' : ActorMethod<[CanisterArgs], Result_20>,
+  'topUpWorker' : ActorMethod<[CanisterArgs], Result_21>,
   /**
    * KO-11: a new build of the core: stop → upgrade → start; its state stays (C-12).
    */
@@ -1065,12 +1226,12 @@ export interface _SERVICE {
   /**
    * The core wasm, in chunks like the worker's.
    */
-  'uploadCoreWasmChunk' : ActorMethod<[WasmChunkArgs], Result_21>,
+  'uploadCoreWasmChunk' : ActorMethod<[WasmChunkArgs], Result_22>,
   /**
    * One chunk of a NEW worker wasm. The first chunk (index 0) drops what was uploaded
    * before; the module counts only after `commitWorkerWasm`.
    */
-  'uploadWorkerWasmChunk' : ActorMethod<[WasmChunkArgs], Result_21>,
+  'uploadWorkerWasmChunk' : ActorMethod<[WasmChunkArgs], Result_22>,
   /**
    * KO-1, KO-2: the worker of the area a geohash lies in — the longest prefix of the map
    * wins. None = no installed worker serves the area (no worker yet, or its worker is being