// Use when verifying the full solution works end-to-end — after refactoring, before PRs, or after dependency upgrades. Runs quality pipeline, validates example scripts, and executes live Stellar testnet demos for both charge and channel payment modes.
| name | e2e-check |
| description | Use when verifying the full solution works end-to-end — after refactoring, before PRs, or after dependency upgrades. Runs quality pipeline, validates example scripts, and executes live Stellar testnet demos for both charge and channel payment modes. |
Full end-to-end verification: quality pipeline, example script validation, and live Stellar testnet demos.
Prerequisites: .env file at project root with testnet keys (see examples/.env.*.example), funded Stellar testnet accounts, pnpm installed.
Run all checks in order. Stop on first failure and report.
make check
Runs: install -> format-check -> lint -> typecheck -> test -> build.
Pass: 0 lint errors (warnings OK), all tests pass, build succeeds.
Verify all 6 example scripts start correctly (imports resolve, env parsing works):
for f in examples/charge-server.ts examples/charge-client.ts examples/charge-client-fee-bump.ts examples/channel-server.ts examples/channel-client.ts examples/channel-open.ts examples/channel-close.ts; do
echo "--- $f ---"
timeout 3 npx tsx "$f" 2>&1 | head -3
echo ""
done
Pass criteria per script:
| Script | Expected |
|---|---|
examples/charge-server.ts | Starts Express on port 3000 (pino JSON log) |
examples/charge-client.ts | Loads keypair, starts client |
examples/charge-client-fee-bump.ts | Loads keypair+fee-bump-key, prints account keys, ECONNREFUSED |
examples/channel-server.ts | Starts Express on port 3001 (pino JSON log) |
examples/channel-client.ts | Loads commitment key, starts client |
examples/channel-open.ts | Env validation error: OPEN_TX_XDR is required (expected) |
examples/channel-close.ts | Env validation error: CHANNEL_CONTRACT is required (expected) |
Fail: Any import error, syntax error, or module-not-found error.
Six flows are available by combining client and server env vars. Each requires a running charge server (Terminal 1) and charge client (Terminal 2).
# Unsponsored (flows 1-4): no feePayer env vars needed
PORT=3099 STELLAR_RECIPIENT=G... npx tsx examples/charge-server.ts
# Sponsored, no fee bump (flow 5): set ENVELOPE_SIGNER_SECRET
PORT=3099 STELLAR_RECIPIENT=G... ENVELOPE_SIGNER_SECRET=S... \
npx tsx examples/charge-server.ts
# Sponsored + FeeBump (flow 6): set both signer secrets
PORT=3099 STELLAR_RECIPIENT=G... ENVELOPE_SIGNER_SECRET=S... FEE_BUMP_SIGNER_SECRET=S... \
npx tsx examples/charge-server.ts
# Flow 1: push (no FeeBump)
STELLAR_SECRET=S... SERVER_URL=http://localhost:3099 CHARGE_CLIENT_MODE=push \
npx tsx examples/charge-client.ts
# Flow 2: push + FeeBump
STELLAR_SECRET=S... FEE_BUMP_SECRET=S... SERVER_URL=http://localhost:3099 CHARGE_CLIENT_MODE=push \
npx tsx examples/charge-client-fee-bump.ts
# Flow 3: pull non-sponsored (no FeeBump) [default CHARGE_CLIENT_MODE]
STELLAR_SECRET=S... SERVER_URL=http://localhost:3099 \
npx tsx examples/charge-client.ts
# Flow 4: pull non-sponsored + FeeBump
STELLAR_SECRET=S... FEE_BUMP_SECRET=S... SERVER_URL=http://localhost:3099 \
npx tsx examples/charge-client-fee-bump.ts
# Flow 5: pull sponsored (no FeeBump) — server must have ENVELOPE_SIGNER_SECRET set
STELLAR_SECRET=S... SERVER_URL=http://localhost:3099 \
npx tsx examples/charge-client.ts
# Flow 6: pull sponsored + FeeBump
# NOTE: client invocation is identical to Flow 5 — the difference is ONLY the server config.
# The server's feeBumpSigner wraps the rebuilt tx in FeeBump; no client-side change needed.
STELLAR_SECRET=S... SERVER_URL=http://localhost:3099 \
npx tsx examples/charge-client.ts
Pass: Each client prints --- Response (200) --- with paid content JSON.
source .env
STELLAR_RECIPIENT="$STELLAR_RECIPIENT" STELLAR_SECRET="$STELLAR_SECRET" timeout 15 ./demo/run.sh
Expected flow:
Pass: Client prints --- Response (200) --- with paid content JSON.
source .env
CHANNEL_CONTRACT="$CHANNEL_CONTRACT" COMMITMENT_PUBKEY="$COMMITMENT_PUBKEY" COMMITMENT_SECRET="$COMMITMENT_SECRET" timeout 15 ./demo/run-channel.sh
Expected flow:
Pass: Both requests return 200. Cumulative amount grows between requests.
Requires the compiled one-way-channel WASM from https://github.com/stellar-experimental/one-way-channel.
WASM_PATH=/Users/marcelosantos/Workspace/one-way-channel/target/wasm32v1-none/release/channel.wasm \
timeout 60 ./demo/run-channel-e2e.sh
Full lifecycle: deploy contract -> 2 off-chain payments -> on-chain close -> balance verified at 0.
Expected flow:
Pass: Script completes with Channel balance after close: 0 and exit code 0.
Every PR must add a line to CHANGELOG.md under the ## [Unreleased] heading. Each entry must link to its PR using the format:
- Description of the change [#PR_NUMBER](https://github.com/stellar/stellar-mpp-sdk/pull/PR_NUMBER)
Pass: The diff includes a CHANGELOG.md addition with a PR link in the correct format.
Fail: No CHANGELOG entry, or entry missing the [#N](url) PR link.
After running all checks, report:
| # | Check | Status | Notes |
|---|---|---|---|
| 1 | make check (full pipeline) | PASS/FAIL | test count, any errors |
| 2a | Example scripts (7 scripts) | PASS/FAIL | which scripts failed |
| 2b-1 | Charge: push, no FeeBump | PASS/FAIL | 200 or error |
| 2b-2 | Charge: push + FeeBump | PASS/FAIL | 200 or error |
| 2b-3 | Charge: pull unsponsored | PASS/FAIL | 200 or error |
| 2b-4 | Charge: pull unsponsored + FeeBump | PASS/FAIL | 200 or error |
| 2b-5 | Charge: pull sponsored | PASS/FAIL | 200 or error |
| 2b-6 | Charge: pull sponsored + FeeBump | PASS/FAIL | 200 or error |
| 3 | Charge E2E (demo/run.sh) | PASS/FAIL | final HTTP status |
| 4 | Channel E2E (demo/run-channel.sh) | PASS/FAIL | request count, cumulative amounts |
| 5 | Channel E2E settlement (demo/run-channel-e2e.sh) | PASS/FAIL | balance after close. ATTENTION: this is explained in Check 5 |
| 6 | CHANGELOG entry | PASS/FAIL | PR link present |