You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+55Lines changed: 55 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -179,6 +179,61 @@ stellar contract invoke \
179
179
--id <ADDRESS>
180
180
```
181
181
182
+
## 🧪 Local Development with Quickstart
183
+
184
+
If you want to build and test against a local Soroban network, run the Stellar Quickstart container instead of using public testnet services.
185
+
186
+
### Start Quickstart
187
+
188
+
```bash
189
+
docker run -d \
190
+
-p "8000:8000" \
191
+
--name stellar \
192
+
stellar/quickstart \
193
+
--local
194
+
```
195
+
196
+
This starts a local Stellar network with RPC, Horizon, and Friendbot on your machine.
197
+
198
+
### Configure the CLI for the Local Network
199
+
200
+
Register the local network once, then switch the CLI to it:
201
+
202
+
```bash
203
+
stellar network add local \
204
+
--rpc-url http://localhost:8000/rpc \
205
+
--network-passphrase "Test SDF Network ; September 2015"
206
+
207
+
stellar network use local
208
+
```
209
+
210
+
### Generate and Fund Accounts
211
+
212
+
Create a local identity and fund it from the local Friendbot instance:
213
+
214
+
```bash
215
+
stellar keys generate deployer
216
+
stellar keys fund deployer
217
+
```
218
+
219
+
You can use `stellar keys public-key deployer` to print the address, then use that keypair as the source account for contract deploy and invoke commands on the local network.
220
+
221
+
### Point the TypeScript SDK at Quickstart
222
+
223
+
When using `bcForgeClient`, point `rpcUrl` at the local Quickstart instance:
224
+
225
+
```typescript
226
+
import { bcForgeClient } from'@bc-forge/sdk';
227
+
228
+
const client =newbcForgeClient({
229
+
rpcUrl: 'http://localhost:8000',
230
+
networkPassphrase: 'Test SDF Network ; September 2015',
231
+
contractId: 'CABC...XYZ',
232
+
});
233
+
```
234
+
235
+
If your local Quickstart setup exposes RPC on a different path, keep the same host and update the URL to match your container configuration.
0 commit comments