Code Monkey home page Code Monkey logo

v3-sdk's Introduction

Alpha software

The latest version of the SDK is used in production in the Premia Interface, but it is considered Alpha software and may contain bugs or change significantly between patch versions. If you have questions about how to use the SDK, please reach out in the #engineering channel of the Discord.

Pull requests are welcome!

Premia V3 SDK

Tests Published npm version npm bundle size (scoped version)

In-depth documentation on this SDK is available at docs.premia.blue.

Auto-generated documentation is available at docs-sdk.premia.finance.

Feedback is welcome!

Dev Setup

  1. Add API_KEY_ALCHEMY, API_KEY_INFURA and TESTNET_PRIVATE_KEY to a .env file (see example)
  2. Run yarn install to download dependencies
  3. If necessary, run chmod ug+x .husky/* to make the husky precommit script an executable.

Anvil Setup

In order to use Anvil as a local blockchain for dev purposes, Forge needs to be installed. Instructions on how to install are here.

Forking Arbitrum Goerli

  1. Make sure ABI's reflect the same copy as the ones deployed on the Georli Network
  2. Determine the blocknumber in which new contracts were deployed (fork must be after this blocknumber)
  3. Forking Georli -> type the following into terminal to launch anvil fork of Georli: anvil --fork-url <INSERT RPC URL> --fork-block-number <INSERT BLOCK NUMBER>
  4. After running the fork use ctrl + z to pause and then type bg to run the fork in the background
  5. Run unit test by running yarn test through the command line

Contract Deployments

  • 2023-11-06 (Arbitrum Goerli): ~53444156
  • 2023-08-10 (Arbitrum Goerli): ~33821949
  • 2023-08-02 (Arbitrum Goerli): ~32704676
  • 2023-06-09 (Arbitrum Goerli): ~25083922

v3-sdk's People

Contributors

froggiedev avatar wolfyds avatar totop716 avatar guceri avatar 0xcourtney avatar nikkatalnikov avatar hikack avatar rickk137 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.