@agoric/network 0.1.1-calypso-dev-84eb287.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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

@@ -0,0 +1,155 @@
+# Network API
+<!--
+  content should remain synchronized with
+  https://github.com/Agoric/documentation/blob/main/main/reference/repl/networking.md
+-->
+
+Suitably-empowered code inside a vat can access a "network API" that works
+vaguely like the BSD socket API. This code can:
+- Open a listening port on various networking stacks.
+- Initiate connections to remote ports.
+- Send and receive data over these connections
+- Close the connection and/or ports.
+
+The type of connection is limited by the host in which the vat is running. Chain-based machines must operate in a platonic realm of replicated consensus, so their network options are limited to protocols like IBC, which allow one gestalt chain to talk to other chain-like entities. Each such entity is defined by an evolving set of consensus rules, which typically include a current set of validator public keys and a particular history of hashed block identifiers.
+
+**CAVEAT:** IBC uses
+[Connection](https://github.com/cosmos/ibc/tree/main/spec/core/ics-003-connection-semantics/README.md)
+to mean a chain-to-chain hop, and
+[Channel](https://github.com/cosmos/ibc/tree/main/spec/core/ics-004-channel-and-packet-semantics/README.md)
+to mean a Port-to-Port pathway through a series of hops.
+This is unfortunate, because IBC "Channels" correspond most precisely to
+TCP "connections", and most discussions of network APIs (including this one,
+below) will talk about "connections" extensively.
+For now, our IBC implementation can only use pre-established hops, and provides
+no means for user-level code to create new hops (IBC Connections) at runtime.
+But user-level code can create new IBC Channels at any time. The terminology
+confusion will be most obvious in the section on "Accepting an Inbound Connection",
+where the user code is really accepting an inbound IBC *Channel*.
+
+A channel via these IBC hops will terminate in IBC-aware code on either end. These endpoints might be traditional (static) IBC handlers (such as an ICS-20 token transfer module), or dynamic IBC handlers (e.g. running in a SwingSet vat). SwingSet vat code that wants to speak to vat code in a different SwingSet machine would not use the IBC connection directly: instead it would simply perform normal eventual-send operations (`E(target).foo(args)`) and let the "CapTP" promise-pipelining layer handle the details. But vat code which wants to speak to an ICS-20 handler in some other chain would need to use this layer.
+
+Vats which live inside a solo machine are able to use traditional networking layers, like TCP, HTTP, and WebSockets. This enables them to communicate with e.g. browser-side UI frontends that use WebSockets to query the vat for order status. These connections do not have to follow normal ocap rules, so vat code which accepts them must provide its own authentication and access control protections.
+
+Solo machines may be able to talk to chains and vice versa using specialized protocols. This will be used by CapTP to provide ocap messaging between these heterogeneous machine types.
+
+## The agoric-sdk User Local Port
+
+Each user of the Agoric testnet gets a few personal IBC listening ports. You can access these `Port` objects in the `home.ibcport` array, and you can learn their local address by calling something like `E(home.ibcport[0]).getLocalAddress()`, which will give you a local address like `/ibc-port/portbvmnfb`.
+
+This is currently the only way for user code to get an IBC `Port`, though non-IBC ports can be allocated using the local `home.network` object.  This is an advanced use case, to be documented later.
+
+## Connecting to a Remote Port
+
+To establish a connection, you must start with a local `Port` object, and you must know the name of the remote endpoint. The remote endpoint will have a name like `/ibc-hop/$HOPNAME/ibc-port/$PORTNAME/ordered/$VERSION` (where `ibc-hop`, `ibc-port` and `ordered` are literal strings, spelled just like that, but `$HOPNAME`, `$PORTNAME`, and `$VERSION` are placeholders for arbitrary values that will vary from one endpoint to another).
+
+You must also prepare a `ConnectionHandler` object to manage the connection you're about to create. This has a number of methods which will be called when the things happen to the connection, including packets arriving. This is described in [Receiving Data](#receiving-data).
+
+Then you will call the `connect()` method on your local `Port`. This will return a `Promise` that will fire with a new `Connection` object, on which you can send data. Your `ConnectionHandler` will be notified about the new channel, and will receive inbound data from the other side.
+
+```js
+const remoteEndpoint = `/ibc-hop/${hopName}/ibc-port/${portName}/ordered/${version}`;
+E(home.ibcport[0]).connect(remoteEndpoint, connectionHandler)
+  .then(conn => doSomethingWithConnection(conn));
+```
+
+## Opening a Listening Port and Accepting an Inbound Connection
+
+The other side of `connect()` is a "listening port". These ports are waiting for inbound connections to be established.
+
+To get a listening port, you need a `NetworkInterface` object (such as the one on your `ag-solo` under `home.network`) and ask it for a port, via the `PortAllocator`.
+
+```js
+// ask for a random allocation - ends with a slash
+E(home.network).getPortAllocator()
+  .then(portAllocator => E(portAllocator).allocateCustomIBCPort())
+  .then(port => usePort(port));
+```
+
+IBC has named "hops" (what they call "Connections" in the IBC spec) which each carry data between two specific chains.  These hops are different from the connections described in this document.  When you bind a port like `/ibc-port/$PORT` without specifying the "hop", any IBC chain can initiate a connection to this port.
+
+You can ask the `Port` object this returns for its local address, which is especially useful if you had asked for a random allocation (since otherwise you have no way to know what address you got):
+
+```js
+E(port).getLocalAddress().then(localAddress => useIt(localAddress))
+```
+
+Once the port is bound, you must call `addListener()` to mark it as ready for inbound connections. You must provide this with a `ListenHandler` object, which has methods to react to listening events. As with `ConnectionHandler`, these methods are all optional.
+
+* `onListen(port, handler)`: called when the port starts listening
+* `onAccept(port, remote, handler)`: called when a new channel has been accepted
+* `onError(port, rejection, handler)`: called if the port is no longer able to accept channels, such as if the Connection to the remote chain has failed, perhaps because a consensus failure was observed
+* `onRemove(port, handler)`: called when the `ListenHandler` is being removed
+
+Once your `ChannelHandler` is prepared, call `addListener()`:
+
+```js
+port.addListener(handler).then(() => console.log('listener is active'))
+```
+
+`onAccept()` is the most important method. It is called with a `remote` endpoint, which tells you the address of the `Port` at the other end, where someone else called `connect()`. You can use this to decide if you want to accept the connection, or what sort of authority to exercise in response to messages arriving therein.
+
+If you choose to accept, your `onAccept()` method must return a `Promise` that fires with a [`ConnectionHandler`](#receiving-data). This will be used just like the one you would pass into `connect()`. To decline, throw an error.
+
+
+## Sending Data
+
+The Networking API (at least for IBC) provides a "record pipe", in which each packet is transmitted intact over the network, requiring no additional framing to distinguish where one packet ends and the next one begins. This is in contrast to the "byte pipe" provided by a TCP connection, where you must typically prepend length headers to establish framing boundaries.
+
+Once you have a `Connection` object, you send data by calling its `send()` method:
+
+```js
+connection.send('data');
+```
+
+`send()` returns a Promise for the ACK data sent by the other side of the connection, which is represented in the same way as inbound data for `onReceive()`.
+
+## Receiving Data
+
+You must provide each open connection with a `ConnectionHandler` object, where you write methods that will be called when various things happen to the connection. You can share a single handler object between multiple connections, if you like, or you can make a separate one for each.
+
+You can omit any of the methods and those events will simply be ignored. All these methods include the Connection object as the first argument, and the `ConnectionHandler` itself as the last argument, which might help if you want to share a common handler function among multiple connections.
+
+* `onOpen(connection, handler)`: this is called when the connection is established, which tells you that the remote end has successfully accepted the connection request
+* `onReceive(connection, packetBytes, handler)`: this is called each time the remote end sends a packet of data
+* `onClose(connection, reason, handler)`: this is called when the connection is closed, either because one side wanted it to close, or because an error occurred. `reason` may be `undefined`.
+
+`onReceive()` is the most important method. Each time the remote end sends a packet, your `onReceive()` method will be called with the data inside that packet (currently as a String due to inter-vat marshalling limitations, but ideally as an ArrayBuffer with a custom `toString(encoding='latin1')` method so that it can contain arbitrary bytes).
+
+The return value of `onReceive()` is nominally a Promise for ACK data of the message (that will eventually appear on the other side as resolution of the Promise returned by `connection.send()`).
+For IBC, if the ACK data settles to an empty value `''` then the implementation will automatically send a trivial `'\x01'` ACK, because empty ACKs are not supported by [Cosmos ibc-go](https://github.com/cosmos/ibc-go). This behavior may be different for other network implementations.
+It is recommended to avoid ACK data where possible.
+
+## Closing the Connection
+
+When a given Connection has ceased to be useful, you should close it:
+
+```js
+connection.close();
+```
+
+This initiates a shutdown. The `ConnectionHandler` on both sides will eventually see their `onClose()` methods be called, with a `reason`.  It will allow them to distinguish an intentional `onClose()` (`reason` is `undefined`) from some error condition.
+
+## Removing a Listener
+
+When you no longer wish to receive connections on a port, you can remove the listener:
+
+```js
+port.removeListener(handler).then(() => console.log('removed'));
+```
+
+You must provide the handler you added, to enable the future ability to have multiple listeners on the same port.
+
+Note that if you want to listen on this port again, you can just call `port.addListener(...)`, as before.  If you want to start a new connection, you can always call `port.connect(...)`.
+
+### Closing the Port Entirely
+
+Removing a listener doesn't release the port address to make it available for other `PortAllocator` requests.  You can call:
+
+```js
+port.revoke();
+```
+
+to completely deallocate the port, remove all listeners, close all pending connections, and release its address.
+
+**CAUTION:** Be aware that if you call `E(home.ibcport[0]).revoke()`, it will be useless for new `connect()` or `addListener()` attempts.  You will need to provision a new Agoric client to obtain a new setup with a functioning `home.ibcport[0]`.

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@agoric/network",
+  "version": "0.1.1-calypso-dev-84eb287.0+84eb287",
+  "description": "Agoric's network protocol API",
+  "type": "module",
+  "main": "./src/index.js",
+  "repository": "https://github.com/Agoric/agoric-sdk",
+  "scripts": {
+    "build": "exit 0",
+    "prepack": "tsc --build tsconfig.build.json",
+    "postpack": "git clean -f '*.d.ts*'",
+    "test": "ava",
+    "test:c8": "c8 $C8_OPTIONS ava",
+    "test:xs": "exit 0",
+    "lint-fix": "yarn lint:eslint --fix",
+    "lint": "run-s --continue-on-error lint:*",
+    "lint:types": "tsc",
+    "lint:eslint": "eslint ."
+  },
+  "keywords": [],
+  "author": "Agoric",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "@agoric/assert": "0.6.1-calypso-dev-84eb287.0+84eb287",
+    "@agoric/internal": "0.3.3-calypso-dev-84eb287.0+84eb287",
+    "@agoric/vow": "0.1.1-calypso-dev-84eb287.0+84eb287",
+    "@endo/base64": "^1.0.5",
+    "@endo/far": "^1.1.2",
+    "@endo/pass-style": "^1.4.0",
+    "@endo/patterns": "^1.4.0",
+    "@endo/promise-kit": "^1.1.2"
+  },
+  "devDependencies": {
+    "@agoric/store": "0.9.3-calypso-dev-84eb287.0+84eb287",
+    "@agoric/swingset-liveslots": "0.10.3-calypso-dev-84eb287.0+84eb287",
+    "@agoric/swingset-vat": "0.32.3-calypso-dev-84eb287.0+84eb287",
+    "@agoric/zone": "0.2.3-calypso-dev-84eb287.0+84eb287",
+    "@endo/bundle-source": "^3.2.3",
+    "ava": "^5.3.0",
+    "c8": "^9.1.0"
+  },
+  "exports": {
+    ".": "./src/index.js"
+  },
+  "files": [
+    "CHANGELOG.md",
+    "src/",
+    "scripts/",
+    "tools/"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": "^18.12 || ^20.9"
+  },
+  "ava": {
+    "files": [
+      "test/**/*.test.*"
+    ],
+    "require": [
+      "@endo/init/debug.js"
+    ],
+    "timeout": "20m",
+    "workerThreads": false
+  },
+  "typeCoverage": {
+    "atLeast": 89.7
+  },
+  "gitHead": "84eb287915c8255d68e845a9b6e10c790f0d54cb"
+}

package/src/bytes.d.ts

@@ -0,0 +1,46 @@
+/**
+ * @import {Bytes} from './types.js';
+ */
+/** @typedef {Bytes | Buffer | Uint8Array | Iterable<number>} ByteSource */
+/**
+ * This function is a coercer instead of an asserter because in a future where
+ * binary data has better support across vats and potentially its own type, we
+ * might allow more `specimen`s than just `ByteSource`.
+ *
+ * @param {unknown} specimen
+ * @returns {ByteSource}
+ */
+export function coerceToByteSource(specimen: unknown): ByteSource;
+/**
+ * Convert a Uint8Array or other sequence of octets to a string representation
+ * that `@endo/marshal` accepts as Passable.
+ *
+ * @param {ByteSource} byteSource
+ * @returns {Bytes}
+ */
+export function toBytes(byteSource: ByteSource): Bytes;
+/**
+ * Convert bytes to a String.
+ *
+ * @param {Bytes} bytes
+ * @returns {string}
+ */
+export function bytesToString(bytes: Bytes): string;
+/**
+ * Base64, as specified in https://tools.ietf.org/html/rfc4648#section-4
+ *
+ * @param {ByteSource} byteSource
+ * @returns {string} base64 encoding
+ */
+export function byteSourceToBase64(byteSource: ByteSource): string;
+/**
+ * Decodes a base64 string into bytes.
+ *
+ * @param {string} string Base64-encoded string
+ * @returns {Bytes} decoded bytes
+ */
+export function base64ToBytes(string: string): Bytes;
+export type ByteSource = Bytes | Buffer | Uint8Array | Iterable<number>;
+import type { Bytes } from './types.js';
+import type { Bytes as Bytes_1 } from './types.js';
+//# sourceMappingURL=bytes.d.ts.map

package/src/bytes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bytes.d.ts","sourceRoot":"","sources":["bytes.js"],"names":[],"mappings":"AAKA;;GAEG;AAEH,2EAA2E;AAE3E;;;;;;;GAOG;AACH,6CAHW,OAAO,GACL,UAAU,CAmBtB;AAuBD;;;;;;GAMG;AACH,oCAHW,UAAU,GACR,KAAK,CAOjB;AAED;;;;;GAKG;AACH,qCAHW,KAAK,GACH,MAAM,CAIlB;AAED;;;;;GAKG;AACH,+CAHW,UAAU,GACR,MAAM,CAKlB;AAED;;;;;GAKG;AACH,sCAHW,MAAM,GACJ,KAAK,CAIjB;yBA7Fa,KAAK,GAAG,MAAM,GAAG,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC;2BAHpC,YAAY;sCAAZ,YAAY"}

package/src/bytes.js

@@ -0,0 +1,103 @@
+// @ts-check
+import { details, Fail } from '@agoric/assert';
+import { encodeBase64, decodeBase64 } from '@endo/base64';
+import { isObject } from '@endo/pass-style';
+
+/**
+ * @import {Bytes} from './types.js';
+ */
+
+/** @typedef {Bytes | Buffer | Uint8Array | Iterable<number>} ByteSource */
+
+/**
+ * This function is a coercer instead of an asserter because in a future where
+ * binary data has better support across vats and potentially its own type, we
+ * might allow more `specimen`s than just `ByteSource`.
+ *
+ * @param {unknown} specimen
+ * @returns {ByteSource}
+ */
+export function coerceToByteSource(specimen) {
+  if (typeof specimen === 'string') {
+    return specimen;
+  }
+
+  isObject(specimen) ||
+    assert.fail(details`non-object ${specimen} is not a ByteSource`, TypeError);
+
+  const obj = /** @type {{}} */ (specimen);
+  typeof obj[Symbol.iterator] === 'function' ||
+    assert.fail(
+      details`non-iterable ${specimen} is not a ByteSource`,
+      TypeError,
+    );
+
+  // Good enough... it's iterable and can be converted later.
+  return /** @type {ByteSource} */ (specimen);
+}
+
+/**
+ * @param {ByteSource} contents
+ */
+const coerceToByteArray = contents => {
+  if (typeof contents === 'string') {
+    return Uint8Array.from(contents, c => {
+      const b = c.charCodeAt(0);
+      b <= 0xff || Fail`character cannot be coerced to an octet: ${c}`;
+      return b;
+    });
+  } else if (contents instanceof Uint8Array) {
+    // Reconstruct to ensure we have a Uint8Array and not a Buffer.
+    return new Uint8Array(
+      contents.buffer,
+      contents.byteOffset,
+      contents.byteLength,
+    );
+  }
+  return new Uint8Array(contents);
+};
+
+/**
+ * Convert a Uint8Array or other sequence of octets to a string representation
+ * that `@endo/marshal` accepts as Passable.
+ *
+ * @param {ByteSource} byteSource
+ * @returns {Bytes}
+ */
+export function toBytes(byteSource) {
+  // We return the raw characters in the lower half of
+  // the String's representation.
+  const buf = coerceToByteArray(byteSource);
+  return String.fromCharCode(...buf);
+}
+
+/**
+ * Convert bytes to a String.
+ *
+ * @param {Bytes} bytes
+ * @returns {string}
+ */
+export function bytesToString(bytes) {
+  return bytes;
+}
+
+/**
+ * Base64, as specified in https://tools.ietf.org/html/rfc4648#section-4
+ *
+ * @param {ByteSource} byteSource
+ * @returns {string} base64 encoding
+ */
+export function byteSourceToBase64(byteSource) {
+  const bytes = coerceToByteArray(byteSource);
+  return encodeBase64(bytes);
+}
+
+/**
+ * Decodes a base64 string into bytes.
+ *
+ * @param {string} string Base64-encoded string
+ * @returns {Bytes} decoded bytes
+ */
+export function base64ToBytes(string) {
+  return toBytes(decodeBase64(string));
+}

package/src/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./network.js";
+export * from "./shapes.js";
+export * from "./multiaddr.js";
+export * from "./bytes.js";
+export * from "./types.js";
+export { prepareRouter, prepareRouterProtocol } from "./router.js";
+//# sourceMappingURL=index.d.ts.map

package/src/index.d.ts.map

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

package/src/index.js

@@ -0,0 +1,7 @@
+export * from './network.js';
+export * from './shapes.js';
+export { prepareRouter, prepareRouterProtocol } from './router.js';
+export * from './multiaddr.js';
+export * from './bytes.js';
+// eslint-disable-next-line import/export -- doesn't know types
+export * from './types.js';