Chore/stellar monorepo migration

merged-packages/stellar-wallet-snap/.depcheckrc.json

@@ -0,0 +1,13 @@
+{
+  "ignores": [
+    "jest-transform-stub",
+    "ts-jest",
+    "@metamask/auto-changelog",
+    "@metamask/key-tree",
+    "@stellar/stellar-sdk",
+    "@types/lodash",
+    "async-mutex",
+    "bignumber.js",
+    "lodash"
+  ]
+}

merged-packages/stellar-wallet-snap/.env.example

@@ -0,0 +1,80 @@
+# Use:
+# - local for local development
+# - test for running tests locally (mandatory)
+# - production before submitting a PR
+ENVIRONMENT=local
+
+# Use:
+# - all for all logs
+# - error for error logs
+# - warn for warn logs
+# - info for info logs
+# - debug for debug logs
+# - silent for silent logs
+LOG_LEVEL=all
+
+# Mainnet RPC URLs
+RPC_URL_MAINNET=https://mainnet.sorobanrpc.com
+
+# Mainnet Horizon URLs
+HORIZON_URL_MAINNET=https://horizon.stellar.org
+
+# Mainnet Explorer Base URLs
+EXPLORER_MAINNET_BASE_URL=https://stellar.expert/explorer/public
+
+# Testnet RPC URLs
+RPC_URL_TESTNET=https://soroban-testnet.stellar.org
+
+# Testnet Horizon URLs
+HORIZON_URL_TESTNET=https://horizon-testnet.stellar.org
+
+# Testnet Explorer Base URLs
+EXPLORER_TESTNET_BASE_URL=https://stellar.expert/explorer/testnet
+
+# Token API Base URL
+TOKEN_API_BASE_URL=https://tokens.api.cx.metamask.io
+
+# Static API Base URL
+STATIC_API_BASE_URL=https://static.cx.metamask.io
+
+# Price API Base URL
+PRICE_API_BASE_URL=https://price.api.cx.metamask.io
+
+# Security Alerts API Base URL
+SECURITY_ALERTS_API_BASE_URL=https://security-alerts.api.cx.metamask.io
+
+# Cache TTL Milliseconds for base fee
+#BASE_FEE_TTL_MILLISECONDS=
+
+# Cache TTL Milliseconds for load on chain account
+#LOAD_ON_CHAIN_ACCOUNT_TTL_MILLISECONDS=
+
+# Cache TTL Milliseconds for SEP41 transfer simulate transaction
+#SIMULATE_TRANSACTION_TTL_MILLISECONDS=
+
+# Cache TTL Milliseconds for sep41 asset balance
+#SEP41_ASSET_BALANCE_TTL_MILLISECONDS=
+
+# Cache TTL Milliseconds for spot prices
+#SPOT_PRICES_TTL_MILLISECONDS=
+
+# Cache TTL Milliseconds for fiat exchange rates
+#FIAT_EXCHANGE_RATES_TTL_MILLISECONDS=
+
+# Cache TTL Milliseconds for historical prices
+#HISTORICAL_PRICES_TTL_MILLISECONDS=
+
+# Inclusion fee multiplier (applied to Stellar network base fee per operation)
+#BASE_FEE_MULTIPLIER=
+
+# Maximum fee threshold in XLM
+#MAX_FEE_THRESHOLD_IN_XLM=
+
+# Maximum background reschedules for the track-transaction cron job while Horizon has not
+#TRACK_TRANSACTION_MAX_RESCHEDULES=10
+
+# Maximum number of reconcile attempts for a pending transaction
+#MAX_RECONCILE_ATTEMPTS=5
+
+# Maximum age of a pending transaction in milliseconds
+#MAX_PENDING_TRANSACTION_AGE=30000

merged-packages/stellar-wallet-snap/.prettierignore

@@ -0,0 +1,2 @@
+dist/
+coverage/

merged-packages/stellar-wallet-snap/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+[Unreleased]: https://github.com/MetaMask/snap-stellar-wallet/

merged-packages/stellar-wallet-snap/LICENSE.APACHE2

@@ -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 2022 ConsenSys Software Inc.
+
+   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.

merged-packages/stellar-wallet-snap/LICENSE.MIT0

@@ -0,0 +1,16 @@
+MIT No Attribution
+
+Copyright 2022 ConsenSys Software Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this
+software and associated documentation files (the "Software"), to deal in the Software
+without restriction, including without limitation the rights to use, copy, modify,
+merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

merged-packages/stellar-wallet-snap/README.md

@@ -0,0 +1,69 @@
+# Stellar Wallet Snap
+
+MetaMask Snap that implements Stellar account management, signing, sends, trustlines, and related multichain client APIs.
+
+## Configuration
+
+Rename `.env.example` to `.env`. Runtime settings are loaded from `.env`.
+
+## Folder structure
+
+High-level layout of `packages/snap` (nested implementation folders like `services/transaction/simulation` are omitted):
+
+| Folder                           | Purpose                                                                        |
+| -------------------------------- | ------------------------------------------------------------------------------ |
+| `locales/`                       | Localized UI strings (built from `messages.json`)                              |
+| `images/`                        | Snap icons / static assets                                                     |
+| `scripts/`                       | Build helpers (manifest, locale, preinstalled snap)                            |
+| `docs/`                          | Package documentation (folder map, use cases, transaction pipeline)            |
+| `docs/use-cases/`                | Use-case docs grouped by domain (`keyring`, `client-request`, `cron-job`, ...) |
+| `docs/misc/transaction/`         | Transaction build / validate / submit reference                                |
+| `docs/misc/synchronization/`     | Background sync flow and component details                                     |
+| `src/api/`                       | Shared types and Superstruct validators (CAIP, XDR, amounts, …)                |
+| `src/handlers/`                  | Snap RPC / lifecycle entry handlers; orchestrates use cases                    |
+| `src/handlers/asset/`            | `onAssets*` lookups, conversion, market data, historical price                 |
+| `src/handlers/clientRequest/`    | SIP-31 client methods (send, trustline, fees, …)                               |
+| `src/handlers/cronjob/`          | Background sync, transaction tracking, confirmation refresh                    |
+| `src/handlers/keyring/`          | Keyring API (accounts, sign tx / message / auth entry)                         |
+| `src/handlers/user-input/`       | Confirmation dialog button / form events                                       |
+| `src/services/`                  | Domain logic (no Snap entry-point routing)                                     |
+| `src/services/account/`          | Keyring account persistence and lookups                                        |
+| `src/services/asset-metadata/`   | Asset metadata resolution (symbol, icon, …)                                    |
+| `src/services/cache/`            | In-memory and state-backed caches                                              |
+| `src/services/network/`          | Horizon / network calls, fees, activation checks                               |
+| `src/services/on-chain-account/` | On-chain balances, trustlines, and sync                                        |
+| `src/services/price/`            | Spot / conversion prices                                                       |
+| `src/services/state/`            | Snap state manager                                                             |
+| `src/services/sync/`             | Assets / Balances / Transactions synchronization orchestration                 |
+| `src/services/transaction/`      | Build, validate, map, send, and pending keyring transactions                   |
+| `src/services/transaction-scan/` | Security / Blockaid scanning                                                   |
+| `src/services/wallet/`           | HD wallet and signing                                                          |
+| `src/ui/`                        | Snap UI (JSX screens shown inside MetaMask)                                    |
+| `src/ui/confirmation/`           | Confirmation dialogs and UX controller                                         |
+| `src/ui/images/`                 | Inline UI assets                                                               |
+| `src/utils/`                     | Cross-cutting helpers (logging, i18n, CAIP, snap APIs, …)                      |
+
+## Use cases
+
+End-to-end flows (handler → services → UI) live under [`docs/use-cases/`](./docs/use-cases/).
+Background synchronization overview: [`docs/misc/synchronization/overview.md`](./docs/misc/synchronization/overview.md).
+Shared transaction build / validate / send: [`docs/misc/transaction/`](./docs/misc/transaction/README.md).
+
+## API examples
+
+### `keyring_createAccount`
+
+```typescript
+provider.request({
+  method: 'wallet_invokeKeyring',
+  params: {
+    snapId,
+    request: {
+      method: 'keyring_createAccount',
+      params: {
+        scope: 'stellar:pubnet', // CAIP-2 chain ID
+      },
+    },
+  },
+});
+```