@wildcatfi/wildcat-sdk 2.0.75 → 2.0.76

package/README.md

@@ -5,14 +5,15 @@
 ### 1. Get controller info for borrower
 
 ```ts
-import { getController, MarketController, MarketParameters } from '@wildcatfi/wildcat-sdk';
+import { getController, MarketController, MarketParameters } from "@wildcatfi/wildcat-sdk";
 
 const controller: MarketController = await getController(signer, borrower);
 ```
 
 ### 2. Get parameter constraints for new markets
 
-`controller.constraints: MarketParameterConstraints` contains the min/max values of 
+`controller.constraints: MarketParameterConstraints` contains the min/max values of
+
 - `annualInterestBips`
 - `delinquencyFeeBips`
 - `withdrawalBatchDuration`
@@ -21,13 +22,12 @@ const controller: MarketController = await getController(signer, borrower);
 
 If provided values are out of this range, market deployment will revert.
 
-
 ### 3. Deploying a mock token for new market
 
 ```ts
 import { deployToken } from "@wildcatfi/wildcat-sdk";
 
-await deployToken(signer, 'name', 'symbol')
+await deployToken(signer, "name", "symbol");
 ```
 
 ### 4. Deploying new market
@@ -56,7 +56,7 @@ const market: Market = await controller.deployMarket(marketParameters);
 ### 1. Get all `Market` instances on Wildcat
 
 ```ts
-import { getAllMarkets } from '@wildcatfi/wildcat-sdk';
+import { getAllMarkets } from "@wildcatfi/wildcat-sdk";
 
 const markets = getAllMarkets(provider);
 ```
@@ -73,16 +73,29 @@ const controller: MarketController = await getController(signer, borrower);
 ## Get `MarketAccount`
 
 ### 1. Get `MarketAccount` for every market
+
 ```ts
-import { getAllMarketAccountsForLender } from '@wildcatfi/wildcat-sdk';
+import { getAllMarketAccountsForLender } from "@wildcatfi/wildcat-sdk";
 const accounts = await getAllMarketAccountsForLender(signer, lenderAddress);
 ```
 
 ## Deposit
 
 ### 1. Get underlying assets from mock token
+
 ```ts
 if (market.underlyingToken.isMock) {
   await market.underlyingToken.faucet();
 }
 ```
+
+# Development
+
+Whenever anything in `./gql` or `./contracts` is changed, run `yarn codegen` to regenerate the graphql and typechain types.
+
+The graphql scripts take a while to run, so the graphql script saves a file in [.gql-cache](./scripts/.gql-cache) with the checksums of the previous input/output files from gql codegen, so the script can skip graphql codegen if there's no reason to. Typechain only takes about a second so we don't do the same for it.
+
+This runs:
+
+- `yarn codegen:gql` - Generates TS types for all the graphql queries, then runs a script to simplify the type literals ([gql-type-cleanup.js](./scripts/gql-type-cleanup.js))
+- `yarn codegen:typechain` - Generates types for the contracts with typechain, then runs a script ([add-typechain-exports.js](./scripts/add-typechain-exports.js)) to add exports for all the structs in the contracts to the src/typechain index file

package/dist/gql/graphql.d.ts

@@ -58,6 +58,10 @@ export type Scalars = {
         input: any;
         output: any;
     };
+    Timestamp: {
+        input: any;
+        output: any;
+    };
 };
 export declare enum SubgraphAggregation_Interval {
     Day = "day",
@@ -2656,12 +2660,15 @@ export declare enum SubgraphLenderWithdrawalStatus_OrderBy {
     AccountTotalDeposited = "account__totalDeposited",
     AccountTotalInterestEarned = "account__totalInterestEarned",
     Batch = "batch",
+    BatchCompletedWithdrawalsCount = "batch__completedWithdrawalsCount",
     BatchExpiry = "batch__expiry",
     BatchId = "batch__id",
     BatchIsClosed = "batch__isClosed",
+    BatchIsCompleted = "batch__isCompleted",
     BatchIsExpired = "batch__isExpired",
     BatchLastScaleFactor = "batch__lastScaleFactor",
     BatchLastUpdatedTimestamp = "batch__lastUpdatedTimestamp",
+    BatchLenderWithdrawalsCount = "batch__lenderWithdrawalsCount",
     BatchNormalizedAmountClaimed = "batch__normalizedAmountClaimed",
     BatchNormalizedAmountPaid = "batch__normalizedAmountPaid",
     BatchPaymentsCount = "batch__paymentsCount",
@@ -6564,15 +6571,18 @@ export declare enum SubgraphUpdateProtocolFeeConfiguration_OrderBy {
 }
 export type SubgraphWithdrawalBatch = {
     __typename: "WithdrawalBatch";
+    completedWithdrawalsCount: Scalars["Int"]["output"];
     creation: SubgraphWithdrawalBatchCreated;
     executions: SubgraphWithdrawalExecution[];
     expiry: Scalars["BigInt"]["output"];
     id: Scalars["ID"]["output"];
     interestAccrualRecords: SubgraphWithdrawalBatchInterestAccrued[];
     isClosed: Scalars["Boolean"]["output"];
+    isCompleted: Scalars["Boolean"]["output"];
     isExpired: Scalars["Boolean"]["output"];
     lastScaleFactor: Scalars["BigInt"]["output"];
     lastUpdatedTimestamp: Scalars["Int"]["output"];
+    lenderWithdrawalsCount: Scalars["Int"]["output"];
     market: SubgraphMarket;
     normalizedAmountClaimed: Scalars["BigInt"]["output"];
     normalizedAmountPaid: Scalars["BigInt"]["output"];
@@ -6673,12 +6683,15 @@ export type SubgraphWithdrawalBatchCreated_Filter = {
 };
 export declare enum SubgraphWithdrawalBatchCreated_OrderBy {
     Batch = "batch",
+    BatchCompletedWithdrawalsCount = "batch__completedWithdrawalsCount",
     BatchExpiry = "batch__expiry",
     BatchId = "batch__id",
     BatchIsClosed = "batch__isClosed",
+    BatchIsCompleted = "batch__isCompleted",
     BatchIsExpired = "batch__isExpired",
     BatchLastScaleFactor = "batch__lastScaleFactor",
     BatchLastUpdatedTimestamp = "batch__lastUpdatedTimestamp",
+    BatchLenderWithdrawalsCount = "batch__lenderWithdrawalsCount",
     BatchNormalizedAmountClaimed = "batch__normalizedAmountClaimed",
     BatchNormalizedAmountPaid = "batch__normalizedAmountPaid",
     BatchPaymentsCount = "batch__paymentsCount",
@@ -6789,12 +6802,15 @@ export type SubgraphWithdrawalBatchExpired_Filter = {
 };
 export declare enum SubgraphWithdrawalBatchExpired_OrderBy {
     Batch = "batch",
+    BatchCompletedWithdrawalsCount = "batch__completedWithdrawalsCount",
     BatchExpiry = "batch__expiry",
     BatchId = "batch__id",
     BatchIsClosed = "batch__isClosed",
+    BatchIsCompleted = "batch__isCompleted",
     BatchIsExpired = "batch__isExpired",
     BatchLastScaleFactor = "batch__lastScaleFactor",
     BatchLastUpdatedTimestamp = "batch__lastUpdatedTimestamp",
+    BatchLenderWithdrawalsCount = "batch__lenderWithdrawalsCount",
     BatchNormalizedAmountClaimed = "batch__normalizedAmountClaimed",
     BatchNormalizedAmountPaid = "batch__normalizedAmountPaid",
     BatchPaymentsCount = "batch__paymentsCount",
@@ -6912,12 +6928,15 @@ export type SubgraphWithdrawalBatchInterestAccrued_Filter = {
 };
 export declare enum SubgraphWithdrawalBatchInterestAccrued_OrderBy {
     Batch = "batch",
+    BatchCompletedWithdrawalsCount = "batch__completedWithdrawalsCount",
     BatchExpiry = "batch__expiry",
     BatchId = "batch__id",
     BatchIsClosed = "batch__isClosed",
+    BatchIsCompleted = "batch__isCompleted",
     BatchIsExpired = "batch__isExpired",
     BatchLastScaleFactor = "batch__lastScaleFactor",
     BatchLastUpdatedTimestamp = "batch__lastUpdatedTimestamp",
+    BatchLenderWithdrawalsCount = "batch__lenderWithdrawalsCount",
     BatchNormalizedAmountClaimed = "batch__normalizedAmountClaimed",
     BatchNormalizedAmountPaid = "batch__normalizedAmountPaid",
     BatchPaymentsCount = "batch__paymentsCount",
@@ -7066,12 +7085,15 @@ export type SubgraphWithdrawalBatchPayment_Filter = {
 };
 export declare enum SubgraphWithdrawalBatchPayment_OrderBy {
     Batch = "batch",
+    BatchCompletedWithdrawalsCount = "batch__completedWithdrawalsCount",
     BatchExpiry = "batch__expiry",
     BatchId = "batch__id",
     BatchIsClosed = "batch__isClosed",
+    BatchIsCompleted = "batch__isCompleted",
     BatchIsExpired = "batch__isExpired",
     BatchLastScaleFactor = "batch__lastScaleFactor",
     BatchLastUpdatedTimestamp = "batch__lastUpdatedTimestamp",
+    BatchLenderWithdrawalsCount = "batch__lenderWithdrawalsCount",
     BatchNormalizedAmountClaimed = "batch__normalizedAmountClaimed",
     BatchNormalizedAmountPaid = "batch__normalizedAmountPaid",
     BatchPaymentsCount = "batch__paymentsCount",
@@ -7090,6 +7112,14 @@ export type SubgraphWithdrawalBatch_Filter = {
     /** Filter for the block changed event. */
     _change_block?: InputMaybe<SubgraphBlockChangedFilter>;
     and?: InputMaybe<Array<InputMaybe<SubgraphWithdrawalBatch_Filter>>>;
+    completedWithdrawalsCount?: InputMaybe<Scalars["Int"]["input"]>;
+    completedWithdrawalsCount_gt?: InputMaybe<Scalars["Int"]["input"]>;
+    completedWithdrawalsCount_gte?: InputMaybe<Scalars["Int"]["input"]>;
+    completedWithdrawalsCount_in?: InputMaybe<Array<Scalars["Int"]["input"]>>;
+    completedWithdrawalsCount_lt?: InputMaybe<Scalars["Int"]["input"]>;
+    completedWithdrawalsCount_lte?: InputMaybe<Scalars["Int"]["input"]>;
+    completedWithdrawalsCount_not?: InputMaybe<Scalars["Int"]["input"]>;
+    completedWithdrawalsCount_not_in?: InputMaybe<Array<Scalars["Int"]["input"]>>;
     creation_?: InputMaybe<SubgraphWithdrawalBatchCreated_Filter>;
     executions_?: InputMaybe<SubgraphWithdrawalExecution_Filter>;
     expiry?: InputMaybe<Scalars["BigInt"]["input"]>;
@@ -7113,6 +7143,10 @@ export type SubgraphWithdrawalBatch_Filter = {
     isClosed_in?: InputMaybe<Array<Scalars["Boolean"]["input"]>>;
     isClosed_not?: InputMaybe<Scalars["Boolean"]["input"]>;
     isClosed_not_in?: InputMaybe<Array<Scalars["Boolean"]["input"]>>;
+    isCompleted?: InputMaybe<Scalars["Boolean"]["input"]>;
+    isCompleted_in?: InputMaybe<Array<Scalars["Boolean"]["input"]>>;
+    isCompleted_not?: InputMaybe<Scalars["Boolean"]["input"]>;
+    isCompleted_not_in?: InputMaybe<Array<Scalars["Boolean"]["input"]>>;
     isExpired?: InputMaybe<Scalars["Boolean"]["input"]>;
     isExpired_in?: InputMaybe<Array<Scalars["Boolean"]["input"]>>;
     isExpired_not?: InputMaybe<Scalars["Boolean"]["input"]>;
@@ -7133,6 +7167,14 @@ export type SubgraphWithdrawalBatch_Filter = {
     lastUpdatedTimestamp_lte?: InputMaybe<Scalars["Int"]["input"]>;
     lastUpdatedTimestamp_not?: InputMaybe<Scalars["Int"]["input"]>;
     lastUpdatedTimestamp_not_in?: InputMaybe<Array<Scalars["Int"]["input"]>>;
+    lenderWithdrawalsCount?: InputMaybe<Scalars["Int"]["input"]>;
+    lenderWithdrawalsCount_gt?: InputMaybe<Scalars["Int"]["input"]>;
+    lenderWithdrawalsCount_gte?: InputMaybe<Scalars["Int"]["input"]>;
+    lenderWithdrawalsCount_in?: InputMaybe<Array<Scalars["Int"]["input"]>>;
+    lenderWithdrawalsCount_lt?: InputMaybe<Scalars["Int"]["input"]>;
+    lenderWithdrawalsCount_lte?: InputMaybe<Scalars["Int"]["input"]>;
+    lenderWithdrawalsCount_not?: InputMaybe<Scalars["Int"]["input"]>;
+    lenderWithdrawalsCount_not_in?: InputMaybe<Array<Scalars["Int"]["input"]>>;
     market?: InputMaybe<Scalars["String"]["input"]>;
     market_?: InputMaybe<SubgraphMarket_Filter>;
     market_contains?: InputMaybe<Scalars["String"]["input"]>;
@@ -7216,6 +7258,7 @@ export type SubgraphWithdrawalBatch_Filter = {
     withdrawals_?: InputMaybe<SubgraphLenderWithdrawalStatus_Filter>;
 };
 export declare enum SubgraphWithdrawalBatch_OrderBy {
+    CompletedWithdrawalsCount = "completedWithdrawalsCount",
     Creation = "creation",
     CreationBlockNumber = "creation__blockNumber",
     CreationBlockTimestamp = "creation__blockTimestamp",
@@ -7226,9 +7269,11 @@ export declare enum SubgraphWithdrawalBatch_OrderBy {
     Id = "id",
     InterestAccrualRecords = "interestAccrualRecords",
     IsClosed = "isClosed",
+    IsCompleted = "isCompleted",
     IsExpired = "isExpired",
     LastScaleFactor = "lastScaleFactor",
     LastUpdatedTimestamp = "lastUpdatedTimestamp",
+    LenderWithdrawalsCount = "lenderWithdrawalsCount",
     Market = "market",
     MarketAnnualInterestBips = "market__annualInterestBips",
     MarketAnnualInterestBipsUpdatedIndex = "market__annualInterestBipsUpdatedIndex",
@@ -7420,12 +7465,15 @@ export declare enum SubgraphWithdrawalExecution_OrderBy {
     AccountTotalDeposited = "account__totalDeposited",
     AccountTotalInterestEarned = "account__totalInterestEarned",
     Batch = "batch",
+    BatchCompletedWithdrawalsCount = "batch__completedWithdrawalsCount",
     BatchExpiry = "batch__expiry",
     BatchId = "batch__id",
     BatchIsClosed = "batch__isClosed",
+    BatchIsCompleted = "batch__isCompleted",
     BatchIsExpired = "batch__isExpired",
     BatchLastScaleFactor = "batch__lastScaleFactor",
     BatchLastUpdatedTimestamp = "batch__lastUpdatedTimestamp",
+    BatchLenderWithdrawalsCount = "batch__lenderWithdrawalsCount",
     BatchNormalizedAmountClaimed = "batch__normalizedAmountClaimed",
     BatchNormalizedAmountPaid = "batch__normalizedAmountPaid",
     BatchPaymentsCount = "batch__paymentsCount",
@@ -7639,12 +7687,15 @@ export declare enum SubgraphWithdrawalRequest_OrderBy {
     AccountTotalDeposited = "account__totalDeposited",
     AccountTotalInterestEarned = "account__totalInterestEarned",
     Batch = "batch",
+    BatchCompletedWithdrawalsCount = "batch__completedWithdrawalsCount",
     BatchExpiry = "batch__expiry",
     BatchId = "batch__id",
     BatchIsClosed = "batch__isClosed",
+    BatchIsCompleted = "batch__isCompleted",
     BatchIsExpired = "batch__isExpired",
     BatchLastScaleFactor = "batch__lastScaleFactor",
     BatchLastUpdatedTimestamp = "batch__lastUpdatedTimestamp",
+    BatchLenderWithdrawalsCount = "batch__lenderWithdrawalsCount",
     BatchNormalizedAmountClaimed = "batch__normalizedAmountClaimed",
     BatchNormalizedAmountPaid = "batch__normalizedAmountPaid",
     BatchPaymentsCount = "batch__paymentsCount",
@@ -8002,6 +8053,7 @@ export type SubgraphWithdrawalBatchPropertiesFragment = {
     totalNormalizedRequests: string;
     isExpired: boolean;
     isClosed: boolean;
+    isCompleted: boolean;
     paymentsCount: number;
     lastScaleFactor: string;
     lastUpdatedTimestamp: number;
@@ -8025,6 +8077,7 @@ export type SubgraphWithdrawalBatchPropertiesWithEventsFragment = {
     totalNormalizedRequests: string;
     isExpired: boolean;
     isClosed: boolean;
+    isCompleted: boolean;
     paymentsCount: number;
     lastScaleFactor: string;
     lastUpdatedTimestamp: number;
@@ -8633,6 +8686,14 @@ export type SubgraphGetAllPendingWithdrawalBatchesForMarketQuery = {
         withdrawalBatches: SubgraphWithdrawalBatchPropertiesWithEventsFragment[];
     } | null;
 };
+export type SubgraphGetIncompleteWithdrawalsForMarketQueryVariables = Exact<{
+    market: Scalars["ID"]["input"];
+    numWithdrawalBatches?: InputMaybe<Scalars["Int"]["input"]>;
+    skipWithdrawalBatches?: InputMaybe<Scalars["Int"]["input"]>;
+    orderWithdrawalBatches?: InputMaybe<SubgraphWithdrawalBatch_OrderBy>;
+    directionWithdrawalBatches?: InputMaybe<SubgraphOrderDirection>;
+}>;
+export type SubgraphGetIncompleteWithdrawalsForMarketQuery = SubgraphGetAllPendingWithdrawalBatchesForMarketQuery;
 export type SubgraphGetAllMarketsQueryVariables = Exact<{
     [key: string]: never;
 }>;
@@ -8654,11 +8715,17 @@ export type SubgraphGetAuthorizedLendersByMarketQuery = {
                 lender: string;
                 authorized: boolean;
                 changes: Array<{
-                    __typename: "Change";
+                    __typename: "LenderAuthorizationChange";
                     blockTimestamp: number;
                 }>;
             }>;
         };
+        lenders: Array<{
+            __typename: "LenderAccount";
+            address: string;
+            scaledBalance: string;
+            role: SubgraphLenderStatus;
+        }>;
     } | null;
 };
 export type SubgraphGetAuthorizedLendersByBorrowerQueryVariables = Exact<{
@@ -9162,6 +9229,34 @@ export type GetAllPendingWithdrawalBatchesForMarketQueryHookResult = Apollo.Quer
 export type GetAllPendingWithdrawalBatchesForMarketLazyQueryHookResult = Apollo.LazyQueryResultTuple<SubgraphGetAllPendingWithdrawalBatchesForMarketQuery, SubgraphGetAllPendingWithdrawalBatchesForMarketQueryVariables>;
 export type GetAllPendingWithdrawalBatchesForMarketSuspenseQueryHookResult = Apollo.UseSuspenseQueryResult<SubgraphGetAllPendingWithdrawalBatchesForMarketQuery, SubgraphGetAllPendingWithdrawalBatchesForMarketQueryVariables>;
 export type GetAllPendingWithdrawalBatchesForMarketQueryResult = Apollo.QueryResult<SubgraphGetAllPendingWithdrawalBatchesForMarketQuery, SubgraphGetAllPendingWithdrawalBatchesForMarketQueryVariables>;
+export declare const GetIncompleteWithdrawalsForMarketDocument: Apollo.DocumentNode;
+/**
+ * __useGetIncompleteWithdrawalsForMarketQuery__
+ *
+ * To run a query within a React component, call `useGetIncompleteWithdrawalsForMarketQuery` and pass it any options that fit your needs.
+ * When your component renders, `useGetIncompleteWithdrawalsForMarketQuery` returns an object from Apollo Client that contains loading, error, and data properties
+ * you can use to render your UI.
+ *
+ * @param baseOptions options that will be passed into the query, supported options are listed on: https://www.apollographql.com/docs/react/api/react-hooks/#options;
+ *
+ * @example
+ * const { data, loading, error } = useGetIncompleteWithdrawalsForMarketQuery({
+ *   variables: {
+ *      market: // value for 'market'
+ *      numWithdrawalBatches: // value for 'numWithdrawalBatches'
+ *      skipWithdrawalBatches: // value for 'skipWithdrawalBatches'
+ *      orderWithdrawalBatches: // value for 'orderWithdrawalBatches'
+ *      directionWithdrawalBatches: // value for 'directionWithdrawalBatches'
+ *   },
+ * });
+ */
+export declare function useGetIncompleteWithdrawalsForMarketQuery(baseOptions: Apollo.QueryHookOptions<SubgraphGetIncompleteWithdrawalsForMarketQuery, SubgraphGetIncompleteWithdrawalsForMarketQueryVariables>): GetIncompleteWithdrawalsForMarketQueryHookResult;
+export declare function useGetIncompleteWithdrawalsForMarketLazyQuery(baseOptions?: Apollo.LazyQueryHookOptions<SubgraphGetIncompleteWithdrawalsForMarketQuery, SubgraphGetIncompleteWithdrawalsForMarketQueryVariables>): GetIncompleteWithdrawalsForMarketLazyQueryHookResult;
+export declare function useGetIncompleteWithdrawalsForMarketSuspenseQuery(baseOptions?: Apollo.SuspenseQueryHookOptions<SubgraphGetIncompleteWithdrawalsForMarketQuery, SubgraphGetIncompleteWithdrawalsForMarketQueryVariables>): GetIncompleteWithdrawalsForMarketSuspenseQueryHookResult;
+export type GetIncompleteWithdrawalsForMarketQueryHookResult = Apollo.QueryResult<SubgraphGetIncompleteWithdrawalsForMarketQuery, SubgraphGetIncompleteWithdrawalsForMarketQueryVariables>;
+export type GetIncompleteWithdrawalsForMarketLazyQueryHookResult = Apollo.LazyQueryResultTuple<SubgraphGetIncompleteWithdrawalsForMarketQuery, SubgraphGetIncompleteWithdrawalsForMarketQueryVariables>;
+export type GetIncompleteWithdrawalsForMarketSuspenseQueryHookResult = Apollo.UseSuspenseQueryResult<SubgraphGetIncompleteWithdrawalsForMarketQuery, SubgraphGetIncompleteWithdrawalsForMarketQueryVariables>;
+export type GetIncompleteWithdrawalsForMarketQueryResult = Apollo.QueryResult<SubgraphGetIncompleteWithdrawalsForMarketQuery, SubgraphGetIncompleteWithdrawalsForMarketQueryVariables>;
 export declare const GetAllMarketsDocument: Apollo.DocumentNode;
 /**
  * __useGetAllMarketsQuery__