onekey-monero-runtime 0.0.0-stage → 0.1.0-alpha.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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/onekey_monero_runtime.d.ts

@@ -0,0 +1,284 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Register an identity (view key pair).
+ *
+ * `spendPublicKeyHex` and `viewPrivateKeyHex` are 32-byte hex. The spend private
+ * key is not taken here; it is passed only for signing (see `signTransaction`).
+ */
+export function addAccount(uuid: string, spend_public_key_hex: string, view_private_key_hex: string, birthday_height: bigint): string;
+
+/**
+ * Balance. `chainTip` = `null` means the tip is unknown; spendable is then reported
+ * as 0 rather than invite a spend that cannot be built.
+ */
+export function balance(account_id: bigint, chain_tip?: bigint | null): string;
+
+/**
+ * Broadcast a signed transaction. Irreversible.
+ *
+ * Accepted and uncertain (network error) outcomes are both recorded: spent outputs
+ * are marked, the transaction goes in flight, and `broadcast: accepted | unknown` is
+ * returned. Only an explicit node rejection errors and releases the inputs.
+ */
+export function broadcastTransaction(account_id: bigint, raw_hex: string, reservation_id: string, chain_tip: bigint, outgoing_atomic?: string | null, change_atomic?: string | null): Promise<string>;
+
+/**
+ * Fetch the chain tip. Does not require an open wallet DB: account creation needs
+ * it for the birthday before the DB exists.
+ *
+ * Returns `{ height, network }`, where `network` is the node's chain (by genesis
+ * block). There is no wallet DB to compare against yet, so the host must check it
+ * matches the wallet being created before setting the birthday.
+ */
+export function chainTip(): Promise<string>;
+
+export function closeWallet(): void;
+
+/**
+ * Delete the whole wallet DB file (app reset, storage rebuild). Irreversible.
+ *
+ * Does not open the DB, so unsupported-version or corrupt DBs can still be deleted.
+ * Closes the DB first if it is the one currently open.
+ */
+export function deleteWallet(db_name: string): Promise<string>;
+
+/**
+ * Upstream versions pinned by this runtime, for host self-checks and logs.
+ */
+export function dependencyVersions(): string;
+
+/**
+ * Derive Monero view material and the primary address from a BIP-32-derived private key.
+ *
+ * Pure derivation: no DB, no node, so an address can exist before any scanning.
+ *
+ * Matches OneKey V4 (`spend = sc_reduce32(key)`, `view = keccak(spend)`). Changing
+ * it would show existing users an empty wallet after importing the same mnemonic.
+ *
+ * Does not return the spend private key; the caller already has it.
+ */
+export function deriveAccount(network: string, bip32_private_key_hex: string): string;
+
+/**
+ * Derive a subaddress. Pure derivation; no DB.
+ */
+export function deriveSubaddress(network: string, spend_public_key_hex: string, view_private_key_hex: string, major: number, minor: number): string;
+
+/**
+ * Diagnostics: DB health, per-table row counts, logical size. No network requests.
+ */
+export function diagDatabase(): string;
+
+export function history(account_id: bigint, limit: number, offset: number): string;
+
+/**
+ * Import key images so spend detection works.
+ *
+ * Call as early as possible after unlock. Until then the balance is too high: a
+ * view-only wallet cannot detect spends, so spent outputs still look unspent. This
+ * only affects blocks scanned afterwards; earlier spends need a rewind and rescan.
+ */
+export function importKeyImages(account_id: bigint, spend_private_key_hex: string): string;
+
+/**
+ * Install persistent storage. Must be called once before opening any DB.
+ */
+export function init(): Promise<void>;
+
+export function listAccounts(): string;
+
+/**
+ * Called before signing; every selected input must still belong to this review.
+ */
+export function markReservationSigned(reservation_id: string, expected_inputs: number): string;
+
+/**
+ * Open (or create) a wallet DB.
+ */
+export function openWallet(db_name: string, network: string): string;
+
+/**
+ * Select inputs, build and reserve. Needs no spend private key; does not broadcast.
+ *
+ * `recipientsJson` is `[{ "address": "...", "amountAtomic": "1000000000000" }]`.
+ *
+ * With `maxSend`, exactly one recipient is accepted and its amount is computed as
+ * spendable total minus fee; the passed amount is ignored. Merely omitting change
+ * would fold the remainder into the fee.
+ *
+ * Returns `{ reservationId, signableHex, feeAtomic, amountAtomic, changeAtomic,
+ * inputsAtomic, inputCount }`. `feeAtomic` and `amountAtomic` are what the
+ * transaction will use: the confirmation page shows them and signing keeps them.
+ *
+ * Failure leaves no reservation. On success the host must call `signTransaction` +
+ * `broadcastTransaction`, or `releaseReservation`; otherwise the inputs stay locked.
+ */
+export function prepareTransaction(account_id: bigint, recipients_json: string, max_send: boolean, reservation_id: string, chain_tip: bigint, priority: string): Promise<string>;
+
+/**
+ * Register a subaddress and return its address. Funds to unregistered subaddresses go undetected.
+ */
+export function registerSubaddress(account_id: bigint, major: number, minor: number, label?: string | null): string;
+
+/**
+ * Release a reservation (user cancelled or construction failed).
+ */
+export function releaseReservation(reservation_id: string): string;
+
+/**
+ * Delete an identity and all its data. Irreversible.
+ */
+export function removeAccount(uuid: string): string;
+
+/**
+ * Reorg recovery: rewind to `height` and requeue everything above it. Destructive.
+ */
+export function rewindTo(account_id: bigint, height: bigint, tip: bigint): string;
+
+/**
+ * Set the node URL; an empty string disables it. No built-in default: one would
+ * decide for the user who sees their IP and queries.
+ *
+ * The old node is dropped before connecting the new one: a replaced or disabled
+ * node must receive no further requests, even if the new one fails to connect.
+ */
+export function setNodeUrl(url: string): Promise<void>;
+
+/**
+ * Hand network requests to the host instead of `fetch`ing in wasm.
+ *
+ * `handler` is `(url, contentType, body: Uint8Array) => Promise<Uint8Array>`;
+ * `undefined` uninstalls it.
+ *
+ * In-wasm fetch is bound by browser mixed-content and CORS rules, and monerod sends
+ * no CORS headers by default, so few public nodes are reachable. The extension
+ * background, desktop main process and mobile native code are not bound by those
+ * rules, so any node is reachable through them.
+ */
+export function setRequestHandler(handler?: Function | null): void;
+
+/**
+ * Sign a prepared transaction. No network, no DB, no broadcast.
+ *
+ * `spendPrivateKeyHex` is wiped after use, never stored or returned.
+ * Returns `{ txid, rawHex, sizeBytes }`; the txid is fixed at signing, so the host
+ * can record the pending transaction before broadcasting.
+ */
+export function signTransaction(signable_hex: string, spend_private_key_hex: string, review_json: string): string;
+
+/**
+ * Spend scalar for signing, from a BIP-32 private key. Same reduction as `deriveAccount`.
+ */
+export function spendScalar(bip32_private_key_hex: string): string;
+
+/**
+ * Read-only scan progress; no network requests. Shows which ranges sync intends to scan.
+ */
+export function syncPeek(account_id: bigint): string;
+
+/**
+ * One bounded step: scan at most `maxBlocks` blocks and return progress.
+ *
+ * Never loops to completion; the host decides whether to call again.
+ */
+export function syncStep(account_id: bigint, max_blocks: bigint): Promise<string>;
+
+export function transactionDetails(account_id: bigint, txid_hex: string): string;
+
+/**
+ * Tell an identity the chain tip and queue its pending scan ranges.
+ */
+export function updateChainTip(account_id: bigint, tip: bigint): string;
+
+/**
+ * Check that a recipient address is valid and belongs to this network.
+ */
+export function validateAddress(network: string, address: string): boolean;
+
+/**
+ * Validate actual payment effects before the host presents its confirmation.
+ */
+export function verifyTransaction(signable_hex: string, review_json: string): void;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly addAccount: (a: number, b: number, c: number, d: number, e: number, f: number, g: bigint) => [number, number, number, number];
+    readonly balance: (a: bigint, b: number, c: bigint) => [number, number, number, number];
+    readonly broadcastTransaction: (a: bigint, b: number, c: number, d: number, e: number, f: bigint, g: number, h: number, i: number, j: number) => any;
+    readonly chainTip: () => any;
+    readonly closeWallet: () => [number, number];
+    readonly deleteWallet: (a: number, b: number) => any;
+    readonly dependencyVersions: () => [number, number];
+    readonly deriveAccount: (a: number, b: number, c: number, d: number) => [number, number, number, number];
+    readonly deriveSubaddress: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => [number, number, number, number];
+    readonly diagDatabase: () => [number, number, number, number];
+    readonly history: (a: bigint, b: number, c: number) => [number, number, number, number];
+    readonly importKeyImages: (a: bigint, b: number, c: number) => [number, number, number, number];
+    readonly init: () => any;
+    readonly listAccounts: () => [number, number, number, number];
+    readonly markReservationSigned: (a: number, b: number, c: number) => [number, number, number, number];
+    readonly openWallet: (a: number, b: number, c: number, d: number) => [number, number, number, number];
+    readonly prepareTransaction: (a: bigint, b: number, c: number, d: number, e: number, f: number, g: bigint, h: number, i: number) => any;
+    readonly registerSubaddress: (a: bigint, b: number, c: number, d: number, e: number) => [number, number, number, number];
+    readonly releaseReservation: (a: number, b: number) => [number, number, number, number];
+    readonly removeAccount: (a: number, b: number) => [number, number, number, number];
+    readonly rewindTo: (a: bigint, b: bigint, c: bigint) => [number, number, number, number];
+    readonly setNodeUrl: (a: number, b: number) => any;
+    readonly setRequestHandler: (a: number) => void;
+    readonly signTransaction: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number, number];
+    readonly spendScalar: (a: number, b: number) => [number, number, number, number];
+    readonly syncPeek: (a: bigint) => [number, number, number, number];
+    readonly syncStep: (a: bigint, b: bigint) => any;
+    readonly transactionDetails: (a: bigint, b: number, c: number) => [number, number, number, number];
+    readonly updateChainTip: (a: bigint, b: bigint) => [number, number, number, number];
+    readonly validateAddress: (a: number, b: number, c: number, d: number) => [number, number, number];
+    readonly verifyTransaction: (a: number, b: number, c: number, d: number) => [number, number];
+    readonly rust_sqlite_wasm_abort: () => void;
+    readonly rust_sqlite_wasm_assert_fail: (a: number, b: number, c: number, d: number) => void;
+    readonly rust_sqlite_wasm_calloc: (a: number, b: number) => number;
+    readonly rust_sqlite_wasm_free: (a: number) => void;
+    readonly rust_sqlite_wasm_getentropy: (a: number, b: number) => number;
+    readonly rust_sqlite_wasm_localtime: (a: number) => number;
+    readonly rust_sqlite_wasm_malloc: (a: number) => number;
+    readonly rust_sqlite_wasm_realloc: (a: number, b: number) => number;
+    readonly sqlite3_os_end: () => number;
+    readonly sqlite3_os_init: () => number;
+    readonly wasm_bindgen__convert__closures_____invoke__h7657f6f35500acf9: (a: number, b: number, c: any) => [number, number];
+    readonly wasm_bindgen__convert__closures_____invoke__h504ed10f016d7d42: (a: number, b: number, c: any, d: any) => void;
+    readonly wasm_bindgen__convert__closures_____invoke__h38334fab7c782151: (a: number, b: number) => void;
+    readonly __wbindgen_malloc: (a: number, b: number) => number;
+    readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+    readonly __wbindgen_exn_store: (a: number) => void;
+    readonly __externref_table_alloc: () => number;
+    readonly __wbindgen_externrefs: WebAssembly.Table;
+    readonly __wbindgen_destroy_closure: (a: number, b: number) => void;
+    readonly __externref_table_dealloc: (a: number) => void;
+    readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+    readonly __wbindgen_start: () => 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>;