Git Product home page Git Product logo

crocswap-protocol-mirror's Introduction

CrocSwap-protocol

Decentralized exchange with concentrated liquidity and low gas fees

Frontend available at

https://ambient.finance

Installation

Clone the repository. In the repository home directory run the following commands:

$ yarn install
$ npx hardhat compile

To verify that the code is functioning run:

$ npx hardhat test

Test coverage can be run with

Documentation

Primary docs can be found at our Gitbook

Additional technical documentation can be found

  • Repo Layout: Top-level overview of the Solidity source files in the project.
  • Control Flow: Illustrated flow charts mapping the smart contract logic associated with common CrocSwap operations.
  • Encoding Guide: Technical specification for clients outlining how to encode arguments to the CrocSwap contract methods that don't use standard Solidity args.

Risks

Users of the CrocSwap protocol should be aware of the implicit risks to the protocol design. Among other major risk sare

  • Protocol Risk - Although carefully reviewed the protocol could have an implementation error that leads to loss of funds
  • Governance Risk - CrocSwap governance has fairly extensive powers, and users should fully trust the entities holding governance roles.
  • Token Risk - CrocSwap expects has fairly stringent conformance requirements to guarantee safe and defined behavior. Users interacting with pools on non-compliant or malicious tokens risk loss of funds.
  • Upgrade Risk - CrocSwap allows for smart contract code upgrade. Any upgrade represents a risk to the entire protocol and users funds if implemented incorrectly. Users should monitor all proposed upgrades and trust the governance process for approving upgrade proposals.

crocswap-protocol-mirror's People

Contributors

mister-meeseeks avatar

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.