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

package/src/decoder/plugins/RegistryAbi.ts

@@ -0,0 +1,562 @@
+export default [
+  {
+    inputs: [
+      { internalType: 'address', name: 'creator', type: 'address' },
+      { internalType: 'address', name: '_codehub', type: 'address' },
+    ],
+    stateMutability: 'nonpayable',
+    type: 'constructor',
+  },
+  { inputs: [], name: 'ERC725Y_DataKeysValuesEmptyArray', type: 'error' },
+  { inputs: [], name: 'ERC725Y_DataKeysValuesLengthMismatch', type: 'error' },
+  { inputs: [], name: 'ERC725Y_MsgValueDisallowed', type: 'error' },
+  {
+    inputs: [{ internalType: 'bytes', name: 'storedData', type: 'bytes' }],
+    name: 'InvalidExtensionAddress',
+    type: 'error',
+  },
+  {
+    inputs: [{ internalType: 'bytes', name: 'data', type: 'bytes' }],
+    name: 'InvalidFunctionSelector',
+    type: 'error',
+  },
+  { inputs: [], name: 'LSP4TokenNameNotEditable', type: 'error' },
+  { inputs: [], name: 'LSP4TokenSymbolNotEditable', type: 'error' },
+  { inputs: [], name: 'LSP4TokenTypeNotEditable', type: 'error' },
+  {
+    inputs: [{ internalType: 'uint256', name: 'callIndex', type: 'uint256' }],
+    name: 'LSP8BatchCallFailed',
+    type: 'error',
+  },
+  { inputs: [], name: 'LSP8CannotSendToAddressZero', type: 'error' },
+  { inputs: [], name: 'LSP8CannotSendToSelf', type: 'error' },
+  { inputs: [], name: 'LSP8CannotUseAddressZeroAsOperator', type: 'error' },
+  { inputs: [], name: 'LSP8InvalidTransferBatch', type: 'error' },
+  {
+    inputs: [{ internalType: 'bytes32', name: 'tokenId', type: 'bytes32' }],
+    name: 'LSP8NonExistentTokenId',
+    type: 'error',
+  },
+  {
+    inputs: [
+      { internalType: 'address', name: 'operator', type: 'address' },
+      { internalType: 'bytes32', name: 'tokenId', type: 'bytes32' },
+    ],
+    name: 'LSP8NonExistingOperator',
+    type: 'error',
+  },
+  {
+    inputs: [
+      { internalType: 'bytes32', name: 'tokenId', type: 'bytes32' },
+      { internalType: 'address', name: 'caller', type: 'address' },
+    ],
+    name: 'LSP8NotTokenOperator',
+    type: 'error',
+  },
+  {
+    inputs: [
+      { internalType: 'address', name: 'tokenOwner', type: 'address' },
+      { internalType: 'bytes32', name: 'tokenId', type: 'bytes32' },
+      { internalType: 'address', name: 'caller', type: 'address' },
+    ],
+    name: 'LSP8NotTokenOwner',
+    type: 'error',
+  },
+  {
+    inputs: [
+      { internalType: 'address', name: 'tokenReceiver', type: 'address' },
+    ],
+    name: 'LSP8NotifyTokenReceiverContractMissingLSP1Interface',
+    type: 'error',
+  },
+  {
+    inputs: [
+      { internalType: 'address', name: 'tokenReceiver', type: 'address' },
+    ],
+    name: 'LSP8NotifyTokenReceiverIsEOA',
+    type: 'error',
+  },
+  {
+    inputs: [
+      { internalType: 'address', name: 'operator', type: 'address' },
+      { internalType: 'bytes32', name: 'tokenId', type: 'bytes32' },
+    ],
+    name: 'LSP8OperatorAlreadyAuthorized',
+    type: 'error',
+  },
+  { inputs: [], name: 'LSP8TokenContractCannotHoldValue', type: 'error' },
+  {
+    inputs: [{ internalType: 'bytes32', name: 'tokenId', type: 'bytes32' }],
+    name: 'LSP8TokenIdAlreadyMinted',
+    type: 'error',
+  },
+  { inputs: [], name: 'LSP8TokenIdFormatNotEditable', type: 'error' },
+  { inputs: [], name: 'LSP8TokenIdsDataEmptyArray', type: 'error' },
+  { inputs: [], name: 'LSP8TokenIdsDataLengthMismatch', type: 'error' },
+  { inputs: [], name: 'LSP8TokenOwnerCannotBeOperator', type: 'error' },
+  {
+    inputs: [
+      { internalType: 'bytes4', name: 'functionSelector', type: 'bytes4' },
+    ],
+    name: 'NoExtensionFoundForFunctionSelector',
+    type: 'error',
+  },
+  {
+    inputs: [
+      { internalType: 'address', name: 'callerAddress', type: 'address' },
+    ],
+    name: 'OwnableCallerNotTheOwner',
+    type: 'error',
+  },
+  { inputs: [], name: 'OwnableCannotSetZeroAddressAsOwner', type: 'error' },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: 'bytes32',
+        name: 'dataKey',
+        type: 'bytes32',
+      },
+      {
+        indexed: false,
+        internalType: 'bytes',
+        name: 'dataValue',
+        type: 'bytes',
+      },
+    ],
+    name: 'DataChanged',
+    type: 'event',
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: 'address',
+        name: 'operator',
+        type: 'address',
+      },
+      {
+        indexed: true,
+        internalType: 'address',
+        name: 'tokenOwner',
+        type: 'address',
+      },
+      {
+        indexed: true,
+        internalType: 'bytes32',
+        name: 'tokenId',
+        type: 'bytes32',
+      },
+      {
+        indexed: false,
+        internalType: 'bytes',
+        name: 'operatorNotificationData',
+        type: 'bytes',
+      },
+    ],
+    name: 'OperatorAuthorizationChanged',
+    type: 'event',
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: 'address',
+        name: 'operator',
+        type: 'address',
+      },
+      {
+        indexed: true,
+        internalType: 'address',
+        name: 'tokenOwner',
+        type: 'address',
+      },
+      {
+        indexed: true,
+        internalType: 'bytes32',
+        name: 'tokenId',
+        type: 'bytes32',
+      },
+      { indexed: false, internalType: 'bool', name: 'notified', type: 'bool' },
+      {
+        indexed: false,
+        internalType: 'bytes',
+        name: 'operatorNotificationData',
+        type: 'bytes',
+      },
+    ],
+    name: 'OperatorRevoked',
+    type: 'event',
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: 'address',
+        name: 'previousOwner',
+        type: 'address',
+      },
+      {
+        indexed: true,
+        internalType: 'address',
+        name: 'newOwner',
+        type: 'address',
+      },
+    ],
+    name: 'OwnershipTransferred',
+    type: 'event',
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: 'bytes32',
+        name: 'tokenId',
+        type: 'bytes32',
+      },
+      {
+        indexed: true,
+        internalType: 'bytes32',
+        name: 'dataKey',
+        type: 'bytes32',
+      },
+      {
+        indexed: false,
+        internalType: 'bytes',
+        name: 'dataValue',
+        type: 'bytes',
+      },
+    ],
+    name: 'TokenIdDataChanged',
+    type: 'event',
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: false,
+        internalType: 'address',
+        name: 'operator',
+        type: 'address',
+      },
+      { indexed: true, internalType: 'address', name: 'from', type: 'address' },
+      { indexed: true, internalType: 'address', name: 'to', type: 'address' },
+      {
+        indexed: true,
+        internalType: 'bytes32',
+        name: 'tokenId',
+        type: 'bytes32',
+      },
+      { indexed: false, internalType: 'bool', name: 'force', type: 'bool' },
+      { indexed: false, internalType: 'bytes', name: 'data', type: 'bytes' },
+    ],
+    name: 'Transfer',
+    type: 'event',
+  },
+  { stateMutability: 'payable', type: 'fallback' },
+  {
+    inputs: [
+      { internalType: 'address', name: 'operator', type: 'address' },
+      { internalType: 'bytes32', name: 'tokenId', type: 'bytes32' },
+      {
+        internalType: 'bytes',
+        name: 'operatorNotificationData',
+        type: 'bytes',
+      },
+    ],
+    name: 'authorizeOperator',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [{ internalType: 'address', name: 'tokenOwner', type: 'address' }],
+    name: 'balanceOf',
+    outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'banner',
+    outputs: [{ internalType: 'contract Fractal', name: '', type: 'address' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [{ internalType: 'bytes[]', name: 'data', type: 'bytes[]' }],
+    name: 'batchCalls',
+    outputs: [{ internalType: 'bytes[]', name: 'results', type: 'bytes[]' }],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [{ internalType: 'bytes32', name: 'dataKey', type: 'bytes32' }],
+    name: 'getData',
+    outputs: [{ internalType: 'bytes', name: 'dataValue', type: 'bytes' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [
+      { internalType: 'bytes32[]', name: 'dataKeys', type: 'bytes32[]' },
+    ],
+    name: 'getDataBatch',
+    outputs: [{ internalType: 'bytes[]', name: 'dataValues', type: 'bytes[]' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [
+      { internalType: 'bytes32[]', name: 'tokenIds', type: 'bytes32[]' },
+      { internalType: 'bytes32[]', name: 'dataKeys', type: 'bytes32[]' },
+    ],
+    name: 'getDataBatchForTokenIds',
+    outputs: [{ internalType: 'bytes[]', name: 'dataValues', type: 'bytes[]' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [
+      { internalType: 'bytes32', name: 'tokenId', type: 'bytes32' },
+      { internalType: 'bytes32', name: 'dataKey', type: 'bytes32' },
+    ],
+    name: 'getDataForTokenId',
+    outputs: [{ internalType: 'bytes', name: 'dataValue', type: 'bytes' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [{ internalType: 'bytes32', name: 'tokenId', type: 'bytes32' }],
+    name: 'getOperatorsOf',
+    outputs: [{ internalType: 'address[]', name: '', type: 'address[]' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [
+      { internalType: 'address', name: 'to', type: 'address' },
+      { internalType: 'uint32', name: 'seed', type: 'uint32' },
+      { internalType: 'address', name: 'fractal', type: 'address' },
+    ],
+    name: 'inject',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [
+      { internalType: 'address', name: 'operator', type: 'address' },
+      { internalType: 'bytes32', name: 'tokenId', type: 'bytes32' },
+    ],
+    name: 'isOperatorFor',
+    outputs: [{ internalType: 'bool', name: '', type: 'bool' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [
+      { internalType: 'address', name: 'fractal', type: 'address' },
+      { internalType: 'address', name: 'owner', type: 'address' },
+      { internalType: 'address', name: 'registry', type: 'address' },
+    ],
+    name: 'migrate',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [
+      { internalType: 'address', name: 'to', type: 'address' },
+      { internalType: 'uint32', name: 'seed', type: 'uint32' },
+    ],
+    name: 'mint',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [{ internalType: 'uint32', name: '', type: 'uint32' }],
+    name: 'minted',
+    outputs: [{ internalType: 'address', name: '', type: 'address' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'owner',
+    outputs: [{ internalType: 'address', name: '', type: 'address' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [{ internalType: 'bool', name: '_paused', type: 'bool' }],
+    name: 'pause',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'paused',
+    outputs: [{ internalType: 'bool', name: '', type: 'bool' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [
+      { internalType: 'bytes32', name: 'tokenId', type: 'bytes32' },
+      { internalType: 'uint256', name: 'iters', type: 'uint256' },
+    ],
+    name: 'refine',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'renounceOwnership',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [
+      { internalType: 'address', name: 'operator', type: 'address' },
+      { internalType: 'bytes32', name: 'tokenId', type: 'bytes32' },
+      { internalType: 'bool', name: 'notify', type: 'bool' },
+      {
+        internalType: 'bytes',
+        name: 'operatorNotificationData',
+        type: 'bytes',
+      },
+    ],
+    name: 'revokeOperator',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [{ internalType: 'address', name: '', type: 'address' }],
+    name: 'seeds',
+    outputs: [{ internalType: 'uint32', name: '', type: 'uint32' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [
+      { internalType: 'bytes32', name: 'dataKey', type: 'bytes32' },
+      { internalType: 'bytes', name: 'dataValue', type: 'bytes' },
+    ],
+    name: 'setData',
+    outputs: [],
+    stateMutability: 'payable',
+    type: 'function',
+  },
+  {
+    inputs: [
+      { internalType: 'bytes32[]', name: 'dataKeys', type: 'bytes32[]' },
+      { internalType: 'bytes[]', name: 'dataValues', type: 'bytes[]' },
+    ],
+    name: 'setDataBatch',
+    outputs: [],
+    stateMutability: 'payable',
+    type: 'function',
+  },
+  {
+    inputs: [
+      { internalType: 'bytes32[]', name: 'tokenIds', type: 'bytes32[]' },
+      { internalType: 'bytes32[]', name: 'dataKeys', type: 'bytes32[]' },
+      { internalType: 'bytes[]', name: 'dataValues', type: 'bytes[]' },
+    ],
+    name: 'setDataBatchForTokenIds',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [
+      { internalType: 'bytes32', name: 'tokenId', type: 'bytes32' },
+      { internalType: 'bytes32', name: 'dataKey', type: 'bytes32' },
+      { internalType: 'bytes', name: 'dataValue', type: 'bytes' },
+    ],
+    name: 'setDataForTokenId',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [{ internalType: 'bytes4', name: 'interfaceId', type: 'bytes4' }],
+    name: 'supportsInterface',
+    outputs: [{ internalType: 'bool', name: '', type: 'bool' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [{ internalType: 'uint256', name: 'index', type: 'uint256' }],
+    name: 'tokenAt',
+    outputs: [{ internalType: 'bytes32', name: '', type: 'bytes32' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [{ internalType: 'address', name: 'tokenOwner', type: 'address' }],
+    name: 'tokenIdsOf',
+    outputs: [{ internalType: 'bytes32[]', name: '', type: 'bytes32[]' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [{ internalType: 'bytes32', name: 'tokenId', type: 'bytes32' }],
+    name: 'tokenOwnerOf',
+    outputs: [{ internalType: 'address', name: '', type: 'address' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'totalSupply',
+    outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [
+      { internalType: 'address', name: 'from', type: 'address' },
+      { internalType: 'address', name: 'to', type: 'address' },
+      { internalType: 'bytes32', name: 'tokenId', type: 'bytes32' },
+      { internalType: 'bool', name: 'force', type: 'bool' },
+      { internalType: 'bytes', name: 'data', type: 'bytes' },
+    ],
+    name: 'transfer',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [
+      { internalType: 'address[]', name: 'from', type: 'address[]' },
+      { internalType: 'address[]', name: 'to', type: 'address[]' },
+      { internalType: 'bytes32[]', name: 'tokenId', type: 'bytes32[]' },
+      { internalType: 'bool[]', name: 'force', type: 'bool[]' },
+      { internalType: 'bytes[]', name: 'data', type: 'bytes[]' },
+    ],
+    name: 'transferBatch',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [{ internalType: 'address', name: 'newOwner', type: 'address' }],
+    name: 'transferOwnership',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  { stateMutability: 'payable', type: 'receive' },
+]

package/src/decoder/plugins/enhanceBurntPix.ts

@@ -0,0 +1,132 @@
+import { standardAggregation } from '../aggregation'
+import { decodeEvent } from '../events'
+import type {
+  DecodeEventResult,
+  DecoderOptions,
+  DecoderResult,
+  PluginOptions,
+  ResultAggregate,
+} from '../types'
+import { createAggregationKey, standardPlugin } from '.'
+import { enhanceSetData } from './enhanceSetData'
+import RegistryAbi from './RegistryAbi'
+
+// Define aggregation state type
+interface RefineAggregationState {
+  callerCounts: Record<
+    string,
+    { count: number; tokenIds: Record<`0x${string}:${string}`, number> }
+  >
+  minBlock: number
+  maxBlock: number
+  count: number
+}
+
+// Create the refine aggregation
+const refineAggregation = standardAggregation<RefineAggregationState>({
+  key: 'refine',
+
+  map: (tx) => {
+    // Only process refine calls
+    if ('functionName' in tx && tx.functionName === 'refine' && tx.from) {
+      return {
+        callerCounts: {
+          [tx.from.toLowerCase()]: {
+            count: 1,
+            tokenIds: {
+              [`${tx.to}:${('args' in tx ? tx?.args?.[0]?.value : undefined) ?? 'none'}`]: 1,
+            },
+          },
+        },
+        minBlock: Number(tx.blockNumber),
+        maxBlock: Number(tx.blockNumber),
+        count: 1,
+      }
+    }
+    return undefined
+  },
+
+  reduce: (state, mapped) => {
+    if (!state) return mapped
+
+    // Merge caller counts
+    const callerCounts = { ...state.callerCounts }
+    for (const [caller, { count, tokenIds }] of Object.entries(
+      mapped.callerCounts
+    )) {
+      const item = callerCounts[caller] ?? { count: 0, tokenIds: {} }
+      item.count += count
+      item.tokenIds = {
+        ...item.tokenIds,
+        ...tokenIds,
+      }
+    }
+
+    return {
+      callerCounts,
+      minBlock: Math.min(state.minBlock, mapped.minBlock),
+      maxBlock: Math.max(state.maxBlock, mapped.maxBlock),
+      count: state.count + mapped.count,
+    }
+  },
+
+  finalize: (state): Omit<ResultAggregate, 'resultType'> => {
+    const stats = Object.entries(state.callerCounts)
+      .sort(([, a], [, b]) => b.count - a.count)
+      .slice(0, 10)
+      .map(([address, { count, tokenIds }]) => {
+        const tokens = Object.entries(tokenIds)
+          .sort(([, a], [, b]) => b - a)
+          .slice(0, 5)
+          .map(([token]) => token)
+        return { address, count, tokens }
+      })
+    return {
+      aggregate: {
+        count: state.count,
+        from: stats.map(({ address }) => address),
+        tokens: stats.flatMap(({ tokens }) => tokens),
+        blockRange: {
+          from: state.minBlock,
+          to: state.maxBlock,
+        },
+      },
+    }
+  },
+})
+
+export const enhanceBurntPixPlugin = standardPlugin(
+  RegistryAbi,
+  {
+    name: 'burntpix',
+    abiName: 'BurntPix',
+    decoderName: '@lukso/burntpix',
+    priority: 50,
+  },
+  {
+    enhance: enhanceBurntPix,
+    decodeEvent: async (log: DecodeEventResult, options: DecoderOptions) => {
+      return decodeEvent(options.chain, RegistryAbi, log)
+    },
+    aggregations: [refineAggregation],
+  }
+)
+
+export async function enhanceBurntPix(
+  result: DecoderResult,
+  pluginOptions: PluginOptions,
+  options: DecoderOptions
+): Promise<DecoderResult | undefined> {
+  // Mark refine transactions as aggregatable
+  if ('functionName' in result && result.functionName === 'refine') {
+    return {
+      ...result,
+      standard: pluginOptions.abiName,
+      __decoder: pluginOptions.decoderName,
+      aggregationKeys: [createAggregationKey(pluginOptions, 'refine')],
+    } as DecoderResult
+  }
+  return undefined
+}
+
+export default enhanceBurntPixPlugin