Skip to content

Commit 05d4085

Browse files
committed
Add requirements
1 parent a6933d4 commit 05d4085

File tree

3 files changed

+23
-6
lines changed

3 files changed

+23
-6
lines changed

docs/documentation/act.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,19 @@ Updating the grantees list to remove a public key ***will not revoke access*** t
1919
Likewise, re-uploading the content using the new grantees list will also ***not retroactively revoke access*** to the content.
2020
:::
2121

22+
## Requirements
23+
The use of ACT requires the following:
24+
25+
* A Bee light node running on with synced postage batch data. (Running at `http://localhost:1633` by default)
26+
* A valid postage batch ID. [Buy one](/docs/storage/#purchasing-storage) if needed.
27+
* Public keys of the nodes you want to grant access to.
28+
* The **public key of the publishing node**. This can be obtained using the [`bee.getNodeAddresses()` method](/docs/status/#3-get-node-addresses).
29+
2230
## Create Grantees List
2331

2432
First we create a grantees list with the public keys of anyone we want to grant access to.
2533

26-
### Example Script
34+
#### Example Script:
2735

2836
The example script below performs the following key operations:
2937

@@ -98,7 +106,7 @@ bee.patchGrantees(postageBatchId, ref, historyref, {
98106

99107
Calling this method returns the new list’s updated `ref` and `historyref`, which you should use for future updates or access.
100108

101-
### Example Script
109+
#### Example Script:
102110

103111
The example script below performs the following key steps:
104112

@@ -167,7 +175,7 @@ In order to view the members of our grantees list we need to use the 64 byte `re
167175
The grantee list is encrypted, and only the owner can view the grantee list, make sure to use the owner node when using the `bee.getGrantees()` method.
168176
:::
169177

170-
### Example Script
178+
#### Example Script:
171179

172180
The example script below performs the following operations:
173181

@@ -236,7 +244,7 @@ The first list of grantees contains the first public key we gave access to when
236244

237245
We can upload our content with either of the two lists we created depending on which set of users we wish to give access too. In the example below, we use both lists.
238246

239-
### Example Script
247+
#### Example Script:
240248

241249
The example script below performs the following operations:
242250

@@ -307,7 +315,7 @@ You can choose which `historyref` to share depending on which set of public keys
307315

308316
In order to download using ACT, we must pass in the public key from the grantee list creator along with the file reference and history reference returned from the file upload operation:
309317

310-
### Example Script
318+
#### Example Script:
311319

312320
The example script below performs the following operations:
313321

docs/documentation/gsoc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_label: GSOC
66
---
77

88

9-
The GSOC (Graffiti Several Owner Chunk) feature allows a **full node** to receive messages from many other nodes using a shared Single Owner Chunk (SOC). This enables real-time communication and notification over Swarm.
9+
The GSOC (Graffiti Several Owner Chunk) feature allows a **full node** to receive messages from many other nodes using a shared Single Owner Chunk (SOC). This enables real-time messaging over Swarm.
1010

1111
## Overview
1212

docs/documentation/soc-and-feeds.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,15 @@ Swarm provides the ability to store content in content-addressed [chunks](https:
1313

1414
Feeds are a unique feature of Swarm which simulate the publishing of mutable content on Swarm's immutable storage. ***Feeds constitute the primary use case for SOCs.*** Developers can use Feeds to version revisions of a mutable resource by indexing sequential updates to a topic at predictably calculated addresses. Because Feeds are built on top of SOCs, their interfaces are somewhat similar and use common concepts.
1515

16+
17+
## Requirements
18+
19+
Interactions with SOC and feeds requires the following:
20+
21+
* A fully initialized Bee light node running with fully synced postage batch data. (Running at `http://localhost:1633` by default)
22+
* A valid postage batch ID.
23+
* An Ethereum-compatible private key to sign updates. Using your node or blockchain account wallet's private key is strongly discouraged. Using a dedicated key for SOC / feeds is recommended.
24+
1625
## Single Owner Chunks
1726

1827
Bee-js calculates a SOC Swarm reference hash as the keccak256 hash of the concatenation of the `identifier` and `owner` Ethereum address. The `identifier` is a 32 byte long arbitrary value (by default a hex string or a `Uint8Array`). The `owner` is an Ethereum address that consists of 20 bytes in a format of a hex string or `Uint8Array`.

0 commit comments

Comments
 (0)