@tuwaio/pulsar-core 0.8.2 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/index.d.mts +10 -7
- package/dist/index.d.ts +10 -7
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -26,7 +26,7 @@ pnpm add @tuwaio/pulsar-core @tuwaio/orbit-core zustand immer dayjs
|
|
|
26
26
|
```
|
|
27
27
|
|
|
28
28
|
> [!IMPORTANT]
|
|
29
|
-
> `@tuwaio/orbit-core` (>=0.
|
|
29
|
+
> `@tuwaio/orbit-core` (>=0.4), `zustand` (5.x), `immer` (11.x) and `dayjs` (1.x) are peer dependencies and must be installed alongside `@tuwaio/pulsar-core`. Add [`@tuwaio/pulsar-evm`](https://pulsar.docs.tuwa.io/packages/pulsar-evm) and/or [`@tuwaio/pulsar-solana`](https://pulsar.docs.tuwa.io/packages/pulsar-solana) for the chain adapters, and [`@tuwaio/pulsar-react`](https://pulsar.docs.tuwa.io/packages/pulsar-react) for React apps.
|
|
30
30
|
|
|
31
31
|
---
|
|
32
32
|
|
package/dist/index.d.mts
CHANGED
|
@@ -56,8 +56,10 @@ type ActionTxKey = `0x${string}` | string;
|
|
|
56
56
|
*/
|
|
57
57
|
type BaseTransaction = {
|
|
58
58
|
/**
|
|
59
|
-
* The chain of the transaction: the numeric chain ID for EVM (for example `1`), or
|
|
60
|
-
* (for example `solana:devnet
|
|
59
|
+
* The chain of the transaction: the numeric chain ID for EVM (for example `1`), or the CAIP-2 chain ID with the
|
|
60
|
+
* genesis hash for Solana (for example `solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1` for devnet). `executeTxAction` derives
|
|
61
|
+
* it from `desiredChainID` with `setChainId` from `@tuwaio/orbit-core`. Transactions saved by Pulsar 0.8.3 and earlier
|
|
62
|
+
* keep `solana:<cluster>` (for example `solana:devnet`); the trackers and explorer links read both forms.
|
|
61
63
|
*/
|
|
62
64
|
chainId: number | string;
|
|
63
65
|
/**
|
|
@@ -230,7 +232,8 @@ type InitialTransactionParams = Pick<BaseTransaction, 'description' | 'title' |
|
|
|
230
232
|
actionFunction: (...args: unknown[]) => Promise<ActionTxKey | undefined>;
|
|
231
233
|
/**
|
|
232
234
|
* The chain the transaction must be sent on: a numeric chain ID for EVM (the wallet is asked to switch if needed),
|
|
233
|
-
* or a cluster
|
|
235
|
+
* or a Solana cluster (compared with the cluster of the connected wallet) as a moniker such as `'devnet'`, a Wallet
|
|
236
|
+
* Standard chain such as `'solana:devnet'` or a CAIP-2 chain ID with the genesis hash.
|
|
234
237
|
*/
|
|
235
238
|
desiredChainID: number | string;
|
|
236
239
|
/** When `true`, the transaction is created with `isTrackedModalOpen: true`. */
|
|
@@ -588,8 +591,8 @@ type ITxInMemoryStore<T extends Transaction> = {
|
|
|
588
591
|
*/
|
|
589
592
|
fetchInitial: (walletAddress: string) => Promise<void>;
|
|
590
593
|
/**
|
|
591
|
-
* Merges a local pool into the in-memory pool. Transactions that are `Success` or `Replaced` in memory are
|
|
592
|
-
* pending ones are overwritten only by a terminal transaction or one with more confirmations.
|
|
594
|
+
* Merges a local pool into the in-memory pool. Transactions that are `Success`, `Failed` or `Replaced` in memory are
|
|
595
|
+
* kept; pending ones are overwritten only by a terminal transaction or one with more confirmations.
|
|
593
596
|
* @param localPool - The pool of the persistent store, usually from its `subscribe` listener.
|
|
594
597
|
*/
|
|
595
598
|
syncWithLocalPool: (localPool: TransactionPool<T>) => void;
|
|
@@ -716,8 +719,8 @@ declare const selectPendingTransactionsByActiveWallet: <T extends Transaction>(t
|
|
|
716
719
|
* with the local pool of the persistent store. Nothing in it is persisted. Keep it in sync with the persistent store by
|
|
717
720
|
* calling `syncWithLocalPool` from that store's `subscribe` listener.
|
|
718
721
|
*
|
|
719
|
-
* Merge rules: a transaction that is `Success` or `Replaced` in memory is never overwritten; a pending one
|
|
720
|
-
* overwritten only by a terminal transaction or by one with more confirmations; any other one is overwritten.
|
|
722
|
+
* Merge rules: a transaction that is `Success`, `Failed` or `Replaced` in memory is never overwritten; a pending one
|
|
723
|
+
* is overwritten only by a terminal transaction or by one with more confirmations; any other one is overwritten.
|
|
721
724
|
*
|
|
722
725
|
* History pages are validated like `injectExternalPendingTxs` does: transactions whose title, description or payload
|
|
723
726
|
* break the safety limits are skipped with a warning and are not passed to `onHistoryFetched`.
|
package/dist/index.d.ts
CHANGED
|
@@ -56,8 +56,10 @@ type ActionTxKey = `0x${string}` | string;
|
|
|
56
56
|
*/
|
|
57
57
|
type BaseTransaction = {
|
|
58
58
|
/**
|
|
59
|
-
* The chain of the transaction: the numeric chain ID for EVM (for example `1`), or
|
|
60
|
-
* (for example `solana:devnet
|
|
59
|
+
* The chain of the transaction: the numeric chain ID for EVM (for example `1`), or the CAIP-2 chain ID with the
|
|
60
|
+
* genesis hash for Solana (for example `solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1` for devnet). `executeTxAction` derives
|
|
61
|
+
* it from `desiredChainID` with `setChainId` from `@tuwaio/orbit-core`. Transactions saved by Pulsar 0.8.3 and earlier
|
|
62
|
+
* keep `solana:<cluster>` (for example `solana:devnet`); the trackers and explorer links read both forms.
|
|
61
63
|
*/
|
|
62
64
|
chainId: number | string;
|
|
63
65
|
/**
|
|
@@ -230,7 +232,8 @@ type InitialTransactionParams = Pick<BaseTransaction, 'description' | 'title' |
|
|
|
230
232
|
actionFunction: (...args: unknown[]) => Promise<ActionTxKey | undefined>;
|
|
231
233
|
/**
|
|
232
234
|
* The chain the transaction must be sent on: a numeric chain ID for EVM (the wallet is asked to switch if needed),
|
|
233
|
-
* or a cluster
|
|
235
|
+
* or a Solana cluster (compared with the cluster of the connected wallet) as a moniker such as `'devnet'`, a Wallet
|
|
236
|
+
* Standard chain such as `'solana:devnet'` or a CAIP-2 chain ID with the genesis hash.
|
|
234
237
|
*/
|
|
235
238
|
desiredChainID: number | string;
|
|
236
239
|
/** When `true`, the transaction is created with `isTrackedModalOpen: true`. */
|
|
@@ -588,8 +591,8 @@ type ITxInMemoryStore<T extends Transaction> = {
|
|
|
588
591
|
*/
|
|
589
592
|
fetchInitial: (walletAddress: string) => Promise<void>;
|
|
590
593
|
/**
|
|
591
|
-
* Merges a local pool into the in-memory pool. Transactions that are `Success` or `Replaced` in memory are
|
|
592
|
-
* pending ones are overwritten only by a terminal transaction or one with more confirmations.
|
|
594
|
+
* Merges a local pool into the in-memory pool. Transactions that are `Success`, `Failed` or `Replaced` in memory are
|
|
595
|
+
* kept; pending ones are overwritten only by a terminal transaction or one with more confirmations.
|
|
593
596
|
* @param localPool - The pool of the persistent store, usually from its `subscribe` listener.
|
|
594
597
|
*/
|
|
595
598
|
syncWithLocalPool: (localPool: TransactionPool<T>) => void;
|
|
@@ -716,8 +719,8 @@ declare const selectPendingTransactionsByActiveWallet: <T extends Transaction>(t
|
|
|
716
719
|
* with the local pool of the persistent store. Nothing in it is persisted. Keep it in sync with the persistent store by
|
|
717
720
|
* calling `syncWithLocalPool` from that store's `subscribe` listener.
|
|
718
721
|
*
|
|
719
|
-
* Merge rules: a transaction that is `Success` or `Replaced` in memory is never overwritten; a pending one
|
|
720
|
-
* overwritten only by a terminal transaction or by one with more confirmations; any other one is overwritten.
|
|
722
|
+
* Merge rules: a transaction that is `Success`, `Failed` or `Replaced` in memory is never overwritten; a pending one
|
|
723
|
+
* is overwritten only by a terminal transaction or by one with more confirmations; any other one is overwritten.
|
|
721
724
|
*
|
|
722
725
|
* History pages are validated like `injectExternalPendingTxs` does: transactions whose title, description or payload
|
|
723
726
|
* break the safety limits are skipped with a warning and are not passed to `onHistoryFetched`.
|
package/dist/index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
'use strict';var immer=require('immer'),vanilla=require('zustand/vanilla'),orbitCore=require('@tuwaio/orbit-core'),ce=require('dayjs'),middleware=require('zustand/middleware'),zustand=require('zustand');function _interopDefault(e){return e&&e.__esModule?e:{default:e}}var ce__default=/*#__PURE__*/_interopDefault(ce);var ee=(p=>(p.Ethereum="ethereum",p.Safe="safe",p.Gelato="gelato",p.Solana="solana",p.ERC4337="erc4337",p))(ee||{}),K=(l=>(l.Failed="Failed",l.Success="Success",l.Replaced="Replaced",l))(K||{});var U=100,B=300,N=10*1024,ne=[/\beval\s*\(/i,/\bFunction\s*\(/,/\bset(?:Timeout|Interval)\s*\(\s*['"`]/i,/javascript\s*:/i],P=class extends Error{field;constructor(e,o){super(o),this.name="PulsarTransactionValidationError",this.field=e;}};function $(n){w({field:"title",value:n.title,maxLength:U}),w({field:"description",value:n.description,maxLength:B}),j(n.payload);}function S(n){w({field:"title",value:n.title,maxLength:U}),w({field:"description",value:n.description,maxLength:B}),j(n.payload);}function w({field:n,value:e,maxLength:o}){if(e===void 0)return;(Array.isArray(e)?e:[e]).forEach((d,p)=>{let T=Array.isArray(e)?`${n}[${p}]`:n;if(typeof d!="string")throw new P(T,`${T} must be a string.`);if(d.length>o)throw new P(T,`${T} must be ${o} characters or less.`);O(T,d);});}function j(n){if(n===void 0)return;let e;try{e=JSON.stringify(n);}catch{throw new P("payload","payload must be JSON-serializable.")}if(e===void 0)throw new P("payload","payload must be JSON-serializable.");if(new TextEncoder().encode(e).length>N)throw new P("payload",`payload must be ${N} bytes or less when serialized.`);_(n);}function _(n,e="payload"){if(typeof n=="string"){O(e,n);return}n===null||typeof n!="object"||Object.entries(n).forEach(([o,l])=>{let d=`${e}.${o}`;O(d,o),_(l,d);});}function O(n,e){if(ne.some(o=>o.test(e)))throw new P(n,`${n} contains a blocked executable-like pattern.`)}function te(n){let e={...n};return delete e.pimlicoApiKey,delete e.gelatoApiKey,e}function G({maxTransactions:n,onRemoteCreate:e}){let o=false,l=new Set;return (d,p)=>{let T=async(t,r)=>{let s=p().transactionsPool[t];if(!(!e||!s||l.has(t))){l.add(t);try{await e(te(s)),d(a=>immer.produce(a,i=>{let c=i.transactionsPool[t];c&&(c.syncStatus="synced"),i.unsyncedTxKeys&&delete i.unsyncedTxKeys[t];}));}catch(a){console.warn(r,a);}finally{l.delete(t);}}};return {transactionsPool:{},lastAddedTxKey:void 0,initialTx:void 0,unsyncedTxKeys:{},reconcileUnsyncedTransactions:async()=>{if(!e||o)return;let t=Object.keys(p().unsyncedTxKeys||{});if(t.length!==0){o=true;try{for(let r of t){if(!p().transactionsPool[r]){d(s=>immer.produce(s,a=>{a.unsyncedTxKeys&&delete a.unsyncedTxKeys[r];}));continue}await T(r,`[Pulsar] Failed to reconcile tx ${r}:`);}}finally{o=false;}}},addTxToPool:t=>{S(t);let r={...t,pending:true,...e&&{syncStatus:"pending-sync"}};return d(s=>immer.produce(s,a=>{if(a.lastAddedTxKey=t.txKey,t.txKey){if(e&&(a.unsyncedTxKeys||(a.unsyncedTxKeys={}),a.unsyncedTxKeys[t.txKey]=true),Object.keys(a.transactionsPool).length>=n){let c=Object.values(a.transactionsPool).sort((x,y)=>x.localTimestamp-y.localTimestamp);if(c.length>0){let x=c[0];delete a.transactionsPool[x.txKey];}}a.transactionsPool[t.txKey]=r;}})),e&&t.txKey&&T(t.txKey,"[Pulsar] onRemoteCreate failed, transaction queued for background sync:"),Promise.resolve()},updateTxParams:(t,r)=>{d(a=>immer.produce(a,i=>{let c=i.transactionsPool[t];c&&Object.assign(c,r);})),(r.status==="Success"||r.status==="Failed"||r.status==="Replaced")&&p().reconcileUnsyncedTransactions&&p().unsyncedTxKeys?.[t]&&p().reconcileUnsyncedTransactions().catch(a=>{console.error("[Pulsar] Terminal reconciliation failed:",a);});},removeTxFromPool:t=>{d(r=>immer.produce(r,s=>{delete s.transactionsPool[t];}));},closeTxTrackedModal:t=>{d(r=>immer.produce(r,s=>{if(t&&s.transactionsPool[t]){let a=s.transactionsPool[t];s.transactionsPool[t]={...a,isTrackedModalOpen:false};}s.initialTx=void 0;}));},getLastTxKey:()=>p().lastAddedTxKey}}}var D=n=>Object.values(n).sort((e,o)=>Number(e.localTimestamp)-Number(o.localTimestamp)),ke=n=>D(n).filter(e=>e.pending),ve=(n,e)=>n[e],re=(n,e)=>D(n).filter(o=>o.from.toLowerCase()===e.toLowerCase()),Ie=(n,e)=>re(n,e).filter(o=>o.pending);var{produce:q}=new immer.Immer({autoFreeze:false}),ae=n=>n.filter(e=>{try{return S(e),!0}catch(o){return console.warn("[Pulsar] Skipped invalid transaction from history:",o),false}}),X=n=>n==="Success"||n==="Replaced",H=(n,e)=>{let o=n[e.txKey];if(o){if(X(o.status))return false;if(o.pending){if(X(e.status))return n[e.txKey]={...o,...e},true;let l=typeof e.confirmations=="number"?e.confirmations:0,d=typeof o.confirmations=="number"?o.confirmations:0;return l>d?(n[e.txKey]={...o,...e},true):false}}return n[e.txKey]=e,true};function Me({localTransactionsPool:n,reconcileUnsyncedTransactions:e,getHistory:o,onHistoryFetched:l}){let d=T=>({isLoading:T,isError:false}),p=T=>{if(!T)return {isLoading:false};let t=ae(T.docs);return l&&queueMicrotask(()=>l(t)),r=>q(r,s=>{let a=s.transactionsPool;for(let i of t)H(a,i);s.currentPage=T.page,s.hasMore=T.hasNextPage,s.isLoading=false;})};return vanilla.createStore()((T,t)=>({transactionsPool:n,isLoading:false,isError:false,hasMore:false,currentPage:1,syncWithLocalPool:r=>{T(s=>q(s,a=>{let i=a.transactionsPool;for(let c of Object.values(r))H(i,c);}));},fetchInitial:async r=>{if(!(!o||!r)){T(d(true)),e&&await e();try{let s=await o({page:1,walletAddress:r});T(p(s));}catch(s){console.error("[Pulsar] Failed to fetch initial transaction history:",s),T({isLoading:false,isError:true});}}},fetchNextPage:async r=>{let{hasMore:s,isLoading:a,currentPage:i}=t();if(!(!o||!s||a||!r)){T(d(true));try{let c=i+1,x=await o({page:c,walletAddress:r});T(p(x));}catch(c){console.error(`[Pulsar] Failed to fetch transaction history page ${i+1}:`,c),T({isLoading:false,isError:true});}}}}))}function Ye({adapter:n,maxTransactions:e=50,onRemoteCreate:o,gelatoApiKey:l,beforeTxProcess:d,abortOnTxError:p,...T}){return vanilla.createStore()(middleware.persist((t,r)=>({...G({maxTransactions:e,onRemoteCreate:o})(t,r),getAdapter:()=>n,initializeTransactionsPool:async()=>{let a=Object.values(r().transactionsPool).filter(i=>i.pending).filter(i=>{try{return S(i),!0}catch(c){return console.warn("[Pulsar] Removed invalid persisted transaction:",c),r().removeTxFromPool(i.txKey),false}});await Promise.all(a.map(i=>orbitCore.selectAdapterByKey({adapterKey:i.adapter,adapter:n})?.checkAndInitializeTrackerInStore({tx:i,gelatoApiKey:l,...r()})));},injectExternalPendingTxs:async s=>{let i=r().getAdapter(),c=[],x=s.filter(y=>{try{return S(y),!0}catch(m){return console.warn("[Pulsar] Skipped invalid remote transaction:",m),false}});t(y=>immer.produce(y,m=>{let b=m.transactionsPool;x.forEach(u=>{let g=b[u.txKey];u.pending&&!g&&(b[u.txKey]=u,c.push(u));let I=u.status==="Success"||u.status==="Failed"||u.status==="Replaced";g?.pending&&I&&(g.status=u.status,g.pending=false,u.txKey&&(g.txKey=u.txKey),u.finishedTimestamp&&(g.finishedTimestamp=u.finishedTimestamp));});})),c.length>0&&await Promise.all(c.map(y=>orbitCore.selectAdapterByKey({adapterKey:y.adapter,adapter:i})?.checkAndInitializeTrackerInStore({tx:y,gelatoApiKey:l,...r()})));},executeTxAction:async({defaultTracker:s,actionFunction:a,params:i,beforeTxProcess:c,abortOnTxError:x,...y})=>{let m=x??p??true,b=ce__default.default().unix();r().reconcileUnsyncedTransactions().catch(f=>console.error("[Pulsar] Reconciliation failed:",f)),$(i);let{desiredChainID:u,tracker:g,...I}=i,{onSuccess:W,onError:J,onReplaced:Y}=y;t({initialTx:{...i,actionFunction:a,localTimestamp:b,isInitializing:true}});let k=orbitCore.selectAdapterByKey({adapterKey:I.adapter,adapter:n}),z=f=>{t(E=>immer.produce(E,h=>{h.initialTx&&(h.initialTx.isInitializing=false,h.initialTx.error=orbitCore.normalizeError(f));}));};if(!k){let f=new Error("No adapter found for this transaction.");throw z(f),f}try{let{connectorType:f,walletAddress:E}=k.getConnectorInfo();await k.checkChainForTx(u);try{await(c??d)?.();}catch(v){if(m)throw t({initialTx:{...i,actionFunction:a,localTimestamp:b,isInitializing:!1,error:orbitCore.normalizeError(v)}}),v;console.warn("[Pulsar] beforeTxProcess failed:",v);}let h=await a();if(!h){t({initialTx:void 0});return}let{tracker:M,txKey:R}=k.checkTransactionsTracker({actionTxKey:h,connectorType:f,tracker:g,gelatoApiKey:i.gelatoApiKey??l,bundlerUrl:i.bundlerUrl,pimlicoApiKey:i.pimlicoApiKey}),Q={...I,connectorType:f,from:E,tracker:M||s,chainId:orbitCore.setChainId(u),localTimestamp:b,txKey:R,bundlerUrl:i.bundlerUrl,pimlicoApiKey:i.pimlicoApiKey,hash:M==="ethereum"?h:void 0,pending:!1,isTrackedModalOpen:i.withTrackedModal};await r().addTxToPool(Q),t(v=>immer.produce(v,F=>{F.initialTx&&(F.initialTx.isInitializing=!1,F.initialTx.lastTxKey=R);}));let Z=r().transactionsPool[R];await k.checkAndInitializeTrackerInStore({tx:Z,onSuccess:W,onError:J,onReplaced:Y,gelatoApiKey:l,...r()});}catch(f){throw z(f),f}}}),{partialize:t=>{let r={...t};return delete r.initialTx,r},merge:(t,r)=>({...r,...t,initialTx:r.initialTx}),...T}))}var nn=(n=>e=>zustand.useStore(n,e));function rn({tx:n,transactionsPool:e,updateTxParams:o}){let l=e[n.txKey];return d=>(o(n.txKey,d),l&&(l={...l,...d}),l)}var pe=5e3,ue=10;function an(n){let{tx:e,fetcher:o,onInitialize:l,onSuccess:d,onFailure:p,onIntervalTick:T,onReplaced:t,removeTxFromPool:r,pollingInterval:s=pe,maxRetries:a=ue}=n;if(!e.pending)return;l?.();let i=a,c=true,x=m=>{c&&(c=false,r&&!m?.withoutRemoving&&r(e.txKey));};(async()=>{for(;c&&i>0;)try{if(await new Promise(m=>setTimeout(m,s)),!c)break;await o({tx:e,stopPolling:x,onSuccess:d,onFailure:p,onIntervalTick:T,onReplaced:t}),i=a;}catch(m){console.error(`Polling fetcher for txKey ${e.txKey} threw an error:`,m),i--;}i<=0&&(console.warn(`Polling for txKey ${e.txKey} stopped after reaching the maximum number of retries.`),p(),x());})();}exports.MAX_TRANSACTION_DESCRIPTION_LENGTH=B;exports.MAX_TRANSACTION_PAYLOAD_BYTES=N;exports.MAX_TRANSACTION_TITLE_LENGTH=U;exports.PulsarTransactionValidationError=P;exports.TransactionStatus=K;exports.TransactionTracker=ee;exports.createBoundedUseStore=nn;exports.createPulsarStore=Ye;exports.createTxInMemoryStore=Me;exports.createTxUpdater=rn;exports.initializePollingTracker=an;exports.initializeTxTrackingStore=G;exports.selectAllTransactions=D;exports.selectAllTransactionsByActiveWallet=re;exports.selectPendingTransactions=ke;exports.selectPendingTransactionsByActiveWallet=Ie;exports.selectTxByKey=ve;exports.validateInitialTransactionParams=$;exports.validateTransaction=S;
|
|
1
|
+
'use strict';var immer=require('immer'),vanilla=require('zustand/vanilla'),orbitCore=require('@tuwaio/orbit-core'),ce=require('dayjs'),middleware=require('zustand/middleware'),zustand=require('zustand');function _interopDefault(e){return e&&e.__esModule?e:{default:e}}var ce__default=/*#__PURE__*/_interopDefault(ce);var ee=(p=>(p.Ethereum="ethereum",p.Safe="safe",p.Gelato="gelato",p.Solana="solana",p.ERC4337="erc4337",p))(ee||{}),K=(l=>(l.Failed="Failed",l.Success="Success",l.Replaced="Replaced",l))(K||{});var U=100,B=300,N=10*1024,ne=[/\beval\s*\(/i,/\bFunction\s*\(/,/\bset(?:Timeout|Interval)\s*\(\s*['"`]/i,/javascript\s*:/i],P=class extends Error{field;constructor(e,o){super(o),this.name="PulsarTransactionValidationError",this.field=e;}};function $(n){w({field:"title",value:n.title,maxLength:U}),w({field:"description",value:n.description,maxLength:B}),j(n.payload);}function S(n){w({field:"title",value:n.title,maxLength:U}),w({field:"description",value:n.description,maxLength:B}),j(n.payload);}function w({field:n,value:e,maxLength:o}){if(e===void 0)return;(Array.isArray(e)?e:[e]).forEach((d,p)=>{let T=Array.isArray(e)?`${n}[${p}]`:n;if(typeof d!="string")throw new P(T,`${T} must be a string.`);if(d.length>o)throw new P(T,`${T} must be ${o} characters or less.`);O(T,d);});}function j(n){if(n===void 0)return;let e;try{e=JSON.stringify(n);}catch{throw new P("payload","payload must be JSON-serializable.")}if(e===void 0)throw new P("payload","payload must be JSON-serializable.");if(new TextEncoder().encode(e).length>N)throw new P("payload",`payload must be ${N} bytes or less when serialized.`);_(n);}function _(n,e="payload"){if(typeof n=="string"){O(e,n);return}n===null||typeof n!="object"||Object.entries(n).forEach(([o,l])=>{let d=`${e}.${o}`;O(d,o),_(l,d);});}function O(n,e){if(ne.some(o=>o.test(e)))throw new P(n,`${n} contains a blocked executable-like pattern.`)}function te(n){let e={...n};return delete e.pimlicoApiKey,delete e.gelatoApiKey,e}function G({maxTransactions:n,onRemoteCreate:e}){let o=false,l=new Set;return (d,p)=>{let T=async(t,r)=>{let s=p().transactionsPool[t];if(!(!e||!s||l.has(t))){l.add(t);try{await e(te(s)),d(a=>immer.produce(a,i=>{let c=i.transactionsPool[t];c&&(c.syncStatus="synced"),i.unsyncedTxKeys&&delete i.unsyncedTxKeys[t];}));}catch(a){console.warn(r,a);}finally{l.delete(t);}}};return {transactionsPool:{},lastAddedTxKey:void 0,initialTx:void 0,unsyncedTxKeys:{},reconcileUnsyncedTransactions:async()=>{if(!e||o)return;let t=Object.keys(p().unsyncedTxKeys||{});if(t.length!==0){o=true;try{for(let r of t){if(!p().transactionsPool[r]){d(s=>immer.produce(s,a=>{a.unsyncedTxKeys&&delete a.unsyncedTxKeys[r];}));continue}await T(r,`[Pulsar] Failed to reconcile tx ${r}:`);}}finally{o=false;}}},addTxToPool:t=>{S(t);let r={...t,pending:true,...e&&{syncStatus:"pending-sync"}};return d(s=>immer.produce(s,a=>{if(a.lastAddedTxKey=t.txKey,t.txKey){if(e&&(a.unsyncedTxKeys||(a.unsyncedTxKeys={}),a.unsyncedTxKeys[t.txKey]=true),Object.keys(a.transactionsPool).length>=n){let c=Object.values(a.transactionsPool).sort((x,y)=>x.localTimestamp-y.localTimestamp);if(c.length>0){let x=c[0];delete a.transactionsPool[x.txKey];}}a.transactionsPool[t.txKey]=r;}})),e&&t.txKey&&T(t.txKey,"[Pulsar] onRemoteCreate failed, transaction queued for background sync:"),Promise.resolve()},updateTxParams:(t,r)=>{d(a=>immer.produce(a,i=>{let c=i.transactionsPool[t];c&&Object.assign(c,r);})),(r.status==="Success"||r.status==="Failed"||r.status==="Replaced")&&p().reconcileUnsyncedTransactions&&p().unsyncedTxKeys?.[t]&&p().reconcileUnsyncedTransactions().catch(a=>{console.error("[Pulsar] Terminal reconciliation failed:",a);});},removeTxFromPool:t=>{d(r=>immer.produce(r,s=>{delete s.transactionsPool[t];}));},closeTxTrackedModal:t=>{d(r=>immer.produce(r,s=>{if(t&&s.transactionsPool[t]){let a=s.transactionsPool[t];s.transactionsPool[t]={...a,isTrackedModalOpen:false};}s.initialTx=void 0;}));},getLastTxKey:()=>p().lastAddedTxKey}}}var D=n=>Object.values(n).sort((e,o)=>Number(e.localTimestamp)-Number(o.localTimestamp)),ke=n=>D(n).filter(e=>e.pending),ve=(n,e)=>n[e],re=(n,e)=>D(n).filter(o=>o.from.toLowerCase()===e.toLowerCase()),Ie=(n,e)=>re(n,e).filter(o=>o.pending);var{produce:q}=new immer.Immer({autoFreeze:false}),ae=n=>n.filter(e=>{try{return S(e),!0}catch(o){return console.warn("[Pulsar] Skipped invalid transaction from history:",o),false}}),X=n=>n==="Success"||n==="Failed"||n==="Replaced",H=(n,e)=>{let o=n[e.txKey];if(o){if(X(o.status))return false;if(o.pending){if(X(e.status))return n[e.txKey]={...o,...e},true;let l=typeof e.confirmations=="number"?e.confirmations:0,d=typeof o.confirmations=="number"?o.confirmations:0;return l>d?(n[e.txKey]={...o,...e},true):false}}return n[e.txKey]=e,true};function Me({localTransactionsPool:n,reconcileUnsyncedTransactions:e,getHistory:o,onHistoryFetched:l}){let d=T=>({isLoading:T,isError:false}),p=T=>{if(!T)return {isLoading:false};let t=ae(T.docs);return l&&queueMicrotask(()=>l(t)),r=>q(r,s=>{let a=s.transactionsPool;for(let i of t)H(a,i);s.currentPage=T.page,s.hasMore=T.hasNextPage,s.isLoading=false;})};return vanilla.createStore()((T,t)=>({transactionsPool:n,isLoading:false,isError:false,hasMore:false,currentPage:1,syncWithLocalPool:r=>{T(s=>q(s,a=>{let i=a.transactionsPool;for(let c of Object.values(r))H(i,c);}));},fetchInitial:async r=>{if(!(!o||!r)){T(d(true)),e&&await e();try{let s=await o({page:1,walletAddress:r});T(p(s));}catch(s){console.error("[Pulsar] Failed to fetch initial transaction history:",s),T({isLoading:false,isError:true});}}},fetchNextPage:async r=>{let{hasMore:s,isLoading:a,currentPage:i}=t();if(!(!o||!s||a||!r)){T(d(true));try{let c=i+1,x=await o({page:c,walletAddress:r});T(p(x));}catch(c){console.error(`[Pulsar] Failed to fetch transaction history page ${i+1}:`,c),T({isLoading:false,isError:true});}}}}))}function Ye({adapter:n,maxTransactions:e=50,onRemoteCreate:o,gelatoApiKey:l,beforeTxProcess:d,abortOnTxError:p,...T}){return vanilla.createStore()(middleware.persist((t,r)=>({...G({maxTransactions:e,onRemoteCreate:o})(t,r),getAdapter:()=>n,initializeTransactionsPool:async()=>{let a=Object.values(r().transactionsPool).filter(i=>i.pending).filter(i=>{try{return S(i),!0}catch(c){return console.warn("[Pulsar] Removed invalid persisted transaction:",c),r().removeTxFromPool(i.txKey),false}});await Promise.all(a.map(i=>orbitCore.selectAdapterByKey({adapterKey:i.adapter,adapter:n})?.checkAndInitializeTrackerInStore({tx:i,gelatoApiKey:l,...r()})));},injectExternalPendingTxs:async s=>{let i=r().getAdapter(),c=[],x=s.filter(y=>{try{return S(y),!0}catch(m){return console.warn("[Pulsar] Skipped invalid remote transaction:",m),false}});t(y=>immer.produce(y,m=>{let b=m.transactionsPool;x.forEach(u=>{let g=b[u.txKey];u.pending&&!g&&(b[u.txKey]=u,c.push(u));let I=u.status==="Success"||u.status==="Failed"||u.status==="Replaced";g?.pending&&I&&(g.status=u.status,g.pending=false,u.txKey&&(g.txKey=u.txKey),u.finishedTimestamp&&(g.finishedTimestamp=u.finishedTimestamp));});})),c.length>0&&await Promise.all(c.map(y=>orbitCore.selectAdapterByKey({adapterKey:y.adapter,adapter:i})?.checkAndInitializeTrackerInStore({tx:y,gelatoApiKey:l,...r()})));},executeTxAction:async({defaultTracker:s,actionFunction:a,params:i,beforeTxProcess:c,abortOnTxError:x,...y})=>{let m=x??p??true,b=ce__default.default().unix();r().reconcileUnsyncedTransactions().catch(f=>console.error("[Pulsar] Reconciliation failed:",f)),$(i);let{desiredChainID:u,tracker:g,...I}=i,{onSuccess:W,onError:J,onReplaced:Y}=y;t({initialTx:{...i,actionFunction:a,localTimestamp:b,isInitializing:true}});let k=orbitCore.selectAdapterByKey({adapterKey:I.adapter,adapter:n}),z=f=>{t(E=>immer.produce(E,h=>{h.initialTx&&(h.initialTx.isInitializing=false,h.initialTx.error=orbitCore.normalizeError(f));}));};if(!k){let f=new Error("No adapter found for this transaction.");throw z(f),f}try{let{connectorType:f,walletAddress:E}=k.getConnectorInfo();await k.checkChainForTx(u);try{await(c??d)?.();}catch(v){if(m)throw t({initialTx:{...i,actionFunction:a,localTimestamp:b,isInitializing:!1,error:orbitCore.normalizeError(v)}}),v;console.warn("[Pulsar] beforeTxProcess failed:",v);}let h=await a();if(!h){t({initialTx:void 0});return}let{tracker:M,txKey:R}=k.checkTransactionsTracker({actionTxKey:h,connectorType:f,tracker:g,gelatoApiKey:i.gelatoApiKey??l,bundlerUrl:i.bundlerUrl,pimlicoApiKey:i.pimlicoApiKey}),Q={...I,connectorType:f,from:E,tracker:M||s,chainId:orbitCore.setChainId(u),localTimestamp:b,txKey:R,bundlerUrl:i.bundlerUrl,pimlicoApiKey:i.pimlicoApiKey,hash:M==="ethereum"?h:void 0,pending:!1,isTrackedModalOpen:i.withTrackedModal};await r().addTxToPool(Q),t(v=>immer.produce(v,F=>{F.initialTx&&(F.initialTx.isInitializing=!1,F.initialTx.lastTxKey=R);}));let Z=r().transactionsPool[R];await k.checkAndInitializeTrackerInStore({tx:Z,onSuccess:W,onError:J,onReplaced:Y,gelatoApiKey:l,...r()});}catch(f){throw z(f),f}}}),{partialize:t=>{let r={...t};return delete r.initialTx,r},merge:(t,r)=>({...r,...t,initialTx:r.initialTx}),...T}))}var nn=(n=>e=>zustand.useStore(n,e));function rn({tx:n,transactionsPool:e,updateTxParams:o}){let l=e[n.txKey];return d=>(o(n.txKey,d),l&&(l={...l,...d}),l)}var pe=5e3,ue=10;function an(n){let{tx:e,fetcher:o,onInitialize:l,onSuccess:d,onFailure:p,onIntervalTick:T,onReplaced:t,removeTxFromPool:r,pollingInterval:s=pe,maxRetries:a=ue}=n;if(!e.pending)return;l?.();let i=a,c=true,x=m=>{c&&(c=false,r&&!m?.withoutRemoving&&r(e.txKey));};(async()=>{for(;c&&i>0;)try{if(await new Promise(m=>setTimeout(m,s)),!c)break;await o({tx:e,stopPolling:x,onSuccess:d,onFailure:p,onIntervalTick:T,onReplaced:t}),i=a;}catch(m){console.error(`Polling fetcher for txKey ${e.txKey} threw an error:`,m),i--;}i<=0&&(console.warn(`Polling for txKey ${e.txKey} stopped after reaching the maximum number of retries.`),p(),x());})();}exports.MAX_TRANSACTION_DESCRIPTION_LENGTH=B;exports.MAX_TRANSACTION_PAYLOAD_BYTES=N;exports.MAX_TRANSACTION_TITLE_LENGTH=U;exports.PulsarTransactionValidationError=P;exports.TransactionStatus=K;exports.TransactionTracker=ee;exports.createBoundedUseStore=nn;exports.createPulsarStore=Ye;exports.createTxInMemoryStore=Me;exports.createTxUpdater=rn;exports.initializePollingTracker=an;exports.initializeTxTrackingStore=G;exports.selectAllTransactions=D;exports.selectAllTransactionsByActiveWallet=re;exports.selectPendingTransactions=ke;exports.selectPendingTransactionsByActiveWallet=Ie;exports.selectTxByKey=ve;exports.validateInitialTransactionParams=$;exports.validateTransaction=S;
|
package/dist/index.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
import {Immer,produce}from'immer';import {createStore}from'zustand/vanilla';import {selectAdapterByKey,normalizeError,setChainId}from'@tuwaio/orbit-core';import ce from'dayjs';import {persist}from'zustand/middleware';import {useStore}from'zustand';var ee=(p=>(p.Ethereum="ethereum",p.Safe="safe",p.Gelato="gelato",p.Solana="solana",p.ERC4337="erc4337",p))(ee||{}),K=(l=>(l.Failed="Failed",l.Success="Success",l.Replaced="Replaced",l))(K||{});var U=100,B=300,N=10*1024,ne=[/\beval\s*\(/i,/\bFunction\s*\(/,/\bset(?:Timeout|Interval)\s*\(\s*['"`]/i,/javascript\s*:/i],P=class extends Error{field;constructor(e,o){super(o),this.name="PulsarTransactionValidationError",this.field=e;}};function $(n){w({field:"title",value:n.title,maxLength:U}),w({field:"description",value:n.description,maxLength:B}),j(n.payload);}function S(n){w({field:"title",value:n.title,maxLength:U}),w({field:"description",value:n.description,maxLength:B}),j(n.payload);}function w({field:n,value:e,maxLength:o}){if(e===void 0)return;(Array.isArray(e)?e:[e]).forEach((d,p)=>{let T=Array.isArray(e)?`${n}[${p}]`:n;if(typeof d!="string")throw new P(T,`${T} must be a string.`);if(d.length>o)throw new P(T,`${T} must be ${o} characters or less.`);O(T,d);});}function j(n){if(n===void 0)return;let e;try{e=JSON.stringify(n);}catch{throw new P("payload","payload must be JSON-serializable.")}if(e===void 0)throw new P("payload","payload must be JSON-serializable.");if(new TextEncoder().encode(e).length>N)throw new P("payload",`payload must be ${N} bytes or less when serialized.`);_(n);}function _(n,e="payload"){if(typeof n=="string"){O(e,n);return}n===null||typeof n!="object"||Object.entries(n).forEach(([o,l])=>{let d=`${e}.${o}`;O(d,o),_(l,d);});}function O(n,e){if(ne.some(o=>o.test(e)))throw new P(n,`${n} contains a blocked executable-like pattern.`)}function te(n){let e={...n};return delete e.pimlicoApiKey,delete e.gelatoApiKey,e}function G({maxTransactions:n,onRemoteCreate:e}){let o=false,l=new Set;return (d,p)=>{let T=async(t,r)=>{let s=p().transactionsPool[t];if(!(!e||!s||l.has(t))){l.add(t);try{await e(te(s)),d(a=>produce(a,i=>{let c=i.transactionsPool[t];c&&(c.syncStatus="synced"),i.unsyncedTxKeys&&delete i.unsyncedTxKeys[t];}));}catch(a){console.warn(r,a);}finally{l.delete(t);}}};return {transactionsPool:{},lastAddedTxKey:void 0,initialTx:void 0,unsyncedTxKeys:{},reconcileUnsyncedTransactions:async()=>{if(!e||o)return;let t=Object.keys(p().unsyncedTxKeys||{});if(t.length!==0){o=true;try{for(let r of t){if(!p().transactionsPool[r]){d(s=>produce(s,a=>{a.unsyncedTxKeys&&delete a.unsyncedTxKeys[r];}));continue}await T(r,`[Pulsar] Failed to reconcile tx ${r}:`);}}finally{o=false;}}},addTxToPool:t=>{S(t);let r={...t,pending:true,...e&&{syncStatus:"pending-sync"}};return d(s=>produce(s,a=>{if(a.lastAddedTxKey=t.txKey,t.txKey){if(e&&(a.unsyncedTxKeys||(a.unsyncedTxKeys={}),a.unsyncedTxKeys[t.txKey]=true),Object.keys(a.transactionsPool).length>=n){let c=Object.values(a.transactionsPool).sort((x,y)=>x.localTimestamp-y.localTimestamp);if(c.length>0){let x=c[0];delete a.transactionsPool[x.txKey];}}a.transactionsPool[t.txKey]=r;}})),e&&t.txKey&&T(t.txKey,"[Pulsar] onRemoteCreate failed, transaction queued for background sync:"),Promise.resolve()},updateTxParams:(t,r)=>{d(a=>produce(a,i=>{let c=i.transactionsPool[t];c&&Object.assign(c,r);})),(r.status==="Success"||r.status==="Failed"||r.status==="Replaced")&&p().reconcileUnsyncedTransactions&&p().unsyncedTxKeys?.[t]&&p().reconcileUnsyncedTransactions().catch(a=>{console.error("[Pulsar] Terminal reconciliation failed:",a);});},removeTxFromPool:t=>{d(r=>produce(r,s=>{delete s.transactionsPool[t];}));},closeTxTrackedModal:t=>{d(r=>produce(r,s=>{if(t&&s.transactionsPool[t]){let a=s.transactionsPool[t];s.transactionsPool[t]={...a,isTrackedModalOpen:false};}s.initialTx=void 0;}));},getLastTxKey:()=>p().lastAddedTxKey}}}var D=n=>Object.values(n).sort((e,o)=>Number(e.localTimestamp)-Number(o.localTimestamp)),ke=n=>D(n).filter(e=>e.pending),ve=(n,e)=>n[e],re=(n,e)=>D(n).filter(o=>o.from.toLowerCase()===e.toLowerCase()),Ie=(n,e)=>re(n,e).filter(o=>o.pending);var{produce:q}=new Immer({autoFreeze:false}),ae=n=>n.filter(e=>{try{return S(e),!0}catch(o){return console.warn("[Pulsar] Skipped invalid transaction from history:",o),false}}),X=n=>n==="Success"||n==="Replaced",H=(n,e)=>{let o=n[e.txKey];if(o){if(X(o.status))return false;if(o.pending){if(X(e.status))return n[e.txKey]={...o,...e},true;let l=typeof e.confirmations=="number"?e.confirmations:0,d=typeof o.confirmations=="number"?o.confirmations:0;return l>d?(n[e.txKey]={...o,...e},true):false}}return n[e.txKey]=e,true};function Me({localTransactionsPool:n,reconcileUnsyncedTransactions:e,getHistory:o,onHistoryFetched:l}){let d=T=>({isLoading:T,isError:false}),p=T=>{if(!T)return {isLoading:false};let t=ae(T.docs);return l&&queueMicrotask(()=>l(t)),r=>q(r,s=>{let a=s.transactionsPool;for(let i of t)H(a,i);s.currentPage=T.page,s.hasMore=T.hasNextPage,s.isLoading=false;})};return createStore()((T,t)=>({transactionsPool:n,isLoading:false,isError:false,hasMore:false,currentPage:1,syncWithLocalPool:r=>{T(s=>q(s,a=>{let i=a.transactionsPool;for(let c of Object.values(r))H(i,c);}));},fetchInitial:async r=>{if(!(!o||!r)){T(d(true)),e&&await e();try{let s=await o({page:1,walletAddress:r});T(p(s));}catch(s){console.error("[Pulsar] Failed to fetch initial transaction history:",s),T({isLoading:false,isError:true});}}},fetchNextPage:async r=>{let{hasMore:s,isLoading:a,currentPage:i}=t();if(!(!o||!s||a||!r)){T(d(true));try{let c=i+1,x=await o({page:c,walletAddress:r});T(p(x));}catch(c){console.error(`[Pulsar] Failed to fetch transaction history page ${i+1}:`,c),T({isLoading:false,isError:true});}}}}))}function Ye({adapter:n,maxTransactions:e=50,onRemoteCreate:o,gelatoApiKey:l,beforeTxProcess:d,abortOnTxError:p,...T}){return createStore()(persist((t,r)=>({...G({maxTransactions:e,onRemoteCreate:o})(t,r),getAdapter:()=>n,initializeTransactionsPool:async()=>{let a=Object.values(r().transactionsPool).filter(i=>i.pending).filter(i=>{try{return S(i),!0}catch(c){return console.warn("[Pulsar] Removed invalid persisted transaction:",c),r().removeTxFromPool(i.txKey),false}});await Promise.all(a.map(i=>selectAdapterByKey({adapterKey:i.adapter,adapter:n})?.checkAndInitializeTrackerInStore({tx:i,gelatoApiKey:l,...r()})));},injectExternalPendingTxs:async s=>{let i=r().getAdapter(),c=[],x=s.filter(y=>{try{return S(y),!0}catch(m){return console.warn("[Pulsar] Skipped invalid remote transaction:",m),false}});t(y=>produce(y,m=>{let b=m.transactionsPool;x.forEach(u=>{let g=b[u.txKey];u.pending&&!g&&(b[u.txKey]=u,c.push(u));let I=u.status==="Success"||u.status==="Failed"||u.status==="Replaced";g?.pending&&I&&(g.status=u.status,g.pending=false,u.txKey&&(g.txKey=u.txKey),u.finishedTimestamp&&(g.finishedTimestamp=u.finishedTimestamp));});})),c.length>0&&await Promise.all(c.map(y=>selectAdapterByKey({adapterKey:y.adapter,adapter:i})?.checkAndInitializeTrackerInStore({tx:y,gelatoApiKey:l,...r()})));},executeTxAction:async({defaultTracker:s,actionFunction:a,params:i,beforeTxProcess:c,abortOnTxError:x,...y})=>{let m=x??p??true,b=ce().unix();r().reconcileUnsyncedTransactions().catch(f=>console.error("[Pulsar] Reconciliation failed:",f)),$(i);let{desiredChainID:u,tracker:g,...I}=i,{onSuccess:W,onError:J,onReplaced:Y}=y;t({initialTx:{...i,actionFunction:a,localTimestamp:b,isInitializing:true}});let k=selectAdapterByKey({adapterKey:I.adapter,adapter:n}),z=f=>{t(E=>produce(E,h=>{h.initialTx&&(h.initialTx.isInitializing=false,h.initialTx.error=normalizeError(f));}));};if(!k){let f=new Error("No adapter found for this transaction.");throw z(f),f}try{let{connectorType:f,walletAddress:E}=k.getConnectorInfo();await k.checkChainForTx(u);try{await(c??d)?.();}catch(v){if(m)throw t({initialTx:{...i,actionFunction:a,localTimestamp:b,isInitializing:!1,error:normalizeError(v)}}),v;console.warn("[Pulsar] beforeTxProcess failed:",v);}let h=await a();if(!h){t({initialTx:void 0});return}let{tracker:M,txKey:R}=k.checkTransactionsTracker({actionTxKey:h,connectorType:f,tracker:g,gelatoApiKey:i.gelatoApiKey??l,bundlerUrl:i.bundlerUrl,pimlicoApiKey:i.pimlicoApiKey}),Q={...I,connectorType:f,from:E,tracker:M||s,chainId:setChainId(u),localTimestamp:b,txKey:R,bundlerUrl:i.bundlerUrl,pimlicoApiKey:i.pimlicoApiKey,hash:M==="ethereum"?h:void 0,pending:!1,isTrackedModalOpen:i.withTrackedModal};await r().addTxToPool(Q),t(v=>produce(v,F=>{F.initialTx&&(F.initialTx.isInitializing=!1,F.initialTx.lastTxKey=R);}));let Z=r().transactionsPool[R];await k.checkAndInitializeTrackerInStore({tx:Z,onSuccess:W,onError:J,onReplaced:Y,gelatoApiKey:l,...r()});}catch(f){throw z(f),f}}}),{partialize:t=>{let r={...t};return delete r.initialTx,r},merge:(t,r)=>({...r,...t,initialTx:r.initialTx}),...T}))}var nn=(n=>e=>useStore(n,e));function rn({tx:n,transactionsPool:e,updateTxParams:o}){let l=e[n.txKey];return d=>(o(n.txKey,d),l&&(l={...l,...d}),l)}var pe=5e3,ue=10;function an(n){let{tx:e,fetcher:o,onInitialize:l,onSuccess:d,onFailure:p,onIntervalTick:T,onReplaced:t,removeTxFromPool:r,pollingInterval:s=pe,maxRetries:a=ue}=n;if(!e.pending)return;l?.();let i=a,c=true,x=m=>{c&&(c=false,r&&!m?.withoutRemoving&&r(e.txKey));};(async()=>{for(;c&&i>0;)try{if(await new Promise(m=>setTimeout(m,s)),!c)break;await o({tx:e,stopPolling:x,onSuccess:d,onFailure:p,onIntervalTick:T,onReplaced:t}),i=a;}catch(m){console.error(`Polling fetcher for txKey ${e.txKey} threw an error:`,m),i--;}i<=0&&(console.warn(`Polling for txKey ${e.txKey} stopped after reaching the maximum number of retries.`),p(),x());})();}export{B as MAX_TRANSACTION_DESCRIPTION_LENGTH,N as MAX_TRANSACTION_PAYLOAD_BYTES,U as MAX_TRANSACTION_TITLE_LENGTH,P as PulsarTransactionValidationError,K as TransactionStatus,ee as TransactionTracker,nn as createBoundedUseStore,Ye as createPulsarStore,Me as createTxInMemoryStore,rn as createTxUpdater,an as initializePollingTracker,G as initializeTxTrackingStore,D as selectAllTransactions,re as selectAllTransactionsByActiveWallet,ke as selectPendingTransactions,Ie as selectPendingTransactionsByActiveWallet,ve as selectTxByKey,$ as validateInitialTransactionParams,S as validateTransaction};
|
|
1
|
+
import {Immer,produce}from'immer';import {createStore}from'zustand/vanilla';import {selectAdapterByKey,normalizeError,setChainId}from'@tuwaio/orbit-core';import ce from'dayjs';import {persist}from'zustand/middleware';import {useStore}from'zustand';var ee=(p=>(p.Ethereum="ethereum",p.Safe="safe",p.Gelato="gelato",p.Solana="solana",p.ERC4337="erc4337",p))(ee||{}),K=(l=>(l.Failed="Failed",l.Success="Success",l.Replaced="Replaced",l))(K||{});var U=100,B=300,N=10*1024,ne=[/\beval\s*\(/i,/\bFunction\s*\(/,/\bset(?:Timeout|Interval)\s*\(\s*['"`]/i,/javascript\s*:/i],P=class extends Error{field;constructor(e,o){super(o),this.name="PulsarTransactionValidationError",this.field=e;}};function $(n){w({field:"title",value:n.title,maxLength:U}),w({field:"description",value:n.description,maxLength:B}),j(n.payload);}function S(n){w({field:"title",value:n.title,maxLength:U}),w({field:"description",value:n.description,maxLength:B}),j(n.payload);}function w({field:n,value:e,maxLength:o}){if(e===void 0)return;(Array.isArray(e)?e:[e]).forEach((d,p)=>{let T=Array.isArray(e)?`${n}[${p}]`:n;if(typeof d!="string")throw new P(T,`${T} must be a string.`);if(d.length>o)throw new P(T,`${T} must be ${o} characters or less.`);O(T,d);});}function j(n){if(n===void 0)return;let e;try{e=JSON.stringify(n);}catch{throw new P("payload","payload must be JSON-serializable.")}if(e===void 0)throw new P("payload","payload must be JSON-serializable.");if(new TextEncoder().encode(e).length>N)throw new P("payload",`payload must be ${N} bytes or less when serialized.`);_(n);}function _(n,e="payload"){if(typeof n=="string"){O(e,n);return}n===null||typeof n!="object"||Object.entries(n).forEach(([o,l])=>{let d=`${e}.${o}`;O(d,o),_(l,d);});}function O(n,e){if(ne.some(o=>o.test(e)))throw new P(n,`${n} contains a blocked executable-like pattern.`)}function te(n){let e={...n};return delete e.pimlicoApiKey,delete e.gelatoApiKey,e}function G({maxTransactions:n,onRemoteCreate:e}){let o=false,l=new Set;return (d,p)=>{let T=async(t,r)=>{let s=p().transactionsPool[t];if(!(!e||!s||l.has(t))){l.add(t);try{await e(te(s)),d(a=>produce(a,i=>{let c=i.transactionsPool[t];c&&(c.syncStatus="synced"),i.unsyncedTxKeys&&delete i.unsyncedTxKeys[t];}));}catch(a){console.warn(r,a);}finally{l.delete(t);}}};return {transactionsPool:{},lastAddedTxKey:void 0,initialTx:void 0,unsyncedTxKeys:{},reconcileUnsyncedTransactions:async()=>{if(!e||o)return;let t=Object.keys(p().unsyncedTxKeys||{});if(t.length!==0){o=true;try{for(let r of t){if(!p().transactionsPool[r]){d(s=>produce(s,a=>{a.unsyncedTxKeys&&delete a.unsyncedTxKeys[r];}));continue}await T(r,`[Pulsar] Failed to reconcile tx ${r}:`);}}finally{o=false;}}},addTxToPool:t=>{S(t);let r={...t,pending:true,...e&&{syncStatus:"pending-sync"}};return d(s=>produce(s,a=>{if(a.lastAddedTxKey=t.txKey,t.txKey){if(e&&(a.unsyncedTxKeys||(a.unsyncedTxKeys={}),a.unsyncedTxKeys[t.txKey]=true),Object.keys(a.transactionsPool).length>=n){let c=Object.values(a.transactionsPool).sort((x,y)=>x.localTimestamp-y.localTimestamp);if(c.length>0){let x=c[0];delete a.transactionsPool[x.txKey];}}a.transactionsPool[t.txKey]=r;}})),e&&t.txKey&&T(t.txKey,"[Pulsar] onRemoteCreate failed, transaction queued for background sync:"),Promise.resolve()},updateTxParams:(t,r)=>{d(a=>produce(a,i=>{let c=i.transactionsPool[t];c&&Object.assign(c,r);})),(r.status==="Success"||r.status==="Failed"||r.status==="Replaced")&&p().reconcileUnsyncedTransactions&&p().unsyncedTxKeys?.[t]&&p().reconcileUnsyncedTransactions().catch(a=>{console.error("[Pulsar] Terminal reconciliation failed:",a);});},removeTxFromPool:t=>{d(r=>produce(r,s=>{delete s.transactionsPool[t];}));},closeTxTrackedModal:t=>{d(r=>produce(r,s=>{if(t&&s.transactionsPool[t]){let a=s.transactionsPool[t];s.transactionsPool[t]={...a,isTrackedModalOpen:false};}s.initialTx=void 0;}));},getLastTxKey:()=>p().lastAddedTxKey}}}var D=n=>Object.values(n).sort((e,o)=>Number(e.localTimestamp)-Number(o.localTimestamp)),ke=n=>D(n).filter(e=>e.pending),ve=(n,e)=>n[e],re=(n,e)=>D(n).filter(o=>o.from.toLowerCase()===e.toLowerCase()),Ie=(n,e)=>re(n,e).filter(o=>o.pending);var{produce:q}=new Immer({autoFreeze:false}),ae=n=>n.filter(e=>{try{return S(e),!0}catch(o){return console.warn("[Pulsar] Skipped invalid transaction from history:",o),false}}),X=n=>n==="Success"||n==="Failed"||n==="Replaced",H=(n,e)=>{let o=n[e.txKey];if(o){if(X(o.status))return false;if(o.pending){if(X(e.status))return n[e.txKey]={...o,...e},true;let l=typeof e.confirmations=="number"?e.confirmations:0,d=typeof o.confirmations=="number"?o.confirmations:0;return l>d?(n[e.txKey]={...o,...e},true):false}}return n[e.txKey]=e,true};function Me({localTransactionsPool:n,reconcileUnsyncedTransactions:e,getHistory:o,onHistoryFetched:l}){let d=T=>({isLoading:T,isError:false}),p=T=>{if(!T)return {isLoading:false};let t=ae(T.docs);return l&&queueMicrotask(()=>l(t)),r=>q(r,s=>{let a=s.transactionsPool;for(let i of t)H(a,i);s.currentPage=T.page,s.hasMore=T.hasNextPage,s.isLoading=false;})};return createStore()((T,t)=>({transactionsPool:n,isLoading:false,isError:false,hasMore:false,currentPage:1,syncWithLocalPool:r=>{T(s=>q(s,a=>{let i=a.transactionsPool;for(let c of Object.values(r))H(i,c);}));},fetchInitial:async r=>{if(!(!o||!r)){T(d(true)),e&&await e();try{let s=await o({page:1,walletAddress:r});T(p(s));}catch(s){console.error("[Pulsar] Failed to fetch initial transaction history:",s),T({isLoading:false,isError:true});}}},fetchNextPage:async r=>{let{hasMore:s,isLoading:a,currentPage:i}=t();if(!(!o||!s||a||!r)){T(d(true));try{let c=i+1,x=await o({page:c,walletAddress:r});T(p(x));}catch(c){console.error(`[Pulsar] Failed to fetch transaction history page ${i+1}:`,c),T({isLoading:false,isError:true});}}}}))}function Ye({adapter:n,maxTransactions:e=50,onRemoteCreate:o,gelatoApiKey:l,beforeTxProcess:d,abortOnTxError:p,...T}){return createStore()(persist((t,r)=>({...G({maxTransactions:e,onRemoteCreate:o})(t,r),getAdapter:()=>n,initializeTransactionsPool:async()=>{let a=Object.values(r().transactionsPool).filter(i=>i.pending).filter(i=>{try{return S(i),!0}catch(c){return console.warn("[Pulsar] Removed invalid persisted transaction:",c),r().removeTxFromPool(i.txKey),false}});await Promise.all(a.map(i=>selectAdapterByKey({adapterKey:i.adapter,adapter:n})?.checkAndInitializeTrackerInStore({tx:i,gelatoApiKey:l,...r()})));},injectExternalPendingTxs:async s=>{let i=r().getAdapter(),c=[],x=s.filter(y=>{try{return S(y),!0}catch(m){return console.warn("[Pulsar] Skipped invalid remote transaction:",m),false}});t(y=>produce(y,m=>{let b=m.transactionsPool;x.forEach(u=>{let g=b[u.txKey];u.pending&&!g&&(b[u.txKey]=u,c.push(u));let I=u.status==="Success"||u.status==="Failed"||u.status==="Replaced";g?.pending&&I&&(g.status=u.status,g.pending=false,u.txKey&&(g.txKey=u.txKey),u.finishedTimestamp&&(g.finishedTimestamp=u.finishedTimestamp));});})),c.length>0&&await Promise.all(c.map(y=>selectAdapterByKey({adapterKey:y.adapter,adapter:i})?.checkAndInitializeTrackerInStore({tx:y,gelatoApiKey:l,...r()})));},executeTxAction:async({defaultTracker:s,actionFunction:a,params:i,beforeTxProcess:c,abortOnTxError:x,...y})=>{let m=x??p??true,b=ce().unix();r().reconcileUnsyncedTransactions().catch(f=>console.error("[Pulsar] Reconciliation failed:",f)),$(i);let{desiredChainID:u,tracker:g,...I}=i,{onSuccess:W,onError:J,onReplaced:Y}=y;t({initialTx:{...i,actionFunction:a,localTimestamp:b,isInitializing:true}});let k=selectAdapterByKey({adapterKey:I.adapter,adapter:n}),z=f=>{t(E=>produce(E,h=>{h.initialTx&&(h.initialTx.isInitializing=false,h.initialTx.error=normalizeError(f));}));};if(!k){let f=new Error("No adapter found for this transaction.");throw z(f),f}try{let{connectorType:f,walletAddress:E}=k.getConnectorInfo();await k.checkChainForTx(u);try{await(c??d)?.();}catch(v){if(m)throw t({initialTx:{...i,actionFunction:a,localTimestamp:b,isInitializing:!1,error:normalizeError(v)}}),v;console.warn("[Pulsar] beforeTxProcess failed:",v);}let h=await a();if(!h){t({initialTx:void 0});return}let{tracker:M,txKey:R}=k.checkTransactionsTracker({actionTxKey:h,connectorType:f,tracker:g,gelatoApiKey:i.gelatoApiKey??l,bundlerUrl:i.bundlerUrl,pimlicoApiKey:i.pimlicoApiKey}),Q={...I,connectorType:f,from:E,tracker:M||s,chainId:setChainId(u),localTimestamp:b,txKey:R,bundlerUrl:i.bundlerUrl,pimlicoApiKey:i.pimlicoApiKey,hash:M==="ethereum"?h:void 0,pending:!1,isTrackedModalOpen:i.withTrackedModal};await r().addTxToPool(Q),t(v=>produce(v,F=>{F.initialTx&&(F.initialTx.isInitializing=!1,F.initialTx.lastTxKey=R);}));let Z=r().transactionsPool[R];await k.checkAndInitializeTrackerInStore({tx:Z,onSuccess:W,onError:J,onReplaced:Y,gelatoApiKey:l,...r()});}catch(f){throw z(f),f}}}),{partialize:t=>{let r={...t};return delete r.initialTx,r},merge:(t,r)=>({...r,...t,initialTx:r.initialTx}),...T}))}var nn=(n=>e=>useStore(n,e));function rn({tx:n,transactionsPool:e,updateTxParams:o}){let l=e[n.txKey];return d=>(o(n.txKey,d),l&&(l={...l,...d}),l)}var pe=5e3,ue=10;function an(n){let{tx:e,fetcher:o,onInitialize:l,onSuccess:d,onFailure:p,onIntervalTick:T,onReplaced:t,removeTxFromPool:r,pollingInterval:s=pe,maxRetries:a=ue}=n;if(!e.pending)return;l?.();let i=a,c=true,x=m=>{c&&(c=false,r&&!m?.withoutRemoving&&r(e.txKey));};(async()=>{for(;c&&i>0;)try{if(await new Promise(m=>setTimeout(m,s)),!c)break;await o({tx:e,stopPolling:x,onSuccess:d,onFailure:p,onIntervalTick:T,onReplaced:t}),i=a;}catch(m){console.error(`Polling fetcher for txKey ${e.txKey} threw an error:`,m),i--;}i<=0&&(console.warn(`Polling for txKey ${e.txKey} stopped after reaching the maximum number of retries.`),p(),x());})();}export{B as MAX_TRANSACTION_DESCRIPTION_LENGTH,N as MAX_TRANSACTION_PAYLOAD_BYTES,U as MAX_TRANSACTION_TITLE_LENGTH,P as PulsarTransactionValidationError,K as TransactionStatus,ee as TransactionTracker,nn as createBoundedUseStore,Ye as createPulsarStore,Me as createTxInMemoryStore,rn as createTxUpdater,an as initializePollingTracker,G as initializeTxTrackingStore,D as selectAllTransactions,re as selectAllTransactionsByActiveWallet,ke as selectPendingTransactions,Ie as selectPendingTransactionsByActiveWallet,ve as selectTxByKey,$ as validateInitialTransactionParams,S as validateTransaction};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tuwaio/pulsar-core",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.9.0",
|
|
4
4
|
"private": false,
|
|
5
5
|
"author": "Oleksandr Tkach",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -45,13 +45,13 @@
|
|
|
45
45
|
}
|
|
46
46
|
],
|
|
47
47
|
"peerDependencies": {
|
|
48
|
-
"@tuwaio/orbit-core": ">=0.
|
|
48
|
+
"@tuwaio/orbit-core": ">=0.4",
|
|
49
49
|
"dayjs": "1.x.x",
|
|
50
50
|
"immer": "11.x.x",
|
|
51
51
|
"zustand": "5.x.x"
|
|
52
52
|
},
|
|
53
53
|
"devDependencies": {
|
|
54
|
-
"@tuwaio/orbit-core": "^0.
|
|
54
|
+
"@tuwaio/orbit-core": "^0.4.0",
|
|
55
55
|
"dayjs": "^1.11.23",
|
|
56
56
|
"immer": "^11.1.18",
|
|
57
57
|
"tsup": "^8.5.1",
|