SDK #1347

hubert-de-lalye · 2024-10-25T12:51:25Z

Notes

all sdk-specific code aligned in sdk/src/modules
sdk/src/configs/* - this is mostly copypaste from configs in UI, it's intended to use those files in UI too (like replace import {getToken} from 'config/tokens'; to import {getToken} from 'sdk/configs/tokens';
sdk/src/types/* - types are copied from UI, except SDK-specific types
sdk/src/utils/* - most utils copied from UI

To see the specific tasks where the Asana app for GitHub is being used, see below:
- https://app.asana.com/0/0/1208263189938413

netlify · 2024-10-25T12:51:40Z

✅ Deploy Preview for vigilant-albattani-df38ec ready!

Name	Link
🔨 Latest commit	`e244790`
🔍 Latest deploy log	https://app.netlify.com/sites/vigilant-albattani-df38ec/deploys/67506088d28b4a0007661879
😎 Deploy Preview	https://deploy-preview-1347--vigilant-albattani-df38ec.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

cloudflare-workers-and-pages · 2024-10-29T14:20:08Z

Deploying gmx-interface with Cloudflare Pages

Latest commit:	`e244790`
Status:	✅ Deploy successful!
Preview URL:	https://2c446d89.gmx-interface.pages.dev
Branch Preview URL:	https://sdk.gmx-interface.pages.dev

View logs

gmxer · 2024-11-15T06:15:35Z

sdk/README.md

+  oracleUrl: "https://arbitrum-api.gmxinfra.io",
+  walletClient: useWallet().walletClient,
+  subgraph: {
+    subsquid: "https://gmx.squids.live/gmx-synthetics-arbitrum/graphql",


having subsquid inside subgraph seems incorrect
they are two parallel entities, both having equal role in our platform

idk yet if it's just README typo or intended that way

Agree, I just copied structure of subgraph urls from UI config, but here it doesn't make sense, we use only subsquid in SDK, so I just rename the object-field to subsquidUrl property

gmxer · 2024-11-15T06:17:40Z

sdk/README.md

+  marketInfo,
+  indexToken: marketInfo.indexToken,
+  increaseAmounts: {
+    // amounts for position


would be nice to put all the numbers
also I don't see swapPath, I think it should be required parameter

swapPathStats may be undefined, i will add complete example

gmxer · 2024-11-15T06:20:14Z

sdk/src/configs/contracts.ts

+import { Address, zeroAddress } from "viem";
+
+const CONTRACTS = {
+  [ARBITRUM_GOERLI]: {


I think it's fine to remove ARBITRUM_GOERLI from all the configs, as we in fact don't support it

it might be confusing for users if they would go with it without any effect

Should we remove this in UI too? If so, I think it's better to remove it from everywhere in single and separate PR

I think it just confuses potential sdk users that we support goerli, but we don't

gmxer · 2024-11-15T06:30:21Z

sdk/src/configs/markets.ts

@@ -0,0 +1,536 @@
+/*


let's update our listing checklist so that we add new markets to sdk as well (even if it's in PR)

https://www.notion.so/gmxio/New-token-market-checklist-11203574745d8067b91de2cba9f52ad9#11203574745d80529ad0c8f5bea8f5cd

Draft is here: https://www.notion.so/gmxio/New-token-market-checklist-pre-SDK-14b03574745d802c962ccb54c02a5964, move to main checklist once we merge

gmxer · 2024-11-15T06:32:16Z

sdk/src/modules/markets/markets.spec.ts

+      expect(response).toBeDefined();
+    }, 30_000);
+  });
+});


can you add a test to check that all markets listed in sdk config are same as in frontend? otherwise it's hard to visually validate each of them, would also simplify publishing new markets

It's not 100% possible as markets in SDK are fetched from chain and filtered by /markets endpoint

maybe not in tests then,
you build markets map in src/config/static/markets.ts, I guess you can throw some error there in case market for any chain is not listed in src/config/markets (I might confused some paths you should get the idea)

gmxer · 2024-11-15T09:37:33Z

sdk/src/modules/oracle.ts

+      .catch((e) => {
+        // eslint-disable-next-line no-console
+        console.error(e);
+        throw e;


does it make sense to log an error?
also let's be consistent, getGovTokenDelegates doesn't log error but here we do.
I think it's fine to ignore it, user would anyway get it?

gmxer · 2024-11-18T04:31:20Z

sdk/src/modules/orders/orders.ts

+    marketsInfoData,
+    tokensData,
+    orderTypesFilter = [],
+    marketsDirectionsFilter = [],


let's allow sending account in params?

gmxer · 2024-11-18T04:32:36Z

sdk/src/modules/orders/orders.ts

+    }, {} as OrdersInfoData);
+
+    return {
+      count: orders.count,


what is purpose of returning orders.count if ordersInfoData may potentially not contain all orders?

we specifically request this field https://github.com/gmx-io/gmx-interface/blob/sdk/sdk/src/modules/orders/utils.ts#L166
Same usage in UI, I thought it's better to keep it

gmxer · 2024-11-18T04:33:26Z

sdk/src/modules/orders/orders.ts

+
+    return {
+      count: orders.count,
+      ordersInfoData,


orders: ordersInfoData or orders: Object.values(ordersInfoData)?

elsewhere it's entityInfoData, why rename only here?

gmxer · 2024-11-18T04:36:03Z

sdk/src/utils/orders.ts

+    //   minOutputAmount: order.minOutputAmount,
+    //   initialCollateralAmount: order.initialCollateralDeltaAmount,
+    // });
+    const title = "TODO";


maybe remove this field for now or put ""?

gmxer · 2024-11-18T04:37:12Z

sdk/src/modules/orders/orders.ts

+        account,
+        collateralAddress: collateralToken.address,
+      })
+    ) as PositionOrderInfo[];


let's make isOrderForPositionByData (and others where applicable) a typeguard?

Hmm, it's already a typeguard. I just remove typecast

gmxer · 2024-11-18T08:53:10Z

tsconfig.json

  },
-  "include": ["src", "scripts"],
+  "references": [{ "path": "./sdk" }],
+  "include": ["src", "scripts"]


what do you think of restrictring imports from sdk by UI?
with all the duplicated files I think it might be an issue

but we're planning remove duplicates from UI where it applicable, sdk is available in UI as a project reference, hence we can keep static common stuff in sdk and in UI only update imports (like import DataStore from 'sdk/abis/DataStore.json")

gmxer · 2024-11-18T09:50:48Z

sdk/src/utils/slidingWindowFallbackSwitcher.ts

+      clearTimeout(this.fallbackTimerId);
+    }
+  }
+}


this file not in use?

correct, removing

gmxer · 2024-11-18T09:52:01Z

sdk/src/utils/objects.ts

+  return obj[key];
+}
+
+export function getMatchingValueFromObject(


not used (I know there're many unused stuff but I only comment big ones)

gmxer · 2024-11-18T09:54:44Z

sdk/src/utils/fees/estimateOraclePriceCount.ts

+  return 3n + BigInt(swapsCount);
+}
+
+export function estimateOrderOraclePriceCount(swapsCount: number): bigint {


only this function is in use, do you think it makes sense to keep the rest functions?

Eventually the rest will be here, so I think it's ok to move fees utils files entirely

gmxer · 2024-11-18T09:56:51Z

sdk/src/configs/factors.ts

+export const HIGH_POSITION_IMPACT_BPS = 50; // 0.5%
+export const HIGH_COLLATERAL_IMPACT_BPS = 500; // 5%
+export const HIGH_SWAP_IMPACT_BPS = 50; // 0.5%
+export const DEFAULT_ACCEPABLE_PRICE_IMPACT_BUFFER = 30; // 0.3%


only
export const USD_DECIMALS = 30;

export const BASIS_POINTS_DIVISOR = 10000;
export const BASIS_POINTS_DIVISOR_BIGINT = 10000n;

are used, let's remove the rest?
I think it's good to keep configs clean

divhead

Seems that we have redudant abis in SDK, probably remove what we don't use in V2?

divhead · 2024-11-20T08:59:40Z

sdk/src/configs/tokens.ts

+    {
+      name: "GMX LP",
+      symbol: "GLP",
+      address: "",


We discussed that tokens and markets config should be an external params to SDK, or probably i don't understand the current concept

Those are defaults, it think it's better to keep configs in one place so in future I'm intended to remove duplicates from UI

initial sdk commit

28ab4be

updated markets and tokens fetching in sdk, added workflow yaml

cd574bf

hubert-de-lalye added 3 commits October 29, 2024 21:16

updated markets prebuilt keys for SDK, fixed publish workflow

1bd3d1f

fixed publish script

442297b

separated configs

85e2df9

hubert-de-lalye force-pushed the sdk branch from 42fe061 to 85e2df9 Compare October 29, 2024 18:14

fixed publish script

f39b38a

hubert-de-lalye force-pushed the sdk branch from c870bb7 to f39b38a Compare October 29, 2024 18:30

hubert-de-lalye added 3 commits October 29, 2024 22:35

added version plugin to repo, fixed publish script

955c384

fix publish command

8308456

fixed publish script

230e0be

hubert-de-lalye force-pushed the sdk branch 4 times, most recently from 74afc8e to 6168717 Compare October 30, 2024 11:02

fresh fix of publish script

eb0cd2a

hubert-de-lalye force-pushed the sdk branch 4 times, most recently from 13aba34 to cb3051a Compare October 30, 2024 11:44

use npm publish instead of yarn publish

93915f8

hubert-de-lalye force-pushed the sdk branch from cb3051a to 93915f8 Compare October 30, 2024 12:00

hubert-de-lalye added 2 commits October 31, 2024 18:32

add simulate order execution tx

d748a5e

renamed package

c624f51

hubert-de-lalye force-pushed the sdk branch from 462a870 to c624f51 Compare October 31, 2024 14:51

hubert-de-lalye added 3 commits October 31, 2024 18:59

fixed yarn.lock

c7f8d5e

fixed sdk/simulateExecuteOrder

7152624

removed yarn cache to fix post cleanup error

18b593f

hubert-de-lalye and others added 3 commits November 4, 2024 17:48

fixed getDailyVolumes return type

4567ea6

Merge branch 'sdk' of github.com:gmx-io/gmx-interface into sdk

708a1ae

Bump SDK version to 0.0.9

2ddbf44

hubert-de-lalye changed the title ~~[WIP] SDK~~ SDK Nov 4, 2024

hubert-de-lalye and others added 3 commits November 4, 2024 18:42

moved gas and fee estimation utils to specific module in SDK

9c7b241

Merge branch 'sdk' of github.com:gmx-io/gmx-interface into sdk

db1697b

Bump SDK version to 0.1.0

a134ee6

gmxer requested changes Nov 15, 2024

View reviewed changes

gmxer requested changes Nov 18, 2024

View reviewed changes

hubert-de-lalye self-assigned this Nov 19, 2024

divhead reviewed Nov 20, 2024

View reviewed changes

hubert-de-lalye added 11 commits November 20, 2024 19:43

fixes in sdk

021c9e0

Merge branch 'master' into sdk

044bf3d

moving new contracts to sdk

4d789a5

use subgraph in trades

1ec26f7

[empty]

052b9b7

Merge branch 'master' into sdk

f4e25d7

fixed markets, updated prebuild

f8e8a20

Merge branch 'sdk' of github.com:gmx-io/gmx-interface into sdk

7204a1e

removed pending updates and events from positions

9403d76

fixed postinstall

873952d

Merge branch 'release-51' into sdk

4a80ff4

hubert-de-lalye changed the base branch from master to release-51 December 2, 2024 10:12

gmxer approved these changes Dec 4, 2024

View reviewed changes

[rebuild]

e244790

gmxer approved these changes Dec 4, 2024

View reviewed changes

gdev8317 merged commit 2f86540 into release-51 Dec 4, 2024
5 checks passed

gdev8317 deleted the sdk branch December 4, 2024 15:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SDK #1347

SDK #1347

hubert-de-lalye commented Oct 25, 2024 •

edited

Loading

netlify bot commented Oct 25, 2024 •

edited

Loading

cloudflare-workers-and-pages bot commented Oct 29, 2024 •

edited

Loading

gmxer Nov 15, 2024

hubert-de-lalye Nov 19, 2024

gmxer Nov 15, 2024

hubert-de-lalye Nov 19, 2024

gmxer Nov 15, 2024

hubert-de-lalye Nov 19, 2024

gmxer Dec 4, 2024 •

edited

Loading

gmxer Nov 15, 2024

hubert-de-lalye Nov 29, 2024

gmxer Nov 15, 2024

hubert-de-lalye Nov 29, 2024

gmxer Dec 4, 2024

gmxer Nov 15, 2024

gmxer Nov 18, 2024

gmxer Nov 18, 2024

hubert-de-lalye Nov 19, 2024

gmxer Nov 18, 2024

hubert-de-lalye Nov 28, 2024

gmxer Nov 18, 2024

gmxer Nov 18, 2024

hubert-de-lalye Nov 19, 2024

gmxer Nov 18, 2024

hubert-de-lalye Nov 20, 2024

gmxer Nov 18, 2024

hubert-de-lalye Nov 20, 2024

gmxer Nov 18, 2024

gmxer Nov 18, 2024

hubert-de-lalye Nov 20, 2024

gmxer Nov 18, 2024

divhead left a comment

divhead Nov 20, 2024

hubert-de-lalye Nov 20, 2024

SDK #1347

SDK #1347

Conversation

hubert-de-lalye commented Oct 25, 2024 • edited Loading

Notes

netlify bot commented Oct 25, 2024 • edited Loading

✅ Deploy Preview for vigilant-albattani-df38ec ready!

cloudflare-workers-and-pages bot commented Oct 29, 2024 • edited Loading

Deploying gmx-interface with Cloudflare Pages

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gmxer Dec 4, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

divhead left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hubert-de-lalye commented Oct 25, 2024 •

edited

Loading

netlify bot commented Oct 25, 2024 •

edited

Loading

cloudflare-workers-and-pages bot commented Oct 29, 2024 •

edited

Loading

gmxer Dec 4, 2024 •

edited

Loading