Impl interface (#1214)

* Improve interface of positionsCreateWithArbitraryTokens

* rename

* 8.1.0

Author: aggre

lib/agent/index.ts

@@ -1,7 +1,7 @@
 export { positionsCreate } from './positionsCreate'
 export { positionsCreateWithEth } from './positionsCreateWithEth'
 export { positionsCreateWithEth as positionsCreateWithEthForPolygon } from './positionsCreateWithEthForPolygon'
-export { positionsCreateWithArbitraryTokens } from './positionsCreateWithArbitraryTokens'
+export { positionsCreateWithAnyTokens } from './positionsCreateWithAnyTokens'
 export { estimationsAPY } from './estimationsAPY'
 export { propertiesAssets } from './propertiesAssets'
 

lib/agent/positionsCreateWithAnyTokens.ts

@@ -0,0 +1,169 @@
+/* eslint-disable functional/functional-parameters */
+import { FallbackableOverrides } from '../common/utils/execute'
+import { clientsUtilsSwapTokensForStake } from './common/clients/clientsUtilsSwapTokensForStake'
+import { ZeroAddress, type ContractRunner, TransactionResponse } from 'ethers'
+import {
+	approveIfNeeded,
+	ApproveIfNeededResult,
+} from './common/approveIfNeeded'
+import { UndefinedOr, whenDefined } from '@devprotocol/util-ts'
+
+type Params = {
+	readonly provider: ContractRunner
+	readonly mintTo: string
+	readonly destination: string
+	readonly path: readonly (string | bigint)[]
+	readonly token?: undefined
+	readonly tokenAmount?: string
+	readonly devAmount?: string
+	readonly devAmountOut?: string
+	readonly from?: string
+	readonly overrides?: FallbackableOverrides
+	readonly payload?: string
+	readonly deadline?: number
+	readonly gatewayAddress?: string
+	readonly gatewayBasisPoints?: number
+}
+
+type ParamsWithToken = Omit<Params, 'token'> & {
+	readonly token: string
+}
+
+const hasTokens = (
+	options: Params | ParamsWithToken,
+): options is ParamsWithToken =>
+	options.token !== undefined && options.token !== ZeroAddress
+
+export function positionsCreateWithAnyTokens(opts: ParamsWithToken): Promise<
+	UndefinedOr<{
+		readonly estimatedDev: string
+		readonly estimatedTokens: string
+		readonly create: () => Promise<ApproveIfNeededResult>
+	}>
+>
+export function positionsCreateWithAnyTokens(opts: Params): Promise<
+	UndefinedOr<{
+		readonly estimatedDev: string
+		readonly estimatedTokens: string
+		readonly create: () => Promise<TransactionResponse>
+	}>
+>
+
+export async function positionsCreateWithAnyTokens(
+	options: ParamsWithToken | Params,
+): Promise<unknown> {
+	const [, cont] = await clientsUtilsSwapTokensForStake(options.provider)
+	const useERC20 = hasTokens(options)
+
+	return cont
+		? {
+				estimatedDev: options.tokenAmount
+					? await cont.getEstimatedDevForTokens(
+							options.path,
+							options.tokenAmount,
+					  )
+					: 'No tokenAmount provided',
+				estimatedTokens: options.devAmount
+					? await cont.getEstimatedTokensForDev(options.path, options.devAmount)
+					: 'No devAmount provided',
+				create: async () => {
+					const tokenAmount = options.tokenAmount
+						? options.tokenAmount
+						: options.devAmount
+						? await cont.getEstimatedTokensForDev(
+								options.path,
+								options.devAmount,
+						  )
+						: 'Neither tokenAmount nor devAmount provided'
+					const _overrides = {
+						overrides: {
+							...{ value: useERC20 ? undefined : tokenAmount },
+							...options.overrides?.overrides,
+						},
+					}
+
+					const devAmountOut = options.devAmountOut
+						? options.devAmountOut
+						: options.tokenAmount
+						? await cont.getEstimatedDevForTokens(
+								options.path,
+								options.tokenAmount,
+						  )
+						: 'Neither devAmountOut nor tokenAmount provided'
+					const deadline = options.deadline
+						? options.deadline
+						: ((await options.provider.provider?.getBlock('latest'))
+								?.timestamp ?? Math.floor(new Date().getTime() / 1000)) + 300
+
+					return useERC20
+						? whenDefined(options.from, async (from) => {
+								return approveIfNeeded({
+									provider: options.provider,
+									requiredAmount: tokenAmount,
+									from,
+									token: options.token,
+									to: await cont.contract().getAddress(),
+									callback: async () => {
+										return options.gatewayAddress &&
+											typeof options.gatewayBasisPoints === 'number'
+											? cont.swapTokensAndStakeDev(
+													options.mintTo,
+													options.path,
+													options.destination,
+													devAmountOut,
+													deadline,
+													tokenAmount,
+													options.payload,
+													options.token,
+													options.gatewayAddress,
+													options.gatewayBasisPoints.toString(),
+													_overrides,
+											  )
+											: cont.swapTokensAndStakeDev(
+													options.mintTo,
+													options.path,
+													options.destination,
+													devAmountOut,
+													deadline,
+													tokenAmount,
+													options.payload,
+													options.token,
+													undefined,
+													undefined,
+													_overrides,
+											  )
+									},
+								})
+						  })
+						: options.gatewayAddress &&
+						  typeof options.gatewayBasisPoints === 'number'
+						? cont.swapTokensAndStakeDev(
+								options.mintTo,
+								options.path,
+								options.destination,
+								devAmountOut,
+								deadline,
+								tokenAmount,
+								options.payload,
+								undefined,
+								options.gatewayAddress,
+								options.gatewayBasisPoints.toString(),
+								_overrides,
+						  )
+						: cont.swapTokensAndStakeDev(
+								options.mintTo,
+								options.path,
+								options.destination,
+								devAmountOut,
+								deadline,
+								tokenAmount,
+								options.payload,
+								undefined,
+								undefined,
+								undefined,
+								_overrides,
+						  )
+				},
+		  }
+		: undefined
+}

lib/agent/positionsCreateWithArbitraryTokens.ts

@@ -1,7 +1,7 @@
 {
 	"name": "@devprotocol/dev-kit",
 	"type": "module",
-	"version": "8.0.2",
+	"version": "8.1.0",
 	"description": "Dev Kit for JavaScript",
 	"author": "abyssparanoia",
 	"license": "Apache-2.0",