diff --git a/.changeset/old-feet-hear.md b/.changeset/old-feet-hear.md new file mode 100644 index 000000000..31f2ff225 --- /dev/null +++ b/.changeset/old-feet-hear.md @@ -0,0 +1,5 @@ +--- +'@cypherock/cysync-desktop': patch +--- + +Add a guide for verifying app downloads to the README. diff --git a/README.md b/README.md index 9e99bc0db..8d0678832 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,42 @@ ## Table of contents 1. [Prerequisites](#prerequisites) -2. [Understanding the directory structure](#understanding-the-directory-structure) -3. [Development Setup](#development-setup) -4. [Local setup](#local-setup) -5. [Other commands](#other-commands) -6. [Contributing](#contributing) +2. [Verifying Your CySync Download](#verifying-your-cysync-download) +3. [Understanding the directory structure](#understanding-the-directory-structure) +4. [Development Setup](#development-setup) +5. [Local setup](#local-setup) +6. [Other commands](#other-commands) +7. [Contributing](#contributing) + +## Verifying Your CySync Download + +To ensure the CySync application you downloaded is legitimate and has not been corrupted, you should verify its checksum. This process confirms the file's integrity. + +Each release on the [official releases page](https://github.com/Cypherock/cypherock-cysync/releases) includes a `sha256sum.txt` file containing the correct checksums for the application files. + +**Steps to Verify:** + +1. Download the CySync application for your system (e.g., `CySync-2.2.0.AppImage`) and the corresponding `sha256sum.txt` file from the same release. + +2. Open a terminal or command prompt and navigate to the folder where you downloaded the files. + +3. Run the appropriate command for your operating system: + + - **On Linux and macOS:** + + ```bash + sha256sum CySync-2.2.0.AppImage + ``` + + - **On Windows (using PowerShell):** + ```powershell + Get-FileHash -Algorithm SHA256 .\CySync-2.2.0.exe + ``` + _(Replace the filename with the one you downloaded)_ + +4. Compare the long string of characters (the hash) generated by the command with the hash listed inside the `sha256sum.txt` file. + +**If they match exactly, your download is authentic and safe to use!** If they don't match, do not run the application and try downloading it again. ## Prerequisites diff --git a/packages/cysync-core/src/dialogs/Send/Dialogs/Components/AddressAndAmountSection/SingleTransaction.tsx b/packages/cysync-core/src/dialogs/Send/Dialogs/Components/AddressAndAmountSection/SingleTransaction.tsx index 589e212fd..aef610732 100644 --- a/packages/cysync-core/src/dialogs/Send/Dialogs/Components/AddressAndAmountSection/SingleTransaction.tsx +++ b/packages/cysync-core/src/dialogs/Send/Dialogs/Components/AddressAndAmountSection/SingleTransaction.tsx @@ -18,6 +18,7 @@ import { BigNumber } from '@cypherock/cysync-utils'; import { AccountTypeMap } from '@cypherock/db-interfaces'; import React, { useEffect, useState } from 'react'; +import { useCurrency } from '~/context'; import { selectLanguage, useAppSelector } from '~/store'; import { AddressInput } from './AddressInput'; @@ -28,7 +29,6 @@ import { NotesInput } from './NotesInput'; import { StellarMemoInput } from './StellarMemoInput'; import { useSendDialog } from '../../../context'; -import { useCurrency } from '~/context'; const MAX_UINT64 = new BigNumber('0xffffffffffffffff'); diff --git a/packages/cysync-core/src/dialogs/SwapDialog.tsx b/packages/cysync-core/src/dialogs/SwapDialog.tsx index 5fdd03c75..7584ba731 100644 --- a/packages/cysync-core/src/dialogs/SwapDialog.tsx +++ b/packages/cysync-core/src/dialogs/SwapDialog.tsx @@ -21,8 +21,8 @@ import { } from '@cypherock/cysync-ui'; import { SwapStatus } from '@cypherock/db-interfaces'; import React, { FC, useMemo } from 'react'; -import { useSwap } from '~/context'; +import { useSwap } from '~/context'; import { SwapTransactionRowData, useSwapTransactions } from '~/hooks'; import { closeDialog, diff --git a/packages/cysync-core/src/services/swapService.ts b/packages/cysync-core/src/services/swapService.ts index 11ac91a31..272d4e482 100644 --- a/packages/cysync-core/src/services/swapService.ts +++ b/packages/cysync-core/src/services/swapService.ts @@ -1,5 +1,6 @@ -import axios from 'axios'; import { SupportedProviders } from '@cypherock/db-interfaces'; +import axios from 'axios'; + import { config } from '../config'; const SUPPORTED_PROVIDERS = Object.values(SupportedProviders) as string[];