@substratedb/sync-core 0.0.0-stage → 0.1.4

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,152 @@
-# Temporary Holding Version
+# Substrate sync core
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The part of every Substrate SDK that must behave the same everywhere, in
+Rust and with no I/O. It speaks the realtime protocol in
+[`docs/architecture/REALTIME_PROTOCOL.md`](../../docs/architecture/REALTIME_PROTOCOL.md).
+
+Events go in as JSON and instructions come out as a JSON array:
+
+| Event                 | Fields                                                                           |
+| --------------------- | -------------------------------------------------------------------------------- |
+| `restored`            | `version`, `resumeToken`, `queries` stored                                       |
+| `connected`           | `now`: the socket finished `hello`                                               |
+| `disconnected`        |                                                                                  |
+| `watch`               | `query`: `queryId`, `canonicalQueryHash`, and `program` or `call`                |
+| `unwatch`             | `queryId`                                                                        |
+| `write`               | `write`: `executionId`, `idempotencyKey`, and `program` or `command`; `now`      |
+| `commandAnswer`       | `executionId`, `now`, and `result` (`committedVersion`, `projection`) or `error` |
+| `message`             | `message` from the server, `now`                                                 |
+| `tick`                | `now`: acknowledgement batching, chunk timeouts, channel retries and deadlines   |
+| `watchLog`            | `logId`, `call`: a live log call, `input.after` its cursor                       |
+| `unwatchLog`          | `logId`                                                                          |
+| `joinChannel`         | `subscriptionId` (the shell's name for it), `feature`, `channel`                 |
+| `leaveChannel`        | `subscriptionId`                                                                 |
+| `channelWrite`        | `subscriptionId`, `writeId`, `value` of the session's key, `now`                 |
+| `channelSend`         | `subscriptionId`, `writeId`, `value` of a message, `now`                         |
+| `channelsInterrupted` | `error`: the socket cannot authorize                                             |
+| `ended`               | `error`: the shell ended the session (a deleted branch, a closed client)         |
+| `close`               | nothing needs the session: it ends in order and the next socket starts fresh     |
+
+| Instruction          | The shell                                                                                     |
+| -------------------- | --------------------------------------------------------------------------------------------- |
+| `send`               | sends `message` on the socket                                                                 |
+| `postCommand`        | posts `request`'s command to `/runtime/commands` and answers with `commandAnswer`             |
+| `store`              | stores the cursor and `queries`, drops `removed` (all, with `replace`), in one transaction    |
+| `queriesChanged`     | reads the named queries' rows with `rows(queryId)` and shows them                             |
+| `reflected`          | the server's rows now include these writes, or they left the queue answered and shown nowhere |
+| `optimistic`         | write `executionId`'s module `result`, shown until the branch answers                         |
+| `writeResult`        | the branch ran write `executionId`: its `result`                                              |
+| `writeFailed`        | write `executionId` left the queue with `error`; its effect is gone                           |
+| `queryFailed`        | the server cannot serve this query                                                            |
+| `failed`             | the session cannot continue                                                                   |
+| `logEntries`         | gives log `logId` its `entries` (`seq`, `payload`) after the last ones, in order              |
+| `logFailed`          | log `logId` ended with `error`                                                                |
+| `channelEntries`     | shows channel `subscriptionId`'s keys: all of them (`replace`), else the changed `entries`    |
+| `channelWriteResult` | answers write or message `writeId`: its `key` and `version`, or `error`                       |
+| `channelWritten`     | the branch wrote the session's `key`, also when a join wrote it again                         |
+| `channelValue`       | the session's key now holds `value` (null: none), after a refusal                             |
+| `channelDropped`     | the branch refused the value it accepted before: the session holds no key                     |
+| `channelMessage`     | another session's message `value`, named by its sender's `key`                                |
+| `channelInterrupted` | the channel waits to join, since the socket cannot authorize                                  |
+| `channelFailed`      | the channel ended with `error`                                                                |
+| `channelReport`      | a failure no write waits for, such as a refused removal after a leave                         |
+
+The core applies a transition whole or not at all, checks every version
+step, joins chunks and rows parts, acknowledges at once or in batches of
+32 (or after 1 second), repairs one gap at a time, and subscribes fresh
+when a resume has expired.
+
+## Modules
+
+A queued Strata write shows at once on every watched read of the source
+it writes: data, state stores and object stores each project it over the
+rows the server returned. A
+projection never makes a row up. When it cannot be exact (a field the rows
+lack, a key the read left out, a full limit window, a file's rendered
+path) the core asks the branch for every query's rows again, once until
+another query becomes inexact. Before a write is queued, each data create
+without an id takes one: the first the UUID of the `sx1` execution id,
+later ones a UUID drawn from it, so a resend names the same rows. A create
+that needs an id under any other execution id fails
+(`INVALID_EXECUTION_IDENTITY`).
+
+A feature command (`module`, `command`, `input`: a flag override, a
+cohort member, an inbox read, a machine call) is queued with the Strata
+writes, in one order, under an `sx1` execution id. The core hands the one
+at the queue's head to the shell (`postCommand`), which posts it with its
+idempotency key and gives back the branch's answer (`commandAnswer`); a
+write behind it waits for that answer, which the shell always gives (a
+lost one as a retryable `NETWORK_ERROR`): a post stays in flight across a
+reconnect, so it is never posted twice at once. A retryable failure posts
+it again with the same key after the same backoff as a write; the branch
+replays a key it already ran. Flags, cohorts and
+notifications show a command at once on the reads it changes, with the
+same rules as a write's projection; other modules show it once the
+branch's rows hold it.
+
+## Live logs
+
+A live log call (K-LOG) is a live call whose input names its cursor
+`after`. The core gives the shell each entry once, in order, after a first
+read that may hold none. Each log has its own query (`<hash>:<logId>`); once
+it holds a full window (64 entries) the core moves it, in one subscribe, to
+a query after the last entry it gave. A reconnect gives only entries after
+that one. An expired cursor moves the log past the entries given, and fails
+it with `KERNEL_LOG_CURSOR_EXPIRED` only when none were. A log opened again
+under its name (a new `generation`) fails with `KERNEL_LOG_REPLACED`.
+
+## Channels
+
+Channels (K-EPH) hold presence and other ephemeral state, never stored. A
+channel writes only while it is joined, from the snapshot that answers its
+join (every part of it) until the socket closes or the branch resets its
+channels; each join writes the session's kept value again. A snapshot shows every
+key (`replace`); a change shows only the keys it changed (`key`, `value`,
+null for a removed one), so the shell keeps the keys. The core reads a
+push as typed fields and keeps each value as the text it arrived as; a push
+it cannot read changes nothing and is reported (`channelReport`,
+`CHANNEL_PUSH_INVALID`). A refused value
+falls back to the last one accepted, or removes the key. A retryable
+refusal joins again after 1 s, doubling, five times. Each write and message
+is answered once: by the branch, a refusal, or its 30 s deadline (`tick`).
+A message is never sent twice: one the socket lost fails with
+`CHANNEL_SEND_INTERRUPTED`. When the session fails, every channel ends with
+it, answered before `failed`; a session the shell ends (`ended`) ends
+them the same way. Each join subscribes under an id of the core's own, so
+a channel joined again under the shell's name never hears the answers of
+the one before.
+
+## Building
+
+```bash
+pnpm --filter @substratedb/sync-core test     # cargo test, then the packaged web core
+pnpm --filter @substratedb/sync-core build    # the web core in dist/web (feature wasm)
+./build-xcframework.sh                         # iOS device, simulator and macOS, with the Swift bindings
+```
+
+`rust-toolchain.toml` pins Rust and the WebAssembly target. The web build
+also needs `wasm-bindgen-cli` at the crate's version
+(`cargo install --locked wasm-bindgen-cli --version 0.2.130`). It writes
+`dist/web`, the package's `./web` export: the wasm-bindgen glue with the
+WebAssembly inlined (gzipped, then base64), so an app's bundler needs no
+setup. `loadSyncCore()` imports the bytes as their own chunk, unpacks them
+with `DecompressionStream` and instantiates the core once per realm, so a
+page loads the core apart from its first paint; a load that failed is
+tried again by the next call. It needs `DecompressionStream`: Chrome 80,
+Safari 16.4, Firefox 113, Node 20 or later. Every core of a realm draws on one WebAssembly memory
+(4 GiB at most, never shrinking); `memoryBytes()` is its size, and the web
+engine opens no new core past 3 GiB (`SYNC_CORE_MEMORY_EXHAUSTED`).
+
+Swift and Kotlin bind through UniFFI (feature `uniffi`); the web through
+wasm-bindgen (feature `wasm`). Both expose `SyncCore(clientId, requestPrefix, capabilities)` with `hello()`, `handle(event)` and `rows(queryId)`.
+
+## Capabilities
+
+The SDK names the capabilities it implements when it creates the core
+(`channels`, `execution-batch`, `keyed-resume`, `live-calls`, `surfaces`); an
+unknown name is refused. `hello()` answers the `protocolVersion` and
+`capabilities` for the shell's `hello`. Without `live-calls` a live call is
+refused (`CAPABILITY_NOT_DECLARED`), without `keyed-resume` a call with
+`since` is, and without `execution-batch` writes go one at a time. A
+`hello_ack` that lacks a declared capability ends the session
+(`REALTIME_CAPABILITY_UNSUPPORTED`).

package/dist/web/glue.d.ts

@@ -0,0 +1,54 @@
+/* tslint:disable */
+/* eslint-disable */
+
+export class SyncCore {
+    free(): void;
+    handle(event: string): string;
+    hello(): string;
+    constructor(client_id: string, request_prefix: string, capabilities: string[]);
+    rows(query_id: string): string;
+}
+
+export function queryHash(query: string): string;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly __wbg_synccore_free: (a: number, b: number) => void;
+    readonly queryHash: (a: number, b: number) => [number, number, number, number];
+    readonly synccore_handle: (a: number, b: number, c: number) => [number, number, number, number];
+    readonly synccore_hello: (a: number) => [number, number, number, number];
+    readonly synccore_new: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number];
+    readonly synccore_rows: (a: number, b: number, c: number) => [number, number, number, number];
+    readonly __wbindgen_malloc: (a: number, b: number) => number;
+    readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+    readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+    readonly __wbindgen_externrefs: WebAssembly.Table;
+    readonly __externref_table_dealloc: (a: number) => void;
+    readonly __externref_table_alloc: () => number;
+    readonly __externref_drop_slice: (a: number, b: number) => void;
+    readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;