Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions .github/ISSUE_TEMPLATE/02_Suite_bug.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ A clear and concise description of what the bug is.

**Info:**

- Remembered Wallet: yes/no
- Suite Version: app/web, commit
- Browser: name, version
- Browser Installation Method: snap, flatpak, app store, windows store, downloaded installer, etc.
- OS: name, version
- Bridge: version
- Firmware Version: model, version/commit
- Remembered Wallet: yes/no
- Suite Version: app/web, commit
- Browser: name, version
- Browser Installation Method: snap, flatpak, app store, windows store, downloaded installer, etc.
- OS: name, version
- Bridge: version
- Firmware Version: model, version/commit

**How to reproduce**
Steps to reproduce the behavior:
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/04_mobile_bug.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ A clear and concise description of what the bug is.

**Info:**

- Mobile Suite Version: version/commit
- OS: name, version
- Mobile Suite Version: version/commit
- OS: name, version

**How to reproduce**
Steps to reproduce the behavior:
Expand Down
2 changes: 1 addition & 1 deletion .github/actions/build-desktop/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ runs:
with:
name: desktop-app-build-e2e
path: app-build.tar.gz
retention-days: 7
retention-days: 7
4 changes: 2 additions & 2 deletions .github/actions/check-previous-test-runs/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -66,13 +66,13 @@ runs:
SUCCESSFUL_JOB_URL=$(echo "$PREVIOUS_RUN_RESPONSE" | jq -r '.workflow_runs[0].html_url')
echo "Previous successful job found: ${SUCCESSFUL_JOB_URL} - no need to run tests again"
echo "skip_tests=true" >> $GITHUB_OUTPUT

- name: Find skipped tests comment
uses: peter-evans/find-comment@v3
id: find-comment
with:
issue-number: ${{ github.event.pull_request.number }}
comment-author: 'trezor-ci'
comment-author: "trezor-ci"
body-includes: βœ… Previously successful run of **${{ inputs.workflow_name }}**

- name: Post skipped tests comment
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/build-suite-native-preview.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ on:
- "packages/transport-native-usb/**"
- "yarn.lock"
- ".github/workflows/build-suite-native-preview.yml"
- '!**.md'
- "!**.md"
# list of paths is not complete, but it's always possible to dispatch manually using 'build-mobile' label
workflow_dispatch:
# manual dispatch will not add any comment to PR, use label 'build-mobile' if PR exists
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release-suite-native-develop.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ on:
paths:
- "suite-native/**"
- "suite-common/**"
- '!**.md'
- "!**.md"
workflow_dispatch:

concurrency:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/test-suite-desktop-e2e-fw-canary.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ name: "[Test] Firmware canary Suite Desktop e2e tests"
permissions:
id-token: write # for fetching the OIDC token
contents: read # for actions/checkout

on:
schedule:
- cron: "0 0 * * *"
Expand All @@ -34,7 +34,7 @@ jobs:
- build-app
strategy:
fail-fast: false
matrix:
matrix:
TEST_GROUP: [1, 2, 3, 4, 5, 6, 7]
steps:
- name: Checkout
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/test-suite-desktop-e2e-nightly.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ jobs:
uses: actions/checkout@v4
- name: Build and Upload Suite Desktop
uses: ./.github/actions/build-desktop

run-e2e-suite-desktop-tests:
if: github.repository == 'trezor/trezor-suite'
runs-on: ubuntu-24.04
needs:
- build-app
strategy:
fail-fast: false
matrix:
matrix:
TEST_GROUP: [1, 2, 3, 4, 5, 6, 7]
steps:
- name: Checkout
Expand Down
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,30 @@

Welcome to the Trezor Suite repository! This repository contains the source code for 3 projects:

- **Connect** - tool that offers developers an easy way to integrate Trezor's functionality into their own applications
- **Trezor Suite** - desktop and web application for managing Trezor hardware wallet
- **Trezor Suite Lite** - Mobile application designed for tracking user portfolios
- **Connect** - tool that offers developers an easy way to integrate Trezor's functionality into their own applications
- **Trezor Suite** - desktop and web application for managing Trezor hardware wallet
- **Trezor Suite Lite** - Mobile application designed for tracking user portfolios

![img](https://repository-images.githubusercontent.com/148657224/439f6100-765f-11e9-9bff-b725eef3c4a6)

# Development

### Prerequisities

- Install [NVM](https://github.com/nvm-sh/nvm)
- Enable [Yarn](https://yarnpkg.com/getting-started/install) through npm
- Install [Git LFS](https://git-lfs.github.com/) (For Linux/Ubuntu, [after adding the repository](https://packagecloud.io/github/git-lfs/install) do `sudo apt-get install git-lfs`, more info [here](https://github.com/git-lfs/git-lfs/blob/main/INSTALLING.md))
- Install [NVM](https://github.com/nvm-sh/nvm)
- Enable [Yarn](https://yarnpkg.com/getting-started/install) through npm
- Install [Git LFS](https://git-lfs.github.com/) (For Linux/Ubuntu, [after adding the repository](https://packagecloud.io/github/git-lfs/install) do `sudo apt-get install git-lfs`, more info [here](https://github.com/git-lfs/git-lfs/blob/main/INSTALLING.md))

### Getting started

- `git clone git@github.com:trezor/trezor-suite.git`
- `cd trezor-suite`
- `git submodule update --init --recursive`
- `git lfs install` // Set up Git LFS for your user account. You only need to run this once per user account.
- `git lfs pull`
- `nvm install`
- `yarn`
- `yarn build:libs`
- `git clone git@github.com:trezor/trezor-suite.git`
- `cd trezor-suite`
- `git submodule update --init --recursive`
- `git lfs install` // Set up Git LFS for your user account. You only need to run this once per user account.
- `git lfs pull`
- `nvm install`
- `yarn`
- `yarn build:libs`

It's recommended to enable `git config --global submodule.recurse true` so you don't need to run `git submodule update --init --recursive` every time when submodules are updated.

Expand All @@ -44,9 +44,9 @@ though development on Windows is possible by following [this guide](https://docs

Run a dev build:

- `yarn suite:dev` (web app)
- `yarn suite:dev:vite` (⚠️ EXPERIMENTAL: web app with Vite bundler used for **development only**, use `yarn suite:dev` if you want fidelity to production app)
- `yarn suite:dev:desktop` (electron app)
- `yarn suite:dev` (web app)
- `yarn suite:dev:vite` (⚠️ EXPERIMENTAL: web app with Vite bundler used for **development only**, use `yarn suite:dev` if you want fidelity to production app)
- `yarn suite:dev:desktop` (electron app)

## **Trezor Suite Lite** @suite-native/app

Expand Down
90 changes: 45 additions & 45 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,48 +2,48 @@

[Introduction](./index.md)

- [Analytics](./analytics/index.md)
- [AWS](./analytics/aws.md)
- [Sentry](./analytics/sentry.md)
- [Releases](./releases/index.md)
- [adding new firmwares](./releases/adding-new-firmwares.md)
- [desktop updates](./releases/desktop_updates.md)
- [environments](./releases/environments.md)
- [npm packages](./releases/npm-packages.md)
- [signing binaries windows](./releases/signing-binaries-win.md)
- [versioning](./releases/versioning.md)
- [Packages](./packages/index.md)
- [@trezor/connect](./packages/connect/index.md)
- [dependencies](./packages/connect/dependencies.md)
- [protobuf](./packages/connect/protobuf-type-definitions.md)
- [coins support](./packages/connect/supported-coins.md)
- [events](./packages/connect/events.md)
- [path](./packages/connect/path.md)
- [methods](./packages/connect/methods.md)
- [@trezor/suite](./packages/suite/index.md)
- [send form](./packages/suite/send.md)
- [send form architecture](./packages/suite/send/ARCHITECTURE.md)
- [@trezor/suite-desktop](./packages/suite-desktop.md)
- [creating new package](./packages/creating-packages.md)
- [Features](./features/index.md)
- [coin handler](./features/protocols/coin-handler.md)
- [transactions export](./features/transactions/export.md)
- [transactions search](./features/transactions/search.md)
- [metadata labeling](./features/metadata.md)
- [fiat rates](./features/fiat-rates.md)
- [guide](./features/guide.md)
- [localization](./features/localization.md)
- [messaging system](./features/message-system.md)
- [feature flags](./features/feature-flags.md)
- [desktop logger](./features/desktop-logger.md)
- [onboarding](./features/onboarding/onboarding.md)
- [Tests](./tests/index.md)
- [e2e @trezor/suite-web](./tests/e2e-suite-web.md)
- [e2e @trezor/connect-popup](./tests/e2e-connect-popup.md)
- [regtest](./tests/regtest.md)
- [Miscellaneous](./misc/index.md)
- [build](./misc/build.md)
- [development on Windows](./misc/development-on-windows.md)
- [device naming](./misc/device-naming.md)
- [review](./misc/review.md)
- [videos](./misc/videos.md)
- [Analytics](./analytics/index.md)
- [AWS](./analytics/aws.md)
- [Sentry](./analytics/sentry.md)
- [Releases](./releases/index.md)
- [adding new firmwares](./releases/adding-new-firmwares.md)
- [desktop updates](./releases/desktop_updates.md)
- [environments](./releases/environments.md)
- [npm packages](./releases/npm-packages.md)
- [signing binaries windows](./releases/signing-binaries-win.md)
- [versioning](./releases/versioning.md)
- [Packages](./packages/index.md)
- [@trezor/connect](./packages/connect/index.md)
- [dependencies](./packages/connect/dependencies.md)
- [protobuf](./packages/connect/protobuf-type-definitions.md)
- [coins support](./packages/connect/supported-coins.md)
- [events](./packages/connect/events.md)
- [path](./packages/connect/path.md)
- [methods](./packages/connect/methods.md)
- [@trezor/suite](./packages/suite/index.md)
- [send form](./packages/suite/send.md)
- [send form architecture](./packages/suite/send/ARCHITECTURE.md)
- [@trezor/suite-desktop](./packages/suite-desktop.md)
- [creating new package](./packages/creating-packages.md)
- [Features](./features/index.md)
- [coin handler](./features/protocols/coin-handler.md)
- [transactions export](./features/transactions/export.md)
- [transactions search](./features/transactions/search.md)
- [metadata labeling](./features/metadata.md)
- [fiat rates](./features/fiat-rates.md)
- [guide](./features/guide.md)
- [localization](./features/localization.md)
- [messaging system](./features/message-system.md)
- [feature flags](./features/feature-flags.md)
- [desktop logger](./features/desktop-logger.md)
- [onboarding](./features/onboarding/onboarding.md)
- [Tests](./tests/index.md)
- [e2e @trezor/suite-web](./tests/e2e-suite-web.md)
- [e2e @trezor/connect-popup](./tests/e2e-connect-popup.md)
- [regtest](./tests/regtest.md)
- [Miscellaneous](./misc/index.md)
- [build](./misc/build.md)
- [development on Windows](./misc/development-on-windows.md)
- [device naming](./misc/device-naming.md)
- [review](./misc/review.md)
- [videos](./misc/videos.md)
14 changes: 7 additions & 7 deletions docs/analytics/aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,16 @@ Collected data are anonymous. This means that **Suite does not track** personal

Among the data **not collected** by analytics:

- Device IDs
- Public keys
- Particular amounts
- Transaction IDs
- Device IDs
- Public keys
- Particular amounts
- Transaction IDs

When data tracking is enabled, Trezor Suite collects functional information that can be used to directly improve the app, such as:

- Events triggered by a user during a session
- Hardware, operating system and setup of the connected device
- Errors encountered during a session
- Events triggered by a user during a session
- Hardware, operating system and setup of the connected device
- Errors encountered during a session

## Data process

Expand Down
8 changes: 4 additions & 4 deletions docs/analytics/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Access to the data is limited strictly to the members of the development, securi

## Contents

- [AWS](./aws.md)
- [Sentry](./sentry.md)
- [Generic analytics package](https://github.com/trezor/trezor-suite/blob/develop/packages/analytics/README.md)
- [Suite analytics package](https://github.com/trezor/trezor-suite/blob/develop/packages/suite-analytics/README.md)
- [AWS](./aws.md)
- [Sentry](./sentry.md)
- [Generic analytics package](https://github.com/trezor/trezor-suite/blob/develop/packages/analytics/README.md)
- [Suite analytics package](https://github.com/trezor/trezor-suite/blob/develop/packages/suite-analytics/README.md)
8 changes: 4 additions & 4 deletions docs/analytics/sentry.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ Browser (User Agent), System and HW specifications, Suite version, instance id s

### Extra data:

- Enabled-coins e.g.: `[btc, ltc, eth, xrp, doge]`
- Wallet discovery e.g.:
- Enabled-coins e.g.: `[btc, ltc, eth, xrp, doge]`
- Wallet discovery e.g.:

```
[
Expand All @@ -38,7 +38,7 @@ Browser (User Agent), System and HW specifications, Suite version, instance id s
]
```

- Device information (slightly redacted):
- Device information (slightly redacted):

```
{
Expand Down Expand Up @@ -131,7 +131,7 @@ Browser (User Agent), System and HW specifications, Suite version, instance id s
}
```

- Action logs:
- Action logs:

```
[
Expand Down
18 changes: 9 additions & 9 deletions docs/features/application-log.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ The application log is in JSON format. It starts with App & Platform information

Contains basic information about the user's platform and app status at the time of displaying the Application log such as:

- app version
- browser name and version
- transport type
- number of connected devices
- enabled networks and custom backends
- ...
- app version
- browser name and version
- transport type
- number of connected devices
- enabled networks and custom backends
- ...

See `getApplicationInfo` method in `logsUtils.ts` in `suite` package.

Expand All @@ -22,9 +22,9 @@ See `getApplicationInfo` method in `logsUtils.ts` in `suite` package.
Hundreds of redux actions are fired when using Trezor Suite. The actions, which should help the Support Team understand the user's problem, are logged.
Each log record consists of:

- `type` which should express the type of user's action.
- `datetime` showing UTC when user action occurred
- `payload` containing additional information
- `type` which should express the type of user's action.
- `datetime` showing UTC when user action occurred
- `payload` containing additional information

Example log record occurred when user's internet connectivity status changed to offline

Expand Down
Loading
Loading