-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add widget meta-data - v0.11.0 (#44)
* Add widget meta-data * Fix wrong schema * Add tests * Export the latest version of the widget metadata
- Loading branch information
Showing
6 changed files
with
310 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| /* 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 (BIPS) | ||
| */ | ||
| export type SlippageBips = string; | ||
| /** | ||
| * 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 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; | ||
|
|
||
| /** | ||
| * 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; | ||
| } | ||
| export interface Referrer { | ||
| address: ReferrerAddress; | ||
| } | ||
| export interface UTMCodes { | ||
| utmSource?: UTMSource; | ||
| utmMedium?: UTMMedium; | ||
| utmCampaign?: UTMCampaign; | ||
| utmContent?: UTMContent; | ||
| utmTerm?: UTMKeywordTerm; | ||
| } | ||
| export interface Quote { | ||
| slippageBips: SlippageBips; | ||
| } | ||
| 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; | ||
| } | ||
| export interface Widget { | ||
| appCode: AppCode1; | ||
| environment?: Environment1; | ||
| [k: string]: unknown; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| { | ||
| "$id": "https://cowswap.exchange/schemas/app-data/v0.11.0.json", | ||
| "$schema": "http://json-schema.org/draft-07/schema", | ||
| "description": "Metadata JSON document for adding information to orders.", | ||
| "required": ["version", "metadata"], | ||
| "title": "AppData Root Schema", | ||
| "type": "object", | ||
| "additionalProperties": false, | ||
| "properties": { | ||
| "version": { | ||
| "$ref": "definitions.json#/definitions/version", | ||
| "readOnly": true, | ||
| "default": "0.11.0" | ||
| }, | ||
| "appCode": { | ||
| "$id": "#/properties/appCode", | ||
| "description": "The code identifying the CLI, UI, service generating the order.", | ||
| "examples": ["CoW Swap"], | ||
| "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", | ||
| "type": "object", | ||
| "additionalProperties": false, | ||
| "properties": { | ||
| "signer": { | ||
| "$ref": "signer/v0.1.0.json#" | ||
| }, | ||
| "referrer": { | ||
| "$ref": "referrer/v0.2.0.json#" | ||
| }, | ||
| "utm": { | ||
| "$ref": "utm/v0.2.0.json#" | ||
| }, | ||
| "quote": { | ||
| "$ref": "quote/v0.3.0.json#" | ||
| }, | ||
| "orderClass": { | ||
| "$ref": "orderClass/v0.3.0.json#" | ||
| }, | ||
| "hooks": { | ||
| "$ref": "hooks/v0.1.0.json#" | ||
| }, | ||
| "widget": { | ||
| "$ref": "widget/v0.1.0.json#" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| { | ||
| "$id": "#widget/v0.1.0.json", | ||
| "$schema": "http://json-schema.org/draft-07/schema", | ||
| "required": ["appCode"], | ||
| "title": "Widget", | ||
| "type": "object", | ||
| "properties": { | ||
| "appCode": { | ||
| "$id": "#/properties/appCodeWidget", | ||
| "description": "The code identifying the UI powering the widget", | ||
| "examples": ["CoW Swap"], | ||
| "title": "App Code", | ||
| "type": "string" | ||
| }, | ||
| "environment": { | ||
| "$id": "#/properties/environmentWidget", | ||
| "description": "Environment from which the order came from.", | ||
| "title": "Environment", | ||
| "type": "string", | ||
| "examples": ["production", "development", "staging", "ens"] | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters