stellar-check 0.1.0

package/LICENSE

@@ -0,0 +1,227 @@
+
+                                 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 2015 Stellar Development Foundation
+
+   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.
+
+----
+
+Included code for base58 encoding is licensed under the MIT license:
+
+Copyright (c) 2011 Google Inc
+Copyright (c) 2013 BitPay 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, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+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.

package/README.md

@@ -0,0 +1,167 @@
+# Stellar Check
+
+Stellar Check is a read-only TypeScript library for checking a Stellar payment before signing. It reports available balances, reserve requirements, liabilities, trustline authorization, receiving capacity and declared memo requirements.
+
+Pre-grant development version: **0.1.0**. UI and branding iterations remain part of v0.1 until the final product milestone. The proposal documents are historical planning inputs; see [implementation status](https://github.com/GautamBytes/stellar-check/blob/main/docs/implementation-status.md) for what has actually been verified.
+
+The repository includes the library, tests, website and documentation. Historical proposal documents describe the original plan; the implementation status records what was built. CI runs the full check and package validation on pull requests.
+
+## Install
+
+```sh
+npm install stellar-check
+```
+
+Requires Node **22.12 or later**, or a modern browser bundler. [Try the Playground](https://stellar-check-gamma.vercel.app/playground.html) or read the [integration guide](https://stellar-check-gamma.vercel.app/docs.html#integration).
+
+## Run locally
+
+Requires Node **22.12 or later** and npm. Dependencies are pinned.
+
+```sh
+npm ci
+npm run check
+npm run example  # four controlled, offline scenarios
+npm run demo     # http://127.0.0.1:5173
+```
+
+The website includes a “Why Stellar Check?” section and a dedicated reading guide at `/docs.html`, covering purpose, problems, a worked example, integration, evidence, ecosystem value and scope.
+
+The website offers coordinated light and dark themes. Use the header toggle to save your preference; the first visit follows your system setting.
+
+The homepage keeps a small interactive preview. The full checker lives at `/playground.html` and starts in **controlled fixture mode**. Select **Live Horizon data** and enter real public accounts for the chosen network to run fresh reads. The library and page never request secret keys, sign transactions, create accounts or submit payments. Live requests disclose queried public addresses to the configured provider. The page clears a report when the input changes and ignores responses for superseded inputs.
+
+## Integrate
+
+Import the installed package in your application. If you use the Stellar SDK directly, install it as a direct dependency too: `npm install @stellar/stellar-sdk`.
+
+```ts
+import { Networks } from '@stellar/stellar-sdk';
+import { checkPayment, HorizonProvider } from 'stellar-check';
+
+const provider = new HorizonProvider('https://horizon-testnet.stellar.org');
+const report = await checkPayment(
+  {
+    networkPassphrase: Networks.TESTNET,
+    source: senderPublicAddress,
+    destination: recipientPublicAddress,
+    asset: { type: 'native' },
+    amount: '2.5000000',
+    feeBudget: '0.0000100',
+    // memo: { type: 'id', value: '12345' },
+  },
+  provider,
+);
+
+if (report.status === 'no_known_issues') {
+  // No supported issue found in observed state. Refresh before confirmation.
+} else {
+  for (const issue of report.issues) {
+    console.log(issue.code, issue.party, issue.message, issue.action);
+  }
+}
+```
+
+For an issued asset, use `{ type: 'credit', code: 'USDC', issuer: issuerPublicAddress }`. Matching a code alone never identifies a trustline. `feeBudget` is the **total fee in XLM**, not stroops, and must be a positive decimal string within the transaction fee range. It is checked against the current one-operation base fee; surge pricing and inclusion are not predicted.
+
+Memo types: `text` (up to 28 UTF-8 bytes), `id` (uint64 decimal string), `hash` and `return` (64 hexadecimal characters). Omit `memo` for no memo. The SDK considers even an empty text memo to be present; applications must obtain the receiving service’s actual memo and verify its intended meaning themselves.
+
+The package exports ESM and TypeScript declarations, and works in Node and browser bundlers. No application database or server is required. The demo uses Vite; the library does not depend on Vite.
+
+## Import an unsigned transaction
+
+The Playground's **Import XDR** panel decodes locally, previews exact payment values and only loads them into the checker after an explicit click. Loading selects Live Horizon and clears the previous report. It does not make account requests; click **Check payment** to fetch current public state. The example XDR uses controlled sample addresses, not maintained live accounts.
+
+```ts
+import { importPaymentXdr, checkPayment, HorizonProvider } from 'stellar-check';
+import { Networks } from '@stellar/stellar-sdk';
+
+const decoded = importPaymentXdr(unsignedEnvelopeBase64, Networks.TESTNET);
+if (!decoded.ok) {
+  console.error(decoded.code, decoded.message);
+} else {
+  console.log(decoded.payment, decoded.context);
+  // Run after reviewing the decoded payment and selected network:
+  const report = await checkPayment(
+    decoded.payment,
+    new HorizonProvider('https://horizon-testnet.stellar.org'),
+  );
+  console.log(report.status);
+}
+```
+
+The importer accepts canonical base64 with optional whitespace, up to 32,768 input characters. Supported envelopes are unsigned V1 transactions containing one classic payment between distinct G accounts. The transaction source and any explicit operation source must match. Fee stroops become exact XLM decimal strings. Text memos must be lossless UTF-8; ID and hash memos preserve their exact values.
+
+Signed envelopes, fee bumps, legacy V0 envelopes, transaction extensions, extended V2 preconditions, multiple/non-payment operations and unsupported payment shapes are rejected. Ordinary time bounds and sequence numbers appear in import context but are **not assessed**. The selected network is supplied by the caller because XDR does not identify its network. An imported payment report is not transaction validation. Editing the form does not modify or rebuild the original XDR.
+
+Issue cards offer relevant field shortcuts such as **Review amount**, **Edit fee budget** and **Edit memo**, plus copyable asset details for trustline and authorization issues. These controls do not change balances, create trustlines or assume the receiving service's memo.
+
+## Report contract
+
+| Status            | Meaning                                                                                                                               |
+| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
+| `no_known_issues` | All applicable supported checks completed without a diagnosed issue.                                                                  |
+| `issues_found`    | Supported checks found one or more problems; dependent checks for a confirmed missing account are marked not applicable.              |
+| `incomplete`      | Invalid/unsupported input, unavailable observations, malformed data or wrong network prevented assessment. Known issues are retained. |
+
+`incomplete` takes precedence over known issues. Always inspect `status`, not just whether `issues` is empty. Coverage entries distinguish `complete`, `unresolved` and `not_applicable`; a completed check may have found an issue. Each diagnostic contains a stable `code`, affected `party`, explanation and recommended `action`.
+
+Facts are decimal strings with seven fractional digits and are absent when their dependencies are unavailable. `availableXlm` is the maximum nonnegative amount after reserve, native selling liabilities and fee. `requiredXlm` includes reserve, selling liabilities, fee and, for native payments, the amount. `xlmShortfall` includes any deficit below reserve plus fee, even for issued-asset payments. Recipient native capacity is checked against the signed int64 balance bound; issued capacity uses the trustline limit and buying liabilities.
+
+Observation metadata contains provider URL, expected network, per-read timestamps, available `x-last-ledger` observations, and account `last_modified_ledger` values. The account modification ledger is **not** its read ledger. Root/ledger metadata, sender, recipient and SDK memo reads are separate observations. `atomic` is always `false`.
+
+## Scope and limits
+
+Supported: one classic Payment operation, distinct G-address source and destination, native XLM or one issued asset, one transaction/operation source and fee payer. Optional `operationType: 'payment'`, `operationSource` and `feePayer` are accepted only when consistent with that shape. Unknown intent fields are rejected so unsupported transaction features cannot silently disappear.
+
+Unsupported: M-addresses, federation, self-payments, issuer-as-party payments, Soroban/SAC, path payments, swaps, batches, multiple operations, fee bumps and separate sources/fee payers. Address checks use the SDK’s StrKey checksum validation. The checker accepts a payment intent. The separate `importPaymentXdr` helper extracts supported payment values from an unsigned envelope.
+
+Amounts use bigint internally and decimal strings externally. Zero/negative payments, excess precision, exponents and out-of-range amounts are invalid. Current reserve and base-fee values come from Horizon’s latest ledger; no reserve constant is substituted. Inconsistent relevant balances, missing liabilities, missing sponsorship counters and missing authorization never become invented defaults.
+
+The official SDK `checkMemoRequired` performs SEP-29 detection. A supplied memo means **presence only**; no identity check or memo-declaration inference is made. The adapter overrides the SDK’s account loader with the same bounded read transport and maps Horizon’s REST `data` field to the SDK’s `data_attr`. It builds an unsigned, non-submittable inspection container; its dummy sequence/fee are not readiness facts.
+
+State can change immediately after checking. Refresh after edits and immediately before confirmation. Signature validity, sequence handling, transaction timing/preconditions, submission, finality and surge-fee inclusion are outside the report. No production audit or adoption claim is implied.
+
+## Provider and offline usage
+
+```ts
+const provider = new HorizonProvider(url, { timeoutMs: 10_000 });
+```
+
+Each HTTP request, including its response body, has a bounded timeout and uses no-store fetching. No automatic retries occur. Account 404 responses are distinct from transport failures; 429s have a dedicated diagnostic. HTTPS is required by default; `allowHttp: true` explicitly enables local development providers. Provider URLs must not contain credentials, query parameters or fragments.
+
+`PaymentProvider` can be implemented with another public-data adapter; its methods return timestamped `Read<T>` envelopes. Custom implementations are responsible for bounded I/O and faithful network/ledger metadata. The orchestrator preserves rejected or malformed observations as incomplete reports. The payment input is copied before asynchronous reads so caller mutations cannot change the assessed intent midway.
+
+For controlled observations, use `assessPayment(intent, snapshot)` directly. This pure function validates relevant account fields and calculates a report without I/O. Offline snapshots must conform to the exported `Snapshot` type. See [the four fixtures](https://github.com/GautamBytes/stellar-check/blob/main/examples/scenarios.ts) and [fixture coverage](https://github.com/GautamBytes/stellar-check/blob/main/docs/fixtures.md).
+
+## Node and testnet examples
+
+```sh
+# Read a JSON payment intent using current public state:
+HORIZON_URL=https://horizon-testnet.stellar.org npm run example -- /absolute/path/payment.json
+
+# Recheck four scenarios using the included public-account manifest:
+npm run testnet
+# Or supply public accounts you maintain:
+npm run testnet -- /absolute/path/testnet-accounts.json
+```
+
+See [testnet verification](https://github.com/GautamBytes/stellar-check/blob/main/docs/testnet.md) for the manifest requirements and report artifact. The included public accounts can change or disappear at a testnet reset; they are not project-owned fixtures.
+
+## Development
+
+```sh
+npm run typecheck
+npm test
+npm run build
+npm run demo:build
+npm pack --dry-run
+```
+
+`npm run check` runs typechecking, the test suite, the library build and demo production build. Tests run without public network access and use real calculation code and the SDK memo helper with controlled HTTP responses. [Diagnostic meanings](https://github.com/GautamBytes/stellar-check/blob/main/docs/diagnostics.md) and [implementation status](https://github.com/GautamBytes/stellar-check/blob/main/docs/implementation-status.md) describe the current contract and verification.
+
+## References and license
+
+The implementation follows Stellar’s [sponsored reserve accounting](https://developers.stellar.org/docs/build/guides/transactions/sponsored-reserves), [payment operation reference](https://developers.stellar.org/docs/learn/fundamentals/transactions/list-of-operations) and [SEP-29](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0029.md). Memo behavior is verified against the pinned `@stellar/stellar-sdk` dependency, version 17.0.1.
+
+Apache-2.0; see [LICENSE](https://github.com/GautamBytes/stellar-check/blob/main/LICENSE). The official Stellar SDK is an Apache-2.0 dependency. No source from the other proposal-referenced wallet projects was copied. Repository owner: GautamBytes. Any upstream contribution and longer-term maintenance commitments remain to be agreed.

package/dist/amounts.d.ts

@@ -0,0 +1,5 @@
+export declare const SCALE = 10000000n;
+export declare const MAX_AMOUNT = 9223372036854775807n;
+export declare function parseAmount(value: unknown, max?: bigint): bigint;
+export declare function formatAmount(units: bigint): string;
+export declare const positivePart: (units: bigint) => bigint;

package/dist/amounts.js

@@ -0,0 +1,18 @@
+export const SCALE = 10000000n;
+export const MAX_AMOUNT = 9223372036854775807n;
+export function parseAmount(value, max = MAX_AMOUNT) {
+    if (typeof value !== 'string' || value.length > 32 || !/^\d+(\.\d{1,7})?$/.test(value)) {
+        throw new Error('Use a decimal string with at most seven decimal places.');
+    }
+    const [whole = '', fraction = ''] = value.split('.');
+    const units = BigInt(whole) * SCALE + BigInt(fraction.padEnd(7, '0'));
+    if (units > max)
+        throw new Error('Amount exceeds the protocol range.');
+    return units;
+}
+export function formatAmount(units) {
+    const sign = units < 0n ? '-' : '';
+    const positive = units < 0n ? -units : units;
+    return `${sign}${positive / SCALE}.${(positive % SCALE).toString().padStart(7, '0')}`;
+}
+export const positivePart = (units) => (units > 0n ? units : 0n);

package/dist/assess.d.ts

@@ -0,0 +1,2 @@
+import type { Report, Snapshot } from './types.js';
+export declare function assessPayment(input: unknown, snapshot: Snapshot): Report;

package/dist/assess.js

@@ -0,0 +1,205 @@
+import { formatAmount, MAX_AMOUNT, parseAmount, positivePart } from './amounts.js';
+import { isRecord, validateIntent } from './input.js';
+import { parseAccount, validateNetwork } from './state.js';
+const CHECKS = [
+    'input',
+    'network',
+    'source_account',
+    'destination_account',
+    'source_xlm',
+    'source_asset',
+    'destination_capacity',
+    'memo',
+];
+export function assessPayment(input, snapshot) {
+    const validated = validateIntent(input);
+    const report = {
+        status: 'incomplete',
+        issues: [...validated.issues],
+        facts: {},
+        coverage: CHECKS.map((check) => ({
+            check,
+            status: 'unresolved',
+            reason: 'Required input or observation is unavailable.',
+        })),
+        observation: {
+            networkPassphrase: 'payment' in validated ? validated.payment.networkPassphrase : null,
+            reads: [],
+            atomic: false,
+        },
+        limitations: [
+            'Separate reads are not an atomic snapshot. Refresh before confirmation and whenever the payment changes.',
+            'No supported issue found in observed data does not guarantee transaction success.',
+            'Signatures, sequence numbers, submission, finality and surge-fee inclusion are not assessed.',
+            'Memo checks establish a declared requirement or memo presence, never the intended customer’s identity.',
+        ],
+    };
+    function mark(check, status, reason) {
+        report.coverage[CHECKS.indexOf(check)] =
+            reason === undefined ? { check, status } : { check, status, reason };
+    }
+    function issue(code, party, message, action) {
+        report.issues.push({ code, party, message, action });
+    }
+    function read(key, check, observation) {
+        if (!isRecord(observation) ||
+            typeof observation.ok !== 'boolean' ||
+            typeof observation.observedAt !== 'string') {
+            issue('MALFORMED_DATA', 'provider', 'The provider returned a malformed observation.', 'Return complete observation envelopes from the provider.');
+            return;
+        }
+        report.observation.reads.push({
+            check: key,
+            observedAt: observation.observedAt,
+            ...(observation.ok && observation.ledger !== undefined ? { ledger: observation.ledger } : {}),
+        });
+        if (!observation.ok) {
+            issue(observation.code, 'provider', observation.message, 'Refresh public account data or choose an available provider, then check again.');
+            mark(check, 'unresolved', observation.code);
+            return;
+        }
+        if (!Number.isFinite(Date.parse(observation.observedAt)) ||
+            (observation.ledger !== undefined &&
+                (!Number.isSafeInteger(observation.ledger) || observation.ledger <= 0))) {
+            issue('MALFORMED_DATA', 'provider', 'Observation metadata is invalid.', 'Use a provider with complete observation metadata.');
+            return;
+        }
+        return { value: observation.value };
+    }
+    if (!('payment' in validated))
+        return report;
+    mark('input', 'complete');
+    const p = validated.payment;
+    const network = read('network', 'network', snapshot.network);
+    if (!network)
+        return report;
+    let reserve, baseFee;
+    try {
+        ({ reserve, fee: baseFee } = validateNetwork(network.value));
+    }
+    catch (error) {
+        issue('MALFORMED_DATA', 'provider', String(error), 'Use complete, consistent network metadata.');
+        return report;
+    }
+    if (network.value.networkPassphrase !== p.networkPassphrase) {
+        issue('NETWORK_MISMATCH', 'application', 'The provider reports a different network passphrase.', 'Select a Horizon provider for the chosen network.');
+        return report;
+    }
+    mark('network', 'complete');
+    const amount = parseAmount(p.amount), fee = parseAmount(p.feeBudget);
+    report.facts.baseReserve = formatAmount(reserve);
+    report.facts.baseFee = formatAmount(baseFee);
+    report.facts.feeBudget = formatAmount(fee);
+    if (fee < baseFee)
+        issue('FEE_BUDGET_TOO_LOW', 'sender', 'The total fee budget is below the current one-operation base fee.', 'Increase the planned fee budget and check again; inclusion under surge pricing is not guaranteed.');
+    function account(key) {
+        const observation = read(key, `${key}_account`, snapshot[key]);
+        if (!observation)
+            return;
+        if (observation.value === null) {
+            mark(`${key}_account`, 'complete');
+            issue(key === 'source' ? 'SOURCE_ACCOUNT_MISSING' : 'DESTINATION_ACCOUNT_MISSING', key === 'source' ? 'sender' : 'recipient', `The ${key === 'source' ? 'sender' : 'recipient'} account does not exist on this network.`, 'Activate the account through your normal onboarding flow, then check again.');
+            return null;
+        }
+        try {
+            const result = parseAccount(observation.value, p[key], p.asset);
+            const observed = snapshot[key];
+            if (observed.ok &&
+                observed.ledger !== undefined &&
+                result.lastModifiedLedger > observed.ledger)
+                throw new Error('Account modification ledger exceeds the observation ledger.');
+            mark(`${key}_account`, 'complete');
+            if (key === 'source')
+                report.observation.sourceLastModifiedLedger = result.lastModifiedLedger;
+            else
+                report.observation.destinationLastModifiedLedger = result.lastModifiedLedger;
+            return result;
+        }
+        catch (error) {
+            issue('MALFORMED_DATA', 'provider', `${key}: ${String(error)}`, 'Fetch complete, consistent account fields from Horizon.');
+            return;
+        }
+    }
+    const sender = account('source'), recipient = account('destination');
+    if (sender) {
+        const requiredReserve = sender.reserveUnits * reserve;
+        const required = requiredReserve + sender.native.selling + fee + (p.asset.type === 'native' ? amount : 0n);
+        report.facts.sourceReserve = formatAmount(requiredReserve);
+        report.facts.sourceXlmBalance = formatAmount(sender.native.balance);
+        report.facts.nativeSellingLiabilities = formatAmount(sender.native.selling);
+        report.facts.availableXlm = formatAmount(positivePart(sender.native.balance - requiredReserve - sender.native.selling - fee));
+        report.facts.requiredXlm = formatAmount(required);
+        report.facts.xlmShortfall = formatAmount(positivePart(required - sender.native.balance));
+        if (required > sender.native.balance)
+            issue('INSUFFICIENT_XLM', 'sender', 'The sender lacks XLM for the payment, required reserves, selling liabilities and planned fee.', 'Reduce the XLM payment, add XLM, or review reserve entries and open offers, then check again.');
+        mark('source_xlm', 'complete');
+    }
+    else if (sender === null)
+        mark('source_xlm', 'not_applicable', 'Sender account is missing.');
+    if (p.asset.type === 'native') {
+        mark('source_asset', 'not_applicable', 'Native funds are covered by source_xlm.');
+        if (recipient) {
+            const capacity = MAX_AMOUNT - recipient.native.balance - recipient.native.buying;
+            report.facts.receivingCapacity = formatAmount(capacity);
+            if (amount > capacity)
+                issue('DESTINATION_CAPACITY_EXCEEDED', 'recipient', 'This payment exceeds the recipient’s native balance range after buying liabilities.', 'Reduce the amount or ask the recipient to free receiving capacity.');
+            mark('destination_capacity', 'complete');
+        }
+    }
+    else {
+        for (const [state, key, check, party] of [
+            [sender, 'SOURCE', 'source_asset', 'sender'],
+            [recipient, 'DESTINATION', 'destination_capacity', 'recipient'],
+        ]) {
+            if (state === undefined)
+                continue;
+            if (state === null) {
+                mark(check, 'not_applicable', `${party} account is missing.`);
+                continue;
+            }
+            mark(check, 'complete');
+            if (!state.asset) {
+                issue(`${key}_TRUSTLINE_MISSING`, party, `The ${party} has no trustline for this exact asset code and issuer.`, `The ${party} needs to create a trustline for ${p.asset.code} issued by ${p.asset.issuer}.`);
+                continue;
+            }
+            if (!state.asset.authorized)
+                issue(`${key}_NOT_AUTHORIZED`, 'issuer', `The ${party} trustline is not authorized for payments. Authorization to maintain liabilities is insufficient.`, 'Ask the asset issuer to authorize this trustline for transfers.');
+            if (key === 'SOURCE') {
+                const available = positivePart(state.asset.balance - state.asset.selling);
+                report.facts.availableAsset = formatAmount(available);
+                report.facts.assetShortfall = formatAmount(positivePart(amount - available));
+                if (amount > available)
+                    issue('INSUFFICIENT_ASSET', party, 'The amount exceeds asset funds available after selling liabilities.', 'Reduce the amount, add this exact asset, or review open sell offers.');
+            }
+            else {
+                const capacity = state.asset.limit - state.asset.balance - state.asset.buying;
+                report.facts.receivingCapacity = formatAmount(capacity);
+                report.facts.capacityShortfall = formatAmount(positivePart(amount - capacity));
+                if (amount > capacity)
+                    issue('DESTINATION_CAPACITY_EXCEEDED', party, 'The recipient has insufficient trustline capacity after balance and buying liabilities.', 'Ask the recipient to increase their trustline limit, reduce holdings or review buy offers.');
+            }
+        }
+    }
+    if (recipient === null)
+        mark('destination_capacity', 'not_applicable', 'Recipient account is missing.');
+    const memo = read('memo', 'memo', snapshot.memo);
+    if (memo) {
+        if (!memo.value ||
+            !['required', 'present', 'not_required'].includes(memo.value.result) ||
+            (memo.value.result === 'present') !== (p.memo !== undefined)) {
+            issue('MALFORMED_DATA', 'provider', 'Memo observation is missing or inconsistent with the payment.', 'Repeat the SDK memo check for this exact payment.');
+        }
+        else {
+            mark('memo', 'complete');
+            report.facts.memo = memo.value.result === 'present' ? 'presence_only' : memo.value.result;
+            if (memo.value.result === 'required')
+                issue('MEMO_REQUIRED', 'sender', 'The destination declares that a memo is required.', 'Obtain the correct memo from the receiving service and include it.');
+        }
+    }
+    report.status = report.coverage.some((c) => c.status === 'unresolved')
+        ? 'incomplete'
+        : report.issues.length > 0
+            ? 'issues_found'
+            : 'no_known_issues';
+    return report;
+}

package/dist/check.d.ts

@@ -0,0 +1,3 @@
+import type { PaymentProvider, Report } from './types.js';
+/** Fresh observations on every call. An incomplete report may still contain known issues. */
+export declare function checkPayment(input: unknown, provider: PaymentProvider): Promise<Report>;