Skip to content

Commit 079e7e8

Browse files
authored
readme updates and env file clarification (#219)
Signed-off-by: nadinedelia <[email protected]>
1 parent 7e9e417 commit 079e7e8

File tree

2 files changed

+16
-11
lines changed

2 files changed

+16
-11
lines changed

.env.example

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
OPERATOR_ID=<YOUR_OPERATOR_ID>
2-
OPERATOR_KEY=<YOUR_PRIVATE_KEY>
3-
RECIPIENT_ID=<RECIPIENT_ID>
4-
RECIPIENT_KEY=<RECIPIENT_KEY>
5-
ADMIN_KEY=<ADMIN_KEY>
6-
TOKEN_ID=<TOKEN_ID>
7-
TOKEN_NAME=<TOKEN_NAME>
8-
TOKEN_SYMBOL=<TOKEN_SYMBOL>
9-
TOPIC_ID=<TOPIC_ID>
10-
NETWORK=<NETWORK>
1+
OPERATOR_ID=<YOUR_OPERATOR_ID> #your private key, can be retrived from https://portal.hedera.com/dashboard
2+
OPERATOR_KEY=<YOUR_PRIVATE_KEY> # your account id, can be retrieved from https://portal.hedera.com/dashboard
3+
NETWORK=<NETWORK> #eg testnet/previewnet/mainnet
4+
5+
# RECIPIENT_ID=<RECIPIENT_ID> #optional
6+
# RECIPIENT_KEY=<RECIPIENT_KEY> #optional
7+
# ADMIN_KEY=<ADMIN_KEY> #optional
8+
# TOKEN_ID=<TOKEN_ID> #optional
9+
# TOKEN_NAME=<TOKEN_NAME> #optional
10+
# TOKEN_SYMBOL=<TOKEN_SYMBOL> #optional
11+
# TOPIC_ID=<TOPIC_ID> #optional

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,16 +100,20 @@ Create a .env file in the root of your project with the following (replace with
100100
```
101101
OPERATOR_ID=0.0.1234xx
102102
OPERATOR_KEY=af20e47d590300506032b657004220420...
103+
NETWORK=testnet
104+
105+
# optional:
103106
ADMIN_KEY=af20e47d59032b65700321009308ecfdf...
104107
SUPPLY_KEY =302a300506032b6570032100c5e4af5..."
105108
FREEZE_KEY=302a300306072b65700321009308ecfdf...
106109
RECIPIENT_ID=0.0.789xx
107110
TOKEN_ID=0.0.100xx
108111
TOPIC_ID=0.0.200xx
109112
FREEZE_ACCOUNT_ID=0.0.100
110-
NETWORK=testnet
111113
```
112114

115+
The only environment variables needed are OPERATOR_ID, OPERATOR_KEY and NETWORK. The rest is optional (if customisation of the example scripts is needed).
116+
113117
A [sample .env](.env.example) file is provided in the root of this project. If you do not have an account on
114118
the Hedera testnet, you can easily get one from the [Hedera Portal](https://portal.hedera.com/). Learn more about
115119
testnet [here](https://docs.hedera.com/guides/testnet).

0 commit comments

Comments
 (0)