refactor: Activities

docs/specifications/activities/class-diagram.md

@@ -42,7 +42,6 @@ classDiagram
  - type: ActivityType.Basic
  - rawAmount: number
  - assetId: string
- - publicNote: string
  - isShimmerClaiming: boolean
  }
  class Nft Activity {

packages/shared/lib/contexts/onboarding/stores/shimmer-claiming-transactions.store.ts

@@ -12,7 +12,7 @@ export const shimmerClaimingTransactions: Writable<IShimmerClaimingTransactionSt
  {}
 )
 
-export function isShimmerClaimingTransaction(transactionId: string, profileId?: string): boolean {
+export function isShimmerClaimingTransaction(transactionId: string, profileId: string | undefined | null): boolean {
  const _shimmerClaimingTransactions = get(shimmerClaimingTransactions)
  profileId = profileId ? profileId : get(onboardingProfile)?.id
  return !!_shimmerClaimingTransactions?.[profileId]?.[transactionId]

packages/shared/lib/core/wallet/actions/activities/hideActivitiesForHiddenAssets.ts

@@ -8,7 +8,7 @@ export function hideActivitiesForHiddenAssets(): void {
  const assets = get(persistedAssets)?.[get(activeProfile)?.id]
  allWalletActivities.update((state) => {
  state[get(selectedWalletId)].forEach((_activity) => {
- if (_activity.type === ActivityType.Basic || _activity.type === ActivityType.Foundry) {
+ if (_activity.type === ActivityType.Transaction || _activity.type === ActivityType.Foundry) {
  const isAssetHidden = !assets[_activity.assetId] || assets[_activity.assetId]?.hidden
  updateActivityFromPartialActivity(_activity, { isAssetHidden })
  }

packages/shared/lib/core/wallet/actions/activities/linkTransactionsWithClaimingTransactions.ts

@@ -5,6 +5,8 @@ import { isOutputAsync } from '@core/wallet/utils/outputs/isOutputAsync'
 import { get } from 'svelte/store'
 import { addClaimedActivity, claimedActivities } from '../../stores'
 
+// TODO: Refactor and clean this
+
 /**
  * It takes a list of transactions and links the transactions that are claiming async transactions
  * @param {IProcessedTransaction[]} transactions - IProcessedTransaction[]

packages/shared/lib/core/wallet/actions/activities/loadAssetsForAllWallets.ts

@@ -11,7 +11,7 @@ export async function loadAssetsForAllWallets(wallet: IWalletState): Promise<voi
  const persistedAssets: IPersistedAsset[] = []
  for (const activity of walletActivities) {
  try {
- if (activity.type === ActivityType.Basic || activity.type === ActivityType.Foundry) {
+ if (activity.type === ActivityType.Transaction || activity.type === ActivityType.Foundry) {
  const asset = await getOrRequestAssetFromPersistedAssets(activity.assetId)
  if (asset) {
  persistedAssets.push(asset)

packages/shared/lib/core/wallet/actions/activities/updateClaimingTransactionInclusion.ts

@@ -17,7 +17,7 @@ export function updateClaimingTransactionInclusion(
  if (activity) {
  if (inclusionState === InclusionState.Confirmed) {
  updateActivityFromPartialActivity(activity, {
- type: ActivityType.Basic,
+ type: ActivityType.Transaction,
  asyncData: {
  ...activity.asyncData,
  isClaiming: false,
@@ -36,9 +36,9 @@ export function updateClaimingTransactionInclusion(
  alert: true,
  message: localize('notifications.claimed.success'),
  })
- } else if (inclusionState === InclusionState.Conflicting) {
+ } else if (inclusionState === InclusionState.Conflicting) { // TODO: Fix this
  updateActivityFromPartialActivity(activity, {
- type: ActivityType.Basic,
+ type: ActivityType.Transaction,
  asyncData: {
  ...activity.asyncData,
  isClaiming: false,

packages/shared/lib/core/wallet/actions/events-handlers/handleNewOutputEvent.ts

@@ -79,7 +79,7 @@ export async function handleNewOutputEventInternal(walletId: string, payload: Ne
 
  const activities = await generateActivities(processedOutput, wallet)
  for (const activity of activities) {
- if (activity.type === ActivityType.Basic || activity.type === ActivityType.Foundry) {
+ if (activity.type === ActivityType.Transaction || activity.type === ActivityType.Foundry) {
  const asset = await getOrRequestAssetFromPersistedAssets(activity.assetId)
  if (asset) {
  addPersistedAsset(asset)

packages/shared/lib/core/wallet/constants/default-activity-filter.constant.ts

@@ -42,9 +42,9 @@ export const DEFAULT_ACTIVITY_FILTER: ActivityFilter = {
  active: false,
  type: 'selection',
  localeKey: 'filters.type',
- selected: ActivityType.Basic,
+ selected: ActivityType.Transaction,
  choices: [
- ActivityType.Basic,
+ ActivityType.Transaction,
  ActivityType.Nft,
  ActivityType.Account,
  ActivityType.Governance,

packages/shared/lib/core/wallet/enums/activity-type.enum.ts

@@ -1,6 +1,6 @@
 export enum ActivityType {
  Account = 'account',
- Basic = 'basic',
+ Transaction = 'transaction',
  Foundry = 'foundry',
  Consolidation = 'consolidation',
  Governance = 'governance',

packages/shared/lib/core/wallet/enums/inclusion-state.enum.ts

@@ -1,6 +1,8 @@
+// TODO: Remove this and use the SDK version.
 export enum InclusionState {
  Pending = 'Pending',
+ Accepted = 'Accepted',
  Confirmed = 'Confirmed',
- Conflicting = 'Conflicting',
- UnknownPruned = 'UnknownPruned',
+ Finalized = 'Finalized',
+ Failed = 'Failed',
 }

packages/shared/lib/core/wallet/interfaces/activity-generation-parameters.interface.ts

@@ -1,9 +1,15 @@
 import { ActivityAction } from '../enums'
-import { IProcessedTransaction } from './processed-transaction.interface'
+import { IProcessedTransaction, ProcessedTransaction } from './processed-transaction.interface'
 import { IWrappedOutput } from './wrapped-output.interface'
 
 export interface IActivityGenerationParameters {
  action: ActivityAction
  processedTransaction: IProcessedTransaction
  wrappedOutput: IWrappedOutput
 }
+
+export interface ActivityGenerationParameters {
+ action: ActivityAction
+ processedTransaction: ProcessedTransaction
+ wrappedOutput: IWrappedOutput
+}

packages/shared/lib/core/wallet/interfaces/processed-transaction.interface.ts

@@ -1,6 +1,17 @@
-import { ActivityDirection, InclusionState } from '@core/wallet/enums'
+import { ActivityDirection } from '@core/wallet/enums'
 import { IWrappedOutput } from './wrapped-output.interface'
-import { UTXOInput } from '@iota/sdk/out/types'
+import { CommonOutput, NftOutput, OutputType, UTXOInput, InclusionState } from '@iota/sdk/out/types'
+import {
+ getNativeTokenFromOutput,
+ getNftId,
+ getRecipientFromOutput,
+ getSenderAddressFromInputs,
+ getSenderFromTransaction,
+ getSubjectFromAddress,
+ isSubjectInternal,
+} from '../utils'
+import { IWalletState } from './wallet-state.interface'
+import { SenderInfo } from '../types'
 
 export interface IProcessedTransaction {
  outputs: IWrappedOutput[]
@@ -17,3 +28,109 @@ export interface IClaimData {
  claimedDate: Date
  claimingTransactionId: string
 }
+
+export class ProcessedTransaction {
+ constructor(
+ public outputs: IWrappedOutput[],
+ public transactionId: string,
+ public direction: ActivityDirection,
+ public time: Date,
+ public inclusionState: InclusionState,
+ public utxoInputs: UTXOInput[],
+ public wrappedInputs: IWrappedOutput[],
+ public claimingData?: IClaimData
+ ) {}
+
+ getSendingInformation(wallet: IWalletState, output: CommonOutput): SenderInfo {
+ const recipient = getRecipientFromOutput(output)
+ const sender = this.wrappedInputs?.length
+ ? getSubjectFromAddress(getSenderAddressFromInputs(wrappedInputs)) // TODO: Fix this
+ : getSenderFromTransaction(this.direction === ActivityDirection.Incoming, wallet.depositAddress, output)
+
+ const subject = this.direction === ActivityDirection.Incoming ? sender : recipient
+ const isInternal = isSubjectInternal(subject)
+
+ return {
+ subject,
+ isInternal,
+ }
+ }
+
+ getBurnedNftInputs(): IWrappedOutput[] {
+ return this.wrappedInputs.filter((wrappedInput) => {
+ const input = wrappedInput.output
+ if (input.type === OutputType.Nft) {
+ const nftInput = input as NftOutput
+ const nftId = getNftId(nftInput.nftId, wrappedInput.outputId)
+
+ const isIncludedInOutputs = this.outputs.some((output) => {
+ if (output.output.type === OutputType.Nft) {
+ const nftOutput = output.output as NftOutput
+ return getNftId(nftOutput.nftId, output.outputId) === nftId
+ } else {
+ return false
+ }
+ })
+
+ return !isIncludedInOutputs
+ } else {
+ return false
+ }
+ })
+ }
+
+ getBurnedNativeTokens(): { assetId: string; amount: number } | undefined {
+ // If the transaction is unblanced and there is a surplus of native tokens on the
+ // input side of the transaction: the transaction destroys tokens.
+ if (this.direction !== ActivityDirection.SelfTransaction) {
+ return
+ }
+
+ const inputNativeTokens: { [key: string]: number } = ProcessedTransaction.getAllNativeTokensFromOutputs(
+ this.wrappedInputs
+ )
+ // No burned native tokens if input doesn't contain any native tokens
+ if (Object.keys(inputNativeTokens).length === 0) {
+ return
+ }
+
+ const outputNativeTokens: { [key: string]: number } = ProcessedTransaction.getAllNativeTokensFromOutputs(
+ this.outputs
+ )
+ // Find missing native tokens in outputNativeTokens (ex. input native tokens count === 3, output native tokens count === 2)
+ // TO DO: adjust UI to account for burining entire amounts of multiple native tokens in one transaction.
+ // We assume here that transaction burns entire amount of only one token.
+ // There may be transactions created outside of FF that burn entire amount for multiple tokens from the input side
+ // (ex.input native tokens count === 3, output native tokens count === 0)
+ let burnedTokenKeys: string[] = Object.keys(inputNativeTokens).filter((key) => !(key in outputNativeTokens))
+ if (Object.keys(burnedTokenKeys).length > 0) {
+ return { assetId: burnedTokenKeys[0], amount: inputNativeTokens[burnedTokenKeys[0]] }
+ }
+ // Check if the amount of output native token was larger on the input side (partially burned native tokens)
+ burnedTokenKeys = Object.keys(outputNativeTokens).filter(
+ (key) => outputNativeTokens[key] < inputNativeTokens[key]
+ )
+ if (Object.keys(burnedTokenKeys).length > 0) {
+ const burnedAmount = inputNativeTokens[burnedTokenKeys[0]] - Number(outputNativeTokens[burnedTokenKeys[0]])
+ return { assetId: burnedTokenKeys[0], amount: burnedAmount }
+ }
+ }
+
+ static getAllNativeTokensFromOutputs(outputs: IWrappedOutput[]): { [key: string]: number } {
+ const nativeTokens: { [key: string]: number } = {}
+ for (const output of outputs) {
+ if (output.output.type === OutputType.Foundry || output.output.type === OutputType.Basic) {
+ const commonOutput = output.output as CommonOutput
+ const nativeToken = getNativeTokenFromOutput(commonOutput)
+ if (nativeToken) {
+ if (!nativeTokens[nativeToken.id]) {
+ nativeTokens[nativeToken.id] = 0
+ }
+
+ nativeTokens[nativeToken.id] += Number(nativeToken.amount)
+ }
+ }
+ }
+ return nativeTokens
+ }
+}

packages/shared/lib/core/wallet/stores/selected-wallet-activities.store.ts

@@ -28,14 +28,15 @@ export const activitySearchTerm: Writable<string> = writable('')
 export const queriedActivities: Readable<Activity[]> = derived(
  [selectedWalletActivities, activitySearchTerm, activityFilter],
  ([$selectedWalletActivities, $activitySearchTerm]) => {
+ // TODO: Refactor this an clean up.
  let activityList = $selectedWalletActivities.filter((_activity) => {
- const containsAssets = _activity.type === ActivityType.Basic || _activity.type === ActivityType.Foundry
+ const containsAssets = _activity.type === ActivityType.Transaction || _activity.type === ActivityType.Foundry
  if (!_activity.isHidden && !containsAssets) {
  return true
  }
 
  const asset =
- _activity.type === ActivityType.Basic || _activity.type === ActivityType.Foundry
+ _activity.type === ActivityType.Transaction || _activity.type === ActivityType.Foundry
  ? getAssetFromPersistedAssets(_activity.assetId)
  : undefined
  const hasValidAsset = asset?.metadata && isValidIrc30Token(asset.metadata)
@@ -64,7 +65,7 @@ function getFieldsToSearchFromActivity(activity: Activity): string[] {
  fieldsToSearch.push(activity.transactionId)
  }
 
- if ((activity.type === ActivityType.Basic || activity.type === ActivityType.Foundry) && activity.assetId) {
+ if ((activity.type === ActivityType.Transaction || activity.type === ActivityType.Foundry) && activity.assetId) {
  fieldsToSearch.push(activity.assetId)
 
  const assetName = getAssetFromPersistedAssets(activity.assetId)?.metadata?.name
@@ -73,7 +74,7 @@ function getFieldsToSearchFromActivity(activity: Activity): string[] {
  }
  }
 
- if ((activity.type === ActivityType.Basic || activity.type === ActivityType.Foundry) && activity.rawAmount) {
+ if ((activity.type === ActivityType.Transaction || activity.type === ActivityType.Foundry) && activity.rawAmount) {
  fieldsToSearch.push(activity.rawAmount?.toString())
  fieldsToSearch.push(getFormattedAmountFromActivity(activity, false)?.toLowerCase())
  }