Create OwnerContext type

cowprotocol · Aug 30, 2023 · 4a11e0f · 4a11e0f
1 parent 0e31b9f
commit 4a11e0f
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 14 deletions.
diff --git a/src/composable/ConditionalOrder.ts b/src/composable/ConditionalOrder.ts
@@ -1,4 +1,4 @@
-import { BigNumber, ethers, utils, providers } from 'ethers'
+import { BigNumber, ethers, utils } from 'ethers'
 import { IConditionalOrder } from './generated/ComposableCoW'
 
 import { decodeParams, encodeParams } from './utils'
@@ -7,12 +7,12 @@ import {
   ConditionalOrderParams,
   ContextFactory,
   IsValidResult,
+  OwnerContext,
   PollParams,
   PollResult,
   PollResultCode,
   PollResultErrors,
 } from './types'
-import { SupportedChainId } from '../common'
 import { getComposableCow, getComposableCowInterface } from './contracts'
 
 /**
@@ -253,7 +253,7 @@ export abstract class ConditionalOrder<D, S> {
       }
 
       // Check if the owner authorised the order
-      const isAuthorized = await this.isAuthorized(owner, chainId, provider)
+      const isAuthorized = await this.isAuthorized(params)
       if (!isAuthorized) {
         return {
           result: PollResultCode.DONT_TRY_AGAIN,
@@ -290,8 +290,9 @@ export abstract class ConditionalOrder<D, S> {
    * @param provider An RPC provider for the chain.
    * @returns true if the owner authorized the order, false otherwise.
    */
-  public isAuthorized(owner: string, chain: SupportedChainId, provider: providers.Provider): Promise<boolean> {
-    const composableCow = getComposableCow(chain, provider)
+  public isAuthorized(params: OwnerContext): Promise<boolean> {
+    const { chainId, owner, provider } = params
+    const composableCow = getComposableCow(chainId, provider)
     return composableCow.callStatic.singleOrders(owner, this.id)
   }
 
@@ -303,8 +304,10 @@ export abstract class ConditionalOrder<D, S> {
    * @param provider An RPC provider for the chain.
    * @returns true if the owner authorized the order, false otherwise.
    */
-  public cabinet(owner: string, chain: SupportedChainId, provider: providers.Provider): Promise<string> {
-    const composableCow = getComposableCow(chain, provider)
+  public cabinet(params: OwnerContext): Promise<string> {
+    const { chainId, owner, provider } = params
+
+    const composableCow = getComposableCow(chainId, provider)
     return composableCow.callStatic.cabinet(owner, this.id)
   }
 

diff --git a/src/composable/orderTypes/Twap.ts b/src/composable/orderTypes/Twap.ts
@@ -1,4 +1,4 @@
-import { BigNumber, constants, providers } from 'ethers'
+import { BigNumber, constants } from 'ethers'
 
 import { ConditionalOrder } from '../ConditionalOrder'
 import {
@@ -7,12 +7,12 @@ import {
   ContextFactory,
   IsNotValid,
   IsValid,
+  OwnerContext,
   PollParams,
   PollResultCode,
   PollResultErrors,
 } from '../types'
 import { encodeParams, formatEpoch, getBlockInfo, isValidAbi } from '../utils'
-import { SupportedChainId } from '../../common'
 
 // The type of Conditional Order
 const TWAP_ORDER_TYPE = 'twap'
@@ -265,14 +265,14 @@ export class Twap extends ConditionalOrder<TwapData, TwapStruct> {
     return error ? { isValid: false, reason: error } : { isValid: true }
   }
 
-  private async startTimestamp(owner: string, chain: SupportedChainId, provider: providers.Provider): Promise<number> {
+  private async startTimestamp(params: OwnerContext): Promise<number> {
     const { startTime } = this.data
 
     if (startTime?.startType === StartTimeValue.AT_EPOC) {
       return startTime.epoch.toNumber()
     }
 
-    const cabinet = await this.cabinet(owner, chain, provider)
+    const cabinet = await this.cabinet(params)
     return parseInt(cabinet, 16)
   }
 
@@ -285,11 +285,11 @@ export class Twap extends ConditionalOrder<TwapData, TwapStruct> {
    * @returns true if the owner authorized the order, false otherwise.
    */
   protected async pollValidate(params: PollParams): Promise<PollResultErrors | undefined> {
-    const { blockInfo = await getBlockInfo(params.provider), owner, chainId, provider } = params
+    const { blockInfo = await getBlockInfo(params.provider) } = params
     const { blockTimestamp } = blockInfo
     const { numberOfParts, timeBetweenParts } = this.data
 
-    const startTimestamp = await this.startTimestamp(owner, chainId, provider)
+    const startTimestamp = await this.startTimestamp(params)
 
     if (startTimestamp > blockTimestamp) {
       // The start time hasn't started

diff --git a/src/composable/types.ts b/src/composable/types.ts
@@ -81,11 +81,13 @@ export type ProofWithParams = {
   params: ConditionalOrderParams
 }
 
-export type PollParams = {
+export type OwnerContext = {
   owner: string
   chainId: SupportedChainId
   provider: providers.Provider
+}
 
+export type PollParams = OwnerContext & {
   /**
    * If present, it can be used for custom conditional order validations. If not present, the orders will need to get the block info themselves
    */