Merge pull request #761 from dev-protocol/improve/positionsCreate

upgrade: positionsCreate API

Author: aggre

lib/agent/common/approveIfNeeded.ts

@@ -0,0 +1,59 @@
+/* eslint-disable functional/functional-parameters */
+import { whenDefinedAll } from '@devprotocol/util-ts'
+import {
+	TransactionResponse,
+	TransactionReceipt,
+} from '@ethersproject/abstract-provider'
+import { Provider } from '@ethersproject/abstract-provider'
+import { BigNumber } from 'ethers'
+import { FallbackableOverrides } from '../../common/utils/execute'
+import { devClients } from './clients/devClients'
+
+type ApproveIfNeeded = (factoryOptions: {
+	readonly provider: Provider
+	readonly requiredAmount: string
+	readonly from: string
+	readonly to?: string
+	readonly callback: (
+		receipt?: TransactionReceipt
+	) => Promise<TransactionResponse>
+}) => (options: {
+	readonly amount?: string
+	readonly overrides?: FallbackableOverrides
+}) => Promise<{
+	readonly waitOrSkip: () => Promise<TransactionResponse>
+}>
+
+export const approveIfNeeded: ApproveIfNeeded =
+	(factoryOptions) => async (options) => {
+		const [l1, l2] = await devClients(factoryOptions.provider)
+		const client = l1 ?? l2
+		const allowance = await whenDefinedAll(
+			[client, factoryOptions.to],
+			([x, to]) => x.allowance(factoryOptions.from, to)
+		)
+		const callback = {
+			waitOrSkip: () => factoryOptions.callback(),
+		} as const
+
+		return (
+			whenDefinedAll([client, factoryOptions.to], async ([dev, to]) => {
+				return BigNumber.from(allowance).lt(factoryOptions.requiredAmount)
+					? ((approve) =>
+							({
+								...approve,
+								waitOrSkip: async () => {
+									const repeipt = await approve.wait()
+									return factoryOptions.callback(repeipt)
+								},
+							} as const))(
+							await dev.approve(
+								to,
+								options.amount ?? factoryOptions.requiredAmount,
+								options.overrides
+							)
+					  )
+					: callback
+			}) ?? callback
+		)
+	}

lib/agent/common/clients/devClients.ts

@@ -0,0 +1,34 @@
+import { l2AvailableNetworks } from '../const'
+import type { UndefinedOr } from '@devprotocol/util-ts'
+import { createDevContract, DevContract } from '../../../ethereum/dev'
+import {
+	createDevContract as createDevContractL2,
+	DevContract as DevContractL2,
+} from '../../../l2/dev'
+import { Provider } from '@ethersproject/abstract-provider'
+import { registryClientL1 } from './registryClientL1'
+
+type Results = readonly [UndefinedOr<DevContract>, UndefinedOr<DevContractL2>]
+
+const cache: WeakMap<Provider, Results> = new WeakMap()
+
+export const devClients = async (provider: Provider): Promise<Results> => {
+	const res =
+		cache.get(provider) ??
+		(await (async () => {
+			const net = await provider.getNetwork()
+			const registry = await registryClientL1(provider)
+			const l1 = registry
+				? createDevContract(provider)(await registry.token())
+				: undefined
+			const l2 = ((data) =>
+				data ? createDevContractL2(provider)(data.map.token) : undefined)(
+				l2AvailableNetworks.find(({ chainId }) => chainId === net.chainId)
+			)
+			const results: Results = [l1, l2]
+			// eslint-disable-next-line functional/no-expression-statement
+			cache.set(provider, results)
+			return results
+		})())
+	return res
+}

lib/agent/common/clients/lockupClients.ts

@@ -8,16 +8,14 @@ import {
 import { Provider } from '@ethersproject/abstract-provider'
 import { registryClientL1 } from './registryClientL1'
 
-const cache: WeakMap<
-	Provider,
-	readonly [UndefinedOr<LockupContract>, UndefinedOr<LockupContractL2>]
-> = new WeakMap()
+type Results = readonly [
+	UndefinedOr<LockupContract>,
+	UndefinedOr<LockupContractL2>
+]
 
-export const lockupClients = async (
-	provider: Provider
-): Promise<
-	readonly [UndefinedOr<LockupContract>, UndefinedOr<LockupContractL2>]
-> => {
+const cache: WeakMap<Provider, Results> = new WeakMap()
+
+export const lockupClients = async (provider: Provider): Promise<Results> => {
 	const res =
 		cache.get(provider) ??
 		(await (async () => {
@@ -30,10 +28,7 @@ export const lockupClients = async (
 				data ? createLockupContractL2(provider)(data.map.lockup) : undefined)(
 				l2AvailableNetworks.find(({ chainId }) => chainId === net.chainId)
 			)
-			const results: readonly [
-				UndefinedOr<LockupContract>,
-				UndefinedOr<LockupContractL2>
-			] = [l1, l2]
+			const results: Results = [l1, l2]
 			// eslint-disable-next-line functional/no-expression-statement
 			cache.set(provider, results)
 			return results

lib/agent/positionsCreate.ts

@@ -1,22 +1,46 @@
-import { TransactionResponse } from '@ethersproject/abstract-provider'
 import { FallbackableOverrides } from '../common/utils/execute'
 import { Provider } from '@ethersproject/abstract-provider'
-import { UndefinedOr } from '@devprotocol/util-ts'
 import { lockupClients } from './common/clients/lockupClients'
+import { approveIfNeeded as _approveIfNeeded } from './common/approveIfNeeded'
+import { UndefinedOr } from '@devprotocol/util-ts'
 
 type PositionsCreate = (options: {
 	readonly provider: Provider
+	readonly from: string
 	readonly destination: string
 	readonly amount: string
 	readonly overrides?: FallbackableOverrides
-}) => Promise<UndefinedOr<TransactionResponse>>
+}) => Promise<
+	UndefinedOr<{
+		readonly approveIfNeeded: ReturnType<typeof _approveIfNeeded>
+	}>
+>
 
 export const positionsCreate: PositionsCreate = async (options) => {
 	const [l1, l2] = await lockupClients(options.provider)
 
-	return l1
-		? l1.depositToProperty(options.destination, options.amount)
-		: l2
-		? l2.depositToProperty(options.destination, options.amount)
+	return l1 || l2
+		? {
+				approveIfNeeded: _approveIfNeeded({
+					provider: options.provider,
+					requiredAmount: options.amount,
+					from: options.from,
+					to: ((x) => x?.contract().address)(l1 ?? l2),
+					callback: (receipt) =>
+						l1
+							? l1.depositToProperty(
+									options.destination,
+									options.amount,
+									options.overrides
+							  )
+							: l2
+							? l2.depositToProperty(
+									options.destination,
+									options.amount,
+									options.overrides
+							  )
+							: (undefined as never),
+				}),
+		  }
 		: undefined
 }

lib/ethereum/allocator/index.spec.ts

@@ -25,6 +25,7 @@ describe('allocator/index.ts', () => {
 				return {
 					calculateMaxRewardsPerBlock:
 						createCalculateMaxRewardsPerBlockCaller(contract),
+					contract: () => contract,
 				}
 			}
 

lib/ethereum/allocator/index.ts

@@ -3,9 +3,11 @@ import { Provider } from '@ethersproject/abstract-provider'
 import { Signer } from '@ethersproject/abstract-signer'
 import { allocatorAbi } from './abi'
 import { createCalculateMaxRewardsPerBlockCaller } from './calculateMaxRewardsPerBlock'
+import { always } from 'ramda'
 
 export type CreateAllocatorContract = {
 	readonly calculateMaxRewardsPerBlock: () => Promise<string>
+	readonly contract: () => ethers.Contract
 }
 
 export const createAllocatorContract =
@@ -15,5 +17,6 @@ export const createAllocatorContract =
 		return {
 			calculateMaxRewardsPerBlock:
 				createCalculateMaxRewardsPerBlockCaller(contract),
+			contract: always(contract),
 		}
 	}

lib/ethereum/dev/index.ts

@@ -14,6 +14,7 @@ import { createAllowanceCaller } from '../../common/erc20/allowance'
 import { createDepositCaller } from './deposit'
 import { FallbackableOverrides } from '../../common/utils/execute'
 import { TransactionResponse } from '@ethersproject/abstract-provider'
+import { always } from 'ramda'
 
 export type DevContract = {
 	readonly totalSupply: () => Promise<string>
@@ -34,6 +35,7 @@ export type DevContract = {
 		value: string,
 		overrides?: FallbackableOverrides
 	) => Promise<TransactionResponse>
+	readonly contract: () => ethers.Contract
 }
 
 export const createDevContract =
@@ -52,5 +54,6 @@ export const createDevContract =
 			symbol: createSymbolCaller(contract),
 			decimals: createDecimalsCaller(contract),
 			deposit: createDepositCaller(contract),
+			contract: always(contract),
 		}
 	}

lib/ethereum/lockup/index.spec.ts

@@ -104,6 +104,7 @@ describe('lockup/index.ts', () => {
 					depositToProperty: createDepositToPropertyCaller(contract),
 					depositToPosition: createDepositToPositionCaller(contract),
 					migrateToSTokens: createMigrateToSTokensCaller(contract),
+					contract: () => contract,
 				}
 			}
 

lib/ethereum/lockup/index.ts

@@ -19,6 +19,7 @@ import { createDepositToPositionCaller } from './depositToPosition'
 import { createMigrateToSTokensCaller } from './migrateToSTokens'
 import { FallbackableOverrides } from '../../common/utils/execute'
 import { TransactionResponse } from '@ethersproject/abstract-provider'
+import { always } from 'ramda'
 
 export type LockupContract = {
 	readonly getValue: (
@@ -72,6 +73,7 @@ export type LockupContract = {
 		positionTokenId: string,
 		overrides?: FallbackableOverrides
 	) => Promise<TransactionResponse>
+	readonly contract: () => ethers.Contract
 }
 
 export const createLockupContract =
@@ -100,5 +102,6 @@ export const createLockupContract =
 			depositToProperty: createDepositToPropertyCaller(contract),
 			depositToPosition: createDepositToPositionCaller(contract),
 			migrateToSTokens: createMigrateToSTokensCaller(contract),
+			contract: always(contract),
 		}
 	}

lib/ethereum/market-behavior/index.spec.ts

@@ -25,6 +25,7 @@ describe('getId/index.ts', () => {
 				return {
 					getId: createGetIdCaller(contract),
 					getMetrics: createGetMetricsCaller(contract),
+					contract: () => contract,
 				}
 			}