@stellar/stellar-base 10.0.0

package/lib/util/checksum.js

@@ -0,0 +1,20 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.verifyChecksum = verifyChecksum;
+function verifyChecksum(expected, actual) {
+  if (expected.length !== actual.length) {
+    return false;
+  }
+  if (expected.length === 0) {
+    return true;
+  }
+  for (var i = 0; i < expected.length; i += 1) {
+    if (expected[i] !== actual[i]) {
+      return false;
+    }
+  }
+  return true;
+}

package/lib/util/continued_fraction.js

@@ -0,0 +1,58 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.best_r = best_r;
+var _bignumber = _interopRequireDefault(require("bignumber.js"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t["return"] && (u = t["return"](), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+// eslint-disable-next-line no-bitwise
+var MAX_INT = (1 << 31 >>> 0) - 1;
+
+/**
+ * Calculates and returns the best rational approximation of the given real number.
+ * @private
+ * @param {string|number|BigNumber} rawNumber Real number
+ * @throws Error Throws `Error` when the best rational approximation cannot be found.
+ * @returns {array} first element is n (numerator), second element is d (denominator)
+ */
+function best_r(rawNumber) {
+  var number = new _bignumber["default"](rawNumber);
+  var a;
+  var f;
+  var fractions = [[new _bignumber["default"](0), new _bignumber["default"](1)], [new _bignumber["default"](1), new _bignumber["default"](0)]];
+  var i = 2;
+
+  // eslint-disable-next-line no-constant-condition
+  while (true) {
+    if (number.gt(MAX_INT)) {
+      break;
+    }
+    a = number.integerValue(_bignumber["default"].ROUND_FLOOR);
+    f = number.minus(a);
+    var h = a.times(fractions[i - 1][0]).plus(fractions[i - 2][0]);
+    var k = a.times(fractions[i - 1][1]).plus(fractions[i - 2][1]);
+    if (h.gt(MAX_INT) || k.gt(MAX_INT)) {
+      break;
+    }
+    fractions.push([h, k]);
+    if (f.eq(0)) {
+      break;
+    }
+    number = new _bignumber["default"](1).div(f);
+    i += 1;
+  }
+  var _fractions = _slicedToArray(fractions[fractions.length - 1], 2),
+    n = _fractions[0],
+    d = _fractions[1];
+  if (n.isZero() || d.isZero()) {
+    throw new Error("Couldn't find approximation");
+  }
+  return [n.toNumber(), d.toNumber()];
+}

package/lib/util/decode_encode_muxed_account.js

@@ -0,0 +1,116 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.decodeAddressToMuxedAccount = decodeAddressToMuxedAccount;
+exports.encodeMuxedAccount = encodeMuxedAccount;
+exports.encodeMuxedAccountToAddress = encodeMuxedAccountToAddress;
+exports.extractBaseAddress = extractBaseAddress;
+var _xdr = _interopRequireDefault(require("../xdr"));
+var _strkey = require("../strkey");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+/**
+ * Converts a Stellar address (in G... or M... form) to an `xdr.MuxedAccount`
+ * structure, using the ed25519 representation when possible.
+ *
+ * This supports full muxed accounts, where an `M...` address will resolve to
+ * both its underlying `G...` address and an integer ID.
+ *
+ * @param   {string}  address   G... or M... address to encode into XDR
+ * @returns {xdr.MuxedAccount}  a muxed account object for this address string
+ */
+function decodeAddressToMuxedAccount(address) {
+  if (_strkey.StrKey.isValidMed25519PublicKey(address)) {
+    return _decodeAddressFullyToMuxedAccount(address);
+  }
+  return _xdr["default"].MuxedAccount.keyTypeEd25519(_strkey.StrKey.decodeEd25519PublicKey(address));
+}
+
+/**
+ * Converts an xdr.MuxedAccount to its StrKey representation.
+ *
+ * This returns its "M..." string representation if there is a muxing ID within
+ * the object and returns the "G..." representation otherwise.
+ *
+ * @param   {xdr.MuxedAccount} muxedAccount   Raw account to stringify
+ * @returns {string} Stringified G... (corresponding to the underlying pubkey)
+ *     or M... address (corresponding to both the key and the muxed ID)
+ *
+ * @see https://stellar.org/protocol/sep-23
+ */
+function encodeMuxedAccountToAddress(muxedAccount) {
+  if (muxedAccount["switch"]().value === _xdr["default"].CryptoKeyType.keyTypeMuxedEd25519().value) {
+    return _encodeMuxedAccountFullyToAddress(muxedAccount);
+  }
+  return _strkey.StrKey.encodeEd25519PublicKey(muxedAccount.ed25519());
+}
+
+/**
+ * Transform a Stellar address (G...) and an ID into its XDR representation.
+ *
+ * @param  {string} address   - a Stellar G... address
+ * @param  {string} id        - a Uint64 ID represented as a string
+ *
+ * @return {xdr.MuxedAccount} - XDR representation of the above muxed account
+ */
+function encodeMuxedAccount(address, id) {
+  if (!_strkey.StrKey.isValidEd25519PublicKey(address)) {
+    throw new Error('address should be a Stellar account ID (G...)');
+  }
+  if (typeof id !== 'string') {
+    throw new Error('id should be a string representing a number (uint64)');
+  }
+  return _xdr["default"].MuxedAccount.keyTypeMuxedEd25519(new _xdr["default"].MuxedAccountMed25519({
+    id: _xdr["default"].Uint64.fromString(id),
+    ed25519: _strkey.StrKey.decodeEd25519PublicKey(address)
+  }));
+}
+
+/**
+ * Extracts the underlying base (G...) address from an M-address.
+ * @param  {string} address   an account address (either M... or G...)
+ * @return {string} a Stellar public key address (G...)
+ */
+function extractBaseAddress(address) {
+  if (_strkey.StrKey.isValidEd25519PublicKey(address)) {
+    return address;
+  }
+  if (!_strkey.StrKey.isValidMed25519PublicKey(address)) {
+    throw new TypeError("expected muxed account (M...), got ".concat(address));
+  }
+  var muxedAccount = decodeAddressToMuxedAccount(address);
+  return _strkey.StrKey.encodeEd25519PublicKey(muxedAccount.med25519().ed25519());
+}
+
+// Decodes an "M..." account ID into its MuxedAccount object representation.
+function _decodeAddressFullyToMuxedAccount(address) {
+  var rawBytes = _strkey.StrKey.decodeMed25519PublicKey(address);
+
+  // Decoding M... addresses cannot be done through a simple
+  // MuxedAccountMed25519.fromXDR() call, because the definition is:
+  //
+  //    constructor(attributes: { id: Uint64; ed25519: Buffer });
+  //
+  // Note the ID is the first attribute. However, the ID comes *last* in the
+  // stringified (base32-encoded) address itself (it's the last 8-byte suffix).
+  // The `fromXDR()` method interprets bytes in order, so we need to parse out
+  // the raw binary into its requisite parts, i.e. use the MuxedAccountMed25519
+  // constructor directly.
+  //
+  // Refer to https://github.com/stellar/go/blob/master/xdr/muxed_account.go#L26
+  // for the Golang implementation of the M... parsing.
+  return _xdr["default"].MuxedAccount.keyTypeMuxedEd25519(new _xdr["default"].MuxedAccountMed25519({
+    id: _xdr["default"].Uint64.fromXDR(rawBytes.subarray(-8)),
+    ed25519: rawBytes.subarray(0, -8)
+  }));
+}
+
+// Converts an xdr.MuxedAccount into its *true* "M..." string representation.
+function _encodeMuxedAccountFullyToAddress(muxedAccount) {
+  if (muxedAccount["switch"]() === _xdr["default"].CryptoKeyType.keyTypeEd25519()) {
+    return encodeMuxedAccountToAddress(muxedAccount);
+  }
+  var muxed = muxedAccount.med25519();
+  return _strkey.StrKey.encodeMed25519PublicKey(Buffer.concat([muxed.ed25519(), muxed.id().toXDR('raw')]));
+}

package/lib/util/util.js

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.trimEnd = void 0;
+var trimEnd = exports.trimEnd = function trimEnd(input, _char) {
+  var isNumber = typeof input === 'number';
+  var str = String(input);
+  while (str.endsWith(_char)) {
+    str = str.slice(0, -1);
+  }
+  return isNumber ? Number(str) : str;
+};

package/lib/xdr.js

@@ -0,0 +1,9 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _curr_generated = _interopRequireDefault(require("./generated/curr_generated"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+var _default = exports["default"] = _curr_generated["default"];

package/package.json

@@ -0,0 +1,133 @@
+{
+  "name": "@stellar/stellar-base",
+  "version": "10.0.0",
+  "description": "Low-level support library for the Stellar network.",
+  "main": "./lib/index.js",
+  "browser": {
+    "main": "./dist/stellar-base.min.js",
+    "sodium-native": false
+  },
+  "types": "./types/index.d.ts",
+  "scripts": {
+    "build": "yarn build:node && yarn build:browser",
+    "build:node": "babel --out-dir ./lib/ ./src/",
+    "build:browser": "webpack -c ./config/webpack.config.browser.js",
+    "build:node:prod": "cross-env NODE_ENV=production yarn build",
+    "build:browser:prod": "cross-env NODE_ENV=production yarn build:browser",
+    "build:prod": "cross-env NODE_ENV=production yarn build",
+    "test": "yarn build && yarn test:node && yarn test:browser",
+    "test:node": "yarn _nyc mocha",
+    "test:browser": "karma start ./config/karma.conf.js",
+    "docs": "jsdoc -c ./config/.jsdoc.json --verbose",
+    "lint": "eslint -c ./config/.eslintrc.js src/ && dtslint --localTs node_modules/typescript/lib types/",
+    "preversion": "yarn clean && yarn fmt && yarn lint && yarn build:prod && yarn test",
+    "fmt": "prettier --config ./config/prettier.config.js --ignore-path ./config/.prettierignore --write './**/*.js'",
+    "prepare": "yarn build:prod",
+    "clean": "rm -rf lib/ dist/ coverage/ .nyc_output/",
+    "_nyc": "nyc --nycrc-path ./config/.nycrc"
+  },
+  "mocha": {
+    "require": [
+      "@babel/register",
+      "./test/test-helper.js"
+    ],
+    "reporter": "dot",
+    "recursive": true,
+    "timeout": 5000
+  },
+  "nyc": {
+    "sourceMap": false,
+    "instrument": false,
+    "reporter": "text-summary"
+  },
+  "files": [
+    "/dist/*.js",
+    "/lib/**/*.js",
+    "/types/*.d.ts"
+  ],
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
+  "lint-staged": {
+    "**/*.{js,json}": [
+      "yarn fmt",
+      "yarn lint"
+    ]
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/stellar/js-stellar-base.git"
+  },
+  "keywords": [
+    "stellar"
+  ],
+  "author": "Stellar Development Foundation <hello@stellar.org>",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/stellar/js-stellar-base/issues"
+  },
+  "homepage": "https://github.com/stellar/js-stellar-base",
+  "devDependencies": {
+    "@babel/cli": "^7.23.4",
+    "@babel/core": "^7.23.5",
+    "@babel/eslint-parser": "^7.23.3",
+    "@babel/eslint-plugin": "^7.23.5",
+    "@babel/preset-env": "^7.23.5",
+    "@babel/register": "^7.22.15",
+    "@definitelytyped/dtslint": "^0.0.182",
+    "@istanbuljs/nyc-config-babel": "3.0.0",
+    "@types/node": "^20.10.3",
+    "@typescript-eslint/parser": "^6.13.2",
+    "babel-loader": "^9.1.3",
+    "babel-plugin-istanbul": "^6.1.1",
+    "chai": "^4.3.10",
+    "chai-as-promised": "^7.1.1",
+    "cross-env": "^7.0.3",
+    "eslint": "^8.55.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-import": "^2.29.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prefer-import": "^0.0.1",
+    "eslint-plugin-prettier": "^5.0.1",
+    "eslint-webpack-plugin": "^4.0.0",
+    "ghooks": "^2.0.4",
+    "husky": "^8.0.3",
+    "jsdoc": "^4.0.2",
+    "karma": "^6.4.2",
+    "karma-chrome-launcher": "^3.1.0",
+    "karma-coverage": "^2.2.1",
+    "karma-firefox-launcher": "^2.1.1",
+    "karma-mocha": "^2.0.0",
+    "karma-sinon-chai": "^2.0.2",
+    "karma-webpack": "^5.0.0",
+    "lint-staged": "^15.2.0",
+    "minami": "^1.1.1",
+    "mocha": "^10.2.0",
+    "node-polyfill-webpack-plugin": "^2.0.1",
+    "nyc": "^15.1.0",
+    "prettier": "^3.1.0",
+    "randombytes": "^2.1.0",
+    "sinon": "^16.1.0",
+    "sinon-chai": "^3.7.0",
+    "taffydb": "^2.7.3",
+    "terser-webpack-plugin": "^5.3.8",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.3.2",
+    "webpack": "^5.89.0",
+    "webpack-cli": "^5.1.1"
+  },
+  "dependencies": {
+    "@stellar/js-xdr": "^3.0.1",
+    "base32.js": "^0.1.0",
+    "bignumber.js": "^9.1.2",
+    "buffer": "^6.0.3",
+    "sha.js": "^2.3.6",
+    "tweetnacl": "^1.0.3"
+  },
+  "optionalDependencies": {
+    "sodium-native": "^4.0.1"
+  }
+}