chore: migrate to @iota/sdk

docs/standard-operating-procedures/development/releases.md

@@ -31,7 +31,6 @@ This SOP is only applicable to maintainers of this repository, that are responsi
 * [Regular Releases](#regular-releases)
 * [Milestone Releases](#milestone-releases)
 * [Hotfix Releases](#hotfix-releases)
-* [@iota/wallet (NPM) release](#iotawallet-npm-release)
 
 ## External References
 
@@ -287,23 +286,3 @@ After the hotfix has been released we can then merge the release branch into bot
 * Do **not** use squash and merge at this point as we will loose the commit history used for the changelog
 * Do **not** delete the release branch, as it will be used as the base for hotfixes in the future
 
-## @iota/wallet (NPM) Release
-
-The Firefly team is partly responsible for the npm package release of the [wallet.rs bindings](https://github.com/iotaledger/wallet.rs/tree/production/bindings/nodejs). The package serves
-as the backend of the application. The following steps describe the release process of the wallet.rs bindings.
-
-### 1. Opening changelog PR
-
-To trigger the release process, you add a markdown file describing the type of release (major/minor/patch) together with a description of what changed.
-The GitHub action expects the file to be under `wallet.rs/.changes`. More information can be found [here](https://github.com/iotaledger/wallet.rs/tree/production/.changes#readme).
-
-[Here](https://github.com/iotaledger/wallet.rs/pull/1212) is an example PR.
-
-The merge of this PR triggers the action described in the following step.
-
-### 2. Merge the release PR
-
-Upon merging the PR from the previous step, GitHub actions automatically opens a new PR. This PR deletes the previously added .md file and updates
-the package.json file and appends the changelog message to the changelog file. Merging this PR triggers the automatic release of the npm package.
-
-[Here](https://github.com/iotaledger/wallet.rs/pull/1216) is an example PR.

package.json

@@ -6,7 +6,6 @@
     ],
     "devDependencies": {
         "@babel/eslint-parser": "^7.15.0",
-        "@iota/types": "^1.0.0-beta.9",
         "@types/node": "^18.15.11",
         "@typescript-eslint/eslint-plugin": "^5.58.0",
         "@typescript-eslint/parser": "^5.57.1",

packages/desktop/components/ProposalAnswer.svelte

@@ -1,5 +1,5 @@
 <script lang="ts">
-    import type { Answer } from '@iota/wallet'
+    import type { Answer } from '@iota/sdk/out/types'
 
     import { Icon, PingingBadge, Text, TooltipIcon } from '@ui'
     import { FontWeight, Position } from '@ui/enums'

packages/desktop/components/ProposalQuestion.svelte

@@ -1,5 +1,5 @@
 <script lang="ts">
-    import type { AnswerStatus, Question } from '@iota/wallet'
+    import type { AnswerStatus, Question } from '@iota/sdk/out/types'
 
     import { ProposalAnswer } from '@components'
     import { Icon, Text, TooltipIcon } from '@ui'
@@ -53,7 +53,7 @@
     cursor-pointer dark:border-transparent dark:bg-gray-850"
     class:animate-pulse={isLoading}
 >
     <button on:click={() => onQuestionClick(questionIndex)} class="flex justify-between items-center">
         <div class="flex flex-col min-w-0">
             {#if questionIndex !== undefined}
                 <Text smaller fontWeight={FontWeight.bold} overrideColor classes="mb-1 text-blue-500">
@@ -95,7 +95,7 @@
                 isWinner={answerIndex === winnerAnswerIndex}
                 proposalStatus={$selectedProposal?.status}
                 truncate={!isOpened}
                 onAnswerClick={() => onAnswerClick(answer.value, questionIndex)}
             />
         {/each}
     </proposal-answers>

packages/desktop/components/popups/AddProposalPopup.svelte

@@ -7,7 +7,7 @@
     import { localize } from '@core/i18n'
     import { activeAccounts, updateActiveAccountPersistedData } from '@core/profile'
     import { truncateString } from '@core/utils/string'
-    import type { Auth } from '@iota/wallet'
+    import type { Auth } from '@iota/sdk/out/types'
     import { Button, Checkbox, NodeInput, Text, TextInput, TextType } from 'shared/components'
     import { HTMLButtonType } from 'shared/components/enums'
 

packages/desktop/components/popups/AliasConfirmationPopup.svelte

@@ -1,38 +1,34 @@
 <script lang="ts">
     import { Button, KeyValueBox, Text, FontWeight, TextType } from 'shared/components'
     import { selectedAccount, updateSelectedAccount } from '@core/account'
+    import { api, getClient } from '@core/profile-manager'
     import { localize } from '@core/i18n'
     import { checkActiveProfileAuth, getBaseToken } from '@core/profile'
-    import {
-        convertBech32ToHexAddress,
-        formatTokenAmountPrecise,
-        EMPTY_HEX_ID,
-        UNLOCK_CONDITION_GOVERNOR_ADDRESS,
-        UNLOCK_CONDITION_STATE_CONTROLLER_ADDRESS,
-        processAndAddToActivities,
-    } from '@core/wallet'
+    import { formatTokenAmountPrecise, EMPTY_HEX_ID, processAndAddToActivities } from '@core/wallet'
+    import { AliasOutput, UnlockConditionType, PreparedTransaction } from '@iota/sdk/out/types'
     import { closePopup } from '@auxiliary/popup'
     import { onMount } from 'svelte'
     import { handleError } from '@core/error/handlers/handleError'
+    import { plainToInstance } from 'class-transformer'
 
     export let _onMount: (..._: any[]) => Promise<void> = async () => {}
 
     let storageDeposit: string = '0'
 
     $: address = {
         type: 0,
-        pubKeyHash: convertBech32ToHexAddress($selectedAccount.depositAddress),
+        pubKeyHash: api.bech32ToHex($selectedAccount.depositAddress),
     }
     $: aliasOutput = address
         ? {
               aliasId: EMPTY_HEX_ID,
               unlockConditions: [
                   {
-                      type: UNLOCK_CONDITION_GOVERNOR_ADDRESS,
+                      type: UnlockConditionType.GovernorAddress,
                       address,
                   },
                   {
-                      type: UNLOCK_CONDITION_STATE_CONTROLLER_ADDRESS,
+                      type: UnlockConditionType.StateControllerAddress,
                       address,
                   },
               ],
@@ -42,9 +38,10 @@
     $: void setStorageDeposit(aliasOutput)
     $: isTransferring = $selectedAccount.isTransferring
 
-    async function setStorageDeposit(aliasOutput): Promise<void> {
+    async function setStorageDeposit(aliasOutput: AliasOutput): Promise<void> {
         try {
-            const { amount } = await $selectedAccount.buildAliasOutput(aliasOutput)
+            const client = await getClient()
+            const { amount } = await client.buildAliasOutput(aliasOutput)
             storageDeposit = formatTokenAmountPrecise(Number(amount), getBaseToken())
         } catch (err) {
             handleError(err)
@@ -54,7 +51,9 @@
     async function createAlias(): Promise<void> {
         try {
             updateSelectedAccount({ isTransferring: true })
-            const transaction = await $selectedAccount.createAliasOutput()
+            const transaction = await $selectedAccount
+                .prepareCreateAliasOutput()
+                .then((prepared) => plainToInstance(PreparedTransaction, prepared).send())
             await processAndAddToActivities(transaction, $selectedAccount)
             closePopup()
         } catch (err) {

packages/desktop/components/popups/BalanceBreakdownPopup.svelte

@@ -3,15 +3,9 @@
     import { selectedAccount } from '@core/account'
     import { localize } from '@core/i18n'
     import { checkActiveProfileAuth } from '@core/profile'
-    import {
-        OUTPUT_TYPE_TREASURY,
-        UNLOCK_CONDITION_EXPIRATION,
-        UNLOCK_CONDITION_STORAGE_DEPOSIT_RETURN,
-        UNLOCK_CONDITION_TIMELOCK,
-    } from '@core/wallet'
     import { consolidateOutputs } from '@core/wallet/actions/consolidateOutputs'
     import { getStorageDepositFromOutput } from '@core/wallet/utils/generateActivity/helper'
-    import type { UnlockConditionTypes } from '@iota/types'
+    import { UnlockCondition, UnlockConditionType, OutputType, CommonOutput } from '@iota/sdk/out/types'
     import { TextHintVariant } from 'shared/components/enums'
     import { BalanceSummarySection, Button, FontWeight, Text, TextType } from 'shared/components'
 
@@ -58,16 +52,18 @@
 
                 let type: string
                 let amount: number
-                if (output.type !== OUTPUT_TYPE_TREASURY) {
-                    if (containsUnlockCondition(output.unlockConditions, UNLOCK_CONDITION_EXPIRATION)) {
+                if (output.type !== OutputType.Treasury) {
+                    const commonOutput = output as CommonOutput
+                    if (containsUnlockCondition(commonOutput.unlockConditions, UnlockConditionType.Expiration)) {
                         type = PendingFundsType.Unclaimed
                         amount = Number(output.amount)
                     } else if (
-                        containsUnlockCondition(output.unlockConditions, UNLOCK_CONDITION_STORAGE_DEPOSIT_RETURN)
+                        containsUnlockCondition(commonOutput.unlockConditions, UnlockConditionType.StorageDepositReturn)
                     ) {
                         type = PendingFundsType.StorageDepositReturn
-                        amount = (await getStorageDepositFromOutput($selectedAccount, output))?.storageDeposit
-                    } else if (containsUnlockCondition(output.unlockConditions, UNLOCK_CONDITION_TIMELOCK)) {
+                        amount = (await getStorageDepositFromOutput($selectedAccount, output as CommonOutput))
+                            ?.storageDeposit
+                    } else if (containsUnlockCondition(commonOutput.unlockConditions, UnlockConditionType.Timelock)) {
                         type = PendingFundsType.Timelock
                         amount = Number(output.amount)
                     }
@@ -115,7 +111,7 @@
         return { amount: totalStorageDeposit, subBreakdown }
     }
 
-    function containsUnlockCondition(unlockConditions: UnlockConditionTypes[], unlockConditionId: number) {
+    function containsUnlockCondition(unlockConditions: UnlockCondition[], unlockConditionId: number): boolean {
         return unlockConditions.some((unlockCondition) => unlockCondition.type === unlockConditionId)
     }
 

packages/desktop/components/popups/MintNativeTokenConfirmationPopup.svelte

@@ -13,6 +13,7 @@
     import { closePopup, openPopup, PopupId } from '@auxiliary/popup'
     import { Button, KeyValueBox, Text, FontWeight, TextType } from 'shared/components'
     import { onMount } from 'svelte'
+    import { getClient } from '@core/profile-manager'
     import { selectedAccount } from '@core/account'
     import { handleError } from '@core/error/handlers/handleError'
 
@@ -33,7 +34,8 @@
                 metadata,
                 aliasId
             )
-            const preparedOutput = await $selectedAccount.buildFoundryOutput(outputData)
+            const client = await getClient()
+            const preparedOutput = await client.buildFoundryOutput(outputData)
             storageDeposit = formatTokenAmountPrecise(Number(preparedOutput.amount) ?? 0, getBaseToken())
         }
     }

packages/desktop/components/popups/MintNftConfirmationPopup.svelte

@@ -2,6 +2,7 @@
     import { onMount } from 'svelte'
     import { Button, Text, FontWeight, NftImageOrIconBox, Tabs, KeyValueBox, NftSize } from 'shared/components'
     import { localize } from '@core/i18n'
+    import { getClient } from '@core/profile-manager'
     import { selectedAccount } from '@core/account'
     import { buildNftOutputData, formatTokenAmountPrecise, mintNft, mintNftDetails } from '@core/wallet'
     import { getBaseToken, checkActiveProfileAuth } from '@core/profile'
@@ -51,7 +52,8 @@
 
     async function prepareNftOutput(): Promise<void> {
         const outputData = buildNftOutputData(irc27Metadata, $selectedAccount.depositAddress)
-        const preparedOutput = await $selectedAccount.buildNftOutput(outputData)
+        const client = await getClient()
+        const preparedOutput = await client.buildNftOutput(outputData)
         storageDeposit = Number(preparedOutput.amount) ?? 0
         totalStorageDeposit = storageDeposit * quantity
     }

packages/desktop/components/popups/NodeAuthRequiredPopup.svelte

@@ -1,6 +1,6 @@
 <script lang="ts">
     import { Button, HTMLButtonType, Text, TextInput, TextType } from 'shared/components'
-    import type { Auth } from '@iota/wallet'
+    import type { Auth } from '@iota/sdk/out/types'
     import { handleError } from '@core/error/handlers'
     import { localize } from '@core/i18n'
     import { closePopup } from '@auxiliary/popup'

packages/desktop/components/popups/send/SendConfirmationPopup.svelte

@@ -24,7 +24,8 @@
     import { sendOutput } from '@core/wallet/actions'
     import { DEFAULT_TRANSACTION_OPTIONS } from '@core/wallet/constants'
     import { getOutputParameters, validateSendConfirmation, getAddressFromSubject } from '@core/wallet/utils'
-    import { Activity, NewTokenTransactionDetails, Output } from '@core/wallet/types'
+    import { Activity, NewTokenTransactionDetails } from '@core/wallet/types'
+    import { CommonOutput, Output } from '@iota/sdk/out/types'
     import { closePopup, openPopup, PopupId } from '@auxiliary/popup'
     import { ledgerPreparedOutput } from '@core/ledger'
     import { getStorageDepositFromOutput } from '@core/wallet/utils/generateActivity/helper'
@@ -145,7 +146,7 @@
 
     async function updateStorageDeposit(): Promise<void> {
         const { storageDeposit: _storageDeposit, giftedStorageDeposit: _giftedStorageDeposit } =
-            await getStorageDepositFromOutput($selectedAccount, preparedOutput)
+            await getStorageDepositFromOutput($selectedAccount, preparedOutput as CommonOutput)
         storageDeposit = minimumStorageDeposit = _storageDeposit > 0 ? _storageDeposit : _giftedStorageDeposit
         if (isBaseTokenTransfer) {
             const rawAmount = Number((transactionDetails as NewTokenTransactionDetails).rawAmount)
@@ -166,7 +167,7 @@
 
     async function onConfirmClick(): Promise<void> {
         try {
-            await validateSendConfirmation($selectedAccount, preparedOutput)
+            await validateSendConfirmation($selectedAccount, preparedOutput as CommonOutput)
 
             if ($isActiveLedgerProfile) {
                 ledgerPreparedOutput.set(preparedOutput)

packages/desktop/electron-builder-config.js

@@ -46,7 +46,7 @@ const prodConfig = () => ({
     artifactName: 'firefly-desktop-${version}.${ext}',
     copyright: 'IOTA Foundation',
     directories: { buildResources: './public', output: './out' },
-    files: ['public/', 'package.json', '!node_modules/@iota/wallet/target/*'],
+    files: ['public/', 'package.json', '!node_modules/@iota/sdk/target/*'],
     appId: APP_ID,
     afterSign: async () => {
         // eslint-disable-next-line no-useless-catch

packages/desktop/electron/preload.js

@@ -8,7 +8,7 @@
 
 const { ipcRenderer, contextBridge } = require('electron')
 const ElectronApi = require('./electronApi')
-const WalletApi = require('@iota/wallet')
+const IotaSdk = require('@iota/sdk')
 const fs = require('fs')
 
 const SEND_CRASH_REPORTS = window.process.argv.includes('--send-crash-reports=true')
@@ -65,7 +65,7 @@ try {
                 levelFilter: 'debug',
                 targetExclusions: ['h2', 'hyper', 'rustls', 'message_handler'],
             }
-            WalletApi.initLogger(loggerOptions)
+            IotaSdk.initLogger(loggerOptions)
 
             deleteOldLogs(logDir, versionDetails.currentVersion)
         })
@@ -96,47 +96,77 @@ try {
     // https://www.electronjs.org/docs/latest/api/context-bridge
     // This workaround exposes the classes through factory methods
     // The factory method also copies all the prototype methods to the object so that it gets passed through the bridge
+
+    const methodNames = Object.getOwnPropertyNames(IotaSdk.Utils).filter(
+        (m) => !['length', 'name', 'prototype'].includes(m)
+    )
+    const methods = {}
+
+    for (const name of methodNames) {
+        methods[name] = (...args) => IotaSdk.Utils[name](...args)
+    }
+
     contextBridge.exposeInMainWorld('__WALLET__API__', {
-        createAccountManager(id, options) {
-            const manager = new WalletApi.AccountManager(options)
+        ...methods,
+        async getNodeInfo(managerId, url, auth) {
+            const manager = profileManagers[managerId]
+            const client = await manager.getClient()
+            const nodeUrl = url ?? (await client.getNode()).url
+
+            const nodeInfo = await client.getNodeInfo(nodeUrl, auth)
+
+            return {
+                url: nodeUrl,
+                nodeInfo,
+            }
+        },
+        createWallet(id, options) {
+            const manager = new IotaSdk.Wallet(options)
             manager.id = id
             profileManagers[id] = manager
-            bindMethodsAcrossContextBridge(WalletApi.AccountManager.prototype, manager)
+            bindMethodsAcrossContextBridge(IotaSdk.Wallet.prototype, manager)
             return manager
         },
         async createAccount(managerId, payload) {
             const manager = profileManagers[managerId]
             const account = await manager.createAccount(payload)
-            bindMethodsAcrossContextBridge(WalletApi.Account.prototype, account)
+            bindMethodsAcrossContextBridge(IotaSdk.Account.prototype, account)
             return account
         },
-        deleteAccountManager(id) {
+        deleteWallet(id) {
             if (id && id in profileManagers) {
                 delete profileManagers[id]
             }
         },
         async getAccount(managerId, index) {
             const manager = profileManagers[managerId]
             const account = await manager.getAccount(index)
-            bindMethodsAcrossContextBridge(WalletApi.Account.prototype, account)
+            bindMethodsAcrossContextBridge(IotaSdk.Account.prototype, account)
             return account
         },
         async getAccounts(managerId) {
             const manager = profileManagers[managerId]
             const accounts = await manager.getAccounts()
-            accounts.forEach((account) => bindMethodsAcrossContextBridge(WalletApi.Account.prototype, account))
+            accounts.forEach((account) => bindMethodsAcrossContextBridge(IotaSdk.Account.prototype, account))
             return accounts
         },
         async recoverAccounts(managerId, payload) {
             const manager = profileManagers[managerId]
             const accounts = await manager.recoverAccounts(...Object.values(payload))
-            accounts.forEach((account) => bindMethodsAcrossContextBridge(WalletApi.Account.prototype, account))
+            accounts.forEach((account) => bindMethodsAcrossContextBridge(IotaSdk.Account.prototype, account))
             return accounts
         },
+        async getClient(managerId) {
+            const manager = profileManagers[managerId]
+            const client = await manager.getClient()
+            bindMethodsAcrossContextBridge(IotaSdk.Client.prototype, client)
+
+            return client
+        },
         async migrateStrongholdSnapshotV2ToV3(currentPath, newPath, currentPassword, newPassword) {
             const snapshotSaltV2 = 'wallet.rs'
             const snapshotRoundsV2 = 100
-            return WalletApi.migrateStrongholdSnapshotV2ToV3(
+            return IotaSdk.migrateStrongholdSnapshotV2ToV3(
                 currentPath,
                 newPath,
                 snapshotSaltV2,

packages/desktop/index.js

@@ -1,3 +1,5 @@
+// needed for features from @iota/sdk which use reflection (decorators)
+import 'reflect-metadata'
 import App from './App.svelte'
 import { Electron } from './lib/electron'
 import { shouldReportError } from './electron/lib/errorHandling'

packages/desktop/views/dashboard/governance/views/ProposalDetailsView.svelte

@@ -1,5 +1,5 @@
 <script lang="ts">
-    import { VotingEventPayload, ParticipationEventType, TrackedParticipationOverview } from '@iota/wallet/out/types'
+    import { VotingEventPayload, ParticipationEventType, TrackedParticipationOverview } from '@iota/sdk/out/types'
 
     import { onMount, onDestroy } from 'svelte'