@digitalworld/digital-world-sdk 16.0.0

package/lib/esm/webauth/index.js

@@ -0,0 +1,4 @@
+export { gatherTxSigners, verifyTxSignedBy } from './utils.js';
+export { InvalidChallengeError } from './errors.js';
+export { buildChallengeTx, readChallengeTx, verifyChallengeTxSigners, verifyChallengeTxThreshold } from './challenge_transaction.js';
+//# sourceMappingURL=index.js.map

package/lib/esm/webauth/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;"}

package/lib/esm/webauth/utils.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Digital World Web Authentication
+ * @see {@link https://docs.digitalworld.global/protocol/sep-10 | SEP-10 Specification}
+ */
+import { FeeBumpTransaction, Transaction } from "../base/index.js";
+/**
+ * Checks if a transaction has been signed by one or more of the given signers,
+ * returning a list of non-repeated signers that were found to have signed the
+ * given transaction.
+ *
+ * @param transaction - The signed transaction.
+ * @param signers - The signer's public keys.
+ * @returns A list of signers that were found to have signed
+ *    the transaction.
+ *
+ * @example
+ * ```ts
+ * let keypair1 = Keypair.random();
+ * let keypair2 = Keypair.random();
+ * const account = new StellarSdk.Account(keypair1.publicKey(), "-1");
+ *
+ * const transaction = new TransactionBuilder(account, { fee: 100 })
+ *    .setTimeout(30)
+ *    .build();
+ *
+ * transaction.sign(keypair1, keypair2)
+ * WebAuth.gatherTxSigners(transaction, [keypair1.publicKey(), keypair2.publicKey()])
+ * ```
+ */
+export declare function gatherTxSigners(transaction: FeeBumpTransaction | Transaction, signers: string[]): string[];
+/**
+ * Verifies if a transaction was signed by the given account id.
+ *
+ * @param transaction - The signed transaction.
+ * @param accountID - The signer's public key.
+ * @returns Whether or not `accountID` was found to have signed the
+ *    transaction.
+ *
+ * @example
+ * ```ts
+ * let keypair = Keypair.random();
+ * const account = new StellarSdk.Account(keypair.publicKey(), "-1");
+ *
+ * const transaction = new TransactionBuilder(account, { fee: 100 })
+ *    .setTimeout(30)
+ *    .build();
+ *
+ * transaction.sign(keypair)
+ * WebAuth.verifyTxSignedBy(transaction, keypair.publicKey())
+ * ```
+ */
+export declare function verifyTxSignedBy(transaction: FeeBumpTransaction | Transaction, accountID: string): boolean;
+/**
+ * A parsed and validated challenge transaction, and some of its constituent details.
+ */
+export type ChallengeTxDetails = {
+    /** The challenge transaction. */
+    tx: Transaction;
+    /** The Digital World public key (master key) used to sign the Manage Data operation. */
+    clientAccountId: string;
+    /** The matched home domain. */
+    matchedHomeDomain: string;
+    /** The memo attached to the transaction, which will be null if not present */
+    memo?: string;
+};

package/lib/esm/webauth/utils.js

@@ -0,0 +1,58 @@
+import '../node_modules/.pnpm/@stellar_js-xdr@4.0.0/node_modules/@stellar/js-xdr/src/int.js';
+import '../node_modules/.pnpm/@stellar_js-xdr@4.0.0/node_modules/@stellar/js-xdr/src/hyper.js';
+import '../node_modules/.pnpm/@stellar_js-xdr@4.0.0/node_modules/@stellar/js-xdr/src/unsigned-int.js';
+import '../node_modules/.pnpm/@stellar_js-xdr@4.0.0/node_modules/@stellar/js-xdr/src/unsigned-hyper.js';
+import '../node_modules/.pnpm/@stellar_js-xdr@4.0.0/node_modules/@stellar/js-xdr/src/xdr-type.js';
+import 'buffer';
+import '../base/generated/curr_generated.js';
+import '@noble/hashes/sha2.js';
+import '../base/signing.js';
+import { Keypair } from '../base/keypair.js';
+import 'base32.js';
+import '../base/util/continued_fraction.js';
+import '../base/util/bignumber.js';
+import '../base/transaction_builder.js';
+import '../base/muxed_account.js';
+import '../base/scval.js';
+import '../base/numbers/uint128.js';
+import '../base/numbers/uint256.js';
+import '../base/numbers/int128.js';
+import '../base/numbers/int256.js';
+import { InvalidChallengeError } from './errors.js';
+
+function gatherTxSigners(transaction, signers) {
+  const hashedSignatureBase = transaction.hash();
+  const txSignatures = [...transaction.signatures];
+  const signersFound = /* @__PURE__ */ new Set();
+  for (const signer of signers) {
+    if (txSignatures.length === 0) {
+      break;
+    }
+    let keypair;
+    try {
+      keypair = Keypair.fromPublicKey(signer);
+    } catch (err) {
+      throw new InvalidChallengeError(
+        `Signer is not a valid address: ${err.message}`
+      );
+    }
+    for (let i = 0; i < txSignatures.length; i++) {
+      const decSig = txSignatures[i];
+      if (!decSig.hint().equals(keypair.signatureHint())) {
+        continue;
+      }
+      if (keypair.verify(hashedSignatureBase, decSig.signature())) {
+        signersFound.add(signer);
+        txSignatures.splice(i, 1);
+        break;
+      }
+    }
+  }
+  return Array.from(signersFound);
+}
+function verifyTxSignedBy(transaction, accountID) {
+  return gatherTxSigners(transaction, [accountID]).length !== 0;
+}
+
+export { gatherTxSigners, verifyTxSignedBy };
+//# sourceMappingURL=utils.js.map

package/lib/esm/webauth/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sources":["../../../src/webauth/utils.ts"],"sourcesContent":["/**\n * Digital World Web Authentication\n * @see {@link https://docs.digitalworld.global/protocol/sep-10 | SEP-10 Specification}\n */\n\nimport { FeeBumpTransaction, Keypair, Transaction } from \"../base/index.js\";\nimport { InvalidChallengeError } from \"./errors.js\";\n/**\n * Checks if a transaction has been signed by one or more of the given signers,\n * returning a list of non-repeated signers that were found to have signed the\n * given transaction.\n *\n * @param transaction - The signed transaction.\n * @param signers - The signer's public keys.\n * @returns A list of signers that were found to have signed\n *    the transaction.\n *\n * @example\n * ```ts\n * let keypair1 = Keypair.random();\n * let keypair2 = Keypair.random();\n * const account = new StellarSdk.Account(keypair1.publicKey(), \"-1\");\n *\n * const transaction = new TransactionBuilder(account, { fee: 100 })\n *    .setTimeout(30)\n *    .build();\n *\n * transaction.sign(keypair1, keypair2)\n * WebAuth.gatherTxSigners(transaction, [keypair1.publicKey(), keypair2.publicKey()])\n * ```\n */\nexport function gatherTxSigners(\n  transaction: FeeBumpTransaction | Transaction,\n  signers: string[],\n): string[] {\n  const hashedSignatureBase = transaction.hash();\n\n  const txSignatures = [...transaction.signatures]; // shallow copy for safe splicing\n  const signersFound = new Set<string>();\n\n  for (const signer of signers) {\n    if (txSignatures.length === 0) {\n      break;\n    }\n\n    let keypair: Keypair;\n    try {\n      keypair = Keypair.fromPublicKey(signer); // This can throw a few different errors\n    } catch (err: any) {\n      throw new InvalidChallengeError(\n        `Signer is not a valid address: ${err.message}`,\n      );\n    }\n\n    for (let i = 0; i < txSignatures.length; i++) {\n      const decSig = txSignatures[i];\n\n      if (!decSig.hint().equals(keypair.signatureHint())) {\n        continue;\n      }\n\n      if (keypair.verify(hashedSignatureBase, decSig.signature())) {\n        signersFound.add(signer);\n        txSignatures.splice(i, 1);\n        break;\n      }\n    }\n  }\n\n  return Array.from(signersFound);\n}\n\n/**\n * Verifies if a transaction was signed by the given account id.\n *\n * @param transaction - The signed transaction.\n * @param accountID - The signer's public key.\n * @returns Whether or not `accountID` was found to have signed the\n *    transaction.\n *\n * @example\n * ```ts\n * let keypair = Keypair.random();\n * const account = new StellarSdk.Account(keypair.publicKey(), \"-1\");\n *\n * const transaction = new TransactionBuilder(account, { fee: 100 })\n *    .setTimeout(30)\n *    .build();\n *\n * transaction.sign(keypair)\n * WebAuth.verifyTxSignedBy(transaction, keypair.publicKey())\n * ```\n */\nexport function verifyTxSignedBy(\n  transaction: FeeBumpTransaction | Transaction,\n  accountID: string,\n): boolean {\n  return gatherTxSigners(transaction, [accountID]).length !== 0;\n}\n\n/**\n * A parsed and validated challenge transaction, and some of its constituent details.\n */\nexport type ChallengeTxDetails = {\n  /** The challenge transaction. */\n  tx: Transaction;\n  /** The Digital World public key (master key) used to sign the Manage Data operation. */\n  clientAccountId: string;\n  /** The matched home domain. */\n  matchedHomeDomain: string;\n  /** The memo attached to the transaction, which will be null if not present */\n  memo?: string;\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AA+BO,SAAS,eAAA,CACd,aACA,OAAA,EACU;AACV,EAAA,MAAM,mBAAA,GAAsB,YAAY,IAAA,EAAK;AAE7C,EAAA,MAAM,YAAA,GAAe,CAAC,GAAG,WAAA,CAAY,UAAU,CAAA;AAC/C,EAAA,MAAM,YAAA,uBAAmB,GAAA,EAAY;AAErC,EAAA,KAAA,MAAW,UAAU,OAAA,EAAS;AAC5B,IAAA,IAAI,YAAA,CAAa,WAAW,CAAA,EAAG;AAC7B,MAAA;AAAA,IACF;AAEA,IAAA,IAAI,OAAA;AACJ,IAAA,IAAI;AACF,MAAA,OAAA,GAAU,OAAA,CAAQ,cAAc,MAAM,CAAA;AAAA,IACxC,SAAS,GAAA,EAAU;AACjB,MAAA,MAAM,IAAI,qBAAA;AAAA,QACR,CAAA,+BAAA,EAAkC,IAAI,OAAO,CAAA;AAAA,OAC/C;AAAA,IACF;AAEA,IAAA,KAAA,IAAS,CAAA,GAAI,CAAA,EAAG,CAAA,GAAI,YAAA,CAAa,QAAQ,CAAA,EAAA,EAAK;AAC5C,MAAA,MAAM,MAAA,GAAS,aAAa,CAAC,CAAA;AAE7B,MAAA,IAAI,CAAC,OAAO,IAAA,EAAK,CAAE,OAAO,OAAA,CAAQ,aAAA,EAAe,CAAA,EAAG;AAClD,QAAA;AAAA,MACF;AAEA,MAAA,IAAI,QAAQ,MAAA,CAAO,mBAAA,EAAqB,MAAA,CAAO,SAAA,EAAW,CAAA,EAAG;AAC3D,QAAA,YAAA,CAAa,IAAI,MAAM,CAAA;AACvB,QAAA,YAAA,CAAa,MAAA,CAAO,GAAG,CAAC,CAAA;AACxB,QAAA;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,EAAA,OAAO,KAAA,CAAM,KAAK,YAAY,CAAA;AAChC;AAuBO,SAAS,gBAAA,CACd,aACA,SAAA,EACS;AACT,EAAA,OAAO,gBAAgB,WAAA,EAAa,CAAC,SAAS,CAAC,EAAE,MAAA,KAAW,CAAA;AAC9D;;;;"}

package/package.json

@@ -0,0 +1,196 @@
+{
+  "name": "@digitalworld/digital-world-sdk",
+  "version": "16.0.0",
+  "type": "module",
+  "description": "A library for working with the Digital World Network, including communication with the Gateway and Soroban RPC servers.",
+  "keywords": [
+    "digital-world",
+    "digitalworld"
+  ],
+  "homepage": "https://github.com/digitalworld/digital-world-js-sdk",
+  "bugs": {
+    "url": "https://github.com/digitalworld/digital-world-js-sdk/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/digitalworld/digital-world-js-sdk.git"
+  },
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "Digital World Foundation",
+  "sideEffects": [
+    "./lib/esm/base/scval.js",
+    "./lib/cjs/base/scval.js"
+  ],
+  "main": "./lib/cjs/index.js",
+  "module": "./lib/esm/index.js",
+  "types": "./lib/esm/index.d.ts",
+  "files": [
+    "/types",
+    "/lib",
+    "/dist",
+    "/bin"
+  ],
+  "bin": {
+    "digital-world-js": "./bin/digital-world-js"
+  },
+  "exports": {
+    ".": {
+      "types": "./lib/esm/index.d.ts",
+      "import": "./lib/esm/index.js",
+      "require": "./lib/cjs/index.js",
+      "default": "./lib/esm/index.js"
+    },
+    "./contract": {
+      "types": "./lib/esm/contract/index.d.ts",
+      "import": "./lib/esm/contract/index.js",
+      "require": "./lib/cjs/contract/index.js",
+      "default": "./lib/esm/contract/index.js"
+    },
+    "./rpc": {
+      "types": "./lib/esm/rpc/index.d.ts",
+      "import": "./lib/esm/rpc/index.js",
+      "require": "./lib/cjs/rpc/index.js",
+      "default": "./lib/esm/rpc/index.js"
+    },
+    "./axios": {
+      "types": "./lib/axios/esm/index.d.ts",
+      "import": "./lib/axios/esm/index.js",
+      "require": "./lib/axios/cjs/index.js",
+      "default": "./lib/axios/esm/index.js"
+    },
+    "./axios/contract": {
+      "types": "./lib/axios/esm/contract/index.d.ts",
+      "import": "./lib/axios/esm/contract/index.js",
+      "require": "./lib/axios/cjs/contract/index.js",
+      "default": "./lib/axios/esm/contract/index.js"
+    },
+    "./axios/rpc": {
+      "types": "./lib/axios/esm/rpc/index.d.ts",
+      "import": "./lib/axios/esm/rpc/index.js",
+      "require": "./lib/axios/cjs/rpc/index.js",
+      "default": "./lib/axios/esm/rpc/index.js"
+    },
+    "./http-client/axios": {
+      "types": "./lib/esm/http-client/axios.d.ts",
+      "import": "./lib/esm/http-client/axios.js",
+      "require": "./lib/cjs/http-client/axios.js",
+      "default": "./lib/esm/http-client/axios.js"
+    }
+  },
+  "lint-staged": {
+    "**/*.{js,json,ts}": [
+      "pnpm run fmt"
+    ]
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "devDependencies": {
+    "@astrojs/sitemap": "^3.7.3",
+    "@astrojs/starlight": "^0.39.2",
+    "@eslint/compat": "^1.4.1",
+    "@eslint/js": "^9.39.4",
+    "@rollup/plugin-commonjs": "^29.0.2",
+    "@rollup/plugin-inject": "^5.0.5",
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "@rollup/plugin-replace": "^6.0.2",
+    "@rollup/plugin-terser": "^1.0.0",
+    "@types/detect-node": "^2.0.2",
+    "@types/json-schema": "^7.0.15",
+    "@types/node": "^22.19.17",
+    "@types/sha.js": "^2.4.4",
+    "@vitest/browser": "^4.1.7",
+    "@vitest/browser-playwright": "^4.1.7",
+    "@vitest/coverage-istanbul": "4.1.7",
+    "@vitest/coverage-v8": "^4.1.7",
+    "@vitest/ui": "^4.1.7",
+    "astro": "^6.4.2",
+    "browserify-zlib": "^0.2.0",
+    "cross-env": "^10.1.0",
+    "dotenv": "^17.4.2",
+    "esbuild": "^0.27.7",
+    "eslint": "^9.39.1",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-import-resolver-typescript": "^4.4.4",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-prettier": "^5.5.6",
+    "eslint-plugin-tsdoc": "^0.5.2",
+    "github-slugger": "2.0.0",
+    "globals": "^17.5.0",
+    "husky": "^9.1.7",
+    "jsdom": "^29.1.1",
+    "lint-staged": "^15.5.1",
+    "lodash": "^4.18.1",
+    "msw": "^2.14.6",
+    "playwright": "^1.60.0",
+    "prettier": "^3.8.3",
+    "rollup": "^4.60.4",
+    "rollup-plugin-esbuild": "^6.2.1",
+    "rollup-plugin-polyfill-node": "^0.13.0",
+    "tsx": "^4.22.3",
+    "typedoc": "^0.28.19",
+    "typescript": "5.9.3",
+    "typescript-eslint": "^8.60.0",
+    "vitest": "^4.1.7"
+  },
+  "dependencies": {
+    "@noble/ed25519": "^3.1.0",
+    "@noble/hashes": "^2.2.0",
+    "@stellar/js-xdr": "4.0.0",
+    "axios": "1.16.1",
+    "base32.js": "^0.1.0",
+    "bignumber.js": "^11.1.1",
+    "buffer": "^6.0.3",
+    "commander": "^14.0.3",
+    "eventsource": "^4.1.0",
+    "feaxios": "^0.0.23",
+    "smol-toml": "^1.6.1",
+    "uint8array-extras": "^1.5.0"
+  },
+  "overrides": {
+    "chalk": "5.3.0",
+    "strip-ansi": "7.1.0",
+    "color-convert": "2.0.1",
+    "color-name": "1.1.4"
+  },
+  "scripts": {
+    "setup": "git config blame.ignoreRevsFile .git-blame-ignore-revs",
+    "build": "cross-env NODE_ENV=development pnpm run _build",
+    "build:prod": "cross-env NODE_ENV=production pnpm run _build",
+    "build:lib": "rollup -c",
+    "build:lib:axios": "cross-env USE_AXIOS=true rollup -c",
+    "build:lib:all": "pnpm run build:lib && pnpm run build:lib:axios",
+    "build:types": "tsc -p tsconfig.json && mkdir -p lib/esm/base/generated && cp src/base/generated/*.d.ts lib/esm/base/generated/",
+    "build:types:axios": "tsc -p config/tsconfig.axios.json && mkdir -p lib/axios/esm/base/generated && cp src/base/generated/*.d.ts lib/axios/esm/base/generated/",
+    "build:types:all": "pnpm run build:types && pnpm run build:types:axios",
+    "postbuild:lib": "node config/write-module-type.js lib/cjs commonjs",
+    "postbuild:lib:axios": "node config/write-module-type.js lib/axios/cjs commonjs",
+    "clean": "rm -rf lib/ dist/ coverage/ jsdoc/ test/e2e/.soroban",
+    "clean:bundle-size": "rm -rf node_modules lib/ dist/ coverage/ jsdoc/ test/e2e/.soroban",
+    "docs": "pnpm docs:reference && pnpm docs:llms && pnpm docs:robots && pnpm docs:htaccess && pnpm docs:site",
+    "docs:reference": "tsx scripts/build-docs.ts",
+    "docs:llms": "tsx scripts/build-llms.ts",
+    "docs:robots": "tsx scripts/build-robots.ts",
+    "docs:htaccess": "tsx scripts/build-htaccess.ts",
+    "docs:site": "astro build && tsx scripts/build-md-siblings.ts",
+    "docs:dev": "astro dev",
+    "docs:preview": "astro preview",
+    "test": "pnpm run test:node && pnpm run test:node:axios && pnpm run test:integration && pnpm run test:browser",
+    "test:all": "pnpm run test:node && pnpm run test:node:axios && pnpm run test:integration && pnpm run test:browser && pnpm run test:e2e",
+    "test:e2e": "./test/e2e/initialize.sh && vitest run --config config/vitest.config.e2e.ts --coverage",
+    "test:node": "vitest run test/unit --config config/vitest.config.ts --coverage",
+    "test:node:axios": "cross-env TRANSPORT=axios vitest run test/unit --config config/vitest.config.ts",
+    "test:e2e:noeval": "NODE_OPTIONS=--disallow-code-generation-from-strings pnpm run test:e2e",
+    "test:integration": "vitest run test/integration --config config/vitest.config.ts --coverage",
+    "test:browser": "pnpm run build:lib && vitest run --config config/vitest.config.browser.ts test/unit --coverage",
+    "test:browser:axios": "pnpm run build:lib:axios && cross-env TRANSPORT=axios vitest run --config config/vitest.config.browser.ts test/unit",
+    "fmt": "pnpm run _prettier && eslint src/ --fix",
+    "preversion": "pnpm run clean && pnpm run _prettier && pnpm run build:prod && pnpm run test",
+    "download-sac-spec": "node scripts/download-sac-spec.js",
+    "_build": "pnpm run clean && pnpm run build:lib:all && pnpm run build:types:all",
+    "_prettier": "prettier --ignore-path config/.prettierignore --write './src/**/*.ts' './test/**/*.{js,ts}'"
+  }
+}

package/types/base32.js/index.d.ts

@@ -0,0 +1,9 @@
+declare module "base32.js" {
+  interface Base32Codec {
+    decode(encoded: string): Buffer;
+    encode(decoded: Uint8Array): string;
+  }
+
+  const base32: Base32Codec;
+  export default base32;
+}

package/types/stellar__js-xdr/index.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Type declarations for @stellar/js-xdr
+ * This file provides type definitions for the @stellar/js-xdr library
+ * during the JS to TS migration process.
+ */
+
+declare module "@stellar/js-xdr" {
+  export abstract class LargeInt {
+    constructor(
+      values: Array<bigint | number | string> | bigint | number | string,
+    );
+    static defineIntBoundaries(): void;
+    static MIN_VALUE: LargeInt;
+    static MAX_VALUE: LargeInt;
+    static isValid(value: unknown): boolean;
+    static fromString(value: string): LargeInt;
+    abstract get unsigned(): boolean;
+    abstract get size(): number;
+    toBigInt(): bigint;
+    toString(): string;
+    slice(chunkSize: number): bigint[];
+  }
+
+  export class Hyper extends LargeInt {
+    get unsigned(): boolean;
+    get size(): number;
+    constructor(
+      values: Array<bigint | number | string> | bigint | number | string,
+    );
+    static defineIntBoundaries(): void;
+    static MIN_VALUE: Hyper;
+    static MAX_VALUE: Hyper;
+    static isValid(value: unknown): boolean;
+    static fromString(value: string): Hyper;
+  }
+
+  export class UnsignedHyper extends LargeInt {
+    get unsigned(): boolean;
+    get size(): number;
+    constructor(
+      values: Array<bigint | number | string> | bigint | number | string,
+    );
+    static defineIntBoundaries(): void;
+    static MIN_VALUE: UnsignedHyper;
+    static MAX_VALUE: UnsignedHyper;
+    static isValid(value: unknown): boolean;
+    static fromString(value: string): UnsignedHyper;
+  }
+
+  export class XdrWriter {
+    constructor(buffer?: Buffer | number);
+    alloc(size: number): number;
+    resize(minRequiredSize: number): void;
+    finalize(): Buffer;
+    write(value: string | Buffer, size?: number): void;
+    result(): Buffer;
+  }
+
+  export class XdrReader {
+    constructor(buffer: Buffer);
+    get eof(): boolean;
+    advance(size: number): void;
+    rewind(): void;
+    read(size: number): Buffer;
+  }
+}