From f1e86ad9cf0470051b7106ee83794d27276b528d Mon Sep 17 00:00:00 2001 From: Javier Peletier Date: Sat, 29 Sep 2018 01:00:28 +0200 Subject: swarm/storage/mru: Renamed all identifiers to Feeds --- swarm/storage/mru/doc.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'swarm/storage/mru/doc.go') diff --git a/swarm/storage/mru/doc.go b/swarm/storage/mru/doc.go index 19330e0c1..a9ea2076c 100644 --- a/swarm/storage/mru/doc.go +++ b/swarm/storage/mru/doc.go @@ -1,5 +1,5 @@ /* -Package mru defines Mutable resource updates. +Package feeds defines Swarm Feeds. A Mutable Resource is an entity which allows updates to a resource without resorting to ENS on each update. -- cgit v1.2.3 From b35622cf3c758d96874f287d137725946fc6341d Mon Sep 17 00:00:00 2001 From: Javier Peletier Date: Sun, 30 Sep 2018 07:48:49 +0200 Subject: swarm/storage/mru: Renamed all comments to Feeds --- swarm/storage/mru/doc.go | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) (limited to 'swarm/storage/mru/doc.go') diff --git a/swarm/storage/mru/doc.go b/swarm/storage/mru/doc.go index a9ea2076c..2cf2d3757 100644 --- a/swarm/storage/mru/doc.go +++ b/swarm/storage/mru/doc.go @@ -1,43 +1,42 @@ /* Package feeds defines Swarm Feeds. -A Mutable Resource is an entity which allows updates to a resource +Swarm Feeds allows a user to build an update feed about a particular topic without resorting to ENS on each update. The update scheme is built on swarm chunks with chunk keys following a predictable, versionable pattern. -A Resource is tied to a unique identifier that is deterministically generated out of +A Feed is tied to a unique identifier that is deterministically generated out of the chosen topic. -A Resource View is defined as a specific user's point of view about a particular resource. -Thus, a View is a Topic + the user's address (userAddr) +A Feed is defined as the series of updates of a specific user about a particular topic Actual data updates are also made in the form of swarm chunks. The keys of the updates are the hash of a concatenation of properties as follows: -updateAddr = H(View, Epoch ID) +updateAddr = H(Feed, Epoch ID) where H is the SHA3 hash function -View is the combination of Topic and the user address +Feed is the combination of Topic and the user address Epoch ID is a time slot. See the lookup package for more information. -A user looking up a resource would only need to know the View in order to -another user's updates +A user looking up a the latest update in a Feed only needs to know the Topic +and the other user's address. -The resource update data is: -resourcedata = View|Epoch|data +The Feed Update data is: +updatedata = Feed|Epoch|data -the full update data that goes in the chunk payload is: +The full update data that goes in the chunk payload is: resourcedata|sign(resourcedata) Structure Summary: -Request: Resource update with signature - ResourceUpdate: headers + data +Request: Feed Update with signature + Update: headers + data Header: Protocol version and reserved for future use placeholders ID: Information about how to locate a specific update - View: Author of the update and what is updating + Feed: Represents a user's series of publications about a specific Topic Topic: Item that the updates are about - User: User who updates the resource + User: User who updates the Feed Epoch: time slot where the update is stored */ -- cgit v1.2.3 From 83705ef6aa3645a6305a400fa175e44904a929f7 Mon Sep 17 00:00:00 2001 From: Javier Peletier Date: Sun, 30 Sep 2018 09:43:10 +0200 Subject: swarm/storage/mru: Renamed rest of MRU references --- swarm/storage/mru/doc.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'swarm/storage/mru/doc.go') diff --git a/swarm/storage/mru/doc.go b/swarm/storage/mru/doc.go index 2cf2d3757..7ffd4a3c6 100644 --- a/swarm/storage/mru/doc.go +++ b/swarm/storage/mru/doc.go @@ -26,7 +26,7 @@ The Feed Update data is: updatedata = Feed|Epoch|data The full update data that goes in the chunk payload is: -resourcedata|sign(resourcedata) +updatedata|sign(updatedata) Structure Summary: -- cgit v1.2.3 From b6ccc06cdaac80d09da17c25b2f450cd1f1b7914 Mon Sep 17 00:00:00 2001 From: Javier Peletier Date: Sun, 30 Sep 2018 09:51:11 +0200 Subject: swarm/storage/feeds: Final package rename and moved files --- swarm/storage/mru/doc.go | 43 ------------------------------------------- 1 file changed, 43 deletions(-) delete mode 100644 swarm/storage/mru/doc.go (limited to 'swarm/storage/mru/doc.go') diff --git a/swarm/storage/mru/doc.go b/swarm/storage/mru/doc.go deleted file mode 100644 index 7ffd4a3c6..000000000 --- a/swarm/storage/mru/doc.go +++ /dev/null @@ -1,43 +0,0 @@ -/* -Package feeds defines Swarm Feeds. - -Swarm Feeds allows a user to build an update feed about a particular topic -without resorting to ENS on each update. -The update scheme is built on swarm chunks with chunk keys following -a predictable, versionable pattern. - -A Feed is tied to a unique identifier that is deterministically generated out of -the chosen topic. - -A Feed is defined as the series of updates of a specific user about a particular topic - -Actual data updates are also made in the form of swarm chunks. The keys -of the updates are the hash of a concatenation of properties as follows: - -updateAddr = H(Feed, Epoch ID) -where H is the SHA3 hash function -Feed is the combination of Topic and the user address -Epoch ID is a time slot. See the lookup package for more information. - -A user looking up a the latest update in a Feed only needs to know the Topic -and the other user's address. - -The Feed Update data is: -updatedata = Feed|Epoch|data - -The full update data that goes in the chunk payload is: -updatedata|sign(updatedata) - -Structure Summary: - -Request: Feed Update with signature - Update: headers + data - Header: Protocol version and reserved for future use placeholders - ID: Information about how to locate a specific update - Feed: Represents a user's series of publications about a specific Topic - Topic: Item that the updates are about - User: User who updates the Feed - Epoch: time slot where the update is stored - -*/ -package mru -- cgit v1.2.3