@dynamic-labs-sdk/sui 1.17.1 → 1.19.0

package/dist/{suiTransferAmount-C0N3dA8F.esm.js → suiTransferAmount-CUAhcg6j.esm.js}

@@ -6,7 +6,7 @@ import { Transaction } from "@mysten/sui/transactions";
 
 //#region package.json
 var name = "@dynamic-labs-sdk/sui";
-var version = "1.17.1";
+var version = "1.19.0";
 
 //#endregion
 //#region src/utils/fetchSuiBalance/fetchSuiBalance.ts
@@ -72,10 +72,17 @@ const isSuiWalletProvider = (provider) => {
 /**
 * Retrieves a SuiClient from a wallet account.
 *
+* @example
+* ```ts
+* const suiClient = await getSuiClient({ walletAccount: suiAccount });
+* ```
+*
 * @param params.walletAccount - The wallet account to get the SuiClient for.
 * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
-* @returns A promise that resolves to a SuiClient instance
-* @throws NotSuiProviderError If the wallet account's provider is not a SUI provider
+* @returns A promise that resolves to a SuiClient instance.
+* @throws {NotSuiProviderError} If the wallet account's provider is not a SUI provider.
+* @see signAndExecuteTransaction
+* @see isSuiWalletAccount
 * @notInstrumented
 */
 const getSuiClient = async ({ walletAccount }, client = getDefaultClient()) => {
@@ -89,8 +96,16 @@ const getSuiClient = async ({ walletAccount }, client = getDefaultClient()) => {
 /**
 * Type guard function to check if a wallet account is a Sui wallet account.
 *
+* @example
+* ```ts
+* const accounts = getWalletAccounts();
+* const suiAccounts = accounts.filter(isSuiWalletAccount);
+* ```
+*
 * @param walletAccount - The wallet account to check.
 * @returns True if the wallet account is a Sui wallet account, false otherwise.
+* @see isSuiNetworkProvider
+* @see addSuiExtension
 * @notInstrumented
 */
 const isSuiWalletAccount = (walletAccount) => walletAccount.chain === "SUI";
@@ -144,11 +159,23 @@ const suiExecuteSwapTransaction = async ({ onStepChange, signingPayload, walletA
 //#endregion
 //#region src/signAndExecuteTransaction/signAndExecuteTransaction.ts
 /**
-* Signs and executes a Sui transaction
-* @param params.transaction - The transaction to sign and execute
-* @param params.walletAccount - The wallet account to sign the transaction with
+* Signs and executes a Sui transaction.
+*
+* @example
+* ```ts
+* const result = await signAndExecuteTransaction({
+*   walletAccount: suiAccount,
+*   transaction: suiTransaction,
+* });
+* ```
+*
+* @param params.transaction - The transaction to sign and execute.
+* @param params.walletAccount - The wallet account to sign the transaction with.
 * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
-* @returns An object containing the signature and transaction bytes
+* @returns An object containing the signature and transaction bytes.
+* @throws {NotSuiProviderError} If the wallet account's provider is not a SUI provider.
+* @see signTransaction
+* @see getSuiClient
 * @notInstrumented
 */
 const signAndExecuteTransaction = async ({ walletAccount, transaction }, client = getDefaultClient$1()) => {
@@ -202,4 +229,4 @@ const suiTransferAmount = async ({ amount, recipient, token, walletAccount }, cl
 
 //#endregion
 export { isSuiWalletAccount as a, NotSuiProviderError as c, version as d, suiConfirmTransaction as i, registerSuiNetworkProviderBuilder as l, signAndExecuteTransaction as n, getSuiClient as o, suiExecuteSwapTransaction as r, isSuiWalletProvider as s, suiTransferAmount as t, name as u };
-//# sourceMappingURL=suiTransferAmount-C0N3dA8F.esm.js.map
+//# sourceMappingURL=suiTransferAmount-CUAhcg6j.esm.js.map

package/dist/suiTransferAmount-CUAhcg6j.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"suiTransferAmount-CUAhcg6j.esm.js","names":["getDefaultClient"],"sources":["../package.json","../src/utils/fetchSuiBalance/fetchSuiBalance.ts","../src/utils/createSuiNetworkProvider/createSuiNetworkProvider.ts","../src/registerSuiNetworkProviderBuilder/registerSuiNetworkProviderBuilder.ts","../src/errors/NotSuiProviderError/NotSuiProviderError.ts","../src/isSuiWalletProvider/isSuiWalletProvider.ts","../src/getSuiClient/getSuiClient.ts","../src/isSuiWalletAccount/isSuiWalletAccount.ts","../src/utils/suiConfirmTransaction/suiConfirmTransaction.ts","../src/utils/suiExecuteSwapTransaction/suiExecuteSwapTransaction.ts","../src/signAndExecuteTransaction/signAndExecuteTransaction.ts","../src/utils/suiTransferAmount/suiTransferAmount.ts"],"sourcesContent":["","import type { NetworkData } from '@dynamic-labs-sdk/client';\nimport { SuiClient } from '@mysten/sui/client';\nimport { MIST_PER_SUI } from '@mysten/sui/utils';\n\n/** @notInstrumented */\nexport const fetchSuiBalance = async ({\n  address,\n  networkData,\n}: {\n  address: string;\n  networkData: NetworkData;\n}): Promise<string | null> => {\n  // Create a SuiClient using the provided RPC URL.\n  const suiClient = new SuiClient({\n    url: networkData.rpcUrls.http[0],\n  });\n\n  const balanceInMist = await suiClient.getBalance({\n    owner: address,\n  });\n\n  // Balance comes back as MIST, 1 SUI = 1e9 MIST\n  const balance = Number(balanceInMist.totalBalance) / Number(MIST_PER_SUI);\n\n  if (Number.isNaN(balance)) {\n    return null;\n  }\n\n  return balance.toString();\n};\n","import type { NetworkData } from '@dynamic-labs-sdk/client';\nimport { createBaseNetworkProvider } from '@dynamic-labs-sdk/client/core';\n\nimport type { SuiNetworkProvider } from '../../SuiNetworkProvider.types';\nimport { fetchSuiBalance } from '../fetchSuiBalance';\n\n/** @notInstrumented */\nexport const createSuiNetworkProvider = (\n  networkData: NetworkData\n): SuiNetworkProvider => ({\n  ...createBaseNetworkProvider('SUI', networkData),\n  getBalance: async ({ address }) => ({\n    balance: await fetchSuiBalance({\n      address,\n      networkData,\n    }),\n  }),\n});\n","import type { DynamicClient } from '@dynamic-labs-sdk/client';\nimport { getNetworkProviderBuilderRegistry } from '@dynamic-labs-sdk/client/core';\n\nimport { createSuiNetworkProvider } from '../utils/createSuiNetworkProvider';\n\n/** @notInstrumented */\nexport const registerSuiNetworkProviderBuilder = (\n  client: DynamicClient\n): void => {\n  const networkProviderBuilderRegistry =\n    getNetworkProviderBuilderRegistry(client);\n\n  /**\n   * If the Sui network provider builder is already registered, return.\n   */\n  if (networkProviderBuilderRegistry.get().get('SUI')) {\n    return;\n  }\n\n  networkProviderBuilderRegistry.register({\n    builder: createSuiNetworkProvider,\n    chain: 'SUI',\n  });\n};\n","import { BaseError } from '@dynamic-labs-sdk/client';\n\nexport class NotSuiProviderError extends BaseError {\n  public readonly providerKey: string;\n\n  constructor(params: { providerKey: string }) {\n    super({\n      cause: null,\n      code: 'not_sui_provider_error',\n      docsUrl: null,\n      name: 'NotSuiProviderError',\n      shortMessage: 'Provider is not a Sui wallet provider',\n    });\n\n    this.providerKey = params.providerKey;\n  }\n}\n","import type { WalletProvider } from '@dynamic-labs-sdk/client/core';\n\nimport type { SuiWalletProvider } from '../SuiWalletProvider.types';\n\n/** @notInstrumented */\nexport const isSuiWalletProvider = (\n  provider: WalletProvider\n): provider is SuiWalletProvider => {\n  return provider.chain === 'SUI';\n};\n","import {\n  getDefaultClient,\n  getWalletProviderFromWalletAccount,\n} from '@dynamic-labs-sdk/client/core';\n\nimport { NotSuiProviderError } from '../errors/NotSuiProviderError';\nimport { isSuiWalletProvider } from '../isSuiWalletProvider';\nimport type { SuiWalletAccount } from '../SuiWalletAccount.types';\n\ntype GetSuiClientParams = {\n  walletAccount: SuiWalletAccount;\n};\n\n/**\n * Retrieves a SuiClient from a wallet account.\n *\n * @example\n * ```ts\n * const suiClient = await getSuiClient({ walletAccount: suiAccount });\n * ```\n *\n * @param params.walletAccount - The wallet account to get the SuiClient for.\n * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.\n * @returns A promise that resolves to a SuiClient instance.\n * @throws {NotSuiProviderError} If the wallet account's provider is not a SUI provider.\n * @see signAndExecuteTransaction\n * @see isSuiWalletAccount\n * @notInstrumented\n */\nexport const getSuiClient = async (\n  { walletAccount }: GetSuiClientParams,\n  client = getDefaultClient()\n) => {\n  const provider = getWalletProviderFromWalletAccount(\n    {\n      walletAccount,\n    },\n    client\n  );\n\n  if (!isSuiWalletProvider(provider)) {\n    throw new NotSuiProviderError({ providerKey: provider.key });\n  }\n\n  return provider.getSuiClient({ walletAccount });\n};\n","import type { WalletAccount } from '@dynamic-labs-sdk/client';\n\nimport type { SuiWalletAccount } from '../SuiWalletAccount.types';\n\n/**\n * Type guard function to check if a wallet account is a Sui wallet account.\n *\n * @example\n * ```ts\n * const accounts = getWalletAccounts();\n * const suiAccounts = accounts.filter(isSuiWalletAccount);\n * ```\n *\n * @param walletAccount - The wallet account to check.\n * @returns True if the wallet account is a Sui wallet account, false otherwise.\n * @see isSuiNetworkProvider\n * @see addSuiExtension\n * @notInstrumented\n */\nexport const isSuiWalletAccount = (\n  walletAccount: WalletAccount\n): walletAccount is SuiWalletAccount => walletAccount.chain === 'SUI';\n","import type { DynamicClient } from '@dynamic-labs-sdk/client';\nimport { InvalidParamError } from '@dynamic-labs-sdk/client';\nimport type { ConfirmTransactionParams } from '@dynamic-labs-sdk/client/core';\n\nimport { getSuiClient } from '../../getSuiClient';\nimport { isSuiWalletAccount } from '../../isSuiWalletAccount';\n\n/**\n * Waits for a SUI transaction to be confirmed on-chain.\n *\n * @param params.transactionHash - The transaction digest to wait for.\n * @param params.walletAccount - The wallet account that submitted the transaction.\n * @param client - The Dynamic client instance.\n * @notInstrumented\n */\nexport const suiConfirmTransaction = async (\n  { transactionHash, walletAccount }: ConfirmTransactionParams,\n  client: DynamicClient\n): Promise<void> => {\n  if (!isSuiWalletAccount(walletAccount)) {\n    throw new InvalidParamError('Wallet account is not a SUI wallet account');\n  }\n\n  const suiClient = await getSuiClient({ walletAccount }, client);\n\n  await suiClient.waitForTransaction({ digest: transactionHash });\n};\n","import {\n  type DynamicClient,\n  InvalidParamError,\n} from '@dynamic-labs-sdk/client';\nimport type {\n  ExecuteSwapTransactionParams,\n  ExecuteSwapTransactionResult,\n} from '@dynamic-labs-sdk/client/core';\nimport { getWalletProviderFromWalletAccount } from '@dynamic-labs-sdk/client/core';\nimport { Transaction } from '@mysten/sui/transactions';\n\nimport { isSuiWalletAccount } from '../../isSuiWalletAccount';\nimport { isSuiWalletProvider } from '../../isSuiWalletProvider';\n\n/**\n * Executes a Sui checkout transaction by deserializing the base64-encoded\n * BCS transaction and sending it via the wallet provider's signAndExecuteTransaction.\n *\n * 1. Validates that the wallet account is a Sui wallet account\n * 2. Extracts and validates the serialized transaction from the signing payload\n * 3. Deserializes the transaction using Transaction.from()\n * 4. Signs and executes via the Sui wallet provider\n *\n * @param params.signingPayload - The signing payload containing `serializedTransaction`.\n * @param params.walletAccount - The wallet account used to sign and execute the transaction.\n * @param params.onStepChange - Optional callback invoked with `'transaction'` when the execution step begins.\n * @param client - The Dynamic client instance.\n * @returns The transaction hash (digest).\n * @notInstrumented\n */\nexport const suiExecuteSwapTransaction = async (\n  { onStepChange, signingPayload, walletAccount }: ExecuteSwapTransactionParams,\n  client: DynamicClient\n): Promise<ExecuteSwapTransactionResult> => {\n  const walletProvider = getWalletProviderFromWalletAccount(\n    { walletAccount },\n    client\n  );\n\n  if (\n    !isSuiWalletAccount(walletAccount) ||\n    !isSuiWalletProvider(walletProvider)\n  ) {\n    throw new InvalidParamError('Wallet account is not a Sui wallet account');\n  }\n\n  const serializedTransactionData = signingPayload.serializedTransaction;\n\n  if (!serializedTransactionData) {\n    throw new InvalidParamError(\n      'Signing payload is missing serialized transaction data'\n    );\n  }\n\n  const transaction = Transaction.from(serializedTransactionData);\n\n  onStepChange?.('transaction');\n\n  const result = await walletProvider.signAndExecuteTransaction({\n    transaction,\n    walletAccount,\n  });\n\n  return { transactionHash: result.digest };\n};\n","import { getDefaultClient } from '@dynamic-labs-sdk/client';\nimport { getWalletProviderFromWalletAccount } from '@dynamic-labs-sdk/client/core';\nimport type { Transaction } from '@mysten/sui/transactions';\n\nimport { NotSuiProviderError } from '../errors/NotSuiProviderError';\nimport { isSuiWalletProvider } from '../isSuiWalletProvider';\nimport type { SuiWalletAccount } from '../SuiWalletAccount.types';\nimport type { SuiSignAndExecuteTransactionResult } from '../SuiWalletProvider.types';\n\ntype SignAndExecuteTransactionParams = {\n  transaction: Transaction;\n  walletAccount: SuiWalletAccount;\n};\n\n/**\n * Signs and executes a Sui transaction.\n *\n * @example\n * ```ts\n * const result = await signAndExecuteTransaction({\n *   walletAccount: suiAccount,\n *   transaction: suiTransaction,\n * });\n * ```\n *\n * @param params.transaction - The transaction to sign and execute.\n * @param params.walletAccount - The wallet account to sign the transaction with.\n * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.\n * @returns An object containing the signature and transaction bytes.\n * @throws {NotSuiProviderError} If the wallet account's provider is not a SUI provider.\n * @see signTransaction\n * @see getSuiClient\n * @notInstrumented\n */\nexport const signAndExecuteTransaction = async (\n  { walletAccount, transaction }: SignAndExecuteTransactionParams,\n  client = getDefaultClient()\n): Promise<SuiSignAndExecuteTransactionResult> => {\n  const provider = getWalletProviderFromWalletAccount(\n    {\n      walletAccount,\n    },\n    client\n  );\n\n  if (!isSuiWalletProvider(provider)) {\n    throw new NotSuiProviderError({ providerKey: provider.key });\n  }\n\n  transaction.setSender(walletAccount.address);\n\n  return provider.signAndExecuteTransaction({ transaction, walletAccount });\n};\n","import type { DynamicClient } from '@dynamic-labs-sdk/client';\nimport { InvalidParamError } from '@dynamic-labs-sdk/client';\nimport {\n  type TransferAmountParams,\n  parseAmountToSmallestUnit,\n} from '@dynamic-labs-sdk/client/core';\nimport { Transaction } from '@mysten/sui/transactions';\n\nimport { getSuiClient } from '../../getSuiClient';\nimport { isSuiWalletAccount } from '../../isSuiWalletAccount';\nimport { signAndExecuteTransaction } from '../../signAndExecuteTransaction';\n\nconst SUI_DECIMALS = 9;\n\n/**\n * Transfers native SUI or a SUI token from one wallet to another.\n *\n * For native SUI, converts the human-readable amount string to MIST (9 decimals).\n * For tokens, fetches the user's coins of that type and splits from them.\n  * @notInstrumented\n */\nexport const suiTransferAmount = async (\n  { amount, recipient, token, walletAccount }: TransferAmountParams,\n  client: DynamicClient\n): Promise<{ transactionHash: string }> => {\n  if (!isSuiWalletAccount(walletAccount)) {\n    throw new InvalidParamError('Wallet account is not a SUI wallet account');\n  }\n\n  const transaction = new Transaction();\n\n  if (token?.address) {\n    const suiClient = await getSuiClient({ walletAccount }, client);\n\n    const { data: coins } = await suiClient.getCoins({\n      coinType: token.address,\n      owner: walletAccount.address,\n    });\n\n    if (coins.length === 0) {\n      throw new InvalidParamError('Token not found');\n    }\n\n    const smallestUnit = parseAmountToSmallestUnit({\n      amount,\n      decimals: token.decimals,\n    });\n\n    const [coin] = transaction.splitCoins(coins[0].coinObjectId, [\n      smallestUnit,\n    ]);\n    transaction.transferObjects([coin], recipient);\n  } else {\n    const mist = parseAmountToSmallestUnit({\n      amount,\n      decimals: SUI_DECIMALS,\n    });\n\n    const [coin] = transaction.splitCoins(transaction.gas, [mist]);\n    transaction.transferObjects([coin], recipient);\n  }\n\n  const result = await signAndExecuteTransaction(\n    { transaction, walletAccount },\n    client\n  );\n\n  return { transactionHash: result.digest };\n};\n"],"mappings":";;;;;;;;;;;;;ACKA,MAAa,kBAAkB,OAAO,EACpC,SACA,kBAI4B;CAM5B,MAAM,gBAAgB,MAJJ,IAAI,UAAU,EAC9B,KAAK,YAAY,QAAQ,KAAK,IAC/B,CAAC,CAEoC,WAAW,EAC/C,OAAO,SACR,CAAC;CAGF,MAAM,UAAU,OAAO,cAAc,aAAa,GAAG,OAAO,aAAa;AAEzE,KAAI,OAAO,MAAM,QAAQ,CACvB,QAAO;AAGT,QAAO,QAAQ,UAAU;;;;;;ACrB3B,MAAa,4BACX,iBACwB;CACxB,GAAG,0BAA0B,OAAO,YAAY;CAChD,YAAY,OAAO,EAAE,eAAe,EAClC,SAAS,MAAM,gBAAgB;EAC7B;EACA;EACD,CAAC,EACH;CACF;;;;;ACXD,MAAa,qCACX,WACS;CACT,MAAM,iCACJ,kCAAkC,OAAO;;;;AAK3C,KAAI,+BAA+B,KAAK,CAAC,IAAI,MAAM,CACjD;AAGF,gCAA+B,SAAS;EACtC,SAAS;EACT,OAAO;EACR,CAAC;;;;;ACpBJ,IAAa,sBAAb,cAAyC,UAAU;CACjD,AAAgB;CAEhB,YAAY,QAAiC;AAC3C,QAAM;GACJ,OAAO;GACP,MAAM;GACN,SAAS;GACT,MAAM;GACN,cAAc;GACf,CAAC;AAEF,OAAK,cAAc,OAAO;;;;;;;ACT9B,MAAa,uBACX,aACkC;AAClC,QAAO,SAAS,UAAU;;;;;;;;;;;;;;;;;;;;;ACqB5B,MAAa,eAAe,OAC1B,EAAE,iBACF,SAAS,kBAAkB,KACxB;CACH,MAAM,WAAW,mCACf,EACE,eACD,EACD,OACD;AAED,KAAI,CAAC,oBAAoB,SAAS,CAChC,OAAM,IAAI,oBAAoB,EAAE,aAAa,SAAS,KAAK,CAAC;AAG9D,QAAO,SAAS,aAAa,EAAE,eAAe,CAAC;;;;;;;;;;;;;;;;;;;;ACzBjD,MAAa,sBACX,kBACsC,cAAc,UAAU;;;;;;;;;;;;ACNhE,MAAa,wBAAwB,OACnC,EAAE,iBAAiB,iBACnB,WACkB;AAClB,KAAI,CAAC,mBAAmB,cAAc,CACpC,OAAM,IAAI,kBAAkB,6CAA6C;AAK3E,QAFkB,MAAM,aAAa,EAAE,eAAe,EAAE,OAAO,EAE/C,mBAAmB,EAAE,QAAQ,iBAAiB,CAAC;;;;;;;;;;;;;;;;;;;;;ACKjE,MAAa,4BAA4B,OACvC,EAAE,cAAc,gBAAgB,iBAChC,WAC0C;CAC1C,MAAM,iBAAiB,mCACrB,EAAE,eAAe,EACjB,OACD;AAED,KACE,CAAC,mBAAmB,cAAc,IAClC,CAAC,oBAAoB,eAAe,CAEpC,OAAM,IAAI,kBAAkB,6CAA6C;CAG3E,MAAM,4BAA4B,eAAe;AAEjD,KAAI,CAAC,0BACH,OAAM,IAAI,kBACR,yDACD;CAGH,MAAM,cAAc,YAAY,KAAK,0BAA0B;AAE/D,gBAAe,cAAc;AAO7B,QAAO,EAAE,kBALM,MAAM,eAAe,0BAA0B;EAC5D;EACA;EACD,CAAC,EAE+B,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;AC7B3C,MAAa,4BAA4B,OACvC,EAAE,eAAe,eACjB,SAASA,oBAAkB,KACqB;CAChD,MAAM,WAAW,mCACf,EACE,eACD,EACD,OACD;AAED,KAAI,CAAC,oBAAoB,SAAS,CAChC,OAAM,IAAI,oBAAoB,EAAE,aAAa,SAAS,KAAK,CAAC;AAG9D,aAAY,UAAU,cAAc,QAAQ;AAE5C,QAAO,SAAS,0BAA0B;EAAE;EAAa;EAAe,CAAC;;;;;ACvC3E,MAAM,eAAe;;;;;;;;AASrB,MAAa,oBAAoB,OAC/B,EAAE,QAAQ,WAAW,OAAO,iBAC5B,WACyC;AACzC,KAAI,CAAC,mBAAmB,cAAc,CACpC,OAAM,IAAI,kBAAkB,6CAA6C;CAG3E,MAAM,cAAc,IAAI,aAAa;AAErC,KAAI,OAAO,SAAS;EAGlB,MAAM,EAAE,MAAM,UAAU,OAFN,MAAM,aAAa,EAAE,eAAe,EAAE,OAAO,EAEvB,SAAS;GAC/C,UAAU,MAAM;GAChB,OAAO,cAAc;GACtB,CAAC;AAEF,MAAI,MAAM,WAAW,EACnB,OAAM,IAAI,kBAAkB,kBAAkB;EAGhD,MAAM,eAAe,0BAA0B;GAC7C;GACA,UAAU,MAAM;GACjB,CAAC;EAEF,MAAM,CAAC,QAAQ,YAAY,WAAW,MAAM,GAAG,cAAc,CAC3D,aACD,CAAC;AACF,cAAY,gBAAgB,CAAC,KAAK,EAAE,UAAU;QACzC;EACL,MAAM,OAAO,0BAA0B;GACrC;GACA,UAAU;GACX,CAAC;EAEF,MAAM,CAAC,QAAQ,YAAY,WAAW,YAAY,KAAK,CAAC,KAAK,CAAC;AAC9D,cAAY,gBAAgB,CAAC,KAAK,EAAE,UAAU;;AAQhD,QAAO,EAAE,kBALM,MAAM,0BACnB;EAAE;EAAa;EAAe,EAC9B,OACD,EAEgC,QAAQ"}