@digitalworld/digital-world-sdk 16.0.0

package/lib/esm/base/sorobandata_builder.d.ts

@@ -0,0 +1,103 @@
+import xdr from "./xdr.js";
+export type IntLike = bigint | number | string;
+/**
+ * Supports building {@link xdr.SorobanTransactionData} structures with various
+ * items set to specific values.
+ *
+ * This is recommended for when you are building
+ * {@link Operation.extendFootprintTtl} / {@link Operation.restoreFootprint}
+ * operations and need to {@link TransactionBuilder.setSorobanData} to avoid
+ * (re)building the entire data structure from scratch.
+ *
+ * @example
+ * ```ts
+ * // You want to use an existing data blob but override specific parts.
+ * const newData = new SorobanDataBuilder(existing)
+ *   .setReadOnly(someLedgerKeys)
+ *   .setResourceFee("1000")
+ *   .build();
+ *
+ * // You want an instance from scratch
+ * const newData = new SorobanDataBuilder()
+ *   .setFootprint([someLedgerKey], [])
+ *   .setResourceFee("1000")
+ *   .build();
+ * ```
+ */
+export declare class SorobanDataBuilder {
+    private _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?: Buffer | Uint8Array | xdr.SorobanTransactionData | string);
+    /**
+     * Decodes and builds a {@link xdr.SorobanTransactionData} instance.
+     *
+     * @param data - raw input to decode
+     */
+    static fromXDR(data: Buffer | Uint8Array | string): xdr.SorobanTransactionData;
+    /**
+     * Sets the resource fee portion of the Soroban data.
+     *
+     * @param fee - the resource fee to set (int64)
+     */
+    setResourceFee(fee: IntLike): SorobanDataBuilder;
+    /**
+     * 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: number, diskReadBytes: number, writeBytes: number): SorobanDataBuilder;
+    /**
+     * 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: xdr.LedgerKey[], readWrite: xdr.LedgerKey[]): SorobanDataBuilder;
+    /**
+     * 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?: xdr.LedgerKey[] | null, readWrite?: xdr.LedgerKey[] | null): SorobanDataBuilder;
+    /**
+     * Sets the read-only keys in the access footprint.
+     *
+     * @param readOnly - read-only keys in the access footprint
+     */
+    setReadOnly(readOnly?: xdr.LedgerKey[]): SorobanDataBuilder;
+    /**
+     * Sets the read-write keys in the access footprint.
+     *
+     * @param readWrite - read-write keys in the access footprint
+     */
+    setReadWrite(readWrite?: xdr.LedgerKey[]): SorobanDataBuilder;
+    /**
+     * Returns a copy of the final data structure.
+     */
+    build(): xdr.SorobanTransactionData;
+    /** Returns the read-only storage access pattern. */
+    getReadOnly(): xdr.LedgerKey[];
+    /** Returns the read-write storage access pattern. */
+    getReadWrite(): xdr.LedgerKey[];
+    /** Returns the storage access pattern. */
+    getFootprint(): xdr.LedgerFootprint;
+}

package/lib/esm/base/sorobandata_builder.js

@@ -0,0 +1,146 @@
+import { Buffer } from 'buffer';
+import types from './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 types.SorobanTransactionData({
+        resources: new types.SorobanResources({
+          footprint: new types.LedgerFootprint({ readOnly: [], readWrite: [] }),
+          instructions: 0,
+          diskReadBytes: 0,
+          writeBytes: 0
+        }),
+        ext: new types.SorobanTransactionDataExt(0),
+        resourceFee: new types.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 types.SorobanTransactionData.fromXDR(data, "base64");
+    } else {
+      return types.SorobanTransactionData.fromXDR(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 types.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 types.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();
+  }
+}
+
+export { SorobanDataBuilder };
+//# sourceMappingURL=sorobandata_builder.js.map

package/lib/esm/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"],"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,MAAI,sBAAA,CAAuB;AAAA,QACpC,SAAA,EAAW,IAAIA,KAAA,CAAI,gBAAA,CAAiB;AAAA,UAClC,SAAA,EAAW,IAAIA,KAAA,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,KAAA,CAAI,yBAAA,CAA0B,CAAC,CAAA;AAAA,QACxC,WAAA,EAAa,IAAIA,KAAA,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,KAAA,CAAI,sBAAA,CAAuB,OAAA,CAAQ,IAAA,EAAM,QAAQ,CAAA;AAAA,IAC1D,CAAA,MAAO;AACL,MAAA,OAAOA,MAAI,sBAAA,CAAuB,OAAA,CAAQ,OAAO,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,IAAIA,KAAA,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,MAAI,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;;;;"}

package/lib/esm/base/strkey.d.ts

@@ -0,0 +1,186 @@
+type VersionByteName = "claimableBalance" | "contract" | "ed25519PublicKey" | "ed25519SecretSeed" | "liquidityPool" | "med25519PublicKey" | "preAuthTx" | "sha256Hash" | "signedPayload";
+/**
+ * StrKey is a helper class that allows encoding and decoding Digital World keys
+ * to/from strings, i.e. between their binary (Buffer, xdr.PublicKey, etc.) and
+ * string (i.e. "GABCD...", etc.) representations.
+ */
+export declare class StrKey {
+    static types: Record<string, VersionByteName>;
+    /**
+     * Encodes `data` to strkey ed25519 public key.
+     *
+     * @param data - raw data to encode
+     */
+    static encodeEd25519PublicKey(data: Buffer): string;
+    /**
+     * Decodes strkey ed25519 public key to raw data.
+     *
+     * If the parameter is a muxed account key ("M..."), this will only encode it
+     * as a basic Ed25519 key (as if in "G..." format).
+     *
+     * @param data - "G..." (or "M...") key representation to decode
+     */
+    static decodeEd25519PublicKey(data: string): Buffer;
+    /**
+     * Returns true if the given Digital World public key is a valid ed25519 public key.
+     *
+     * @param publicKey - public key to check
+     */
+    static isValidEd25519PublicKey(publicKey: string): boolean;
+    /**
+     * Encodes data to strkey ed25519 seed.
+     *
+     * @param data - data to encode
+     */
+    static encodeEd25519SecretSeed(data: Buffer): string;
+    /**
+     * Decodes strkey ed25519 seed to raw data.
+     *
+     * @param address - data to decode
+     */
+    static decodeEd25519SecretSeed(address: string): Buffer;
+    /**
+     * Returns true if the given Digital World secret key is a valid ed25519 secret seed.
+     *
+     * @param seed - seed to check
+     */
+    static isValidEd25519SecretSeed(seed: string): boolean;
+    /**
+     * Encodes data to strkey med25519 public key.
+     *
+     * @param data - data to encode
+     */
+    static encodeMed25519PublicKey(data: Buffer): string;
+    /**
+     * Decodes strkey med25519 public key to raw data.
+     *
+     * @param address - data to decode
+     */
+    static decodeMed25519PublicKey(address: string): Buffer;
+    /**
+     * Returns true if the given Digital World public key is a valid med25519 public key.
+     *
+     * @param publicKey - public key to check
+     */
+    static isValidMed25519PublicKey(publicKey: string): boolean;
+    /**
+     * Encodes data to strkey preAuthTx.
+     *
+     * @param data - data to encode
+     */
+    static encodePreAuthTx(data: Buffer): string;
+    /**
+     * Decodes strkey PreAuthTx to raw data.
+     *
+     * @param address - data to decode
+     */
+    static decodePreAuthTx(address: string): Buffer;
+    /**
+     * Encodes data to strkey sha256 hash.
+     *
+     * @param data - data to encode
+     */
+    static encodeSha256Hash(data: Buffer): string;
+    /**
+     * Decodes strkey sha256 hash to raw data.
+     *
+     * @param address - data to decode
+     */
+    static decodeSha256Hash(address: string): Buffer;
+    /**
+     * Encodes raw data to strkey signed payload (P...).
+     *
+     * @param data - data to encode
+     */
+    static encodeSignedPayload(data: Buffer): string;
+    /**
+     * Decodes strkey signed payload (P...) to raw data.
+     *
+     * @param address - address to decode
+     */
+    static decodeSignedPayload(address: string): Buffer;
+    /**
+     * Checks validity of alleged signed payload (P...) strkey address.
+     *
+     * @param address - signer key to check
+     */
+    static isValidSignedPayload(address: string): boolean;
+    /**
+     * Encodes raw data to strkey contract (C...).
+     *
+     * @param data - data to encode
+     */
+    static encodeContract(data: Buffer): string;
+    /**
+     * Decodes strkey contract (C...) to raw data.
+     *
+     * @param address - address to decode
+     */
+    static decodeContract(address: string): Buffer;
+    /**
+     * Checks validity of alleged contract (C...) strkey address.
+     *
+     * @param address - signer key to check
+     */
+    static isValidContract(address: string): boolean;
+    /**
+     * Encodes raw data to strkey claimable balance (B...).
+     *
+     * @param data - data to encode
+     */
+    static encodeClaimableBalance(data: Buffer): string;
+    /**
+     * Decodes strkey claimable balance (B...) to raw data.
+     *
+     * @param address - balance to decode
+     */
+    static decodeClaimableBalance(address: string): Buffer;
+    /**
+     * Checks validity of alleged claimable balance (B...) strkey address.
+     *
+     * @param address - balance to check
+     */
+    static isValidClaimableBalance(address: string): boolean;
+    /**
+     * Encodes raw data to strkey liquidity pool (L...).
+     *
+     * @param data - data to encode
+     */
+    static encodeLiquidityPool(data: Buffer): string;
+    /**
+     * Decodes strkey liquidity pool (L...) to raw data.
+     *
+     * @param address - address to decode
+     */
+    static decodeLiquidityPool(address: string): Buffer;
+    /**
+     * Checks validity of alleged liquidity pool (L...) strkey address.
+     *
+     * @param address - pool to check
+     */
+    static isValidLiquidityPool(address: string): boolean;
+    /**
+     * Returns the strkey type based on the prefix of the given strkey address,
+     * or undefined if the prefix is invalid.
+     *
+     * @param address - the strkey address to check
+     */
+    static getVersionByteForPrefix(address: string): VersionByteName | undefined;
+}
+/**
+ * Decodes and validates a strkey-encoded string, verifying the version byte
+ * and checksum.
+ *
+ * @param versionByteName - the expected strkey type
+ * @param encoded - the strkey-encoded string to decode
+ */
+export declare function decodeCheck(versionByteName: string, encoded: string): Buffer;
+/**
+ * Encodes raw data into a strkey-encoded string with a version byte and
+ * CRC16 checksum.
+ *
+ * @param versionByteName - the strkey type to encode as
+ * @param data - the raw data to encode
+ */
+export declare function encodeCheck(versionByteName: string, data: Buffer): string;
+export {};