Skip to content

Commit 57cc9c8

Browse files
goldenandrewgitbook-bot
authored andcommitted
GitBook: No commit message
1 parent 3acddfd commit 57cc9c8

23 files changed

+538
-34
lines changed
2.05 MB
Loading

README (1).md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: >-
88

99
![](.gitbook/assets/golden\_api\_docs.png)
1010

11-
Golden's GraphQL API offers developers powerful and flexible queries to retrieve, submit, and verify the data in the Golden protocol. For more information on Golden and the protocol please read the [readme-2](protocol/readme-2/ "mention") guide.
11+
Golden's GraphQL API offers developers powerful and flexible queries to retrieve, submit, and verify the data in the Golden protocol. For more information on Golden and the protocol please read the [README (2).md](<README (2).md> "mention") guide.
1212

1313
{% hint style="info" %}
1414
The Golden protocol is currently live on the Goerli testnet.
@@ -21,7 +21,7 @@ Correct verifications (those that agree with the consensus verification vote on
2121

2222
Attribution and eligibility for testnet points on triple submissions will be assigned by the earliest timestamped transaction.
2323

24-
**Please read the** [triple-verification-guide.md](protocol/concepts/triple-verification-guide.md "mention") **before submitting or verifying triples.**
24+
**Please read the** [triple-verification-guide.md](protocol/guides/triple-verification-guide.md "mention") **before submitting or verifying triples.**
2525
{% endhint %}
2626

2727
Developers using the Golden API to create agents that submit and verify triples are encouraged to join the [Golden Discord group](https://discord.gg/golden-protocol) to share ideas, feedback, and requests.

README (2).md

+120
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
---
2+
description: >-
3+
Learn about the Golden Protocol and how you can help build the worlds largest
4+
decentralized knowledge graph.
5+
---
6+
7+
# Golden Protocol FAQ
8+
9+
### Status and progress
10+
11+
Golden is on a mission to map all human knowledge.&#x20;
12+
13+
We [started](https://golden.com/blog/introducing-golden/) as a [web2 company](https://golden.com/wiki/Golden-5R) in San Francisco. We [raised $20m](https://golden.com/blog/golden-raises-14-5m-series-a-led-by-a16z/) from leading investors ranging from a16z to Balaji to Founders Fund and many others. Since the Fall 2021, we have been ramping up efforts to create a web3 version of Golden to increase the speed that the knowledge graph can be built.&#x20;
14+
15+
Golden is building a permissionless, open source [protocol](https://golden.xyz/) that incentivizes the collection and verification of canonical knowledge, which it will offer to the public for free and charge commercial entities.
16+
17+
**User growth:** 10’s of thousands of users (growing daily) have connected wallets to Golden and are submitting data into the protocol.
18+
19+
**Data collection:** users have contributed millions of data triples to Golden so far, and we have started the process of the verification of these triples.
20+
21+
**Protocol development:** We are developing a protocol, [dApp](https://dapp.golden.xyz/), and APIs for submitting and verifying triples. [Golden.com](http://golden.com) is in the process of being optimized for full web3 integration.
22+
23+
**Whitepaper:** We have written our whitepaper, which is currently in review to be made public soon.
24+
25+
**Hiring:** We are hiring fast and have [many open roles](https://www.notion.so/Golden-Careers-Public-c19e625ad4874be8b845b756ee1b0252). Please apply or share.
26+
27+
### I am new here, how can I help?
28+
29+
1. Start by [creating an account on Golden.com](https://golden.com/signup) and following the guide to [add-wallet-to-golden.com.md](general-information/add-wallet-to-golden.com.md "mention") ([settings](https://golden.com/settings/profile) → connect wallet). If you have already made a Golden.com account, just connect your wallet.
30+
2. Sign in to the Golden dApp by following: [accessing-the-dapp.md](protocol/guides/accessing-the-dapp.md "mention").
31+
3. Help grow the knowledge graph by [adding data triples and citations](https://www.notion.so/Adding-Structured-Data-Guide-ae657337bf4f4e54ae4402df083c76ac) to [Golden.com](http://golden.com) entity pages. Follow our [Adding Structured Data Guide](https://www.notion.so/Adding-Structured-Data-Guide-ae657337bf4f4e54ae4402df083c76ac) to get started.
32+
1. **Submit triples:** Users that submit fact triples that go on to be accepted will be eligible for an airdrop when the Golden token is released. _Please note, there is no need to paste edits of data triples and citations into Discord, we have a log of your efforts!_
33+
2. **Verify triples:** Users can become eligible for a future airdrop by verifying triples that get accepted by the protocol on [dapp.golden.xyz](http://dapp.golden.xyz). Please follow our [Triple Verification Guide](https://docs.golden.xyz/protocol/guides/triple-validation-guide) when verifying.
34+
4. Are you a builder (developer, data scientist etc.) that can help us? Let us know in Discord by [introducing yourself](https://discord.com/channels/900818355315961876/920015042471133204).
35+
5. Share the project! Tell your friends, developers, or family. [Join our Discord](https://discord.gg/28QcktsGmG) and invite like-minded people to [golden.xyz](https://golden.xyz).
36+
37+
### **What’s the TLDR on how the protocol works?**
38+
39+
1. **Tokens for submission and verification:** Tokens are earned by submitters and verifiers for loading and verifying true facts (triples) into the knowledge graph. E.g. _‘Apple’ ‘was founded in’ ‘1976’_. Verifiers confirm the correctness of the triples by voting. Once the number of votes reaches a statistical threshold, the ‘fact’ is accepted by the knowledge graph and immutably stored. As the knowledge graph grows, the data itself can be used to aid verification. Submitters and verifiers gain a reputation score as triples are accepted.
40+
2. **Data NFTs, fractional ownership, and revenue share incentives:** NFTs are used to organize fractional ownership between the creators of the data associated with each unique entity. Various canonical data can be associated with the unique data NFTs including triples, natural language in various translations, canonical images, or otherwise. These NFTs will assist with disambiguation and allow fractionalized ownership for the submitters, verifiers, and the protocol. Revenue shared from commercial data usage can be distributed to the creators of the data and protocol. Copyright law is used to protect intellectual property and afford commercial usage of the data while allowing free usage by the public.
41+
3. **Anti-gaming:** A Sybil attack resistance, game-theoretic approach is used to provide asymmetric costs to gaming the protocol. Slashing staked collateral is a mechanic used to prevent submitters and verifiers from incorrectly submitting or voting. Reputation scores are implemented to increase efficiency in staking and slashing. Voting is blind.
42+
43+
V0 system design:
44+
45+
{% embed url="https://www.figma.com/embed?embed_host=share&url=https%3A%2F%2Fwww.figma.com%2Ffile%2FuDIr66fHSwokJzWURnvl0o%2FGolden-Diagrams%3Fnode-id%3D0%253A1" %}
46+
47+
### When will a token be released?
48+
49+
There is currently no Golden token and no set date for release. The team will clearly communicate this release well in advance of the launch.
50+
51+
⚠️ Important: We will \***never**\* directly message you about the token sale, so please do not interact with any such messages, as they are spam. When we launch the token, we will do so on multiple marketing channels including core discord announcements channels, Twitter, and our blog.
52+
53+
The team is working aggressively towards a mainnet launch. Currently, we are creating our protocol and [dApp](https://dapp.golden.xyz/) on the testnet. We will announce an estimated launch date as we further build the protocol. We are building Golden in an SEC-compliant manner and are not cutting corners with compliance.
54+
55+
### **How will airdrops be awarded?**
56+
57+
At this time, performing the following tasks will make you eligible for an airdrop:
58+
59+
* submitting triples that go on to be accepted
60+
* performing correct verification
61+
* developing the protocol code
62+
* adding a citation to a triple that exists on Golden that doesn’t have a citation already
63+
64+
Up to 1% of the token treasury will be awarded to the community for correct data submission and verification.
65+
66+
### How can I perform triple submission tasks?
67+
68+
You can use our infobox editor [here](https://jmp.sh/UanEHeA) to edit triples. Please follow our [Adding Structured Data Guide](https://www.notion.so/Adding-Structured-Data-Guide-ae657337bf4f4e54ae4402df083c76ac). We are currently _only accepting triples in the English language_, though we plan to expand this as soon as possible.
69+
70+
### How can I perform verification tasks?
71+
72+
The [Triple Verification Guide](https://docs.golden.xyz/protocol/guides/triple-validation-guide) covers mechanics and common questions around verification.
73+
74+
### I have been adding triples, are my efforts being counted?
75+
76+
Yes! You will eligible for an airdrop reward relative to the number of correct triples you have submitted when we launch our token on the mainnet.
77+
78+
**Note**: for additions to be counted towards airdrop rewards they must follow the [Adding Structured Data Guide](https://www.notion.so/Adding-Structured-Data-Guide-ae657337bf4f4e54ae4402df083c76ac) and not attempt to game the protocol.
79+
80+
### I have been adding citations, are my efforts being counted?
81+
82+
Yes! Adding valid citations to any triple that is missing a citation will qualify you for a special airdrop, and will help the triples you have cited become verified. Citations should be focused around triples that are not URL predicates, especially triples added after the launch of [golden.xyz](http://golden.xyz).
83+
84+
### **Will any contribution to** [**golden.com**](http://golden.com) **count for a future airdrop?**
85+
86+
No. We are focused on triples that go on to be verified along with citations for triples. As of February 16, 2022, natural language and prose in articles will not be rewarded. If you still wish to contribute prose, please follow our [Writing Guide](https://www.notion.so/Writing-Guide-1e96be6c4c4742a288a142dbc212248c). We are currently _only accepting prose in the English language_, though we plan to expand this as soon as possible.
87+
88+
### What is the difference between [**Golden.com**](http://golden.com) **and the** [**dApp**](https://dapp.golden.xyz/) **(Golden.xyz)?**
89+
90+
[Golden.com](http://golden.com) is the current place to register your user account, connect your wallet and submit triple data (with citations). The [dApp](https://dapp.golden.xyz/) is a minimal dApp on testnet with a focused UI around verification.
91+
92+
### Initial testnet point allocations will not be included in a future airdrop
93+
94+
The initial testnet points that are allocated when a user joins the dApp are used as an initial staking mechanic by the protocol to enable triple submission and verification. This initial testnet point allocation will NOT be considered in a future mainnet airdrop reward. Testnet points are designed to reward users for taking positive actions in the protocol.
95+
96+
### How can I find my position on the leaderboard?
97+
98+
You may be able to find your current position on the leaderboard. If the number of ‘submissions’ and ‘accepted triples’ you see associated with your wallet seem lower than expected, this is because your submissions from [Golden.com](http://golden.com) are still being imported and verifiers still need to vote on them.
99+
100+
### Why is Golden the right team to build this?
101+
102+
Golden’s team has crypto enthusiasts dating back to 2011, some being early users and supporters of BTC. Golden's investors have also been at the heart of many crypto projects we see in the market today.
103+
104+
### **Do I need to paste the edit I have done into Discord?**
105+
106+
No, we have full logs of all edits being made on [Golden.com](http://golden.com) and the [dApp](https://dapp.golden.xyz/).
107+
108+
### **When are other languages going to be supported?**
109+
110+
We want to prove the unit economics and security of the system first in English (the language of our original team). If it works, we want to open up to multiple languages (as it should be!). Please don’t make non-English edits at this point, as we don’t support it yet.
111+
112+
### **I want to be a mod in Discord, how should I approach Golden?**
113+
114+
We are still configuring Discord for mass scale. At this time, please refrain from DMing team members as this will only slow the protocol development down. However, long term, we are interested in mods. If you have experience in this area, please add that to your introduction in the "introductions" channel. We are booting up moderators in a careful way to prevent security issues.
115+
116+
### Can I change the eth account address associated with my [Golden.com](http://golden.com/) account / used to login into dapp.golden.xyz?
117+
118+
You cannot change the eth account address associated with your [golden.com](http://golden.com/) account or that you used to login into dapp.golden.xyz. This would cause issues with how attribution for effort is tracked. To use a new .eth account, please create a new account on [golden.com](http://golden.com/).
119+
120+
We plan to explore how we can help users not lose previous work in the case of wallet hacks, loss of login information, etc., in the context of these technical constraints.

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Golden is building a permissionless, decentralized, open-source protocol that incentivizes the collection and verification of canonical knowledge. Protocol data will be offered to the public for free with commercial usage requiring payment. Continue reading [about-golden.md](predicates/about-golden.md "mention") for more.
44

5-
The protocol is currently under development and running on the Goerli testnet. We are actively seeking users to help develop protocol components and act as data submitters or verifiers. Please read the [readme-2](protocol/readme-2/ "mention")for additional information on the protocol mechanics, testnet points, and other common questions.&#x20;
5+
The protocol is currently under development and running on the Goerli testnet. We are actively seeking users to help develop protocol components and act as data submitters or verifiers. Please read the [README (2).md](<README (2).md> "mention")for additional information on the protocol mechanics, testnet points, and other common questions.&#x20;
66

77
_This docs site is designed to help users build and interact with the Golden knowledge graph. If you would like to learn more about the project at a higher level check out_ [_golden.xyz_](https://golden.xyz)_, join us on_ [_Discord_](https://discord.com/invite/golden-protocol)_, or read the_ [_blog_](https://golden.com/blog/golden-raises-40m-series-b/)_._
88

@@ -22,7 +22,7 @@ Earn rewards for helping build the decentralized protocol for knowledge. Pick a
2222
**The incentivized testnet is live**\
2323
****Make data, code, or intellectual contributions to earn testnet points. \
2424
\
25-
Learn how to earn: [incentivized-testnet-activities](protocol/incentivized-testnet-activities/ "mention") &#x20;
25+
Learn how to earn: [incentivized-testnet-activities.md](protocol/incentivized-testnet-activities.md "mention") &#x20;
2626
{% endhint %}
2727

2828
**Growing the graph:** users have contributed and verified millions of data triples on the Golden protocol. We are now scaling up data input through the [protocol API](<README (1).md>) and [dataset submissions](data-and-tools/data-sources.md#submitting-a-dataset). &#x20;

SUMMARY.md

+11-12
Original file line numberDiff line numberDiff line change
@@ -10,28 +10,27 @@
1010
* [Getting started as a data collector](getting-started/getting-started-as-a-data-collector.md)
1111
* [Getting started as a dApp user](getting-started/getting-started-as-a-dapp-user.md)
1212
* [Getting started in governance and community](getting-started/getting-started-in-governance-and-community.md)
13-
* [How to get involved](getting-started/how-to-get-involved/README.md)
14-
* [Reward function development](getting-started/how-to-get-involved/reward-function-development.md)
1513

1614
## ♾ Protocol
1715

18-
* [Golden Protocol FAQ](protocol/readme-2/README.md)
19-
* [Bulk submission tools](protocol/readme-2/bulk-submission-tools.md)
20-
* [IP Ownership](protocol/readme-2/ip-ownership.md)
21-
* [Guides](protocol/guides.md)
22-
* [Incentivized Testnet Activities](protocol/incentivized-testnet-activities/README.md)
23-
* [Accessing the dApp](protocol/incentivized-testnet-activities/accessing-the-dapp.md)
16+
* [Golden Protocol FAQ](<README (2).md>)
17+
* [Incentivized Testnet Activities](protocol/incentivized-testnet-activities.md)
18+
* [Guides](protocol/guides/README.md)
19+
* [Accessing the dApp](protocol/guides/accessing-the-dapp.md)
20+
* [Connecting a Wallet to dapp.golden.xyz](protocol/guides/connecting-a-wallet-to-dapp.golden.xyz.md)
21+
* [Triple Verification Guide](protocol/guides/triple-verification-guide.md)
22+
* [Flagging Triples](protocol/guides/flagging-triples.md)
2423
* [Concepts](protocol/concepts/README.md)
25-
* [Connecting a Wallet to dapp.golden.xyz](protocol/concepts/connecting-a-wallet-to-dapp.golden.xyz.md)
2624
* [Triple](protocol/concepts/triple.md)
27-
* [Triple Verification Guide](protocol/concepts/triple-verification-guide.md)
2825
* [Verification](protocol/concepts/verification.md)
29-
* [Flagging Triples](protocol/concepts/flagging-triples.md)
30-
* [Staking](protocol/concepts/staking.md)
3126
* [Minimum Disambiguation Triple Requirements (MDT)](protocol/concepts/minimum-disambiguation-triple-requirements-mdt.md)
3227
* [Ground Truth Triples (GTT)](protocol/concepts/ground-truth-triples-gtt.md)
3328
* [Disambiguation](protocol/concepts/disambiguation.md)
3429
* [Citations](protocol/concepts/citations.md)
30+
* [How to get involved](protocol/how-to-get-involved/README.md)
31+
* [Reward function development](protocol/how-to-get-involved/reward-function-development.md)
32+
* [Bulk submission tools](protocol/how-to-get-involved/bulk-submission-tools.md)
33+
* [IP Ownership](protocol/how-to-get-involved/ip-ownership.md)
3534
* [Open source development](protocol/open-source-development.md)
3635

3736
## ⚙ API

api/godel-python-sdk/verification.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Verification
22

3-
Here is a short guide to verifying triples on the Golden protocol. Before casting votes, be sure to read the [triple-verification-guide.md](../../protocol/concepts/triple-verification-guide.md "mention").
3+
Here is a short guide to verifying triples on the Golden protocol. Before casting votes, be sure to read the [triple-verification-guide.md](../../protocol/guides/triple-verification-guide.md "mention").
44

55
## Prerequisites
66

data-and-tools/data-sources.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ _<mark style="color:yellow;">Note</mark>: information submitted to the Golden Pr
1616

1717
### Submitting a dataset
1818

19-
We encourage and offer testnet incentives to users that add data sources to this list. See [#dataset-contribution](../protocol/incentivized-testnet-activities/#dataset-contribution "mention") for details on testnet rewards.&#x20;
19+
We encourage and offer testnet incentives to users that add data sources to this list. See [#dataset-contribution](../protocol/incentivized-testnet-activities.md#dataset-contribution "mention") for details on testnet rewards.&#x20;
2020

2121
To submit a dataset you may use this form:
2222

0 commit comments

Comments
 (0)