@swapkit/toolboxes 6.0.0 → 6.0.1

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @swapkit/toolboxes
 
+## 6.0.1
+
+### Patch Changes
+
+- [#424](https://github.com/swapkit/sdk/pull/424) [`3254bf4`](https://github.com/swapkit/sdk/commit/3254bf4d7496289307c2f22edabf627f63479611) Thanks [@hippocampusSK](https://github.com/hippocampusSK)! - Solana: the payer SOL check for SPL transfers that create the recipient's associated token account is now opt-in. Pass `checkPayerBalance: true` to `createTransaction` or `transfer` to get `toolbox_solana_insufficient_balance` instead of a transaction that fails simulation; by default no extra RPC calls are made and the transaction is returned as before. The recipient token account is still created with `CreateIdempotent`.
+- [#415](https://github.com/swapkit/sdk/pull/415) [`3e3dca0`](https://github.com/swapkit/sdk/commit/3e3dca0aea7625917a797c1a8183c60a47ae5574) Thanks [@github-actions](https://github.com/apps/github-actions)! - Update generated token lists. (via @swapkit/helpers@6.0.1)
+
 ## 6.0.0
 
 ### Major Changes

package/dist/src/solana/index.js

@@ -1 +1 @@
-import{ia as D}from"../../chunk-xdkdc1f0.js";import{ja as m}from"../../chunk-exyqap7m.js";import{PublicKey as T}from"@solana/web3.js";import{AssetValue as A,Chain as y,DerivationPath as F,derivationPathToString as G,getChainConfig as O,getRPCUrl as N,NetworkDerivationPath as L,SwapKitError as p,updateDerivationPath as E}from"@swapkit/helpers";import{match as U,P as B}from"ts-pattern";async function j(n){let e=A.from({address:n,chain:y.Solana});if(e.symbol!=="UNKNOWN")return{decimals:e.decimal||0,id:n,logoURI:e.getIconUrl(),name:e.symbol,symbol:e.ticker};let t=`https://lite-api.jup.ag/tokens/v2/search?query=${encodeURIComponent(n)}`;try{let o=await fetch(t);if(!o.ok)return null;let r=await o.json();if(!Array.isArray(r)||r.length===0)return null;return r.find((a)=>a.id===n)||null}catch{return null}}async function V(n){let e=await w(),{PublicKey:t}=await import("@solana/web3.js"),{TOKEN_PROGRAM_ID:o}=await import("@solana/spl-token"),r=new t(n),{baseDecimal:s}=O(y.Solana),a=await e.getBalance(r),i=[A.from({chain:y.Solana,fromBaseDecimal:s,value:a||0})],c=await e.getParsedTokenAccountsByOwner(r,{programId:o});for(let{account:d}of c.value){let l=d.data.parsed.info,P=l.mint,g=l.tokenAmount.amount;if(Number(g)===0)continue;let u=await j(P),f=u?.symbol||"UNKNOWN",h=u?.decimals||l.tokenAmount.decimals;i.push(A.from({asset:`${y.Solana}.${f}-${P}`,fromBaseDecimal:h,value:g}))}return i}function M(n){try{let e=new T(n);return T.isOnCurve(e.toBytes())}catch{return!1}}function en(n){let e=n&&"index"in n?n.index||0:0,t=G(n&&"derivationPath"in n&&n.derivationPath?n.derivationPath:E(L[y.Solana],{index:e})),o;async function r(){if(o)return o;return o=await U(n).with({phrase:B.string},({phrase:a})=>I({derivationPath:t,phrase:a})).with({signer:B.any},({signer:a})=>a).otherwise(()=>{return}),o}async function s(){let a=await r();return a?.publicKey?R(a.publicKey):""}return{broadcastTransaction:_(w),createKeysForPath:I,createTransaction:K(w),createTransactionFromInstructions:Z,estimateTransactionFee:q(w),getAddress:s,getAddressFromPubKey:R,getBalance:D(y.Solana),getBalanceFromRPC:V,getConnection:w,getPubkeyFromAddress:(a)=>new T(a),signAndBroadcastTransaction:async(a)=>{let i=await x(w,r)(a);return _(w)(i)},signTransaction:x(w,r),transfer:J(w,r),validateAddress:M}}function q(n){return async({recipient:e,assetValue:t,memo:o,isProgramDerivedAddress:r,sender:s})=>{let a=await n(),i=await K(n,{checkPayerBalance:!1})({assetValue:t,isProgramDerivedAddress:r,memo:o,recipient:e,sender:s}),c=await C(a,i),{baseDecimal:d}=O(y.Solana);return A.from({chain:y.Solana,fromBaseDecimal:d,value:c})}}async function C(n,e){let t=await n.getFeeForMessage(e.compileMessage());if(t.value===null)throw new p("toolbox_fee_estimation_failed","Could not estimate Solana fee.");return t.value}async function w(){let{Connection:n}=await import("@solana/web3.js"),e=await N(y.Solana);return new n(e,{commitment:"confirmed",fetchMiddleware:(t,o,r)=>{let s={};for(let[a,i]of Object.entries(o?.headers??{})){let c=a.toLowerCase();if(c!=="pragma"&&c!=="solana-client")s[a]=i}r(t,{...o,headers:s})}})}function W(n){return async({assetValue:e,recipient:t,sender:o,isProgramDerivedAddress:r,sweep:s})=>{let a=new T(o);if(e.isGasAsset){let{Transaction:i,SystemProgram:c}=await import("@solana/web3.js");return new i().add(c.transfer({fromPubkey:a,lamports:s?0:e.getBaseValue("number"),toPubkey:new T(t)}))}if(e.address){let i=await n();return H({amount:s?0:e.getBaseValue("number"),connection:i,decimals:e.decimal,from:a,isProgramDerivedAddress:r,recipient:t,sweep:s,tokenAddress:e.address})}return}}async function H({tokenAddress:n,recipient:e,from:t,connection:o,amount:r,decimals:s,isProgramDerivedAddress:a,sweep:i}){let{getAssociatedTokenAddress:c,getAccount:d,createAssociatedTokenAccountIdempotentInstruction:l,createTransferCheckedInstruction:P}=await import("@solana/spl-token"),{Transaction:g}=await import("@solana/web3.js"),u=new g,f=new T(n),h=await c(f,t),S=new T(e),b=await c(f,S,a),k=!1;try{await d(o,b),k=!0}catch{}if(!k)u.add(l(t,b,S,f));let v=i?BigInt((await o.getTokenAccountBalance(h)).value.amount):r;if(i&&v<=0n)throw new p({errorKey:"toolbox_sweep_amount_too_low",info:{asset:n,balance:v.toString()}});return u.add(P(h,f,b,t,v,s)),u}async function z(n,e,t){let{ACCOUNT_SIZE:o,ASSOCIATED_TOKEN_PROGRAM_ID:r}=await import("@solana/spl-token");if(!e.instructions.some(({programId:P})=>P.equals(r)))return;let[a,i,c,d]=await Promise.all([n.getBalance(t),C(n,e),n.getMinimumBalanceForRentExemption(o),n.getMinimumBalanceForRentExemption(0)]),l=i+c+d;if(a<l)throw new p({errorKey:"toolbox_solana_insufficient_balance",info:{balance:a,fee:i,rentReserve:d,required:l,tokenAccountRent:c}})}function K(n,{checkPayerBalance:e=!0}={}){return async({recipient:t,assetValue:o,memo:r,isProgramDerivedAddress:s,sender:a,recentBlockhash:i,sweep:c})=>{let{createMemoInstruction:d}=await import("@solana/spl-memo"),l=new T(a);if(!(s||M(t)))throw new p("core_transaction_invalid_recipient_address");let P,g=()=>P??=n(),u=await W(g)({assetValue:o,isProgramDerivedAddress:s,recipient:t,sender:a,sweep:c});if(!u)throw new p("core_transaction_invalid_sender_address");if(r)u.add(d(r));if(u.recentBlockhash=i??(await(await g()).getLatestBlockhash()).blockhash,u.feePayer=l,e&&!o.isGasAsset)await z(await g(),u,l);if(c&&o.isGasAsset){let f=await g(),[h,S,b]=await Promise.all([f.getBalance(l),C(f,u),f.getMinimumBalanceForRentExemption(0)]),k=h-S-b;if(k<=0)throw new p({errorKey:"toolbox_sweep_amount_too_low",info:{balance:h,fee:S,rentReserve:b}});let{SystemProgram:v}=await import("@solana/web3.js");u.instructions[0]=v.transfer({fromPubkey:l,lamports:k,toPubkey:new T(t)})}return u}}async function Z({instructions:n}){let{Transaction:e}=await import("@solana/web3.js"),t=new e().add(...n);if(!t)throw new p("core_transaction_invalid_sender_address");return t}function J(n,e){return async({recipient:t,assetValue:o,memo:r,isProgramDerivedAddress:s,sweep:a})=>{let i=await e();if(!i)throw new p("core_transaction_invalid_sender_address");let c=i.publicKey?.toString()??(await i.connect()).publicKey.toString(),d=await K(n)({assetValue:o,isProgramDerivedAddress:s,memo:r,recipient:t,sender:c,sweep:a});if("signTransaction"in i){let l=await i.signTransaction(d);return _(n)(l)}return d.sign(i),_(n)(d)}}function _(n){return async(e)=>(await n()).sendRawTransaction(e.serialize())}function x(n,e){return async(t)=>{let o=await e();if(!o)throw new p("toolbox_solana_no_signer");let{VersionedTransaction:r}=await import("@solana/web3.js");if(!(t instanceof r)){let a=await(await n()).getLatestBlockhash();t.recentBlockhash=a.blockhash,t.feePayer=o.publicKey||void 0}if("connect"in o)return await o.signTransaction(t);return t.sign([o]),t}}async function I({phrase:n,derivationPath:e=F.SOL}){let{HDKey:t}=await import("micro-key-producer/slip10.js"),{mnemonicToSeedSync:o}=await import("@scure/bip39"),{Keypair:r}=await import("@solana/web3.js"),s=o(n),a=t.fromMasterSeed(s);return r.fromSeed(a.derive(e,!0).privateKey)}function R(n){return n.toString()}export{I as createKeysForPath,j as fetchTokenMetaData,en as getSolanaToolbox,M as validateSolanaAddress};
+import{ia as D}from"../../chunk-xdkdc1f0.js";import{ja as d}from"../../chunk-exyqap7m.js";import{PublicKey as P}from"@solana/web3.js";import{AssetValue as A,Chain as p,DerivationPath as F,derivationPathToString as G,getChainConfig as O,getRPCUrl as N,NetworkDerivationPath as L,SwapKitError as T,updateDerivationPath as E}from"@swapkit/helpers";import{match as U,P as B}from"ts-pattern";async function j(n){let e=A.from({address:n,chain:p.Solana});if(e.symbol!=="UNKNOWN")return{decimals:e.decimal||0,id:n,logoURI:e.getIconUrl(),name:e.symbol,symbol:e.ticker};let t=`https://lite-api.jup.ag/tokens/v2/search?query=${encodeURIComponent(n)}`;try{let o=await fetch(t);if(!o.ok)return null;let r=await o.json();if(!Array.isArray(r)||r.length===0)return null;return r.find((a)=>a.id===n)||null}catch{return null}}async function V(n){let e=await w(),{PublicKey:t}=await import("@solana/web3.js"),{TOKEN_PROGRAM_ID:o}=await import("@solana/spl-token"),r=new t(n),{baseDecimal:i}=O(p.Solana),a=await e.getBalance(r),c=[A.from({chain:p.Solana,fromBaseDecimal:i,value:a||0})],s=await e.getParsedTokenAccountsByOwner(r,{programId:o});for(let{account:m}of s.value){let l=m.data.parsed.info,f=l.mint,y=l.tokenAmount.amount;if(Number(y)===0)continue;let u=await j(f),g=u?.symbol||"UNKNOWN",h=u?.decimals||l.tokenAmount.decimals;c.push(A.from({asset:`${p.Solana}.${g}-${f}`,fromBaseDecimal:h,value:y}))}return c}function M(n){try{let e=new P(n);return P.isOnCurve(e.toBytes())}catch{return!1}}function en(n){let e=n&&"index"in n?n.index||0:0,t=G(n&&"derivationPath"in n&&n.derivationPath?n.derivationPath:E(L[p.Solana],{index:e})),o;async function r(){if(o)return o;return o=await U(n).with({phrase:B.string},({phrase:a})=>I({derivationPath:t,phrase:a})).with({signer:B.any},({signer:a})=>a).otherwise(()=>{return}),o}async function i(){let a=await r();return a?.publicKey?R(a.publicKey):""}return{broadcastTransaction:_(w),createKeysForPath:I,createTransaction:K(w),createTransactionFromInstructions:Z,estimateTransactionFee:q(w),getAddress:i,getAddressFromPubKey:R,getBalance:D(p.Solana),getBalanceFromRPC:V,getConnection:w,getPubkeyFromAddress:(a)=>new P(a),signAndBroadcastTransaction:async(a)=>{let c=await x(w,r)(a);return _(w)(c)},signTransaction:x(w,r),transfer:J(w,r),validateAddress:M}}function q(n){return async({recipient:e,assetValue:t,memo:o,isProgramDerivedAddress:r,sender:i})=>{let a=await n(),c=await K(n)({assetValue:t,isProgramDerivedAddress:r,memo:o,recipient:e,sender:i}),s=await C(a,c),{baseDecimal:m}=O(p.Solana);return A.from({chain:p.Solana,fromBaseDecimal:m,value:s})}}async function C(n,e){let t=await n.getFeeForMessage(e.compileMessage());if(t.value===null)throw new T("toolbox_fee_estimation_failed","Could not estimate Solana fee.");return t.value}async function w(){let{Connection:n}=await import("@solana/web3.js"),e=await N(p.Solana);return new n(e,{commitment:"confirmed",fetchMiddleware:(t,o,r)=>{let i={};for(let[a,c]of Object.entries(o?.headers??{})){let s=a.toLowerCase();if(s!=="pragma"&&s!=="solana-client")i[a]=c}r(t,{...o,headers:i})}})}function W(n){return async({assetValue:e,recipient:t,sender:o,isProgramDerivedAddress:r,sweep:i})=>{let a=new P(o);if(e.isGasAsset){let{Transaction:c,SystemProgram:s}=await import("@solana/web3.js");return new c().add(s.transfer({fromPubkey:a,lamports:i?0:e.getBaseValue("number"),toPubkey:new P(t)}))}if(e.address){let c=await n();return H({amount:i?0:e.getBaseValue("number"),connection:c,decimals:e.decimal,from:a,isProgramDerivedAddress:r,recipient:t,sweep:i,tokenAddress:e.address})}return}}async function H({tokenAddress:n,recipient:e,from:t,connection:o,amount:r,decimals:i,isProgramDerivedAddress:a,sweep:c}){let{getAssociatedTokenAddress:s,getAccount:m,createAssociatedTokenAccountIdempotentInstruction:l,createTransferCheckedInstruction:f}=await import("@solana/spl-token"),{Transaction:y}=await import("@solana/web3.js"),u=new y,g=new P(n),h=await s(g,t),S=new P(e),b=await s(g,S,a),k=!1;try{await m(o,b),k=!0}catch{}if(!k)u.add(l(t,b,S,g));let v=c?BigInt((await o.getTokenAccountBalance(h)).value.amount):r;if(c&&v<=0n)throw new T({errorKey:"toolbox_sweep_amount_too_low",info:{asset:n,balance:v.toString()}});return u.add(f(h,g,b,t,v,i)),u}async function z(n,e,t){let{ACCOUNT_SIZE:o,ASSOCIATED_TOKEN_PROGRAM_ID:r}=await import("@solana/spl-token");if(!e.instructions.some(({programId:f})=>f.equals(r)))return;let[a,c,s,m]=await Promise.all([n.getBalance(t),C(n,e),n.getMinimumBalanceForRentExemption(o),n.getMinimumBalanceForRentExemption(0)]),l=c+s+m;if(a<l)throw new T({errorKey:"toolbox_solana_insufficient_balance",info:{balance:a,fee:c,rentReserve:m,required:l,tokenAccountRent:s}})}function K(n){return async({checkPayerBalance:e=!1,recipient:t,assetValue:o,memo:r,isProgramDerivedAddress:i,sender:a,recentBlockhash:c,sweep:s})=>{let{createMemoInstruction:m}=await import("@solana/spl-memo"),l=new P(a);if(!(i||M(t)))throw new T("core_transaction_invalid_recipient_address");let f,y=()=>f??=n(),u=await W(y)({assetValue:o,isProgramDerivedAddress:i,recipient:t,sender:a,sweep:s});if(!u)throw new T("core_transaction_invalid_sender_address");if(r)u.add(m(r));if(u.recentBlockhash=c??(await(await y()).getLatestBlockhash()).blockhash,u.feePayer=l,e&&!o.isGasAsset)await z(await y(),u,l);if(s&&o.isGasAsset){let g=await y(),[h,S,b]=await Promise.all([g.getBalance(l),C(g,u),g.getMinimumBalanceForRentExemption(0)]),k=h-S-b;if(k<=0)throw new T({errorKey:"toolbox_sweep_amount_too_low",info:{balance:h,fee:S,rentReserve:b}});let{SystemProgram:v}=await import("@solana/web3.js");u.instructions[0]=v.transfer({fromPubkey:l,lamports:k,toPubkey:new P(t)})}return u}}async function Z({instructions:n}){let{Transaction:e}=await import("@solana/web3.js"),t=new e().add(...n);if(!t)throw new T("core_transaction_invalid_sender_address");return t}function J(n,e){return async({recipient:t,assetValue:o,checkPayerBalance:r,memo:i,isProgramDerivedAddress:a,sweep:c})=>{let s=await e();if(!s)throw new T("core_transaction_invalid_sender_address");let m=s.publicKey?.toString()??(await s.connect()).publicKey.toString(),l=await K(n)({assetValue:o,checkPayerBalance:r,isProgramDerivedAddress:a,memo:i,recipient:t,sender:m,sweep:c});if("signTransaction"in s){let f=await s.signTransaction(l);return _(n)(f)}return l.sign(s),_(n)(l)}}function _(n){return async(e)=>(await n()).sendRawTransaction(e.serialize())}function x(n,e){return async(t)=>{let o=await e();if(!o)throw new T("toolbox_solana_no_signer");let{VersionedTransaction:r}=await import("@solana/web3.js");if(!(t instanceof r)){let a=await(await n()).getLatestBlockhash();t.recentBlockhash=a.blockhash,t.feePayer=o.publicKey||void 0}if("connect"in o)return await o.signTransaction(t);return t.sign([o]),t}}async function I({phrase:n,derivationPath:e=F.SOL}){let{HDKey:t}=await import("micro-key-producer/slip10.js"),{mnemonicToSeedSync:o}=await import("@scure/bip39"),{Keypair:r}=await import("@solana/web3.js"),i=o(n),a=t.fromMasterSeed(i);return r.fromSeed(a.derive(e,!0).privateKey)}function R(n){return n.toString()}export{I as createKeysForPath,j as fetchTokenMetaData,en as getSolanaToolbox,M as validateSolanaAddress};

package/dist/types/solana/index.d.ts

@@ -15,10 +15,13 @@ export interface SolanaProvider {
     signTransaction: <T extends Transaction | VersionedTransaction = Transaction>(transaction: T) => Promise<T>;
 }
 export type SolanaCreateTransactionParams = Omit<GenericCreateTransactionParams, "feeRate"> & {
+    /** Rejects SPL transfers whose SOL can't cover the fee and the recipient token account rent. Off by default. */
+    checkPayerBalance?: boolean;
     isProgramDerivedAddress?: boolean;
     /** Pre-fetched recent blockhash; when provided, skips the getLatestBlockhash round-trip. */
     recentBlockhash?: string;
 };
 export type SolanaTransferParams = Omit<GenericTransferParams, "feeRate"> & {
+    checkPayerBalance?: boolean;
     isProgramDerivedAddress?: boolean;
 };

package/dist/types/solana/toolbox.d.ts

@@ -23,7 +23,7 @@ export declare function getSolanaToolbox(toolboxParams?: {
 }): {
     broadcastTransaction: (transaction: Transaction | VersionedTransaction) => Promise<string>;
     createKeysForPath: typeof createKeysForPath;
-    createTransaction: ({ recipient, assetValue, memo, isProgramDerivedAddress, sender, recentBlockhash, sweep, }: SolanaCreateTransactionParams) => Promise<Transaction>;
+    createTransaction: ({ checkPayerBalance, recipient, assetValue, memo, isProgramDerivedAddress, sender, recentBlockhash, sweep, }: SolanaCreateTransactionParams) => Promise<Transaction>;
     createTransactionFromInstructions: typeof createTransactionFromInstructions;
     estimateTransactionFee: ({ recipient, assetValue, memo, isProgramDerivedAddress, sender, }: Omit<GenericCreateTransactionParams, "feeRate"> & {
         isProgramDerivedAddress?: boolean;
@@ -36,7 +36,7 @@ export declare function getSolanaToolbox(toolboxParams?: {
     getPubkeyFromAddress: (address: string) => PublicKey;
     signAndBroadcastTransaction: (transaction: Transaction | VersionedTransaction) => Promise<string>;
     signTransaction: (transaction: Transaction | VersionedTransaction) => Promise<Transaction | VersionedTransaction>;
-    transfer: ({ recipient, assetValue, memo, isProgramDerivedAddress, sweep }: SolanaTransferParams) => Promise<string>;
+    transfer: ({ recipient, assetValue, checkPayerBalance, memo, isProgramDerivedAddress, sweep, }: SolanaTransferParams) => Promise<string>;
     validateAddress: typeof validateSolanaAddress;
 };
 declare function getConnection(): Promise<Connection>;

package/package.json

@@ -1,5 +1,5 @@
 {
-  "dependencies": { "@swapkit/helpers": "6.0.0", "@swapkit/utxo-signer": "3.1.0" },
+  "dependencies": { "@swapkit/helpers": "6.0.1", "@swapkit/utxo-signer": "3.1.0" },
   "description": "SwapKit - Toolboxes",
   "devDependencies": {
     "@aptos-labs/ts-sdk": "7.0.1",
@@ -131,5 +131,5 @@
     "type-check:go": "tsgo"
   },
   "type": "module",
-  "version": "6.0.0"
+  "version": "6.0.1"
 }