Light

kwenta / kwenta-subgraph Goto Github PK

View Code? Open in Web Editor NEW

This project forked from synthetixio/synthetix-subgraph

8.0 8.0 14.0 6.02 MB

All sources for the handful of Kwenta subgraphs indexed by The Graph

Home Page: https://thegraph.com/hosted-service/subgraph/kwenta/optimism-main

License: MIT License

JavaScript 1.87% TypeScript 98.13% Shell 0.01%

kwenta-subgraph's Introduction

Kwenta

A dApp enabling derivatives trading — powered by the Synthetix protocol.

The decentralized trading UI is available at kwenta.eth.limo.

ENS link: kwenta.eth.

The latest IPFS hash can be found under releases.

Contributing

Kwenta welcomes contributors. Regardless of the time you have available, everyone can provide meaningful contributions to the project by submitting bug reports, feature requests or even the smallest of fixes! To submit your contribution, please fork, fix, commit and create a pull-request describing your work in detail. For more details, please have a look at the Contribution guidelines.

Tech stack

Next.js
React
Redux
Kwenta SDK
Styled-Components

Ethereum stack

ethers.js v5 - Ethereum wallet implementation.
Rainbowkit - for ethereum wallet onboarding.

Development

Contributing to the Kwenta frontend - Kwenta Code Style Guidelines
The devDAO - How to contribute

Install dependencies

pnpm install

Set up environment variables

Copy the .env.local.example file in the packages/app directory to .env.local (which will be ignored by Git):

cd packages/app
cp .env.local.example .env.local

Then, open .env.local and add the missing environment variables:

Required:

NEXT_PUBLIC_PROVIDER_ID - Specifies the default provider, options are INFURA or BLAST_API
NEXT_PUBLIC_INFURA_PROJECT_ID - Infura project id (get it from infura.io) or
NEXT_PUBLIC_BLASTAPI_PROJECT_ID - Blast API project id (get it from blastapi.io)
NEXT_PUBLIC_SOCKET_API_KEY - Socket API key (get it from socket.tech
NEXT_PUBLIC_SATSUMA_API_KEY - API key for Satsuma subgraph queries
NEXT_PUBLIC_THEGRAPH_API_KEY - API key for The Graph's decentralized service
NEXT_PUBLIC_DEFAULT_PRICE_SERVICE - Specifies the default price server, options are KWENTA or PYTH
NEXT_PUBLIC_SERVICES_PROXY - Specify Kwenta proxy server

Run

cd packages/app
pnpm dev

Open http://localhost:3000 to view it in the browser.

Build

cd packages/app
pnpm build
pnpm start

Unit Testing

cd packages/app
pnpm test:jest

For unit tests we use a combination of Jest and React Testing Library

Page tests should be added to the testing folder at the root as it is not possible to co-locate tests and pages in nextjs. Other tests should be co-located in a __tests__ folder next to their related file.

Contact

Join the community on the Kwenta Discord server!

kwenta-subgraph's People

Contributors

Stargazers

Watchers

Forkers

dmitro3 zhyd1997 paulvaden bestxeosx-gm candlenetwork dhedge rhxo goshimadev synthquest mentaltrain serpepe ilofy index-chain1 cyberdex-exchange amalgamate-amgt

kwenta-subgraph's Issues

Production Subgraph Updates

Deploy production subgraph for optimism mainnet
Get contract addresses from Synthetix libraries
Add fees to position handler
Point UI at production subgraph
Add conditional statement to point at mainnet vs testnet subgraphs

Add raw PositionModified Events

Add a handler for the PositionModified events coming from each FuturesMarket contract.

Subgraph contains PositionModified entity

Track net funding on subgraph

Add to net funding when positions are modified
Add net funding from subgraph to current position in UI

Add keeper fee to position

Update fees on Next-price order execution

Add keeper fee to position and trade entities if NP order executed by keeper

Limit order investigation

Collect transactions for limit orders through gelato and plan a way to track open orders and transactions

Set up repo

Deliverables:

Remove all subgraphs except futures and latest-rates (candles)
Review docs for info that is not relevant to Kwenta subgraphs

Implement decentralized subgraph

Set up Kwenta test polygon wallet
Manually deploy to decentralized subgraph
Check curation and indexing on newly deployed graph

Investigate PnL calculation

Add basic PnL summation to subgraph
Verify PnL includes funding
Determine if we should have a separate subgraph for the futures competition

Add cumulative traders to subgraph

Add a totalTraders value to the cumulative subgraph entity

AC:

FuturesCumulativeStat contains a totalTraders field

Create hourly markets entity

Hourly entity tracks volume
Hourly entity tracks number of trades

Update README

Update readme with relevant information for Kwenta. Remove deprecated Synthetix information and entities

Subgraph CI Updates

Add separate latest-rates deploy to CI
Point Kwenta at new latest-rates endpoint
Update main subgraph to exclude latest-rates

Update orders

Change "Pending" state to "Open"
Add event handlers for limit order events

Discuss Future of Subgraph

Investigate what to do once subgraph starts sunsetting hosted service (Q3/22)
Investigate alternatives

Fix Liquidation Pnl

Liquidation position pnl is showing as >100%

Cap liquidation losses to initial margin + total deposits. This occurs when funding is really high or closing price results in excess losses taken by the debt pool.

pnlWithFeesPaid is never >100% for a position
Implement pnlWithFeesPaid on frontend queries

Add `FuturesMarginAccount` entity

Add an entity that tracks the margin for each user within each market. The entity will update each time they deposit, withdraw, or modify their position.

Added FuturerMarginAccount entity futures subgraph

Recommend Projects

React

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

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

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

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
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.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

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

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.