@scallop-io/scallop-deepbook-kit 0.2.1 → 0.4.0

package/dist/index.cjs

@@ -1 +1 @@
-'use strict';var client=require('@mysten/sui/client'),ed25519=require('@mysten/sui/keypairs/ed25519'),transactions=require('@mysten/sui/transactions'),deepbookV3=require('@mysten/deepbook-v3'),cryptography=require('@mysten/sui/cryptography'),bcs$1=require('@mysten/bcs'),bcs=require('@mysten/sui/bcs'),bignumber_js=require('bignumber.js');var T=n=>/^0x[0-9a-fA-F]+$|^[0-9a-fA-F]+$/.test(n),B=n=>/^[a-zA-Z0-9+/]+={0,2}$/g.test(n),A=n=>{if(T(n))return bcs$1.fromHex(n);if(B(n))return bcs$1.fromBase64(n);throw new Error("The string is not a valid hex or base64 string.")},P=n=>{if(n.length===cryptography.LEGACY_PRIVATE_KEY_SIZE)return n.slice(0,cryptography.PRIVATE_KEY_SIZE);if(n.length===cryptography.PRIVATE_KEY_SIZE+1&&n[0]===0)return n.slice(1);if(n.length===cryptography.PRIVATE_KEY_SIZE)return n;throw new Error("invalid secret key")};var C=class{suiClient;keypair;address;marginPoolContract;supplierCapId;dbConfig;supplierCapPackageId;constructor({network:r,fullnodeUrl:i,supplierCapId:t,privateKey:e,supplierCapPackageId:o,dbConfig:a}){let s=i??client.getFullnodeUrl(r);this.suiClient=new client.SuiClient({url:s}),this.keypair=this.#r(e),this.address=this.keypair.getPublicKey().toSuiAddress(),this.supplierCapId=t,this.dbConfig=a??new deepbookV3.DeepBookConfig({network:r,address:this.address}),this.marginPoolContract=new deepbookV3.MarginPoolContract(this.dbConfig),this.supplierCapPackageId=o??this.dbConfig.MARGIN_PACKAGE_ID;}#r(r){if(r.startsWith(cryptography.SUI_PRIVATE_KEY_PREFIX)){let{secretKey:i}=cryptography.decodeSuiPrivateKey(r);return ed25519.Ed25519Keypair.fromSecretKey(P(i))}return ed25519.Ed25519Keypair.fromSecretKey(P(A(r)))}async#t(){let r=`${this.dbConfig.MARGIN_PACKAGE_ID}::margin_pool::SupplierCap`;return (await this.suiClient.getOwnedObjects({owner:this.address,filter:{StructType:r},options:{showType:true}})).data?.[0]?.data?.objectId}async initialize(){if(this.supplierCapId)return this.supplierCapId;let r=await this.#t();if(r)return this.supplierCapId=r,r;let i=await this.createSupplierCap();if(!i)throw new Error("Failed to create Supplier Cap");return this.supplierCapId=i,i}async createSupplierCap(){try{let r=new transactions.Transaction;r.setSender(this.address);let i=r.moveCall({target:`${this.supplierCapPackageId}::margin_pool::mint_supplier_cap`,arguments:[r.object(this.dbConfig.MARGIN_REGISTRY_ID),r.object.clock()]});r.transferObjects([i],r.pure.address(this.address));let t=await this.suiClient.signAndExecuteTransaction({signer:this.keypair,transaction:r,options:{showEffects:!0,showObjectChanges:!0}});if(t.errors&&t.errors.length>0)throw new Error(`Transaction failed with errors: ${t.errors.map(e=>e.toString()).join(", ")}`);if(t.objectChanges){for(let e of t.objectChanges)if(e.type==="created"&&e.objectType.includes("SupplierCap"))return e.objectId}return null}catch(r){throw new Error(`Failed to create Supplier Cap: ${r.message||r}`)}}async createSupplyReferral(r){try{let i=new transactions.Transaction;i.setSender(this.address);let t=this.dbConfig.getMarginPool(r);if(!t)throw new Error(`Margin pool configuration not found for coin: ${r}`);i.moveCall({target:`${this.dbConfig.MARGIN_PACKAGE_ID}::margin_pool::mint_supply_referral`,arguments:[i.object(t.address),i.object(this.dbConfig.MARGIN_REGISTRY_ID),i.object.clock()],typeArguments:[t.type]});let e=await this.suiClient.signAndExecuteTransaction({signer:this.keypair,transaction:i,options:{showEffects:!0,showObjectChanges:!0}});if(e.errors&&e.errors.length>0)throw new Error(`Transaction failed with errors: ${e.errors.map(o=>o.toString()).join(", ")}`);if(e.objectChanges){for(let o of e.objectChanges)if(o.type==="created"&&o.objectType.includes("SupplyReferral"))return o.objectId}return null}catch(i){throw new Error(`Failed to create Supply Referral: ${i.message||i}`)}}async supplyToMarginPool(r,i,t){try{if(!this.supplierCapId)throw new Error("Supplier Cap not initialized. Call initialize() first.");let e=new transactions.Transaction;e.setSender(this.address);let o=e.object(this.supplierCapId);e.add(this.marginPoolContract.supplyToMarginPool(r,o,i,t));let{errors:a}=await this.suiClient.signAndExecuteTransaction({signer:this.keypair,transaction:e,options:{showEffects:!0,showObjectChanges:!0}});if(a&&a.length>0)throw new Error(`Transaction failed with errors: ${a.map(s=>s.toString()).join(", ")}`);return !0}catch(e){throw new Error(`Failed to supply to margin pool: ${e.message||e}`)}}async withdrawFromMarginPool(r,i){try{if(!this.supplierCapId)throw new Error("Supplier Cap not initialized. Call initialize() first.");let t=new transactions.Transaction,e=t.object(this.supplierCapId),a=this.marginPoolContract.withdrawFromMarginPool(r,e,i)(t);t.transferObjects([a],this.address);let{errors:s}=await this.suiClient.signAndExecuteTransaction({signer:this.keypair,transaction:t,options:{showEffects:!0,showObjectChanges:!0}});if(s&&s.length>0)throw new Error(`Transaction failed with errors: ${s.map(p=>p.toString()).join(", ")}`);return !0}catch(t){throw new Error(`Failed to withdraw from margin pool: ${t.message||t}`)}}async withdrawReferralFees(r,i){try{let t=new transactions.Transaction;t.add(this.marginPoolContract.withdrawReferralFees(r,i));let{errors:e}=await this.suiClient.signAndExecuteTransaction({signer:this.keypair,transaction:t,options:{showEffects:!0,showObjectChanges:!0,showBalanceChanges:!0}});if(e&&e.length>0)throw new Error(`Transaction failed with errors: ${e.map(o=>o.toString()).join(", ")}`);return !0}catch(t){throw new Error(`Failed to withdraw referral fees: ${t.message||t}`)}}async getBalance(r){try{if(!this.supplierCapId)throw new Error("Supplier Cap not initialized. Call initialize() first.");let i=new transactions.Transaction;i.add(this.marginPoolContract.userSupplyAmount(r,this.supplierCapId));let t=await this.suiClient.devInspectTransactionBlock({sender:this.address,transactionBlock:i}),e=0;if(t&&t.results&&t.results[0]&&t.results[0].returnValues){let l=t.results[0].returnValues[0];if(l&&l[0]){let c=Buffer.from(l[0]).readBigUInt64LE(),m=this.dbConfig.getCoin(r).scalar;e=Number(c)/m;}}let o=this.dbConfig.getCoin(r).type,a=await this.suiClient.getBalance({owner:this.address,coinType:o}),s=this.dbConfig.getCoin(r).scalar,p=Number(a.totalBalance)/s;return {userSupplyAmount:e,walletBalance:p}}catch(i){throw new Error(`Failed to get balance: ${i.message||i}`)}}getSupplierCapId(){return this.supplierCapId}getAddress(){return this.address}};var w=["supplyCap","maxUtilizationRate","protocolSpread","minBorrow","interestRate","totalSupply","supplyShares","totalBorrow","borrowShares","lastUpdateTimestamp"],h=["userSupplyShares","userSupplyAmount"],_={supplyCap:"U64",maxUtilizationRate:"U64",protocolSpread:"U64",minBorrow:"U64",interestRate:"U64",totalSupply:"U64",supplyShares:"U64",totalBorrow:"U64",borrowShares:"U64",lastUpdateTimestamp:"U64",userSupplyShares:"U64",userSupplyAmount:"U64"};var d=(n,r)=>n*r/BigInt(deepbookV3.FLOAT_SCALAR),u=n=>Number(n)/deepbookV3.FLOAT_SCALAR;var W=new Set(h),D=n=>W.has(n),b=class{marginPoolContract;dbConfig;suiClient;constructor({network:r,address:i="",suiClient:t,dbConfig:e}={}){let o=r??e?.network??"mainnet";if(this.dbConfig=e??new deepbookV3.DeepBookConfig({network:o,address:i}),this.suiClient=t??new client.SuiClient({url:client.getFullnodeUrl(o)}),this.marginPoolContract=new deepbookV3.MarginPoolContract(this.dbConfig),r!==void 0&&e!==void 0&&r!==e.network)throw new Error(`Mismatch between provided network (${r}) and dbConfig network (${e.network}).`)}get network(){return this.dbConfig.network}#r(r,i,t,e){if(D(i)){let o=this.marginPoolContract[i];if(e==null)throw new Error(`supplierCap is required for '${i}'.`);r.add(o(t,e));}else {let o=this.marginPoolContract[i];r.add(o(t));}}parseInspectResultToBcsStructs(r,i){let t=r.results;if(!t)throw new Error("No results found in DevInspect output.");return i.reduce((e,o,a)=>{let s=t[a]?.returnValues?.[0]?.[0];if(!s)return e;let p=bcs.bcs[_[o]];return e[o]=p.parse(new Uint8Array(s)),e},{})}formatResult(r,i){let t=this.dbConfig.getCoin(i),e={supplyCap:0,maxUtilizationRate:0,protocolSpread:0,minBorrow:0,interestRate:0,totalSupply:0,supplyShares:0,totalBorrow:0,borrowShares:0,lastUpdateTimestamp:0,userSupplyShares:0,userSupplyAmount:0,decimals:t.scalar.toString().length-1,highKink:0,baseBorrowApr:0,borrowAprOnHighKink:0,maxBorrowApr:0,supplyApr:0,utilizationRate:0,...t};if(!t)return e;let o=new Set(["interestRate","maxUtilizationRate","protocolSpread"]);for(let[a,s]of Object.entries(r))a==="lastUpdateTimestamp"?e[a]=Number(s):o.has(a)?e[a]=new bignumber_js.BigNumber(s).dividedBy(deepbookV3.FLOAT_SCALAR).toNumber():e[a]=new bignumber_js.BigNumber(s).dividedBy(t.scalar).toNumber();return e}computeBorrowAprAtUtil(r,i){let t=BigInt(i.base_rate),e=BigInt(i.base_slope),o=BigInt(i.excess_slope),a=BigInt(i.optimal_utilization);return r<a?t+d(r,e):t+d(a,e)+d(r-a,o)}calculateKinksAndRate(r,i,t,e){let o=BigInt(r.optimal_utilization),a=BigInt(i.max_utilization_rate),s=this.computeBorrowAprAtUtil(o,r),p=this.computeBorrowAprAtUtil(a,r),l=BigInt(bignumber_js.BigNumber(t.total_borrow).dividedBy(t.total_supply).shiftedBy(9).decimalPlaces(0).toString()),c=d(d(e,l),BigInt(deepbookV3.FLOAT_SCALAR)-BigInt(i.protocol_spread));return {raw:{baseBorrowApr:r.base_rate,highKink:o,borrowAprOnHighKink:s,maxBorrowApr:p,supplyApr:c,utilizationRate:l},normalized:{baseBorrowApr:u(BigInt(r.base_rate)),highKink:u(o),borrowAprOnHighKink:u(s),maxBorrowApr:u(p),supplyApr:u(c),utilizationRate:u(l)}}}async#t(r,i){let{address:t}=this.dbConfig.getMarginPool(r),o=((await this.suiClient.getObject({id:t,options:{showContent:true}})).data?.content).fields,a=o.config.fields,s=a.interest_config.fields,p=a.margin_pool_config.fields,l=o.state.fields,{normalized:c}=this.calculateKinksAndRate(s,p,l,i);return c}async getPoolParameters(r,i,t=new transactions.Transaction,e=true){if(w.forEach(m=>this.#r(t,m,r)),i&&h.forEach(m=>this.#r(t,m,r,i)),!e)return t;let o=[...w,...h],a=await this.suiClient.devInspectTransactionBlock({transactionBlock:t,sender:this.dbConfig.address}),s=this.parseInspectResultToBcsStructs(a,o),p=this.formatResult(s,r),l=BigInt(s.interestRate??0),c=await this.#t(r,l);return {...p,...c}}};exports.DeepBookMarginPool=b;exports.DeepBookMarginToolkit=C;
+'use strict';var client=require('@mysten/sui/client'),ed25519=require('@mysten/sui/keypairs/ed25519'),transactions=require('@mysten/sui/transactions'),deepbookV3=require('@mysten/deepbook-v3'),cryptography=require('@mysten/sui/cryptography'),bcs$1=require('@mysten/bcs'),bcs=require('@mysten/sui/bcs'),bignumber_js=require('bignumber.js'),utils=require('@mysten/sui/utils');var H=s=>/^0x[0-9a-fA-F]+$|^[0-9a-fA-F]+$/.test(s),V=s=>/^[a-zA-Z0-9+/]+={0,2}$/g.test(s),B=s=>{if(H(s))return bcs$1.fromHex(s);if(V(s))return bcs$1.fromBase64(s);throw new Error("The string is not a valid hex or base64 string.")},S=s=>{if(s.length===cryptography.LEGACY_PRIVATE_KEY_SIZE)return s.slice(0,cryptography.PRIVATE_KEY_SIZE);if(s.length===cryptography.PRIVATE_KEY_SIZE+1&&s[0]===0)return s.slice(1);if(s.length===cryptography.PRIVATE_KEY_SIZE)return s;throw new Error("invalid secret key")};var A=class{suiClient;keypair;address;marginPoolContract;supplierCapId;dbConfig;supplierCapPackageId;constructor({network:r,fullnodeUrl:e,supplierCapId:t,privateKey:o,supplierCapPackageId:i,dbConfig:n}){let a=e??client.getFullnodeUrl(r);this.suiClient=new client.SuiClient({url:a}),this.keypair=this.#r(o),this.address=this.keypair.getPublicKey().toSuiAddress(),this.supplierCapId=t,this.dbConfig=n??new deepbookV3.DeepBookConfig({network:r,address:this.address}),this.marginPoolContract=new deepbookV3.MarginPoolContract(this.dbConfig),this.supplierCapPackageId=i??this.dbConfig.MARGIN_PACKAGE_ID;}#r(r){if(r.startsWith(cryptography.SUI_PRIVATE_KEY_PREFIX)){let{secretKey:e}=cryptography.decodeSuiPrivateKey(r);return ed25519.Ed25519Keypair.fromSecretKey(S(e))}return ed25519.Ed25519Keypair.fromSecretKey(S(B(r)))}async#t(){let r=`${this.dbConfig.MARGIN_PACKAGE_ID}::margin_pool::SupplierCap`;return (await this.suiClient.getOwnedObjects({owner:this.address,filter:{StructType:r},options:{showType:true}})).data?.[0]?.data?.objectId}async initialize(){if(this.supplierCapId)return this.supplierCapId;let r=await this.#t();if(r)return this.supplierCapId=r,r;let e=await this.createSupplierCap();if(!e)throw new Error("Failed to create Supplier Cap");return this.supplierCapId=e,e}async createSupplierCap(){try{let r=new transactions.Transaction;r.setSender(this.address);let e=r.moveCall({target:`${this.supplierCapPackageId}::margin_pool::mint_supplier_cap`,arguments:[r.object(this.dbConfig.MARGIN_REGISTRY_ID),r.object.clock()]});r.transferObjects([e],r.pure.address(this.address));let t=await this.suiClient.signAndExecuteTransaction({signer:this.keypair,transaction:r,options:{showEffects:!0,showObjectChanges:!0}});if(t.errors&&t.errors.length>0)throw new Error(`Transaction failed with errors: ${t.errors.map(o=>o.toString()).join(", ")}`);if(t.objectChanges){for(let o of t.objectChanges)if(o.type==="created"&&o.objectType.includes("SupplierCap"))return o.objectId}return null}catch(r){throw new Error(`Failed to create Supplier Cap: ${r.message||r}`)}}async createSupplyReferral(r){try{let e=new transactions.Transaction;e.setSender(this.address);let t=this.dbConfig.getMarginPool(r);if(!t)throw new Error(`Margin pool configuration not found for coin: ${r}`);e.moveCall({target:`${this.dbConfig.MARGIN_PACKAGE_ID}::margin_pool::mint_supply_referral`,arguments:[e.object(t.address),e.object(this.dbConfig.MARGIN_REGISTRY_ID),e.object.clock()],typeArguments:[t.type]});let o=await this.suiClient.signAndExecuteTransaction({signer:this.keypair,transaction:e,options:{showEffects:!0,showObjectChanges:!0}});if(o.errors&&o.errors.length>0)throw new Error(`Transaction failed with errors: ${o.errors.map(i=>i.toString()).join(", ")}`);if(o.objectChanges){for(let i of o.objectChanges)if(i.type==="created"&&i.objectType.includes("SupplyReferral"))return i.objectId}return null}catch(e){throw new Error(`Failed to create Supply Referral: ${e.message||e}`)}}async supplyToMarginPool(r,e,t){try{if(!this.supplierCapId)throw new Error("Supplier Cap not initialized. Call initialize() first.");let o=new transactions.Transaction;o.setSender(this.address);let i=o.object(this.supplierCapId);o.add(this.marginPoolContract.supplyToMarginPool(r,i,e,t));let{errors:n}=await this.suiClient.signAndExecuteTransaction({signer:this.keypair,transaction:o,options:{showEffects:!0,showObjectChanges:!0}});if(n&&n.length>0)throw new Error(`Transaction failed with errors: ${n.map(a=>a.toString()).join(", ")}`);return !0}catch(o){throw new Error(`Failed to supply to margin pool: ${o.message||o}`)}}async withdrawFromMarginPool(r,e){try{if(!this.supplierCapId)throw new Error("Supplier Cap not initialized. Call initialize() first.");let t=new transactions.Transaction,o=t.object(this.supplierCapId),n=this.marginPoolContract.withdrawFromMarginPool(r,o,e)(t);t.transferObjects([n],this.address);let{errors:a}=await this.suiClient.signAndExecuteTransaction({signer:this.keypair,transaction:t,options:{showEffects:!0,showObjectChanges:!0}});if(a&&a.length>0)throw new Error(`Transaction failed with errors: ${a.map(l=>l.toString()).join(", ")}`);return !0}catch(t){throw new Error(`Failed to withdraw from margin pool: ${t.message||t}`)}}async withdrawReferralFees(r,e){try{let t=new transactions.Transaction;t.add(this.marginPoolContract.withdrawReferralFees(r,e));let{errors:o}=await this.suiClient.signAndExecuteTransaction({signer:this.keypair,transaction:t,options:{showEffects:!0,showObjectChanges:!0,showBalanceChanges:!0}});if(o&&o.length>0)throw new Error(`Transaction failed with errors: ${o.map(i=>i.toString()).join(", ")}`);return !0}catch(t){throw new Error(`Failed to withdraw referral fees: ${t.message||t}`)}}async getBalance(r){try{if(!this.supplierCapId)throw new Error("Supplier Cap not initialized. Call initialize() first.");let e=new transactions.Transaction;e.add(this.marginPoolContract.userSupplyAmount(r,this.supplierCapId));let t=await this.suiClient.devInspectTransactionBlock({sender:this.address,transactionBlock:e}),o=0;if(t&&t.results&&t.results[0]&&t.results[0].returnValues){let p=t.results[0].returnValues[0];if(p&&p[0]){let u=Buffer.from(p[0]).readBigUInt64LE(),g=this.dbConfig.getCoin(r).scalar;o=Number(u)/g;}}let i=this.dbConfig.getCoin(r).type,n=await this.suiClient.getBalance({owner:this.address,coinType:i}),a=this.dbConfig.getCoin(r).scalar,l=Number(n.totalBalance)/a;return {userSupplyAmount:o,walletBalance:l}}catch(e){throw new Error(`Failed to get balance: ${e.message||e}`)}}getSupplierCapId(){return this.supplierCapId}getAddress(){return this.address}};var C=["supplyCap","maxUtilizationRate","protocolSpread","minBorrow","interestRate","totalSupply","supplyShares","totalBorrow","borrowShares","lastUpdateTimestamp"],f=["userSupplyShares","userSupplyAmount"],_={supplyCap:"U64",maxUtilizationRate:"U64",protocolSpread:"U64",minBorrow:"U64",interestRate:"U64",totalSupply:"U64",supplyShares:"U64",totalBorrow:"U64",borrowShares:"U64",lastUpdateTimestamp:"U64",userSupplyShares:"U64",userSupplyAmount:"U64"};var P=(s,r)=>s*r/BigInt(deepbookV3.FLOAT_SCALAR),d=s=>Number(s)/deepbookV3.FLOAT_SCALAR;var nr=new Set(f),ar=s=>nr.has(s),R=class{marginPoolContract;dbConfig;suiClient;constructor({network:r,address:e="",suiClient:t,dbConfig:o}={}){let i=r??o?.network??"mainnet";if(this.dbConfig=o??new deepbookV3.DeepBookConfig({network:i,address:e}),this.suiClient=t??new client.SuiClient({url:client.getFullnodeUrl(i)}),this.marginPoolContract=new deepbookV3.MarginPoolContract(this.dbConfig),r!==void 0&&o!==void 0&&r!==o.network)throw new Error(`Mismatch between provided network (${r}) and dbConfig network (${o.network}).`)}get network(){return this.dbConfig.network}#r(r,e,t,o){if(ar(e)){let i=this.marginPoolContract[e];if(o==null)throw new Error(`supplierCap is required for '${e}'.`);r.add(i(t,o));}else {let i=this.marginPoolContract[e];r.add(i(t));}}parseInspectResultToBcsStructs(r,e){let t=r.results;if(!t)throw new Error("No results found in DevInspect output.");return e.reduce((o,i,n)=>{let a=t[n]?.returnValues?.[0]?.[0];if(!a)return o;let l=bcs.bcs[_[i]];return o[i]=l.parse(new Uint8Array(a)),o},{})}formatResult(r,e){let t=this.dbConfig.getCoin(e),o={supplyCap:0,maxUtilizationRate:0,protocolSpread:0,minBorrow:0,interestRate:0,totalSupply:0,supplyShares:0,totalBorrow:0,borrowShares:0,lastUpdateTimestamp:0,userSupplyShares:0,userSupplyAmount:0,decimals:t.scalar.toString().length-1,highKink:0,baseBorrowApr:0,borrowAprOnHighKink:0,maxBorrowApr:0,supplyApr:0,utilizationRate:0,...t};if(!t)return o;let i=new Set(["interestRate","maxUtilizationRate","protocolSpread"]);for(let[n,a]of Object.entries(r))n==="lastUpdateTimestamp"?o[n]=Number(a):i.has(n)?o[n]=new bignumber_js.BigNumber(a).dividedBy(deepbookV3.FLOAT_SCALAR).toNumber():o[n]=new bignumber_js.BigNumber(a).dividedBy(t.scalar).toNumber();return o}computeBorrowAprAtUtil(r,e){let t=BigInt(e.base_rate),o=BigInt(e.base_slope),i=BigInt(e.excess_slope),n=BigInt(e.optimal_utilization);return r<n?t+P(r,o):t+P(n,o)+P(r-n,i)}calculateKinksAndRate(r,e,t,o){let i=BigInt(r.optimal_utilization),n=BigInt(e.max_utilization_rate),a=this.computeBorrowAprAtUtil(i,r),l=this.computeBorrowAprAtUtil(n,r),p=BigInt(bignumber_js.BigNumber(t.total_borrow).dividedBy(t.total_supply).shiftedBy(9).decimalPlaces(0).toString()),u=P(P(o,p),BigInt(deepbookV3.FLOAT_SCALAR)-BigInt(e.protocol_spread));return {raw:{baseBorrowApr:r.base_rate,highKink:i,borrowAprOnHighKink:a,maxBorrowApr:l,supplyApr:u,utilizationRate:p},normalized:{baseBorrowApr:d(BigInt(r.base_rate)),highKink:d(i),borrowAprOnHighKink:d(a),maxBorrowApr:d(l),supplyApr:d(u),utilizationRate:d(p)}}}async#t(r,e,t){let{address:o}=this.dbConfig.getMarginPool(r);t??=await this.suiClient.getObject({id:o,options:{showContent:true}});let i=(t.data?.content).fields,n=i.config.fields,a=n.interest_config.fields,l=n.margin_pool_config.fields,p=i.state.fields,{normalized:u}=this.calculateKinksAndRate(a,l,p,e);return u}async getPoolParameters(r,e,t=new transactions.Transaction,o=true){if(C.forEach(g=>this.#r(t,g,r)),e&&f.forEach(g=>this.#r(t,g,r,e)),!o)return t;let i=[...C,...f],n=await this.suiClient.devInspectTransactionBlock({transactionBlock:t,sender:this.dbConfig.address}),a=this.parseInspectResultToBcsStructs(n,i),l=this.formatResult(a,r),p=BigInt(a.interestRate??0),u=await this.#t(r,p);return {...l,...u}}async getPoolsParameters(r,e,t=new transactions.Transaction,o=true){for(let c of r)C.forEach(m=>this.#r(t,m,c)),e&&f.forEach(m=>this.#r(t,m,c,e));if(!o)return t;let i=[...C,...e?f:[]],n=i.length,a=r.map(c=>this.dbConfig.getMarginPool(c).address),l=50,p=[];for(let c=0;c<a.length;c+=l)p.push(a.slice(c,c+l));let[u,...g]=await Promise.all([this.suiClient.devInspectTransactionBlock({transactionBlock:t,sender:this.dbConfig.address}),...p.map(c=>this.suiClient.multiGetObjects({ids:c,options:{showContent:true}}))]),v=g.flat(),I=u.results;if(!I)throw new Error("No results found in DevInspect output.");return Promise.all(r.map(async(c,m)=>{let N=m*n,T=i.reduce((y,E,L)=>{let K=I[N+L]?.returnValues?.[0]?.[0];if(!K)return y;let $=bcs.bcs[_[E]];return y[E]=$.parse(new Uint8Array(K)),y},{}),z=this.formatResult(T,c),G=BigInt(T.interestRate??0),w=v[m];if(!w||w.error)throw new Error(`Failed to fetch interest config for ${c}`);let F=await this.#t(c,G,w);return {...z,...F}}))}};var cr="0x7f7351ef7e5089dfddf17f55abe028d719c45ca91d2c23e45a441ba65897f804",ur=async(s=new client.SuiClient({url:client.getFullnodeUrl("mainnet")}))=>{let r=[],e=[],t=null,o=true;for(;o;){let{data:n,nextCursor:a,hasNextPage:l}=await s.getDynamicFields({parentId:cr,cursor:t,limit:50});if(e.push(...n.map(p=>p.objectId)),n.length===0)break;t=a,o=l;}let i=await s.multiGetObjects({ids:e,options:{showContent:true}});for(let n of i){let a=n.data?.content;if(!a||a.dataType!=="moveObject")continue;let l=a.fields;r.push({address:l.value,type:`0x${l.name?.fields?.name}`});}return r.reduce((n,a)=>{let{name:l}=utils.parseStructTag(a.type);return n[l.replace(/_/g,"")]=a,n},{})};exports.DeepBookMarginPool=R;exports.DeepBookMarginToolkit=A;exports.getOnChainMarginPools=ur;

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { DeepBookConfig, MarginPoolContract, Coin } from '@mysten/deepbook-v3';
+import { DeepBookConfig, MarginPoolContract, Coin, MarginPool } from '@mysten/deepbook-v3';
 import { SuiClient } from '@mysten/sui/client';
 import { Transaction } from '@mysten/sui/transactions';
 
@@ -84,6 +84,11 @@ declare class DeepBookMarginPool {
     getPoolParameters(coinKey: string, supplierCapId?: string, tx?: Transaction): Promise<MarginPoolParams>;
     getPoolParameters(coinKey: string, supplierCapId: string | undefined, tx: Transaction, inspect: true): Promise<MarginPoolParams>;
     getPoolParameters(coinKey: string, supplierCapId: string | undefined, tx: Transaction, inspect: false): Promise<Transaction>;
+    getPoolsParameters(coinKeys: string[], supplierCapId?: string, tx?: Transaction): Promise<MarginPoolParams[]>;
+    getPoolsParameters(coinKeys: string[], supplierCapId: string | undefined, tx: Transaction, inspect: true): Promise<MarginPoolParams[]>;
+    getPoolsParameters(coinKeys: string[], supplierCapId: string | undefined, tx: Transaction, inspect: false): Promise<Transaction>;
 }
 
-export { DeepBookMarginPool, DeepBookMarginToolkit, type MarginBalance, type MarginCoinType, type MarginPoolParams, type NetworkType, type ReferralInfo, type ToolkitConfig, type TransactionResult };
+declare const getOnChainMarginPools: (suiClient?: SuiClient) => Promise<Record<string, MarginPool>>;
+
+export { DeepBookMarginPool, DeepBookMarginToolkit, type MarginBalance, type MarginCoinType, type MarginPoolParams, type NetworkType, type ReferralInfo, type ToolkitConfig, type TransactionResult, getOnChainMarginPools };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { DeepBookConfig, MarginPoolContract, Coin } from '@mysten/deepbook-v3';
+import { DeepBookConfig, MarginPoolContract, Coin, MarginPool } from '@mysten/deepbook-v3';
 import { SuiClient } from '@mysten/sui/client';
 import { Transaction } from '@mysten/sui/transactions';
 
@@ -84,6 +84,11 @@ declare class DeepBookMarginPool {
     getPoolParameters(coinKey: string, supplierCapId?: string, tx?: Transaction): Promise<MarginPoolParams>;
     getPoolParameters(coinKey: string, supplierCapId: string | undefined, tx: Transaction, inspect: true): Promise<MarginPoolParams>;
     getPoolParameters(coinKey: string, supplierCapId: string | undefined, tx: Transaction, inspect: false): Promise<Transaction>;
+    getPoolsParameters(coinKeys: string[], supplierCapId?: string, tx?: Transaction): Promise<MarginPoolParams[]>;
+    getPoolsParameters(coinKeys: string[], supplierCapId: string | undefined, tx: Transaction, inspect: true): Promise<MarginPoolParams[]>;
+    getPoolsParameters(coinKeys: string[], supplierCapId: string | undefined, tx: Transaction, inspect: false): Promise<Transaction>;
 }
 
-export { DeepBookMarginPool, DeepBookMarginToolkit, type MarginBalance, type MarginCoinType, type MarginPoolParams, type NetworkType, type ReferralInfo, type ToolkitConfig, type TransactionResult };
+declare const getOnChainMarginPools: (suiClient?: SuiClient) => Promise<Record<string, MarginPool>>;
+
+export { DeepBookMarginPool, DeepBookMarginToolkit, type MarginBalance, type MarginCoinType, type MarginPoolParams, type NetworkType, type ReferralInfo, type ToolkitConfig, type TransactionResult, getOnChainMarginPools };

package/dist/index.js

@@ -1 +1 @@
-import {getFullnodeUrl,SuiClient}from'@mysten/sui/client';import {Ed25519Keypair}from'@mysten/sui/keypairs/ed25519';import {Transaction}from'@mysten/sui/transactions';import {DeepBookConfig,MarginPoolContract,FLOAT_SCALAR}from'@mysten/deepbook-v3';import {SUI_PRIVATE_KEY_PREFIX,decodeSuiPrivateKey,LEGACY_PRIVATE_KEY_SIZE,PRIVATE_KEY_SIZE}from'@mysten/sui/cryptography';import {fromHex,fromBase64}from'@mysten/bcs';import {bcs}from'@mysten/sui/bcs';import {BigNumber}from'bignumber.js';var T=n=>/^0x[0-9a-fA-F]+$|^[0-9a-fA-F]+$/.test(n),B=n=>/^[a-zA-Z0-9+/]+={0,2}$/g.test(n),A=n=>{if(T(n))return fromHex(n);if(B(n))return fromBase64(n);throw new Error("The string is not a valid hex or base64 string.")},P=n=>{if(n.length===LEGACY_PRIVATE_KEY_SIZE)return n.slice(0,PRIVATE_KEY_SIZE);if(n.length===PRIVATE_KEY_SIZE+1&&n[0]===0)return n.slice(1);if(n.length===PRIVATE_KEY_SIZE)return n;throw new Error("invalid secret key")};var C=class{suiClient;keypair;address;marginPoolContract;supplierCapId;dbConfig;supplierCapPackageId;constructor({network:r,fullnodeUrl:i,supplierCapId:t,privateKey:e,supplierCapPackageId:o,dbConfig:a}){let s=i??getFullnodeUrl(r);this.suiClient=new SuiClient({url:s}),this.keypair=this.#r(e),this.address=this.keypair.getPublicKey().toSuiAddress(),this.supplierCapId=t,this.dbConfig=a??new DeepBookConfig({network:r,address:this.address}),this.marginPoolContract=new MarginPoolContract(this.dbConfig),this.supplierCapPackageId=o??this.dbConfig.MARGIN_PACKAGE_ID;}#r(r){if(r.startsWith(SUI_PRIVATE_KEY_PREFIX)){let{secretKey:i}=decodeSuiPrivateKey(r);return Ed25519Keypair.fromSecretKey(P(i))}return Ed25519Keypair.fromSecretKey(P(A(r)))}async#t(){let r=`${this.dbConfig.MARGIN_PACKAGE_ID}::margin_pool::SupplierCap`;return (await this.suiClient.getOwnedObjects({owner:this.address,filter:{StructType:r},options:{showType:true}})).data?.[0]?.data?.objectId}async initialize(){if(this.supplierCapId)return this.supplierCapId;let r=await this.#t();if(r)return this.supplierCapId=r,r;let i=await this.createSupplierCap();if(!i)throw new Error("Failed to create Supplier Cap");return this.supplierCapId=i,i}async createSupplierCap(){try{let r=new Transaction;r.setSender(this.address);let i=r.moveCall({target:`${this.supplierCapPackageId}::margin_pool::mint_supplier_cap`,arguments:[r.object(this.dbConfig.MARGIN_REGISTRY_ID),r.object.clock()]});r.transferObjects([i],r.pure.address(this.address));let t=await this.suiClient.signAndExecuteTransaction({signer:this.keypair,transaction:r,options:{showEffects:!0,showObjectChanges:!0}});if(t.errors&&t.errors.length>0)throw new Error(`Transaction failed with errors: ${t.errors.map(e=>e.toString()).join(", ")}`);if(t.objectChanges){for(let e of t.objectChanges)if(e.type==="created"&&e.objectType.includes("SupplierCap"))return e.objectId}return null}catch(r){throw new Error(`Failed to create Supplier Cap: ${r.message||r}`)}}async createSupplyReferral(r){try{let i=new Transaction;i.setSender(this.address);let t=this.dbConfig.getMarginPool(r);if(!t)throw new Error(`Margin pool configuration not found for coin: ${r}`);i.moveCall({target:`${this.dbConfig.MARGIN_PACKAGE_ID}::margin_pool::mint_supply_referral`,arguments:[i.object(t.address),i.object(this.dbConfig.MARGIN_REGISTRY_ID),i.object.clock()],typeArguments:[t.type]});let e=await this.suiClient.signAndExecuteTransaction({signer:this.keypair,transaction:i,options:{showEffects:!0,showObjectChanges:!0}});if(e.errors&&e.errors.length>0)throw new Error(`Transaction failed with errors: ${e.errors.map(o=>o.toString()).join(", ")}`);if(e.objectChanges){for(let o of e.objectChanges)if(o.type==="created"&&o.objectType.includes("SupplyReferral"))return o.objectId}return null}catch(i){throw new Error(`Failed to create Supply Referral: ${i.message||i}`)}}async supplyToMarginPool(r,i,t){try{if(!this.supplierCapId)throw new Error("Supplier Cap not initialized. Call initialize() first.");let e=new Transaction;e.setSender(this.address);let o=e.object(this.supplierCapId);e.add(this.marginPoolContract.supplyToMarginPool(r,o,i,t));let{errors:a}=await this.suiClient.signAndExecuteTransaction({signer:this.keypair,transaction:e,options:{showEffects:!0,showObjectChanges:!0}});if(a&&a.length>0)throw new Error(`Transaction failed with errors: ${a.map(s=>s.toString()).join(", ")}`);return !0}catch(e){throw new Error(`Failed to supply to margin pool: ${e.message||e}`)}}async withdrawFromMarginPool(r,i){try{if(!this.supplierCapId)throw new Error("Supplier Cap not initialized. Call initialize() first.");let t=new Transaction,e=t.object(this.supplierCapId),a=this.marginPoolContract.withdrawFromMarginPool(r,e,i)(t);t.transferObjects([a],this.address);let{errors:s}=await this.suiClient.signAndExecuteTransaction({signer:this.keypair,transaction:t,options:{showEffects:!0,showObjectChanges:!0}});if(s&&s.length>0)throw new Error(`Transaction failed with errors: ${s.map(p=>p.toString()).join(", ")}`);return !0}catch(t){throw new Error(`Failed to withdraw from margin pool: ${t.message||t}`)}}async withdrawReferralFees(r,i){try{let t=new Transaction;t.add(this.marginPoolContract.withdrawReferralFees(r,i));let{errors:e}=await this.suiClient.signAndExecuteTransaction({signer:this.keypair,transaction:t,options:{showEffects:!0,showObjectChanges:!0,showBalanceChanges:!0}});if(e&&e.length>0)throw new Error(`Transaction failed with errors: ${e.map(o=>o.toString()).join(", ")}`);return !0}catch(t){throw new Error(`Failed to withdraw referral fees: ${t.message||t}`)}}async getBalance(r){try{if(!this.supplierCapId)throw new Error("Supplier Cap not initialized. Call initialize() first.");let i=new Transaction;i.add(this.marginPoolContract.userSupplyAmount(r,this.supplierCapId));let t=await this.suiClient.devInspectTransactionBlock({sender:this.address,transactionBlock:i}),e=0;if(t&&t.results&&t.results[0]&&t.results[0].returnValues){let l=t.results[0].returnValues[0];if(l&&l[0]){let c=Buffer.from(l[0]).readBigUInt64LE(),m=this.dbConfig.getCoin(r).scalar;e=Number(c)/m;}}let o=this.dbConfig.getCoin(r).type,a=await this.suiClient.getBalance({owner:this.address,coinType:o}),s=this.dbConfig.getCoin(r).scalar,p=Number(a.totalBalance)/s;return {userSupplyAmount:e,walletBalance:p}}catch(i){throw new Error(`Failed to get balance: ${i.message||i}`)}}getSupplierCapId(){return this.supplierCapId}getAddress(){return this.address}};var w=["supplyCap","maxUtilizationRate","protocolSpread","minBorrow","interestRate","totalSupply","supplyShares","totalBorrow","borrowShares","lastUpdateTimestamp"],h=["userSupplyShares","userSupplyAmount"],_={supplyCap:"U64",maxUtilizationRate:"U64",protocolSpread:"U64",minBorrow:"U64",interestRate:"U64",totalSupply:"U64",supplyShares:"U64",totalBorrow:"U64",borrowShares:"U64",lastUpdateTimestamp:"U64",userSupplyShares:"U64",userSupplyAmount:"U64"};var d=(n,r)=>n*r/BigInt(FLOAT_SCALAR),u=n=>Number(n)/FLOAT_SCALAR;var W=new Set(h),D=n=>W.has(n),b=class{marginPoolContract;dbConfig;suiClient;constructor({network:r,address:i="",suiClient:t,dbConfig:e}={}){let o=r??e?.network??"mainnet";if(this.dbConfig=e??new DeepBookConfig({network:o,address:i}),this.suiClient=t??new SuiClient({url:getFullnodeUrl(o)}),this.marginPoolContract=new MarginPoolContract(this.dbConfig),r!==void 0&&e!==void 0&&r!==e.network)throw new Error(`Mismatch between provided network (${r}) and dbConfig network (${e.network}).`)}get network(){return this.dbConfig.network}#r(r,i,t,e){if(D(i)){let o=this.marginPoolContract[i];if(e==null)throw new Error(`supplierCap is required for '${i}'.`);r.add(o(t,e));}else {let o=this.marginPoolContract[i];r.add(o(t));}}parseInspectResultToBcsStructs(r,i){let t=r.results;if(!t)throw new Error("No results found in DevInspect output.");return i.reduce((e,o,a)=>{let s=t[a]?.returnValues?.[0]?.[0];if(!s)return e;let p=bcs[_[o]];return e[o]=p.parse(new Uint8Array(s)),e},{})}formatResult(r,i){let t=this.dbConfig.getCoin(i),e={supplyCap:0,maxUtilizationRate:0,protocolSpread:0,minBorrow:0,interestRate:0,totalSupply:0,supplyShares:0,totalBorrow:0,borrowShares:0,lastUpdateTimestamp:0,userSupplyShares:0,userSupplyAmount:0,decimals:t.scalar.toString().length-1,highKink:0,baseBorrowApr:0,borrowAprOnHighKink:0,maxBorrowApr:0,supplyApr:0,utilizationRate:0,...t};if(!t)return e;let o=new Set(["interestRate","maxUtilizationRate","protocolSpread"]);for(let[a,s]of Object.entries(r))a==="lastUpdateTimestamp"?e[a]=Number(s):o.has(a)?e[a]=new BigNumber(s).dividedBy(FLOAT_SCALAR).toNumber():e[a]=new BigNumber(s).dividedBy(t.scalar).toNumber();return e}computeBorrowAprAtUtil(r,i){let t=BigInt(i.base_rate),e=BigInt(i.base_slope),o=BigInt(i.excess_slope),a=BigInt(i.optimal_utilization);return r<a?t+d(r,e):t+d(a,e)+d(r-a,o)}calculateKinksAndRate(r,i,t,e){let o=BigInt(r.optimal_utilization),a=BigInt(i.max_utilization_rate),s=this.computeBorrowAprAtUtil(o,r),p=this.computeBorrowAprAtUtil(a,r),l=BigInt(BigNumber(t.total_borrow).dividedBy(t.total_supply).shiftedBy(9).decimalPlaces(0).toString()),c=d(d(e,l),BigInt(FLOAT_SCALAR)-BigInt(i.protocol_spread));return {raw:{baseBorrowApr:r.base_rate,highKink:o,borrowAprOnHighKink:s,maxBorrowApr:p,supplyApr:c,utilizationRate:l},normalized:{baseBorrowApr:u(BigInt(r.base_rate)),highKink:u(o),borrowAprOnHighKink:u(s),maxBorrowApr:u(p),supplyApr:u(c),utilizationRate:u(l)}}}async#t(r,i){let{address:t}=this.dbConfig.getMarginPool(r),o=((await this.suiClient.getObject({id:t,options:{showContent:true}})).data?.content).fields,a=o.config.fields,s=a.interest_config.fields,p=a.margin_pool_config.fields,l=o.state.fields,{normalized:c}=this.calculateKinksAndRate(s,p,l,i);return c}async getPoolParameters(r,i,t=new Transaction,e=true){if(w.forEach(m=>this.#r(t,m,r)),i&&h.forEach(m=>this.#r(t,m,r,i)),!e)return t;let o=[...w,...h],a=await this.suiClient.devInspectTransactionBlock({transactionBlock:t,sender:this.dbConfig.address}),s=this.parseInspectResultToBcsStructs(a,o),p=this.formatResult(s,r),l=BigInt(s.interestRate??0),c=await this.#t(r,l);return {...p,...c}}};export{b as DeepBookMarginPool,C as DeepBookMarginToolkit};
+import {SuiClient,getFullnodeUrl}from'@mysten/sui/client';import {Ed25519Keypair}from'@mysten/sui/keypairs/ed25519';import {Transaction}from'@mysten/sui/transactions';import {DeepBookConfig,MarginPoolContract,FLOAT_SCALAR}from'@mysten/deepbook-v3';import {SUI_PRIVATE_KEY_PREFIX,decodeSuiPrivateKey,LEGACY_PRIVATE_KEY_SIZE,PRIVATE_KEY_SIZE}from'@mysten/sui/cryptography';import {fromHex,fromBase64}from'@mysten/bcs';import {bcs}from'@mysten/sui/bcs';import {BigNumber}from'bignumber.js';import {parseStructTag}from'@mysten/sui/utils';var H=s=>/^0x[0-9a-fA-F]+$|^[0-9a-fA-F]+$/.test(s),V=s=>/^[a-zA-Z0-9+/]+={0,2}$/g.test(s),B=s=>{if(H(s))return fromHex(s);if(V(s))return fromBase64(s);throw new Error("The string is not a valid hex or base64 string.")},S=s=>{if(s.length===LEGACY_PRIVATE_KEY_SIZE)return s.slice(0,PRIVATE_KEY_SIZE);if(s.length===PRIVATE_KEY_SIZE+1&&s[0]===0)return s.slice(1);if(s.length===PRIVATE_KEY_SIZE)return s;throw new Error("invalid secret key")};var A=class{suiClient;keypair;address;marginPoolContract;supplierCapId;dbConfig;supplierCapPackageId;constructor({network:r,fullnodeUrl:e,supplierCapId:t,privateKey:o,supplierCapPackageId:i,dbConfig:n}){let a=e??getFullnodeUrl(r);this.suiClient=new SuiClient({url:a}),this.keypair=this.#r(o),this.address=this.keypair.getPublicKey().toSuiAddress(),this.supplierCapId=t,this.dbConfig=n??new DeepBookConfig({network:r,address:this.address}),this.marginPoolContract=new MarginPoolContract(this.dbConfig),this.supplierCapPackageId=i??this.dbConfig.MARGIN_PACKAGE_ID;}#r(r){if(r.startsWith(SUI_PRIVATE_KEY_PREFIX)){let{secretKey:e}=decodeSuiPrivateKey(r);return Ed25519Keypair.fromSecretKey(S(e))}return Ed25519Keypair.fromSecretKey(S(B(r)))}async#t(){let r=`${this.dbConfig.MARGIN_PACKAGE_ID}::margin_pool::SupplierCap`;return (await this.suiClient.getOwnedObjects({owner:this.address,filter:{StructType:r},options:{showType:true}})).data?.[0]?.data?.objectId}async initialize(){if(this.supplierCapId)return this.supplierCapId;let r=await this.#t();if(r)return this.supplierCapId=r,r;let e=await this.createSupplierCap();if(!e)throw new Error("Failed to create Supplier Cap");return this.supplierCapId=e,e}async createSupplierCap(){try{let r=new Transaction;r.setSender(this.address);let e=r.moveCall({target:`${this.supplierCapPackageId}::margin_pool::mint_supplier_cap`,arguments:[r.object(this.dbConfig.MARGIN_REGISTRY_ID),r.object.clock()]});r.transferObjects([e],r.pure.address(this.address));let t=await this.suiClient.signAndExecuteTransaction({signer:this.keypair,transaction:r,options:{showEffects:!0,showObjectChanges:!0}});if(t.errors&&t.errors.length>0)throw new Error(`Transaction failed with errors: ${t.errors.map(o=>o.toString()).join(", ")}`);if(t.objectChanges){for(let o of t.objectChanges)if(o.type==="created"&&o.objectType.includes("SupplierCap"))return o.objectId}return null}catch(r){throw new Error(`Failed to create Supplier Cap: ${r.message||r}`)}}async createSupplyReferral(r){try{let e=new Transaction;e.setSender(this.address);let t=this.dbConfig.getMarginPool(r);if(!t)throw new Error(`Margin pool configuration not found for coin: ${r}`);e.moveCall({target:`${this.dbConfig.MARGIN_PACKAGE_ID}::margin_pool::mint_supply_referral`,arguments:[e.object(t.address),e.object(this.dbConfig.MARGIN_REGISTRY_ID),e.object.clock()],typeArguments:[t.type]});let o=await this.suiClient.signAndExecuteTransaction({signer:this.keypair,transaction:e,options:{showEffects:!0,showObjectChanges:!0}});if(o.errors&&o.errors.length>0)throw new Error(`Transaction failed with errors: ${o.errors.map(i=>i.toString()).join(", ")}`);if(o.objectChanges){for(let i of o.objectChanges)if(i.type==="created"&&i.objectType.includes("SupplyReferral"))return i.objectId}return null}catch(e){throw new Error(`Failed to create Supply Referral: ${e.message||e}`)}}async supplyToMarginPool(r,e,t){try{if(!this.supplierCapId)throw new Error("Supplier Cap not initialized. Call initialize() first.");let o=new Transaction;o.setSender(this.address);let i=o.object(this.supplierCapId);o.add(this.marginPoolContract.supplyToMarginPool(r,i,e,t));let{errors:n}=await this.suiClient.signAndExecuteTransaction({signer:this.keypair,transaction:o,options:{showEffects:!0,showObjectChanges:!0}});if(n&&n.length>0)throw new Error(`Transaction failed with errors: ${n.map(a=>a.toString()).join(", ")}`);return !0}catch(o){throw new Error(`Failed to supply to margin pool: ${o.message||o}`)}}async withdrawFromMarginPool(r,e){try{if(!this.supplierCapId)throw new Error("Supplier Cap not initialized. Call initialize() first.");let t=new Transaction,o=t.object(this.supplierCapId),n=this.marginPoolContract.withdrawFromMarginPool(r,o,e)(t);t.transferObjects([n],this.address);let{errors:a}=await this.suiClient.signAndExecuteTransaction({signer:this.keypair,transaction:t,options:{showEffects:!0,showObjectChanges:!0}});if(a&&a.length>0)throw new Error(`Transaction failed with errors: ${a.map(l=>l.toString()).join(", ")}`);return !0}catch(t){throw new Error(`Failed to withdraw from margin pool: ${t.message||t}`)}}async withdrawReferralFees(r,e){try{let t=new Transaction;t.add(this.marginPoolContract.withdrawReferralFees(r,e));let{errors:o}=await this.suiClient.signAndExecuteTransaction({signer:this.keypair,transaction:t,options:{showEffects:!0,showObjectChanges:!0,showBalanceChanges:!0}});if(o&&o.length>0)throw new Error(`Transaction failed with errors: ${o.map(i=>i.toString()).join(", ")}`);return !0}catch(t){throw new Error(`Failed to withdraw referral fees: ${t.message||t}`)}}async getBalance(r){try{if(!this.supplierCapId)throw new Error("Supplier Cap not initialized. Call initialize() first.");let e=new Transaction;e.add(this.marginPoolContract.userSupplyAmount(r,this.supplierCapId));let t=await this.suiClient.devInspectTransactionBlock({sender:this.address,transactionBlock:e}),o=0;if(t&&t.results&&t.results[0]&&t.results[0].returnValues){let p=t.results[0].returnValues[0];if(p&&p[0]){let u=Buffer.from(p[0]).readBigUInt64LE(),g=this.dbConfig.getCoin(r).scalar;o=Number(u)/g;}}let i=this.dbConfig.getCoin(r).type,n=await this.suiClient.getBalance({owner:this.address,coinType:i}),a=this.dbConfig.getCoin(r).scalar,l=Number(n.totalBalance)/a;return {userSupplyAmount:o,walletBalance:l}}catch(e){throw new Error(`Failed to get balance: ${e.message||e}`)}}getSupplierCapId(){return this.supplierCapId}getAddress(){return this.address}};var C=["supplyCap","maxUtilizationRate","protocolSpread","minBorrow","interestRate","totalSupply","supplyShares","totalBorrow","borrowShares","lastUpdateTimestamp"],f=["userSupplyShares","userSupplyAmount"],_={supplyCap:"U64",maxUtilizationRate:"U64",protocolSpread:"U64",minBorrow:"U64",interestRate:"U64",totalSupply:"U64",supplyShares:"U64",totalBorrow:"U64",borrowShares:"U64",lastUpdateTimestamp:"U64",userSupplyShares:"U64",userSupplyAmount:"U64"};var P=(s,r)=>s*r/BigInt(FLOAT_SCALAR),d=s=>Number(s)/FLOAT_SCALAR;var nr=new Set(f),ar=s=>nr.has(s),R=class{marginPoolContract;dbConfig;suiClient;constructor({network:r,address:e="",suiClient:t,dbConfig:o}={}){let i=r??o?.network??"mainnet";if(this.dbConfig=o??new DeepBookConfig({network:i,address:e}),this.suiClient=t??new SuiClient({url:getFullnodeUrl(i)}),this.marginPoolContract=new MarginPoolContract(this.dbConfig),r!==void 0&&o!==void 0&&r!==o.network)throw new Error(`Mismatch between provided network (${r}) and dbConfig network (${o.network}).`)}get network(){return this.dbConfig.network}#r(r,e,t,o){if(ar(e)){let i=this.marginPoolContract[e];if(o==null)throw new Error(`supplierCap is required for '${e}'.`);r.add(i(t,o));}else {let i=this.marginPoolContract[e];r.add(i(t));}}parseInspectResultToBcsStructs(r,e){let t=r.results;if(!t)throw new Error("No results found in DevInspect output.");return e.reduce((o,i,n)=>{let a=t[n]?.returnValues?.[0]?.[0];if(!a)return o;let l=bcs[_[i]];return o[i]=l.parse(new Uint8Array(a)),o},{})}formatResult(r,e){let t=this.dbConfig.getCoin(e),o={supplyCap:0,maxUtilizationRate:0,protocolSpread:0,minBorrow:0,interestRate:0,totalSupply:0,supplyShares:0,totalBorrow:0,borrowShares:0,lastUpdateTimestamp:0,userSupplyShares:0,userSupplyAmount:0,decimals:t.scalar.toString().length-1,highKink:0,baseBorrowApr:0,borrowAprOnHighKink:0,maxBorrowApr:0,supplyApr:0,utilizationRate:0,...t};if(!t)return o;let i=new Set(["interestRate","maxUtilizationRate","protocolSpread"]);for(let[n,a]of Object.entries(r))n==="lastUpdateTimestamp"?o[n]=Number(a):i.has(n)?o[n]=new BigNumber(a).dividedBy(FLOAT_SCALAR).toNumber():o[n]=new BigNumber(a).dividedBy(t.scalar).toNumber();return o}computeBorrowAprAtUtil(r,e){let t=BigInt(e.base_rate),o=BigInt(e.base_slope),i=BigInt(e.excess_slope),n=BigInt(e.optimal_utilization);return r<n?t+P(r,o):t+P(n,o)+P(r-n,i)}calculateKinksAndRate(r,e,t,o){let i=BigInt(r.optimal_utilization),n=BigInt(e.max_utilization_rate),a=this.computeBorrowAprAtUtil(i,r),l=this.computeBorrowAprAtUtil(n,r),p=BigInt(BigNumber(t.total_borrow).dividedBy(t.total_supply).shiftedBy(9).decimalPlaces(0).toString()),u=P(P(o,p),BigInt(FLOAT_SCALAR)-BigInt(e.protocol_spread));return {raw:{baseBorrowApr:r.base_rate,highKink:i,borrowAprOnHighKink:a,maxBorrowApr:l,supplyApr:u,utilizationRate:p},normalized:{baseBorrowApr:d(BigInt(r.base_rate)),highKink:d(i),borrowAprOnHighKink:d(a),maxBorrowApr:d(l),supplyApr:d(u),utilizationRate:d(p)}}}async#t(r,e,t){let{address:o}=this.dbConfig.getMarginPool(r);t??=await this.suiClient.getObject({id:o,options:{showContent:true}});let i=(t.data?.content).fields,n=i.config.fields,a=n.interest_config.fields,l=n.margin_pool_config.fields,p=i.state.fields,{normalized:u}=this.calculateKinksAndRate(a,l,p,e);return u}async getPoolParameters(r,e,t=new Transaction,o=true){if(C.forEach(g=>this.#r(t,g,r)),e&&f.forEach(g=>this.#r(t,g,r,e)),!o)return t;let i=[...C,...f],n=await this.suiClient.devInspectTransactionBlock({transactionBlock:t,sender:this.dbConfig.address}),a=this.parseInspectResultToBcsStructs(n,i),l=this.formatResult(a,r),p=BigInt(a.interestRate??0),u=await this.#t(r,p);return {...l,...u}}async getPoolsParameters(r,e,t=new Transaction,o=true){for(let c of r)C.forEach(m=>this.#r(t,m,c)),e&&f.forEach(m=>this.#r(t,m,c,e));if(!o)return t;let i=[...C,...e?f:[]],n=i.length,a=r.map(c=>this.dbConfig.getMarginPool(c).address),l=50,p=[];for(let c=0;c<a.length;c+=l)p.push(a.slice(c,c+l));let[u,...g]=await Promise.all([this.suiClient.devInspectTransactionBlock({transactionBlock:t,sender:this.dbConfig.address}),...p.map(c=>this.suiClient.multiGetObjects({ids:c,options:{showContent:true}}))]),v=g.flat(),I=u.results;if(!I)throw new Error("No results found in DevInspect output.");return Promise.all(r.map(async(c,m)=>{let N=m*n,T=i.reduce((y,E,L)=>{let K=I[N+L]?.returnValues?.[0]?.[0];if(!K)return y;let $=bcs[_[E]];return y[E]=$.parse(new Uint8Array(K)),y},{}),z=this.formatResult(T,c),G=BigInt(T.interestRate??0),w=v[m];if(!w||w.error)throw new Error(`Failed to fetch interest config for ${c}`);let F=await this.#t(c,G,w);return {...z,...F}}))}};var cr="0x7f7351ef7e5089dfddf17f55abe028d719c45ca91d2c23e45a441ba65897f804",ur=async(s=new SuiClient({url:getFullnodeUrl("mainnet")}))=>{let r=[],e=[],t=null,o=true;for(;o;){let{data:n,nextCursor:a,hasNextPage:l}=await s.getDynamicFields({parentId:cr,cursor:t,limit:50});if(e.push(...n.map(p=>p.objectId)),n.length===0)break;t=a,o=l;}let i=await s.multiGetObjects({ids:e,options:{showContent:true}});for(let n of i){let a=n.data?.content;if(!a||a.dataType!=="moveObject")continue;let l=a.fields;r.push({address:l.value,type:`0x${l.name?.fields?.name}`});}return r.reduce((n,a)=>{let{name:l}=parseStructTag(a.type);return n[l.replace(/_/g,"")]=a,n},{})};export{R as DeepBookMarginPool,A as DeepBookMarginToolkit,ur as getOnChainMarginPools};

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "@scallop-io/scallop-deepbook-kit",
-  "version": "0.2.1",
+  "version": "0.4.0",
   "description": "A toolkit for integrating Scallop with DeepBook functionality",
   "keywords": [
     "scallop",

package/src/examples/margin-pool-demo.ts

@@ -18,22 +18,31 @@ const MARGIN_POOLS = {
     address: '0x38decd3dbb62bd4723144349bf57bc403b393aee86a51596846a824a1e0c2c01',
     type: '0x356a26eb9e012a68958082340d4c4116e7f55615cf27affcff209cf0ae544f59::wal::WAL',
   },
+  XBTC: {
+    address: '0x14dfbf54400e0b97e892349310d392bef6d187c2b6709d9b246b8f41c9a13de4',
+    type: '0x876a4b7bce8aeaef60464c11f4026903e9afacab79b9b142686158aa86560b50::xbtc::XBTC',
+  },
+  SUIUSDE: {
+    address: '0xbb990ca04a7743e6c0a25a7fb16f60fc6f6d8bf213624ff03a63f1bb04c3a12f',
+    type: '0x41d587e5336f1c86cad50d38a7136db99333bb9bda91cea4ba69115defeb1402::sui_usde::SUI_USDE',
+  },
 };
 
 const main = async () => {
   try {
-    const env = 'mainnet';
+    const network = 'mainnet';
     const dbMarginPool = new DeepBookMarginPool({
-      env,
+      network,
       dbConfig: new DeepBookConfig({
-        env,
+        network,
         address: '',
         marginPools: MARGIN_POOLS,
       }),
     });
-    const coinKey = 'USDC';
-    const suiMarginPoolParams = await dbMarginPool.getPoolParameters(coinKey);
-    console.log(`${coinKey} Margin Pool Parameters:`, suiMarginPoolParams);
+    const coinKeys = ['USDC', 'XBTC'];
+    const suiMarginPoolsParams = await dbMarginPool.getPoolsParameters(coinKeys);
+    console.log('Margin Pools Parameters:');
+    console.log(JSON.stringify(suiMarginPoolsParams, null, 2));
   } catch (error) {
     console.error('An error occurred:', error);
   } finally {

package/src/index.ts

@@ -1 +1,2 @@
 export * from './toolkit';
+export * from './queries';

package/src/queries/getOnChainMarginPools.ts

@@ -0,0 +1,61 @@
+import { MarginPool } from '@mysten/deepbook-v3';
+import { getFullnodeUrl, SuiClient } from '@mysten/sui/client';
+import { parseStructTag } from '@mysten/sui/utils';
+
+const MARGIN_POOLS_TABLE_ID = '0x7f7351ef7e5089dfddf17f55abe028d719c45ca91d2c23e45a441ba65897f804';
+
+/**
+ * Fetch all margin pool addresses and their types from the on-chain dynamic fields table.
+ * @returns Record<coinKey, { address: string; type: string }>
+ */
+export const getOnChainMarginPools = async (
+  suiClient: SuiClient = new SuiClient({
+    url: getFullnodeUrl('mainnet'),
+  })
+) => {
+  const marginPools: Array<{ address: string; type: string }> = [];
+  const ids: string[] = [];
+
+  let cursor: string | null = null;
+  let nextPage = true;
+
+  while (nextPage) {
+    const { data, nextCursor, hasNextPage } = await suiClient.getDynamicFields({
+      parentId: MARGIN_POOLS_TABLE_ID,
+      cursor,
+      limit: 50,
+    });
+
+    ids.push(...data.map((item) => item.objectId));
+
+    if (data.length === 0) {
+      break;
+    }
+
+    cursor = nextCursor;
+    nextPage = hasNextPage;
+  }
+
+  // Fetch all the object ids
+  const objects = await suiClient.multiGetObjects({ ids, options: { showContent: true } });
+
+  for (const obj of objects) {
+    const content = obj.data?.content;
+    if (!content || content.dataType !== 'moveObject') continue;
+    const fields = content.fields as Record<string, any>;
+    marginPools.push({
+      address: fields.value,
+      type: `0x${fields.name?.fields?.name}`,
+    });
+  }
+
+  return marginPools.reduce(
+    (acc, pool) => {
+      // Get symbol from type
+      const { name } = parseStructTag(pool.type);
+      acc[name.replace(/_/g, '')] = pool;
+      return acc;
+    },
+    {} as Record<string, MarginPool>
+  );
+};

package/src/queries/index.ts

@@ -0,0 +1 @@
+export { getOnChainMarginPools } from './getOnChainMarginPools';

package/src/toolkit/DeepBookMarginPool.ts

@@ -1,6 +1,11 @@
 import { Coin, DeepBookConfig, FLOAT_SCALAR, MarginPoolContract } from '@mysten/deepbook-v3';
 import { bcs } from '@mysten/sui/bcs';
-import { DevInspectResults, getFullnodeUrl, SuiClient } from '@mysten/sui/client';
+import {
+  DevInspectResults,
+  getFullnodeUrl,
+  SuiClient,
+  SuiObjectResponse,
+} from '@mysten/sui/client';
 import { Transaction } from '@mysten/sui/transactions';
 import { BigNumber } from 'bignumber.js';
 import {
@@ -87,7 +92,12 @@ export class DeepBookMarginPool {
     // If dbConfig is provided and network is not, derive network from dbConfig
     const resolvedNetwork = network ?? dbConfig?.network ?? 'mainnet';
 
-    this.dbConfig = dbConfig ?? new DeepBookConfig({ network: resolvedNetwork, address });
+    this.dbConfig =
+      dbConfig ??
+      new DeepBookConfig({
+        network: resolvedNetwork,
+        address,
+      });
     this.suiClient = suiClient ?? new SuiClient({ url: getFullnodeUrl(resolvedNetwork) });
 
     // Initialize smart contract wrapper
@@ -309,9 +319,9 @@ export class DeepBookMarginPool {
    * @param coinKey - Asset key.
    * @param borrowAprScaled - interestRate in FLOAT_SCALAR scale (bigint).
    */
-  async #getInterestConfig(coinKey: string, borrowAprScaled: bigint) {
+  async #getInterestConfig(coinKey: string, borrowAprScaled: bigint, response?: SuiObjectResponse) {
     const { address } = this.dbConfig.getMarginPool(coinKey);
-    const response = await this.suiClient.getObject({
+    response ??= await this.suiClient.getObject({
       id: address,
       options: {
         showContent: true,
@@ -368,7 +378,6 @@ export class DeepBookMarginPool {
     inspect: false
   ): Promise<Transaction>;
 
-  // 👇 implementation signature (must be last)
   async getPoolParameters(
     coinKey: string,
     supplierCapId?: string,
@@ -409,4 +418,125 @@ export class DeepBookMarginPool {
       ...interestData,
     };
   }
+
+  /**
+   * Batch version of getPoolParameters for reduced RPC calls.
+   * Adds all param calls to a single transaction and performs one devInspect.
+   *
+   * @param coinKeys - Asset keys.
+   * @param supplierCapId - Supplier cap object ID.
+   * @param tx - Optional transaction to append to.
+   * @param inspect - Whether to perform devInspect and return decoded results.
+   *
+   * @returns Parsed parameters or transaction object ready for execution.
+   */
+  async getPoolsParameters(
+    coinKeys: string[],
+    supplierCapId?: string,
+    tx?: Transaction
+  ): Promise<MarginPoolParams[]>;
+
+  async getPoolsParameters(
+    coinKeys: string[],
+    supplierCapId: string | undefined,
+    tx: Transaction,
+    inspect: true
+  ): Promise<MarginPoolParams[]>;
+
+  async getPoolsParameters(
+    coinKeys: string[],
+    supplierCapId: string | undefined,
+    tx: Transaction,
+    inspect: false
+  ): Promise<Transaction>;
+
+  async getPoolsParameters(
+    coinKeys: string[],
+    supplierCapId?: string,
+    tx: Transaction = new Transaction(),
+    inspect: boolean = true
+  ): Promise<MarginPoolParams[] | Transaction> {
+    // Add all param calls for every coin into a single transaction
+    for (const coinKey of coinKeys) {
+      MARGIN_POOL_PARAM_KEYS.forEach((paramKey) => this.#addParamCall(tx, paramKey, coinKey));
+
+      if (supplierCapId) {
+        MARGIN_POOL_W_SUPPLIER_CAP_PARAM_KEYS.forEach((paramKey) =>
+          this.#addParamCall(tx, paramKey, coinKey, supplierCapId)
+        );
+      }
+    }
+
+    if (!inspect) return tx;
+
+    // Determine how many result slots each coin occupies
+    const keysPerCoin: (MarginPoolParamKey | MarginPoolWithSupplierCapParamKey)[] = [
+      ...MARGIN_POOL_PARAM_KEYS,
+      ...(supplierCapId ? MARGIN_POOL_W_SUPPLIER_CAP_PARAM_KEYS : []),
+    ];
+    const slotCount = keysPerCoin.length;
+
+    // Single devInspect + batched multiGetObjects (max 50 per call)
+    const objectIds = coinKeys.map((coinKey) => this.dbConfig.getMarginPool(coinKey).address);
+    const MULTI_GET_BATCH_SIZE = 50;
+    const batches: string[][] = [];
+    for (let i = 0; i < objectIds.length; i += MULTI_GET_BATCH_SIZE) {
+      batches.push(objectIds.slice(i, i + MULTI_GET_BATCH_SIZE));
+    }
+
+    const [inspectResult, ...objectBatches] = await Promise.all([
+      this.suiClient.devInspectTransactionBlock({
+        transactionBlock: tx,
+        sender: this.dbConfig.address,
+      }),
+      ...batches.map((ids) =>
+        this.suiClient.multiGetObjects({
+          ids,
+          options: { showContent: true },
+        })
+      ),
+    ]);
+    const interestConfigs = objectBatches.flat();
+
+    const allResults = inspectResult.results;
+    if (!allResults) throw new Error('No results found in DevInspect output.');
+
+    // Split results per coin and format
+    return Promise.all(
+      coinKeys.map(async (coinKey, coinIdx) => {
+        const offset = coinIdx * slotCount;
+
+        // Parse the slice of results belonging to this coin
+        const parsed = keysPerCoin.reduce(
+          (acc, key, keyIdx) => {
+            const bytes = allResults[offset + keyIdx]?.returnValues?.[0]?.[0];
+            if (!bytes) return acc;
+            const bcsType = bcs[MARGIN_POOL_PARAM_KEY_STRUCT_MAP[key]];
+            acc[key] = bcsType.parse(new Uint8Array(bytes));
+            return acc;
+          },
+          {} as Record<MarginPoolParamKey | MarginPoolWithSupplierCapParamKey, string>
+        );
+
+        const formattedResult = this.formatResult(parsed, coinKey);
+        const borrowAprScaled = BigInt(parsed.interestRate ?? 0);
+
+        const interestConfig = interestConfigs[coinIdx];
+        if (!interestConfig || interestConfig.error) {
+          throw new Error(`Failed to fetch interest config for ${coinKey}`);
+        }
+
+        const interestData = await this.#getInterestConfig(
+          coinKey,
+          borrowAprScaled,
+          interestConfig
+        );
+
+        return {
+          ...formattedResult,
+          ...interestData,
+        };
+      })
+    );
+  }
 }