Initialize the repo (#5)

* :WIP: Add issues templates * :WIP: Update readme * Update PR template * 🌱 Add lisk icons * 🐛 Fix some images for testing * 🐛 Fix app name based on ledger-app-database * Fix CI * Revert "Fix CI" This reverts commit 17b1a6c. * Fix CI * test make file * Cleanup Makefile * 🐛 Cleanup the Makefile * Test Makefile * Test Makefile * Revert and cleanup --------- Co-authored-by: hatef <[email protected]>
LiskHQ · May 19, 2024 · 695543d · 695543d
1 parent d0648fb
commit 695543d
Show file tree

Hide file tree

Showing 19 changed files with 120 additions and 15 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -0,0 +1,15 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: 'type: bug'
+assignees: ''
+---
+
+### Expected behavior
+
+### Actual behavior
+
+### Steps to reproduce
+
+### Which version(s) does this affect? (Environment, OS, etc...)
diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md
@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Propose an idea for new improvements/features
+title: ''
+labels: ''
+assignees: ''
+---
+
+### Description
+
+Please describe what functionality is needed
+
+### Motivation
+
+Please describe why it is needed
+
+### Additional Information
diff --git a/.github/ISSUE_TEMPLATE/feature-specification.md b/.github/ISSUE_TEMPLATE/feature-specification.md
@@ -0,0 +1,17 @@
+---
+name: Feature specification
+about: Specification of new features/improvements
+title: ''
+labels: ''
+assignees: ''
+---
+
+### Description
+
+Please describe the specification of new features/improvements
+
+### Acceptance Criteria
+
+Please describe the conditions which must be met for this issue to close
+
+### Additional Information
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,8 +1,11 @@
-# Checklist
-<!-- Put an `x` in each box when you have completed the items. -->
-- [ ] App update process has been followed <!-- See comment below -->
-- [ ] Target branch is `develop` <!-- unless you have a very good reason -->
-- [ ] Application version has been bumped <!-- required if your changes are to be deployed -->
-
-<!-- Make sure you followed the process described in https://developers.ledger.com/docs/device-app/deliver/maintenance before opening your Pull Request.
-Don't hesitate to contact us directly on Discord if you have any questions ! https://developers.ledger.com/discord -->
+### What was the problem?
+
+This PR resolves #INSERT_ISSUE_NUMBER
+
+### How was it solved?
+
+<!--- Please describe your technical implementation -->
+
+### How was it tested?
+
+<!--- Please describe how you tested your changes -->
diff --git a/Makefile b/Makefile
@@ -15,12 +15,54 @@
 #   limitations under the License.
 # ****************************************************************************
 
-# EDIT THIS: Application name
-APPNAME = "PluginBoilerplate"
+ifeq ($(BOLOS_SDK),)
+$(error Environment variable BOLOS_SDK is not set)
+endif
+
+include $(BOLOS_SDK)/Makefile.defines
+
+ifeq ($(TARGET_NAME),$(filter $(TARGET_NAME),TARGET_NANOX TARGET_STAX))
+CUSTOM_APP_FLAGS = 0x200
+else
+CUSTOM_APP_FLAGS = 0x000
+endif
+
+# Application name
+APPNAME = "Lisk"
 
 # Application version
 APPVERSION_M = 1
 APPVERSION_N = 0
 APPVERSION_P = 0
 
-include ethereum-plugin-sdk/standard_plugin.mk
+APPVERSION ?= "$(APPVERSION_M).$(APPVERSION_N).$(APPVERSION_P)"
+
+# Application source files
+APP_SOURCE_PATH += src ethereum-plugin-sdk
+
+NORMAL_NAME ?= $(shell echo -n "$(APPNAME)" | tr " ." "_" | tr "[:upper:]" "[:lower:]")
+ICON_NANOS = icons/nanos_app_$(NORMAL_NAME).gif
+ICON_NANOX = icons/nanox_app_$(NORMAL_NAME).gif
+ICON_NANOSP = $(ICON_NANOX)
+ICON_STAX = icons/stax_app_$(NORMAL_NAME).gif
+
+ifeq ($(TARGET_NAME),TARGET_STAX)
+    DEFINES += ICONGLYPH=C_stax_$(NORMAL_NAME)_64px
+    DEFINES += ICONBITMAP=C_stax_$(NORMAL_NAME)_64px_bitmap
+endif
+
+CURVE_APP_LOAD_PARAMS = ed25519
+PATH_APP_LOAD_PARAMS = "44'/134'"
+
+VARIANT_PARAM = COIN
+VARIANT_VALUES = LSK
+
+DISABLE_STANDARD_APP_FILES = 1
+DISABLE_STANDARD_SNPRINTF = 1
+DISABLE_STANDARD_USB = 1
+DISABLE_STANDARD_WEBUSB = 1
+DISABLE_STANDARD_BAGL_UX_FLOW = 1
+DISABLE_DEBUG_LEDGER_ASSERT = 1
+DISABLE_DEBUG_THROW = 1
+
+include $(BOLOS_SDK)/Makefile.standard_app
diff --git a/README.md b/README.md
@@ -1,10 +1,13 @@
-[![Ensure compliance with Ledger guidelines](https://github.com/LedgerHQ/app-plugin-boilerplate/actions/workflows/guidelines_enforcer.yml/badge.svg?branch=develop)](https://github.com/LedgerHQ/app-plugin-boilerplate/actions/workflows/guidelines_enforcer.yml)
-[![Compilation & tests](https://github.com/LedgerHQ/app-plugin-boilerplate/actions/workflows/build_and_functional_tests.yml/badge.svg?branch=develop)](https://github.com/LedgerHQ/app-plugin-boilerplate/actions/workflows/build_and_functional_tests.yml)
+![GitHub repo size](https://img.shields.io/github/repo-size/liskhq/lisk-app-plugin)
+![GitHub issues](https://img.shields.io/github/issues-raw/liskhq/lisk-app-plugin)
+![GitHub closed issues](https://img.shields.io/github/issues-closed-raw/liskhq/lisk-app-plugin)
+[![Ensure compliance with Ledger guidelines](https://github.com/liskhq/lisk-app-plugin/actions/workflows/guidelines_enforcer.yml/badge.svg?branch=develop)](https://github.com/liskhq/lisk-app-plugin/actions/workflows/guidelines_enforcer.yml)
+[![Compilation & tests](https://github.com/liskhq/lisk-app-plugin/actions/workflows/build_and_functional_tests.yml/badge.svg?branch=develop)](https://github.com/liskhq/lisk-app-plugin/actions/workflows/build_and_functional_tests.yml)
 
 
-# app-plugin-boilerplate
+# Lisk App Plugin
 
-This repo is meant to be a forkable example of a plugin.
+Lisk App Plugin is a plugin for the Ethereum application specific to support lisk smart contracts. It helps parsing and displaying relevant information when signing transaction.
 
 Plugins are lightweight applications that go hand-in-hand with the Ethereum
 Application on a Nano (S, S plus, X) and Stax devices.
@@ -20,6 +23,14 @@ It is STRONGLY recommended to follow the
 [plugin guide](https://developers.ledger.com/docs/dapp/embedded-plugin/code-overview/)
 in order to better understand the flow and the context for plugins.
 
+## Smart Contracts
+
+Smart contracts covered by this plugin are:
+
+| Network | Smart Contract Name | Address                                      | Selectors                                                                                                     |
+|---------|---------------------|----------------------------------------------|---------------------------------------------------------------------------------------------------------------|
+| Lisk Sepolia Testnet     | ERC1967Proxy          | `0x5c3a68B5C635Ce0DA7648C30A1B83A61C376bd87` | TODO |    
+
 ## Ethereum SDK
 
 Ethereum plugins need the [Ethereum SDK](https://github.com/LedgerHQ/ethereum-plugin-sdk).

diff --git a/glyphs/stax_lisk_64px.gif b/glyphs/stax_lisk_64px.gif
diff --git a/glyphs/stax_pluginboilerplate_64px.gif b/glyphs/stax_pluginboilerplate_64px.gif
diff --git a/icons/nanos_app_lisk.gif b/icons/nanos_app_lisk.gif
diff --git a/icons/nanos_app_pluginboilerplate.gif b/icons/nanos_app_pluginboilerplate.gif
diff --git a/icons/nanox_app_lisk.gif b/icons/nanox_app_lisk.gif
diff --git a/icons/nanox_app_pluginboilerplate.gif b/icons/nanox_app_pluginboilerplate.gif
diff --git a/icons/stax_app_lisk.gif b/icons/stax_app_lisk.gif
diff --git a/icons/stax_app_pluginboilerplate.gif b/icons/stax_app_pluginboilerplate.gif
diff --git a/tests/snapshots/nanos/test_swap_exact_eth_for_token/00001.png b/tests/snapshots/nanos/test_swap_exact_eth_for_token/00001.png
diff --git a/tests/snapshots/nanosp/test_swap_exact_eth_for_token/00001.png b/tests/snapshots/nanosp/test_swap_exact_eth_for_token/00001.png
diff --git a/tests/snapshots/nanox/test_swap_exact_eth_for_token/00001.png b/tests/snapshots/nanox/test_swap_exact_eth_for_token/00001.png
diff --git a/tests/snapshots/stax/test_swap_exact_eth_for_token/00000.png b/tests/snapshots/stax/test_swap_exact_eth_for_token/00000.png
diff --git a/tests/snapshots/stax/test_swap_exact_eth_for_token/00003.png b/tests/snapshots/stax/test_swap_exact_eth_for_token/00003.png