@digitalworld/digital-world-sdk 16.0.0

package/lib/cjs/base/signerkey.js

@@ -0,0 +1,72 @@
+'use strict';
+
+var curr_generated = require('./generated/curr_generated.js');
+var strkey = require('./strkey.js');
+
+class SignerKey {
+  /**
+   * Decodes a StrKey address into an xdr.SignerKey instance.
+   *
+   * Only ED25519 public keys (G...), pre-auth transactions (T...), hashes
+   * (H...), and signed payloads (P...) can be signer keys.
+   *
+   * @param address - a StrKey-encoded signer address
+   */
+  static decodeAddress(address) {
+    const vb = strkey.StrKey.getVersionByteForPrefix(address);
+    if (vb === void 0) {
+      throw new Error(`invalid signer key type (${vb})`);
+    }
+    const raw = strkey.decodeCheck(vb, address);
+    switch (vb) {
+      case "signedPayload":
+        return curr_generated.default.SignerKey.signerKeyTypeEd25519SignedPayload(
+          new curr_generated.default.SignerKeyEd25519SignedPayload({
+            ed25519: raw.subarray(0, 32),
+            payload: raw.subarray(36, 36 + raw.readUInt32BE(32))
+          })
+        );
+      case "ed25519PublicKey":
+        return curr_generated.default.SignerKey.signerKeyTypeEd25519(raw);
+      case "preAuthTx":
+        return curr_generated.default.SignerKey.signerKeyTypePreAuthTx(raw);
+      case "sha256Hash":
+        return curr_generated.default.SignerKey.signerKeyTypeHashX(raw);
+      default:
+        throw new Error(`invalid signer key type (${vb})`);
+    }
+  }
+  /**
+   * Encodes a signer key into its StrKey equivalent.
+   *
+   * @param signerKey - the signer
+   */
+  static encodeSignerKey(signerKey) {
+    let strkeyType;
+    let raw;
+    switch (signerKey.switch()) {
+      case curr_generated.default.SignerKeyType.signerKeyTypeEd25519():
+        strkeyType = "ed25519PublicKey";
+        raw = signerKey.value();
+        break;
+      case curr_generated.default.SignerKeyType.signerKeyTypePreAuthTx():
+        strkeyType = "preAuthTx";
+        raw = signerKey.value();
+        break;
+      case curr_generated.default.SignerKeyType.signerKeyTypeHashX():
+        strkeyType = "sha256Hash";
+        raw = signerKey.value();
+        break;
+      case curr_generated.default.SignerKeyType.signerKeyTypeEd25519SignedPayload():
+        strkeyType = "signedPayload";
+        raw = signerKey.ed25519SignedPayload().toXDR("raw");
+        break;
+      default:
+        throw new Error(`invalid SignerKey (type: ${signerKey.switch().name})`);
+    }
+    return strkey.encodeCheck(strkeyType, raw);
+  }
+}
+
+exports.SignerKey = SignerKey;
+//# sourceMappingURL=signerkey.js.map

package/lib/cjs/base/signerkey.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"signerkey.js","sources":["../../../src/base/signerkey.ts"],"sourcesContent":["import xdr from \"./xdr.js\";\nimport { StrKey, encodeCheck, decodeCheck } from \"./strkey.js\";\n\ntype SignerStrKeyType =\n  | \"ed25519PublicKey\"\n  | \"preAuthTx\"\n  | \"sha256Hash\"\n  | \"signedPayload\";\n\n/**\n * A container class with helpers to convert between signer keys\n * (`xdr.SignerKey`) and {@link StrKey}s.\n *\n * It's primarily used for manipulating the `extraSigners` precondition on a\n * {@link Transaction}.\n *\n * @see {@link TransactionBuilder.setExtraSigners}\n */\nexport class SignerKey {\n  /**\n   * Decodes a StrKey address into an xdr.SignerKey instance.\n   *\n   * Only ED25519 public keys (G...), pre-auth transactions (T...), hashes\n   * (H...), and signed payloads (P...) can be signer keys.\n   *\n   * @param address - a StrKey-encoded signer address\n   */\n  static decodeAddress(address: string): xdr.SignerKey {\n    const vb = StrKey.getVersionByteForPrefix(address);\n    if (vb === undefined) {\n      throw new Error(`invalid signer key type (${vb})`);\n    }\n\n    const raw = decodeCheck(vb, address);\n    switch (vb) {\n      case \"signedPayload\":\n        return xdr.SignerKey.signerKeyTypeEd25519SignedPayload(\n          new xdr.SignerKeyEd25519SignedPayload({\n            ed25519: raw.subarray(0, 32),\n            payload: raw.subarray(36, 36 + raw.readUInt32BE(32)),\n          }),\n        );\n\n      case \"ed25519PublicKey\":\n        return xdr.SignerKey.signerKeyTypeEd25519(raw);\n\n      case \"preAuthTx\":\n        return xdr.SignerKey.signerKeyTypePreAuthTx(raw);\n\n      case \"sha256Hash\":\n        return xdr.SignerKey.signerKeyTypeHashX(raw);\n\n      default:\n        throw new Error(`invalid signer key type (${vb})`);\n    }\n  }\n\n  /**\n   * Encodes a signer key into its StrKey equivalent.\n   *\n   * @param signerKey - the signer\n   */\n  static encodeSignerKey(signerKey: xdr.SignerKey): string {\n    let strkeyType: SignerStrKeyType;\n    let raw: Buffer;\n\n    switch (signerKey.switch()) {\n      case xdr.SignerKeyType.signerKeyTypeEd25519():\n        strkeyType = \"ed25519PublicKey\";\n        raw = signerKey.value() as Buffer;\n        break;\n\n      case xdr.SignerKeyType.signerKeyTypePreAuthTx():\n        strkeyType = \"preAuthTx\";\n        raw = signerKey.value() as Buffer;\n        break;\n\n      case xdr.SignerKeyType.signerKeyTypeHashX():\n        strkeyType = \"sha256Hash\";\n        raw = signerKey.value() as Buffer;\n        break;\n\n      case xdr.SignerKeyType.signerKeyTypeEd25519SignedPayload():\n        strkeyType = \"signedPayload\";\n        raw = signerKey.ed25519SignedPayload().toXDR(\"raw\");\n        break;\n\n      default:\n        throw new Error(`invalid SignerKey (type: ${signerKey.switch().name})`);\n    }\n\n    return encodeCheck(strkeyType, raw);\n  }\n}\n"],"names":["StrKey","decodeCheck","xdr","encodeCheck"],"mappings":";;;;;AAkBO,MAAM,SAAA,CAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASrB,OAAO,cAAc,OAAA,EAAgC;AACnD,IAAA,MAAM,EAAA,GAAKA,aAAA,CAAO,uBAAA,CAAwB,OAAO,CAAA;AACjD,IAAA,IAAI,OAAO,MAAA,EAAW;AACpB,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,yBAAA,EAA4B,EAAE,CAAA,CAAA,CAAG,CAAA;AAAA,IACnD;AAEA,IAAA,MAAM,GAAA,GAAMC,kBAAA,CAAY,EAAA,EAAI,OAAO,CAAA;AACnC,IAAA,QAAQ,EAAA;AAAI,MACV,KAAK,eAAA;AACH,QAAA,OAAOC,uBAAI,SAAA,CAAU,iCAAA;AAAA,UACnB,IAAIA,uBAAI,6BAAA,CAA8B;AAAA,YACpC,OAAA,EAAS,GAAA,CAAI,QAAA,CAAS,CAAA,EAAG,EAAE,CAAA;AAAA,YAC3B,OAAA,EAAS,IAAI,QAAA,CAAS,EAAA,EAAI,KAAK,GAAA,CAAI,YAAA,CAAa,EAAE,CAAC;AAAA,WACpD;AAAA,SACH;AAAA,MAEF,KAAK,kBAAA;AACH,QAAA,OAAOA,sBAAA,CAAI,SAAA,CAAU,oBAAA,CAAqB,GAAG,CAAA;AAAA,MAE/C,KAAK,WAAA;AACH,QAAA,OAAOA,sBAAA,CAAI,SAAA,CAAU,sBAAA,CAAuB,GAAG,CAAA;AAAA,MAEjD,KAAK,YAAA;AACH,QAAA,OAAOA,sBAAA,CAAI,SAAA,CAAU,kBAAA,CAAmB,GAAG,CAAA;AAAA,MAE7C;AACE,QAAA,MAAM,IAAI,KAAA,CAAM,CAAA,yBAAA,EAA4B,EAAE,CAAA,CAAA,CAAG,CAAA;AAAA;AACrD,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,gBAAgB,SAAA,EAAkC;AACvD,IAAA,IAAI,UAAA;AACJ,IAAA,IAAI,GAAA;AAEJ,IAAA,QAAQ,SAAA,CAAU,QAAO;AAAG,MAC1B,KAAKA,sBAAA,CAAI,aAAA,CAAc,oBAAA,EAAqB;AAC1C,QAAA,UAAA,GAAa,kBAAA;AACb,QAAA,GAAA,GAAM,UAAU,KAAA,EAAM;AACtB,QAAA;AAAA,MAEF,KAAKA,sBAAA,CAAI,aAAA,CAAc,sBAAA,EAAuB;AAC5C,QAAA,UAAA,GAAa,WAAA;AACb,QAAA,GAAA,GAAM,UAAU,KAAA,EAAM;AACtB,QAAA;AAAA,MAEF,KAAKA,sBAAA,CAAI,aAAA,CAAc,kBAAA,EAAmB;AACxC,QAAA,UAAA,GAAa,YAAA;AACb,QAAA,GAAA,GAAM,UAAU,KAAA,EAAM;AACtB,QAAA;AAAA,MAEF,KAAKA,sBAAA,CAAI,aAAA,CAAc,iCAAA,EAAkC;AACvD,QAAA,UAAA,GAAa,eAAA;AACb,QAAA,GAAA,GAAM,SAAA,CAAU,oBAAA,EAAqB,CAAE,KAAA,CAAM,KAAK,CAAA;AAClD,QAAA;AAAA,MAEF;AACE,QAAA,MAAM,IAAI,KAAA,CAAM,CAAA,yBAAA,EAA4B,UAAU,MAAA,EAAO,CAAE,IAAI,CAAA,CAAA,CAAG,CAAA;AAAA;AAG1E,IAAA,OAAOC,kBAAA,CAAY,YAAY,GAAG,CAAA;AAAA,EACpC;AACF;;;;"}

package/lib/cjs/base/signing.js

@@ -0,0 +1,48 @@
+'use strict';
+
+var buffer = require('buffer');
+var ed = require('@noble/ed25519');
+var sha2_js = require('@noble/hashes/sha2.js');
+
+function _interopNamespace(e) {
+  if (e && e.__esModule) return e;
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n.default = e;
+  return Object.freeze(n);
+}
+
+var ed__namespace = /*#__PURE__*/_interopNamespace(ed);
+
+ed__namespace.hashes.sha512 = sha2_js.sha512;
+function generate(secretKey) {
+  return buffer.Buffer.from(ed__namespace.getPublicKey(secretKey));
+}
+function sign(data, rawSecret) {
+  return buffer.Buffer.from(ed__namespace.sign(buffer.Buffer.from(data), rawSecret));
+}
+function verify(data, signature, rawPublicKey) {
+  return ed__namespace.verify(
+    buffer.Buffer.from(signature),
+    buffer.Buffer.from(data),
+    buffer.Buffer.from(rawPublicKey),
+    {
+      zip215: false
+    }
+  );
+}
+
+exports.generate = generate;
+exports.sign = sign;
+exports.verify = verify;
+//# sourceMappingURL=signing.js.map

package/lib/cjs/base/signing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"signing.js","sources":["../../../src/base/signing.ts"],"sourcesContent":["import * as ed from \"@noble/ed25519\";\nimport { sha512 } from \"@noble/hashes/sha2.js\";\n\ned.hashes.sha512 = sha512;\n/**\n * Derives an Ed25519 public key from a secret key.\n *\n * @param secretKey - the raw Ed25519 secret key\n */\nexport function generate(secretKey: Buffer | Uint8Array): Buffer {\n  return Buffer.from(ed.getPublicKey(secretKey));\n}\n\n/**\n * Signs data using an Ed25519 secret key.\n *\n * @param data - the data to sign\n * @param rawSecret - the raw Ed25519 secret key\n */\nexport function sign(data: Buffer, rawSecret: Buffer | Uint8Array): Buffer {\n  return Buffer.from(ed.sign(Buffer.from(data), rawSecret));\n}\n\n/**\n * Verifies an Ed25519 signature against the given data and public key.\n *\n * @param data - the original signed data\n * @param signature - the signature to verify\n * @param rawPublicKey - the raw Ed25519 public key\n */\nexport function verify(\n  data: Buffer,\n  signature: Buffer,\n  rawPublicKey: Buffer | Uint8Array,\n): boolean {\n  return ed.verify(\n    Buffer.from(signature),\n    Buffer.from(data),\n    Buffer.from(rawPublicKey),\n    {\n      zip215: false,\n    },\n  );\n}\n"],"names":["ed","sha512","Buffer"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAGAA,aAAA,CAAG,OAAO,MAAA,GAASC,cAAA;AAMZ,SAAS,SAAS,SAAA,EAAwC;AAC/D,EAAA,OAAOC,aAAA,CAAO,IAAA,CAAKF,aAAA,CAAG,YAAA,CAAa,SAAS,CAAC,CAAA;AAC/C;AAQO,SAAS,IAAA,CAAK,MAAc,SAAA,EAAwC;AACzE,EAAA,OAAOE,aAAA,CAAO,KAAKF,aAAA,CAAG,IAAA,CAAKE,cAAO,IAAA,CAAK,IAAI,CAAA,EAAG,SAAS,CAAC,CAAA;AAC1D;AASO,SAAS,MAAA,CACd,IAAA,EACA,SAAA,EACA,YAAA,EACS;AACT,EAAA,OAAOF,aAAA,CAAG,MAAA;AAAA,IACRE,aAAA,CAAO,KAAK,SAAS,CAAA;AAAA,IACrBA,aAAA,CAAO,KAAK,IAAI,CAAA;AAAA,IAChBA,aAAA,CAAO,KAAK,YAAY,CAAA;AAAA,IACxB;AAAA,MACE,MAAA,EAAQ;AAAA;AACV,GACF;AACF;;;;;;"}

package/lib/cjs/base/soroban.js

@@ -0,0 +1,91 @@
+'use strict';
+
+class Soroban {
+  /**
+   * Given a whole number smart contract amount of a token and an amount of
+   * decimal places (if the token has any), it returns a "display" value.
+   *
+   * All arithmetic inside the contract is performed on integers to avoid
+   * potential precision and consistency issues of floating-point.
+   *
+   * @param amount - the token amount you want to display
+   * @param decimals - specify how many decimal places a token has
+   *
+   * @throws if the given amount has a decimal point already
+   * @example
+   * ```ts
+   * formatTokenAmount("123000", 4) === "12.3";
+   * formatTokenAmount("123000", 3) === "123.0";
+   * formatTokenAmount("123", 3) === "0.123";
+   * ```
+   */
+  static formatTokenAmount(amount, decimals) {
+    if (amount.includes(".")) {
+      throw new TypeError("No decimals are allowed");
+    }
+    const negative = amount.startsWith("-");
+    let formatted = negative ? amount.slice(1) : amount;
+    if (decimals > 0) {
+      if (decimals > formatted.length) {
+        formatted = ["0", formatted.toString().padStart(decimals, "0")].join(
+          "."
+        );
+      } else {
+        formatted = [
+          formatted.slice(0, -decimals),
+          formatted.slice(-decimals)
+        ].join(".");
+      }
+    }
+    if (formatted.includes(".")) {
+      formatted = formatted.replace(/0+$/, "");
+      if (formatted.endsWith(".")) {
+        formatted += "0";
+      }
+    }
+    if (formatted.startsWith(".")) {
+      formatted = `0${formatted}`;
+    }
+    return negative ? `-${formatted}` : formatted;
+  }
+  /**
+   * Parse a token amount to use it on smart contract
+   *
+   * This function takes the display value and its decimals (if the token has
+   * any) and returns a string that'll be used within the smart contract.
+   *
+   * Returns the whole number token amount represented by the display value
+   * with the decimal places shifted over.
+   *
+   * @param value - the token amount you want to use on a smart contract
+   *    which you've been displaying in a UI
+   * @param decimals - the number of decimal places expected in the
+   *    display value (different than the "actual" number, because suffix zeroes
+   *    might not be present)
+   *
+   * @example
+   * ```ts
+   * const displayValueAmount = "123.4560"
+   * const parsedAmtForSmartContract = parseTokenAmount(displayValueAmount, 5);
+   * parsedAmtForSmartContract === "12345600"
+   * ```
+   */
+  static parseTokenAmount(value, decimals) {
+    const [whole, fraction, ...rest] = value.split(".").slice();
+    if (rest.length) {
+      throw new Error(`Invalid decimal value: ${value}`);
+    }
+    if (fraction?.length && fraction.length > decimals) {
+      throw new Error(
+        `Too many decimal places in "${value}": expected at most ${decimals}, got ${fraction.length}`
+      );
+    }
+    const shifted = BigInt(
+      whole + (fraction?.padEnd(decimals, "0") ?? "0".repeat(decimals))
+    );
+    return shifted.toString();
+  }
+}
+
+exports.Soroban = Soroban;
+//# sourceMappingURL=soroban.js.map

package/lib/cjs/base/soroban.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"soroban.js","sources":["../../../src/base/soroban.ts"],"sourcesContent":["/** Helper class to assist with formatting and parsing token amounts.*/\nexport class Soroban {\n  /**\n   * Given a whole number smart contract amount of a token and an amount of\n   * decimal places (if the token has any), it returns a \"display\" value.\n   *\n   * All arithmetic inside the contract is performed on integers to avoid\n   * potential precision and consistency issues of floating-point.\n   *\n   * @param amount - the token amount you want to display\n   * @param decimals - specify how many decimal places a token has\n   *\n   * @throws if the given amount has a decimal point already\n   * @example\n   * ```ts\n   * formatTokenAmount(\"123000\", 4) === \"12.3\";\n   * formatTokenAmount(\"123000\", 3) === \"123.0\";\n   * formatTokenAmount(\"123\", 3) === \"0.123\";\n   * ```\n   */\n  static formatTokenAmount(amount: string, decimals: number): string {\n    if (amount.includes(\".\")) {\n      throw new TypeError(\"No decimals are allowed\");\n    }\n\n    const negative = amount.startsWith(\"-\");\n    let formatted = negative ? amount.slice(1) : amount;\n\n    if (decimals > 0) {\n      if (decimals > formatted.length) {\n        formatted = [\"0\", formatted.toString().padStart(decimals, \"0\")].join(\n          \".\",\n        );\n      } else {\n        formatted = [\n          formatted.slice(0, -decimals),\n          formatted.slice(-decimals),\n        ].join(\".\");\n      }\n    }\n\n    if (formatted.includes(\".\")) {\n      formatted = formatted.replace(/0+$/, \"\"); // strip trailing zeroes\n      if (formatted.endsWith(\".\")) {\n        formatted += \"0\"; // but keep at least one\n      }\n    }\n    if (formatted.startsWith(\".\")) {\n      formatted = `0${formatted}`; // and a leading one\n    }\n\n    return negative ? `-${formatted}` : formatted;\n  }\n\n  /**\n   * Parse a token amount to use it on smart contract\n   *\n   * This function takes the display value and its decimals (if the token has\n   * any) and returns a string that'll be used within the smart contract.\n   *\n   * Returns the whole number token amount represented by the display value\n   * with the decimal places shifted over.\n   *\n   * @param value - the token amount you want to use on a smart contract\n   *    which you've been displaying in a UI\n   * @param decimals - the number of decimal places expected in the\n   *    display value (different than the \"actual\" number, because suffix zeroes\n   *    might not be present)\n   *\n   * @example\n   * ```ts\n   * const displayValueAmount = \"123.4560\"\n   * const parsedAmtForSmartContract = parseTokenAmount(displayValueAmount, 5);\n   * parsedAmtForSmartContract === \"12345600\"\n   * ```\n   */\n  static parseTokenAmount(value: string, decimals: number): string {\n    const [whole, fraction, ...rest] = value.split(\".\").slice();\n\n    if (rest.length) {\n      throw new Error(`Invalid decimal value: ${value}`);\n    }\n\n    if (fraction?.length && fraction.length > decimals) {\n      throw new Error(\n        `Too many decimal places in \"${value}\": expected at most ${decimals}, got ${fraction.length}`,\n      );\n    }\n\n    const shifted = BigInt(\n      whole + (fraction?.padEnd(decimals, \"0\") ?? \"0\".repeat(decimals)),\n    );\n\n    return shifted.toString();\n  }\n}\n"],"names":[],"mappings":";;AACO,MAAM,OAAA,CAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmBnB,OAAO,iBAAA,CAAkB,MAAA,EAAgB,QAAA,EAA0B;AACjE,IAAA,IAAI,MAAA,CAAO,QAAA,CAAS,GAAG,CAAA,EAAG;AACxB,MAAA,MAAM,IAAI,UAAU,yBAAyB,CAAA;AAAA,IAC/C;AAEA,IAAA,MAAM,QAAA,GAAW,MAAA,CAAO,UAAA,CAAW,GAAG,CAAA;AACtC,IAAA,IAAI,SAAA,GAAY,QAAA,GAAW,MAAA,CAAO,KAAA,CAAM,CAAC,CAAA,GAAI,MAAA;AAE7C,IAAA,IAAI,WAAW,CAAA,EAAG;AAChB,MAAA,IAAI,QAAA,GAAW,UAAU,MAAA,EAAQ;AAC/B,QAAA,SAAA,GAAY,CAAC,KAAK,SAAA,CAAU,QAAA,GAAW,QAAA,CAAS,QAAA,EAAU,GAAG,CAAC,CAAA,CAAE,IAAA;AAAA,UAC9D;AAAA,SACF;AAAA,MACF,CAAA,MAAO;AACL,QAAA,SAAA,GAAY;AAAA,UACV,SAAA,CAAU,KAAA,CAAM,CAAA,EAAG,CAAC,QAAQ,CAAA;AAAA,UAC5B,SAAA,CAAU,KAAA,CAAM,CAAC,QAAQ;AAAA,SAC3B,CAAE,KAAK,GAAG,CAAA;AAAA,MACZ;AAAA,IACF;AAEA,IAAA,IAAI,SAAA,CAAU,QAAA,CAAS,GAAG,CAAA,EAAG;AAC3B,MAAA,SAAA,GAAY,SAAA,CAAU,OAAA,CAAQ,KAAA,EAAO,EAAE,CAAA;AACvC,MAAA,IAAI,SAAA,CAAU,QAAA,CAAS,GAAG,CAAA,EAAG;AAC3B,QAAA,SAAA,IAAa,GAAA;AAAA,MACf;AAAA,IACF;AACA,IAAA,IAAI,SAAA,CAAU,UAAA,CAAW,GAAG,CAAA,EAAG;AAC7B,MAAA,SAAA,GAAY,IAAI,SAAS,CAAA,CAAA;AAAA,IAC3B;AAEA,IAAA,OAAO,QAAA,GAAW,CAAA,CAAA,EAAI,SAAS,CAAA,CAAA,GAAK,SAAA;AAAA,EACtC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAwBA,OAAO,gBAAA,CAAiB,KAAA,EAAe,QAAA,EAA0B;AAC/D,IAAA,MAAM,CAAC,KAAA,EAAO,QAAA,EAAU,GAAG,IAAI,IAAI,KAAA,CAAM,KAAA,CAAM,GAAG,CAAA,CAAE,KAAA,EAAM;AAE1D,IAAA,IAAI,KAAK,MAAA,EAAQ;AACf,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,uBAAA,EAA0B,KAAK,CAAA,CAAE,CAAA;AAAA,IACnD;AAEA,IAAA,IAAI,QAAA,EAAU,MAAA,IAAU,QAAA,CAAS,MAAA,GAAS,QAAA,EAAU;AAClD,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,+BAA+B,KAAK,CAAA,oBAAA,EAAuB,QAAQ,CAAA,MAAA,EAAS,SAAS,MAAM,CAAA;AAAA,OAC7F;AAAA,IACF;AAEA,IAAA,MAAM,OAAA,GAAU,MAAA;AAAA,MACd,KAAA,IAAS,UAAU,MAAA,CAAO,QAAA,EAAU,GAAG,CAAA,IAAK,GAAA,CAAI,OAAO,QAAQ,CAAA;AAAA,KACjE;AAEA,IAAA,OAAO,QAAQ,QAAA,EAAS;AAAA,EAC1B;AACF;;;;"}

package/lib/cjs/base/sorobandata_builder.js

@@ -0,0 +1,148 @@
+'use strict';
+
+var buffer = require('buffer');
+var curr_generated = require('./generated/curr_generated.js');
+
+class SorobanDataBuilder {
+  _data;
+  /**
+   * @param sorobanData - either a base64-encoded string that represents an
+   *      {@link xdr.SorobanTransactionData} instance or an XDR instance itself
+   *      (it will be copied); if omitted or "falsy" (e.g. an empty string), it
+   *      starts with an empty instance
+   */
+  constructor(sorobanData) {
+    let data;
+    if (!sorobanData) {
+      data = new curr_generated.default.SorobanTransactionData({
+        resources: new curr_generated.default.SorobanResources({
+          footprint: new curr_generated.default.LedgerFootprint({ readOnly: [], readWrite: [] }),
+          instructions: 0,
+          diskReadBytes: 0,
+          writeBytes: 0
+        }),
+        ext: new curr_generated.default.SorobanTransactionDataExt(0),
+        resourceFee: new curr_generated.default.Int64(0)
+      });
+    } else if (typeof sorobanData === "string" || ArrayBuffer.isView(sorobanData)) {
+      data = SorobanDataBuilder.fromXDR(sorobanData);
+    } else {
+      data = SorobanDataBuilder.fromXDR(sorobanData.toXDR());
+    }
+    this._data = data;
+  }
+  /**
+   * Decodes and builds a {@link xdr.SorobanTransactionData} instance.
+   *
+   * @param data - raw input to decode
+   */
+  static fromXDR(data) {
+    if (typeof data === "string") {
+      return curr_generated.default.SorobanTransactionData.fromXDR(data, "base64");
+    } else {
+      return curr_generated.default.SorobanTransactionData.fromXDR(buffer.Buffer.from(data), "raw");
+    }
+  }
+  /**
+   * Sets the resource fee portion of the Soroban data.
+   *
+   * @param fee - the resource fee to set (int64)
+   */
+  setResourceFee(fee) {
+    this._data.resourceFee(new curr_generated.default.Int64(fee));
+    return this;
+  }
+  /**
+   * Sets up the resource metrics.
+   *
+   * You should almost NEVER need this, as its often generated / provided to you
+   * by transaction simulation/preflight from a Soroban RPC server.
+   *
+   * @param cpuInstrs - number of CPU instructions
+   * @param diskReadBytes - number of bytes being read from disk
+   * @param writeBytes - number of bytes being written to disk/memory
+   */
+  setResources(cpuInstrs, diskReadBytes, writeBytes) {
+    this._data.resources().instructions(cpuInstrs);
+    this._data.resources().diskReadBytes(diskReadBytes);
+    this._data.resources().writeBytes(writeBytes);
+    return this;
+  }
+  /**
+   * Appends the given ledger keys to the existing storage access footprint.
+   *
+   * @param readOnly - read-only keys to add
+   * @param readWrite - read-write keys to add
+   */
+  appendFootprint(readOnly, readWrite) {
+    return this.setFootprint(
+      this.getReadOnly().concat(readOnly),
+      this.getReadWrite().concat(readWrite)
+    );
+  }
+  /**
+   * Sets the storage access footprint to be a certain set of ledger keys.
+   *
+   * You can also set each field explicitly via
+   * {@link SorobanDataBuilder.setReadOnly} and
+   * {@link SorobanDataBuilder.setReadWrite} or add to the existing footprint
+   * via {@link SorobanDataBuilder.appendFootprint}.
+   *
+   * Passing `null|undefined` to either parameter will IGNORE the existing
+   * values. If you want to clear them, pass `[]`, instead.
+   *
+   * @param readOnly - the set of ledger keys to set in the read-only portion of the transaction's `sorobanData`, or `null | undefined` to keep the existing keys
+   * @param readWrite - the set of ledger keys to set in the read-write portion of the transaction's `sorobanData`, or `null | undefined` to keep the existing keys
+   */
+  setFootprint(readOnly, readWrite) {
+    if (readOnly !== null) {
+      this.setReadOnly(readOnly);
+    }
+    if (readWrite !== null) {
+      this.setReadWrite(readWrite);
+    }
+    return this;
+  }
+  /**
+   * Sets the read-only keys in the access footprint.
+   *
+   * @param readOnly - read-only keys in the access footprint
+   */
+  setReadOnly(readOnly) {
+    this._data.resources().footprint().readOnly(readOnly ?? []);
+    return this;
+  }
+  /**
+   * Sets the read-write keys in the access footprint.
+   *
+   * @param readWrite - read-write keys in the access footprint
+   */
+  setReadWrite(readWrite) {
+    this._data.resources().footprint().readWrite(readWrite ?? []);
+    return this;
+  }
+  /**
+   * Returns a copy of the final data structure.
+   */
+  build() {
+    return curr_generated.default.SorobanTransactionData.fromXDR(this._data.toXDR());
+  }
+  //
+  // getters follow
+  //
+  /** Returns the read-only storage access pattern. */
+  getReadOnly() {
+    return this.getFootprint().readOnly();
+  }
+  /** Returns the read-write storage access pattern. */
+  getReadWrite() {
+    return this.getFootprint().readWrite();
+  }
+  /** Returns the storage access pattern. */
+  getFootprint() {
+    return this._data.resources().footprint();
+  }
+}
+
+exports.SorobanDataBuilder = SorobanDataBuilder;
+//# sourceMappingURL=sorobandata_builder.js.map

package/lib/cjs/base/sorobandata_builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sorobandata_builder.js","sources":["../../../src/base/sorobandata_builder.ts"],"sourcesContent":["import xdr from \"./xdr.js\";\n\nexport type IntLike = bigint | number | string;\n\n/**\n * Supports building {@link xdr.SorobanTransactionData} structures with various\n * items set to specific values.\n *\n * This is recommended for when you are building\n * {@link Operation.extendFootprintTtl} / {@link Operation.restoreFootprint}\n * operations and need to {@link TransactionBuilder.setSorobanData} to avoid\n * (re)building the entire data structure from scratch.\n *\n * @example\n * ```ts\n * // You want to use an existing data blob but override specific parts.\n * const newData = new SorobanDataBuilder(existing)\n *   .setReadOnly(someLedgerKeys)\n *   .setResourceFee(\"1000\")\n *   .build();\n *\n * // You want an instance from scratch\n * const newData = new SorobanDataBuilder()\n *   .setFootprint([someLedgerKey], [])\n *   .setResourceFee(\"1000\")\n *   .build();\n * ```\n */\nexport class SorobanDataBuilder {\n  private _data: xdr.SorobanTransactionData;\n\n  /**\n   * @param sorobanData - either a base64-encoded string that represents an\n   *      {@link xdr.SorobanTransactionData} instance or an XDR instance itself\n   *      (it will be copied); if omitted or \"falsy\" (e.g. an empty string), it\n   *      starts with an empty instance\n   */\n  constructor(\n    sorobanData?: Buffer | Uint8Array | xdr.SorobanTransactionData | string,\n  ) {\n    let data: xdr.SorobanTransactionData;\n\n    if (!sorobanData) {\n      data = new xdr.SorobanTransactionData({\n        resources: new xdr.SorobanResources({\n          footprint: new xdr.LedgerFootprint({ readOnly: [], readWrite: [] }),\n          instructions: 0,\n          diskReadBytes: 0,\n          writeBytes: 0,\n        }),\n        ext: new xdr.SorobanTransactionDataExt(0),\n        resourceFee: new xdr.Int64(0),\n      });\n    } else if (\n      typeof sorobanData === \"string\" ||\n      ArrayBuffer.isView(sorobanData)\n    ) {\n      data = SorobanDataBuilder.fromXDR(sorobanData as Uint8Array | string);\n    } else {\n      data = SorobanDataBuilder.fromXDR(sorobanData.toXDR()); // copy\n    }\n\n    this._data = data;\n  }\n\n  /**\n   * Decodes and builds a {@link xdr.SorobanTransactionData} instance.\n   *\n   * @param data - raw input to decode\n   */\n  static fromXDR(\n    data: Buffer | Uint8Array | string,\n  ): xdr.SorobanTransactionData {\n    if (typeof data === \"string\") {\n      return xdr.SorobanTransactionData.fromXDR(data, \"base64\");\n    } else {\n      return xdr.SorobanTransactionData.fromXDR(Buffer.from(data), \"raw\");\n    }\n  }\n\n  /**\n   * Sets the resource fee portion of the Soroban data.\n   *\n   * @param fee - the resource fee to set (int64)\n   */\n  setResourceFee(fee: IntLike): SorobanDataBuilder {\n    this._data.resourceFee(new xdr.Int64(fee));\n    return this;\n  }\n\n  /**\n   * Sets up the resource metrics.\n   *\n   * You should almost NEVER need this, as its often generated / provided to you\n   * by transaction simulation/preflight from a Soroban RPC server.\n   *\n   * @param cpuInstrs - number of CPU instructions\n   * @param diskReadBytes - number of bytes being read from disk\n   * @param writeBytes - number of bytes being written to disk/memory\n   */\n  setResources(\n    cpuInstrs: number,\n    diskReadBytes: number,\n    writeBytes: number,\n  ): SorobanDataBuilder {\n    this._data.resources().instructions(cpuInstrs);\n    this._data.resources().diskReadBytes(diskReadBytes);\n    this._data.resources().writeBytes(writeBytes);\n\n    return this;\n  }\n\n  /**\n   * Appends the given ledger keys to the existing storage access footprint.\n   *\n   * @param readOnly - read-only keys to add\n   * @param readWrite - read-write keys to add\n   */\n  appendFootprint(\n    readOnly: xdr.LedgerKey[],\n    readWrite: xdr.LedgerKey[],\n  ): SorobanDataBuilder {\n    return this.setFootprint(\n      this.getReadOnly().concat(readOnly),\n      this.getReadWrite().concat(readWrite),\n    );\n  }\n\n  /**\n   * Sets the storage access footprint to be a certain set of ledger keys.\n   *\n   * You can also set each field explicitly via\n   * {@link SorobanDataBuilder.setReadOnly} and\n   * {@link SorobanDataBuilder.setReadWrite} or add to the existing footprint\n   * via {@link SorobanDataBuilder.appendFootprint}.\n   *\n   * Passing `null|undefined` to either parameter will IGNORE the existing\n   * values. If you want to clear them, pass `[]`, instead.\n   *\n   * @param readOnly - the set of ledger keys to set in the read-only portion of the transaction's `sorobanData`, or `null | undefined` to keep the existing keys\n   * @param readWrite - the set of ledger keys to set in the read-write portion of the transaction's `sorobanData`, or `null | undefined` to keep the existing keys\n   */\n  setFootprint(\n    readOnly?: xdr.LedgerKey[] | null,\n    readWrite?: xdr.LedgerKey[] | null,\n  ): SorobanDataBuilder {\n    if (readOnly !== null) {\n      // null means \"leave me alone\"\n      this.setReadOnly(readOnly);\n    }\n    if (readWrite !== null) {\n      this.setReadWrite(readWrite);\n    }\n    return this;\n  }\n\n  /**\n   * Sets the read-only keys in the access footprint.\n   *\n   * @param readOnly - read-only keys in the access footprint\n   */\n  setReadOnly(readOnly?: xdr.LedgerKey[]): SorobanDataBuilder {\n    this._data\n      .resources()\n      .footprint()\n      .readOnly(readOnly ?? []);\n    return this;\n  }\n\n  /**\n   * Sets the read-write keys in the access footprint.\n   *\n   * @param readWrite - read-write keys in the access footprint\n   */\n  setReadWrite(readWrite?: xdr.LedgerKey[]): SorobanDataBuilder {\n    this._data\n      .resources()\n      .footprint()\n      .readWrite(readWrite ?? []);\n    return this;\n  }\n\n  /**\n   * Returns a copy of the final data structure.\n   */\n  build(): xdr.SorobanTransactionData {\n    return xdr.SorobanTransactionData.fromXDR(this._data.toXDR()); // clone\n  }\n\n  //\n  // getters follow\n  //\n\n  /** Returns the read-only storage access pattern. */\n  getReadOnly(): xdr.LedgerKey[] {\n    return this.getFootprint().readOnly();\n  }\n\n  /** Returns the read-write storage access pattern. */\n  getReadWrite(): xdr.LedgerKey[] {\n    return this.getFootprint().readWrite();\n  }\n\n  /** Returns the storage access pattern. */\n  getFootprint(): xdr.LedgerFootprint {\n    return this._data.resources().footprint();\n  }\n}\n"],"names":["xdr","Buffer"],"mappings":";;;;;AA4BO,MAAM,kBAAA,CAAmB;AAAA,EACtB,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQR,YACE,WAAA,EACA;AACA,IAAA,IAAI,IAAA;AAEJ,IAAA,IAAI,CAAC,WAAA,EAAa;AAChB,MAAA,IAAA,GAAO,IAAIA,uBAAI,sBAAA,CAAuB;AAAA,QACpC,SAAA,EAAW,IAAIA,sBAAA,CAAI,gBAAA,CAAiB;AAAA,UAClC,SAAA,EAAW,IAAIA,sBAAA,CAAI,eAAA,CAAgB,EAAE,QAAA,EAAU,EAAC,EAAG,SAAA,EAAW,EAAC,EAAG,CAAA;AAAA,UAClE,YAAA,EAAc,CAAA;AAAA,UACd,aAAA,EAAe,CAAA;AAAA,UACf,UAAA,EAAY;AAAA,SACb,CAAA;AAAA,QACD,GAAA,EAAK,IAAIA,sBAAA,CAAI,yBAAA,CAA0B,CAAC,CAAA;AAAA,QACxC,WAAA,EAAa,IAAIA,sBAAA,CAAI,KAAA,CAAM,CAAC;AAAA,OAC7B,CAAA;AAAA,IACH,WACE,OAAO,WAAA,KAAgB,YACvB,WAAA,CAAY,MAAA,CAAO,WAAW,CAAA,EAC9B;AACA,MAAA,IAAA,GAAO,kBAAA,CAAmB,QAAQ,WAAkC,CAAA;AAAA,IACtE,CAAA,MAAO;AACL,MAAA,IAAA,GAAO,kBAAA,CAAmB,OAAA,CAAQ,WAAA,CAAY,KAAA,EAAO,CAAA;AAAA,IACvD;AAEA,IAAA,IAAA,CAAK,KAAA,GAAQ,IAAA;AAAA,EACf;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,QACL,IAAA,EAC4B;AAC5B,IAAA,IAAI,OAAO,SAAS,QAAA,EAAU;AAC5B,MAAA,OAAOA,sBAAA,CAAI,sBAAA,CAAuB,OAAA,CAAQ,IAAA,EAAM,QAAQ,CAAA;AAAA,IAC1D,CAAA,MAAO;AACL,MAAA,OAAOA,uBAAI,sBAAA,CAAuB,OAAA,CAAQC,cAAO,IAAA,CAAK,IAAI,GAAG,KAAK,CAAA;AAAA,IACpE;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,eAAe,GAAA,EAAkC;AAC/C,IAAA,IAAA,CAAK,MAAM,WAAA,CAAY,IAAID,sBAAA,CAAI,KAAA,CAAM,GAAG,CAAC,CAAA;AACzC,IAAA,OAAO,IAAA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,YAAA,CACE,SAAA,EACA,aAAA,EACA,UAAA,EACoB;AACpB,IAAA,IAAA,CAAK,KAAA,CAAM,SAAA,EAAU,CAAE,YAAA,CAAa,SAAS,CAAA;AAC7C,IAAA,IAAA,CAAK,KAAA,CAAM,SAAA,EAAU,CAAE,aAAA,CAAc,aAAa,CAAA;AAClD,IAAA,IAAA,CAAK,KAAA,CAAM,SAAA,EAAU,CAAE,UAAA,CAAW,UAAU,CAAA;AAE5C,IAAA,OAAO,IAAA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,eAAA,CACE,UACA,SAAA,EACoB;AACpB,IAAA,OAAO,IAAA,CAAK,YAAA;AAAA,MACV,IAAA,CAAK,WAAA,EAAY,CAAE,MAAA,CAAO,QAAQ,CAAA;AAAA,MAClC,IAAA,CAAK,YAAA,EAAa,CAAE,MAAA,CAAO,SAAS;AAAA,KACtC;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBA,YAAA,CACE,UACA,SAAA,EACoB;AACpB,IAAA,IAAI,aAAa,IAAA,EAAM;AAErB,MAAA,IAAA,CAAK,YAAY,QAAQ,CAAA;AAAA,IAC3B;AACA,IAAA,IAAI,cAAc,IAAA,EAAM;AACtB,MAAA,IAAA,CAAK,aAAa,SAAS,CAAA;AAAA,IAC7B;AACA,IAAA,OAAO,IAAA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,YAAY,QAAA,EAAgD;AAC1D,IAAA,IAAA,CAAK,KAAA,CACF,WAAU,CACV,SAAA,GACA,QAAA,CAAS,QAAA,IAAY,EAAE,CAAA;AAC1B,IAAA,OAAO,IAAA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,aAAa,SAAA,EAAiD;AAC5D,IAAA,IAAA,CAAK,KAAA,CACF,WAAU,CACV,SAAA,GACA,SAAA,CAAU,SAAA,IAAa,EAAE,CAAA;AAC5B,IAAA,OAAO,IAAA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA,EAKA,KAAA,GAAoC;AAClC,IAAA,OAAOA,uBAAI,sBAAA,CAAuB,OAAA,CAAQ,IAAA,CAAK,KAAA,CAAM,OAAO,CAAA;AAAA,EAC9D;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,WAAA,GAA+B;AAC7B,IAAA,OAAO,IAAA,CAAK,YAAA,EAAa,CAAE,QAAA,EAAS;AAAA,EACtC;AAAA;AAAA,EAGA,YAAA,GAAgC;AAC9B,IAAA,OAAO,IAAA,CAAK,YAAA,EAAa,CAAE,SAAA,EAAU;AAAA,EACvC;AAAA;AAAA,EAGA,YAAA,GAAoC;AAClC,IAAA,OAAO,IAAA,CAAK,KAAA,CAAM,SAAA,EAAU,CAAE,SAAA,EAAU;AAAA,EAC1C;AACF;;;;"}