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
@@ -392,3 +392,58 @@ Returns the amount of pegout collateral locked by a liquidity provider \* addr:
392
392
#### Return value
393
393
394
394
The amount of locked collateral for pegout operations
395
+
396
+
## Development & Deployment
397
+
398
+
### Foundry & Makefile
399
+
400
+
This project uses **Foundry** for smart contract development and deployment. We provide a comprehensive Makefile for easy deployment across different networks.
401
+
402
+
#### Quick Start
403
+
404
+
```bash
405
+
# Setup environment
406
+
cp example.env .env
407
+
make install
408
+
make build
409
+
410
+
# Test deployment (simulation)
411
+
make deploy-lbc NETWORK=testnet
412
+
413
+
# Actual deployment
414
+
make deploy-lbc-broadcast NETWORK=testnet
415
+
```
416
+
417
+
#### Documentation
418
+
419
+
-**[Complete Guide](./docs/FOUNDRY_MAKEFILE_GUIDE.md)** - Comprehensive documentation for Foundry and Makefile usage
420
+
421
+
#### Key Features
422
+
423
+
-**Multi-network support**: Mainnet, Testnet, Dev environments
424
+
-**Fork testing**: Test against forked networks
425
+
-**Safety validation**: Environment checks and mainnet confirmations
426
+
-**Simulation vs Deployment**: Separate commands for testing and actual deployment
427
+
428
+
#### Common Commands
429
+
430
+
```bash
431
+
# Deployment
432
+
make deploy-lbc NETWORK=testnet # Simulation
433
+
make deploy-lbc-broadcast NETWORK=testnet # Actual deployment
434
+
435
+
# Upgrades
436
+
make upgrade-lbc NETWORK=testnet # Simulation
437
+
make upgrade-lbc-broadcast NETWORK=testnet # Actual upgrade
438
+
439
+
# Fork testing
440
+
make testnet-fork-deploy # Testnet fork simulation
441
+
make testnet-fork-deploy-broadcast # Testnet fork actual deployment
442
+
443
+
# Utilities
444
+
make get-versions # Get contract versions
445
+
make check-env NETWORK=testnet # Environment validation
446
+
make help# Show all commands
447
+
```
448
+
449
+
For detailed usage instructions, see the [Foundry & Makefile Guide](./docs/FOUNDRY_MAKEFILE_GUIDE.md).
0 commit comments