@zofai/zo-sdk 0.1.94 → 0.1.96

package/dist/interfaces/zlp.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"zlp.d.mts","sourceRoot":"","sources":["../../src/interfaces/zlp.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,yBAAyB,EAAE,iCAAgC;AAEtF,OAAO,KAAK,EACV,QAAQ,EACR,eAAe,EACf,YAAY,EACZ,oBAAoB,EACpB,YAAY,EACZ,eAAe,EACf,wBAAwB,EACxB,iBAAiB,EACjB,cAAc,EACd,oBAAoB,EACpB,mBAAmB,EACnB,iBAAiB,EACjB,mBAAmB,EACnB,sBAAsB,EACtB,cAAc,EACd,eAAe,EACf,cAAc,EACd,iBAAiB,EAClB,mBAAc;AAGf,MAAM,WAAW,uBAAwB,SAAQ,wBAAwB;IACvE,oFAAoF;IACpF,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACrC;AAED,MAAM,WAAW,aAAc,SAAQ,cAAc;CAAI;AAEzD,MAAM,WAAW,qBAAsB,SAAQ,sBAAsB;CAAI;AAEzE,MAAM,WAAW,mBAAoB,SAAQ,oBAAoB;CAAI;AAErE,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;CAAI;AAEnE,MAAM,WAAW,cAAe,SAAQ,eAAe;CAAI;AAE3D,MAAM,WAAW,cAAe,SAAQ,eAAe;CAEtD;AAED,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB;CAE1D;AAED,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;CAAI;AAEnE,MAAM,WAAW,mBAAoB,SAAQ,oBAAoB;CAAI;AAErE,MAAM,WAAW,aAAc,SAAQ,cAAc;CAAI;AAEzD,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB;CAAI;AAE/D,MAAM,WAAW,WAAY,SAAQ,YAAY;CAEhD;AAED,MAAM,WAAW,aAAc,SAAQ,cAAc;IAEnD,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,cAAe,SAAQ,eAAe;CAEtD;AAGD,MAAM,WAAW,gCAAgC;IAC/C,sCAAsC,EAAE,MAAM,CAAA;IAC9C,2BAA2B,EAAE,MAAM,CAAA;IACnC,+BAA+B,EAAE,OAAO,CAAA;IACxC,sCAAsC,EAAE,MAAM,CAAA;IAC9C,2BAA2B,EAAE,MAAM,CAAA;IACnC,+BAA+B,EAAE,OAAO,CAAA;IACxC,sCAAsC,EAAE,MAAM,CAAA;IAC9C,2BAA2B,EAAE,MAAM,CAAA;IACnC,+BAA+B,EAAE,OAAO,CAAA;CACzC;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,gBAAgB,EAAE,MAAM,CAAA;IACxB,wBAAwB,EAAE,OAAO,CAAA;IACjC,6BAA6B,EAAE,MAAM,CAAA;IACrC,qCAAqC,EAAE,OAAO,CAAA;IAC9C,uBAAuB,EAAE,gCAAgC,CAAA;CAC1D;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,GAAG,EAAE,MAAM,CAAA;CACZ;AACD,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,OAAO,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,kBAAkB,CAAA;IACzB,0FAA0F;IAC1F,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,0FAA0F;IAC1F,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAA;IACV,sDAAsD;IACtD,OAAO,EAAE,OAAO,CAAA;IAChB,wEAAwE;IACxE,cAAc,EAAE,MAAM,CAAA;IACtB,yDAAyD;IACzD,oBAAoB,EAAE,MAAM,CAAA;IAC5B,4CAA4C;IAC5C,kBAAkB,EAAE,MAAM,CAAA;IAC1B,uEAAuE;IACvE,cAAc,EAAE,MAAM,CAAA;IACtB,wDAAwD;IACxD,SAAS,EAAE,MAAM,CAAA;IACjB,yDAAyD;IACzD,UAAU,EAAE,MAAM,CAAA;IAClB,mFAAmF;IACnF,aAAa,EAAE,MAAM,CAAA;CACtB;AAGD,MAAM,WAAW,WAAY,SAAQ,YAAY;IAC/C,eAAe,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,KAAK,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAA;IACxF,oBAAoB,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAC,CAAA;IACnF,yBAAyB,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAA;CAClH;AAGD,MAAM,WAAW,OAAQ,SAAQ,QAAQ;IACvC,iBAAiB,EAAE,CACjB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EAAE,EACf,aAAa,EAAE,MAAM,EAAE,EACvB,OAAO,EAAE,MAAM,EAAE,EACjB,EAAE,EAAE,WAAW,KACZ,IAAI,CAAA;IAET,kBAAkB,EAAE,CAClB,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,EAAE,EACrB,MAAM,EAAE,MAAM,KACX,WAAW,CAAA;IAEhB,qBAAqB,EAAE,CACrB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,KACX,WAAW,CAAA;IAEhB,WAAW,EAAE,CACX,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,KACZ,WAAW,CAAA;IAEhB,mBAAmB,EAAE,CACnB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EAAE,EACf,aAAa,EAAE,MAAM,EAAE,EACvB,OAAO,EAAE,MAAM,EAAE,EACjB,MAAM,EAAE,MAAM,EAAE,EAChB,YAAY,EAAE,MAAM,EAAE,EACtB,EAAE,EAAE,WAAW,KACZ,IAAI,CAAA;IAET,aAAa,EAAE,CACb,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,KACZ,WAAW,CAAA;IAEhB,0BAA0B,EAAE,CAC1B,IAAI,EAAE,MAAM,EACZ,aAAa,EAAE,MAAM,EAAE,EACvB,eAAe,EAAE,MAAM,EAAE,EACzB,aAAa,EAAE,MAAM,EAAE,EACvB,eAAe,EAAE,MAAM,EAAE,EACzB,EAAE,EAAE,WAAW,KACZ,IAAI,CAAA;IAET,eAAe,EAAE,CACf,IAAI,EAAE,MAAM,EACZ,cAAc,EAAE,MAAM,KACnB,WAAW,CAAA;IAEhB,aAAa,EAAE,CACb,IAAI,EAAE,MAAM,EACZ,cAAc,EAAE,MAAM,KACnB,WAAW,CAAA;IAEhB,uBAAuB,EAAE,CACvB,IAAI,EAAE,MAAM,EACZ,cAAc,EAAE,MAAM,KACnB,WAAW,CAAA;IAEhB,UAAU,EAAE,CACV,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,EAAE,EACrB,MAAM,EAAE,MAAM,EACd,YAAY,CAAC,EAAE,MAAM,EACrB,eAAe,CAAC,EAAE,MAAM,EACxB,MAAM,CAAC,EAAE,MAAM,EACf,EAAE,CAAC,EAAE,WAAW,EAChB,WAAW,CAAC,EAAE,OAAO,EACrB,2BAA2B,CAAC,EAAE,MAAM,EAAE,KACnC,OAAO,CAAC,yBAAyB,CAAC,CAAA;IAEvC,eAAe,EAAE,CACf,UAAU,EAAE,yBAAyB,EACrC,IAAI,EAAE,MAAM,EACZ,EAAE,CAAC,EAAE,WAAW,KACb,WAAW,CAAA;IAEhB,oBAAoB,EAAE,CACpB,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,yBAAyB,EACvC,YAAY,EAAE,MAAM,EACpB,EAAE,CAAC,EAAE,WAAW,KACb,OAAO,CAAC,WAAW,CAAC,CAAA;IAEzB,oBAAoB,EAAE,CACpB,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,MAAM,EAClB,cAAc,EAAE,MAAM,EACtB,EAAE,EAAE,WAAW,KACZ,yBAAyB,CAAA;IAE9B,eAAe,EAAE,CACf,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,MAAM,EAClB,EAAE,EAAE,WAAW,KACZ,yBAAyB,CAAA;IAE9B,cAAc,EAAE,CACd,WAAW,EAAE,cAAc,EAAE,EAC7B,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,WAAW,KACZ,yBAAyB,EAAE,CAAA;CACjC"}
+{"version":3,"file":"zlp.d.mts","sourceRoot":"","sources":["../../src/interfaces/zlp.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,yBAAyB,EAAE,iCAAgC;AAEtF,OAAO,KAAK,EACV,QAAQ,EACR,eAAe,EACf,YAAY,EACZ,oBAAoB,EACpB,YAAY,EACZ,eAAe,EACf,wBAAwB,EACxB,iBAAiB,EACjB,cAAc,EACd,oBAAoB,EACpB,mBAAmB,EACnB,iBAAiB,EACjB,mBAAmB,EACnB,sBAAsB,EACtB,cAAc,EACd,eAAe,EACf,cAAc,EACd,iBAAiB,EAClB,mBAAc;AAGf,MAAM,WAAW,uBAAwB,SAAQ,wBAAwB;IACvE,oFAAoF;IACpF,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACrC;AAED,MAAM,WAAW,aAAc,SAAQ,cAAc;CAAI;AAEzD,MAAM,WAAW,qBAAsB,SAAQ,sBAAsB;CAAI;AAEzE,MAAM,WAAW,mBAAoB,SAAQ,oBAAoB;CAAI;AAErE,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;CAAI;AAEnE,MAAM,WAAW,cAAe,SAAQ,eAAe;CAAI;AAE3D,MAAM,WAAW,cAAe,SAAQ,eAAe;CAEtD;AAED,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB;CAE1D;AAED,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;CAAI;AAEnE,MAAM,WAAW,mBAAoB,SAAQ,oBAAoB;CAAI;AAErE,MAAM,WAAW,aAAc,SAAQ,cAAc;CAAI;AAEzD,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB;CAAI;AAE/D,MAAM,WAAW,WAAY,SAAQ,YAAY;CAEhD;AAED,MAAM,WAAW,aAAc,SAAQ,cAAc;IAEnD,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,cAAe,SAAQ,eAAe;CAEtD;AAGD,MAAM,WAAW,gCAAgC;IAC/C,sCAAsC,EAAE,MAAM,CAAA;IAC9C,2BAA2B,EAAE,MAAM,CAAA;IACnC,+BAA+B,EAAE,OAAO,CAAA;IACxC,sCAAsC,EAAE,MAAM,CAAA;IAC9C,2BAA2B,EAAE,MAAM,CAAA;IACnC,+BAA+B,EAAE,OAAO,CAAA;IACxC,sCAAsC,EAAE,MAAM,CAAA;IAC9C,2BAA2B,EAAE,MAAM,CAAA;IACnC,+BAA+B,EAAE,OAAO,CAAA;CACzC;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,gBAAgB,EAAE,MAAM,CAAA;IACxB,wBAAwB,EAAE,OAAO,CAAA;IACjC,6BAA6B,EAAE,MAAM,CAAA;IACrC,qCAAqC,EAAE,OAAO,CAAA;IAC9C,uBAAuB,EAAE,gCAAgC,CAAA;CAC1D;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,GAAG,EAAE,MAAM,CAAA;CACZ;AACD,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,OAAO,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,kBAAkB,CAAA;IACzB,0FAA0F;IAC1F,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,0FAA0F;IAC1F,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAA;IACV,sDAAsD;IACtD,OAAO,EAAE,OAAO,CAAA;IAChB,wEAAwE;IACxE,cAAc,EAAE,MAAM,CAAA;IACtB,yDAAyD;IACzD,oBAAoB,EAAE,MAAM,CAAA;IAC5B,4CAA4C;IAC5C,kBAAkB,EAAE,MAAM,CAAA;IAC1B,uEAAuE;IACvE,cAAc,EAAE,MAAM,CAAA;IACtB,wDAAwD;IACxD,SAAS,EAAE,MAAM,CAAA;IACjB,yDAAyD;IACzD,UAAU,EAAE,MAAM,CAAA;IAClB,mFAAmF;IACnF,aAAa,EAAE,MAAM,CAAA;CACtB;AAGD,MAAM,WAAW,WAAY,SAAQ,YAAY;IAC/C,eAAe,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,KAAK,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAA;IACxF,oBAAoB,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAC,CAAA;IACnF,yBAAyB,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAA;CAClH;AAGD,MAAM,WAAW,OAAQ,SAAQ,QAAQ;IACvC,iBAAiB,EAAE,CACjB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EAAE,EACf,aAAa,EAAE,MAAM,EAAE,EACvB,OAAO,EAAE,MAAM,EAAE,EACjB,EAAE,EAAE,WAAW,KACZ,IAAI,CAAA;IAET,kBAAkB,EAAE,CAClB,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,EAAE,EACrB,MAAM,EAAE,MAAM,KACX,WAAW,CAAA;IAEhB,qBAAqB,EAAE,CACrB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,KACX,WAAW,CAAA;IAEhB,WAAW,EAAE,CACX,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,KACZ,WAAW,CAAA;IAEhB,mBAAmB,EAAE,CACnB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EAAE,EACf,aAAa,EAAE,MAAM,EAAE,EACvB,OAAO,EAAE,MAAM,EAAE,EACjB,MAAM,EAAE,MAAM,EAAE,EAChB,YAAY,EAAE,MAAM,EAAE,EACtB,EAAE,EAAE,WAAW,KACZ,IAAI,CAAA;IAET,aAAa,EAAE,CACb,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,KACZ,WAAW,CAAA;IAEhB,0BAA0B,EAAE,CAC1B,IAAI,EAAE,MAAM,EACZ,aAAa,EAAE,MAAM,EAAE,EACvB,eAAe,EAAE,MAAM,EAAE,EACzB,aAAa,EAAE,MAAM,EAAE,EACvB,eAAe,EAAE,MAAM,EAAE,EACzB,EAAE,EAAE,WAAW,KACZ,IAAI,CAAA;IAET,eAAe,EAAE,CACf,IAAI,EAAE,MAAM,EACZ,cAAc,EAAE,MAAM,KACnB,WAAW,CAAA;IAEhB,aAAa,EAAE,CACb,IAAI,EAAE,MAAM,EACZ,cAAc,EAAE,MAAM,KACnB,WAAW,CAAA;IAEhB,uBAAuB,EAAE,CACvB,IAAI,EAAE,MAAM,EACZ,cAAc,EAAE,MAAM,KACnB,WAAW,CAAA;IAEhB,UAAU,EAAE,CACV,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,EAAE,EACrB,MAAM,EAAE,MAAM,EACd,YAAY,CAAC,EAAE,MAAM,EACrB,eAAe,CAAC,EAAE,MAAM,EACxB,MAAM,CAAC,EAAE,MAAM,EACf,EAAE,CAAC,EAAE,WAAW,EAChB,WAAW,CAAC,EAAE,OAAO,EACrB,2BAA2B,CAAC,EAAE,MAAM,EAAE,KACnC,OAAO,CAAC,yBAAyB,CAAC,CAAA;IAEvC,eAAe,EAAE,CACf,UAAU,EAAE,yBAAyB,EACrC,IAAI,EAAE,MAAM,EACZ,EAAE,CAAC,EAAE,WAAW,KACb,WAAW,CAAA;IAEhB,oBAAoB,EAAE,CACpB,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,yBAAyB,EACvC,YAAY,EAAE,MAAM,EACpB,EAAE,CAAC,EAAE,WAAW,KACb,OAAO,CAAC,WAAW,CAAC,CAAA;IAEzB,oBAAoB,EAAE,CACpB,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,MAAM,EAClB,cAAc,EAAE,MAAM,EACtB,EAAE,EAAE,WAAW,KACZ,yBAAyB,CAAA;IAE9B,eAAe,EAAE,CACf,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,MAAM,EAClB,EAAE,EAAE,WAAW,KACZ,yBAAyB,CAAA;IAE9B,cAAc,EAAE,CACd,WAAW,EAAE,cAAc,EAAE,EAC7B,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,WAAW,KACZ,yBAAyB,EAAE,CAAA;IAEhC;;;OAGG;IACH,SAAS,EAAE,CACT,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,eAAe,EAAE,MAAM,EAAE,EACzB,YAAY,CAAC,EAAE,MAAM,EACrB,EAAE,CAAC,EAAE,WAAW,KACb,OAAO,CAAC,yBAAyB,CAAC,CAAA;CACxC"}

package/docs/SUMMARY.md

@@ -4,6 +4,7 @@
 * [Architecture](architecture.md)
 * [Getting Started](getting-started.md)
 * [Common Operations](common-operations.md)
+* [Swap Integration](swap-integration.md)
 * [Trading Examples](lp-specific-features.md)
 * [Type Safety](type-safety.md)
 * [Error Handling](error-handling.md)

package/docs/getting-started.md

@@ -2,16 +2,16 @@
 
 ## 1. Create an API or DataAPI instance
 
-Use the **SDK** factory (exported as `SDK` from `zo-sdk`) to create LP-specific instances. You need a Sui client, network, API endpoint, and connection URL.
+Use the **SDK** factory (exported as `SDK` from `@zofai/zo-sdk`) to create LP-specific instances. You need a Sui client, network, API endpoint, and connection URL.
 
 ```typescript
-import { SDK, LPToken, Network } from 'zo-sdk'
+import { SDK, LPToken, Network } from '@zofai/zo-sdk'
 import { SuiClient } from '@mysten/sui/client'
 
 const provider = new SuiClient({ url: 'https://fullnode.mainnet.sui.io' })
 const network = Network.MAINNET
-const apiEndpoint = 'https://api.zo.xyz'
-const connectionURL = 'wss://api.zo.xyz/ws'
+const apiEndpoint = 'https://api.zofinance.io'
+const connectionURL = 'https://hermes.zofinance.io'
 
 // Create API instances (transactions + data)
 const zlpAPI = SDK.createZLPAPI(network, provider, apiEndpoint, connectionURL)

package/docs/introduction.md

@@ -5,11 +5,11 @@ ZO SDK is a TypeScript SDK for interacting with multiple LP tokens on Sui Networ
 ## Installation
 
 ```bash
-npm install zo-sdk
+npm install @zofai/zo-sdk
 # or
-yarn add zo-sdk
+yarn add @zofai/zo-sdk
 # or
-pnpm add zo-sdk
+pnpm add @zofai/zo-sdk
 ```
 
 For the full guide, see [Getting Started](getting-started.md).

package/docs/swap-integration.md

@@ -0,0 +1,183 @@
+# Swap Integration
+
+This guide covers how to integrate swaps using the ZO SDK. Swaps are supported on **ZLP**, **SLP**, and **USDZ** via `api.swap()`, `api.swapV2Ptb()`, and fee estimation via `dataAPI.calculateSwapFeeBreakdown()`.
+
+## Overview
+
+A swap flow typically involves:
+
+1. **Estimate fees** – Get the expected fee breakdown for the swap.
+2. **Set slippage protection** – Compute `minAmountOut` based on expected output and slippage tolerance.
+3. **Build transaction** – Call `api.swap()` to construct the transaction.
+4. **Sign and send** – Sign with the wallet and submit to the network.
+
+## Amounts and units
+
+- `fromAmount` is in **atomic units** (raw token units), e.g. `1_000_000` for 1 USDC (6 decimals).
+- `minAmountOut` is in **atomic units** of the destination token.
+- `calculateSwapFeeBreakdown(fromAmount)` expects atomic units for the source token.
+
+```typescript
+// Example: swap 100 USDC (6 decimals) for SUI
+const fromAmount = BigInt(100 * 1e6)  // 100_000_000 atomic units
+```
+
+## Estimate swap fees
+
+Before building the swap transaction, you can estimate the fee breakdown to display to the user or compute a safe `minAmountOut`.
+
+```typescript
+import { SDK, LPToken, Network } from '@zofai/zo-sdk'
+import { SuiClient } from '@mysten/sui/client'
+
+const provider = new SuiClient({ url: 'https://fullnode.mainnet.sui.io' })
+const network = Network.MAINNET
+const apiEndpoint = 'https://api.zofinance.io'
+const connectionURL = 'https://hermes.zofinance.io'
+
+const slpDataAPI = SDK.createSLPDataAPI(network, provider, apiEndpoint, connectionURL)
+
+// fromAmount in atomic units (e.g. 100 USDC = 100 * 1e6)
+const fromToken = 'usdc'
+const toToken = 'sui'
+const fromAmount = 100 * 1e6
+
+const feeBreakdown = await slpDataAPI.calculateSwapFeeBreakdown(fromToken, toToken, fromAmount)
+
+// feeBreakdown contains:
+// - swapValue: notional in USD
+// - totalVaultsValue: total vault value in USD
+// - rebaseFeeInRate, rebaseFeeOutRate: rates for swap-in and swap-out
+// - rebaseFeeInValue, rebaseFeeOutValue: rebase fee amounts in USD
+// - swapImpactFeeValue: swap impact fee in USD
+// - emaVolatilityFeeValue: EMA volatility fee in USD
+// - totalFeeValue: sum of all fee components
+// - totalFeeRate: totalFeeValue / swapValue
+
+console.log(`Total fee: ${feeBreakdown.totalFeeValue.toFixed(4)} USD`)
+console.log(`Fee rate: ${(feeBreakdown.totalFeeRate * 100).toFixed(2)}%`)
+```
+
+## Build and submit swap transaction
+
+Use the **API** instance to build the swap transaction. You need:
+
+- `fromToken`, `toToken` – token identifiers (e.g. `'usdc'`, `'sui'`).
+- `fromAmount` – amount in atomic units (bigint).
+- `fromCoinObjects` – owned coin object IDs for the source token.
+- `minAmountOut` – optional; minimum output amount in atomic units (slippage protection).
+
+```typescript
+const slpAPI = SDK.createSLPAPI(network, provider, apiEndpoint, connectionURL)
+
+const fromAmount = BigInt(100 * 1e6)  // 100 USDC
+const fromCoinObjects = ['0x...']     // user's USDC coin IDs
+
+// Optional: set minAmountOut to protect against slippage
+// e.g. 1% slippage: minAmountOut = expectedOut * 0.99
+const minAmountOut = 0  // or compute from oracle + slippage
+
+const tx = await slpAPI.swap(
+  'usdc',
+  'sui',
+  fromAmount,
+  fromCoinObjects,
+  minAmountOut
+)
+
+// Sign with wallet and execute
+// const signed = await signAndExecuteTransaction({ transaction: tx })
+```
+
+## Swap and return coin to user (swapV2Ptb)
+
+Use `swapV2Ptb()` when you need the output coin returned as a `TransactionObjectArgument`—for example, to pass into another move call or to transfer it within the same transaction. Unlike `swap()`, which consumes the output internally, `swapV2Ptb()` returns the output coin so you can compose it into larger transactions.
+
+Pass an optional `tx` to compose into an existing transaction; otherwise a new transaction is created (you must sign and execute it via your wallet).
+
+```typescript
+const slpAPI = SDK.createSLPAPI(network, provider, apiEndpoint, connectionURL)
+
+// Option 1: Standalone swap (tx created internally)
+const tx = new Transaction()
+const outputCoin = await slpAPI.swapV2Ptb(
+  'usdc',
+  'sui',
+  BigInt(100 * 1e6),
+  fromCoinObjects,
+  minAmountOut,
+  tx
+)
+// tx is modified in place; sign and execute tx
+
+// Option 2: Compose with other move calls
+const composedTx = new Transaction()
+const swapCoin = await slpAPI.swapV2Ptb('usdc', 'sui', BigInt(100 * 1e6), fromCoinObjects, minAmountOut, composedTx)
+composedTx.transferObjects([swapCoin], composedTx.pure.address(recipientAddress))
+```
+
+## Complete integration example
+
+```typescript
+import { SDK, LPToken, Network } from '@zofai/zo-sdk'
+import { SuiClient } from '@mysten/sui/client'
+
+async function swapWithFeeEstimate(
+  fromToken: string,
+  toToken: string,
+  fromAmountAtomic: number,
+  fromCoinObjects: string[],
+  slippageBps: number = 50,  // 0.5%
+) {
+  const provider = new SuiClient({ url: 'https://fullnode.mainnet.sui.io' })
+  const api = SDK.createSLPAPI(
+    Network.MAINNET,
+    provider,
+    'https://api.zofinance.io',
+    'https://hermes.zofinance.io'
+  )
+
+  // 1. Estimate fees
+  const feeBreakdown = await api.dataAPI.calculateSwapFeeBreakdown(
+    fromToken,
+    toToken,
+    fromAmountAtomic
+  )
+
+  // 2. Compute minAmountOut from fee breakdown (net value after fees) and slippage
+  const toPrice = (await api.getOraclePrice(toToken)).getPriceUnchecked().getPriceAsNumberUnchecked()
+  const toDecimals = 9  // use deployment consts or lookup
+  const netValueUsd = feeBreakdown.swapValue - feeBreakdown.totalFeeValue
+  const expectedOutAtomic = (netValueUsd * (10 ** toDecimals)) / toPrice
+  const minAmountOut = Math.floor(expectedOutAtomic * (1 - slippageBps / 10000))
+
+  // 3. Build transaction
+  const tx = await api.swap(
+    fromToken,
+    toToken,
+    BigInt(fromAmountAtomic),
+    fromCoinObjects,
+    minAmountOut
+  )
+
+  return {
+    transaction: tx,
+    feeBreakdown,
+  }
+}
+```
+
+## Fee components
+
+| Component | Description |
+|-----------|-------------|
+| **Rebase fee (in)** | Fee on the source token when swapping in; depends on vault utilization. |
+| **Rebase fee (out)** | Fee on the destination token when swapping out. |
+| **Swap impact fee** | Fee from `SwapImpactConfig`; scales with `swapValue / totalVaultsValue`. |
+| **EMA volatility fee** | Fee from `EmaVolatilityFeeConfig`; scales with price divergence from EMA. |
+
+Use `calculateSwapFeeBreakdown` to get the USD value of each component and the total fee before executing the swap.
+
+## Token identifiers
+
+Tokens are identified by their symbol in the deployment config, e.g. `'sui'`, `'usdc'`, `'usdt'`, `'eth'`, `'btc'`. Ensure the `fromToken` and `toToken` values match those in the LP’s supported tokens.

package/docs/type-safety.md

@@ -16,7 +16,7 @@ import type {
   IBaseSymbolInfo,
   IBasePositionInfo,
   IBaseOrderInfo
-} from 'zo-sdk'
+} from '@zofai/zo-sdk'
 
 // All APIs implement their respective interfaces
 const zlpAPI: IZLPAPI = SDK.createZLPAPI(network, provider, apiEndpoint, connectionURL)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zofai/zo-sdk",
   "type": "module",
-  "version": "0.1.94",
+  "version": "0.1.96",
   "author": "zo",
   "exports": {
     ".": {

package/src/consts/deployments-usdz-mainnet.json

@@ -143,56 +143,6 @@
         "funding_fee_model": "0xc1c25c0402b1cee0af7c724aedee71fe64436bdee285a37f5a6dcca3004c6eba",
         "position_config": "0x4786e2d0688cfca6329952689f364a6c2ff928ab98262c6beb7aedb1186bc37d"
       },
-      "long_spy": {
-        "supported_collaterals": ["nusdc"],
-        "funding_fee_model": "0x9f39668bc0893250e13d4592dabbf030b4ddd58b38b64c027a0b2858a489dac5",
-        "position_config": "0x802ef0a8ced165f79029323c1077e9e6e313b9da7b5522bd70f1690c9ac34f13"
-      },
-      "short_spy": {
-        "supported_collaterals": ["nusdc"],
-        "funding_fee_model": "0x92f774684fd05c0bd20e2a690237f856795df7a2464d789306e2789de67c73ab",
-        "position_config": "0x9ad859654c3f981e710953a25f4ee6a31470d95b02c6c666cee69878819c439d"
-      },
-      "long_nlr": {
-        "supported_collaterals": ["nusdc"],
-        "funding_fee_model": "0x2a47b62ee1a4def0588451cc945e98c1764ecbba9d4b31ce57c5cfc84725cd72",
-        "position_config": "0x8696123eba339bc0f4502b331a04ddc85b319bb08b50ba203481873d57df2094"
-      },
-      "short_nlr": {
-        "supported_collaterals": ["nusdc"],
-        "funding_fee_model": "0x7ec7a3539d6d7dbbab77e740c27ce0ca2f3f0654664b700f8ad94cfd79c105ed",
-        "position_config": "0xc9d655679f822d32c290764cf3797b70ef75a1566590ecfbbbddda2f2a40551a"
-      },
-      "long_qqq": {
-        "supported_collaterals": ["nusdc"],
-        "funding_fee_model": "0xbf7fbc99f0951c7cdb8fa1f2d37dc4571abc26c56f163b2e8a6b5130fd4920f4",
-        "position_config": "0x095d89be4c5dd3f461764e8a48d9a3f6a8bb62096dc5de84ef9f406770aea771"
-      },
-      "short_qqq": {
-        "supported_collaterals": ["nusdc"],
-        "funding_fee_model": "0xd934bfbc094c62cb200bb06eedf884c3a5c19497c92851788f7951a761c34b8f",
-        "position_config": "0x6069084d0479949512ccbb7bb7b0caccb7adf93e41dd8664bc5145ed7d1a62de"
-      },
-      "long_mu": {
-        "supported_collaterals": ["nusdc"],
-        "funding_fee_model": "0x6d9ca08af29c10928f6e57b6b083a47d45084f4000c39547e7c914d2a713c9e3",
-        "position_config": "0x41df6ebcfc8341b3f867d9cdf2b02e55d65862ad34030426c96f85ee54ba3449"
-      },
-      "short_mu": {
-        "supported_collaterals": ["nusdc"],
-        "funding_fee_model": "0x0071f4b04835ebea7780d8987eff310e942eca887b92f1017e4d8157d68fc308",
-        "position_config": "0x3706ead42207539e92fa8db05face103cf6c23ec9735f9a6b4525d4eb5881375"
-      },
-      "long_googl": {
-        "supported_collaterals": ["nusdc"],
-        "funding_fee_model": "0x8bc23ee0a7ee544703e3da151b980e89ffa957668a3f306a0d562a1dec35ea4d",
-        "position_config": "0x203f6e25a01c8725df531c76bf09bca630a55bce832920d9c8b748bbc815ca0d"
-      },
-      "short_googl": {
-        "supported_collaterals": ["nusdc"],
-        "funding_fee_model": "0x2a060d17867c08e0c5937c97d7a8ad7bca8642a9060f20f5f10cf88cd09301f2",
-        "position_config": "0xd7ce0bdcc8ede8ce1eeb137e8da3dd0b327ff54b346e765eed2bd8caf1db322c"
-      },
       "long_wti": {
         "supported_collaterals": ["nusdc"],
         "funding_fee_model": "0xe04cce47722ad061de705e1f9c6527976d07879a5c08a3e35101ce70453f55ec",
@@ -483,9 +433,7 @@
     }
   },
   "zo_staking": {
-    "pools": [
-      "0x283291d471764236db56b692f4f890c4d244a2891c478ee16c7e5076b6ad0fa7"
-    ],
+    "pools": ["0x283291d471764236db56b692f4f890c4d244a2891c478ee16c7e5076b6ad0fa7"],
     "upgrade_cap": "0x0b2ebbdedd751039cf033c1b24f61069b26cb2f99523789e150b5db59f13ccfd",
     "package": "0x87c13bb9157c3d51d61c7802704539d9d4782e838aadc41df0d6f0cc117298ba",
     "admin_cap": "0xe339faca7f7558bdf8256e7174d0543e5db99befcd0e5b9bef9c421cecabc195",

package/src/implementations/SLPAPI.ts

@@ -441,6 +441,52 @@ export class SLPAPI extends BaseAPI implements ISLPAPI {
     return tx
   }
 
+  /**
+   * Swaps tokens and returns the output coin to the user (PTB).
+   * Same as swap() but returns the output coin as TransactionObjectArgument for use in composed transactions.
+   * Pass optional tx to compose with other move calls; otherwise a new transaction is created.
+   */
+  public async swapV2Ptb(
+    fromToken: string,
+    toToken: string,
+    fromAmount: bigint,
+    fromCoinObjects: string[],
+    minAmountOut?: number,
+    tx?: Transaction,
+  ): Promise<TransactionObjectArgument> {
+    if (!tx) {
+      tx = new Transaction()
+    }
+    tx = await this.initOracleTxb(
+      Object.keys(this.consts.sudoCore.vaults),
+      tx,
+    )
+    const fromCoinObject = this.processCoins(tx, fromToken, fromCoinObjects)
+    const [fromDepositObject] = tx.splitCoins(fromCoinObject, [
+      tx.pure.u64(fromAmount),
+    ])
+    const vaultsValuation = this.dataAPI.valuateVaults(tx)
+
+    const [outputCoin] = tx.moveCall({
+      target: `${this.consts.sudoCore.upgradedPackage}::market::swap_v2_ptb`,
+      typeArguments: [
+        `${this.consts.sudoCore.package}::slp::SLP`,
+        this.consts.coins[fromToken].module,
+        this.consts.coins[toToken].module,
+      ],
+      arguments: [
+        tx.object(this.consts.sudoCore.market),
+        tx.object(this.consts.sudoCore.rebaseFeeModel),
+        fromDepositObject,
+        tx.pure.u64(minAmountOut || 0),
+        vaultsValuation,
+        tx.object(this.consts.pythFeeder.feeder[fromToken]),
+        tx.object(this.consts.pythFeeder.feeder[toToken]),
+      ],
+    })
+    return outputCoin
+  }
+
   /**
    * Stakes SLP tokens in ZO staking pools
    */

package/src/implementations/USDZAPI.ts

@@ -1473,6 +1473,47 @@ export class USDZAPI extends BaseAPI implements IUSDZAPI {
     return tx
   }
 
+  /**
+   * Swaps tokens and returns the output coin to the user (PTB).
+   * Same as swap() but returns the output coin as TransactionObjectArgument for use in composed transactions.
+   * Pass optional tx to compose into an existing transaction.
+   */
+  public async swapV2Ptb(
+    fromToken: string,
+    toToken: string,
+    fromAmount: bigint,
+    fromCoinObjects: string[],
+    minAmountOut?: number,
+    tx?: Transaction,
+  ): Promise<TransactionObjectArgument> {
+    if (!tx) {
+      tx = new Transaction()
+    }
+    tx = await this.initOracleTxb(Object.keys(this.consts.zoCore.vaults), tx)
+    const fromCoinObject = this.processCoins(tx, fromToken, fromCoinObjects)
+    const [fromDepositObject] = tx.splitCoins(fromCoinObject, [
+      tx.pure.u64(fromAmount),
+    ])
+    const vaultsValuation = this.dataAPI.valuateVaults(tx)
+
+    const [outputCoin] = tx.moveCall({
+      target: `${this.consts.zoCore.upgradedPackage}::market::swap_v2_ptb`,
+      typeArguments: [
+        `${this.consts.zoCore.package}::usdz::USDZ`,
+        this.consts.coins[fromToken].module,
+        this.consts.coins[toToken].module,
+      ],
+      arguments: [
+        tx.object(this.consts.zoCore.market),
+        tx.object(this.consts.zoCore.rebaseFeeModel),
+        fromDepositObject,
+        tx.pure.u64(minAmountOut || 0),
+        vaultsValuation,
+      ],
+    })
+    return outputCoin
+  }
+
   /**
    * Opens a new position in USDZ
    */

package/src/implementations/ZLPAPI.ts

@@ -624,6 +624,49 @@ export class ZLPAPI extends BaseAPI implements IZLPAPI {
     return tx
   }
 
+  /**
+   * Swaps tokens and returns the output coin to the user (PTB).
+   * Same as swap() but returns the output coin as TransactionObjectArgument for use in composed transactions.
+   * Pass optional tx to compose with other move calls; otherwise a new transaction is created.
+   */
+  public async swapV2Ptb(
+    fromToken: string,
+    toToken: string,
+    fromAmount: bigint,
+    fromCoinObjects: string[],
+    minAmountOut?: number,
+    tx?: Transaction,
+  ): Promise<TransactionObjectArgument> {
+    if (!tx) {
+      tx = new Transaction()
+    }
+    tx = await this.initOracleTxb(Object.keys(this.consts.zoCore.vaults), tx)
+    const fromCoinObject = this.processCoins(tx, fromToken, fromCoinObjects)
+    const [fromDepositObject] = tx.splitCoins(fromCoinObject, [
+      tx.pure.u64(fromAmount),
+    ])
+    const vaultsValuation = this.dataAPI.valuateVaults(tx)
+
+    const [outputCoin] = tx.moveCall({
+      target: `${this.consts.zoCore.upgradedPackage}::market::swap_v2_ptb`,
+      typeArguments: [
+        `${this.consts.zoCore.package}::zlp::ZLP`,
+        this.consts.coins[fromToken].module,
+        this.consts.coins[toToken].module,
+      ],
+      arguments: [
+        tx.object(this.consts.zoCore.market),
+        tx.object(this.consts.zoCore.rebaseFeeModel),
+        fromDepositObject,
+        tx.pure.u64(minAmountOut || 0),
+        vaultsValuation,
+        tx.object(this.consts.pythFeeder.feeder[fromToken]),
+        tx.object(this.consts.pythFeeder.feeder[toToken]),
+      ],
+    })
+    return outputCoin
+  }
+
   /**
    * Opens a new position in ZLP
    */

package/src/interfaces/slp.ts

@@ -274,4 +274,17 @@ export interface ISLPAPI extends IBaseAPI {
     pool: string,
     tx: Transaction,
   ) => TransactionObjectArgument[]
+
+  /**
+   * Swaps tokens and returns the output coin to the user (PTB).
+   * Same as swap() but returns the output coin for use in composed transactions.
+   */
+  swapV2Ptb: (
+    fromToken: string,
+    toToken: string,
+    fromAmount: bigint,
+    fromCoinObjects: string[],
+    minAmountOut?: number,
+    tx?: Transaction,
+  ) => Promise<TransactionObjectArgument>
 }

package/src/interfaces/usdz.ts

@@ -187,4 +187,17 @@ export interface IUSDZAPI extends IBaseAPI {
     pool: string,
     tx: Transaction,
   ) => TransactionObjectArgument[]
+
+  /**
+   * Swaps tokens and returns the output coin to the user (PTB).
+   * Same as swap() but returns the output coin for use in composed transactions.
+   */
+  swapV2Ptb: (
+    fromToken: string,
+    toToken: string,
+    fromAmount: bigint,
+    fromCoinObjects: string[],
+    minAmountOut?: number,
+    tx?: Transaction,
+  ) => Promise<TransactionObjectArgument>
 }

package/src/interfaces/zlp.ts

@@ -250,4 +250,17 @@ export interface IZLPAPI extends IBaseAPI {
     pool: string,
     tx: Transaction,
   ) => TransactionObjectArgument[]
+
+  /**
+   * Swaps tokens and returns the output coin to the user (PTB).
+   * Same as swap() but returns the output coin for use in composed transactions.
+   */
+  swapV2Ptb: (
+    fromToken: string,
+    toToken: string,
+    fromAmount: bigint,
+    fromCoinObjects: string[],
+    minAmountOut?: number,
+    tx?: Transaction,
+  ) => Promise<TransactionObjectArgument>
 }