Skip to content

Commit 99285df

Browse files
committed
docs: improve readme
1 parent 25376ee commit 99285df

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

scripts/web2/README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
1-
# Ignite Proxy API Key Decryption example
1+
# Obtaining Web2Json Ignite Source API Key
22

3-
This is a sample script demonstrating how to obtain your Ignite proxy API key.
3+
API keys for the Ignite proxy are issued separately to each registered data provider.
4+
Each key is encrypted with that provider's signing policy public key and then published as part of a global list at: https://api.ignitemarket.xyz/proxy-api-keys
5+
6+
The steps below show how to decrypt and obtain your own provider's API key.
47

58
## Setup
69

7-
From the project root:
10+
From the project root run:
811

912
```bash
1013
yarn install
@@ -18,7 +21,7 @@ PRIVATE_KEY=0x...
1821

1922
- `PRIVATE_KEY`: your provider's signing policy private key in hex format.
2023

21-
## Step 1: Fetch encrypted keys list
24+
## Step 1: Fetch encrypted keys
2225

2326
From `scripts/web2/`, run:
2427

0 commit comments

Comments
 (0)