Coder Social home page Coder Social logo

gnosischain / documentation Goto Github PK

View Code? Open in Web Editor NEW
86.0 86.0 126.0 172.35 MB

Gnosis Chain Website

Home Page: https://docs.gnosischain.com

License: Creative Commons Zero v1.0 Universal

JavaScript 49.40% CSS 8.06% Shell 0.98% TypeScript 10.92% SCSS 30.64%

documentation's People

Contributors

0xarmagan avatar 4rgon4ut avatar alebanzas avatar alexpeterson91 avatar anmolsirola avatar atj3097 avatar barichek avatar billyjitsu avatar cjbangert avatar cvjoint avatar davidalbela avatar deeintech avatar devinlamoureux avatar giacomognosis avatar giacomolicari avatar ilge-ustun avatar jbradach avatar mrtdlgc avatar nitric avatar omahs avatar plato-gno avatar sukey2008 avatar symulacr avatar tabascoatw avatar thechim9 avatar tloffler avatar vanshika-srivastava avatar vanshwassan avatar wineberry007 avatar zengzengzenghuy avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

documentation's Issues

Key Differences between Gnosis Chain and Ethereum

Overview

  • Key Differences section on [Developers' Overview] does not adequately cover key differences

Image

Key Pointers

  • Native gas token is a stablecoin (this is major?!)
  • 1:1 native bridge from Ethereum to Gnosis
  • As similar to native Ethereum as possible (using Beacon Chain consensus)

AMB Bridge Documentation - 1st Pass

Overview

  • Do a 1st draft of the AMB Bridge Documentation

Key Information

  1. Overview
  • Create table similar to that of xDai Chain
  • Frontend URL - is there even one?`
  • Trust Model: 4-of-6 Multisig
  • Governance: 7-of-16 Multisig
  • Governance Params: (are there any for AMB bridge?)
  • Bug bounty - link the Immunefi https://immunefi.com/bounty/gnosischain/

Image

  1. Key Contracts
  1. Fees & Daily Limits

Image

  1. Bridge Validators

Image

  1. Bridge Governance

Image

  1. Bridge Revenue
  • There is no bridge revenue for the AMB
  1. Analytics
  • We should consider building an Analytics site for the AMB (see # of messages passed)

How it Works

Deploying the AMB

Deploying the AMB Bridge Validator

How to send data on the Bridge

How to submit confirmations manually

Content: Ecosystem Section that details DApps deployed on GC

<<edited by @dan-gnosis>>

Description

  • "Ecosystem" Section that has a page for each "category" of project
  • We should do a round of "housekeeping" to get rid of deadpool-ed dApps that are no longer active
  • Differentiate between "Featured" projects, vs. "Mentions"

User Stories

  • User should be able to see a list of all dApps in the Gnosis Chain ecosystem
  • Each "category" should have a SEO-able page that lists the projects in that category with a short description
  • Projects should be able to do a PR to the repo to add their project to the dApp page

Image

Advanced User Stories

  • There should be an optional way for projects to add a page for a project
  • This page may not necessarily show up in the sidebar (just an internal link)
  • The page URL will follow the following structure, e.g.
    https://documentation.gnosischain.com/ecosystem/defi/uniswap

Image

Resources

bug: 3/6 OmniBridge Validators are out of date

What

The AMB live monitoring page only includes the addresses for Protofire, Giveth, and Syncnode Omnibridge Validators, and the other three are those mentioned above

Why

  • They are currently incorrect

Add SASS compiler plugin

What

Add a SASS compiler plugin to Docusaurus

Why

To allow for more flexible CSS implementation. Does not change the ability to use vanilla CSS (though the src/css/custom file changes from .css to .scss)

xDai Bridge Documentation - 2nd Pass

xDai Bridge Documentation

  • Improve the xDai Bridge documentation by adding more critical information
  • Improve the xDai Bridge documentation by refactoring additional legacy TokenBridge and xDai Docs into the new version of documentation

Docs Structure

  • I have created a "structure" for the documentation
  • "Key Information" holds critical "at-a-glance" information (e.g. fees & daily limits)
  • "How it Works" explains

Image

Tasks

Image

Image

  • #91
  • Add the contracts to the table above, linking their Etherscan and Gnosisscan/Blockscout URLs

Image

Stretch Goals:

Image

  • Look into past transactions to the bridge and see if there is a consistent gas cost (bridge in from Ethereum, bridge out from Gnosis)

Additional Thoughts

  • We will need to create a "Tutorials" section for each Bridge (e.g. "How to run a xDai Bridge Validator")
  • This can come later (refactor at a later date)

Reflect that site covers Documentation (vs Developers Portal)

Earlier last week we decided to move towards making this site a full Documentation site, covering more than just dev topics, to address the across-the-board lack of documentation.

Todo

  • Update site to reflect Documentation (vs Developers Portal)

Testnet (Chiado)

  • Specs for network
  • JSON RPC Providers
  • Easy Metamask integration
  • Truffle config
  • Hardhat config
  • Foundry commands
  • Web3.js
  • Tutorials

bug: old discord invites invalid

What

-need new invite links to Gnosis discord

Why

  • so new users can interact with and join the Gnosis community
  • so users can get support with questions

Bridge - Add Docs on updated Validators for GC <> BNB Chain

@CJBangert

Tokenbridge on GC <> ETH

  • 0x1312e98995bbcc30fc63db3cef807e20cdd33dca (Gnosis Safe)
  • 0x587c0d02b40822f15f05301d87c16f6a08aaddde (CoW)
  • 0x97630e2ae609d4104abda91f3066c556403182dd (Gnosis)
  • 0xfe24cfb2f8872e9ed097c451de065a9f6048915b (SyncNode)
  • 0xc073c8e5ed9aa11cf6776c69b3e13b259ba9f506 (Giveth)
  • 0x4d1c96b9a49c4469a0b720a22b74b034eddfe051 (Protofire)

AMB validators on GC <> ETH (also Omnibridge)

  • 0x258667E543C913264388B33328337257aF208a8f (Gnosis Safe)
  • 0x674c97db4ce6cac04a124d745979f3e4cba0e9f0 (CoW)
  • 0xbdc141c8d2343f33f40cb9edd601ccf460cd0dde (Gnosis)
  • 0x19ac7c69e5f1ac95b8d49b30cbb79e81f1ab0dba (SyncNode)
  • 0x105cd22ed3d089bf5589c59b452f9de0796ca52d (Giveth)
  • 0x459a3bd49f1ff109bc90b76125533699aaaaf9a6 (Protofire)

AMB validators on GC <> BSC (also Omnibridge)

  • 0x5333588897ce6de00031dc30cd2d6881e5c517fb (Gnosis Safe)
  • 0x13f3912ea00878cdb63ee5f02cf8ab65988efd2a (CoW)
  • 0x9adb7385b598843c36fa057e45bc70542516e35d (Gnosis)
  • 0x19ac7c69e5f1ac95b8d49b30cbb79e81f1ab0dba (SyncNode)
  • 0x459a3bd49f1ff109bc90b76125533699aaaaf9a6 (Protofire)
  • 0x105cd22ed3d089bf5589c59b452f9de0796ca52d (Giveth)

Improvements to "Deploying a Smart Contract'

Some areas for improvement

Using Truffle

  1. Title of the page should be "Using Truffle with Gnosis Chain" to enhance SEO-ability
  1. Remove extraneous information from truffle code snapshot
  • Unnecessary config information in the snippet below. Junior devs might assume that things such as truffle-hdwallet-provider are critical to the functioning, when they are not
  • The code snippet should show the path to the truffle.js file (see how it's done in the hardhat page)

Image

  1. Compiling a smart contract
# Compile for Gnosis
truffle compile --network gnosis

# Compile with options
truffle compile [--list <filter>] [--all] [--network gnosis] [--quiet]

Image

  1. Deploy your contract

  2. Verify contract

  • Truffle Plugin Verify link is broken - read up on the Contract Verification Page and figure out what is the best documentation to write
  • Contract Verification Page link has a typo

Using Hardhat

  1. Title
  • Amend title (similar to Truffle)
  • Add SEO Metadata
  1. Config Metadata for Gnosis
  • Remove irrelevant sections from the code snippet (also remove deprecated URL)

Is GetMnemonic() crucial for Gnosis development?

For "Change the TNetworkInfo variable to gnosis", the path_to_file needs to be the same as the previous 2 code snippets.

  • Why do we have a hardhat.config.ts file path
  • Should it be hardhat.config.js instead? (be agnostic to their file structure)

Remix and Metamask

  • Amend title
  • Add SEO Metadata
  1. Screenshots should be of a smaller resolution (currently very difficult to see). I would recommend reducing this to something that can be easily seen in the screenshot.
  2. Again, typo on "Contract Verfication Page"

For screenshots, the default is to use red arrows for visibility - see https://ethereum-blockchain-developer.com/110-upgrade-smart-contracts/08-eip-1822-uups/ for an example of a good tutorial

Using Foundry

  • Needs to be done

Bridges section should have Bridge Governance section

We should have a separate section for Bridge Governance in Bridges (as these are separate from Chain Governance)

It is important to note that Bridge Governance is separate and different from Bridge Validators:

  • Bridge Governance: 16 governors, 7/16 for approval, can set
  • Bridge Validators: 6 bridge operators, 4/6 for approval

We should look through the Bridge Governance contract and document what exactly they have control over - i.e. parameters such as daily limits, and even replacing Bridge Validators.

cc @alebanzas @CJBangert

2nd pass on Ecosystem Section

I went over the Ecosystem Section, which has room for improvement

Use neutral voice for documentation

Let's remove the ! from technical writing.

Image

Categorize links

For each of the Ecosystem pages, we should find a way to synthesize information into categories.

An excellent example of this is @alebanzas's page on Wallets, which categorizes the long list of wallets into Software Wallets and Hardware Wallets.

Each project should just be a bullet point and a short description. I provide a short example of the DeFi page, where I would have a few categories:

## DEXes

* [Sushiswap](https://sushi.com): ...
* [Uniswap](https://uniswap.com): ...
* [Swapr](...): ...

## DEX Aggregators

* [1Inch](): ...

## Perpetuals

* [Perpetual Protocol](...): ...

Image

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.