Skip to content

Commit

Permalink
Merge branch 'master' of github.com:Giveth/giveth-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
divine-comedian committed Jun 11, 2024
2 parents 94a1e48 + 9a7c598 commit 1196c84
Show file tree
Hide file tree
Showing 11 changed files with 780 additions and 32 deletions.
674 changes: 674 additions & 0 deletions LICENSE

Large diffs are not rendered by default.

13 changes: 6 additions & 7 deletions dapps/ImportTorusMM.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,9 @@ slug: dapps/importTorusMM
import useBaseUrl from '@docusaurus/useBaseUrl';
import styles from '../src/css/custom.css'

The purpose of this guide is to explain how to import Torus private key into a MetaMask wallet, thereby enabling broader functionality and easier access to decentralized applications (dApps).

While the Torus wallet is a great option for newcomers to crypto, it can be more difficult to use when interacting with decentralized applications (dApps). Giveth users have the opportunity to earn [GIV](https://docs.giveth.io/giveconomy/) by interacting with the [GIVeconomy](https://giveth.io/). Torus users can claim [GIVbacks](https://giveth.io/givbacks), stake in the [GIVfarm](https://giveth.io/givfarm), and claim their [GIVstream](https://giveth.io/givstream), but MetaMask users benefit from a more streamlined user experience.

We want to empower new-comers to crypto with the means to get fully integrated into the web3 community. MetaMask is a secure crypto wallet and a highly optimized gateway to blockchain apps. The purpose of this guide is to explain how to get funds into a MetaMask wallet, thereby enabling broader functionality and security. Users can do this by either transferring funds to a brand new MetaMask wallet or by importing private keys from an existing wallet like Torus. We recommend transferring the funds to a new wallet. Transferring funds removes the risk of someone accessing the wallet using the username and account used to set up the Torus wallet. For instructions on how to get started with a MetaMask wallet, [check out this article from the Metamask team](https://metamask.zendesk.com/hc/en-us/articles/360015489531-Getting-Started-With-MetaMask).
For instructions on how to get started with a MetaMask wallet, [check out this article from the Metamask team](https://metamask.zendesk.com/hc/en-us/articles/360015489531-Getting-Started-With-MetaMask).

## Transfer Your Funds to MetaMask
Once you are logged into your Torus wallet, navigate to the transfer page using the navigation bar at the top of the page.
Expand All @@ -24,21 +23,21 @@ If you have multiple tokens in your Torus Wallet, you will have to repeat this p
<img alt='Download Private Key in Torus' width='75%' height='auto' class='center' src={useBaseUrl('img/content/transferTorusMM.png')} />

## Import Torus Private Key Into MetaMask
### What is a Private Key

Your [private key](https://www.coinbase.com/learn/crypto-basics/what-is-a-private-key) is a string of numbers and letters that allows you to access and manage your funds. <span class='importantText'>It should never be shared with anyone (no community moderators, no Giveth core contributors, no admins, <i>no one!</i> )!</span>. Anyone who has access to your private key has access to your crypto. Importing your Torus private key into MetaMask allows you to access and control your funds from both wallets. This means that you can enjoy full functionality of Giveth and other dApps by using MetaMask, but can still access your funds using your regular Torus login if you wish.
### Get your Torus Private Key
Once you’re signed in to your Torus wallet, navigate to the `Settings` page using the menu at the top of the page. Once on the `Settings` page, click `Account Details` in the `Privacy and Security` section. This will open a pop-up with two options for getting your private key.

<img alt='Download Private Key in Torus' width='75%' height='auto' class='center' src={useBaseUrl('img/content/toruspk.png')} />

The first option is to download a soft copy of your private key as a JSON file. When you select this option you will be prompted to create a password that will later be used to import the file into MetaMask. Create your password, then download the file.
The second option is to show the private key and copy it. This method is less secure since it both shows the private key and copies it to your operating system clipboard. Once copied, your private key can be pasted into MetaMask to import the private key. If you use this option, do not save a copy of your private key. If your system is ever compromised, your private key will be as well.
Choose the option to download a JSON file with your private key or to view and copy the private key securely.

### Import Private Key
Assuming you are set up and logged in with your Metamask wallet, the next step is to import your private key into MetaMask. First, click the circular icon in the top right corner of your MetaMask wallet. This will open the accounts menu. Click the `Import Account` option in this menu. Here you can use the `Select Type` option to select which option you’d like to use to import your private key.

<img alt='Import Private Key into MetaMask' width='50%' height='auto' class='center' src={useBaseUrl('img/content/mmimportkey.png')} />

Important note : Your private key is crucial for accessing and managing your funds securely. To maintain the security of your accounts, never share your private key with anyone.


If you copied your private key from Torus, the `Private Key` option will let you paste the key into MetaMask. If you downloaded the JSON file, select `JSON File`, then use the `Choose File` button to select the private key JSON you downloaded from Torus. Enter the password you created to download the private key file from Torus, then click `Import`. Your new account should now appear in MetaMask and be ready to interact with the GIVeconomy dApps!

Expand Down
2 changes: 1 addition & 1 deletion dapps/givbacks.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ If you would like to request for a token to be considered GIVbacks eligible, you
## Getting GIVbacks
During each round, all donations to verified projects on the DApp are tracked, and this data is used to calculate the amount of GIVbacks received by each Giver for that period.

GIVbacks are distributed in two different blockchains, Gnosis and Optimism. All donations made in eligible tokens on Mainnet, Gnosis, Polygon or Celo will be rewarded with GIV on Gnosis chain; and the ones made in eligible tokens on Optimism will be rewarded with GIV on Optimism.
GIVbacks are distributed on two different networks: Gnosis Chain and OP Mainnet. Donations made on Gnosis Chain will be rewarded with GIV on Gnosis Chain. Donations made on all other GIVbacks-supported chains, will be rewarded with GIV on OP Mainnet.

Givers are able to claim their GIV after the round ends and a fraud review has been conducted. Donors will receive an email when the rewards are ready to be claimed on the [GIVbacks page](https://giveth.io/givbacks). A portion of the GIV will be liquid immediately, and the rest will increase the flowrate of their [GIVstream](https://giveth.io/givstream). To learn more about the GIVstream and how it works, check out our [documentation](https://docs.giveth.io/giveconomy/givstream/). For the purposes of this documentation, we will refer to the sum of the liquid amount and the amount allocated to the GIVstream from GIVbacks as `cumulative GIVbacks`.

Expand Down
2 changes: 1 addition & 1 deletion dapps/guide1-createproject.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Follow the prompts, and input the requested content:
- Alternatively, click the tab `Search for photos`, and enter a keyword.
<img alt='featuredimage2' src={useBaseUrl('img/cryptofundraising8.png')} />

- Your recipient address is where donations to your project will be collected. You can choose to set a single recipient address that can receive donations on Ethereum Mainnet, Gnosis Chain, Polygon, Celo, Optimism, Solana and Ethereum Classic or set a different recipient address for each chain.
- Your recipient address is where donations to your project will be collected. You can choose to set a single recipient address that can receive donations on Ethereum Mainnet, Gnosis Chain, Polygon, Celo, Optimism, Solana, Arbitrum, Base and Ethereum Classic or set a different recipient address for each chain.

* Set one address to receive donations on all supported networks.

Expand Down
70 changes: 70 additions & 0 deletions devouch/whatisdevouch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
id: whatisdevouch
title: What is DeVouch?
slug: /
---
import useBaseUrl from '@docusaurus/useBaseUrl'


DeVouch is a system for members of reputable organizations in the Ethereum ecosystem to vouch for projects that are looking to raise funding. By vouching for a project, the organization can lend its credibility to the project, building confidence for those looking to support with funding.

DeVouch collects projects [Gitcoin](https://gitcoin.co/), [Giveth](https://giveth.io/) and [Optimism Retro Funding](https://vote.optimism.io/) and shows them in a singe place allowing users to either vouch or flag for each project. More platforms may be added in the future.

Visitors to the website can see the vouches and flags received by each project, tracked by the "Attester Group" that the vouch or flag came from. Learn more about "Attester Groups" below.

We believe that by providing a way for members of reputable organizations to vouch for projects, we can leverage the social fabric of the Ethereum community to make more informed decisions on the allocation of capital.

## Attester Groups

DeVouch functions using a system of Attestations from [EAS](https://attest.org/). At the top level DeVouch identifies "Attester Groups" by looking at on-chain attestation data, Attester Groups are best defined as a group of addresses that hold the same type of attestations (defined by it's schema ID) that were all issued by the same address (the "Issuing Authority").

Check out this attestation for example:

https://optimism.easscan.org/attestation/view/0x3ef6cc3d97a1386c1eb6a9ed7903c7247883f348eb8784db17678b1392c0c136

<img alt='attestestation example' src={useBaseUrl('img/devouch/attesterOrganizationExamples.png')} />

In this case, you see the schema is called "RETROPGF BADGEHOLDER" with an ID of `0xfdcfdad2dbe7489e0ce56b260348b7f14e8365a8a325aef9834818c00d46b31b` and the Issuing Authority is `0x621477dBA416E12df7FF0d48E14c4D20DC85D7D9` (presumably someone from the Optimism team). DeVouch would consider all addresses that hold attestations with this schema ID, issued by the same Issuing Authority address to be part of the same Attester Group. The Attester Groups that the DeVouch indexer recognizes were defined at launch by the DeVouch team, and more can be added by following the instructions in the [DeVouch repository](https://github.com/Giveth/DeVouch-BE).

Anyone can make an attestation to either vouch or flag a project at any time, but DeVouch only considers attestations from recognized Attester Groups when indexing information.

## Navigating DeVouch

There are four main pages on DeVouch:
- The "All Projects" view, which shows project card summaries of all projects that have been indexed by DeVouch.
- The "Project Details" view, which shows detailed information about a single project, including the vouches and flags it has received.
- The "My Attestations" view, which shows all the eligible DeVouch attestations you have made, and allows you to edit or delete them.
- The "User Attestations" view, which shows all the eligible DeVouch attestations made by a specific address.

On any page there are a myriad of options for filtering, sorting, and searching for exactly the information you're looking for! Make use of them to optimize you're experience and see the data that's relevant for you.

## Vouching and Flagging projects

When you vouch for a project, you are saying that you know this project and that you trust it. When you belong to a "Atterster Group" in a way you are lending the credibility of the Attester Group to the project you vouched for.

Similarily, when you flag a project, you are saying that you don't trust this project or you don't believe it is legitimate.

Be aware that your address will be associated with the vouch or flag you make, and that this information is public and can be seen by anyone. You can additionally add a comment to your vouch or flag to provide more context.

It is possible that an address could belong to multiple Attester Groups, when you create an attestation, you can choose which Attester Group you want to vouch or flag from. Each attestation made with a unique Attester Group used by the same address counts as a separate vouch or flag. You can only use one Attester Group per attestation on DeVouch.

## Editing Attestations

You can edit your attestation, whether it was a vouch or a flag. This will allow you to change your vouch to a flag or vice versa and also write a new comment into your attestation. This will create a new on-chain attestation that will replace the old one. If you attest to the project as part of other Attester Groups, those attestations will remain unchanged.

You can edit your attestations from either the project details page of the project you attested to or from the 'My Attestations' page.

## Deleting Attestations

You can delete your attestation, whether it was a vouch or a flag. This creates an on-chain revocation of your attestation. This will remove your vouch or flag from the project. If you attested to the project as part of other Attester Groups, those attestations will remain.

You can delete your attestations from either the project details page of the project you attested to or from the 'My Attestations' page.

# Integrating DeVouch

If you'd like to integrate DeVouch data into your platform or analytics we have several graphQL APIs available.

- Sepolia (for testing) - https://backend.devouch.xyz/graphql
- Optimism Mainnet - https://optimism.backend.devouch.xyz/graphql

To learn more about the APIs and how to issue DeVouch attestations continue on to [this article](./api.md).
37 changes: 18 additions & 19 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -205,25 +205,24 @@ module.exports = {
showLastUpdateTime: true
}
],
// [
// '@docusaurus/plugin-content-docs',
//
// {
// id: 'jobs',
//
// path: 'jobs',
//
// editUrl: 'https://github.com/giveth/giveth-docs/edit/master/',
//
// routeBasePath: 'jobs',
//
// sidebarPath: require.resolve('./sidebarsjobs.js'),
//
// showLastUpdateAuthor: true,
//
// showLastUpdateTime: true
// }
// ],
[
'@docusaurus/plugin-content-docs',
{
id: 'devouch',

path: 'devouch',

editUrl: 'https://github.com/giveth/giveth-docs/edit/master/',

routeBasePath: 'devouch',

sidebarPath: require.resolve('./sidebarDevouch.js'),

showLastUpdateAuthor: true,

showLastUpdateTime: true
}
]
// [
// '@docusaurus/plugin-content-docs',
//
Expand Down
5 changes: 5 additions & 0 deletions funding.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"opRetro": {
"projectId": "0xe434930e189c807b137ff0d8e2fa6a95eaa57dde574143a02ca0d7fb31a40bea"
}
}
5 changes: 5 additions & 0 deletions sidebarDevouch.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module.exports= {
whatisdevouch: [
'whatisdevouch', 'devouch-api'
]
}
4 changes: 0 additions & 4 deletions sidebarsjobs.js

This file was deleted.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/devouch/devouchAttestationExample.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1196c84

Please sign in to comment.