@lukso/transaction-decoder 1.0.1-dev.0f1bea5

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,486 @@
+# @lukso/transaction-decoder
+
+A modern, progressive transaction decoder for LUKSO and EVM blockchains with reactive state management, multi-level caching, and three-phase enhancement.
+
+## Features
+
+- 🚀 **Progressive Enhancement** - Show results immediately, enhance progressively
+- ⚡ **Reactive State Management** - Framework-agnostic signals for real-time updates
+- 🔄 **Smart Batching** - Minimize API calls with intelligent request batching
+- 💾 **Multi-Level Caching** - Transaction, address, ABI, and schema caches
+- 🔌 **Plugin System** - Extensible architecture with auto-registration
+- 🛡️ **Security First** - Frozen plugins, immutable data, prototype protection
+- 🌐 **Universal** - Works in Node.js, browsers, and all major frameworks
+- ⏱️ **Time-Bounded Server Mode** - Get the best result within your time budget
+
+## Installation
+
+```bash
+npm install @lukso/transaction-decoder
+# or
+yarn add @lukso/transaction-decoder
+# or
+pnpm add @lukso/transaction-decoder
+```
+
+## Quick Start
+
+### Client-Side (React, Vue, etc.)
+
+```typescript
+import { decodeTransaction } from '@lukso/transaction-decoder'
+
+// Decode a transaction with progressive enhancement
+const result = await decodeTransaction(transaction)
+
+// Access immediate result
+console.log(result.immediate)
+
+// Subscribe to updates
+result.signal.subscribe(state => {
+  console.log(state.decodingStatus) // 'decoded' → 'enhanced' → 'complete'
+  console.log(state.data) // Progressively enhanced data
+})
+```
+
+### Server-Side (Node.js)
+
+```typescript
+import { createServerDecoder } from '@lukso/transaction-decoder/server'
+
+// Create a decoder instance with caching
+const decoder = createServerDecoder({
+  graphqlEndpoint: 'https://api.universalprofile.cloud/graphql',
+  defaultChain: lukso,
+  transactionCacheSize: 10000,
+  addressCacheSize: 50000,
+})
+
+// Decode with time budget (returns best result within 800ms)
+const result = await decoder.decodeTransaction(transaction, {
+  timeoutMs: 800,
+  enableEnhancement: true,
+  enableAddressResolution: true,
+})
+
+console.log(result.phase) // 'immediate' | 'enhanced' | 'complete'
+console.log(result.cached) // true if from cache
+console.log(result.data) // Decoded transaction data
+```
+
+## Three-Phase Decoding
+
+The decoder uses a progressive enhancement approach:
+
+### Phase 1: Immediate Decode (10ms)
+- Synchronous decoding using known ABIs
+- Returns function names, arguments, basic info
+- Available immediately for UI rendering
+
+### Phase 2: Enhancement (200ms)
+- Fetches unknown ABIs from blockchain
+- Adds contract verification status
+- Provides human-readable context
+- Batches ABI requests across transactions
+
+### Phase 3: Address Resolution (100ms)
+- Resolves profile metadata
+- Fetches asset information
+- Adds token details
+- Batches all address lookups
+
+## Architecture
+
+### API Layers
+
+1. **Consumer API** (`@lukso/transaction-decoder`) - Read-only reactive access
+2. **Data Provider API** (`@lukso/transaction-decoder/data`) - Data management
+3. **Server API** (`@lukso/transaction-decoder/server`) - Server-side optimized
+4. **Browser API** (`@lukso/transaction-decoder/browser`) - Browser global
+
+### Data Flow
+
+```text
+Raw Transaction → Decoder → Data Model → Consumer API → UI
+                     ↓           ↓
+                 Progressive  Address
+                 Enhancement  Resolution
+```
+
+### Reactive State Management
+
+Using Preact signals for framework-agnostic reactivity:
+
+```typescript
+// Get reactive transaction state
+const txSignal = getTransaction(hash)
+
+// Vue
+const transaction = computed(() => txSignal.value)
+
+// React  
+const [state, setState] = useState(txSignal.value)
+useEffect(() => effect(() => setState(txSignal.value)), [])
+
+// Svelte
+$: state = $txSignal.value
+
+// Vanilla JS
+txSignal.subscribe(state => {
+  console.log('Transaction updated:', state)
+})
+```
+
+## API Reference
+
+### Consumer API (Client-Side)
+
+```typescript
+import { 
+  decodeTransaction,
+  getTransaction,
+  getAddress,
+  subscribe 
+} from '@lukso/transaction-decoder'
+
+// Decode single or multiple transactions
+const result = await decodeTransaction(tx, options)
+const results = await decodeTransaction([tx1, tx2, tx3], options)
+
+// Access transaction by hash
+const txSignal = getTransaction(hash)
+
+// Access address metadata
+const addressSignal = getAddress(address)
+
+// Subscribe to any data changes
+const unsubscribe = subscribe(key, (state) => {
+  console.log('Data updated:', state)
+})
+```
+
+### Server API
+
+```typescript
+import { createServerDecoder } from '@lukso/transaction-decoder/server'
+
+const decoder = createServerDecoder({
+  graphqlEndpoint: string,
+  defaultChain: Chain,
+  transactionCacheSize?: number,    // Default: 10000
+  addressCacheSize?: number,        // Default: 50000
+  abiCacheSize?: number,           // Default: 5000
+  schemaCacheSize?: number,        // Default: 10000
+  defaultTimeout?: number,         // Default: 800ms
+})
+
+// Decode with time budget
+const result = await decoder.decodeTransaction(tx, {
+  timeoutMs: 800,
+  enableEnhancement: true,
+  enableAddressResolution: true,
+})
+
+// Batch decode for efficiency
+const results = await decoder.decodeTransactionsBatch(transactions, options)
+
+// Cache management
+decoder.clearCaches()
+const stats = decoder.getCacheStats()
+await decoder.warmAddressCache(addresses)
+```
+
+### Data Provider API
+
+```typescript
+import { 
+  addTransactions,
+  injectData,
+  updateData 
+} from '@lukso/transaction-decoder/data'
+
+// Add transactions to be decoded
+addTransactions(transactions)
+
+// Inject address metadata
+injectData(addresses)
+
+// Update existing data
+updateData(key, data)
+```
+
+## Plugin System
+
+### Using Plugins
+
+```typescript
+// Import plugins - they auto-register
+import '@lukso/decoder-plugin-defi'
+import '@lukso/decoder-plugin-nft'
+
+// Plugins are automatically available
+const result = await decodeTransaction(tx)
+```
+
+### Creating Plugins
+
+```typescript
+import { standardPlugin, registerPlugin } from '@lukso/transaction-decoder'
+
+const myPlugin = standardPlugin(
+  CONTRACT_ABI,
+  {
+    name: 'my-plugin',
+    abiName: 'MyContract',
+    required: true,      // Can't be overridden
+    priority: 1000,      // Higher runs first
+  },
+  async (result, options) => {
+    // Enhance the decoded result
+    return enhancedResult
+  }
+)
+
+// Auto-register the plugin
+registerPlugin('my-plugin', myPlugin)
+```
+
+### Schema Plugins
+
+```typescript
+import { standardSchemaPlugin } from '@lukso/transaction-decoder'
+
+const schemaPlugin = standardSchemaPlugin(
+  ERC725_SCHEMAS,
+  { name: 'custom-schema' },
+  async (info) => {
+    // Process decoded schema data
+    return enhancedInfo
+  }
+)
+```
+
+## Caching Architecture
+
+### Client-Side
+- Reactive signals cache decoded data
+- Automatic deduplication of requests
+- Memory-based with configurable limits
+
+### Server-Side
+- **Transaction Cache**: Complete decoded results (1hr TTL)
+- **Address Cache**: Profile/asset metadata (24hr TTL)
+- **ABI Cache**: Contract interfaces (7 day TTL)
+- **Schema Cache**: Decoded values (1hr TTL)
+
+Cache statistics available for monitoring:
+```typescript
+const stats = decoder.getCacheStats()
+// {
+//   transactions: { size: 5420, hitRate: 0.89, ... },
+//   addresses: { size: 12453, hitRate: 0.94, ... },
+//   ...
+// }
+```
+
+## Framework Integration
+
+### React
+
+```typescript
+function useTransaction(hash: string) {
+  const signal = getTransaction(hash)
+  const [state, setState] = useState(signal.value)
+  
+  useEffect(() => {
+    const unsubscribe = signal.subscribe(setState)
+    return unsubscribe
+  }, [hash])
+  
+  return state
+}
+```
+
+### Vue
+
+```vue
+<script setup>
+import { computed } from 'vue'
+import { getTransaction } from '@lukso/transaction-decoder'
+
+const props = defineProps(['hash'])
+const signal = getTransaction(props.hash)
+const transaction = computed(() => signal.value)
+</script>
+```
+
+### Svelte
+
+```svelte
+<script>
+  import { onDestroy } from 'svelte'
+  import { effect } from '@preact/signals-core'
+  import { getAddress } from '@lukso/transaction-decoder'
+  
+  export let address
+  
+  let state = getAddress(address).value
+  
+  const unsubscribe = effect(() => {
+    state = getAddress(address).value
+  })
+  
+  onDestroy(unsubscribe)
+</script>
+```
+
+## Security
+
+- 🔒 **Frozen Plugins** - Plugins are immutable after creation
+- 🛡️ **Read-Only API** - Consumer API prevents data tampering
+- 🧊 **Immutable Data** - All returned data is deeply frozen
+- 🔐 **Prototype Protection** - Classes protected against pollution
+
+## Performance
+
+- **Immediate results** in ~10ms
+- **Enhanced results** in ~200ms  
+- **Complete with addresses** in ~300ms
+- **Batch processing** reduces API calls by 90%+
+- **Server caching** provides sub-millisecond responses
+
+## Types
+
+```typescript
+// Address key - can be just address or address + tokenId
+type DataKey = Hex | { address: Hex; tokenId: Hex }
+
+// Transaction state during decoding
+interface TransactionState {
+  loading: boolean
+  data: DecoderResult
+  decodingStatus: 'decoded' | 'enhanced' | 'complete' | 'failed'
+  addresses: DataKey[]
+  addressesResolved: boolean
+  resolvedData?: DecoderResult // Transaction with addresses replaced by metadata
+  error?: string
+  lastUpdated: number
+}
+
+// Server decoding result
+interface ServerDecoderResult {
+  data: DecoderResult
+  phase: 'immediate' | 'enhanced'
+  cached: boolean
+  timeTaken: number
+  addressesResolved?: number
+  addressesCached?: number
+}
+
+// Decoder plugin
+interface DecoderPlugin {
+  enhance: (transaction, options) => Promise<DecoderResult | undefined>
+  decodeEvent: (log, options) => Promise<DecodeEventResult>
+  async?: boolean
+  name?: string
+  required?: boolean
+  priority?: number
+}
+```
+
+## Browser Support
+
+### CDN
+```html
+<script src="https://unpkg.com/@lukso/transaction-decoder"></script>
+<script>
+  const { decodeTransaction } = window.TransactionDecoder
+</script>
+```
+
+### ES Modules
+```javascript
+import { decodeTransaction } from '@lukso/transaction-decoder'
+```
+
+### CommonJS
+```javascript
+const { decodeTransaction } = require('@lukso/transaction-decoder')
+```
+
+## Advanced Usage
+
+### Custom Address Resolver
+
+```typescript
+import { AddressResolver } from '@lukso/transaction-decoder'
+
+const resolver = new AddressResolver({
+  dataModel,
+  graphqlEndpoint: 'https://custom-api.com/graphql',
+  batchSize: 100,
+  batchDelay: 50,
+})
+```
+
+### Integration with Data Model
+
+```typescript
+import { DecoderIntegration, createDataModel } from '@lukso/transaction-decoder'
+
+const dataModel = createDataModel({
+  onMissingKeys: (keys) => {
+    // Trigger address resolution
+  },
+  onNewTransaction: (tx) => {
+    // Handle new transaction
+  },
+})
+
+const decoder = new DecoderIntegration({
+  dataModel,
+  chain: lukso,
+})
+```
+
+### TypeScript Augmentation
+
+```typescript
+// Augment types for custom fields
+declare module '@lukso/transaction-decoder' {
+  interface DecoderResult {
+    myCustomField?: string
+  }
+  
+  interface EnhancedInfo {
+    myCustomData?: any
+  }
+}
+```
+
+## Migration from lib/decoder
+
+If migrating from the old `lib/decoder`:
+
+1. Install the npm package
+2. Update imports:
+   ```typescript
+   // Old
+   import { decodeTransaction } from '~/lib/decoder/transaction'
+   
+   // New - Client
+   import { decodeTransaction } from '@lukso/transaction-decoder'
+   
+   // New - Server
+   import { createServerDecoder } from '@lukso/transaction-decoder/server'
+   ```
+3. Update API calls for new return format
+4. Delete the old `lib/decoder` folder
+
+## Contributing
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for development setup and guidelines.
+
+## License
+
+MIT