@cowprotocol/cow-sdk 0.0.9 → 0.0.12

package/README.md

@@ -166,12 +166,16 @@ const appDataDoc = cowSdk.metadataApi.generateAppDataDoc(
     } 
 */
 
+// Calculate appDataHash (and cidV0) for given doc without uploading to IPFS
+// This operation is deterministic and can be used to know before the upload the actual hash
+const { appDataHash, cidv0 } = await cowSdk.metadataApi.calculateAppDataHash(appDataDoc)
+
 // Upload AppDataDoc to IPFS (Pinata)
 const cowSdk = new CowSdk(4, {
   ipfs: { pinataApiKey: 'YOUR_PINATA_API_KEY', pinataApiSecret: 'YOUR_PINATA_API_SECRET' },
 })
 
-await cowSdk.metadataApi.uploadMetadataDocToIpfs(appDataDoc)
+const uploadedAppDataHash = await cowSdk.metadataApi.uploadMetadataDocToIpfs(appDataDoc)
 /* 0x5ddb2c8207c10b96fac92cb934ef9ba004bc007a073c9e5b13edc422f209ed80 */
 ```
 
@@ -184,22 +188,29 @@ const chainId = 1 // Mainnet
 const cowSdk = new CowSdk(chainId)
 
 // Get Cow Protocol totals
-const { totals } = await cowSdk.cowSubgraphApi.getTotals()
-const { tokens, orders, traders, settlements, volumeUsd, volumeEth, feesUsd, feesEth } = totals
+const { tokens, orders, traders, settlements, volumeUsd, volumeEth, feesUsd, feesEth } = await cowSdk.cowSubgraphApi.getTotals()
 console.log({ tokens, orders, traders, settlements, volumeUsd, volumeEth, feesUsd, feesEth })
 
+// Get last 24 hours volume in usd 
+const { hourlyTotals } = await cowSdk.cowSubgraphApi.getLastHoursVolume(24)
+console.log(hourlyTotals)
+
+// Get last week volume in usd
+const { dailyTotals } = await cowSdk.cowSubgraphApi.getLastDaysVolume(7)
+console.log(dailyTotals)
+
 // Get the last 5 batches
 const query = `
-query LastBatches($n: Int!) {
-  settlements(orderBy: timestamp, orderDirection: desc, first: $n) {
-    txHash
-    timestamp
+  query LastBatches($n: Int!) {
+    settlements(orderBy: firstTradeTimestamp, orderDirection: desc, first: $n) {
+      txHash
+      firstTradeTimestamp
+    }
   }
-}
 `
 const variables = { n: 5 }
 const response = await cowSdk.cowSubgraphApi.runQuery(query, variables)
-console.log(response.data.settlements)
+console.log(response)
 ```
 
 ### Install Dependencies

package/dist/api/cow/errors/OperatorError.d.ts

@@ -3,7 +3,7 @@ declare type ApiActionType = 'get' | 'create' | 'delete';
 export interface ApiErrorObject {
     errorType: ApiErrorCodes;
     description: string;
-    data?: any;
+    data?: unknown;
 }
 export declare enum ApiErrorCodes {
     DuplicateOrder = "DuplicateOrder",
@@ -59,5 +59,5 @@ export default class OperatorError extends CowError {
     static getErrorFromStatusCode(response: Response, action: 'create' | 'delete'): Promise<string>;
     constructor(apiError: ApiErrorObject);
 }
-export declare function isValidOperatorError(error: any): error is OperatorError;
+export declare function isValidOperatorError(error: unknown): error is OperatorError;
 export {};

package/dist/api/cow/errors/QuoteError.d.ts

@@ -3,7 +3,7 @@ import { ApiErrorObject } from './OperatorError';
 export interface GpQuoteErrorObject {
     errorType: GpQuoteErrorCodes;
     description: string;
-    data?: any;
+    data?: unknown;
 }
 export declare enum GpQuoteErrorCodes {
     UnsupportedToken = "UnsupportedToken",
@@ -23,10 +23,10 @@ export declare function mapOperatorErrorToQuoteError(error?: ApiErrorObject): Gp
 export default class GpQuoteError extends CowError {
     name: string;
     description: string;
-    data?: any;
+    data?: unknown;
     static quoteErrorDetails: typeof GpQuoteErrorDetails;
     static getErrorMessage(response: Response): Promise<string>;
     static getErrorFromStatusCode(response: Response): Promise<string>;
     constructor(quoteError: GpQuoteErrorObject);
 }
-export declare function isValidQuoteError(error: any): error is GpQuoteError;
+export declare function isValidQuoteError(error: unknown): error is GpQuoteError;

package/dist/api/cow/index.d.ts

@@ -1,6 +1,6 @@
 import { SupportedChainId as ChainId } from '../../constants/chains';
 import { OrderCreation } from '../../utils/sign';
-import { FeeQuoteParams, PriceInformation, PriceQuoteParams, SimpleGetQuoteResponse } from '../../utils/price';
+import { FeeQuoteParams, PriceInformation, PriceQuoteParams, SimpleGetQuoteResponse } from './types';
 import { GetOrdersParams, GetTradesParams, OrderCancellationParams, OrderID, OrderMetaData, ProfileData, TradeMetaData } from './types';
 import { Context } from '../../utils/context';
 export declare class CowApi {

package/dist/api/cow/types.d.ts

@@ -1,4 +1,4 @@
-import { OrderKind } from '@gnosis.pm/gp-v2-contracts';
+import { GetQuoteResponse, OrderKind } from '@gnosis.pm/gp-v2-contracts';
 import { SupportedChainId as ChainId } from '../../constants/chains';
 import { OrderCancellation, SigningSchemeValue } from '../../utils/sign';
 /**
@@ -71,3 +71,36 @@ export declare type ProfileData = {
     referralVolumeUsd: number;
     lastUpdated: string;
 };
+export interface QuoteParams {
+    quoteParams: FeeQuoteParams;
+    fetchFee: boolean;
+    previousFee?: FeeInformation;
+    isPriceRefresh: boolean;
+}
+export interface FeeInformation {
+    expirationDate: string;
+    amount: string;
+}
+export interface PriceInformation {
+    token: string;
+    amount: string | null;
+}
+export declare type SimpleGetQuoteResponse = Pick<GetQuoteResponse, 'from'> & {
+    quote: Omit<GetQuoteResponse['quote'], 'sellAmount' | 'buyAmount' | 'feeAmount' | 'validTo'> & {
+        sellAmount: string;
+        buyAmount: string;
+        validTo: string;
+        feeAmount: string;
+    };
+    expiration: string;
+};
+export declare type FeeQuoteParams = Pick<OrderMetaData, 'sellToken' | 'buyToken' | 'kind'> & {
+    amount: string;
+    userAddress?: string | null;
+    receiver?: string | null;
+    validTo: number;
+};
+export declare type PriceQuoteParams = Omit<FeeQuoteParams, 'sellToken' | 'buyToken'> & {
+    baseToken: string;
+    quoteToken: string;
+};