@cowprotocol/cow-sdk 0.0.15 → 1.0.0-RC.0

package/dist/utils/appData.d.ts

@@ -1,9 +1,9 @@
-import { AppDataDoc } from '../types';
+import { AnyAppDataDocVersion } from '../types';
 interface ValidationResult {
     result: boolean;
     errors?: string;
 }
 export declare function getSerializedCID(hash: string): Promise<void | string>;
-export declare function loadIpfsFromCid(cid: string, ipfsUri?: string): Promise<AppDataDoc>;
-export declare function validateAppDataDocument(appDataDocument: unknown): Promise<ValidationResult>;
+export declare function loadIpfsFromCid(cid: string, ipfsUri?: string): Promise<AnyAppDataDocVersion>;
+export declare function validateAppDataDocument(appDataDocument: unknown, version: string): Promise<ValidationResult>;
 export {};

package/dist/utils/context.d.ts

@@ -1,5 +1,6 @@
 import { Signer } from 'ethers';
 import { SupportedChainId as ChainId } from '../constants/chains';
+export declare type Env = 'prod' | 'staging';
 export interface Ipfs {
     uri?: string;
     writeUri?: string;
@@ -9,19 +10,14 @@ export interface Ipfs {
 }
 export interface CowContext {
     appDataHash?: string;
-    isDevEnvironment?: boolean;
+    env?: Env;
     signer?: Signer;
     ipfs?: Ipfs;
 }
 export declare const DefaultCowContext: {
     appDataHash: string;
-    isDevEnvironment: boolean;
-    ipfs: {
-        readUri: string;
-        writeUri: string;
-        apiKey: undefined;
-        apiSecret: undefined;
-    };
+    ipfs: Ipfs;
+    env: Env;
 };
 /**
  *
@@ -38,7 +34,7 @@ export declare class Context implements Partial<CowContext> {
     updateChainId(chainId: ChainId): ChainId;
     get chainId(): Promise<ChainId>;
     get appDataHash(): string;
-    get isDevEnvironment(): boolean;
+    get env(): Env;
     get signer(): Signer | undefined;
     get ipfs(): Ipfs;
 }

package/dist/utils/ipfs.d.ts

@@ -1,10 +1,10 @@
 import { Ipfs } from './context';
-import { AppDataDoc } from '../api/metadata/types';
+import { AnyAppDataDocVersion } from '../api/metadata/types';
 declare type PinataPinResponse = {
     IpfsHash: string;
     PinSize: number;
     Timestamp: string;
 };
 export declare function pinJSONToIPFS(file: unknown, { writeUri, pinataApiKey, pinataApiSecret }: Ipfs): Promise<PinataPinResponse>;
-export declare function calculateIpfsCidV0(doc: AppDataDoc): Promise<string>;
+export declare function calculateIpfsCidV0(doc: AnyAppDataDocVersion): Promise<string>;
 export {};

package/dist/utils/market.d.ts

@@ -0,0 +1,16 @@
+import { OrderKind } from '@cowprotocol/contracts';
+interface Market<T = string> {
+    baseToken: T;
+    quoteToken: T;
+}
+export interface CanonicalMarketParams<T> {
+    sellToken: T;
+    buyToken: T;
+    kind: OrderKind;
+}
+export interface TokensFromMarketParams<T> extends Market<T> {
+    kind: OrderKind;
+}
+export declare function getCanonicalMarket<T>({ sellToken, buyToken, kind }: CanonicalMarketParams<T>): Market<T>;
+export declare function getTokensFromMarket<T>({ quoteToken, baseToken, kind, }: TokensFromMarketParams<T>): Omit<CanonicalMarketParams<T>, 'kind'>;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cowprotocol/cow-sdk",
-  "version": "0.0.15",
+  "version": "1.0.0-RC.0",
   "license": "(MIT OR Apache-2.0)",
   "source": "src/index.ts",
   "main": "./dist/index.js",
@@ -25,6 +25,7 @@
     "graphql:codegen": "graphql-codegen --config graphql-codegen.yml"
   },
   "dependencies": {
+    "@cowprotocol/app-data": "^0.0.1-RC.1",
     "@cowprotocol/contracts": "^1.3.1",
     "ajv": "^8.8.2",
     "cross-fetch": "^3.1.5",

package/dist/appData.schema-42d10730.js

@@ -1,2 +0,0 @@
-var e="https://cowswap.exchange/appdata.schema.json",t="http://json-schema.org/draft-07/schema",i="Metadata JSON document for adding information to orders.",r=["version","metadata"],s="AppData Root Schema",o={version:{$id:"#/properties/version",description:"Semantic versioning of document",examples:["1.0.0","1.2.3"],title:"Semantic Versioning",type:"string"},appCode:{$id:"#/properties/appCode",description:"The code identifying the CLI, UI, service generating the order.",examples:["CowSwap"],title:"App Code",type:"string"},environment:{$id:"#/properties/environment",description:"Environment from which the order came from",title:"Environment",type:"string",examples:["production","development","staging","ens"]},metadata:{$id:"#/properties/metadata",default:{},description:"Each metadata will specify one aspect of the order.",required:[],title:"Metadata descriptors",type:"object",properties:{referrer:{$ref:"#/definitions/kindMetadata/referrer"},quote:{$ref:"#/definitions/kindMetadata/quote"}}}},n={version:{$id:"#/definitions/version",description:"Semantic versioning of document",examples:["1.0.0","1.2.3"],title:"Semantic Versioning",type:"string"},ethereumAddress:{$id:"#/definitions/ethereumAddress",pattern:"^0x[a-fA-F0-9]{40}$",title:"Ethereum compatible address",examples:["0xb6BAd41ae76A11D10f7b0E664C5007b908bC77C9"],type:"string"},bigNumber:{$id:"#/definitions/bigNumber",pattern:"^\\d+$",title:"BigNumber",examples:["90741097240912730913, 0, 75891372"],type:"string"},kindMetadata:{referrer:{$id:"#/definitions/referrer",required:["version","address"],title:"Referrer",type:"object",properties:{version:{$ref:"#/definitions/version"},address:{$ref:"#/definitions/ethereumAddress",title:"Referrer address"}}},quote:{$id:"#/definitions/quote",required:["version","slippageBips"],title:"Quote",type:"object",properties:{version:{$ref:"#/definitions/version"},slippageBips:{$id:"#/definitions/quote/slippageBips",title:"Slippage tolerance that was applied to the order to get the limit price. Expressed in Basis Points (BIPS)",examples:["5","10","20","100"],pattern:"^\\d+(\\.\\d+)?$",type:"string"}}}}},d={$id:e,$schema:t,description:i,required:r,title:s,type:"object",properties:o,definitions:n};exports.$id=e,exports.$schema=t,exports.default=d,exports.definitions=n,exports.description=i,exports.properties=o,exports.required=r,exports.title=s,exports.type="object";
-//# sourceMappingURL=appData.schema-42d10730.js.map

package/dist/appData.schema-42d10730.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"appData.schema-42d10730.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/appData.schema-b8f018d7.js

@@ -1,2 +0,0 @@
-var e="https://cowswap.exchange/appdata.schema.json",t="http://json-schema.org/draft-07/schema",i="Metadata JSON document for adding information to orders.",r=["version","metadata"],n="AppData Root Schema",s="object",o={version:{$id:"#/properties/version",description:"Semantic versioning of document",examples:["1.0.0","1.2.3"],title:"Semantic Versioning",type:"string"},appCode:{$id:"#/properties/appCode",description:"The code identifying the CLI, UI, service generating the order.",examples:["CowSwap"],title:"App Code",type:"string"},environment:{$id:"#/properties/environment",description:"Environment from which the order came from",title:"Environment",type:"string",examples:["production","development","staging","ens"]},metadata:{$id:"#/properties/metadata",default:{},description:"Each metadata will specify one aspect of the order.",required:[],title:"Metadata descriptors",type:"object",properties:{referrer:{$ref:"#/definitions/kindMetadata/referrer"},quote:{$ref:"#/definitions/kindMetadata/quote"}}}},d={version:{$id:"#/definitions/version",description:"Semantic versioning of document",examples:["1.0.0","1.2.3"],title:"Semantic Versioning",type:"string"},ethereumAddress:{$id:"#/definitions/ethereumAddress",pattern:"^0x[a-fA-F0-9]{40}$",title:"Ethereum compatible address",examples:["0xb6BAd41ae76A11D10f7b0E664C5007b908bC77C9"],type:"string"},bigNumber:{$id:"#/definitions/bigNumber",pattern:"^\\d+$",title:"BigNumber",examples:["90741097240912730913, 0, 75891372"],type:"string"},kindMetadata:{referrer:{$id:"#/definitions/referrer",required:["version","address"],title:"Referrer",type:"object",properties:{version:{$ref:"#/definitions/version"},address:{$ref:"#/definitions/ethereumAddress",title:"Referrer address"}}},quote:{$id:"#/definitions/quote",required:["version","slippageBips"],title:"Quote",type:"object",properties:{version:{$ref:"#/definitions/version"},slippageBips:{$id:"#/definitions/quote/slippageBips",title:"Slippage tolerance that was applied to the order to get the limit price. Expressed in Basis Points (BIPS)",examples:["5","10","20","100"],pattern:"^\\d+(\\.\\d+)?$",type:"string"}}}}},a={$id:e,$schema:t,description:i,required:r,title:n,type:"object",properties:o,definitions:d};export{e as $id,t as $schema,a as default,d as definitions,i as description,o as properties,r as required,n as title,s as type};
-//# sourceMappingURL=appData.schema-b8f018d7.js.map

package/dist/appData.schema-b8f018d7.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"appData.schema-b8f018d7.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}