Boilerplate plugin

Estimated reading time: One minute

Sections in this page

• What’s what
• Change plugin name

Here is a boilerplate plugin to help you write your own. This guide walks you through the plugin.

You can follow it best by forking the repository https://github.com/LedgerHQ/app-plugin-boilerplate in the plugin_dev/ folder:

cd ..
git clone https://github.com/LedgerHQ/app-plugin-boilerplate

We will need the Ethereum SDK to build our plugin. It can be cloned anywhere, but it is easier to add it directly inside the app-plugin-boilerplate directory:

cd app-plugin-boilerplate/
git clone https://github.com/LedgerHQ/ethereum-plugin-sdk

  Important
The SDK repository defaults on branch "master", which is synchronized with the Ethereum application latest stable version. If your want to work on a newer but unstable version, checkout the "develop" branch.

What’s what

There is no need to build it right now, only after adding tests. For now, in app-plugin-boilerplate/ there are these folders:

• ethereum-plugin-sdk: This repository contains information shared by the Ethereum app and your plugin, such as structure definitions, utility functions, etc.
• icons: plugin icons as displayed on the device. We will get to it later, but you can read about it here.
• src: the actual source code (in C).
• tests/: the test folder (using the js Testing Framework).

Change plugin name

There is the Makefile directly in the repository root. You need to open Makefile and change APPNAME to suit your plugin name (e.g., Paraswap, 1inch, Lido, etc.).

---

Did you find this page helpful?

How would you improve this page for developers?

I am a developer.
Contributors will be chosen randomly to receive rewards. Check this box to send your email and participate.

Ledger collects your email address to send you rewards for your contribution to improve the Developer Portal documentation. Learn more about how we manage your data and your rights.

By providing your email address, you consent that Ledger may contact you for rewards delivery purposes. If you are part of the randomly selected contributors, we will send you an email to ask for your physical address and if necessary, ask you for additional information on the suggestion you made. Your information will only be available to Ledger and will be retained for no longer than 90 days. It may be transferred to non-European countries that ensure an adequate level of protection or under the standard contractual clauses adopted by the EU Commission.

Please note that you may withdraw your consent at any time, access your data and request their rectification or deletion. You may also request the limitation of the processing of your data. To exercise your rights or for any question on the processing of your data, please contact LEDGER’s Data Protection Officer here. If nevertheless you believe LEDGER did not adequately address your concerns and mishandled your data, you may lodge a complaint with the personal data protection authority of your country.

Introduction

← Previous

Selector Setup

Next →