feat: add bridging metadata (#87)

* feat: add bridging metadata

* chore: bump version to 3.2.0

* chore: relax types for bridging

* chore: update regex

* chore: fix test

Author: shoom3301

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cowprotocol/app-data",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "CoW Protocol AppData schema definitions",
   "type": "module",
   "source": "src/index.ts",
@@ -91,4 +91,4 @@
       "@babel/preset-typescript"
     ]
   }
-}
+}

src/generatedTypes/index.ts

@@ -16,10 +16,11 @@ import * as v1_1_0 from './v1.1.0'
 import * as v1_2_0 from './v1.2.0'
 import * as v1_3_0 from './v1.3.0'
 import * as v1_4_0 from './v1.4.0'
+import * as v1_5_0 from './v1.5.0'
 
 export * from './latest'
 
-export const LATEST_APP_DATA_VERSION = '1.4.0'
+export const LATEST_APP_DATA_VERSION = '1.5.0'
 export const LATEST_QUOTE_METADATA_VERSION = '1.1.0'
 export const LATEST_REFERRER_METADATA_VERSION = '0.2.0'
 export const LATEST_ORDER_CLASS_METADATA_VERSION = '0.3.0'
@@ -30,8 +31,9 @@ export const LATEST_WIDGET_METADATA_VERSION = '0.1.0'
 export const LATEST_PARTNER_FEE_METADATA_VERSION = '1.0.0'
 export const LATEST_REPLACED_ORDER_METADATA_VERSION = '0.1.0'
 
-export type LatestAppDataDocVersion = v1_4_0.AppDataRootSchema
+export type LatestAppDataDocVersion = v1_5_0.AppDataRootSchema
 export type AnyAppDataDocVersion = 
+  | v1_5_0.AppDataRootSchema
   | v1_4_0.AppDataRootSchema
   | v1_3_0.AppDataRootSchema
   | v1_2_0.AppDataRootSchema
@@ -50,6 +52,7 @@ export type AnyAppDataDocVersion =
   | v0_1_0.AppDataRootSchema
 
 export {
+  v1_5_0,
   v1_4_0,
   v1_3_0,
   v1_2_0,

src/generatedTypes/latest.ts

@@ -1,3 +1,3 @@
 // generated file, do not edit manually
 
-export * as latest from './v1.4.0'
+export * as latest from './v1.5.0'

src/generatedTypes/v1.5.0.ts

@@ -0,0 +1,224 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+/**
+ * Semantic versioning of document.
+ */
+export type Version = string;
+/**
+ * The code identifying the CLI, UI, service generating the order.
+ */
+export type AppCode = string;
+/**
+ * Environment from which the order came from.
+ */
+export type Environment = string;
+/**
+ * The address of the trader who signs the CoW Swap order. This field should normally be omitted; it is recommended to use it if the signer is a smart-contract wallet using EIP-1271 signatures.
+ */
+export type Signer = string;
+export type ReferrerAddress = string;
+/**
+ * Tracks in which medium the traffic originated from (twitter, facebook, etc.)
+ */
+export type UTMSource = string;
+/**
+ * Tracks in which medium the traffic originated from (mail, CPC, social, etc.)
+ */
+export type UTMMedium = string;
+/**
+ * Track the performance of a specific campaign
+ */
+export type UTMCampaign = string;
+/**
+ * Track which link was clicked
+ */
+export type UTMContent = string;
+/**
+ * Track which keyword term a website visitor came from
+ */
+export type UTMKeywordTerm = string;
+/**
+ * Slippage tolerance that was applied to the order to get the limit price. Expressed in Basis Points (BPS). One basis point is equivalent to 0.01% (1/100th of a percent)
+ */
+export type SlippageBips = number;
+/**
+ * Whether the given slippageBips used is originated from a Smart slippage suggestion
+ */
+export type SmartSlippage = boolean;
+/**
+ * Indicator of the order class.
+ */
+export type OrderClass1 = "market" | "limit" | "liquidity" | "twap";
+/**
+ * Semantic versioning of document.
+ */
+export type Version1 = string;
+/**
+ * The contract to call for the hook
+ */
+export type HookTarget = string;
+/**
+ * The calldata to use when calling the hook
+ */
+export type HookCallData = string;
+/**
+ * The gas limit (in gas units) for the hook
+ */
+export type HookGasLimit = string;
+/**
+ * CoW Swap has an interface that allows dApps to build hooks for orders. This field is used to identify the dApp that has built the hook.
+ */
+export type IdOfTheDAppWhichHasBuiltTheHook = string;
+/**
+ * CoW Hooks to call before an order executes
+ */
+export type PreHooks = CoWHook[];
+/**
+ * CoW Hooks to call after an order executes
+ */
+export type PostHooks = CoWHook[];
+/**
+ * The code identifying the UI powering the widget
+ */
+export type AppCode1 = string;
+/**
+ * Environment from which the order came from.
+ */
+export type Environment1 = string;
+export type PartnerFee =
+  | (
+      | {
+          volumeBps: VolumeBasisPointBPS;
+          recipient: PartnerAccount;
+        }
+      | {
+          surplusBps: SurplusBasisPointBPS;
+          maxVolumeBps: MaxVolumeBasisPointBPS;
+          recipient: PartnerAccount;
+        }
+      | {
+          priceImprovementBps: PriceImprovementBasisPointBPS;
+          maxVolumeBps: MaxVolumeBasisPointBPS;
+          recipient: PartnerAccount;
+        }
+    )[]
+  | (
+      | {
+          volumeBps: VolumeBasisPointBPS;
+          recipient: PartnerAccount;
+        }
+      | {
+          surplusBps: SurplusBasisPointBPS;
+          maxVolumeBps: MaxVolumeBasisPointBPS;
+          recipient: PartnerAccount;
+        }
+      | {
+          priceImprovementBps: PriceImprovementBasisPointBPS;
+          maxVolumeBps: MaxVolumeBasisPointBPS;
+          recipient: PartnerAccount;
+        }
+    );
+/**
+ * The fee in basis points (BPS) to be paid to the partner based on volume. Capped at protocol level to 100 BPS (1%)
+ */
+export type VolumeBasisPointBPS = number;
+/**
+ * The Ethereum address of the partner to receive the fee.
+ */
+export type PartnerAccount = string;
+/**
+ * The fee in basis points (BPS) to be paid to the partner based on surplus
+ */
+export type SurplusBasisPointBPS = number;
+/**
+ * The maximum volume in basis points (BPS) to be paid to the partner. Capped at protocol level to 100 BPS (1%). You can chose to go lower but not higher
+ */
+export type MaxVolumeBasisPointBPS = number;
+/**
+ * The fee in basis points (BPS) to be paid to the partner based on price improvement
+ */
+export type PriceImprovementBasisPointBPS = number;
+/**
+ * The replaced order UID.
+ */
+export type ReplacedOrderUID = string;
+/**
+ * Id of a blockchain where funds will be received
+ */
+export type BridgingDestinationChainId = string;
+/**
+ * Address of a token that will be received at destination chain. The chain might be EVM or non-EVM. Some chains might even not have a token address. E.g.: Bitcoin
+ */
+export type BridgingDestinationTokenAddress = string;
+
+/**
+ * Metadata JSON document for adding information to orders.
+ */
+export interface AppDataRootSchema {
+  version: Version;
+  appCode?: AppCode;
+  environment?: Environment;
+  metadata: Metadata;
+}
+/**
+ * Each metadata will specify one aspect of the order.
+ */
+export interface Metadata {
+  signer?: Signer;
+  referrer?: Referrer;
+  utm?: UTMCodes;
+  quote?: Quote;
+  orderClass?: OrderClass;
+  hooks?: OrderInteractionHooks;
+  widget?: Widget;
+  partnerFee?: PartnerFee;
+  replacedOrder?: ReplacedOrder;
+  bridging?: Bridging;
+}
+export interface Referrer {
+  address: ReferrerAddress;
+}
+export interface UTMCodes {
+  utmSource?: UTMSource;
+  utmMedium?: UTMMedium;
+  utmCampaign?: UTMCampaign;
+  utmContent?: UTMContent;
+  utmTerm?: UTMKeywordTerm;
+}
+export interface Quote {
+  slippageBips: SlippageBips;
+  smartSlippage?: SmartSlippage;
+}
+export interface OrderClass {
+  orderClass: OrderClass1;
+}
+/**
+ * Optional Pre and Post order interaction hooks attached to a single order
+ */
+export interface OrderInteractionHooks {
+  version?: Version1;
+  pre?: PreHooks;
+  post?: PostHooks;
+}
+export interface CoWHook {
+  target: HookTarget;
+  callData: HookCallData;
+  gasLimit: HookGasLimit;
+  dappId?: IdOfTheDAppWhichHasBuiltTheHook;
+}
+export interface Widget {
+  appCode: AppCode1;
+  environment?: Environment1;
+}
+export interface ReplacedOrder {
+  uid: ReplacedOrderUID;
+}
+export interface Bridging {
+  destinationChainId: BridgingDestinationChainId;
+  destinationTokenAddress: BridgingDestinationTokenAddress;
+}

src/schemas/bridging/v0.1.0.json

@@ -0,0 +1,30 @@
+{
+  "$id": "#bridging/v0.1.0.json",
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "required": [
+    "destinationChainId",
+    "destinationTokenAddress"
+  ],
+  "title": "Bridging",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "destinationChainId": {
+      "$ref": "../definitions.json#/definitions/chainId",
+      "title": "Bridging destination chainId",
+      "description": "Id of a blockchain where funds will be received"
+    },
+    "destinationTokenAddress": {
+      "title": "Bridging destination token address",
+      "description": "Address of a token that will be received at destination chain. The chain might be EVM or non-EVM. Some chains might even not have a token address. E.g.: Bitcoin",
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9\\-.]{1,64}$",
+      "examples": [
+        "0x00E989b87700514118Fa55326CD1cCE82faebEF6",
+        "A.b19436aae4d94622.FiatToken",
+        "0.0.456858",
+        "1337"
+      ]
+    }
+  }
+}

src/schemas/definitions.json

@@ -47,6 +47,17 @@
       "title": "A hex string representing a dApp ID",
       "examples": ["75716a3cb48fdbb43ebdff58ce6c541f6a2c269be690513131355800367f2da2"],
       "type": "string"
+    },
+    "chainId": {
+      "$id": "#/definitions/chainId",
+      "pattern": "^[a-zA-Z0-9\\-_]{1,32}$",
+      "title": "Blockchain id",
+      "examples": [
+        "1",
+        "100",
+        "hedera-hashgraph"
+      ],
+      "type": "string"
     }
   }
 }