Skip to content

Commit 5a69f37

Browse files
authored
Merge branch 'main' into feature/batch-mint-issue-12
2 parents 3fc9dfc + e7f4f3d commit 5a69f37

4 files changed

Lines changed: 465 additions & 50 deletions

File tree

.github/workflows/ci.yml

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,23 @@ jobs:
2424
targets: wasm32-unknown-unknown
2525
components: rustfmt, clippy
2626

27-
- name: Cache Cargo registry
27+
- name: Cache Cargo dependencies
2828
uses: actions/cache@v4
2929
with:
3030
path: |
3131
~/.cargo/registry
3232
~/.cargo/git
33-
target
34-
key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
33+
key: ${{ runner.os }}-cargo-deps-${{ hashFiles('Cargo.lock') }}
34+
restore-keys: |
35+
${{ runner.os }}-cargo-deps-
36+
37+
- name: Cache Cargo target
38+
uses: actions/cache@v4
39+
with:
40+
path: target
41+
key: ${{ runner.os }}-cargo-target-${{ hashFiles('Cargo.lock') }}-stable
42+
restore-keys: |
43+
${{ runner.os }}-cargo-target-
3544
3645
- name: Check formatting
3746
run: cargo fmt --all -- --check

README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,61 @@ stellar contract invoke \
179179
--id <ADDRESS>
180180
```
181181

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 = new bcForgeClient({
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.
236+
182237
## 📦 SDK Usage
183238

184239
```typescript

0 commit comments

Comments
 (0)