@sovereign-sdk/modules 0.0.2

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/index.d.mts

@@ -0,0 +1,73 @@
+import { Rollup } from '@sovereign-sdk/web3';
+
+/**
+ * Bank class for interacting with the Sovereign SDK Bank module.
+ */
+declare class Bank {
+    private readonly rollup;
+    private _gasTokenId?;
+    /**
+     * Creates a new Bank instance.
+     *
+     * @param rollup - The rollup instance to use for HTTP requests
+     */
+    constructor(rollup: Rollup<any, any>);
+    /**
+     * Gets the balance of a specific token for a given address.
+     *
+     * If no token ID is provided, the gas token balance will be returned.
+     *
+     * @param address - The address to query the balance for
+     * @param tokenId - Optional token ID. If not provided, uses the gas token
+     * @returns Promise resolving to the token balance as a bigint
+     * @throws {SovereignClient.APIError} When the request fails for reasons other than missing account
+     * @example
+     * ```typescript
+     * const bank = new Bank(rollup);
+     * const balance = await bank.balance("0x123...");
+     * console.log(`Balance: ${balance}`);
+     *
+     * // Query specific token balance
+     * const tokenBalance = await bank.balance("0x123...", "token_123");
+     * ```
+     */
+    balance(address: string, tokenId?: string): Promise<bigint>;
+    /**
+     * Gets the total supply of a specific token.
+     *
+     * If no token ID is provided, returns the total supply of the gas token.
+     *
+     * @param tokenId - Optional token ID. If not provided, uses the gas token
+     * @returns Promise resolving to the total supply as a bigint
+     * @throws {SovereignClient.APIError} When the request fails
+     * @example
+     * ```typescript
+     * const bank = new Bank(rollup);
+     * const totalSupply = await bank.totalSupply();
+     * console.log(`Total gas token supply: ${totalSupply}`);
+     *
+     * // Query specific token supply
+     * const tokenSupply = await bank.totalSupply("token_123");
+     * ```
+     */
+    totalSupply(tokenId?: string): Promise<bigint>;
+    /**
+     * Gets the gas token identifier.
+     *
+     * The gas token ID is cached after the first request to avoid repeated API calls.
+     *
+     * @returns Promise resolving to the gas token ID as a string
+     * @throws {Error} When the gas token ID cannot be retrieved
+     * @example
+     * ```typescript
+     * const bank = new Bank(rollup);
+     * const gasTokenId = await bank.gasTokenId();
+     * console.log(`Gas token ID: ${gasTokenId}`);
+     * ```
+     */
+    gasTokenId(): Promise<string>;
+    private tokenIdOrElseGasTokenId;
+    private isMissingAccountError;
+}
+
+export { Bank };

package/dist/index.d.ts

@@ -0,0 +1,73 @@
+import { Rollup } from '@sovereign-sdk/web3';
+
+/**
+ * Bank class for interacting with the Sovereign SDK Bank module.
+ */
+declare class Bank {
+    private readonly rollup;
+    private _gasTokenId?;
+    /**
+     * Creates a new Bank instance.
+     *
+     * @param rollup - The rollup instance to use for HTTP requests
+     */
+    constructor(rollup: Rollup<any, any>);
+    /**
+     * Gets the balance of a specific token for a given address.
+     *
+     * If no token ID is provided, the gas token balance will be returned.
+     *
+     * @param address - The address to query the balance for
+     * @param tokenId - Optional token ID. If not provided, uses the gas token
+     * @returns Promise resolving to the token balance as a bigint
+     * @throws {SovereignClient.APIError} When the request fails for reasons other than missing account
+     * @example
+     * ```typescript
+     * const bank = new Bank(rollup);
+     * const balance = await bank.balance("0x123...");
+     * console.log(`Balance: ${balance}`);
+     *
+     * // Query specific token balance
+     * const tokenBalance = await bank.balance("0x123...", "token_123");
+     * ```
+     */
+    balance(address: string, tokenId?: string): Promise<bigint>;
+    /**
+     * Gets the total supply of a specific token.
+     *
+     * If no token ID is provided, returns the total supply of the gas token.
+     *
+     * @param tokenId - Optional token ID. If not provided, uses the gas token
+     * @returns Promise resolving to the total supply as a bigint
+     * @throws {SovereignClient.APIError} When the request fails
+     * @example
+     * ```typescript
+     * const bank = new Bank(rollup);
+     * const totalSupply = await bank.totalSupply();
+     * console.log(`Total gas token supply: ${totalSupply}`);
+     *
+     * // Query specific token supply
+     * const tokenSupply = await bank.totalSupply("token_123");
+     * ```
+     */
+    totalSupply(tokenId?: string): Promise<bigint>;
+    /**
+     * Gets the gas token identifier.
+     *
+     * The gas token ID is cached after the first request to avoid repeated API calls.
+     *
+     * @returns Promise resolving to the gas token ID as a string
+     * @throws {Error} When the gas token ID cannot be retrieved
+     * @example
+     * ```typescript
+     * const bank = new Bank(rollup);
+     * const gasTokenId = await bank.gasTokenId();
+     * console.log(`Gas token ID: ${gasTokenId}`);
+     * ```
+     */
+    gasTokenId(): Promise<string>;
+    private tokenIdOrElseGasTokenId;
+    private isMissingAccountError;
+}
+
+export { Bank };

package/dist/index.js

@@ -0,0 +1,173 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  Bank: () => Bank
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/bank.ts
+var import_web3 = require("@sovereign-sdk/web3");
+
+// src/types.ts
+function isSuccessResponse(response) {
+  if (response.data === void 0)
+    throw new Error("data field missing from response");
+}
+
+// src/bank.ts
+var Bank = class {
+  /**
+   * Creates a new Bank instance.
+   *
+   * @param rollup - The rollup instance to use for HTTP requests
+   */
+  // biome-ignore lint/suspicious/noExplicitAny: types arent used
+  constructor(rollup) {
+    this.rollup = rollup;
+  }
+  /**
+   * Gets the balance of a specific token for a given address.
+   *
+   * If no token ID is provided, the gas token balance will be returned.
+   *
+   * @param address - The address to query the balance for
+   * @param tokenId - Optional token ID. If not provided, uses the gas token
+   * @returns Promise resolving to the token balance as a bigint
+   * @throws {SovereignClient.APIError} When the request fails for reasons other than missing account
+   * @example
+   * ```typescript
+   * const bank = new Bank(rollup);
+   * const balance = await bank.balance("0x123...");
+   * console.log(`Balance: ${balance}`);
+   *
+   * // Query specific token balance
+   * const tokenBalance = await bank.balance("0x123...", "token_123");
+   * ```
+   */
+  balance(address, tokenId) {
+    return __async(this, null, function* () {
+      const token = yield this.tokenIdOrElseGasTokenId(tokenId);
+      try {
+        const response = yield this.rollup.http.get(
+          `/modules/bank/tokens/${token}/balances/${address}`
+        );
+        isSuccessResponse(response);
+        return BigInt(response.data.amount);
+      } catch (e) {
+        const err = e;
+        if (this.isMissingAccountError(err)) return BigInt(0);
+        throw e;
+      }
+    });
+  }
+  /**
+   * Gets the total supply of a specific token.
+   *
+   * If no token ID is provided, returns the total supply of the gas token.
+   *
+   * @param tokenId - Optional token ID. If not provided, uses the gas token
+   * @returns Promise resolving to the total supply as a bigint
+   * @throws {SovereignClient.APIError} When the request fails
+   * @example
+   * ```typescript
+   * const bank = new Bank(rollup);
+   * const totalSupply = await bank.totalSupply();
+   * console.log(`Total gas token supply: ${totalSupply}`);
+   *
+   * // Query specific token supply
+   * const tokenSupply = await bank.totalSupply("token_123");
+   * ```
+   */
+  totalSupply(tokenId) {
+    return __async(this, null, function* () {
+      const token = yield this.tokenIdOrElseGasTokenId(tokenId);
+      const response = yield this.rollup.http.get(
+        `/modules/bank/tokens/${token}/total-supply`
+      );
+      isSuccessResponse(response);
+      return BigInt(response.data.amount);
+    });
+  }
+  /**
+   * Gets the gas token identifier.
+   *
+   * The gas token ID is cached after the first request to avoid repeated API calls.
+   *
+   * @returns Promise resolving to the gas token ID as a string
+   * @throws {Error} When the gas token ID cannot be retrieved
+   * @example
+   * ```typescript
+   * const bank = new Bank(rollup);
+   * const gasTokenId = await bank.gasTokenId();
+   * console.log(`Gas token ID: ${gasTokenId}`);
+   * ```
+   */
+  gasTokenId() {
+    return __async(this, null, function* () {
+      if (this._gasTokenId) return this._gasTokenId;
+      const response = yield this.rollup.http.get(
+        "/modules/bank/tokens/gas_token"
+      );
+      isSuccessResponse(response);
+      this._gasTokenId = response.data.token_id;
+      return this._gasTokenId;
+    });
+  }
+  tokenIdOrElseGasTokenId(tokenId) {
+    return __async(this, null, function* () {
+      return tokenId != null ? tokenId : this.gasTokenId();
+    });
+  }
+  isMissingAccountError(anyError) {
+    if (!(anyError instanceof import_web3.SovereignClient.APIError)) return false;
+    if (anyError.status !== 404) return false;
+    const body = anyError.error;
+    const error = body.errors[0];
+    if (!error) return false;
+    return error.title.startsWith("Balance") && error.title.endsWith("not found");
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Bank
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/bank.ts","../src/types.ts"],"sourcesContent":["export * from \"./bank\";\n","import { type Rollup, SovereignClient } from \"@sovereign-sdk/web3\";\nimport { type ErrorResponse, type Response, isSuccessResponse } from \"./types\";\n\ntype GasTokenIdPayload = {\n  token_id: string;\n};\n\ntype BalancePayload = {\n  amount: string;\n  token_id: string;\n};\n\ntype TotalSupplyPayload = {\n  amount: string;\n  token_id: string;\n};\n\n/**\n * Bank class for interacting with the Sovereign SDK Bank module.\n */\nexport class Bank {\n  // biome-ignore lint/suspicious/noExplicitAny: types arent used\n  private readonly rollup: Rollup<any, any>;\n  private _gasTokenId?: string;\n\n  /**\n   * Creates a new Bank instance.\n   *\n   * @param rollup - The rollup instance to use for HTTP requests\n   */\n  // biome-ignore lint/suspicious/noExplicitAny: types arent used\n  constructor(rollup: Rollup<any, any>) {\n    this.rollup = rollup;\n  }\n\n  /**\n   * Gets the balance of a specific token for a given address.\n   *\n   * If no token ID is provided, the gas token balance will be returned.\n   *\n   * @param address - The address to query the balance for\n   * @param tokenId - Optional token ID. If not provided, uses the gas token\n   * @returns Promise resolving to the token balance as a bigint\n   * @throws {SovereignClient.APIError} When the request fails for reasons other than missing account\n   * @example\n   * ```typescript\n   * const bank = new Bank(rollup);\n   * const balance = await bank.balance(\"0x123...\");\n   * console.log(`Balance: ${balance}`);\n   *\n   * // Query specific token balance\n   * const tokenBalance = await bank.balance(\"0x123...\", \"token_123\");\n   * ```\n   */\n  async balance(address: string, tokenId?: string): Promise<bigint> {\n    const token = await this.tokenIdOrElseGasTokenId(tokenId);\n\n    try {\n      const response: Response<BalancePayload> = await this.rollup.http.get(\n        `/modules/bank/tokens/${token}/balances/${address}`,\n      );\n\n      isSuccessResponse(response);\n      return BigInt(response.data.amount);\n    } catch (e) {\n      const err = e as SovereignClient.APIError;\n\n      if (this.isMissingAccountError(err)) return BigInt(0);\n\n      throw e;\n    }\n  }\n\n  /**\n   * Gets the total supply of a specific token.\n   *\n   * If no token ID is provided, returns the total supply of the gas token.\n   *\n   * @param tokenId - Optional token ID. If not provided, uses the gas token\n   * @returns Promise resolving to the total supply as a bigint\n   * @throws {SovereignClient.APIError} When the request fails\n   * @example\n   * ```typescript\n   * const bank = new Bank(rollup);\n   * const totalSupply = await bank.totalSupply();\n   * console.log(`Total gas token supply: ${totalSupply}`);\n   *\n   * // Query specific token supply\n   * const tokenSupply = await bank.totalSupply(\"token_123\");\n   * ```\n   */\n  async totalSupply(tokenId?: string): Promise<bigint> {\n    const token = await this.tokenIdOrElseGasTokenId(tokenId);\n    const response: Response<TotalSupplyPayload> = await this.rollup.http.get(\n      `/modules/bank/tokens/${token}/total-supply`,\n    );\n    isSuccessResponse(response);\n    return BigInt(response.data.amount);\n  }\n\n  /**\n   * Gets the gas token identifier.\n   *\n   * The gas token ID is cached after the first request to avoid repeated API calls.\n   *\n   * @returns Promise resolving to the gas token ID as a string\n   * @throws {Error} When the gas token ID cannot be retrieved\n   * @example\n   * ```typescript\n   * const bank = new Bank(rollup);\n   * const gasTokenId = await bank.gasTokenId();\n   * console.log(`Gas token ID: ${gasTokenId}`);\n   * ```\n   */\n  async gasTokenId(): Promise<string> {\n    if (this._gasTokenId) return this._gasTokenId;\n    const response: Response<GasTokenIdPayload> = await this.rollup.http.get(\n      \"/modules/bank/tokens/gas_token\",\n    );\n    isSuccessResponse(response);\n    this._gasTokenId = response.data.token_id;\n    return this._gasTokenId;\n  }\n\n  private async tokenIdOrElseGasTokenId(tokenId?: string): Promise<string> {\n    return tokenId ?? this.gasTokenId();\n  }\n\n  private isMissingAccountError(anyError: unknown): boolean {\n    if (!(anyError instanceof SovereignClient.APIError)) return false;\n    if (anyError.status !== 404) return false;\n    const body = anyError.error as ErrorResponse;\n    const error = body.errors[0];\n    if (!error) return false;\n    return (\n      error.title.startsWith(\"Balance\") && error.title.endsWith(\"not found\")\n    );\n  }\n}\n","export type SuccessResponse<T> = {\n  data: T;\n};\n\nexport type ErrorResponse = {\n  data: undefined;\n  errors: {\n    status: number;\n    title: string;\n    details: Record<string, unknown>;\n  }[];\n};\n\nexport type Response<T> = SuccessResponse<T> | ErrorResponse;\n\nexport function isSuccessResponse<T>(\n  response: Response<T>,\n): asserts response is SuccessResponse<T> {\n  if (response.data === undefined)\n    throw new Error(\"data field missing from response\");\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,kBAA6C;;;ACetC,SAAS,kBACd,UACwC;AACxC,MAAI,SAAS,SAAS;AACpB,UAAM,IAAI,MAAM,kCAAkC;AACtD;;;ADAO,IAAM,OAAN,MAAW;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWhB,YAAY,QAA0B;AACpC,SAAK,SAAS;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAqBM,QAAQ,SAAiB,SAAmC;AAAA;AAChE,YAAM,QAAQ,MAAM,KAAK,wBAAwB,OAAO;AAExD,UAAI;AACF,cAAM,WAAqC,MAAM,KAAK,OAAO,KAAK;AAAA,UAChE,wBAAwB,KAAK,aAAa,OAAO;AAAA,QACnD;AAEA,0BAAkB,QAAQ;AAC1B,eAAO,OAAO,SAAS,KAAK,MAAM;AAAA,MACpC,SAAS,GAAG;AACV,cAAM,MAAM;AAEZ,YAAI,KAAK,sBAAsB,GAAG,EAAG,QAAO,OAAO,CAAC;AAEpD,cAAM;AAAA,MACR;AAAA,IACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAoBM,YAAY,SAAmC;AAAA;AACnD,YAAM,QAAQ,MAAM,KAAK,wBAAwB,OAAO;AACxD,YAAM,WAAyC,MAAM,KAAK,OAAO,KAAK;AAAA,QACpE,wBAAwB,KAAK;AAAA,MAC/B;AACA,wBAAkB,QAAQ;AAC1B,aAAO,OAAO,SAAS,KAAK,MAAM;AAAA,IACpC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBM,aAA8B;AAAA;AAClC,UAAI,KAAK,YAAa,QAAO,KAAK;AAClC,YAAM,WAAwC,MAAM,KAAK,OAAO,KAAK;AAAA,QACnE;AAAA,MACF;AACA,wBAAkB,QAAQ;AAC1B,WAAK,cAAc,SAAS,KAAK;AACjC,aAAO,KAAK;AAAA,IACd;AAAA;AAAA,EAEc,wBAAwB,SAAmC;AAAA;AACvE,aAAO,4BAAW,KAAK,WAAW;AAAA,IACpC;AAAA;AAAA,EAEQ,sBAAsB,UAA4B;AACxD,QAAI,EAAE,oBAAoB,4BAAgB,UAAW,QAAO;AAC5D,QAAI,SAAS,WAAW,IAAK,QAAO;AACpC,UAAM,OAAO,SAAS;AACtB,UAAM,QAAQ,KAAK,OAAO,CAAC;AAC3B,QAAI,CAAC,MAAO,QAAO;AACnB,WACE,MAAM,MAAM,WAAW,SAAS,KAAK,MAAM,MAAM,SAAS,WAAW;AAAA,EAEzE;AACF;","names":[]}

package/dist/index.mjs

@@ -0,0 +1,147 @@
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+
+// src/bank.ts
+import { SovereignClient } from "@sovereign-sdk/web3";
+
+// src/types.ts
+function isSuccessResponse(response) {
+  if (response.data === void 0)
+    throw new Error("data field missing from response");
+}
+
+// src/bank.ts
+var Bank = class {
+  /**
+   * Creates a new Bank instance.
+   *
+   * @param rollup - The rollup instance to use for HTTP requests
+   */
+  // biome-ignore lint/suspicious/noExplicitAny: types arent used
+  constructor(rollup) {
+    this.rollup = rollup;
+  }
+  /**
+   * Gets the balance of a specific token for a given address.
+   *
+   * If no token ID is provided, the gas token balance will be returned.
+   *
+   * @param address - The address to query the balance for
+   * @param tokenId - Optional token ID. If not provided, uses the gas token
+   * @returns Promise resolving to the token balance as a bigint
+   * @throws {SovereignClient.APIError} When the request fails for reasons other than missing account
+   * @example
+   * ```typescript
+   * const bank = new Bank(rollup);
+   * const balance = await bank.balance("0x123...");
+   * console.log(`Balance: ${balance}`);
+   *
+   * // Query specific token balance
+   * const tokenBalance = await bank.balance("0x123...", "token_123");
+   * ```
+   */
+  balance(address, tokenId) {
+    return __async(this, null, function* () {
+      const token = yield this.tokenIdOrElseGasTokenId(tokenId);
+      try {
+        const response = yield this.rollup.http.get(
+          `/modules/bank/tokens/${token}/balances/${address}`
+        );
+        isSuccessResponse(response);
+        return BigInt(response.data.amount);
+      } catch (e) {
+        const err = e;
+        if (this.isMissingAccountError(err)) return BigInt(0);
+        throw e;
+      }
+    });
+  }
+  /**
+   * Gets the total supply of a specific token.
+   *
+   * If no token ID is provided, returns the total supply of the gas token.
+   *
+   * @param tokenId - Optional token ID. If not provided, uses the gas token
+   * @returns Promise resolving to the total supply as a bigint
+   * @throws {SovereignClient.APIError} When the request fails
+   * @example
+   * ```typescript
+   * const bank = new Bank(rollup);
+   * const totalSupply = await bank.totalSupply();
+   * console.log(`Total gas token supply: ${totalSupply}`);
+   *
+   * // Query specific token supply
+   * const tokenSupply = await bank.totalSupply("token_123");
+   * ```
+   */
+  totalSupply(tokenId) {
+    return __async(this, null, function* () {
+      const token = yield this.tokenIdOrElseGasTokenId(tokenId);
+      const response = yield this.rollup.http.get(
+        `/modules/bank/tokens/${token}/total-supply`
+      );
+      isSuccessResponse(response);
+      return BigInt(response.data.amount);
+    });
+  }
+  /**
+   * Gets the gas token identifier.
+   *
+   * The gas token ID is cached after the first request to avoid repeated API calls.
+   *
+   * @returns Promise resolving to the gas token ID as a string
+   * @throws {Error} When the gas token ID cannot be retrieved
+   * @example
+   * ```typescript
+   * const bank = new Bank(rollup);
+   * const gasTokenId = await bank.gasTokenId();
+   * console.log(`Gas token ID: ${gasTokenId}`);
+   * ```
+   */
+  gasTokenId() {
+    return __async(this, null, function* () {
+      if (this._gasTokenId) return this._gasTokenId;
+      const response = yield this.rollup.http.get(
+        "/modules/bank/tokens/gas_token"
+      );
+      isSuccessResponse(response);
+      this._gasTokenId = response.data.token_id;
+      return this._gasTokenId;
+    });
+  }
+  tokenIdOrElseGasTokenId(tokenId) {
+    return __async(this, null, function* () {
+      return tokenId != null ? tokenId : this.gasTokenId();
+    });
+  }
+  isMissingAccountError(anyError) {
+    if (!(anyError instanceof SovereignClient.APIError)) return false;
+    if (anyError.status !== 404) return false;
+    const body = anyError.error;
+    const error = body.errors[0];
+    if (!error) return false;
+    return error.title.startsWith("Balance") && error.title.endsWith("not found");
+  }
+};
+export {
+  Bank
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/bank.ts","../src/types.ts"],"sourcesContent":["import { type Rollup, SovereignClient } from \"@sovereign-sdk/web3\";\nimport { type ErrorResponse, type Response, isSuccessResponse } from \"./types\";\n\ntype GasTokenIdPayload = {\n  token_id: string;\n};\n\ntype BalancePayload = {\n  amount: string;\n  token_id: string;\n};\n\ntype TotalSupplyPayload = {\n  amount: string;\n  token_id: string;\n};\n\n/**\n * Bank class for interacting with the Sovereign SDK Bank module.\n */\nexport class Bank {\n  // biome-ignore lint/suspicious/noExplicitAny: types arent used\n  private readonly rollup: Rollup<any, any>;\n  private _gasTokenId?: string;\n\n  /**\n   * Creates a new Bank instance.\n   *\n   * @param rollup - The rollup instance to use for HTTP requests\n   */\n  // biome-ignore lint/suspicious/noExplicitAny: types arent used\n  constructor(rollup: Rollup<any, any>) {\n    this.rollup = rollup;\n  }\n\n  /**\n   * Gets the balance of a specific token for a given address.\n   *\n   * If no token ID is provided, the gas token balance will be returned.\n   *\n   * @param address - The address to query the balance for\n   * @param tokenId - Optional token ID. If not provided, uses the gas token\n   * @returns Promise resolving to the token balance as a bigint\n   * @throws {SovereignClient.APIError} When the request fails for reasons other than missing account\n   * @example\n   * ```typescript\n   * const bank = new Bank(rollup);\n   * const balance = await bank.balance(\"0x123...\");\n   * console.log(`Balance: ${balance}`);\n   *\n   * // Query specific token balance\n   * const tokenBalance = await bank.balance(\"0x123...\", \"token_123\");\n   * ```\n   */\n  async balance(address: string, tokenId?: string): Promise<bigint> {\n    const token = await this.tokenIdOrElseGasTokenId(tokenId);\n\n    try {\n      const response: Response<BalancePayload> = await this.rollup.http.get(\n        `/modules/bank/tokens/${token}/balances/${address}`,\n      );\n\n      isSuccessResponse(response);\n      return BigInt(response.data.amount);\n    } catch (e) {\n      const err = e as SovereignClient.APIError;\n\n      if (this.isMissingAccountError(err)) return BigInt(0);\n\n      throw e;\n    }\n  }\n\n  /**\n   * Gets the total supply of a specific token.\n   *\n   * If no token ID is provided, returns the total supply of the gas token.\n   *\n   * @param tokenId - Optional token ID. If not provided, uses the gas token\n   * @returns Promise resolving to the total supply as a bigint\n   * @throws {SovereignClient.APIError} When the request fails\n   * @example\n   * ```typescript\n   * const bank = new Bank(rollup);\n   * const totalSupply = await bank.totalSupply();\n   * console.log(`Total gas token supply: ${totalSupply}`);\n   *\n   * // Query specific token supply\n   * const tokenSupply = await bank.totalSupply(\"token_123\");\n   * ```\n   */\n  async totalSupply(tokenId?: string): Promise<bigint> {\n    const token = await this.tokenIdOrElseGasTokenId(tokenId);\n    const response: Response<TotalSupplyPayload> = await this.rollup.http.get(\n      `/modules/bank/tokens/${token}/total-supply`,\n    );\n    isSuccessResponse(response);\n    return BigInt(response.data.amount);\n  }\n\n  /**\n   * Gets the gas token identifier.\n   *\n   * The gas token ID is cached after the first request to avoid repeated API calls.\n   *\n   * @returns Promise resolving to the gas token ID as a string\n   * @throws {Error} When the gas token ID cannot be retrieved\n   * @example\n   * ```typescript\n   * const bank = new Bank(rollup);\n   * const gasTokenId = await bank.gasTokenId();\n   * console.log(`Gas token ID: ${gasTokenId}`);\n   * ```\n   */\n  async gasTokenId(): Promise<string> {\n    if (this._gasTokenId) return this._gasTokenId;\n    const response: Response<GasTokenIdPayload> = await this.rollup.http.get(\n      \"/modules/bank/tokens/gas_token\",\n    );\n    isSuccessResponse(response);\n    this._gasTokenId = response.data.token_id;\n    return this._gasTokenId;\n  }\n\n  private async tokenIdOrElseGasTokenId(tokenId?: string): Promise<string> {\n    return tokenId ?? this.gasTokenId();\n  }\n\n  private isMissingAccountError(anyError: unknown): boolean {\n    if (!(anyError instanceof SovereignClient.APIError)) return false;\n    if (anyError.status !== 404) return false;\n    const body = anyError.error as ErrorResponse;\n    const error = body.errors[0];\n    if (!error) return false;\n    return (\n      error.title.startsWith(\"Balance\") && error.title.endsWith(\"not found\")\n    );\n  }\n}\n","export type SuccessResponse<T> = {\n  data: T;\n};\n\nexport type ErrorResponse = {\n  data: undefined;\n  errors: {\n    status: number;\n    title: string;\n    details: Record<string, unknown>;\n  }[];\n};\n\nexport type Response<T> = SuccessResponse<T> | ErrorResponse;\n\nexport function isSuccessResponse<T>(\n  response: Response<T>,\n): asserts response is SuccessResponse<T> {\n  if (response.data === undefined)\n    throw new Error(\"data field missing from response\");\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,SAAsB,uBAAuB;;;ACetC,SAAS,kBACd,UACwC;AACxC,MAAI,SAAS,SAAS;AACpB,UAAM,IAAI,MAAM,kCAAkC;AACtD;;;ADAO,IAAM,OAAN,MAAW;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWhB,YAAY,QAA0B;AACpC,SAAK,SAAS;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAqBM,QAAQ,SAAiB,SAAmC;AAAA;AAChE,YAAM,QAAQ,MAAM,KAAK,wBAAwB,OAAO;AAExD,UAAI;AACF,cAAM,WAAqC,MAAM,KAAK,OAAO,KAAK;AAAA,UAChE,wBAAwB,KAAK,aAAa,OAAO;AAAA,QACnD;AAEA,0BAAkB,QAAQ;AAC1B,eAAO,OAAO,SAAS,KAAK,MAAM;AAAA,MACpC,SAAS,GAAG;AACV,cAAM,MAAM;AAEZ,YAAI,KAAK,sBAAsB,GAAG,EAAG,QAAO,OAAO,CAAC;AAEpD,cAAM;AAAA,MACR;AAAA,IACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAoBM,YAAY,SAAmC;AAAA;AACnD,YAAM,QAAQ,MAAM,KAAK,wBAAwB,OAAO;AACxD,YAAM,WAAyC,MAAM,KAAK,OAAO,KAAK;AAAA,QACpE,wBAAwB,KAAK;AAAA,MAC/B;AACA,wBAAkB,QAAQ;AAC1B,aAAO,OAAO,SAAS,KAAK,MAAM;AAAA,IACpC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBM,aAA8B;AAAA;AAClC,UAAI,KAAK,YAAa,QAAO,KAAK;AAClC,YAAM,WAAwC,MAAM,KAAK,OAAO,KAAK;AAAA,QACnE;AAAA,MACF;AACA,wBAAkB,QAAQ;AAC1B,WAAK,cAAc,SAAS,KAAK;AACjC,aAAO,KAAK;AAAA,IACd;AAAA;AAAA,EAEc,wBAAwB,SAAmC;AAAA;AACvE,aAAO,4BAAW,KAAK,WAAW;AAAA,IACpC;AAAA;AAAA,EAEQ,sBAAsB,UAA4B;AACxD,QAAI,EAAE,oBAAoB,gBAAgB,UAAW,QAAO;AAC5D,QAAI,SAAS,WAAW,IAAK,QAAO;AACpC,UAAM,OAAO,SAAS;AACtB,UAAM,QAAQ,KAAK,OAAO,CAAC;AAC3B,QAAI,CAAC,MAAO,QAAO;AACnB,WACE,MAAM,MAAM,WAAW,SAAS,KAAK,MAAM,MAAM,SAAS,WAAW;AAAA,EAEzE;AACF;","names":[]}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@sovereign-sdk/modules",
+  "version": "0.0.2",
+  "description": "A package providing convenient helpers for interacting with core Sovereign SDK modules",
+  "repository": "github:Sovereign-Labs/sovereign-sdk-web3-js",
+  "files": [
+    "dist",
+    "README.md",
+    "package.json"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "devDependencies": {
+    "tsup": "^8.3.0",
+    "typescript": "^5.6.3",
+    "vitest": "^3.0.5"
+  },
+  "peerDependencies": {
+    "tsup": "^8.3.0",
+    "typescript": "^5.6.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@sovereign-sdk/web3": "^0.4.1",
+    "@sovereign-sdk/utils": "^0.0.3"
+  },
+  "scripts": {
+    "build": "tsup",
+    "ci": "biome ci",
+    "fix": "biome check --write",
+    "lint": "biome lint",
+    "test": "vitest"
+  }
+}