refactor(base64): Factor base64 out of SwingSet network
ADD
.eslintignore
+dist
+types

ADD
.gitignore
+dist
+types

ADD
LICENSE
+ 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.

ADD
NEWS.md
NEWS.md
ADD
README.md
README.md
ADD
package.json
+{
+ "name": "@agoric/base64",
+ "version": "0.0.0+1-dev",
+ "description": "Transcodes base64",
+ "author": "Agoric",
+ "license": "Apache-2.0",
+ "type": "module",
+ "main": "./dist/base64.cjs",
+ "module": "./src/main.js",
+ "browser": "./dist/base64.umd.js",
+ "unpkg": "./dist/base64.umd.js",
+ "types": "./types/main.d.ts",
+ "exports": {
+ "import": "./src/main.js",
+ "require": "./dist/base64.cjs",
+ "browser": "./dist/base64.umd.js"
+ },
+ "scripts": {
+ "build": "yarn build:types && yarn build:dist",
+ "build:dist": "rollup --config rollup.config.js",
+ "build:types": "tsc src/*.js --declaration --allowJs --emitDeclarationOnly --outDir types",
+ "clean": "rm -rf dist",
+ "lint": "yarn lint-check",
+ "lint-check": "eslint '**/*.js'",
+ "lint-fix": "eslint --fix '**/*.js'",
+ "prepublish": "yarn clean && yarn build",
+ "test": "ava",
+ "test:nyc": "nyc ava"
+ },
+ "dependencies": {},
+ "devDependencies": {
+ "@rollup/plugin-node-resolve": "^6.1.0",
+ "ava": "^3.12.1",
+ "babel-eslint": "^10.0.3",
+ "eslint": "^6.8.0",
+ "eslint-config-airbnb-base": "^14.0.0",
+ "eslint-config-prettier": "^6.9.0",
+ "eslint-plugin-eslint-comments": "^3.1.2",
+ "eslint-plugin-import": "^2.19.1",
+ "eslint-plugin-prettier": "^3.1.2",
+ "nyc": "^15.1.0",
+ "prettier": "^1.19.1",
+ "rollup": "1.31.0",
+ "rollup-plugin-terser": "^5.1.3",
+ "typescript": "^4.0.5"
+ },
+ "files": [
+ "LICENSE*",
+ "dist",
+ "types",
+ "src"
+ ],
+ "publishConfig": {
+ "access": "public"
+ },
+ "eslintConfig": {
+ "extends": [
+ "airbnb-base",
+ "plugin:prettier/recommended"
+ ],
+ "env": {
+ "es6": true
+ },
+ "rules": {
+ "implicit-arrow-linebreak": "off",
+ "function-paren-newline": "off",
+ "arrow-parens": "off",
+ "strict": "off",
+ "prefer-destructuring": "off",
+ "no-else-return": "off",
+ "no-console": "off",
+ "no-unused-vars": [
+ "error",
+ {
+ "argsIgnorePattern": "^_",
+ "varsIgnorePattern": "^_"
+ }
+ ],
+ "no-return-assign": "off",
+ "no-param-reassign": "off",
+ "no-restricted-syntax": [
+ "off",
+ "ForOfStatement"
+ ],
+ "no-unused-expressions": "off",
+ "no-loop-func": "off",
+ "no-inner-declarations": "off",
+ "import/prefer-default-export": "off",
+ "import/extensions": "off"
+ },
+ "ignorePatterns": [
+ "**/dist/**"
+ ]
+ },
+ "prettier": {
+ "trailingComma": "all",
+ "singleQuote": true
+ },
+ "ava": {
+ "files": [
+ "test/**/test-*.js"
+ ],
+ "timeout": "2m"
+ }
+}

ADD
rollup.config.js
+import resolve from '@rollup/plugin-node-resolve';
+import { terser } from 'rollup-plugin-terser';
+
+const name = 'base64';
+const umd = 'Base64';
+
+export default [
+ {
+ input: 'src/main.js',
+ output: [
+ {
+ file: `dist/${name}.mjs`,
+ format: 'esm',
+ },
+ {
+ file: `dist/${name}.cjs`,
+ format: 'cjs',
+ },
+ ],
+ plugins: [resolve()],
+ },
+ {
+ input: 'src/main.js',
+ output: {
+ file: `dist/${name}.umd.js`,
+ format: 'umd',
+ name: umd,
+ },
+ plugins: [resolve()],
+ },
+ {
+ input: 'src/main.js',
+ output: {
+ file: `dist/${name}.umd.min.js`,
+ format: 'umd',
+ name: umd,
+ },
+ plugins: [resolve(), terser()],
+ },
+];

ADD
src/main.js
+/* eslint no-bitwise: ["off"] */
+// @ts-check
+
+const padding = '=';
+
+const alphabet64 =
+ 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/';
+
+/**
+ * The numeric value corresponding to each letter of the alphabet.
+ * If an alphabet is named for the Greek letters alpha and beta, then clearly a
+ * monodu is named for the corresponding Greek numbers mono and duo.
+ * @type {Record<string, number>}
+ */
+const monodu64 = {};
+for (let i = 0; i < alphabet64.length; i += 1) {
+ const c = alphabet64[i];
+ monodu64[c] = i;
+}
+
+/**
+ * Encodes bytes into a Base64 string, as specified in
+ * https://tools.ietf.org/html/rfc4648#section-4
+ *
+ * @param {Uint8Array} data
+ * @returns {string} base64 encoding
+ */
+export function encodeBase64(data) {
+ // A cursory benchmark shows that string concatenation is about 25% faster
+ // than building an array and joining it in v8, in 2020, for strings of about
+ // 100 long.
+ let string = '';
+ let register = 0;
+ let quantum = 0;
+
+ for (let i = 0; i < data.length; i += 1) {
+ const b = data[i];
+ register = (register << 8) | b;
+ quantum += 8;
+ if (quantum === 24) {
+ string +=
+ alphabet64[(register >>> 18) & 0x3f] +
+ alphabet64[(register >>> 12) & 0x3f] +
+ alphabet64[(register >>> 6) & 0x3f] +
+ alphabet64[(register >>> 0) & 0x3f];
+ register = 0;
+ quantum = 0;
+ }
+ }
+
+ switch (quantum) {
+ case 0:
+ break;
+ case 8:
+ string +=
+ alphabet64[(register >>> 2) & 0x3f] +
+ alphabet64[(register << 4) & 0x3f] +
+ padding +
+ padding;
+ break;
+ case 16:
+ string +=
+ alphabet64[(register >>> 10) & 0x3f] +
+ alphabet64[(register >>> 4) & 0x3f] +
+ alphabet64[(register << 2) & 0x3f] +
+ padding;
+ break;
+ default:
+ throw Error(`internal: bad quantum ${quantum}`);
+ }
+ return string;
+}
+
+/**
+ * Decodes a Base64 string into bytes, as specified in
+ * https://tools.ietf.org/html/rfc4648#section-4
+ *
+ * @param {string} string Base64-encoded string
+ * @param {string} [name] The name of the string as it will appear in error
+ * messages.
+ * @returns {Uint8Array} decoded bytes
+ */
+export function decodeBase64(string, name = '<unknowwn>') {
+ const data = new Uint8Array(Math.ceil((string.length * 4) / 3));
+ let register = 0;
+ let quantum = 0;
+ let i = 0; // index in string
+ let j = 0; // index in data
+
+ while (i < string.length && string[i] !== padding) {
+ const number = monodu64[string[i]];
+ if (number === undefined) {
+ throw Error(`Invalid base64 character ${string[i]} in string ${name}`);
+ }
+ register = (register << 6) | number;
+ quantum += 6;
+ if (quantum >= 8) {
+ quantum -= 8;
+ data[j] = register >>> quantum;
+ j += 1;
+ register &= (1 << quantum) - 1;
+ }
+ i += 1;
+ }
+
+ while (i < string.length && quantum % 8 !== 0) {
+ if (string[i] !== padding) {
+ throw Error(`Missing padding at offset ${i} of string ${name}`);
+ }
+ i += 1;
+ quantum += 6;
+ }
+
+ if (i < string.length) {
+ throw Error(
+ `Base64 string has trailing garbage ${string.substr(
+ i,
+ )} in string ${name}`,
+ );
+ }
+
+ return data.subarray(0, j);
+}

ADD
test/bench-main.js
+import { encodeBase64, decodeBase64 } from '../src/main.js';
+
+const string = new Array(100)
+ .fill(
+ 'there once a rich man from nottingham who tried to cross the river. what a dope, he tripped on a rope. now look at him shiver.',
+ )
+ .join(' ');
+const data = encodeBase64(string);
+
+{
+ const start = Date.now();
+ const limit = start + 1000;
+ let operations = 0;
+ for (let n = 1; Date.now() < limit; n *= 2) {
+ for (let i = 0; i < n; i += 1) {
+ encodeBase64(string);
+ }
+ operations += n;
+ }
+ const end = Date.now();
+ const duration = end - start;
+ console.log(
+ operations / duration,
+ 'encodes per millisecond, for input of length',
+ string.length,
+ );
+}
+
+{
+ const start = Date.now();
+ const limit = start + 1000;
+ let operations = 0;
+ for (let n = 1; Date.now() < limit; n *= 2) {
+ for (let i = 0; i < n; i += 1) {
+ decodeBase64(data);
+ }
+ operations += n;
+ }
+ const end = Date.now();
+ const duration = end - start;
+ console.log(
+ operations / duration,
+ 'decodes per millisecond, for input of length',
+ data.length,
+ );
+}

ADD
test/test-main.js
+import test from 'ava';
+import { encodeBase64, decodeBase64 } from '../src/main.js';
+
+function stringToBytes(string) {
+ const data = new Uint8Array(string.length);
+ for (let i = 0; i < string.length; i += 1) {
+ data[i] = string.charCodeAt(i);
+ }
+ return data;
+}
+
+function bytesToString(data) {
+ return String.fromCharCode(...data);
+}
+
+test('bytes conversions', t => {
+ const insouts = [
+ ['', ''],
+ ['f', 'Zg=='],
+ ['fo', 'Zm8='],
+ ['foo', 'Zm9v'],
+ ['foob', 'Zm9vYg=='],
+ ['fooba', 'Zm9vYmE='],
+ ['foobar', 'Zm9vYmFy'],
+ ];
+ for (const [inp, outp] of insouts) {
+ t.is(encodeBase64(stringToBytes(inp)), outp, `${inp} encodes`);
+ t.is(bytesToString(decodeBase64(outp)), inp, `${outp} decodes`);
+ }
+ const inputs = [
+ 'a',
+ 'ab',
+ 'abc',
+ 'Hello, world!',
+ '\x0d\x02\x09\xff\xfe',
+ 'other--+iadtedata',
+ ];
+ for (const str of inputs) {
+ t.is(
+ bytesToString(decodeBase64(encodeBase64(stringToBytes(str)))),
+ str,
+ `${str} round trips`,
+ );
+ }
+});

refactor(base64): Factor base64 out of SwingSet network (#1995)