@gala-chain/launchpad-sdk 4.0.3 → 4.0.4-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/EXAMPLES.md +96 -35
  2. package/README.md +2 -0
  3. package/dist/index.cjs.js +1 -1
  4. package/dist/index.esm.js +1 -1
  5. package/dist/index.js +1 -1
  6. package/dist/src/LaunchpadSDK.d.ts +750 -72
  7. package/dist/src/LaunchpadSDK.d.ts.map +1 -1
  8. package/dist/src/constants/version.generated.d.ts +1 -1
  9. package/dist/src/constants/version.generated.d.ts.map +1 -1
  10. package/dist/src/services/DexBackendClient.d.ts +139 -10
  11. package/dist/src/services/DexBackendClient.d.ts.map +1 -1
  12. package/dist/src/services/DexQuoteService.d.ts +181 -22
  13. package/dist/src/services/DexQuoteService.d.ts.map +1 -1
  14. package/dist/src/services/DexService.d.ts +274 -38
  15. package/dist/src/services/DexService.d.ts.map +1 -1
  16. package/dist/src/services/GSwapService.d.ts +555 -246
  17. package/dist/src/services/GSwapService.d.ts.map +1 -1
  18. package/dist/src/services/GalaChainGatewayClient.d.ts +139 -41
  19. package/dist/src/services/GalaChainGatewayClient.d.ts.map +1 -1
  20. package/dist/src/services/ImageService.d.ts +101 -12
  21. package/dist/src/services/ImageService.d.ts.map +1 -1
  22. package/dist/src/services/PoolCacheManager.d.ts +125 -31
  23. package/dist/src/services/PoolCacheManager.d.ts.map +1 -1
  24. package/dist/src/services/SignatureService.d.ts +35 -5
  25. package/dist/src/services/SignatureService.d.ts.map +1 -1
  26. package/dist/src/services/SwapEventQueue.d.ts +79 -10
  27. package/dist/src/services/SwapEventQueue.d.ts.map +1 -1
  28. package/dist/src/services/TokenClassKeyService.d.ts +56 -10
  29. package/dist/src/services/TokenClassKeyService.d.ts.map +1 -1
  30. package/dist/src/services/TokenMetadataService.d.ts +407 -31
  31. package/dist/src/services/TokenMetadataService.d.ts.map +1 -1
  32. package/dist/src/services/TradeService.d.ts +168 -6
  33. package/dist/src/services/TradeService.d.ts.map +1 -1
  34. package/dist/src/services/UserService.d.ts +117 -15
  35. package/dist/src/services/UserService.d.ts.map +1 -1
  36. package/package.json +12 -2
  37. package/API.md +0 -1475
@@ -1 +1 @@
1
- {"version":3,"file":"GSwapService.d.ts","sourceRoot":"","sources":["../../../src/services/GSwapService.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAsB3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAYpD,OAAO,KAAK,EACV,eAAe,EACf,eAAe,EACf,iBAAiB,EACjB,iBAAiB,EACjB,SAAS,EACT,QAAQ,EACR,kBAAkB,EAClB,aAAa,EACb,aAAa,EACb,aAAa,EACb,4BAA4B,EAE5B,2BAA2B,EAC5B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAGV,kCAAkC,EAClC,uBAAuB,EACxB,MAAM,gCAAgC,CAAC;AACxC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAerD,qBAAa,YAAa,SAAQ,UAAU;IAC1C,OAAO,CAAC,aAAa,CAAyB;IAC9C,OAAO,CAAC,gBAAgB,CAAmB;IAC3C,OAAO,CAAC,cAAc,CAAuB;IAC7C,OAAO,CAAC,gBAAgB,CAAmB;IAC3C,OAAO,CAAC,eAAe,CAA8B;IACrD,OAAO,CAAC,gBAAgB,CAA2B;IACnD,OAAO,CAAC,gBAAgB,CAAU;IAClC,OAAO,CAAC,cAAc,CAAU;IAChC,OAAO,CAAC,cAAc,CAAU;IAChC,OAAO,CAAC,UAAU,CAAqB;IACvC,OAAO,CAAC,kBAAkB,CAAa;gBAE3B,MAAM,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,eAAe,CAAC,EAAE,eAAe;IAyC7G;;;;OAIG;IACH,qBAAqB,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;IAWhD;;;;;;;;;;;OAWG;IACG,sBAAsB,CAC1B,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC,eAAe,CAAC;IA2I3B;;;;;;;;;;;OAWG;IACG,uBAAuB,CAC3B,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC,eAAe,CAAC;IAmH3B;;;;OAIG;IACG,WAAW,CACf,MAAM,EAAE,iBAAiB,GACxB,OAAO,CAAC,iBAAiB,CAAC;IAqH7B;;;;;;;;;;OAUG;IACG,aAAa,CAAC,aAAa,EAAE,MAAM,EAAE,IAAI,GAAE,MAAU,EAAE,KAAK,GAAE,MAAW,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAiEtG;;;;OAIG;IACG,gBAAgB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAmCnE;;;;;OAKG;IACG,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAsEpE;;;;;;OAMG;IAEH;;;OAGG;IACH,OAAO,CAAC,UAAU;IAQlB;;;;OAIG;YACW,mBAAmB;IA4EjC;;;OAGG;IAEH,OAAO,CAAC,yBAAyB;IAmEjC;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IAqBpB,yBAAyB,CAC7B,YAAY,EAAE,MAAM,EACpB,KAAK,GAAE,MAA4C,EACnD,QAAQ,CAAC,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,4BAA4B,GACrC,OAAO,CAAC,2BAA2B,CAAC;IA4FvC;;;;;;;OAOG;IACG,gCAAgC,CACpC,YAAY,EAAE,MAAM,EACpB,OAAO,CAAC,EAAE,4BAA4B,GACrC,OAAO,CAAC,aAAa,EAAE,GAAG,2BAA2B,CAAC;IAwDzD;;;;;OAKG;IACG,oBAAoB,CACxB,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE;QACR,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,GAAG,EAAE,MAAM,CAAC;QACZ,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;KACnB,GACA,OAAO,CAAC,aAAa,CAAC;IA6CzB;;;;;;;;;;OAUG;IACG,wBAAwB,CAC5B,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACzC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACzC,OAAO,CAAC,EAAE,MAAM,EAChB,SAAS,CAAC,EAAE,MAAM,EAClB,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,aAAa,CAAC;IAsJzB;;;;;;;;;;OAUG;IACG,uBAAuB,CAAC,MAAM,EAAE;QACpC,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,GAAG,EAAE,MAAM,CAAC;QACZ,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,OAAO,CAAC,aAAa,CAAC;IAiF1B;;;;OAIG;IACG,uBAAuB,CAAC,IAAI,EAAE;QAClC,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,GAAG,EAAE,MAAM,CAAC;QACZ,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,OAAO,CAAC,kCAAkC,CAAC;IAmC/C;;;;OAIG;IACG,mBAAmB,CAAC,IAAI,EAAE;QAC9B,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,GAAG,EAAE,MAAM,CAAC;QACZ,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,MAAM,CAAC;QACjB,cAAc,EAAE,MAAM,CAAC;QACvB,cAAc,EAAE,MAAM,CAAC;QACvB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,uBAAuB,GAAG;QAAE,SAAS,CAAC,EAAE,IAAI,CAAC;QAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;KAAE,CAAC;IAiXzG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkEG;IACG,uBAAuB,CAAC,IAAI,EAAE;QAClC,MAAM,EAAE,MAAM,GAAG,aAAa,CAAC;QAC/B,MAAM,EAAE,MAAM,GAAG,aAAa,CAAC;QAC/B,GAAG,EAAE,MAAM,CAAC;QACZ,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,cAAc,EAAE,MAAM,CAAC;QACvB,cAAc,EAAE,MAAM,CAAC;QACvB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,uBAAuB,GAAG;QAAE,SAAS,CAAC,EAAE,IAAI,CAAC;QAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;KAAE,CAAC;IAwWzG;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;YACW,yBAAyB;IA8DvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuEG;IACG,eAAe,CAAC,IAAI,EAAE;QAC1B,MAAM,EAAE,MAAM,GAAG,aAAa,CAAC;QAC/B,MAAM,EAAE,MAAM,GAAG,aAAa,CAAC;QAC/B,GAAG,EAAE,MAAM,CAAC;QACZ,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IA0FpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8EG;IACG,mBAAmB,CAAC,IAAI,EAAE;QAE9B,MAAM,CAAC,EAAE,MAAM,GAAG,aAAa,CAAC;QAChC,MAAM,CAAC,EAAE,MAAM,GAAG,aAAa,CAAC;QAChC,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAwGpC;;;;;;OAMG;IACG,WAAW,CACf,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,GACd,OAAO,CAAC;QACT,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,EAAE,MAAM,CAAC;QAClB,YAAY,EAAE,MAAM,CAAC;QACrB,IAAI,EAAE,MAAM,CAAC;QACb,oBAAoB,EAAE,MAAM,CAAC;QAC7B,oBAAoB,EAAE,MAAM,CAAC;QAC7B,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;IAsCF;;;;;;OAMG;IACG,yBAAyB,CAC7B,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,GACd,OAAO,CAAC;QACT,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,MAAM,CAAC;QAChB,KAAK,EAAE,MAAM,CAAC;QACd,aAAa,EAAE,MAAM,CAAC;QACtB,IAAI,EAAE,MAAM,CAAC;QACb,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;IAqBF;;;;;;;;;;OAUG;IACG,4BAA4B,CAChC,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,cAAc,EAAE,MAAM,EACtB,cAAc,EAAE,MAAM,EACtB,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC;QACT,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,EAAE,MAAM,CAAC;QAClB,KAAK,EAAE,MAAM,CAAC;QACd,kBAAkB,EAAE;YAClB,OAAO,EAAE,MAAM,CAAC;YAChB,OAAO,EAAE,MAAM,CAAC;SACjB,CAAC;KACH,CAAC;IA4DF;;;;;;;;;;OAUG;IACG,0BAA0B,CAC9B,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GACd,OAAO,CAAC;QACT,KAAK,EAAE,OAAO,CAAC;QACf,MAAM,EAAE,MAAM,EAAE,CAAC;QACjB,QAAQ,EAAE,MAAM,EAAE,CAAC;QACnB,WAAW,EAAE,MAAM,CAAC;QACpB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;IA+FF;;;;;;;;OAQG;IACG,sBAAsB,CAC1B,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC;QACT,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,WAAW,EAAE,MAAM,CAAC;QACpB,iBAAiB,EAAE,MAAM,CAAC;QAC1B,iBAAiB,EAAE,MAAM,CAAC;QAC1B,cAAc,EAAE,MAAM,CAAC;QACvB,cAAc,EAAE,MAAM,CAAC;QACvB,cAAc,EAAE;YACd,iBAAiB,EAAE,MAAM,CAAC;YAC1B,iBAAiB,EAAE,MAAM,CAAC;SAC3B,CAAC;KACH,CAAC;IA+DF;;;;;;;OAOG;IACG,sBAAsB,CAC1B,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IA0DzL;;OAEG;IACH,OAAO,CAAC,uBAAuB;IAgB/B;;;OAGG;IACH,OAAO,CAAC,cAAc;IAatB;;;;;;;OAOG;IACH,OAAO,CAAC,mBAAmB;IAkB3B;;;;OAIG;IACH,OAAO,CAAC,8BAA8B;IAUtC;;;;;OAKG;IACH,OAAO,CAAC,kCAAkC;IAQ1C;;;;;;;;;OASG;IACG,YAAY,CAChB,MAAM,EAAE,MAAM,GAAG,aAAa,EAC9B,MAAM,EAAE,MAAM,GAAG,aAAa,EAC9B,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,aAAa,CAAC;IAsEzB;;;;OAIG;IACG,uBAAuB,CAAC,QAAQ,EAAE;QACtC,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC,aAAa,CAAC;IAsC1B;;;;OAIG;IACH,OAAO,CAAC,6BAA6B;IAerC;;;;OAIG;IACH,OAAO,CAAC,6BAA6B;IAerC;;;;OAIG;IACH,OAAO,CAAC,6BAA6B;IAerC;;;;OAIG;IACH,OAAO,CAAC,6BAA6B;IAerC;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,gBAAgB;IAUxB;;;;;;;;;;;;OAYG;YACW,yBAAyB;IA0JvC;;;;;;;;;;;;;;;;;;;OAmBG;YACW,4BAA4B;IAwI1C;;;;;;;;;;;;;;;;;;OAkBG;YACW,gCAAgC;IAsI9C;;;;;;;;;;;;;;;;OAgBG;YACW,iBAAiB;IAgQ/B;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,iCAAiC;IAsBzC;;;;;;;;;;;;;;;OAeG;IACH,OAAO,CAAC,gBAAgB;IA4CxB;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,qBAAqB;IAsB7B;;;;;;;;OAQG;YACW,wBAAwB;IAMtC;;;;;;;;;;OAUG;IACH,OAAO,CAAC,2BAA2B;CAIpC"}
1
+ {"version":3,"file":"GSwapService.d.ts","sourceRoot":"","sources":["../../../src/services/GSwapService.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAsB3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAYpD,OAAO,KAAK,EACV,eAAe,EACf,eAAe,EACf,iBAAiB,EACjB,iBAAiB,EACjB,SAAS,EACT,QAAQ,EACR,kBAAkB,EAClB,aAAa,EACb,aAAa,EACb,aAAa,EACb,4BAA4B,EAE5B,2BAA2B,EAC5B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAGV,kCAAkC,EAClC,uBAAuB,EACxB,MAAM,gCAAgC,CAAC;AACxC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAerD,qBAAa,YAAa,SAAQ,UAAU;IAC1C,OAAO,CAAC,aAAa,CAAyB;IAC9C,OAAO,CAAC,gBAAgB,CAAmB;IAC3C,OAAO,CAAC,cAAc,CAAuB;IAC7C,OAAO,CAAC,gBAAgB,CAAmB;IAC3C,OAAO,CAAC,eAAe,CAA8B;IACrD,OAAO,CAAC,gBAAgB,CAA2B;IACnD,OAAO,CAAC,gBAAgB,CAAU;IAClC,OAAO,CAAC,cAAc,CAAU;IAChC,OAAO,CAAC,cAAc,CAAU;IAChC,OAAO,CAAC,UAAU,CAAqB;IACvC,OAAO,CAAC,kBAAkB,CAAa;gBAE3B,MAAM,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,eAAe,CAAC,EAAE,eAAe;IAyC7G;;;;OAIG;IACH,qBAAqB,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;IAWhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,sBAAsB,CAC1B,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC,eAAe,CAAC;IA2I3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,uBAAuB,CAC3B,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC,eAAe,CAAC;IAmH3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACG,WAAW,CACf,MAAM,EAAE,iBAAiB,GACxB,OAAO,CAAC,iBAAiB,CAAC;IAqH7B;;;;;;;;;;OAUG;IACG,aAAa,CAAC,aAAa,EAAE,MAAM,EAAE,IAAI,GAAE,MAAU,EAAE,KAAK,GAAE,MAAW,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAiEtG;;;;OAIG;IACG,gBAAgB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAmCnE;;;;;OAKG;IACG,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAsEpE;;;;;;OAMG;IAEH;;;OAGG;IACH,OAAO,CAAC,UAAU;IAQlB;;;;OAIG;YACW,mBAAmB;IA4EjC;;;OAGG;IAEH,OAAO,CAAC,yBAAyB;IAmEjC;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IAqB1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwDG;IACG,yBAAyB,CAC7B,YAAY,EAAE,MAAM,EACpB,KAAK,GAAE,MAA4C,EACnD,QAAQ,CAAC,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,4BAA4B,GACrC,OAAO,CAAC,2BAA2B,CAAC;IA4FvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACG,gCAAgC,CACpC,YAAY,EAAE,MAAM,EACpB,OAAO,CAAC,EAAE,4BAA4B,GACrC,OAAO,CAAC,aAAa,EAAE,GAAG,2BAA2B,CAAC;IAwDzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACG,oBAAoB,CACxB,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE;QACR,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,GAAG,EAAE,MAAM,CAAC;QACZ,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;KACnB,GACA,OAAO,CAAC,aAAa,CAAC;IA6CzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,wBAAwB,CAC5B,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACzC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACzC,OAAO,CAAC,EAAE,MAAM,EAChB,SAAS,CAAC,EAAE,MAAM,EAClB,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,aAAa,CAAC;IAsJzB;;;;;;;;;;OAUG;IACG,uBAAuB,CAAC,MAAM,EAAE;QACpC,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,GAAG,EAAE,MAAM,CAAC;QACZ,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,OAAO,CAAC,aAAa,CAAC;IAiF1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsDG;IACG,uBAAuB,CAAC,IAAI,EAAE;QAClC,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,GAAG,EAAE,MAAM,CAAC;QACZ,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,OAAO,CAAC,kCAAkC,CAAC;IAmC/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,mBAAmB,CAAC,IAAI,EAAE;QAC9B,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,GAAG,EAAE,MAAM,CAAC;QACZ,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,MAAM,CAAC;QACjB,cAAc,EAAE,MAAM,CAAC;QACvB,cAAc,EAAE,MAAM,CAAC;QACvB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,uBAAuB,GAAG;QAAE,SAAS,CAAC,EAAE,IAAI,CAAC;QAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;KAAE,CAAC;IAiXzG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0DG;IACG,uBAAuB,CAAC,IAAI,EAAE;QAClC,MAAM,EAAE,MAAM,GAAG,aAAa,CAAC;QAC/B,MAAM,EAAE,MAAM,GAAG,aAAa,CAAC;QAC/B,GAAG,EAAE,MAAM,CAAC;QACZ,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,cAAc,EAAE,MAAM,CAAC;QACvB,cAAc,EAAE,MAAM,CAAC;QACvB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,uBAAuB,GAAG;QAAE,SAAS,CAAC,EAAE,IAAI,CAAC;QAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;KAAE,CAAC;IAwWzG;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;YACW,yBAAyB;IA8DvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiEG;IACG,eAAe,CAAC,IAAI,EAAE;QAC1B,MAAM,EAAE,MAAM,GAAG,aAAa,CAAC;QAC/B,MAAM,EAAE,MAAM,GAAG,aAAa,CAAC;QAC/B,GAAG,EAAE,MAAM,CAAC;QACZ,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IA0FpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkEG;IACG,mBAAmB,CAAC,IAAI,EAAE;QAE9B,MAAM,CAAC,EAAE,MAAM,GAAG,aAAa,CAAC;QAChC,MAAM,CAAC,EAAE,MAAM,GAAG,aAAa,CAAC;QAChC,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAwGpC;;;;;;OAMG;IACG,WAAW,CACf,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,GACd,OAAO,CAAC;QACT,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,EAAE,MAAM,CAAC;QAClB,YAAY,EAAE,MAAM,CAAC;QACrB,IAAI,EAAE,MAAM,CAAC;QACb,oBAAoB,EAAE,MAAM,CAAC;QAC7B,oBAAoB,EAAE,MAAM,CAAC;QAC7B,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;IAsCF;;;;;;OAMG;IACG,yBAAyB,CAC7B,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,GACd,OAAO,CAAC;QACT,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,MAAM,CAAC;QAChB,KAAK,EAAE,MAAM,CAAC;QACd,aAAa,EAAE,MAAM,CAAC;QACtB,IAAI,EAAE,MAAM,CAAC;QACb,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;IAqBF;;;;;;;;;;OAUG;IACG,4BAA4B,CAChC,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,cAAc,EAAE,MAAM,EACtB,cAAc,EAAE,MAAM,EACtB,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC;QACT,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,EAAE,MAAM,CAAC;QAClB,KAAK,EAAE,MAAM,CAAC;QACd,kBAAkB,EAAE;YAClB,OAAO,EAAE,MAAM,CAAC;YAChB,OAAO,EAAE,MAAM,CAAC;SACjB,CAAC;KACH,CAAC;IA4DF;;;;;;;;;;OAUG;IACG,0BAA0B,CAC9B,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GACd,OAAO,CAAC;QACT,KAAK,EAAE,OAAO,CAAC;QACf,MAAM,EAAE,MAAM,EAAE,CAAC;QACjB,QAAQ,EAAE,MAAM,EAAE,CAAC;QACnB,WAAW,EAAE,MAAM,CAAC;QACpB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;IA+FF;;;;;;;;OAQG;IACG,sBAAsB,CAC1B,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC;QACT,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,WAAW,EAAE,MAAM,CAAC;QACpB,iBAAiB,EAAE,MAAM,CAAC;QAC1B,iBAAiB,EAAE,MAAM,CAAC;QAC1B,cAAc,EAAE,MAAM,CAAC;QACvB,cAAc,EAAE,MAAM,CAAC;QACvB,cAAc,EAAE;YACd,iBAAiB,EAAE,MAAM,CAAC;YAC1B,iBAAiB,EAAE,MAAM,CAAC;SAC3B,CAAC;KACH,CAAC;IA+DF;;;;;;;OAOG;IACG,sBAAsB,CAC1B,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IA0DzL;;OAEG;IACH,OAAO,CAAC,uBAAuB;IAgB/B;;;OAGG;IACH,OAAO,CAAC,cAAc;IAatB;;;;;;;OAOG;IACH,OAAO,CAAC,mBAAmB;IAkB3B;;;;OAIG;IACH,OAAO,CAAC,8BAA8B;IAUtC;;;;;OAKG;IACH,OAAO,CAAC,kCAAkC;IAQ1C;;;;;;;;;OASG;IACG,YAAY,CAChB,MAAM,EAAE,MAAM,GAAG,aAAa,EAC9B,MAAM,EAAE,MAAM,GAAG,aAAa,EAC9B,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,aAAa,CAAC;IAsEzB;;;;OAIG;IACG,uBAAuB,CAAC,QAAQ,EAAE;QACtC,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC,aAAa,CAAC;IAsC1B;;;;OAIG;IACH,OAAO,CAAC,6BAA6B;IAerC;;;;OAIG;IACH,OAAO,CAAC,6BAA6B;IAerC;;;;OAIG;IACH,OAAO,CAAC,6BAA6B;IAerC;;;;OAIG;IACH,OAAO,CAAC,6BAA6B;IAerC;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,gBAAgB;IAUxB;;;;;;;;;;;;OAYG;YACW,yBAAyB;IA0JvC;;;;;;;;;;;;;;;;;;;OAmBG;YACW,4BAA4B;IAwI1C;;;;;;;;;;;;;;;;;;OAkBG;YACW,gCAAgC;IAsI9C;;;;;;;;;;;;;;;;OAgBG;YACW,iBAAiB;IAgQ/B;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,iCAAiC;IAsBzC;;;;;;;;;;;;;;;OAeG;IACH,OAAO,CAAC,gBAAgB;IA4CxB;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,qBAAqB;IAsB7B;;;;;;;;OAQG;YACW,wBAAwB;IAMtC;;;;;;;;;;OAUG;IACH,OAAO,CAAC,2BAA2B;CAIpC"}
@@ -1,8 +1,22 @@
1
1
  /**
2
2
  * GalaChain Gateway Client
3
3
  *
4
- * Direct HTTP client for GalaChain Gateway DEX contract endpoints.
5
- * Fully typed API interactions with zero `any` types.
4
+ * Direct HTTP client for GalaChain Gateway DEX contract endpoints with full type safety.
5
+ * Provides low-level blockchain interactions for DEX v3 liquidity pools and positions.
6
+ *
7
+ * ## Key Features:
8
+ * - Zero `any` types - fully typed responses
9
+ * - Automatic response validation
10
+ * - Compound key and position ID lookup support
11
+ * - Comprehensive error handling
12
+ *
13
+ * ## Supported Operations:
14
+ * - Pool state queries (GetPoolData)
15
+ * - Position management (GetPositions)
16
+ * - Liquidity removal estimation (GetRemoveLiquidityEstimation)
17
+ *
18
+ * @category GalaChain
19
+ * @since 3.0.0
6
20
  */
7
21
  import { GalaChainGatewayResponse, GalaChainPoolData, GalaChainGetPoolDataRequest, GalaChainGetPositionsRequest, GalaChainGetPositionsResponse, GalaChainGetRemoveLiquidityEstimationRequest, GalaChainRemoveLiquidityEstimation } from '../types/galachain-api.types';
8
22
  /**
@@ -19,57 +33,141 @@ export declare class GalaChainGatewayClient {
19
33
  private client;
20
34
  constructor(config: GalaChainGatewayClientConfig);
21
35
  /**
22
- * Get pool data from GalaChain Gateway
23
- * Endpoint: POST /api/asset/dexv3-contract/GetPoolData
36
+ * Fetch pool state data from GalaChain DEX v3 contract
37
+ *
38
+ * Retrieves complete pool state including liquidity, price, tick data, and fee tier.
39
+ * Uses TokenClassKey objects for precise token identification - pipe-delimited strings
40
+ * are NOT supported (use parseToken() utility to convert if needed).
41
+ *
42
+ * **Critical**: tokens must be TokenClassKey objects, not strings. Backend requires
43
+ * structured token objects with collection/category/type/additionalKey fields.
24
44
  *
25
- * @param request - Pool data request with token pair and fee tier
26
- * @returns Fully typed pool data
27
- * @throws ApiError if request fails
45
+ * @param request Pool data request with token0, token1 (TokenClassKey objects), and fee tier
46
+ * @returns Promise<GalaChainPoolData> Complete pool state from blockchain
47
+ * @throws ApiError if tokens are strings instead of objects, or request fails
48
+ * @category GalaChain
49
+ * @since 3.0.0
50
+ *
51
+ * @example Fetch pool state for GALA/GUSDC
52
+ * ```typescript
53
+ * const poolData = await client.getPoolData({
54
+ * token0: { collection: 'GALA', category: 'Unit', type: 'none', additionalKey: 'none' },
55
+ * token1: { collection: 'GUSDC', category: 'Unit', type: 'none', additionalKey: 'none' },
56
+ * fee: 3000 // 0.3% fee tier
57
+ * });
58
+ * console.log('Current price:', poolData.sqrtPriceX96);
59
+ * console.log('Liquidity:', poolData.liquidity);
60
+ * ```
28
61
  */
29
62
  getPoolData(request: GalaChainGetPoolDataRequest): Promise<GalaChainPoolData>;
30
63
  /**
31
- * Get position(s) from GalaChain Gateway
32
- * Endpoint: POST /api/asset/dexv3-contract/GetPositions
33
- *
34
- * Supports multiple query filters:
35
- * - Get all positions for owner
36
- * - Get positions for specific token pair
37
- * - Get specific position by ID
38
- * - Pagination via bookmark
39
- *
40
- * @param request - Position query request with optional filters
41
- * @returns List of positions matching criteria
42
- * @throws ApiError if request fails
64
+ * Query liquidity positions from GalaChain DEX v3 contract
65
+ *
66
+ * Flexible position query supporting multiple filter combinations:
67
+ * - All positions for an owner (owner only)
68
+ * - Positions for specific pool (owner + token0 + token1)
69
+ * - Specific position by compound key (owner + tokens + ticks)
70
+ * - Pagination support via bookmark field
71
+ *
72
+ * **Response Format**: Returns either single position object or `{ positions: [...], count: N }`
73
+ * wrapper depending on query type. SDK normalizes to consistent array format.
74
+ *
75
+ * @param request Position query with owner and optional filters (token0, token1, fee, ticks, bookmark)
76
+ * @returns Promise<GalaChainGetPositionsResponse> Array of matching positions with count
77
+ * @throws ApiError if request fails or response format invalid
78
+ * @category GalaChain
79
+ * @since 3.0.0
80
+ *
81
+ * @example Get all positions for a user
82
+ * ```typescript
83
+ * const positions = await client.getPositions({
84
+ * owner: 'client|user123'
85
+ * });
86
+ * console.log(`User has ${positions.count} positions`);
87
+ * ```
88
+ *
89
+ * @example Get positions for specific pool
90
+ * ```typescript
91
+ * const poolPositions = await client.getPositions({
92
+ * owner: 'client|user123',
93
+ * token0: { collection: 'GALA', category: 'Unit', type: 'none', additionalKey: 'none' },
94
+ * token1: { collection: 'GUSDC', category: 'Unit', type: 'none', additionalKey: 'none' }
95
+ * });
96
+ * ```
43
97
  */
44
98
  getPositions(request: GalaChainGetPositionsRequest): Promise<GalaChainGetPositionsResponse>;
45
99
  /**
46
- * Get position by ID from GalaChain Gateway
47
- * Supports both compound key lookup (preferred) and simple positionId lookup
48
- *
49
- * Compound key requires: owner + token0 + token1 + tickLower + tickUpper + fee
50
- * PositionId approach uses just the position ID (fallback for compatibility)
51
- *
52
- * @param ownerOrPositionId - Position owner address OR position ID
53
- * @param token0Optional - Token0 symbol or TokenClassKey (required for compound key lookup)
54
- * @param token1Optional - Token1 symbol or TokenClassKey (required for compound key lookup)
55
- * @param feeOptional - Fee tier (required for compound key lookup)
56
- * @param tickLowerOptional - Lower tick boundary (required for compound key lookup)
57
- * @param tickUpperOptional - Upper tick boundary (required for compound key lookup)
58
- * @param positionIdOptional - Position ID (optional, included in request)
59
- * @returns Position data if found
60
- * @throws ApiError if position not found or request fails
100
+ * Fetch specific liquidity position by compound key or position ID
101
+ *
102
+ * Supports two lookup strategies:
103
+ * 1. **Compound Key** (preferred): owner + token0 + token1 + fee + tickLower + tickUpper
104
+ * 2. **Position ID** (legacy fallback): just position ID string
105
+ *
106
+ * Compound key lookup is more reliable and matches the blockchain's native position
107
+ * identification scheme. Position ID lookup is provided for backward compatibility.
108
+ *
109
+ * **Response Format**: Returns position object directly (not wrapped in array).
110
+ *
111
+ * @param ownerOrPositionId Position owner address (compound key) or position ID (legacy)
112
+ * @param token0Optional Token0 symbol or TokenClassKey (required for compound key)
113
+ * @param token1Optional Token1 symbol or TokenClassKey (required for compound key)
114
+ * @param feeOptional Fee tier in basis points (required for compound key)
115
+ * @param tickLowerOptional Lower tick boundary (required for compound key)
116
+ * @param tickUpperOptional Upper tick boundary (required for compound key)
117
+ * @param positionIdOptional Optional position ID to include in request
118
+ * @returns Promise<GalaChainResponse<any>> Wrapped position data
119
+ * @throws ApiError if position not found (404) or request fails
120
+ * @category GalaChain
121
+ * @since 3.0.0
122
+ *
123
+ * @example Fetch position by compound key (preferred)
124
+ * ```typescript
125
+ * const position = await client.getPositionById(
126
+ * 'client|user123',
127
+ * { collection: 'GALA', category: 'Unit', type: 'none', additionalKey: 'none' },
128
+ * { collection: 'GUSDC', category: 'Unit', type: 'none', additionalKey: 'none' },
129
+ * 3000, // 0.3% fee
130
+ * -887220, // tickLower
131
+ * 887220, // tickUpper
132
+ * 'position123' // optional
133
+ * );
134
+ * console.log('Liquidity:', position.Data.liquidity);
135
+ * ```
136
+ *
137
+ * @example Fetch position by ID (legacy)
138
+ * ```typescript
139
+ * const position = await client.getPositionById('position123');
140
+ * ```
61
141
  */
62
142
  getPositionById(ownerOrPositionId: string, token0Optional?: string | Record<string, any>, token1Optional?: string | Record<string, any>, feeOptional?: number, tickLowerOptional?: number, tickUpperOptional?: number, positionIdOptional?: string): Promise<GalaChainResponse<any>>;
63
143
  /**
64
- * Get liquidity removal estimation from GalaChain Gateway
65
- * Endpoint: POST /api/asset/dexv3-contract/GetRemoveLiquidityEstimation
144
+ * Calculate estimated token amounts from liquidity removal
145
+ *
146
+ * Simulates removing liquidity from a position to preview the exact amounts of token0
147
+ * and token1 that will be received. Includes both principal liquidity and accumulated
148
+ * trading fees. Does not execute the removal - use for UI preview before transaction.
149
+ *
150
+ * **Use Cases**: Preview removal amounts, calculate impermanent loss, position exit planning
66
151
  *
67
- * Calculates amounts user will receive when removing liquidity
68
- * Includes both principal amounts and accumulated fees
152
+ * @param request Removal estimation request with owner, tokens, fee, ticks, and liquidity amount
153
+ * @returns Promise<GalaChainRemoveLiquidityEstimation> Estimated token0 and token1 amounts
154
+ * @throws ApiError if request fails or position parameters invalid
155
+ * @category GalaChain
156
+ * @since 3.0.0
69
157
  *
70
- * @param request - Removal estimation request with position details
71
- * @returns Estimated amounts to be received
72
- * @throws ApiError if request fails
158
+ * @example Estimate removal amounts
159
+ * ```typescript
160
+ * const estimation = await client.getRemoveLiquidityEstimation({
161
+ * owner: 'client|user123',
162
+ * token0: { collection: 'GALA', category: 'Unit', type: 'none', additionalKey: 'none' },
163
+ * token1: { collection: 'GUSDC', category: 'Unit', type: 'none', additionalKey: 'none' },
164
+ * fee: 3000,
165
+ * tickLower: -887220,
166
+ * tickUpper: 887220,
167
+ * liquidity: '1000000000000'
168
+ * });
169
+ * console.log(`Will receive: ${estimation.amount0} GALA, ${estimation.amount1} GUSDC`);
170
+ * ```
73
171
  */
74
172
  getRemoveLiquidityEstimation(request: GalaChainGetRemoveLiquidityEstimationRequest): Promise<GalaChainRemoveLiquidityEstimation>;
75
173
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"GalaChainGatewayClient.d.ts","sourceRoot":"","sources":["../../../src/services/GalaChainGatewayClient.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EACL,wBAAwB,EACxB,iBAAiB,EACjB,2BAA2B,EAC3B,4BAA4B,EAC5B,6BAA6B,EAC7B,4CAA4C,EAC5C,kCAAkC,EAKnC,MAAM,8BAA8B,CAAC;AAEtC;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,qBAAa,sBAAsB;IACjC,OAAO,CAAC,MAAM,CAAgB;gBAElB,MAAM,EAAE,4BAA4B;IAOhD;;;;;;;OAOG;IACG,WAAW,CAAC,OAAO,EAAE,2BAA2B,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAwCnF;;;;;;;;;;;;;OAaG;IACG,YAAY,CAAC,OAAO,EAAE,4BAA4B,GAAG,OAAO,CAAC,6BAA6B,CAAC;IAoDjG;;;;;;;;;;;;;;;;OAgBG;IACG,eAAe,CACnB,iBAAiB,EAAE,MAAM,EAEzB,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAE7C,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC7C,WAAW,CAAC,EAAE,MAAM,EACpB,iBAAiB,CAAC,EAAE,MAAM,EAC1B,iBAAiB,CAAC,EAAE,MAAM,EAC1B,kBAAkB,CAAC,EAAE,MAAM,GAE1B,OAAO,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;IAyHlC;;;;;;;;;;OAUG;IACG,4BAA4B,CAChC,OAAO,EAAE,4CAA4C,GACpD,OAAO,CAAC,kCAAkC,CAAC;IA4B9C;;;;;;OAMG;IACH,OAAO,CAAC,gBAAgB;IAexB;;;;;;;OAOG;IACH,OAAO,CAAC,WAAW;CAkBpB;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI,wBAAwB,CAAC,CAAC,CAAC,CAAC"}
1
+ {"version":3,"file":"GalaChainGatewayClient.d.ts","sourceRoot":"","sources":["../../../src/services/GalaChainGatewayClient.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAGH,OAAO,EACL,wBAAwB,EACxB,iBAAiB,EACjB,2BAA2B,EAC3B,4BAA4B,EAC5B,6BAA6B,EAC7B,4CAA4C,EAC5C,kCAAkC,EAKnC,MAAM,8BAA8B,CAAC;AAEtC;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,qBAAa,sBAAsB;IACjC,OAAO,CAAC,MAAM,CAAgB;gBAElB,MAAM,EAAE,4BAA4B;IAOhD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,WAAW,CAAC,OAAO,EAAE,2BAA2B,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAwCnF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,YAAY,CAAC,OAAO,EAAE,4BAA4B,GAAG,OAAO,CAAC,6BAA6B,CAAC;IAoDjG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACG,eAAe,CACnB,iBAAiB,EAAE,MAAM,EAEzB,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAE7C,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC7C,WAAW,CAAC,EAAE,MAAM,EACpB,iBAAiB,CAAC,EAAE,MAAM,EAC1B,iBAAiB,CAAC,EAAE,MAAM,EAC1B,kBAAkB,CAAC,EAAE,MAAM,GAE1B,OAAO,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;IAyHlC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,4BAA4B,CAChC,OAAO,EAAE,4CAA4C,GACpD,OAAO,CAAC,kCAAkC,CAAC;IA4B9C;;;;;;OAMG;IACH,OAAO,CAAC,gBAAgB;IAexB;;;;;;;OAOG;IACH,OAAO,CAAC,WAAW;CAkBpB;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI,wBAAwB,CAAC,CAAC,CAAC,CAAC"}
@@ -13,10 +13,15 @@ import { BaseService } from './BaseService';
13
13
  * Image Service Class
14
14
  *
15
15
  * Provides methods for:
16
- * - Uploading token images
17
- * - Image validation and processing
16
+ * - Uploading token images with validation
17
+ * - Multi-environment support (Node.js and browser)
18
+ * - Image format and size validation
19
+ * - Automatic signature generation for secure uploads
18
20
  *
19
- * @example
21
+ * @category Services
22
+ * @since 3.6.0
23
+ *
24
+ * @example Basic token image upload
20
25
  * ```typescript
21
26
  * const imageService = new ImageService(httpClient);
22
27
  *
@@ -25,9 +30,52 @@ import { BaseService } from './BaseService';
25
30
  * tokenName: 'mytoken',
26
31
  * options: { file: imageFile, tokenName: 'mytoken' }
27
32
  * });
33
+ * console.log('Image uploaded:', imageUrl);
34
+ * ```
35
+ *
36
+ * @example Browser file upload with validation
37
+ * ```typescript
38
+ * const fileInput = document.querySelector('#image-upload') as HTMLInputElement;
39
+ * const file = fileInput.files?.[0];
40
+ *
41
+ * if (file) {
42
+ * // Validate file size before upload
43
+ * if (file.size > 5 * 1024 * 1024) {
44
+ * console.error('File too large (max 5MB)');
45
+ * return;
46
+ * }
47
+ *
48
+ * const imageUrl = await imageService.uploadImageByTokenName({
49
+ * tokenName: 'anime',
50
+ * options: { file, tokenName: 'anime' }
51
+ * });
52
+ * }
53
+ * ```
54
+ *
55
+ * @example Node.js buffer upload
56
+ * ```typescript
57
+ * import * as fs from 'fs';
58
+ *
59
+ * const imageBuffer = fs.readFileSync('./token-logo.png');
60
+ * const imageUrl = await imageService.uploadImageByTokenName({
61
+ * tokenName: 'GDOG',
62
+ * options: { file: imageBuffer, tokenName: 'GDOG' }
63
+ * });
28
64
  * ```
29
65
  */
30
66
  export declare class ImageService extends BaseService {
67
+ /**
68
+ * Creates an ImageService instance
69
+ *
70
+ * @param http Configured HttpClient with authentication
71
+ * @param debugMode Enable debug logging (default: false)
72
+ *
73
+ * @example
74
+ * ```typescript
75
+ * const httpClient = new HttpClient(config);
76
+ * const imageService = new ImageService(httpClient, true);
77
+ * ```
78
+ */
31
79
  constructor(http: HttpClient, debugMode?: boolean);
32
80
  /**
33
81
  * Uploads an image for a token pool
@@ -42,39 +90,80 @@ export declare class ImageService extends BaseService {
42
90
  * - Dimensions: Recommended 512x512px or higher
43
91
  * - Aspect ratio: Square (1:1) recommended
44
92
  *
93
+ * Security:
94
+ * - Automatic signature generation via wallet
95
+ * - Custom headers for authentication
96
+ * - Server-side validation
97
+ *
45
98
  * @param options Upload configuration object
46
99
  * @param options.file Image file as File object (browser) or Buffer (Node.js)
47
100
  * @param options.tokenName Token name for the image (must be valid token name format)
48
- * @returns Promise that resolves to image URL string
101
+ * @returns Promise resolving to image URL string (empty string if no URL returned)
49
102
  * @throws {ValidationError} If token name format is invalid
50
- * @throws {FileValidationError} If file doesn't meet requirements
51
- * @throws {Error} If upload fails due to network or server issues
103
+ * @throws {FileValidationError} If file doesn't meet requirements (size, format)
104
+ * @throws {ConfigurationError} If wallet not configured for signature generation
105
+ * @throws {ConfigurationError} If FormData not supported in environment
106
+ * @throws {ApiError} If upload fails due to network or server issues
107
+ *
108
+ * @category Image Operations
109
+ * @since 3.6.0
52
110
  *
53
- * @example Browser file upload
111
+ * @example Browser file upload with preview
54
112
  * ```typescript
55
113
  * const fileInput = document.querySelector('#image-upload') as HTMLInputElement;
56
114
  * const file = fileInput.files?.[0];
57
115
  *
58
116
  * if (file) {
117
+ * // Show preview
118
+ * const preview = URL.createObjectURL(file);
119
+ * imgElement.src = preview;
120
+ *
121
+ * // Upload
59
122
  * const imageUrl = await service.uploadImageByTokenName({
60
123
  * file,
61
- * tokenName: 'mytoken'
124
+ * tokenName: 'anime'
62
125
  * });
63
- * console.log('Image uploaded:', imageUrl);
126
+ * console.log('Uploaded:', imageUrl);
64
127
  * }
65
128
  * ```
66
129
  *
67
- * @example Node.js buffer upload
130
+ * @example Node.js buffer upload with validation
68
131
  * ```typescript
69
132
  * import * as fs from 'fs';
70
133
  *
71
- * const imageBuffer = fs.readFileSync('./token-image.png');
134
+ * const imageBuffer = fs.readFileSync('./token-logo.png');
135
+ * const stats = fs.statSync('./token-logo.png');
136
+ *
137
+ * // Validate size before upload
138
+ * if (stats.size > 5 * 1024 * 1024) {
139
+ * throw new Error('Image too large (max 5MB)');
140
+ * }
141
+ *
72
142
  * const imageUrl = await service.uploadImageByTokenName({
73
143
  * file: imageBuffer,
74
- * tokenName: 'mytoken'
144
+ * tokenName: 'GDOG'
75
145
  * });
76
146
  * console.log('Image URL:', imageUrl);
77
147
  * ```
148
+ *
149
+ * @example Error handling
150
+ * ```typescript
151
+ * try {
152
+ * const imageUrl = await service.uploadImageByTokenName({
153
+ * file: imageFile,
154
+ * tokenName: 'GUSDC'
155
+ * });
156
+ * console.log('Success:', imageUrl);
157
+ * } catch (error) {
158
+ * if (error instanceof ValidationError) {
159
+ * console.error('Invalid token name:', error.message);
160
+ * } else if (error.message.includes('FormData')) {
161
+ * console.error('Environment does not support file uploads');
162
+ * } else {
163
+ * console.error('Upload failed:', error);
164
+ * }
165
+ * }
166
+ * ```
78
167
  */
79
168
  uploadImageByTokenName(options: UploadImageByTokenNameOptions): Promise<string>;
80
169
  }
@@ -1 +1 @@
1
- {"version":3,"file":"ImageService.d.ts","sourceRoot":"","sources":["../../../src/services/ImageService.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAM3C,OAAO,EAAE,6BAA6B,EAAE,MAAM,sBAAsB,CAAC;AAIrE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAQ5C;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,YAAa,SAAQ,WAAW;gBAC/B,IAAI,EAAE,UAAU,EAAE,SAAS,GAAE,OAAe;IAIxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,sBAAsB,CAC1B,OAAO,EAAE,6BAA6B,GACrC,OAAO,CAAC,MAAM,CAAC;CAgEnB"}
1
+ {"version":3,"file":"ImageService.d.ts","sourceRoot":"","sources":["../../../src/services/ImageService.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAM3C,OAAO,EAAE,6BAA6B,EAAE,MAAM,sBAAsB,CAAC;AAIrE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAQ5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;OAWG;gBACS,IAAI,EAAE,UAAU,EAAE,SAAS,GAAE,OAAe;IAIxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuFG;IACG,sBAAsB,CAC1B,OAAO,EAAE,6BAA6B,GACrC,OAAO,CAAC,MAAM,CAAC;CAgEnB"}
@@ -43,38 +43,98 @@ export declare class PoolCacheManager {
43
43
  private readonly refetchThresholds;
44
44
  constructor(fetchPoolFn: (poolKey: string) => Promise<CompositePoolDataResult>, config: Required<SwapMonitorConfig>, metrics: MonitoringMetrics, logger?: Logger);
45
45
  /**
46
- * Get pool data from cache, fetching if necessary
46
+ * Retrieve pool data with three-tier LRU caching
47
47
  *
48
- * Implements three-tier cache strategy:
49
- * 1. Check hot cache (never expires)
50
- * 2. Check warm cache (30-min TTL)
51
- * 3. Check cold cache (5-min TTL)
52
- * 4. Fetch from backend if not found or expired
48
+ * Implements intelligent cache hierarchy for optimal performance:
49
+ * - **Hot Cache** (50 pools): Never expires, highest priority (e.g., GALA/GUSDC)
50
+ * - **Warm Cache** (200 pools): 30-minute TTL, frequently accessed pools
51
+ * - **Cold Cache** (remaining): 5-minute TTL, LRU eviction
53
52
  *
54
- * @param poolKey - Pool identifier
55
- * @returns Pool data
53
+ * **Cache Strategy**: Automatic tier assignment based on access patterns. Hot pools
54
+ * receive delta updates indefinitely. Warm/cold pools refetch periodically for accuracy.
55
+ *
56
+ * **Performance**: ~1ms cache hit, ~50-100ms cache miss (backend fetch)
57
+ *
58
+ * @param poolKey Pool identifier (e.g., 'GALA-GUSDC-3000')
59
+ * @returns Promise<CompositePoolDataResult> Complete pool state (cached or fresh)
60
+ * @throws Error if backend fetch fails
61
+ * @category Pool Cache
62
+ * @since 3.19.0
63
+ *
64
+ * @example Get pool with automatic caching
65
+ * ```typescript
66
+ * const poolData = await cacheManager.getPool('GALA-GUSDC-3000');
67
+ * console.log('Price:', poolData.pool.sqrtPriceX96);
68
+ * console.log('Liquidity:', poolData.pool.liquidity);
69
+ * // First call: ~80ms (cache miss)
70
+ * // Subsequent calls: ~1ms (cache hit)
71
+ * ```
56
72
  */
57
73
  getPool(poolKey: string): Promise<CompositePoolDataResult>;
58
74
  /**
59
- * Update pool cache with swap delta
75
+ * Apply swap delta to cached pool state for real-time updates
60
76
  *
61
- * Applies swap delta to cached pool state using SwapDeltaCalculator.
62
- * Tracks swap count, drift accumulation, and marks for refetch when thresholds exceeded.
77
+ * Updates pool state by calculating and applying swap deltas using SwapDeltaCalculator.
78
+ * This avoids expensive full pool refetches for every swap event, improving monitoring
79
+ * performance by 10-15x. Automatically triggers refetch when drift exceeds 5% or after
80
+ * 50 swaps to maintain accuracy.
63
81
  *
64
- * Performance: 25-50ms for typical swaps (1-3 tick crossings)
82
+ * **Delta Calculation**: Simulates tick crossings, liquidity changes, and price movements
83
+ * based on swap parameters. Typical accuracy: 99.5%+ vs full refetch.
65
84
  *
66
- * @param poolKey - Pool identifier
67
- * @param direction - Swap direction (zeroForOne or oneForZero)
68
- * @param amount0 - Amount of token0
69
- * @param amount1 - Amount of token1
70
- * @param swapEvent - Full swap event data for delta calculation
71
- * @returns Whether delta was successfully applied
85
+ * **Performance**: 25-50ms per swap (1-3 tick crossings), vs 500ms+ for full refetch
86
+ *
87
+ * **Refetch Triggers**:
88
+ * - 50+ swaps processed since last refetch
89
+ * - Cumulative drift >= 5%
90
+ * - Delta calculation error
91
+ *
92
+ * @param poolKey Pool identifier (e.g., 'GALA-GUSDC-3000')
93
+ * @param direction Swap direction ('zeroForOne' = sell token0, 'oneForZero' = buy token0)
94
+ * @param amount0 Amount of token0 in swap (decimal string)
95
+ * @param amount1 Amount of token1 in swap (decimal string)
96
+ * @param swapEvent Optional full swap event for precise delta calculation
97
+ * @returns true if delta applied successfully, false if pool not cached or error occurred
98
+ * @category Pool Cache
99
+ * @since 3.19.0
100
+ *
101
+ * @example Apply swap delta
102
+ * ```typescript
103
+ * const success = cacheManager.updatePoolWithSwapDelta(
104
+ * 'GALA-GUSDC-3000',
105
+ * 'zeroForOne',
106
+ * '1000.0',
107
+ * '995.2',
108
+ * swapEvent
109
+ * );
110
+ * if (success) {
111
+ * console.log('Pool state updated via delta');
112
+ * }
113
+ * ```
72
114
  */
73
115
  updatePoolWithSwapDelta(poolKey: string, direction: 'zeroForOne' | 'oneForZero', amount0: string, amount1: string, swapEvent?: SwapMonitorEvent): boolean;
74
116
  /**
75
- * Get cache statistics
117
+ * Get comprehensive cache statistics with tier breakdown
76
118
  *
77
- * @returns Cache stats with tier breakdown
119
+ * Returns detailed metrics about cache utilization, tier distribution, and memory usage.
120
+ * Useful for monitoring cache effectiveness, capacity planning, and performance tuning.
121
+ *
122
+ * @returns Cache statistics object with tier sizes and memory usage
123
+ * @category Monitoring
124
+ * @since 3.19.0
125
+ *
126
+ * @example Monitor cache statistics
127
+ * ```typescript
128
+ * const stats = cacheManager.getStats();
129
+ * console.log(`Total cached pools: ${stats.totalCached}`);
130
+ * console.log(`Hot: ${stats.hotCacheSize}, Warm: ${stats.warmCacheSize}, Cold: ${stats.coldCacheSize}`);
131
+ * console.log(`Memory used: ${stats.memoryUsedMB.toFixed(2)} MB`);
132
+ *
133
+ * // Alert if cache is underutilized
134
+ * if (stats.hotCacheSize < 20) {
135
+ * console.warn('Hot cache underutilized - consider monitoring more pools');
136
+ * }
137
+ * ```
78
138
  */
79
139
  getStats(): {
80
140
  totalCached: number;
@@ -99,24 +159,58 @@ export declare class PoolCacheManager {
99
159
  isExpired: boolean;
100
160
  } | null;
101
161
  /**
102
- * Warm cache with a pool (eager preload)
162
+ * Preload pool into cache (eager caching)
163
+ *
164
+ * Fetches and caches pool data before it's actively needed, reducing latency for
165
+ * first access. Typically used at monitoring startup to preload high-priority pools
166
+ * (e.g., GALA/GUSDC, top volume pools).
103
167
  *
104
- * Fetches and caches pool data for future access. Used during startup
105
- * to preload high-priority pools.
168
+ * **Use Case**: Preload top 50 pools at startup to populate hot cache tier.
106
169
  *
107
- * @param poolKey - Pool identifier to warm
108
- * @returns Whether pool was successfully warmed
170
+ * @param poolKey Pool identifier to preload (e.g., 'GALA-GUSDC-3000')
171
+ * @returns Promise<boolean> true if successfully warmed, false if fetch failed
172
+ * @category Pool Cache
173
+ * @since 3.19.0
174
+ *
175
+ * @example Warm cache for high-priority pool
176
+ * ```typescript
177
+ * const success = await cacheManager.warmCache('GALA-GUSDC-3000');
178
+ * if (success) {
179
+ * console.log('Pool preloaded - first access will be instant');
180
+ * }
181
+ * ```
109
182
  */
110
183
  warmCache(poolKey: string): Promise<boolean>;
111
184
  /**
112
- * Warm cache with multiple pools (batch eager preload)
185
+ * Preload multiple pools into cache with concurrency control
186
+ *
187
+ * Efficiently preloads an array of pools in parallel with rate limiting to avoid
188
+ * overwhelming the backend. Ideal for startup warming of top pools to populate
189
+ * hot cache tier. Returns statistics for monitoring warming success rate.
190
+ *
191
+ * **Use Case**: At monitoring startup, preload top 50 pools by TVL or volume.
192
+ *
193
+ * **Performance**: 5 concurrent requests = ~1 second per 5 pools (200ms each)
113
194
  *
114
- * Fetches multiple pools in parallel with concurrency control.
115
- * Useful for preloading top pools at startup.
195
+ * @param poolKeys Array of pool identifiers to preload
196
+ * @param maxConcurrent Maximum parallel fetch requests (default: 5, max recommended: 10)
197
+ * @returns Promise<WarmingStats> Statistics with succeeded/failed/total counts
198
+ * @category Pool Cache
199
+ * @since 3.19.0
116
200
  *
117
- * @param poolKeys - Array of pool identifiers to warm
118
- * @param maxConcurrent - Maximum parallel requests (default: 5)
119
- * @returns Statistics on warming results
201
+ * @example Warm top pools at startup
202
+ * ```typescript
203
+ * const topPools = [
204
+ * 'GALA-GUSDC-3000',
205
+ * 'anime-GALA-3000',
206
+ * 'GDOG-GALA-3000'
207
+ * ];
208
+ * const stats = await cacheManager.warmCacheBatch(topPools, 5);
209
+ * console.log(`Warmed ${stats.succeeded}/${stats.total} pools`);
210
+ * if (stats.failed > 0) {
211
+ * console.warn(`${stats.failed} pools failed to load`);
212
+ * }
213
+ * ```
120
214
  */
121
215
  warmCacheBatch(poolKeys: string[], maxConcurrent?: number): Promise<{
122
216
  succeeded: number;
@@ -1 +1 @@
1
- {"version":3,"file":"PoolCacheManager.d.ts","sourceRoot":"","sources":["../../../src/services/PoolCacheManager.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,6BAA6B,CAAC;AAC3E,OAAO,KAAK,EAAE,iBAAiB,EAAE,aAAa,IAAI,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAEtG,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAG/D;;;;GAIG;AACH,KAAK,SAAS,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;AAwBzC;;;;;;;GAOG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAqC;IAC3D,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;IAC5C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA8B;IACrD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAwD;IAEpF,0CAA0C;IAC1C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAIxB;IAEF,mCAAmC;IACnC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAIvB;IAEF,yBAAyB;IACzB,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAGhC;gBAGA,WAAW,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,uBAAuB,CAAC,EAClE,MAAM,EAAE,QAAQ,CAAC,iBAAiB,CAAC,EACnC,OAAO,EAAE,iBAAiB,EAC1B,MAAM,CAAC,EAAE,MAAM;IAkBjB;;;;;;;;;;;OAWG;IACG,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC;IA2DhE;;;;;;;;;;;;;;OAcG;IACH,uBAAuB,CACrB,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,YAAY,GAAG,YAAY,EACtC,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,SAAS,CAAC,EAAE,gBAAgB,GAC3B,OAAO;IAyEV;;;;OAIG;IACH,QAAQ,IAAI;QACV,WAAW,EAAE,MAAM,CAAC;QACpB,YAAY,EAAE,MAAM,CAAC;QACrB,aAAa,EAAE,MAAM,CAAC;QACtB,aAAa,EAAE,MAAM,CAAC;QACtB,YAAY,EAAE,MAAM,CAAC;KACtB;IAkBD;;;;;OAKG;IACH,WAAW,CAAC,OAAO,EAAE,MAAM;;;;;;;;;IAiB3B;;;;;;;;OAQG;IACG,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAgBlD;;;;;;;;;OASG;IACG,cAAc,CAClB,QAAQ,EAAE,MAAM,EAAE,EAClB,aAAa,GAAE,MAAU,GACxB,OAAO,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAsChE;;OAEG;IACH,KAAK,IAAI,IAAI;IAKb;;OAEG;IACH,YAAY,IAAI,IAAI;IAgBpB;;;;OAIG;IACH,OAAO,CAAC,aAAa;IAkBrB;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IAU1B;;;;OAIG;IACH,OAAO,CAAC,aAAa;IAcrB;;;;;;OAMG;IACH,OAAO,CAAC,QAAQ;IA2BhB;;;;;;;OAOG;IACG,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC;CAmC9C"}
1
+ {"version":3,"file":"PoolCacheManager.d.ts","sourceRoot":"","sources":["../../../src/services/PoolCacheManager.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,6BAA6B,CAAC;AAC3E,OAAO,KAAK,EAAE,iBAAiB,EAAE,aAAa,IAAI,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAEtG,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAG/D;;;;GAIG;AACH,KAAK,SAAS,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;AAwBzC;;;;;;;GAOG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAqC;IAC3D,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;IAC5C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA8B;IACrD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAwD;IAEpF,0CAA0C;IAC1C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAIxB;IAEF,mCAAmC;IACnC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAIvB;IAEF,yBAAyB;IACzB,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAGhC;gBAGA,WAAW,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,uBAAuB,CAAC,EAClE,MAAM,EAAE,QAAQ,CAAC,iBAAiB,CAAC,EACnC,OAAO,EAAE,iBAAiB,EAC1B,MAAM,CAAC,EAAE,MAAM;IAkBjB;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC;IA2DhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACH,uBAAuB,CACrB,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,YAAY,GAAG,YAAY,EACtC,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,SAAS,CAAC,EAAE,gBAAgB,GAC3B,OAAO;IAyEV;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,QAAQ,IAAI;QACV,WAAW,EAAE,MAAM,CAAC;QACpB,YAAY,EAAE,MAAM,CAAC;QACrB,aAAa,EAAE,MAAM,CAAC;QACtB,aAAa,EAAE,MAAM,CAAC;QACtB,YAAY,EAAE,MAAM,CAAC;KACtB;IAkBD;;;;;OAKG;IACH,WAAW,CAAC,OAAO,EAAE,MAAM;;;;;;;;;IAiB3B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAgBlD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,cAAc,CAClB,QAAQ,EAAE,MAAM,EAAE,EAClB,aAAa,GAAE,MAAU,GACxB,OAAO,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAsChE;;OAEG;IACH,KAAK,IAAI,IAAI;IAKb;;OAEG;IACH,YAAY,IAAI,IAAI;IAgBpB;;;;OAIG;IACH,OAAO,CAAC,aAAa;IAkBrB;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IAU1B;;;;OAIG;IACH,OAAO,CAAC,aAAa;IAcrB;;;;;;OAMG;IACH,OAAO,CAAC,QAAQ;IA2BhB;;;;;;;OAOG;IACG,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC;CAmC9C"}