Skip to content

Commit be167de

Browse files
authored
Create ledgerUpgrade.md (#2530)
1 parent 1922178 commit be167de

File tree

1 file changed

+113
-0
lines changed

1 file changed

+113
-0
lines changed

applications/ledgerUpgrade.md

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
- **Team Name:** Zondax AG
2+
- **Payment Address:** DOT/AssetHub address 1fN87Fgj5BUhezFgbLiGbXTMrBVggnmYBX9anzMBky8KaJ5
3+
- **[Level]**: 3
4+
5+
## Project Overview :page_facing_up:
6+
7+
### Overview
8+
9+
#### Enhancing Ledger Polkadot Universal App Compatibility for Emerging Substrate Ecosystems
10+
11+
This project expands the compatibility of the [Polkadot Universal App](https://github.com/Zondax/ledger-polkadot) to support the evolving landscape of Substrate-based blockchain networks, particularly those with specialized configurations. This initiative addresses the growing need for secure hardware wallet support for projects like [Mythical Games](https://mythicalgames.com/) and the future AssetHub evolution, codenamed "Plaza,".
12+
13+
### Project Details
14+
15+
This upgrade will deliver the following key enhancements:
16+
17+
- **Expanded Cryptographic Support**: Implement alternative cryptographic signature methods, specifically ECDSA and Keccak-256 hashing, to accommodate the requirements of emerging networks. This involves modifications to both the Ledger app and the associated JavaScript (JS) package.
18+
- **Variable Account Identifier Support**: Adapt the application to handle varying account identifier lengths, including the 20-byte address format, which is essential for compatibility with specific networks. This will require changes to both the Ledger app and the JS package.
19+
- **Adaptation of signRaw function** Extend signRaw functionality to support ecdsa
20+
- **Testing and Integration**: Develop comprehensive integration tests and implement Continuous Integration (CI) pipelines to ensure the stability and reliability of the enhanced application.
21+
- **Third Party Security Audit**: Conduct a thorough security audit by an auditor selected from Ledger SAS's approved list. This audit is a requirement for publication on the Ledger Live platform, as per Ledger's established procedures. [Ledger's Third-Party Security Assessment Report Guidelines](https://support.ledger.com/article/Third-party-Security-Assessment-Report)
22+
- **Ledger Release Management**: Manage the submission process and release process through Ledger, ensuring effective communication and coordination. While Zondax will facilitate the review process, Ledger's release timeline remains outside of Zondax's direct control.
23+
24+
Note: This upgrade maintains the existing Polkadot derivation path within the Ledger app; no modifications are required.
25+
26+
#### Technology and Languages
27+
28+
- C, Typescrypt
29+
- Ledger SDK
30+
31+
### Ecosystem Fit
32+
33+
Zondax is a growing and distributed team with experience and projects for more than 50 blockchains. Zondax has been contributing to the Substrate ecosystem since 2018-2019. The team has received and completed a large number of W3F grants and currently maintains most Ledger apps for the ecosystem.
34+
35+
## Team :busts_in_silhouette:
36+
37+
### Team members
38+
39+
- 1x Embedded Engineer
40+
- 0.3 x Engineering Manager
41+
- 0.2 x Project Manager
42+
43+
### Contact
44+
45+
- **Contact Name:** Juan Leni and Ainhoa Aldave
46+
- **Contact Email:** [email protected] / [email protected]
47+
- **Website:** zondax.ch
48+
49+
### Legal Structure
50+
51+
Legal structure
52+
Zondax AG
53+
Dammstrasse 16
54+
Zug 6300
55+
Switzerland
56+
UID CHE-491.796.576
57+
58+
### Team's experience
59+
60+
Over the last few years, Zondax has been involved in a large number of projects for most of the key players in the blockchain industry. Our team includes experts in most blockchain aspects, from cryptography to data and protocol engineering.
61+
62+
### Team Code Repos
63+
64+
Most of our contributions to the blockchain ecosystem can be found in our GitHub organization [zondax](https://github.com/zondax)
65+
66+
67+
## Development Status :open_book:
68+
69+
Not initiated.
70+
71+
## Development Roadmap :nut_and_bolt:
72+
73+
## Technical Scope:
74+
75+
76+
### Milestone 1 Extension of compatibility on Polkadot Ledger App + Security Audit
77+
78+
Complete Ledger Polkadot App Compatibility Extension & Security Audit. Implement enhanced cryptographic and address support, conduct a full security audit, and prepare for Ledger release.
79+
80+
### Overview
81+
82+
- **Total estimated workload:** 1.5 months
83+
- **Delivery time:**: 2 months
84+
- **Full-Time Equivalent (FTE):** 1.5 FTE
85+
- **Total Costs:** 35'000 USDT
86+
- **DOT %:** Percentage of Total Costs to be paid in (vested) DOT = 50%
87+
88+
### Milestone 1 Extension of compatibility on Polkadot Ledger App + Security Audit
89+
90+
- **Estimated workload:** 1.5 month
91+
- **Delivery time:**: 2 months
92+
- **FTE:** 1.5
93+
- **Costs:** 35'000 USDT
94+
95+
| Number | Deliverable | Specification |
96+
| -----: | ----------- | ------------- |
97+
| **0a.** | License | Apache 2.0 / MIT |
98+
| **0b.** | Documentation | We will provide a inline documentation of the code and inline documentation of the code and a basic tutorial |
99+
| **0c.** | Testing and Testing Guide | Core functions will be fully covered by comprehensive unit tests to ensure functionality and robustness. In the guide, we will describe how to run these tests. |
100+
| **0d.** | Docker | We will provide a Dockerfile(s) that can be used to test all the functionality delivered with this milestone. |
101+
| 0e. | Article/Tutorial |Initial article/tutorial explaining the project and how to use the web application |
102+
| 1. | Code| General structure |
103+
| 2a. | Code| Ledger Application code |
104+
| 2b. | Code| Ts Library Application code |
105+
106+
107+
## Future Plans
108+
109+
No further updates planned in the short term.
110+
111+
## Additional Information :heavy_plus_sign:
112+
113+
Zondax has been contributing to the Polkadot ecosystem for several years, and has successfully completed several grants.

0 commit comments

Comments
 (0)