Skip to content

Commit 558da0b

Browse files
piyalbasuclaude
andcommitted
Rewrite introduction and add Stellar Wallets Kit integration
- Rewrote README.md with What You Can Build, How It Works, and Why Freighter sections to walk developers through the integration experience without code samples - Added Stellar Wallets Kit (stellarwalletskit.dev) to the Introduction and Integrations page for multi-wallet support Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent a01ff40 commit 558da0b

2 files changed

Lines changed: 32 additions & 1 deletion

File tree

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,32 @@
11
# Welcome to Freighter
22

3-
Freighter is a non-custodial wallet for the Stellar network. It lets you manage accounts, sign transactions, and interact with Soroban smart contracts from both the browser extension and the mobile app.
3+
Freighter is a non-custodial wallet for the Stellar network, available as a browser extension and a mobile app. This guide will walk you through integrating Freighter into your dapp so your users can connect their wallets, sign transactions, and interact with Soroban smart contracts — all without you ever touching a private key.
4+
5+
## What You Can Build
6+
7+
With Freighter, your dapp can connect a user's wallet with a single call — no signup form, no password, just a familiar wallet popup and an immediate public key. From there you can read their active network, hand off transactions for signing, and submit to the network. The user reviews everything in the wallet's own UI and stays in full control.
8+
9+
For Soroban dapps, Freighter also handles authorization entry signing for smart contract calls and arbitrary message signing for account verification.
10+
11+
## How It Works
12+
13+
The integration model is simple: your dapp talks to the wallet, and the wallet talks to the user. You never handle private keys, seed phrases, or encryption. Freighter manages all of that on the user's device.
14+
15+
For **desktop browsers**, you integrate with the Freighter extension through a lightweight JavaScript library. It injects itself into the page, and your dapp calls methods like "is the wallet connected?", "what's the user's address?", and "please sign this transaction." Every sensitive action goes through the extension's UI where the user has full visibility and control.
16+
17+
For **mobile**, the integration works over WalletConnect v2. Your dapp generates a connection URI, the user scans a QR code with Freighter Mobile, and a secure relay session is established. From that point on, signing requests flow through the same pattern — your dapp proposes, the user reviews and approves in the wallet.
18+
19+
Both paths produce the same output: signed transactions you can submit to the Stellar network. So your backend and submission logic stay the same regardless of whether your user connected from a laptop or a phone.
20+
21+
If you want to support multiple Stellar wallets — not just Freighter — take a look at [Stellar Wallets Kit](https://stellarwalletskit.dev/). It provides a unified interface across Stellar wallets so your users can connect with whichever wallet they prefer.
22+
23+
## Why Freighter
24+
25+
**Your users stay in control.** Every transaction, every signature, every connection is explicitly approved by the user in the wallet's own interface. There's no ambient access, no silent signing, and no stored sessions that persist beyond what the user expects.
26+
27+
**You ship faster.** The API surface is small and intentional. Connecting a wallet, signing a transaction, and reading account data each take one function call. There's no complex state machine to manage, no WebSocket lifecycle to babysit, and no cryptography to implement yourself.
28+
29+
**It works where your users are.** Desktop users get the browser extension experience they're used to from other ecosystems. Mobile users get QR-code-based WalletConnect flows that feel native. You can support both from the same dapp with minimal branching.
430

531
## Choose Your Integration
632

integrations/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,14 @@
22

33
Freighter connects to third-party services to provide a better user experience. As an open source project, we document these integrations so other wallet developers can adopt similar patterns.
44

5+
## Multi-Wallet Support
6+
7+
If your dapp needs to support multiple Stellar wallets beyond Freighter, [Stellar Wallets Kit](https://stellarwalletskit.dev/) provides a unified interface for connecting to any Stellar wallet. It handles wallet detection, connection, and signing through a single API, so your users can choose whichever wallet they prefer.
8+
59
## Available Integrations
610

711
| Integration | Description |
812
| --- | --- |
13+
| [Stellar Wallets Kit](https://stellarwalletskit.dev/) | Unified multi-wallet interface for Stellar dapps |
914
| [Soroswap](https://github.com/stellar/freighter/blob/master/extension/INTEGRATING_SOROSWAP.MD) | DEX integration for token swaps |
1015
| [Hardware Wallets](https://github.com/stellar/freighter/blob/master/extension/INTEGRATING_HARDWARE_WALLET.MD) | Ledger and other hardware wallet support |

0 commit comments

Comments
 (0)