Skip to content

Commit 4896bfb

Browse files
committed
feat: add faucet wallet generation instructions to README
1 parent b980db7 commit 4896bfb

File tree

1 file changed

+64
-1
lines changed

1 file changed

+64
-1
lines changed

tests/govtool-frontend/playwright/README.md

Lines changed: 64 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,13 +77,76 @@ npx playwright install
7777
3. Navigate to **API Keys**.
7878
4. Click to **Generate API Key**.
7979

80+
---
81+
82+
## 🔧 Faucet wallet Configuration
83+
84+
This section guides you through generating a Cardano faucet wallet and configuring it for use. Follow the steps below to create and set the config on env
85+
86+
### Step 1: Generate a Faucet Wallet
87+
88+
Run the following command to generate a new faucet wallet:
89+
90+
```bash
91+
npm run generate-faucet-wallet
92+
```
93+
94+
The script will:
95+
- Display the wallet details (payment private key, stake public key hash, and wallet address) in the terminal.
96+
97+
**Example Output:**
98+
```
99+
🎉 Wallet generated successfully!
100+
-----------------------------------
101+
🔑 Payment Private Key: <your-payment-private-key>
102+
🔗 Stake Public Key Hash: <your-stake-pkh>
103+
🏠 Wallet Address: <your-wallet-address>
104+
-----------------------------------
105+
106+
📋 Please copy the following to your environment variables:
107+
1. Set FAUCET_PAYMENT_PRIVATE=<your-payment-private-key>
108+
2. Set FAUCET_STAKE_PKH=<your-stake-pkh>
109+
3. Set FAUCET_ADDRESS=<your-wallet-address>
110+
111+
🎈 All done! Have fun with your new wallet!
112+
```
113+
114+
### Step 2: Configure Environment Variables
115+
116+
Securely store the generated wallet details in your environment variables. Add the following to your `.env` file or environment configuration:
117+
118+
```env
119+
FAUCET_PAYMENT_PRIVATE=<your-payment-private-key>
120+
FAUCET_STAKE_PKH=<your-stake-pkh>
121+
FAUCET_ADDRESS=<your-wallet-address>
122+
```
123+
124+
⚠️ **Security Note**: Store your wallet details in a secure location for future use. The payment private key is sensitive and must be protected to prevent unauthorized access to your funds.
125+
126+
### Step 3: Fund the Wallet
127+
128+
Ensure the wallet address has sufficient funds for your test runs. The required balance depends on the specific tests you plan to execute (refer to the test-specific test run details below).
129+
130+
To check the wallet balance, visit:
131+
132+
```
133+
https://${network}.cardanoscan.io/address/<your-wallet-address>
134+
```
135+
136+
Replace `${network}` with the appropriate Cardano network (e.g.`preprod`, or `preview`) and `<your-wallet-address>` with the generated address.
137+
138+
**Example**:
139+
- For a preview wallet: `https://preview.cardanoscan.io/address/<your-wallet-address>`
140+
- Monitor the balance to ensure it meets the requirements for individual or all test runs.
141+
142+
80143
---
81144

82145
## 🧪 Running Tests
83146

84147
### 🔑 Generate Test Wallets
85148

86-
Before each test run, generate fresh test wallets to avoid conflicts:
149+
Before each test run, generate test wallets which is required for wallet dependent test:
87150

88151
```bash
89152
npm run generate-wallets

0 commit comments

Comments
 (0)