@fairblock/stabletrust 1.0.0

package/README.md

@@ -0,0 +1,304 @@
+# @fairblock/stabletrust
+
+## Overview
+
+The StableTrust SDK by Fairblock provides a robust interface for executing confidential transfers using homomorphic encryption and zero-knowledge proofs. This package enables developers to integrate confidentiality features directly into their applications, allowing for secure token deposits, private transfers, and withdrawals while maintaining the integrity and auditability of the underlying blockchain transactions.
+
+For a comprehensive technical understanding of the architecture and cryptographic primitives, please refer to the following documentation:
+
+- **Technical Overview**: [Fairblock Confidential Transfers](https://docs.fairblock.network/docs/confidential_transfers/technical_overview)
+- **StableTrust Protocol**: [StableTrust Documentation](https://docs.fairblock.network/docs/confidential_transfers/stabletrust)
+- **Confidential Transactions**: [Transaction Mechanics](https://docs.fairblock.network/docs/confidential_transfers/confidential_transactions)
+
+## Requirements
+
+Before using this SDK, ensure you have the following installed:
+
+- **Node.js**: Version 16.0 or higher
+- **npm** or **yarn**: For package management
+- **ethers.js**: Version 6.0 or higher (automatically installed as a dependency)
+
+## Installation
+
+To install the package in your project, execute the following command:
+
+```bash
+npm install @fairblock/stabletrust
+```
+
+Or with yarn:
+
+```bash
+yarn add @fairblock/stabletrust
+```
+
+## Available Confidential Contract Addresses (Testnet)
+
+The following contract addresses are available for confidential transfers on testnet networks. These are test deployments and should not be used with mainnet assets:
+
+| Network  | Chain ID | Contract Address                             |
+| :------- | :------- | :------------------------------------------- |
+| Stable   | 2201     | `0x9261D8A9d5B66B202AC56E2BE738Df00D3ecAa4d` |
+| Arc      | 1244     | `0x840499150804Af011B4d0C4A8a968F18b8626e41` |
+| Base     | 84532    | `0x05ad3FF447930ad5B4085C07B4Ef9b10Aa0a58F2` |
+| Ethereum | 11155111 | `0x7B5A0060dE15a1AA1b9712A0146145E9D01A1acA` |
+| Arbitrum | 421614   | `0x5acE788EF0C9f7f902642001d639AD155fF29A6C` |
+| Tempo    | 42431    | `0x17176c409B66bb03d102215eeEdb34259Db0F5AD` |
+
+## Usage
+
+The SDK revolves around the `ConfidentialTransferClient`, which manages interactions with the confidential transfer contract and handles the necessary cryptographic operations.
+
+### Initialization
+
+Import and initialize the client with your network configuration.
+
+```javascript
+import { ConfidentialTransferClient } from "@fairblock/stabletrust";
+import { ethers } from "ethers";
+
+// Configuration for Arbitrum (example)
+const client = new ConfidentialTransferClient(
+  "https://arb1.arbitrum.io/rpc",
+  "0x5acE788EF0C9f7f902642001d639AD155fF29A6C",
+  42161,
+);
+```
+
+#### Network Configuration Examples
+
+For different networks, use the following configurations:
+
+```javascript
+// Base
+const baseClient = new ConfidentialTransferClient(
+  "https://mainnet.base.org",
+  "0x05ad3FF447930ad5B4085C07B4Ef9b10Aa0a58F2",
+  8453,
+);
+
+// Ethereum Mainnet
+const ethClient = new ConfidentialTransferClient(
+  "https://eth.public.netzach.io",
+  "0x7B5A0060dE15a1AA1b9712A0146145E9D01A1acA",
+  1,
+);
+
+// Tempo (Stablecoin chain with special fee handling)
+const tempoClient = new ConfidentialTransferClient(
+  "https://tempo-rpc.example.com",
+  "0x17176c409B66bb03d102215eeEdb34259Db0F5AD",
+  42431,
+);
+```
+
+**Note on Tempo Chain**: The Tempo network (chainId 42431) uses token-based fees instead of native currency. The SDK automatically handles fee payment using PathUSD when detected.
+
+### Key Functions
+
+The following methods are the primary entry points for interacting with the confidential system.
+
+#### `deriveKeys(signer)`
+
+Derives the encryption keypair for a wallet. These keys are used for all confidential operations.
+
+- **Parameters**:
+  - `signer` (ethers.Signer): The ethers.js signer instance for the user.
+- **Returns**: An object containing `publicKey` and `privateKey` (base64-encoded).
+
+#### `ensureAccount(signer, options)`
+
+Initializes or retrieves the cryptographic keys associated with an account. This step is required before performing any confidential operations. Automatically creates the account on-chain if it doesn't exist.
+
+- **Parameters**:
+  - `signer` (ethers.Signer): The ethers.js signer instance for the user.
+  - `options` (object, optional):
+    - `waitForFinalization` (boolean): Wait for account finalization. Default: `true`
+    - `maxAttempts` (number): Maximum attempts to check finalization. Default: `30`
+- **Returns**: An object containing the user's private and public keys for the confidential system.
+
+#### `getBalance(address, privateKey, tokenAddress, options)`
+
+Retrieves the decrypted balance for a specific token in the confidential account.
+
+- **Parameters**:
+  - `address` (string): The account address.
+  - `privateKey` (string): The private key for decryption.
+  - `tokenAddress` (string): The token contract address.
+  - `options` (object, optional):
+    - `type` (string): Balance type—`'available'` or `'pending'`. Default: `'available'`
+- **Returns**: An object containing `amount` (number) and `ciphertext` (string).
+
+#### `deposit(signer, tokenAddress, amount, options)`
+
+Deposits a specified amount of ERC20 tokens into the confidential contract, converting them into a "pending" confidential balance.
+
+- **Parameters**:
+  - `signer` (ethers.Signer): The transaction signer.
+  - `tokenAddress` (string): The contract address of the ERC20 token.
+  - `amount` (bigint | string | number): The amount to deposit (ensure proper unit scaling).
+  - `options` (object, optional):
+    - `waitForFinalization` (boolean): Wait for deposit finalization. Default: `true`
+- **Returns**: A transaction receipt.
+
+#### `transfer(signer, recipientAddress, tokenAddress, amount, options)`
+
+Executes a confidential transfer of tokens from the sender to a recipient. The amount and nature of the transfer are encrypted.
+
+- **Parameters**:
+  - `signer` (ethers.Signer): The sender's signer.
+  - `recipientAddress` (string): The public address of the recipient.
+  - `tokenAddress` (string): The token contract address.
+  - `amount` (number): The amount to transfer.
+  - `options` (object, optional):
+    - `useOffchainVerify` (boolean): Use offchain verification. Default: `false`
+    - `waitForFinalization` (boolean): Wait for transfer finalization. Default: `true`
+- **Returns**: A transaction receipt.
+
+#### `applyPending(signer, options)`
+
+Moves funds from the "pending" balance to the "available" balance. This is often necessary for the recipient to utilize received funds.
+
+- **Parameters**:
+  - `signer` (ethers.Signer): The user's signer.
+  - `options` (object, optional):
+    - `waitForFinalization` (boolean): Wait for operation finalization. Default: `true`
+- **Returns**: A transaction receipt.
+
+#### `withdraw(signer, tokenAddress, amount, options)`
+
+Withdraws funds from the confidential "available" balance back to the public layer (ERC20 tokens).
+
+- **Parameters**:
+  - `signer` (ethers.Signer): The user's signer.
+  - `tokenAddress` (string): The token contract address.
+  - `amount` (number): The amount to withdraw.
+  - `options` (object, optional):
+    - `useOffchainVerify` (boolean): Use offchain verification. Default: `false`
+    - `waitForFinalization` (boolean): Wait for withdrawal finalization. Default: `true`
+- **Returns**: A transaction receipt.
+
+#### `waitForPendingBalance(address, privateKey, tokenAddress, options)`
+
+Polls for pending balance to appear after a transfer (typically after another user calls `applyPending`).
+
+- **Parameters**:
+  - `address` (string): The account address.
+  - `privateKey` (string): The private key for decryption.
+  - `tokenAddress` (string): The token contract address.
+  - `options` (object, optional):
+    - `maxAttempts` (number): Maximum polling attempts. Default: `60`
+    - `intervalMs` (number): Polling interval in milliseconds. Default: `3000`
+- **Returns**: An object containing `amount` and `ciphertext`.
+
+#### `getFeeAmount()`
+
+Retrieves the current fee amount required for confidential transfers on the network.
+
+- **Returns**: The fee amount in wei (bigint).
+
+#### `getTokenBalance(address, tokenAddress)`
+
+Retrieves the public ERC20 token balance for an address (non-confidential).
+
+- **Parameters**:
+  - `address` (string): The account address.
+  - `tokenAddress` (string): The token contract address.
+- **Returns**: The token balance (bigint).
+
+### Examples
+
+For a complete implementation demonstrating the full lifecycle of a confidential transaction—from deposit to withdrawal—please refer to the `examples/complete-flow.js` file included in this repository.
+
+Additional examples are available in the `examples/` directory:
+
+- **complete-flow.js**: Full workflow example covering all operations
+- **simple-snippets.js**: Quick code snippets for common tasks
+
+## Error Handling
+
+The SDK provides descriptive error messages for common issues. Here are some typical scenarios:
+
+```javascript
+try {
+  await client.transfer(signer, recipientAddress, tokenAddress, amount);
+} catch (error) {
+  if (error.message.includes("Insufficient balance")) {
+    console.error("Transfer amount exceeds available balance");
+  } else if (error.message.includes("Proof generation failed")) {
+    console.error("Failed to generate transfer proof");
+  } else if (error.message.includes("Account finalization timeout")) {
+    console.error("Account setup is still processing");
+  } else {
+    console.error("Transfer failed:", error.message);
+  }
+}
+```
+
+### Common Issues and Solutions
+
+| Issue                            | Cause                                                   | Solution                                            |
+| :------------------------------- | :------------------------------------------------------ | :-------------------------------------------------- |
+| "Account does not exist"         | Recipient hasn't initialized their confidential account | Recipient must call `ensureAccount()` first         |
+| "Insufficient balance"           | Transfer amount exceeds available confidential balance  | Deposit more tokens or reduce transfer amount       |
+| "Insufficient fee token balance" | Not enough PathUSD on Tempo chain for fees              | Top up fee token balance before transferring        |
+| "Account finalization timeout"   | Account creation is still processing                    | Wait a few minutes and retry the operation          |
+| "Proof generation failed"        | Invalid inputs or cryptographic operation error         | Verify all parameters and ensure sufficient balance |
+
+## Performance Metrics
+
+The following are estimated execution times for standard operations within the confidential flow. Please note that these durations may vary based on network congestion and client hardware performance.
+
+The following are estimated execution times for standard operations within the confidential flow. Please note that these durations may vary based on network congestion and client hardware performance.
+
+| Operation     | Avg Duration |
+| :------------ | :----------- |
+| Deposit       | 63s          |
+| Transfer      | 58s          |
+| Apply Pending | 61s          |
+| Withdraw      | 58s          |
+
+## Security Considerations
+
+When using the StableTrust SDK, follow these best practices to ensure the security of your confidential transactions:
+
+1. **Private Key Management**
+   - Never expose or log private keys or seed phrases
+   - Store private keys securely (e.g., hardware wallets, encrypted vaults)
+   - Derived keys are sensitive cryptographic material—handle with care
+
+2. **Signer Security**
+   - Use secure signer implementations (e.g., hardware wallets, encrypted key stores)
+   - Avoid using signers with exposed private keys in production
+   - Keep your ethers.js provider and signer in sync with your security setup
+
+3. **Network Security**
+   - Use HTTPS-only RPC endpoints
+   - Verify contract addresses before initialization to prevent man-in-the-middle attacks
+   - Consider using dedicated RPC providers for production environments
+
+4. **Account Initialization**
+   - Always call `ensureAccount()` before performing any confidential operations
+   - Verify that recipient accounts exist before transferring funds
+   - Allow sufficient time for account finalization before proceeding with operations
+
+5. **Balance Verification**
+   - Check available balance before initiating transfers
+   - Be aware of transaction fees that may vary by network
+   - On Tempo chain, ensure sufficient PathUSD balance for fee payment
+
+6. **Error Handling**
+   - Implement comprehensive error handling for all SDK operations
+   - Log errors appropriately without exposing sensitive information
+   - Implement retry logic for transient failures (network timeouts, etc.)
+
+## Resources
+
+- **Website**: [https://app.stabletrust.io/](https://app.stabletrust.io/)
+- **Documentation**: [https://docs.fairblock.network/docs/confidential_transfers/confidential_transactions](https://docs.fairblock.network/docs/confidential_transfers/confidential_transactions)
+- **Twitter**: [https://twitter.com/0xfairblock](https://twitter.com/0xfairblock)
+- **GitHub**: [https://github.com/fairblock](https://github.com/fairblock)
+
+## License
+
+This package is licensed under the Apache-2.0 License. See the LICENSE file in the repository for details.

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@fairblock/stabletrust",
+  "version": "1.0.0",
+  "description": "SDK for confidential transfers using homomorphic encryption and zero-knowledge proofs",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "import": "./src/index.js"
+    },
+    "./wasm": "./pkg/confidential_transfer_proof_generation.js"
+  },
+  "files": [
+    "src/",
+    "pkg/",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "confidential",
+    "transfers",
+    "zero-knowledge",
+    "encryption",
+    "blockchain",
+    "privacy"
+  ],
+  "author": "",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "dotenv": "^17.2.3",
+    "ethers": "^6.16.0"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  }
+}

package/pkg/LICENSE

@@ -0,0 +1,176 @@
+                                 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

package/pkg/confidential_transfer_proof_generation.d.ts

@@ -0,0 +1,65 @@
+/* tslint:disable */
+/* eslint-disable */
+export function generate_withdraw_proof(input: string): string;
+export function decrypt_ciphertext(ciphertext_base64: string, keypair_base64: string): string;
+/**
+ * Generate a deterministic ElGamal keypair from an EIP-712 signature
+ */
+export function generate_deterministic_keypair(signature_hex: string, domain_context: string): string;
+export function test_wasm(): string;
+export function generate_transfer_proof(input: string): string;
+/**
+ * Decode transfer proof from contract input data and extract transfer amount ciphertext
+ * handle_index: 0 for sender, 1 for recipient
+ */
+export function decode_transfer_proof(validity_proof_base64: string, handle_index: number): string;
+/**
+ * Generate a random ElGamal keypair (for compatibility)
+ */
+export function generate_keypair(): string;
+export function encrypt_amount(amount: bigint, pubkey_base64: string): string;
+/**
+ * Generate a deterministic ElGamal keypair using legacy method (for backward compatibility)
+ */
+export function generate_deterministic_keypair_legacy(signature_hex: string): string;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+  readonly memory: WebAssembly.Memory;
+  readonly decode_transfer_proof: (a: number, b: number, c: number, d: number) => void;
+  readonly decrypt_ciphertext: (a: number, b: number, c: number, d: number, e: number) => void;
+  readonly encrypt_amount: (a: number, b: bigint, c: number, d: number) => void;
+  readonly generate_deterministic_keypair: (a: number, b: number, c: number, d: number, e: number) => void;
+  readonly generate_deterministic_keypair_legacy: (a: number, b: number, c: number) => void;
+  readonly generate_keypair: (a: number) => void;
+  readonly generate_transfer_proof: (a: number, b: number, c: number) => void;
+  readonly generate_withdraw_proof: (a: number, b: number, c: number) => void;
+  readonly test_wasm: (a: number) => void;
+  readonly __wbindgen_export_0: (a: number) => void;
+  readonly __wbindgen_export_1: (a: number, b: number) => number;
+  readonly __wbindgen_export_2: (a: number, b: number, c: number, d: number) => number;
+  readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
+  readonly __wbindgen_export_3: (a: number, b: number, c: number) => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+/**
+* Instantiates the given `module`, which can either be bytes or
+* a precompiled `WebAssembly.Module`.
+*
+* @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+*
+* @returns {InitOutput}
+*/
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+* If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+* for everything else, calls `WebAssembly.instantiate` directly.
+*
+* @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+*
+* @returns {Promise<InitOutput>}
+*/
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;