Skip to content

Commit

Permalink
feat(connect-explorer-nextra): info about management methods
Browse files Browse the repository at this point in the history
  • Loading branch information
martykan committed Apr 23, 2024
1 parent 6c2e298 commit 05b68fa
Show file tree
Hide file tree
Showing 12 changed files with 78 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { Callout } from 'nextra/components';

import { PROTO } from '@trezor/connect/src/constants';

import { ParamsTable } from '../../../components/ParamsTable';
Expand All @@ -14,6 +16,11 @@ export const paramDescriptions = {

## Apply flags

<Callout type="error" emoji="️🚫">
**Management command** - this method is restricted to Trezor.io and can't be used in 3rd party
applications.
</Callout>

Change device flags. This methods allows you to set a mark on device (number) which must not be lower than
previously set flag.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { Callout } from 'nextra/components';

import { ApplySettings } from '@trezor/connect/src/types/api/applySettings';

import { ParamsTable } from '../../../components/ParamsTable';
Expand All @@ -22,6 +24,11 @@ export const paramDescriptions = {

## Apply settings

<Callout type="error" emoji="️🚫">
**Management command** - this method is restricted to Trezor.io and can't be used in 3rd party
applications.
</Callout>

Change device settings

```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@ export const paramDescriptions = {

## authenticateDevice

<Callout type="error" emoji="️🚫">
**Management command** - this method is restricted to Trezor.io and can't be used in 3rd party
applications.
</Callout>

<Callout type="info">**Supported only by T2B1 devices**</Callout>

Request a signature and validate certificate issued by the Trezor company.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
import { Callout } from 'nextra/components';

import { CommonParamsLink } from '../../../components/CommonParamsLink';
import { ApiPlayground } from '../../../components/ApiPlayground';

<ApiPlayground options={[{ title: 'No payload', method: 'backupDevice' }]} />

## Backup device

<Callout type="error" emoji="️🚫">
**Management command** - this method is restricted to Trezor.io and can't be used in 3rd party
applications.
</Callout>

Start seed backup process on the device. Can only be called if the seed is not backed up yet.

```javascript
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { Callout } from 'nextra/components';

import { ChangeLanguage } from '@trezor/connect/src/types/api/changeLanguage';

import { ParamsTable } from '../../../components/ParamsTable';
Expand All @@ -18,6 +20,11 @@ export const paramDescriptions = {

## Change language

<Callout type="error" emoji="️🚫">
**Management command** - this method is restricted to Trezor.io and can't be used in 3rd party
applications.
</Callout>

This method initiates language change.

```javascript
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { Callout } from 'nextra/components';

import { PROTO } from '@trezor/connect/src/constants';

import { ParamsTable } from '../../../components/ParamsTable';
Expand All @@ -14,6 +16,11 @@ export const paramDescriptions = {

## Change pin

<Callout type="error" emoji="️🚫">
**Management command** - this method is restricted to Trezor.io and can't be used in 3rd party
applications.
</Callout>

This method initiates pin change sequence.

```javascript
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { Callout } from 'nextra/components';

import { PROTO } from '@trezor/connect/src/constants';

import { ParamsTable } from '../../../components/ParamsTable';
Expand All @@ -16,6 +18,11 @@ export const paramDescriptions = {

## Change wipe code

<Callout type="error" emoji="️🚫">
**Management command** - this method is restricted to Trezor.io and can't be used in 3rd party
applications.
</Callout>

This method initiates wipe code change sequence.

```javascript
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { Callout } from 'nextra/components';

import { FirmwareUpdate } from '@trezor/connect/src/types/api/firmwareUpdate';

import { ParamsTable } from '../../../components/ParamsTable';
Expand All @@ -18,6 +20,11 @@ export const paramDescriptions = {

## firmwareUpdate

<Callout type="error" emoji="️🚫">
**Management command** - this method is restricted to Trezor.io and can't be used in 3rd party
applications.
</Callout>

Installs a new firmware

```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,11 @@ export const paramDescriptions = {

## getFirmwareHash

<Callout type="error" emoji="️🚫">
**Management command** - this method is restricted to Trezor.io and can't be used in 3rd party
applications.
</Callout>

<Callout type="info">**Supported only by firmwares 1.11.1 and 2.5.1 or higher!**</Callout>

### Params
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { Callout } from 'nextra/components';

import { PROTO } from '@trezor/connect/src/constants';

import { ParamsTable } from '../../../components/ParamsTable';
Expand All @@ -20,6 +22,11 @@ export const paramDescriptions = {

## Reset device

<Callout type="error" emoji="️🚫">
**Management command** - this method is restricted to Trezor.io and can't be used in 3rd party
applications.
</Callout>

Perform device setup and generate new seed.

```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ export const paramDescriptions = {

## Set busy

<Callout type="error" emoji="️🚫">
**Management command** - this method is restricted to Trezor.io and can't be used in 3rd party
applications.
</Callout>

Show a "Do not disconnect" dialog instead of the standard homescreen.

```javascript
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
import { Callout } from 'nextra/components';

import { CommonParamsLink } from '../../../components/CommonParamsLink';
import { ApiPlayground } from '../../../components/ApiPlayground';

<ApiPlayground options={[{ title: 'No payload', method: 'wipeDevice' }]} />

## Wipe device

<Callout type="error" emoji="️🚫">
**Management command** - this method is restricted to Trezor.io and can't be used in 3rd party
applications.
</Callout>

Reset device to factory defaults and remove all private data.

```javascript
Expand Down

0 comments on commit 05b68fa

Please sign in to comment.