Skip to content

Latest commit

 

History

History
243 lines (175 loc) · 6.98 KB

README.md

File metadata and controls

243 lines (175 loc) · 6.98 KB
Raw

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

APWine SDK

This repository is in the early stages. It may be subject to frequent changes, and there may be missing features.

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact

About The Project

This is the SDK which lets you interact with the APWine protocol, and the contracts.

For more detailed information, visit the documentation page.

(back to top)

Built With

(back to top)

Getting Started

  • npm 
    npm install @apwine/sdk
  • yarn 
    yarn add @apwine/sdk
Note: You can access the raw typechain output of our contracts by installing @apwine/protocol & @apwine/amm

Usage

import APWineSDK from '@apwine/sdk'
import { ethers, providers } from 'ethers'
// ...

// You will need a provider for queries.
// Note: Providers will automatically get wrapped into a MulticallProvider.
const alchemyProvider = new providers.AlchemyProvider(
  'mainnet',
  #YOUR ALCHEMY API KEY
)

// You will need a signer for transactions.
// Note: if you want to fetch data only, this can be omitted.
const signer = new ethers.Wallet(
  #YOUR PRIVATE KEY,
  alchemyProvider


// Create an SDK instance

const sdk = new APWineSDK({
  provider: alchemyProvider,
  signer,
  network: 'mainnet'
})

// Fetch all future vaults, then inspect and withdraw from one

  await sdk.ready // ready signifies, that we loaded all asynchronous props, like the Controller, or the LP.
  const vaults = await sdk.fetchAllFutureVaults()
  const { 
    ibtAddress,
    apwibtAddress,
    period,
    platform,
    depositsPaused,
    withdrawalsPaused,
    nextPeriodIndex,
    nextPeriodTimestamp
  } = await sdk.fetchFutureAggregateFromAddress(vaults[0].address)

  const receipt = await sdk.withdraw(vaults[0], 1000)
}
import { howToSwap } from '@apwine/sdk/utils/swap'

// get swap information
const { namedTokenPath } = howToSwap('FYT', 'Underlying')
console.log(namedTokenPath)) // ['FYT', 'PT', 'PT', 'Underlying']

// fetch all AMMs 
const amms = await sdk.fetchAllAMMs()

// swap some tokens

const transaction = 
    await sdk.swapIn({
        amm: amms[0],
        from: 'FYT',
        to: 'PT'
        amount: 100
        deadline: (new Date(Date.now() + 60 * 1000)).getTime()
    }, { autoApprove: true })

For transactions you will need a signer, if you want to just read information, a provider is enough.

(back to top)

Roadmap

  • Add support for deposit & withdraw
  • Add support for token swaps
  • Add support for spot price
  • Add support for distinct import routes
  • Add support for stats fetching
  • Add support for zaps

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

APWine Finance - @APWineFinance - [email protected]

Project Link: https://github.com/APWine/apwine-sdk

(back to top)