@agoric/kmarshal 0.1.1-dev-a1dd248.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/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@agoric/kmarshal",
+  "version": "0.1.1-dev-a1dd248.0+a1dd248",
+  "description": "Token-only marshaller for kernel and tests",
+  "type": "module",
+  "main": "./src/kmarshal.js",
+  "exports": {
+    ".": "./src/kmarshal.js"
+  },
+  "repository": "https://github.com/Agoric/agoric-sdk",
+  "author": "Agoric",
+  "license": "Apache-2.0",
+  "scripts": {
+    "build": "exit 0",
+    "test": "ava",
+    "test:c8": "c8 $C8_OPTIONS ava --config=ava-nesm.config.js",
+    "test:xs": "exit 0",
+    "lint-fix": "yarn lint:eslint --fix",
+    "lint": "run-s --continue-on-error lint:*",
+    "lint:types": "tsc",
+    "lint:eslint": "eslint ."
+  },
+  "dependencies": {
+    "@agoric/assert": "0.6.1-dev-a1dd248.0+a1dd248",
+    "@endo/far": "^0.2.21",
+    "@endo/marshal": "^0.8.8"
+  },
+  "devDependencies": {
+    "ava": "^5.3.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "ava": {
+    "files": [
+      "test/**/test-*.js"
+    ],
+    "require": [
+      "@endo/init/debug.js"
+    ],
+    "timeout": "2m"
+  },
+  "gitHead": "a1dd248f1dc5a770760e7520660ca9d4d7f442aa"
+}

package/src/kmarshal.js

@@ -0,0 +1,165 @@
+import { Far, passStyleOf } from '@endo/far';
+import { makeMarshal } from '@endo/marshal';
+import { assert, Fail } from '@agoric/assert';
+
+// Simple wrapper for serializing and unserializing marshalled values inside the
+// kernel, where we don't actually want to use clists nor actually allocate real
+// objects, but instead to stay entirely within the domain of krefs.  This is
+// used to enable syntactic manipulation of serialized values while remaining
+// agnostic about the internal details of the serialization encoding.
+
+/**
+ * @typedef {{getKref: () => string, iface: () => string} | Promise} KCap
+ */
+
+const { toStringTag } = Symbol;
+
+const makeStringStandinPromise = kref => {
+  const p = Promise.resolve(`${kref} stand in`);
+  // eslint-disable-next-line @typescript-eslint/no-floating-promises
+  Object.defineProperty(p, toStringTag, {
+    value: kref,
+    enumerable: false,
+  });
+  return harden(p);
+};
+
+const getStringStandinPromiseTag = p => {
+  const desc = Object.getOwnPropertyDescriptor(p, toStringTag);
+  assert(desc !== undefined, 'promise lacks own @@toStringTag property');
+  const kref = desc.value;
+  assert.typeof(kref, 'string');
+  return kref;
+};
+
+const makeAccessorStandinPromise = kref => {
+  // TODO This Bizarro world hack is only for the version of Endo that
+  // agoric-sdk currently depends on, and is already inconsistent with
+  // the "current" endo. Once agoric-sdk depends only on the next endo,
+  // we should delete this code, and rename `makeStringStandinPromise`
+  // above to `makeStandinPromise`.
+  //
+  // Bizarro World hack for attaching a string property to a Promise, courtesy
+  // of MarkM.  Even though the @@toStringTag property nominally *is* a
+  // string, some unfortunate stuff in our hardened JS safety checks blows up
+  // if it actually is.  Eventually that will be fixed and we'll be able to
+  // use the @@toStringTag property directly, but for now we need to use this
+  // weird construct employing a sneaky getter function.  Note that this is
+  // only necessary in the first place because smallcaps encodes promise
+  // references differently from remotable object references, and the current
+  // version of the smallcaps decoder annoyingly insists that if the encoded
+  // body string says a slot is a promise, then convertSlotToVal had better by
+  // damn return an actual Promise, even if, as in the intended use case here,
+  // we neither want nor need a promise nor are capable of making any use of
+  // the fact that it is one.
+  const p = Promise.resolve(`${kref} stand in`);
+  // Bizarro World makes eslint hallucinate
+  // eslint-disable-next-line @typescript-eslint/no-floating-promises
+  Object.defineProperty(p, toStringTag, {
+    get: reveal => (reveal ? kref : NaN),
+    enumerable: false,
+  });
+  return harden(p);
+};
+
+const getAccessorStandinPromiseTag = p => {
+  // Other half of Bizarro World hack for handling promises.  Note the
+  // peculiar way the @@toStringTag getter is used.
+  const desc = Object.getOwnPropertyDescriptor(p, toStringTag);
+  assert(desc !== undefined, 'promise lacks toStringTag getter');
+
+  const getter = desc.get;
+  assert.typeof(getter, 'function', 'toStringTag getter is not a function');
+  // @ts-expect-error violates the norm that getters have zero parameters
+  const kref = getter(true);
+  assert.typeof(kref, 'string');
+  return kref;
+};
+
+const [makeStandinPromise, getStandinPromiseTag] = (() => {
+  // Use whatever works
+  try {
+    const p = makeStringStandinPromise('string mascot');
+    assert(passStyleOf(p) === 'promise');
+    return [makeStringStandinPromise, getStringStandinPromiseTag];
+  } catch (_1) {
+    try {
+      const p = makeAccessorStandinPromise('accessor mascot');
+      assert(passStyleOf(p) === 'promise');
+      return [makeAccessorStandinPromise, getAccessorStandinPromiseTag];
+    } catch (_2) {
+      throw Error('One of the promise tagging schemes should have worked');
+    }
+  }
+})();
+
+/**
+ * @param {string} kref
+ * @param {string} [iface]
+ * @returns {import('@endo/eventual-send').ERef<KCap>}
+ */
+export const kslot = (kref, iface = 'undefined') => {
+  assert.typeof(kref, 'string');
+  if (iface && iface.startsWith('Alleged: ')) {
+    // Encoder prepends "Alleged: " to iface string, but the decoder doesn't strip it
+    // Unclear whether it's the decoder or me who is wrong
+    iface = iface.slice(9);
+  }
+  if (
+    kref.startsWith('p') ||
+    kref.startsWith('kp') ||
+    kref.startsWith('lp') ||
+    kref.startsWith('rp')
+  ) {
+    return makeStandinPromise(kref);
+  } else {
+    const o = Far(iface, {
+      iface: () => iface,
+      getKref: () => `${kref}`,
+    });
+    return o;
+  }
+};
+
+/**
+ * @param {any} obj
+ * @returns {string}
+ */
+export const krefOf = obj => {
+  switch (passStyleOf(obj)) {
+    case 'promise': {
+      return getStandinPromiseTag(obj);
+    }
+    case 'remotable': {
+      const getKref = obj.getKref;
+      assert.typeof(getKref, 'function', 'object lacks getKref function');
+      return getKref();
+    }
+    default:
+      // When krefOf() is called as part of kmarshal.serialize, marshal
+      // will only give it things that are 'remotable' (Promises and the
+      // Far objects created by kslot()).  When krefOf() is called by
+      // kernel code (as part of extractSingleSlot() or the vat-comms
+      // equivalent), it ought to throw if 'obj' is not one of the
+      // objects created by our kslot().
+      return Fail`krefOf requires a promise or remotable`;
+  }
+};
+
+const kmarshal = makeMarshal(krefOf, kslot, {
+  serializeBodyFormat: 'smallcaps',
+  errorTagging: 'off',
+});
+
+export const kser = value => kmarshal.serialize(harden(value));
+
+/**
+ * @param {import('@endo/marshal').CapData<string>} serializedValue
+ * @returns {any}
+ */
+export const kunser = serializedValue => kmarshal.unserialize(serializedValue);
+
+export function makeError(message) {
+  assert.typeof(message, 'string');
+  return kser(Error(message));
+}

package/test/test-basic.js

@@ -0,0 +1,20 @@
+import test from 'ava';
+
+import { kser, kunser, krefOf, kslot } from '../src/kmarshal.js';
+
+test('sanity check', t => {
+  const assertRoundTrip = (val, toComparable = v => v) => {
+    const ser = kser(val);
+    t.not(ser, val);
+    const unser = kunser(ser);
+    t.is(toComparable(unser), toComparable(val));
+  };
+  assertRoundTrip(undefined);
+  assertRoundTrip(47);
+  assertRoundTrip(-2n);
+  assertRoundTrip('foo');
+
+  const remotable = kslot('ko47');
+  t.is(krefOf(remotable), 'ko47');
+  assertRoundTrip(remotable, krefOf);
+});

package/tsconfig.json

@@ -0,0 +1,12 @@
+// This file can contain .js-specific Typescript compiler config.
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "allowSyntheticDefaultImports": true,
+    "maxNodeModuleJsDepth": 2,
+  },
+  "include": [
+    "src/**/*.js",
+    "test/**/*.js"
+  ]
+}