Skip to content
This repository was archived by the owner on Jul 6, 2021. It is now read-only.

Add device icon requirement to welcome screen #63

Open
phantomcrypt wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add device icon requirement to welcome screen #63

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
117 changes: 59 additions & 58 deletions source/additional/publishing_an_app.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,28 +48,28 @@ during the review process:
* Application stability, correct handling of errors
* Correct usability (see `Design Guidelines`_)

Review time depends on Ledger’s available resources and code complexity. The
more unique and complex the code, the longer the review. Please note that forks
of supported BOLOS apps will require a new review. The decision to reject or
revoke an app is at Ledger’s sole discretion. We will make our best efforts to
provide a rationale for such decisions. Upon fixing identified issues, app
authors will be allowed to re-submit their apps.
A new all-in-one native app called *Ledger Live*
has been released on the 9th of July, 2018. This new platform will be open to
pull requests for adding support for new cryptocurrencies in the coming months,
*it is not available yet*. Currently, your best shot is to build your own companion
app with its own backend. It is less convenient for users than a full integration
to Ledger Live, but on the other hand, it gives you more freedom on the design
of the interface you want users to see, and the way it will be implemented
Review time depends on Ledger’s available resources and code complexity. The
more unique and complex the code, the longer the review. Please note that forks
of supported BOLOS apps will require a new review. The decision to reject or
revoke an app is at Ledger’s sole discretion. We will make our best efforts to
provide a rationale for such decisions. Upon fixing identified issues, app
authors will be allowed to re-submit their apps.
A new all-in-one native app called *Ledger Live*
has been released on the 9th of July, 2018. This new platform will be open to
pull requests for adding support for new cryptocurrencies in the coming months,
*it is not available yet*. Currently, your best shot is to build your own companion
app with its own backend. It is less convenient for users than a full integration
to Ledger Live, but on the other hand, it gives you more freedom on the design
of the interface you want users to see, and the way it will be implemented
(Web app? Native app? It's up to you!).

Design Guidelines
Design Guidelines
-----------------


The design of your device app will be added to our website to inform that your app is
available. In that respect, we thank you to provide us with the design in a format and
with measurements that shall meet the criteria communicated by our team.
The design of your device app will be added to our website to inform that your app is
available. In that respect, we thank you to provide us with the design in a format and
with measurements that shall meet the criteria communicated by our team.

There are 2 mandatory icons that should be provided for Ledger to release an app:

Expand All @@ -86,7 +86,7 @@ Below are the Adobe Illustrator templates for such icons, please respect their g


- Nano X icons must be 14x14 px in size. Developers can create their Nano X icons from the 16x16 px Nano S one with the following command on Linux (it first requires to install the package `imagemagick`): ``convert nanos_app_<token>.gif -crop 14x14+1+1 +repage -negate nanox_app_<token>.gif``


**Click on each image to download the corresponding .ai file, and fill them directly before sending them back. They should correspond to the icons used to compile your app.**

Expand All @@ -103,27 +103,29 @@ Below are the Adobe Illustrator templates for such icons, please respect their g
Manager icon template (click to access Illustrator file)


Most of the time, Bolos apps expose few functionalities to the user. However,
despite this simplicity, it is still challenging to build a user-friendly
interface, because of the few inputs (only 2 buttons !) and also because of
The Device icon must be displayed on the first welcome screen.

Most of the time, Bolos apps expose few functionalities to the user. However,
despite this simplicity, it is still challenging to build a user-friendly
interface, because of the few inputs (only 2 buttons !) and also because of
the screen size which offer only 128*32 pixels.
Ledger provides some guidance to avoid third party developers to reinvent
the wheel.
Ledger provides some guidance to avoid third party developers to reinvent
the wheel.

.. note::
.. note::

See the :doc:`BAGL Toolkit</userspace/display_management>` for more information
on the BOLOS Application Graphics Library technical details.
See the :doc:`BAGL Toolkit</userspace/display_management>` for more information
on the BOLOS Application Graphics Library technical details.


Even though the screen is small, you don't want to bloat it with plenty of tiny text
to fit everything in a single time. Instead, multiple successives screens are the
to fit everything in a single time. Instead, multiple successives screens are the
way to go, with a configurable time interval between each screen switch.
Doing this allows you to split and segment the information to display.
It is also a good practice to inform the user of what is the kind of information
It is also a good practice to inform the user of what is the kind of information
currently displayed, by giving it a title.
In some cases, even when the information is segmented by type, there won't be
enough space for it to fit entirely on screen. Rather than splitting this information
In some cases, even when the information is segmented by type, there won't be
enough space for it to fit entirely on screen. Rather than splitting this information
in multiple screens, it is better to use automatic scrolling display.
Here is an example that sums it up:

Expand All @@ -132,29 +134,29 @@ Here is an example that sums it up:

Example: transaction confirmation screen

On this example two pieces of information are shown: an amount of bitcoins, and a
On this example two pieces of information are shown: an amount of bitcoins, and a
destination address.
The two screens are alternating periodically until the user validates or cancel.
A title is present to describe each information. For the too-long-to-display destination
A title is present to describe each information. For the too-long-to-display destination
address, the automatic scrolling is used.

A few graphical pointers (glyphs) help users to make a link between the right and left
A few graphical pointers (glyphs) help users to make a link between the right and left
buttons and their effects.
There are four principal functions fulfilled by pressing buttons:
There are four principal functions fulfilled by pressing buttons:

- Making a binary choice for a question asked by the device (1 button)
- Moving in a menu (1 button)
- Selecting a menu entry (2 buttons)
- Proceeding with a disclaimer (2 buttons)

To propose a binary choice to the user, 2 glyphs representing the 2 choices should be
placed on each side of the screen (a cross symbol to cancel and a validation symbol to
accept).
You can display a question and relevant information in between the glyphs, like in the
To propose a binary choice to the user, 2 glyphs representing the 2 choices should be
placed on each side of the screen (a cross symbol to cancel and a validation symbol to
accept).
You can display a question and relevant information in between the glyphs, like in the
upper example.

To move inside a menu, be it vertical or horizontal, the same technique is applied with
different glyphs. We recommend using arrows: up and down for a vertical menu, left and
To move inside a menu, be it vertical or horizontal, the same technique is applied with
different glyphs. We recommend using arrows: up and down for a vertical menu, left and
right for a horizontal one).

.. figure:: images/horizontal_menu.png
Expand All @@ -168,20 +170,20 @@ right for a horizontal one).

Example use of arrows in a vertical menu

Once positioned on the right menu entry, the user can select the entry by pressing both
Once positioned on the right menu entry, the user can select the entry by pressing both
buttons. This potential action is not represented by glyphs.
Same goes when going through a set of disclaimer screens: only text is displayed, and
Same goes when going through a set of disclaimer screens: only text is displayed, and
the user goes to the next part by pressing both buttons.
This is a consistent behavior across the device, so you can assume that users are used
to it. It should feel obvious when the user has to press two buttons to go through
This is a consistent behavior across the device, so you can assume that users are used
to it. It should feel obvious when the user has to press two buttons to go through
something in your app.

Ledger does not impose the icons nor the interface for third party applications, however user
friendliness and guidelines compliance is something being reviewed during the integration process.
Therefore, a very poor design might be a cause of delay in your release roadmap if the
Ledger does not impose the icons nor the interface for third party applications, however user
friendliness and guidelines compliance is something being reviewed during the integration process.
Therefore, a very poor design might be a cause of delay in your release roadmap if the
outcome of the review is negative because of it. Don't neglect it !

Design Warranty
Design Warranty
---------------

The design of your device app shall free from any encumbrances and shall not infringe upon any third party intellectual property right, in particular trademark and design rights. You grant Ledger the right to use such design for free with the right to reproduce and exploit the design for the duration of its display on Ledger website.
Expand All @@ -200,16 +202,15 @@ There are different release levels for a given application:

* Developer mode with an **audited** application
* Developer mode with an **unaudited** application


.. warning::

In any case, Ledger's decision to publish a third party application may not be considered as any form of partnership nor endorsement of such.


As long as an application isn't audited by Ledger security team, the message ``Pending Ledger Review`` will be made visible when the application is started.
As long as an application isn't audited by Ledger security team, the message ``Pending Ledger Review`` will be made visible when the application is started.
The user can aknowledge and skip this warning by pressing both buttons and use the application at his own risks.
As an unaudited application is considered experimental, such application will be visible **only once the developer mode settings has been enabled** in Ledger Live settings.
As an unaudited application is considered experimental, such application will be visible **only once the developer mode settings has been enabled** in Ledger Live settings.

Some applications are also visible once the developer mode setting is enabled, not because of a lack of security review, but rather because they are considered too complex to use. A reason might be a the mandatory compatible GUI is missing, or the application purpose is considered too technical for the vast majority of users.

Expand All @@ -235,13 +236,13 @@ Third Party Applications Support
The following only applies if you are adding support for a cryptocurrency and
chose to build your own companion app.

Ledger does not provide support for third party applications.
**It is required for third party teams to provide and host a complete tutorial that will guide
Ledger does not provide support for third party applications.
**It is required for third party teams to provide and host a complete tutorial that will guide
users before the app is released on the Ledger Manager** (please follow `these guidelines
<https://docs.google.com/document/d/1QI7DHd3HIyhKWydlmjBbB-dlUXquqAd-4f4ED_-wgAU/edit?usp=sharing>`_).

Along with your publication request, app sources and tutorial,
please provide information that will allow the Ledger support team to redirect
Along with your publication request, app sources and tutorial,
please provide information that will allow the Ledger support team to redirect
users to relevant support resources:

* **Identity: Name, Surname, Legal Entity**
Expand All @@ -261,7 +262,7 @@ us.
Warranty and liability disclaimer
---------------------------------

The review and publication of third-party Ledger device applications (collectively “the Service”) are provided by Ledger on an “as-is” and “as-available” basis. The Service is subject to change without notice. Ledger disclaims all warranties of accuracy, non-infringement, merchantability and fitness for a particular purpose. To the extent that Ledger makes any pre-release of Ledger device applications available to third-party developers, you understand that Ledger is under no obligation to provide updates, enhancements, or corrections, or to notify you of any changes that Ledger may make, or to publicly announce or introduce the Ledger device applications at any time in the future.
The review and publication of third-party Ledger device applications (collectively “the Service”) are provided by Ledger on an “as-is” and “as-available” basis. The Service is subject to change without notice. Ledger disclaims all warranties of accuracy, non-infringement, merchantability and fitness for a particular purpose. To the extent that Ledger makes any pre-release of Ledger device applications available to third-party developers, you understand that Ledger is under no obligation to provide updates, enhancements, or corrections, or to notify you of any changes that Ledger may make, or to publicly announce or introduce the Ledger device applications at any time in the future.

To the extent not prohibited by applicable law, in no event will Ledger be liable for personal injury, or any incidental, special, indirect, consequential or punitive damages whatsoever, including, without limitation, damages resulting from delay of delivery, for loss of profits, data, business or goodwill, for business interruption, or any other commercial damages or losses, arising out of or related to this agreement or your use or inability to use the service.

Expand All @@ -281,7 +282,7 @@ Please apply on `Ledger's Listing Program
* Video of your application running on the Ledger device

* Verify public address on the Ledger device
* Display transaction information before allowing signature
* Display transaction information before allowing signature
* Reject a transaction on the Ledger device
* Sign a transaction on the Ledger device

Expand Down