ledgerhq / ledger-dev-doc

DEPRECATED - please use https://github.com/LedgerHQ/developer-portal

Ledger Developer Documentation (DEPRECATED - please use https://github.com/LedgerHQ/developer-portal)

This repository contains the core documentation for developers who wish to make BOLOS applications, and for those who would like to gain a better understanding of the features offered by BOLOS and the background theory behind our products.

The latest version of this repository can be viewed, pre-built, here: https://ledger.readthedocs.io.

Contributing

If you notice a mistake or would like to contribute, feel free to issue a pull request or talk to us on the developer Slack.

If you make a contribution with a pull request, don't bother bumping the version number yourself. We will do this at some point if your pull request is accepted.

Building

If you wish, you may install Sphinx and build this documentation into a collection of HTML files yourself.

Firstly, make sure you have pip3 installed.

Secondly, install Sphinx and the Read the Docs theme:

pip3 install sphinx sphinx_rtd_theme

Finally, build:

make html

You will need internet access for intersphinx to work properly.

ledger-dev-doc's Issues

Add Keep Calm and Hodl (KCH)

Hello, kindly add KEEP CALM (KCH) token (ERC20) to the Ledger list: https://www.ledger.com/supported-crypto-assets/
Token name: KEEP CALM AND HODL
Token symbol: KCH
Blockchain: ERC-20 Eethereum
Token smart contract address: 0xdB80734b094a3F964DEdfD10e8946753aE0AC04c
Etherscan link: https://etherscan.io/token/0xdB80734b094a3F964DEdfD10e8946753aE0AC04c

Copyright outdated

Just noticed the Copyright time frame is 2016-2019.

I think it needs to be updated to 2016-2021.

Cannot join the Slack workspace

Hi, I'm a developer and I've read the document.

The document stated that External developer teams are welcome on Ledger’s Developer Slack. This is the place to get technical support, to discuss Ledger’s tech stack, and more broadly to get in touch with us.

However, I found that I need to be invited before I can join the Slack workspace, and I cannot find any other contact methods for developers.

I also found the Slack Trello board, which gives out http://slack.ledger.co/ for Developer Slack registration, but the link no longer works now.

So how should I join the Slack workspace?

(I think it could be count as a bug in the document?)

Application debug

Trying to follow the steps here to debug an app: https://ledger.readthedocs.io/en/latest/userspace/debugging.html

When I follow the instructions and add a PRINTF in the code, when I try to load the app, I get the following error:

undefined reference to `screen_printf'

I gess I am missing something. I would appreciate your help on this.

Thank you.

Kindly add USER PAY (UP2) token (ERC-20)

Token name: USER PAY
Token symbol: UP2
Blockchain: ERC-20 Ethereum
Token smart contract address: 0x4f54A83f5929a2453c2e18E25B215f6F8F2828F9
Etherscan link: https://etherscan.io/token/0x4f54A83f5929a2453c2e18E25B215f6F8F2828F9

Removing debug firmware

When finished debugging, is there a way to remove the debugging firmware afterwards?

Please, add CoinLoan (CLT) token (ERC-20)

Token Name: CoinLoan
Token Symbol: CLT
Blockchain: ERC-20 (Ethereum)
Contract Address: 0x2001f2A0Cf801EcFda622f6C28fb6E10d803D969
Etherscan: https://etherscan.io/token/0x2001f2a0cf801ecfda622f6c28fb6e10d803d969

Kindly add Sensitrust Token (SETS) token (ERC20)

Token name: Sensitrust Token
Token symbol: SETS
Blockchain: ERC-20 Ethereum
Token smart contract address: 0x04E0Af0af1b7f0023c6B12af5a94Df59B0e8cF59
Etherscan link: https://etherscan.io/token/0x04E0Af0af1b7f0023c6B12af5a94Df59B0e8cF59

Hello, kindly add Yearn Finance Global (YFIG) token (ERC20) to the Ledger list: https://www.ledger.com/supported-crypto-assets/

Hello, kindly add Yearn Finance Global (YFIG) token (ERC20) to the Ledger list: https://www.ledger.com/supported-crypto-assets/
Token name: Yearn Finance Global
Token symbol: YFIG
Blockchain: ERC-20 Eethereum
Token smart contract address: 0xF3a231bF11a0EF1a3074Cf5a1f5620BC85d975Fb
Etherscan link: https://etherscan.io/token/0xF3a231bF11a0EF1a3074Cf5a1f5620BC85d975Fb

Dependancy Problems

When i follow the documentation and try to run a sample app using
make BOLOS_ENV=/opt/ledger-blue/ BOLOS_SDK=/home/nanos-secure-sdk
i get a dependency error

/home/nanos-secure-sdk/src/os_io_seproxyhal.c:25:10: fatal error: 'hci.h' file
      not found
#include "hci.h"

Which i think is in an older version of
nanos-secure-sdk
It was removed in 1.3.1 Maybe as a way to separate between ledger-blue and ledger-nano however the problem remains because when running the example we use Ledger-blue environment

Kindly add TOKPIE (TKP) token (ERC20)

Hello, kindly add TOKPIE (TKP) token (ERC20) to the Ledger list: https://www.ledger.com/supported-crypto-assets/
Token name: TOKPIE
Token symbol: TKP
Blockchain: ERC-20 Eethereum
Token smart contract address: 0xd31695a1d35e489252ce57b129fd4b1b05e6acac
Etherscan link: https://etherscan.io/token/0xd31695a1d35e489252ce57b129fd4b1b05e6acac

How to add erc20 token to the list on assets supported by Ledger?

Hi, kindly inform me how to add ERC20 token into the Ledger's list of supported cryptocurrency assets: https://www.ledger.com/supported-crypto-assets/ ?

Thanks in advance!

Kindly add CASINOCOIN (CSC) token (CSCL)

Kindly add CASINOCOIN (CSC) token (CSCL) to the Ledger list: https://www.ledger.com/supported-crypto-assets/

Token name: CASINOCOIN

Token symbol: CSC

Blockchain: Consensus Ledger (Fork of XRP’s codebase (rippled))

Developer Center link:
https://casinocoin.org/build/

Merci 😘

Please add TPX gold to supported tokens list

Name: TPXGold
Symbol: TPX
Blockchain: erc-20 ethereum
Contract id: 0x2EdA619076F269BC05BA143beE81d94E8b51A082

Kindly add Thousand Token (TND) token waves blockchain.

Hello, kindly add Thousand Token (TND), token of waves to the Ledger
Token name: Thousand Token
Token symbol: TND
Blockchain: Waves
Smart contract address (AssetId): q2xCQyLDKXLzxcMY4PKuFDVknaLoMpq4o57pjJtLMe7
wavesexplorer link: https://wavesexplorer.com/assets/q2xCQyLDKXLzxcMY4PKuFDVknaLoMpq4o57pjJtLMe7

Unclear instruction: 14x14 icon generation "convert" command

To generate the 14x14 icon from the 16x16 one, the instructions mention the following:

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: convert nanos_app_<token>.gif -crop 14x14+1+1 +repage -negate nanox_app_<token>.gif

This instruction is unclear.

convert using which CLI? Which OS? What package do you need? etc.

Points to old blue-loader-python 0.1.15 doc

Points to https://ledger.readthedocs.io/projects/blue-loader-python/en/0.1.15/index.html in https://ledger.readthedocs.io/en/latest/additional/external_docs.html for example, new version is 0.1.21

API documentation

Where can I find some actual API documentation, especially for BAGL? Currently I'm just poking around in the SDK source and making guesses based on identifier names and extremely sparse comments.