@secondlayer/sdk 6.9.0 → 6.9.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -27,6 +27,13 @@ require an `sk-sl_` API key, created in the platform console at
|
|
|
27
27
|
https://secondlayer.tools/platform/api-keys. (Public Streams bulk dumps —
|
|
28
28
|
`client.dumps`, `events.replay` — need no key.)
|
|
29
29
|
|
|
30
|
+
**API keys.** Each `sk-sl_` key has a `product`. An **`account`** key (dashboard
|
|
31
|
+
default) grants both `streams:read` and `index:read` and is the only key that can
|
|
32
|
+
mint new keys; **`streams`** / **`index`** keys are scoped, read-only, and cannot
|
|
33
|
+
mint. Mint scoped keys programmatically with `sl.apiKeys.create({ product })`
|
|
34
|
+
(needs an account/owner key) — the returned `key` is shown once and inherits your
|
|
35
|
+
plan's tier.
|
|
36
|
+
|
|
30
37
|
## Mental model
|
|
31
38
|
|
|
32
39
|
- `sl.streams` reads raw ordered L1 events from Stacks Streams.
|