@azuro-org/toolkit 3.0.0 → 4.1.0

package/.eslintrc

@@ -0,0 +1,166 @@
+{
+  "extends": [
+    "plugin:import/errors",
+    "plugin:import/warnings",
+    "plugin:import/recommended"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "plugins": [
+    "import",
+    "@typescript-eslint"
+  ],
+  "ignorePatterns": [
+    "*.js",
+    "*.graphql.ts",
+    "src/docs/*",
+    "examples/**",
+    "*.json",
+    "codegen.ts"
+    // "./dist"
+  ],
+  "settings": {
+    "import/parsers": {
+      "@typescript-eslint/parser": [".ts", ".tsx"]
+    },
+    "import/resolver": {
+      "typescript": "./tsconfig.json"
+    }
+  },
+  "parserOptions": {
+    "project": "./tsconfig.json"
+  },
+  "rules": {
+    // Common
+
+    "padding-line-between-statements": [
+      "error",
+      {
+        "blankLine": "always",
+        "prev": "*",
+        "next": [ "return", "if", "try" ]
+      }
+    ],
+
+    "eol-last": [
+      "error",
+      "always"
+    ],
+    "curly": [
+      "error"
+    ],
+    "indent": "off",
+    "quotes": [
+      "error",
+      "single"
+    ],
+    "brace-style": [
+      "error",
+      "stroustrup"
+    ],
+    "prefer-const": "off",
+    "key-spacing": [
+      "error",
+      { "beforeColon": false }
+    ],
+    "arrow-spacing": "error",
+    "space-infix-ops": "error",
+    "space-before-blocks": "error",
+    "no-multi-spaces": "warn",
+    "no-trailing-spaces": "warn",
+    "semi": [
+      "error",
+      "never"
+    ],
+    "max-len": "off",
+    "object-curly-spacing": [
+      "error",
+      "always"
+    ],
+    "array-bracket-spacing": [
+      "error",
+      "always"
+    ],
+    "no-multiple-empty-lines": [
+      "error",
+      {
+        "max": 2
+      }
+    ],
+    "comma-spacing": "warn",
+    "comma-dangle": [
+      "error",
+      {
+        "arrays": "always-multiline",
+        "objects": "always-multiline",
+        "imports": "always-multiline",
+        "exports": "always-multiline",
+        "functions": "never"
+      }
+    ],
+    "keyword-spacing": "error",
+
+    // Import plugin
+
+    "import/order": [
+      "error",
+      {
+        "groups": [
+          [ "builtin", "external" ],
+          "internal"
+        ],
+        "pathGroups": [
+          {
+            "pattern": "react",
+            "group": "builtin",
+            "position": "before"
+          },
+          {
+            "pattern": "wagmi",
+            "group": "external"
+          },
+          {
+            "pattern": "viem",
+            "group": "external"
+          },
+          {
+            "pattern": "cookies-next",
+            "group": "external"
+          },
+          {
+            "pattern": "@apollo/**",
+            "group": "external"
+          }
+        ],
+        "newlines-between": "always"
+      }
+    ],
+    "import/first": 0,
+    "import/extensions": 0,
+    "import/no-unresolved": 0,
+    "import/no-dynamic-require": 0,
+    "import/prefer-default-export": 0,
+    "import/no-webpack-loader-syntax": 0,
+    "import/no-named-as-default-member": 1,
+    "import/no-extraneous-dependencies": 0,
+    "import/no-anonymous-default-export": 0,
+    "import/newline-after-import": [
+      "error",
+      {
+        "count": 2
+      }
+    ],
+    // typescript
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/no-for-in-array": "error",
+    "@typescript-eslint/await-thenable": "warn",
+    "@typescript-eslint/consistent-type-imports": "error",
+    "@typescript-eslint/type-annotation-spacing": "error",
+    "@typescript-eslint/indent": [
+      "error",
+      2,
+      {
+        "SwitchCase": 1
+      }
+    ]
+  }
+}

package/README.md

@@ -1,4 +1,4 @@
-# Toolkit Package
+# Toolkit
 
 This package provides helpers to develop an app using Azuro Protocol.
 
@@ -9,116 +9,13 @@ This package provides helpers to develop an app using Azuro Protocol.
 npm i --save @azuro-org/toolkit
 ```
 
+#### Peer Dependencies
 
-## Helpers
-
-### `aggregateOutcomesByMarkets.ts`
-
-This helper function allows you to aggregate outcomes that are obtained from conditions by markets. This function takes 
-an array of conditions and groups outcomes by their market key. It then sorts the outcomes within each market group 
-and returns an array of market objects, each containing an array of outcomes.
-
-Here is an example of how you can use it:
-
-```graphql
-query Game($id: String!) {
-  game(id: $id) {
-    liquidityPool {
-      address
-    }
-    conditions {
-      conditionId
-      coreAddress
-      outcomes {
-        outcomeId
-      }
-    }
-  }
-}
-```
-
-```ts
-type Conditions = {
-  conditionId: string
-  coreAddress: string
-  outcomes: {
-    outcomeId: string
-  }
-}
-
-aggregateOutcomesByMarkets({
-  lpAddress: game.liquidityPool.lpAddress,
-  conditions: game.conditions,
-  dictionaries, // **
-})
-```
-
-The result will be of type
-
-```ts
-type Outcome = {
-  selectionName: string
-  conditionId: string
-  outcomeId: string
-  lpAddress: string
-  coreAddress: string
-}
-
-type OutcomesByMarkets = {
-  marketName: string
-  outcomes: Outcome[][] // *
-}[]
 ```
-
-`*` returned `outcomes` are wrapped with additional array `Outcome[][]` 
-
-`**`  `dictionaries` contain a set of texts for each outcome ID used in Azuro. These texts can be used to display outcomes 
-in a user-friendly way and provide more context about what the outcome represents. Dictionaries are an important 
-component of Azuro's infrastructure as they allow for standardized and consistent outcomes across all markets and events. 
-[Read more about dictionaries](https://azuro-v2-docs.surge.sh/build-own-app/dive-deeper/dictionaries).
-
----
-
-You can pass additional data in outcomes if required, the helper will add it to outcomes in the result:
-
-```graphql {11}
-query Game($id: String!) {
-  game(id: $id) {
-    ...
-    conditions {
-      ...
-      outcomes {
-        ...
-        odds
-      }
-    }
-  }
-}
+@apollo/client@^3.8.0-beta.7
+@azuro-org/dictionaries@^3.0.12
+viem@^2.17.3
+@wagmi/core@^2.11.7
 ```
 
-```ts
-type MyOutcome = {
-  outcomeId: string
-  odds: string
-}
-
-aggregateOutcomesByMarkets<MyOutcome>(...)
-```
-
-The result will be of type
-
-```ts {7}
-type Outcome = {
-  selectionName: string
-  conditionId: string
-  outcomeId: string
-  lpAddress: string
-  coreAddress: string
-  odds: string
-}
-
-type OutcomesByMarkets = {
-  marketName: string
-  outcomes: Outcome[][]
-}[]
-```
+Package information can be found in our [Doc](https://gem.azuro.org/hub/apps/toolkit/overview)

package/codegen.ts

@@ -0,0 +1,62 @@
+import { CodegenConfig } from '@graphql-codegen/cli'
+
+
+const config: CodegenConfig = {
+  ignoreNoDocuments: true,
+  generates: {
+    'src/docs/prematch/types.ts': {
+      schema: 'https://thegraph.azuro.org/subgraphs/name/azuro-protocol/azuro-api-polygon-v3',
+      plugins: [
+        'typescript',
+      ],
+    },
+    'src/docs/prematch': {
+      preset: 'near-operation-file',
+      schema: 'https://thegraph.azuro.org/subgraphs/name/azuro-protocol/azuro-api-polygon-v3',
+      documents: 'src/docs/prematch/**/*.graphql',
+      presetConfig: {
+        extension: '.ts',
+        baseTypesPath: 'types.ts',
+      },
+      plugins: [
+        'typescript-operations',
+        'typescript-react-apollo',
+      ],
+      config: {
+        withHooks: false,
+        scalars: {
+          'BigInt': 'string',
+          'BigDecimal': 'string',
+        }
+      },
+    },
+    'src/docs/live/types.ts': {
+      schema: 'https://thegraph.azuro.org/subgraphs/name/azuro-protocol/azuro-api-live-data-feed-dev',
+      plugins: [
+        'typescript',
+      ],
+    },
+    'src/docs/live': {
+      preset: 'near-operation-file',
+      schema: 'https://thegraph.azuro.org/subgraphs/name/azuro-protocol/azuro-api-live-data-feed-dev',
+      documents: 'src/docs/live/**/*.graphql',
+      presetConfig: {
+        extension: '.ts',
+        baseTypesPath: 'types.ts',
+      },
+      plugins: [
+        'typescript-operations',
+        'typescript-react-apollo',
+      ],
+      config: {
+        withHooks: false,
+        scalars: {
+          'BigInt': 'string',
+          'BigDecimal': 'string',
+        }
+      },
+    },
+  },
+}
+
+export default config