Skip to content

Commit 686f136

Browse files
shrimalmadhurshrimalmadhur
committed
add readme
1 parent 7033830 commit 686f136

File tree

3 files changed

+79
-3
lines changed

3 files changed

+79
-3
lines changed

‎pkg/operator/allocations/README.md‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
## Allocations Command
2+
### Initialize Delay
3+
```bash
4+
eigenlayer operator allocations initialize-delay --help
5+
NAME:
6+
eigenlayer operator allocations initialize-delay - Initialize the allocation delay for operator
7+
8+
USAGE:
9+
initialize-delay [flags] <delay>
10+
11+
DESCRIPTION:
12+
Initializes the allocation delay for operator. This is a one time command. You can not change the allocation delay once
13+
14+
OPTIONS:
15+
--broadcast, -b Use this flag to broadcast the transaction (default: false) [$BROADCAST]
16+
--ecdsa-private-key value, -e value ECDSA private key hex to send transaction [$ECDSA_PRIVATE_KEY]
17+
--environment value, --env value environment to use. Currently supports 'preprod' ,'testnet' and 'prod'. If not provided, it will be inferred based on network [$ENVIRONMENT]
18+
--eth-rpc-url value, -r value URL of the Ethereum RPC [$ETH_RPC_URL]
19+
--fireblocks-api-key value, --ff value Fireblocks API key [$FIREBLOCKS_API_KEY]
20+
--fireblocks-aws-region value, --fa value AWS region if secret is stored in AWS KMS (default: "us-east-1") [$FIREBLOCKS_AWS_REGION]
21+
--fireblocks-base-url value, --fb value Fireblocks base URL [$FIREBLOCKS_BASE_URL]
22+
--fireblocks-secret-key value, --fs value Fireblocks secret key. If you are using AWS Secret Manager, this should be the secret name. [$FIREBLOCKS_SECRET_KEY]
23+
--fireblocks-secret-storage-type value, --fst value Fireblocks secret storage type. Supported values are 'plaintext' and 'aws_secret_manager' [$FIREBLOCKS_SECRET_STORAGE_TYPE]
24+
--fireblocks-timeout value, --ft value Fireblocks timeout (default: 30) [$FIREBLOCKS_TIMEOUT]
25+
--fireblocks-vault-account-name value, --fv value Fireblocks vault account name [$FIREBLOCKS_VAULT_ACCOUNT_NAME]
26+
--network value, -n value Network to use. Currently supports 'holesky' and 'mainnet' (default: "holesky") [$NETWORK]
27+
--operator-address value, --oa value, --operator value Operator address [$OPERATOR_ADDRESS]
28+
--output-file value, -o value Output file to write the data [$OUTPUT_FILE]
29+
--output-type value, --ot value Output format of the command. One of 'pretty', 'json' or 'calldata' (default: "pretty") [$OUTPUT_TYPE]
30+
--path-to-key-store value, -k value Path to the key store used to send transactions [$PATH_TO_KEY_STORE]
31+
--verbose, -v Enable verbose logging (default: false) [$VERBOSE]
32+
--web3signer-url value, -w value URL of the Web3Signer [$WEB3SIGNER_URL]
33+
--help, -h show help
34+
```
35+
36+
### Update allocations
37+
```bash
38+
eigenlayer operator allocations update --help
39+
NAME:
40+
eigenlayer operator allocations update - Update allocations
41+
42+
USAGE:
43+
update
44+
45+
DESCRIPTION:
46+
47+
Command to update allocations
48+
49+
50+
OPTIONS:
51+
--avs-address value, --aa value AVS addresses [$AVS_ADDRESS]
52+
--bips-to-allocate value, --bta value, --bips value, --bps value Bips to allocate to the strategy (default: 0) [$BIPS_TO_ALLOCATE]
53+
--broadcast, -b Use this flag to broadcast the transaction (default: false) [$BROADCAST]
54+
--csv-file value, --csv value CSV file to read data from [$CSV_FILE]
55+
--ecdsa-private-key value, -e value ECDSA private key hex to send transaction [$ECDSA_PRIVATE_KEY]
56+
--environment value, --env value environment to use. Currently supports 'preprod' ,'testnet' and 'prod'. If not provided, it will be inferred based on network [$ENVIRONMENT]
57+
--eth-rpc-url value, -r value URL of the Ethereum RPC [$ETH_RPC_URL]
58+
--fireblocks-api-key value, --ff value Fireblocks API key [$FIREBLOCKS_API_KEY]
59+
--fireblocks-aws-region value, --fa value AWS region if secret is stored in AWS KMS (default: "us-east-1") [$FIREBLOCKS_AWS_REGION]
60+
--fireblocks-base-url value, --fb value Fireblocks base URL [$FIREBLOCKS_BASE_URL]
61+
--fireblocks-secret-key value, --fs value Fireblocks secret key. If you are using AWS Secret Manager, this should be the secret name. [$FIREBLOCKS_SECRET_KEY]
62+
--fireblocks-secret-storage-type value, --fst value Fireblocks secret storage type. Supported values are 'plaintext' and 'aws_secret_manager' [$FIREBLOCKS_SECRET_STORAGE_TYPE]
63+
--fireblocks-timeout value, --ft value Fireblocks timeout (default: 30) [$FIREBLOCKS_TIMEOUT]
64+
--fireblocks-vault-account-name value, --fv value Fireblocks vault account name [$FIREBLOCKS_VAULT_ACCOUNT_NAME]
65+
--network value, -n value Network to use. Currently supports 'holesky' and 'mainnet' (default: "holesky") [$NETWORK]
66+
--operator-address value, --oa value, --operator value Operator address [$OPERATOR_ADDRESS]
67+
--operator-set-id value, --osid value Operator set ID (default: 0) [$OPERATOR_SET_ID]
68+
--output-file value, -o value Output file to write the data [$OUTPUT_FILE]
69+
--output-type value, --ot value Output format of the command. One of 'pretty', 'json' or 'calldata' (default: "pretty") [$OUTPUT_TYPE]
70+
--path-to-key-store value, -k value Path to the key store used to send transactions [$PATH_TO_KEY_STORE]
71+
--strategy-address value, --sa value Strategy addresses [$STRATEGY_ADDRESS]
72+
--verbose, -v Enable verbose logging (default: false) [$VERBOSE]
73+
--web3signer-url value, -w value URL of the Web3Signer [$WEB3SIGNER_URL]
74+
--help, -h show help
75+
```

‎pkg/operator/allocations/flags.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ import "github.com/urfave/cli/v2"
44

55
var (
66
BipsToAllocateFlag = cli.Uint64Flag{
7-
Name: "Bips-to-allocate",
8-
Aliases: []string{"bta", "Bips", "bps"},
7+
Name: "bips-to-allocate",
8+
Aliases: []string{"bta", "bips", "bps"},
99
Usage: "Bips to allocate to the strategy",
1010
EnvVars: []string{"BIPS_TO_ALLOCATE"},
1111
}

‎pkg/operator/allocations/update.go‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,8 @@ func updateAllocations(cCtx *cli.Context, p utils.Prompter) error {
153153
allocationsToUpdate.Allocations,
154154
contractIAVSDirectory.ISignatureUtilsSignatureWithSaltAndExpiry{
155155
Expiry: big.NewInt(0),
156-
})
156+
},
157+
)
157158
if err != nil {
158159
return eigenSdkUtils.WrapError("failed to create unsigned tx", err)
159160
}

0 commit comments

Comments
 (0)