New developers #102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

muhammad-usman56 wants to merge 3 commits into develop from new-developers

.gitignore

-Original file line number
+Diff line change
@@ Expand Up / @@ -4,7 +4,7 @@ @@
     /node_modules
     /.pnp
     .pnp.js
+    .env
     # testing
     /coverage
@@ Expand Down @@

docs/contrax-dao/dao-faq.mdx

-Original file line number
+Diff line change
@@ -0,0 +1,31 @@
+    ---
+    title: "DAO FAQ"
+    description: "Frequently asked questions about the Contrax DAO"
+    ---
+    ### Who own the Contrax DAO?
+    The Contrax DAO does not belong to any organization or individuals. Rather, the
+    vTRAX token holders control the DAO and make every decision regarding it. The
+    Contrax team is responsible for setting the initial conditions of the DAO, and
+    will transition all control of the DAO to the vTRAX token holders after the
+    release of the token via the public Liquidity Generation Event.
+    ### What does the DAO control?
+    The DAO controls every aspect related to the Contrax dApp, the DAO treasury, the
+    revenue, and the community TRAX tokens. Through the DAO voting process, every
+    decision related to the project is proposed, voted on, and enacted.
+    ### What is the role of the founding team?
+    At its creation, the DAO will have some partially centralized processes, such as
+    enforcing voting results or dealing with early bugs or exploits. The purpose of
+    the team is to transition the Contrax DAO into an entirely decentralized entity
+    governed exclusively by the Trax token holders.
+    ### How do I vote in the Contrax DAO?
+    Your voting power in the DAO is determined by the amount of vTRAX tokens you
+    hold. Voting mechanisms are still in development. We will notify the community
+    when they are in place.

docs/contrax-dao/dao-intro.mdx

-Original file line number
+Diff line change
@@ -0,0 +1,40 @@
+    ---
+    title: "DAO Overview"
+    description: "An introduction to the Contrax DAO"
+    ---
+    ![Dao Intro](/images/contrax-dao/dao-intro.png)
+    ## A Disclaimer
+    This entire section, from the description of the token, it's usage, and its
+    distribution, and the formation of the DAO, are all currently proposed ideas
+    from the Contrax team. Please keep this mind as you read through.
+    ## The Contrax DAO
+    The Contrax DAO (Decentralized Autonomous Organization) is the
+    open-to-participation, decentralized organization that will control the Contrax
+    Project after its launch. Anyone who holds TRAX tokens will be able to lock them
+    for vTRAX to vote in the DAO. Voting pertains to the Contrax dApp, the community
+    TRAX tokens, and the TRAX token treasury.
+    The DAO is an organization with no central authority and makes all decisions
+    based on blockchain-based votes by its members. To understand more about DAOs in
+    general, please read [the explanation of DAOs](https://ethereum.org/en/dao/) on
+    Ethereum.org.
+    ## DAO Description
+    The DAO itself is currently in the process of creation. Please check back for
+    more information on the specifics of the Contrax DAO mechanics and voting
+    methods. You can also see the TRAX section for more information on the
+    governance token model:
+    [Token Overview](/trax-token/introduction)
+    ## DAO Launch
+    The Contrax DAO will launch simultaneously with the TRAX token release in the
+    public LGE. The LGE is scheduled to be held some time after the release of the
+    full Contrax dApp.

docs/contrax-dao/dao-voting.mdx

-Original file line number
+Diff line change
@@ -0,0 +1,25 @@
+    ---
+    title: "DAO Voting"
+    description: "The voting scope and how to participate."
+    ---
+    ## DAO Voting Authority
+    After the public Liquidity Generation Event, the Contrax project will be
+    controlled by the Contrax DAO. This includes everything from dApp features and
+    projects to integrate, to the TRAX staking rewards and treasury token
+    allocations.
+    Anyone who owns TRAX tokens (whether they are circulating or not) has the
+    ability to swap for vTRAX, granting the authority to cast votes per their token
+    allocation size. Each complete vTRAX token constitutes one a vote.
+    ## DAO Voting Structure
+    It will initially be the responsibility of the Contrax team to facilitate and
+    execute the DAO voting. The voting mechanism itself is currently in development.
+    It will initially be the responsibility of the Contrax team to initiate DAO
+    voting, and to execute the DAO's decisions. As the infrastructure of the DAO
+    develops, the voting will move to be on-chain, allowing for the actual voting
+    and its execution to occur without the Contrax team as a point of
+    centralization.

docs/contrax-dapp/architecture.mdx

-Original file line number
+Diff line change
@@ -0,0 +1,46 @@
+    ---
+    title: "Architecture"
+    description: "A brief overview of the high level components of the Contrax architecture"
+    ---
+    ![Architecture](/images/contrax-dapp/architecture.png)
+    **Contrax.finance:** The domain for the Contrax web dApp where users generate
+    requests from.
+    **Route 53:** The cloud DNS which holds the domain name and directs the request
+    to Cloudfront.
+    **Cloudfront:** The AWS component for securely and quickly delivering the
+    correct services.
+    **S3 Buckets:** Contains the React code of the web dApp which is retrieved by
+    Cloudfront.
+    **API Gateway:** Called by Cloudfront for any backend requests, which knows the
+    subnet to call within the cloud.
+    **NAT Gateway:** The only gateway that can call the private subnet which
+    contains the lambdas to interact with the blockchain
+    **Backend lambda builder & Contract builder:** Server-less requests for specific
+    tasks on the blockchain which only get executed when called.
+    **Code build/deploy**: As commits to the production branch happens, the code is
+    built and deployed to the necessary buckets.
+    **Blockchain:** The EVM chains which the lambdas will interact with to deploy
+    and execute smart contracts.**Dynamo DB:** The private database for the web
+    dApp. It is only for mapping useful information to enhance the UX experience.
+    **Cloudwatch:** Monitors the AWS architecture and ensures all components are
+    working as expected.
+    **Dashboard:** Provides a way to interact with Cloudwatch and request status
+    logs.
+    **GitHub:** The public codebase and entry-point for code into the Contrax
+    application.
+    **Developers:** Changes can be suggested by anyone, but are reviewed, approved,
+    and merged by the active developers of Contrax.

docs/contrax-dapp/dapp-faq.mdx

-Original file line number
+Diff line change
@@ -0,0 +1,20 @@
+    ---
+    title: "DApp FAQ"
+    description: "Frequently asked questions about the Contrax dApp"
+    ---
+    ## What makes it a dApp instead of just an App?
+    Upon its public release, the actual features and functionality of the app will be controlled by the holders of vTRAX tokens. Although the infrastructure currently uses a hybrid approach between centralized and decentralized services, the ultimate goal would be to move both the governance and the architecture to a decentralized model.
+    ## Has the Contrax dApp Launched Yet?
+    No. The dApp is currently in development. The beta is expected to launch in April. The first public version of the dApp will launch just before the public Liquidity Generation Event.
+    ## What can I do in the Contrax dApp?
+    The Contrax dApp will allow users to easily create and manage tokens on the Ethereum and Arbitrum networks. It will also allow them to create Uniswap pools for those tokens, and deploy custom farming contracts. Users can use advanced farming features like auto-compounding and impermanent loss protection on both new and existing tokens on Ethereum and Arbitrum.
+    ## What is Auto-Compounding?
+    This is one of the most useful farming features which Contrax want to bring to as many tokens and chains as possible. Normally, it takes manual effort with several steps to claim, swap, and and re-stake from farming contracts. With auto-compounding, this manual effort is automated several times a day, allowing for exponential growth for any farm offered on Ethereum and Arbitrum.

docs/contrax-dapp/dapp-intro.mdx

-Original file line number
+Diff line change
@@ -0,0 +1,40 @@
+    ---
+    title: "DApp Overview"
+    description: "An Overview of the Contrax dApp, its components, and features"
+    ---
+    ## Introduction
+    The Contrax web dApp is the application by which any user can easily create tokens, farms, and pools on the Ethereum and Arbitrum network. It is designed to be general in the types of smart contracts deployable, but focus on popular DeFi contracts, all while accommodating everyone from new users with limited knowledge of DeFi to advanced users that want extra features and a deeper involvement with the DeFi ecosystems.
+    The ultimate vision for the Contrax dApp is to make the creation of DeFi easy for Arbitrum first, and then for other EVM and eventually non-EVM chains.
+    ## Features
+    The following features will be available on the Ethereum and Arbitrum networks:
+    **Token Creation**: The Contrax dApp will allow users to create ERC20 tokens on either the Ethereum or Arbitrum network. The token creation process will be done via an interface that allows the user to set the name, ticker, supply, and decimals. The user can also add features such as auto-burning per trade, auto-fee collection to the creator per trade, and the ability to increase the supply.
+    <Frame>![Home](/images/contrax-dapp/home.png)</Frame>
+    **Token Management**: After tokens are created, the Contrax dApp shows the user their created token, and provides them options to transfer it, create pools for swapping with other tokens, and create farms for their tokens.
+    <Frame>![Manage Token](/images/contrax-dapp/manage-token.png)</Frame>
+    **Pool Creation/Management**: For either existing assets on Ethereum and Arbitrum, or ones created using Contrax, users can set up pools or contribute to pools that exist on Uniswap and receive LP tokens along with a portion of the fees on all trades for those pools.
+    <Frame>![Graphs](/images/contrax-dapp/graphs.png)</Frame>
+    **Impermanent Loss Protection on Pools**: To help secure the profitability of Contrax farms, Contrax will offer impermanent loss protection for its most popular pools. This will be in the form of TRAX reimbursement for pools based on how long liquidity was provided.
+    **Farm Creation/Management**: For either existing pools on Ethereum and Arbitrum, or ones created on Contrax, users can stake the pools' LP tokens for rewards, or set-up LP staking for reward for their own token. Farms can be popular ones already existing on third party sites, or new contracts can be made for farms made through Contrax.
+    **Auto-compounding Farms**: Unlike most farms where the staking rewards need to be manually withdrawn and re-staked, Contrax can auto-compound rewards so that your rewards work for you as they are earned. This leads to exponential growth in staking rewards for the user. **Token Swaps**: Users can swap between tokens using existing pools or ones created through the Contrax app. All pools will be deployed on Uniswap.
+    <Frame>![Conversion](/images/contrax-dapp/conversion.png)</Frame>
+    ## Development Stage
+    The Contrax dApp is at the end of beta development and will be testable by the public in March.
+    The dApp's development is open source and can be tracked on GitHub. The source code of the front end can be viewed [here](https://github.com/Contrax-co/contrax-web), and the back-end source code can be viewed [here](https://github.com/Contrax-co/contrax-backend). You can also sign up to participate in beta for rewards [here](https://my.forms.app/form/6127a7e0bd6e4f7f3a71a783).

docs/images/contrax-dao/dao-intro.png

Sorry, something went wrong. Reload?