You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<ahref="https://pr.new/ethereumfollowprotocol/api"><imgsrc="https://developer.stackblitz.com/img/start_pr_dark_small.svg"alt="Start new PR in StackBlitz Codeflow" /></a>
Copy file name to clipboardExpand all lines: src/content/docs/api/intro.mdx
+8-10Lines changed: 8 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,10 +15,10 @@ If you are a developer, you are free to use this endpoint to retrieve EFP data.
15
15
16
16
### Commonly used endpoints
17
17
18
-
-[User Stats](https://docs.ethfollow.xyz/api/users/stats/): the follower and following counts of a particular user
19
-
-[User Following](https://docs.ethfollow.xyz/api/users/following/): list of the accounts a particular user follows
20
-
-[User Followers](https://docs.ethfollow.xyz/api/users/followers/): list of the accounts that follow a particular user
21
-
-[User ENS data](https://docs.ethfollow.xyz/api/users/ens/): the ENS data for a particular user
18
+
-[User Stats](https://docs.efp.app/api/users/stats/): the follower and following counts of a particular user
19
+
-[User Following](https://docs.efp.app/api/users/following/): list of the accounts a particular user follows
20
+
-[User Followers](https://docs.efp.app/api/users/followers/): list of the accounts that follow a particular user
21
+
-[User ENS data](https://docs.efp.app/api/users/ens/): the ENS data for a particular user
22
22
23
23
### Self-hosting
24
24
@@ -29,20 +29,18 @@ You may also fork EFP's Indexer/API source code and deploy yourself.
29
29
30
30
### KV cache
31
31
32
-
The API uses Cloudflare KV storage to cache some endpoint's responses. When one of these
33
-
endpoints is called the cache is checked and if there is no record the data is fetched from
34
-
the database. If a cached record is found it is returned immediately. All cache records
35
-
are set to expire 5 minutes after they are created.
32
+
The API uses Cloudflare KV storage to cache some endpoint's responses. When one of these endpoints is called the cache is checked and if there is no record the data is fetched from the database. If a cached record is found it is returned immediately. All cache records are set to expire 5 minutes after they are created.
36
33
37
-
The cached record for each of these endpoints can be refreshed by adding `cache=fresh` to the
38
-
query params. For example:
34
+
The cached record for each of these endpoints can be refreshed by adding `cache=fresh` to the query params. For example:
Copy file name to clipboardExpand all lines: src/content/docs/design/glossary.mdx
+52-26Lines changed: 52 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,79 +3,105 @@ title: Glossary
3
3
---
4
4
5
5
**Account** (or **Ethereum account**)
6
-
>An EVM account. There are no "EFP accounts".
6
+
7
+
> An EVM account. There are no "EFP accounts".
7
8
8
9
**Account Metadata**
9
-
> EFP provides an Account Metadata contract that allows users to set EFP-related metadata specific to their Ethereum account, such as identifying the Primary List for that Ethereum account. (see [Account Metadata](https://docs.ethfollow.xyz/design/account-metadata/))
10
+
11
+
> EFP provides an Account Metadata contract that allows users to set EFP-related metadata specific to their Ethereum account, such as identifying the Primary List for that Ethereum account. (see [Account Metadata](https://docs.efp.app/design/account-metadata/))
10
12
11
13
**Address** (or **Ethereum address**)
12
-
>An EVM address (e.g. 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045). There are no "EFP addresses".
14
+
15
+
> An EVM address (e.g. 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045). There are no "EFP addresses".
13
16
14
17
**Block**
15
-
>A standard tag that means neither the user nor the blocked account should see each other’s activity in a relevant app; lists with this tag are not included in Followers count, even if the list tags the account with other tags; if both “block” and “mute” tags are present, “block” takes precedence. (see [Tags](https://docs.ethfollow.xyz/design/tags/))
18
+
19
+
> A standard tag that means neither the user nor the blocked account should see each other’s activity in a relevant app; lists with this tag are not included in Followers count, even if the list tags the account with other tags; if both “block” and “mute” tags are present, “block” takes precedence. (see [Tags](https://docs.efp.app/design/tags/))
16
20
17
21
**EFP app**
18
-
>Web app that enables someone to create and manage a List on EFP. (see [EFP website](https://ethfollow.xyz/))
22
+
23
+
> Web app that enables someone to create and manage a List on EFP. (see [EFP website](https://efp.app/))
19
24
20
25
**Ethereum Follow Protocol** (or **EFP**)
21
-
>An onchain social graph protocol for Ethereum accounts. The protocol whose docs you are currently reading. (see [EFP website](https://ethfollow.xyz/))
26
+
27
+
> An onchain social graph protocol for Ethereum accounts. The protocol whose docs you are currently reading. (see [EFP website](https://efp.app/))
22
28
23
29
**Ethereum Name Service** (or **ENS**)
24
-
>A distributed, open, and extensible naming system based on the Ethereum blockchain. EFP is designed to complement ENS, and the EFP web app makes extensive use of ENS for names, avatar, and other profile data. (see [ENS website](https://ens.domains/))
30
+
31
+
> A distributed, open, and extensible naming system based on the Ethereum blockchain. EFP is designed to complement ENS, and the EFP web app makes extensive use of ENS for names, avatar, and other profile data. (see [ENS website](https://ens.domains/))
25
32
26
33
**Followers**
27
-
>The total number of Primary Lists that follow a particular Ethereum account, excluding lists that tag them with "block" or "mute".
34
+
35
+
> The total number of Primary Lists that follow a particular Ethereum account, excluding lists that tag them with "block" or "mute".
28
36
29
37
**Following**
30
-
>The total number of Ethereum accounts followed by a list, excluding accounts tagged with "block" or "mute".
38
+
39
+
> The total number of Ethereum accounts followed by a list, excluding accounts tagged with "block" or "mute".
31
40
32
41
**List**
33
-
>An NFT in the EFP List Registry and its accompanying List Storage Location data.
42
+
43
+
> An NFT in the EFP List Registry and its accompanying List Storage Location data.
34
44
35
45
**List Metadata**
36
-
>Metadata for a list, stored alongside List Records in a list's List Storage Location, that specifies the Ethereum accounts set for the roles Manager and User.
46
+
47
+
> Metadata for a list, stored alongside List Records in a list's List Storage Location, that specifies the Ethereum accounts set for the roles Manager and User.
37
48
38
49
**List Number**
39
-
>The token ID for the NFT that represents a list.
50
+
51
+
> The token ID for the NFT that represents a list.
40
52
41
53
**List Ops** (or **List Operation**)
42
-
>The same as a **List Record**; An operation performed on an EFP List, such as appending a list record (for following a particular Ethereum account, unfollowing, tagging, untagging).
54
+
55
+
> The same as a **List Record**; An operation performed on an EFP List, such as appending a list record (for following a particular Ethereum account, unfollowing, tagging, untagging).
43
56
44
57
**List Records**
45
-
>The set of list operations stored at your List Storage Location. (see [List Records](https://docs.ethfollow.xyz/design/list-records/))
58
+
59
+
> The set of list operations stored at your List Storage Location. (see [List Records](https://docs.efp.app/design/list-records/))
46
60
47
61
**List Registry**
48
-
>An Ethereum ERC-721 contract where the NFT represents ownership of a particular list.
62
+
63
+
> An Ethereum ERC-721 contract where the NFT represents ownership of a particular list.
49
64
50
65
**List Settings**
51
-
>A term used in the EFP app that refers to a variety of settings for a list, including: the list's List Storage Location; whether the list is set as a Primary List; the Ethereum accounts set for the roles Owner, Manager, and User.
66
+
67
+
> A term used in the EFP app that refers to a variety of settings for a list, including: the list's List Storage Location; whether the list is set as a Primary List; the Ethereum accounts set for the roles Owner, Manager, and User.
52
68
53
69
**List Storage Location**
54
-
>Where the records for a list are stored. (see [List Storage Location](https://docs.ethfollow.xyz/design/list-storage-location/))
70
+
71
+
> Where the records for a list are stored. (see [List Storage Location](https://docs.efp.app/design/list-storage-location/))
55
72
56
73
**Manager**
57
-
>The Ethereum account that can edit a list's records. By default when a list is created, all three roles (Owner, Manager, and User) are set as the Ethereum account that created the list. Typically, all three roles remain the same account, but they can be changed to be different. (see [Roles](https://docs.ethfollow.xyz/design/roles/))
74
+
75
+
> The Ethereum account that can edit a list's records. By default when a list is created, all three roles (Owner, Manager, and User) are set as the Ethereum account that created the list. Typically, all three roles remain the same account, but they can be changed to be different. (see [Roles](https://docs.efp.app/design/roles/))
58
76
59
77
**Mute**
60
-
> A standard tag that means the user shouldn’t see the muted account’s activity in a relevant app, but the muted account might still be able to see the user’s activity; lists with this tag are not included in Followers count, even if the list tags the account with other tags; if both “block” and “mute” tags are present, “block” takes precedence. (see [Tags](https://docs.ethfollow.xyz/design/tags/))
78
+
79
+
> A standard tag that means the user shouldn’t see the muted account’s activity in a relevant app, but the muted account might still be able to see the user’s activity; lists with this tag are not included in Followers count, even if the list tags the account with other tags; if both “block” and “mute” tags are present, “block” takes precedence. (see [Tags](https://docs.efp.app/design/tags/))
61
80
62
81
**Mutuals**
63
-
>Ethereum accounts that an Ethereum account follows who follow them back.
82
+
83
+
> Ethereum accounts that an Ethereum account follows who follow them back.
64
84
65
85
**Owner**
66
-
>The Ethereum account that ultimately controls a List. By default when a list is created, all three roles (Owner, Manager, and User) are set as the Ethereum account that created the list. Typically, all three roles remain the same account, but they can be changed to be different. (see [Roles](https://docs.ethfollow.xyz/design/roles/))
86
+
87
+
> The Ethereum account that ultimately controls a List. By default when a list is created, all three roles (Owner, Manager, and User) are set as the Ethereum account that created the list. Typically, all three roles remain the same account, but they can be changed to be different. (see [Roles](https://docs.efp.app/design/roles/))
67
88
68
89
**Primary List**
69
-
>The one list an Ethereum account has confirmed to represent who they follow. While an Ethereum account may have roles in more than one list, an Ethereum account can only have one Primary List. Only Primary Lists count as Followers. (see [Account Metadata](https://docs.ethfollow.xyz/design/account-metadata/))
90
+
91
+
> The one list an Ethereum account has confirmed to represent who they follow. While an Ethereum account may have roles in more than one list, an Ethereum account can only have one Primary List. Only Primary Lists count as Followers. (see [Account Metadata](https://docs.efp.app/design/account-metadata/))
70
92
71
93
**Social Graph**
72
-
>The sum total of relationships between Ethereum accounts held in EFP, counting only Primary Lists. Any list that is not set as a Primary List is not included.
94
+
95
+
> The sum total of relationships between Ethereum accounts held in EFP, counting only Primary Lists. Any list that is not set as a Primary List is not included.
73
96
74
97
**Tag**
75
-
>A Tag is a string associated with a List Record in an EFP list. Tags only count for an account if that account is also followed by the user, otherwise they're not counted. List Records can have zero or more tags. A few tags are standardized with specified semantics. Users may also set custom tags. (see [Tags](https://docs.ethfollow.xyz/design/tags/))
98
+
99
+
> A Tag is a string associated with a List Record in an EFP list. Tags only count for an account if that account is also followed by the user, otherwise they're not counted. List Records can have zero or more tags. A few tags are standardized with specified semantics. Users may also set custom tags. (see [Tags](https://docs.efp.app/design/tags/))
76
100
77
101
**Top8** (or, **Top 8**)
78
-
>The tag "top8" means the account should appear in the user's "Top 8" in UIs that support it. If a user has more than eight followed accounts with the "top8" tag, then only show the eight most recent should be included in a "Top 8" displayed in a UI. (see [Tags](https://docs.ethfollow.xyz/design/tags/))
102
+
103
+
> The tag "top8" means the account should appear in the user's "Top 8" in UIs that support it. If a user has more than eight followed accounts with the "top8" tag, then only show the eight most recent should be included in a "Top 8" displayed in a UI. (see [Tags](https://docs.efp.app/design/tags/))
79
104
80
105
**User**
81
-
>The Ethereum account for whom the list is intended; the Ethereum account that is following the Ethereum accounts in the list. By default when a list is created, all three roles (Owner, Manager, and User) are set as the Ethereum account that created the list. Typically, all three roles remain the same account, but they can be changed to be different. (see [Roles](https://docs.ethfollow.xyz/design/roles/))
106
+
107
+
> The Ethereum account for whom the list is intended; the Ethereum account that is following the Ethereum accounts in the list. By default when a list is created, all three roles (Owner, Manager, and User) are set as the Ethereum account that created the list. Typically, all three roles remain the same account, but they can be changed to be different. (see [Roles](https://docs.efp.app/design/roles/))
0 commit comments