generateAppDataDoc() example

cowprotocol · Mar 3, 2023 · 5013ac3 · 5013ac3
1 parent 296f784
commit 5013ac3
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/src/metadata/api.ts b/src/metadata/api.ts
@@ -16,6 +16,23 @@ export class MetadataApi {
    *
    * Without params creates a default minimum appData doc
    * Optionally creates metadata docs
+   *
+   * Example of result:
+   * {
+   *   "appCode": "CoW Swap",
+   *   "environment": "local",
+   *   "metadata": {
+   *     "quote": {
+   *       "slippageBips": "50",
+   *       "version": "0.2.0"
+   *     },
+   *     "orderClass": {
+   *       "orderClass": "market",
+   *       "version": "0.1.0"
+   *     }
+   *   },
+   *   "version": "0.5.0"
+   * }
    */
   generateAppDataDoc(params?: GenerateAppDataDocParams): LatestAppDataDocVersion {
     const { appDataParams, metadataParams } = params || {}