npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@aperture_finance/uniswap-v3-automation-sdk

v3.14.0

Published

SDK for Aperture's CLMM automation platform

Downloads

2,767

Readme

Uniswap V3 Automation SDK

This repository contains the Uniswap V3 Automation SDK developed by Aperture Finance.

Lint Test npm version

Overview

The Uniswap V3 Automation SDK is a comprehensive software development kit designed to automate various workflows related to Uniswap V3. It provides a set of tools, libraries, and utilities that simplify the process of interacting with the Uniswap V3 protocol.

Features

  • Automate Liquidity Provision: The SDK enables you to automate the process of providing liquidity to Uniswap V3 pools. It offers functionalities for calculating optimal positions, managing liquidity ranges, and handling position updates.

  • Trade Execution Automation: With the SDK, you can automate the execution of trades on Uniswap V3. It provides tools for generating trade paths, estimating gas costs, and executing trades with customizable parameters.

  • Position Management: The SDK simplifies the management of your Uniswap V3 positions. It includes features for tracking position details, monitoring performance metrics, and adjusting positions based on market conditions.

  • Analytics and Reporting: Utilize the SDK's analytics and reporting capabilities to gain insights into your Uniswap V3 activities. It offers tools for generating reports, visualizing data, and analyzing historical performance.

Documentation

For detailed information on how to use the Uniswap V3 Automation SDK, please refer to the official documentation: Documentation Link.

Getting Started

To get started with the Uniswap V3 Automation SDK, follow these steps:

  1. Clone the repository:
git clone https://github.com/Aperture-Finance/uniswap-v3-automation-sdk.git
  1. Install the required dependencies:
npm i -g yarn
yarn
  1. Explore the examples and code samples provided in the repository to understand the SDK's functionalities and usage patterns.

Use yarn link for debugging

When debugging with frontend / backend environment, you don't have to release a new version for every change. Instead, use yarn link can easily replace current module under node_modules with your local code.

Here's the step:

  1. Build this sdk repo
❯ yarn && yarn build
  1. Run yarn link in this sdk repo root
❯ yarn link
yarn link v1.22.22
success Registered "@aperture_finance/uniswap-v3-automation-sdk".
info You can now run `yarn link "@aperture_finance/uniswap-v3-automation-sdk"` in the projects where you want to use this package and it will be used instead.
  1. Run yarn link @aperture_finance/uniswap-v3-automation-sdk in target project, it will create a soft link to sdk code.
❯ yarn link @aperture_finance/uniswap-v3-automation-sdk
yarn link v1.22.22
success Using linked package for "@aperture_finance/uniswap-v3-automation-sdk".
  1. (Optional) If making changes on this sdk repo, you will need to re-build this sdk repo
❯ yarn && yarn build
  1. Use unlink followed by yarn install --force in the target project to clean up the soft link
❯ yarn unlink @aperture_finance/uniswap-v3-automation-sdk
yarn unlink v1.22.22
success Removed linked package "@aperture_finance/uniswap-v3-automation-sdk".
❯ yarn install --force
  1. (Optional) Run yarn unlink in this sdk repo to unlink
❯ yarn unlink @aperture_finance/uniswap-v3-automation-sdk
success Unregistered "@aperture_finance/uniswap-v3-automation-sdk".

Version Naming Conventions

  • V2: Custom Solver
  • V3: Migrate from feeBips to feeAmount

Contributing

We welcome contributions from the community!

Licensing

The license for Aperture Automation SDK is the Business Source License 1.1 (BUSL-1.1), see LICENSE.

Contact

If you have any questions, suggestions, or feedback, please feel free to reach out to us at [email protected]