Skip to content

allow optional lpConduit param passthrough on liquidity actions #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cronii wants to merge 1 commit into
base: main
Choose a base branch
from
Open

allow optional lpConduit param passthrough on liquidity actions #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@crocswap-libs/sdk",
"version": "0.2.75",
"version": "0.2.76",
"description": "🛠🐊🛠 An SDK for building applications on top of CrocSwap",
"author": "Ben Wolski <ben@crocodilelabs.io>",
"repository": "https://github.com/CrocSwap/sdk.git",
Expand Down
42 changes: 27 additions & 15 deletions src/encoding/liquidity.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import { BigNumber, ethers } from "ethers";
import { MAX_LIQ } from "../constants";
import { encodeCrocPrice } from "../utils/price";
import { AddressZero } from "@ethersproject/constants";

type Address = string;
type PoolType = number;
Expand All @@ -26,7 +25,8 @@ export class WarmPathEncoder {
qtyIsBase: boolean,
limitLow: number,
limitHigh: number,
useSurplus: number
useSurplus: number,
lpConduit: Address
) {
return this.encodeWarmPath(
qtyIsBase ? MINT_CONC_BASE : MINT_CONC_QUOTE,
Expand All @@ -35,7 +35,8 @@ export class WarmPathEncoder {
qty,
limitLow,
limitHigh,
useSurplus
useSurplus,
lpConduit
);
}

Expand All @@ -45,7 +46,8 @@ export class WarmPathEncoder {
liq: BigNumber,
limitLow: number,
limitHigh: number,
useSurplus: number
useSurplus: number,
lpConduit: Address
) {
return this.encodeWarmPath(
BURN_CONCENTRATED,
Expand All @@ -54,7 +56,8 @@ export class WarmPathEncoder {
liq,
limitLow,
limitHigh,
useSurplus
useSurplus,
lpConduit
);
}

Expand All @@ -63,7 +66,8 @@ export class WarmPathEncoder {
upperTick: number,
limitLow: number,
limitHigh: number,
useSurplus: number
useSurplus: number,
lpConduit: Address
) {
return this.encodeWarmPath(
HARVEST_CONCENTRATED,
Expand All @@ -72,7 +76,8 @@ export class WarmPathEncoder {
BigNumber.from(0),
limitLow,
limitHigh,
useSurplus
useSurplus,
lpConduit
);
}

Expand All @@ -81,7 +86,8 @@ export class WarmPathEncoder {
qtyIsBase: boolean,
limitLow: number,
limitHigh: number,
useSurplus: number
useSurplus: number,
lpConduit: Address
) {
return this.encodeWarmPath(
qtyIsBase ? MINT_AMBIENT_BASE : MINT_AMBIENT_QUOTE,
Expand All @@ -90,15 +96,17 @@ export class WarmPathEncoder {
qty,
limitLow,
limitHigh,
useSurplus
useSurplus,
lpConduit
);
}

encodeBurnAmbient(
liq: BigNumber,
limitLow: number,
limitHigh: number,
useSurplus: number
useSurplus: number,
lpConduit: Address
) {
return this.encodeWarmPath(
BURN_AMBIENT,
Expand All @@ -107,14 +115,16 @@ export class WarmPathEncoder {
liq,
limitLow,
limitHigh,
useSurplus
useSurplus,
lpConduit
);
}

encodeBurnAmbientAll(
limitLow: number,
limitHigh: number,
useSurplus: number
useSurplus: number,
lpConduit: Address
) {
return this.encodeWarmPath(
BURN_AMBIENT,
Expand All @@ -123,7 +133,8 @@ export class WarmPathEncoder {
MAX_LIQ,
limitLow,
limitHigh,
useSurplus
useSurplus,
lpConduit
);
}

Expand All @@ -134,7 +145,8 @@ export class WarmPathEncoder {
qty: BigNumber,
limitLow: number,
limitHigh: number,
useSurplus: number
useSurplus: number,
lpConduit: Address
): string {
return this.abiCoder.encode(WARM_ARG_TYPES, [
callCode,
Expand All @@ -147,7 +159,7 @@ export class WarmPathEncoder {
encodeCrocPrice(limitLow),
encodeCrocPrice(limitHigh),
useSurplus,
AddressZero,
lpConduit,
]);
}
}
Expand Down
19 changes: 19 additions & 0 deletions src/examples/demo.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import { CrocEnv } from '../croc';
import { CrocPositionView } from '../position';
import { ERC20_READ_ABI } from '../abis/erc20.read';
import { ethers } from 'ethers';

//const ETH = ethers.constants.AddressZero
Expand All @@ -8,6 +10,9 @@ const USDC = "0xD87Ba7A50B2E7E660f678A895E4B72E7CB4CCd9C"
// deepcode ignore HardcodedSecret: testnet dummy key
const KEY = "0x7c5e2cfbba7b00ba95e5ed7cd80566021da709442e147ad3e08f23f5044a3d5a"

// USDC/ETH lpConduit
const USDC_ETH_LP_CONDUIT = "0x8c1A6FfA18183ef223d5Eb3b0A0208515E64bB88";

async function demo() {
const wallet = new ethers.Wallet(KEY)

Expand Down Expand Up @@ -190,6 +195,20 @@ async function demo() {

/*console.log((await croc.tokenEth().balance("benwolski.eth")).toString())
console.log(await croc.tokenEth().balanceDisplay("benwolski.eth"))*/

// await croc.poolEth(USDC).mintAmbientQuote(50, [0.0001, 0.001]);

// mint USDC/ETH lp tokens
// await croc.poolEth(USDC).mintAmbientQuote(50, [0.0001, 0.001], { lpConduit: USDC_ETH_LP_CONDUIT });
const lpConduitContract = new ethers.Contract(USDC_ETH_LP_CONDUIT, ERC20_READ_ABI, (await croc.context).provider);
const lpTokenBalance = await lpConduitContract.balanceOf(wallet.address);
console.log(ethers.utils.formatUnits(lpTokenBalance, 18));

// burn USDC/ETH lp tokens
const lpConduitPositionView = new CrocPositionView(pool, USDC_ETH_LP_CONDUIT);
const lpConduitPosition = await lpConduitPositionView.queryAmbient()
console.log(lpConduitPosition);
// await croc.poolEth(USDC).burnAmbientLiq(lpConduitPosition.seeds, [0.0001, 0.001], { lpConduit: USDC_ETH_LP_CONDUIT });
}

demo()
20 changes: 13 additions & 7 deletions src/pool.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,14 +146,14 @@ export class CrocPoolView {
Promise<TransactionResponse> {
let [lowerBound, upperBound] = await this.transformLimits(limits)
const calldata = (await this.makeEncoder()).encodeBurnAmbient
(liq, lowerBound, upperBound, this.maskSurplusFlag(opts))
(liq, lowerBound, upperBound, this.maskSurplusFlag(opts), this.applyLpConduit(opts))
return this.sendCmd(calldata)
}

async burnAmbientAll (limits: PriceRange, opts?: CrocLpOpts): Promise<TransactionResponse> {
let [lowerBound, upperBound] = await this.transformLimits(limits)
const calldata = (await this.makeEncoder()).encodeBurnAmbientAll
(lowerBound, upperBound, this.maskSurplusFlag(opts))
(lowerBound, upperBound, this.maskSurplusFlag(opts), this.applyLpConduit(opts))
return this.sendCmd(calldata)
}

Expand All @@ -162,15 +162,15 @@ export class CrocPoolView {
let [lowerBound, upperBound] = await this.transformLimits(limits)
let roundLotLiq = roundForConcLiq(liq)
const calldata = (await this.makeEncoder()).encodeBurnConc
(range[0], range[1], roundLotLiq, lowerBound, upperBound, this.maskSurplusFlag(opts))
(range[0], range[1], roundLotLiq, lowerBound, upperBound, this.maskSurplusFlag(opts), this.applyLpConduit(opts))
return this.sendCmd(calldata)
}

async harvestRange (range: TickRange, limits: PriceRange, opts?: CrocLpOpts):
Promise<TransactionResponse> {
let [lowerBound, upperBound] = await this.transformLimits(limits)
const calldata = (await this.makeEncoder()).encodeHarvestConc
(range[0], range[1], lowerBound, upperBound, this.maskSurplusFlag(opts))
(range[0], range[1], lowerBound, upperBound, this.maskSurplusFlag(opts), this.applyLpConduit(opts))
return this.sendCmd(calldata)
}

Expand All @@ -189,7 +189,7 @@ export class CrocPoolView {
let [lowerBound, upperBound] = await this.transformLimits(limits)

const calldata = (await this.makeEncoder()).encodeMintAmbient(
await weiQty, isQtyBase, lowerBound, upperBound, this.maskSurplusFlag(opts))
await weiQty, isQtyBase, lowerBound, upperBound, this.maskSurplusFlag(opts), this.applyLpConduit(opts))
return this.sendCmd(calldata, {value: await msgVal})
}

Expand Down Expand Up @@ -250,7 +250,7 @@ export class CrocPoolView {
let [lowerBound, upperBound] = await this.transformLimits(await saneLimits)

const calldata = (await this.makeEncoder()).encodeMintConc(range[0], range[1],
await weiQty, isQtyBase, lowerBound, upperBound, this.maskSurplusFlag(opts))
await weiQty, isQtyBase, lowerBound, upperBound, this.maskSurplusFlag(opts), this.applyLpConduit(opts))
return this.sendCmd(calldata, { value: await msgVal })
}

Expand All @@ -259,6 +259,11 @@ export class CrocPoolView {
return encodeSurplusArg(opts.surplus, this.useTrueBase)
}

private applyLpConduit (opts?: CrocLpOpts): string {
if (!opts || opts.lpConduit === undefined) { return AddressZero }
return opts.lpConduit;
}

private async msgValAmbient (qty: TokenQty, isQtyBase: boolean, limits: PriceRange,
opts?: CrocLpOpts): Promise<BigNumber> {
let ethQty = isQtyBase ? qty :
Expand Down Expand Up @@ -333,5 +338,6 @@ export class CrocPoolView {
}

export interface CrocLpOpts {
surplus?: CrocSurplusFlags
surplus?: CrocSurplusFlags,
lpConduit?: string
}