Skip to content

Commit 55a8f85

Browse files
authored
[xc-admin] add README to xc_admin_cli (#614)
1 parent 66a3856 commit 55a8f85

File tree

1 file changed

+33
-0
lines changed
  • governance/xc_admin/packages/xc_admin_cli

1 file changed

+33
-0
lines changed
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Pyth Cross-chain Governance Admin CLI Program
2+
3+
The goal of this CLI is interacting with the Pyth Squads multisig.
4+
It allows to :
5+
6+
- Make proposals :
7+
- `accept-authority`
8+
- `upgrade-program`
9+
- `init-price`
10+
- `propose-token-transfer`
11+
- Interact with proposals :
12+
- `approve`
13+
- `activate`
14+
- Inspect proposals :
15+
- `parse-transaction`
16+
17+
## Usage
18+
19+
Note:
20+
21+
- When using with Ledger, please enable [blind signing](https://www.ledger.com/academy/enable-blind-signing-why-when-and-how-to-stay-safe) in the Solana app settings. TLDR: When you enable blind signing, you enable your device to approve a smart contract transaction, even though it hasn’t been able to display full contract data to you. In other words, you’re agreeing to trust, instead of verify, the transaction. You still have to manually approve each transactions.
22+
- Information about ledger derivation can be found [here](https://github.com/LedgerHQ/ledger-live-common/blob/master/docs/derivation.md).
23+
24+
### Example
25+
26+
To activate a transaction:
27+
28+
```
29+
npm install
30+
npx lerna run build --scope "xc_admin_common"
31+
npx ts-node src/index.ts activate -t <TRANSACTION_HASH> -c <CLUSTER: [mainnet|devnet|testnet|pythnet|pythtest]> -v <VAULT_ADDRESS> -w <WALLET_SECRET_KEY_FILEPATH: [filepath|"ledger"]> -lda <LEDGER_DERIVATION_ACCOUNT> -ldc <LEDGER_DERIVATION_CHANGE>
32+
33+
```

0 commit comments

Comments
 (0)