@azuro-org/toolkit 0.1.5 → 0.1.7

package/README.md

@@ -10,107 +10,119 @@ npm i --save @azuro-org/toolkit
 ```
 
 
-## CLI
-
-All dictionaries stored in [public repository](https://github.com/Azuro-protocol/public-config/tree/main/dictionaries).
-For ease of use, the dictionaries have a version and file format.
-
-It's easy to download dictionary files with CLI. In your package.json add script:
-
-```json
-"scripts": {
-  "get-dicts": "dictionaries -o {OUTPUT_DIR} -v {VERSION} -t {FILES_TYPE}"
-}
-```
-
-- `VERSION` is the version of downloaded dictionaries. [Find the version you need here](https://github.com/Azuro-protocol/public-config/tree/main/dictionaries).
-- `OUTPUT_DIR` is the directory where to put downloaded files.
-- `FILES_TYPE` is the extension of downloaded files. Accepts `ts`, `js`, `maps`, `arrays`. `maps` and `arrays` are 
-json files with different output format.
-
-```bash
-dictionaries -o ./dist -v 2.0.0 -t ts # will download v2.0.0 typescript files to ./dist directory
-```
-
-
 ## Helpers
 
-```js
-import { getMarketKey, getMarketName, getMarketDescription, assembleMarketName, assembleSelectionName } from '@azuro-org/dictionaries'
-```
-
-### Get market name and description
-
-```js
-import { getMarketKey } from '@azuro-org/dictionaries'
-import dictionaries from './path-to-downloaded-dictionaries'
-
-const outcomeId = 1
-const marketKey = getMarketKey(outcomeId, dictionaries)
+### `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
+      }
+    }
+  }
+}
 ```
 
-`getMarketKey(outcomeId, dictionaries)` returns the string key `marketId-gamePeriodId-gameTypeId[-teamPlayerId]` 
-built from the dictionaries related to passed `outcomeId`.
-
-In the example above the result is `1-1-1`.
-
-There are two dictionary files `marketNames.js` and `marketDescriptions.js`. `marketKey` is used to receive market name 
-and description for specific outcome ID.
-
-```
-import dictionaries from './path-to-downloaded-dictionaries'
+```ts
+type Conditions = {
+  conditionId: string
+  coreAddress: string
+  outcomes: {
+    outcomeId: string
+  }
+}
 
-dictionaries.marketNames['1-1-1'] // "Full Time Result" 
-dictionaries.marketDescriptions['1-1-1'] // "You predict the result..."
+aggregateOutcomesByMarkets({
+  lpAddress: game.liquidityPool.lpAddress,
+  conditions: game.conditions,
+  dictionaries, // **
+})
 ```
 
-**!!! Note that there are no texts for each `outcomeId` !!!**
+The result will be of type
 
-`marketNames[marketKey]` and `marketDescriptions[marketKey]` may return `undefined`. For `marketName` generation there 
-is other helper `assembleMarketName`. It generates human readable market name based on outcome `marketId`, `gamePeriodId`, 
-`gameTypeId`, `teamPlayerId`.
+```ts
+type Outcome = {
+  selectionName: string
+  conditionId: string
+  outcomeId: string
+  lpAddress: string
+  coreAddress: string
+}
 
+type OutcomesByMarkets = {
+  marketName: string
+  outcomes: Outcome[][] // *
+}[]
 ```
-import { getMarketKey, assembleMarketName } from '@azuro-org/dictionaries'
-import dictionaries from './path-to-downloaded-dictionaries'
-
-const outcomeId = 42
-const marketKey = getMarketKey(outcomeId, dictionaries)
-
-let marketName = dictionaries[marketKey] // undefined
 
-if (!marketName) {
-  marketName = assembleMarketName(outcomeId, dictionaries) // "Whole game - Winner of match Goal"
+`*` 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
+      }
+    }
+  }
 }
 ```
 
-There are additional 2 sugar helpers:
-
-```js
-import { getMarketName } from '@azuro-org/dictionaries'
-import dictionaries from './path-to-downloaded-dictionaries'
-
-getMarketName(1, dictionaries) // "Full Time Result"
-getMarketName(42, dictionaries) // "Whole game - Winner of match Goal"
-```
-
-```js
-import { getMarketDescription } from '@azuro-org/dictionaries'
-import dictionaries from './path-to-downloaded-dictionaries'
+```ts
+type MyOutcome = {
+  outcomeId: string
+  odds: string
+}
 
-getMarketDescription(1, dictionaries) // "You predict the result..."
-getMarketDescription(42, dictionaries) // undefined. Note that there is no `assemblyMarketDescription` helper.
+aggregateOutcomesByMarkets<MyOutcome>({
+  lpAddress: game.liquidityPool.lpAddress,
+  conditions: game.conditions,
+  dictionaries, // ** check the note below
+})
 ```
 
-### Get selection (outcome) name
-
-```js
-import { assembleSelectionName } from '@azuro-org/dictionaries'
-import dictionaries from './dist'
+The result will be of type
 
-const outcomeId = 1
-const selectionName = assembleSelectionName(outcomeId, dictionaries) // "Yes"
+```ts {7}
+type Outcome = {
+  selectionName: string
+  conditionId: string
+  outcomeId: string
+  lpAddress: string
+  coreAddress: string
+  odds: string
+}
 
-const outcomeId = 4
-const selectionName = assembleSelectionName(outcomeId, dictionaries) // "Team 2 (4.5)"
+type OutcomesByMarkets = {
+  marketName: string
+  outcomes: Outcome[][]
+}[]
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azuro-org/toolkit",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "Set of helpers to work with Azuro protocol",
   "module": "dist/index.es.js",
   "main": "lib/index.js",
@@ -25,7 +25,7 @@
   "bugs": {
     "url": "https://github.com/Azuro-protocol/toolkit/issues"
   },
-  "homepage": "https://github.com/Azuro-protocol/toolkit/packages/toolkit#readme",
+  "homepage": "https://github.com/Azuro-protocol/toolkit#readme",
   "peerDependencies": {
     "@azuro-org/dictionaries": "^1.0.5"
   },