Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: support large text fields #55

Merged
merged 1 commit into from
Jan 9, 2020
Merged

chore: support large text fields #55

merged 1 commit into from
Jan 9, 2020

Conversation

sleepdefic1t
Copy link
Contributor

Summary

This PR creates a separate variable for large fields and 64-byte aligns the DisplayContext object (to 704-bytes).

Specifically, this PR recommends:

  • add an extended-sized text variable to DisplayCtx.
  • change large fields to last display step (ipfs, transfer, etc).
  • rename the UX flow steps to be more concise.
  • create secondary UX flow steps for extended text fields.
  • change transaction_t's vendorFieldLength to size_t (vs uint8_t).
  • add bool (isExtended) argument to the setDisplaySteps method.
  • update examples and docs to demonstrate v2 Transfers with vendorFields up to 255 characters.
  • update Message example with extended field up to 255 characters.
  • update the changelog.

Checklist

  • Documentation (if necessary)
  • Tests (if necessary)
  • Ready to be merged

Additional Comments

This also resolves #20

@sleepdefic1t
chore: support large text fields
8864c46 
The only way to get large fields to display properly would be to use patterns that invoke undefined behavior.

This PR creates a separate variable for these large fields and 64-byte aligns the DisplayContext object (704-bytes).

- add an extended-sized text variable to DisplayCtx.
- change large fields to last display step (ipfs, tranfer, etc).
- rename the UX flow steps to be more concise.
- create secondary UX flow steps for extended text fields.
- change `transaction_t` `vendorFieldLength` to `size_t`.
- add bool (isExtended) to the `setDisplaySteps` method.
- update examples and docs to demonstrate v2 Transfers with vendorFields up to 255 characters.
- update Message example with extended field up to 255 characters.
- update the changelog.
@ghost ghost added Complexity: High More than 256 lines changed. Type: Task The issue is a request to setup third-party integrations or any general non-code related tasks. labels Jan 7, 2020
@sleepdefic1t sleepdefic1t merged commit 9eb76f4 into ArkEcosystem:develop Jan 9, 2020
@sleepdefic1t sleepdefic1t mentioned this pull request Jan 9, 2020
Closed
@ghost ghost mentioned this pull request Jan 12, 2020
Closed
sleepdefic1t added a commit that referenced this pull request Feb 5, 2020
@sleepdefic1t
release: v.2.0.0
1973ac9 

While there are no breaking changes from a users perspective, this release includes a massive rewrite of the project.


Backwards compatibility is maintained in this release.



Specific objectives accomplished within this release:

- Support ARK Core v2 Transactions.

- Support Message Signing.

- Merge changes from `LedgerHQ/ledger-app-ark`.

- Update the ARK Ledger App to use Ledger Nano FW v.1.6.0.

- Improve overall project layout.

- Add files to support development environment setup using Vagrant.

- Update documentation.



Significant changes can also be found in the CHANGELOG, as well as the following pull requests:

-   added message signing features [#40](#40)
-   implement v2 Transactions [#27](#27)
-   added VendorField display support [#29](#29)
-   added build options and documentation [#32](#32)
-   merged updates from LedgerHQ/ledger-app-ark [#23](#23)
-   cleaned up warnings and refactored implementation [#25](#25)
-   upgraded `nanos-secure-sdk` version `1553` -> `160` [#46](#46)
-   refactor transactions classes to decouple Ledger SDK code [#51](#51)
-   unify Ledger NanoS and NanoX ux display flow [#53](#53)
-   implement support for large text fields [#55](#55)
This was referenced Feb 5, 2020
Merged
Merged
sleepdefic1t added a commit that referenced this pull request Feb 8, 2020
@sleepdefic1t
release: ARK Ledger App v.2.0.0
9a60e56 
## Summary


While there are no breaking changes from a users perspective, this release includes a massive rewrite of the project.


Specific objectives accomplished within this release:

- Support ARK Core v2 Transactions.
- Support Message Signing.
- Merge changes from `LedgerHQ/ledger-app-ark`.
- Update the ARK Ledger App to use Ledger Nano FW v.1.6.0.
- Implement optimized Base58 from Ledger BTC App.
- Improve overall project layout.

- Add files to support development environment setup using Vagrant.
- Update documentation.



Significant changes can be found in the CHANGELOG, as well as the following pull requests:

-   added message signing features [#40](#40)
-   implement v2 Transactions [#27](#27)
-   added VendorField display support [#29](#29)
-   added build options and documentation [#32](#32)
-   merged updates from LedgerHQ/ledger-app-ark [#23](#23)
-   cleaned up warnings and refactored implementation [#25](#25)
-   upgraded `nanos-secure-sdk` version `1553` -> `160` [#46](#46)
-   refactor transactions classes to decouple Ledger SDK code [#51](#51)
-   unify Ledger NanoS and NanoX ux display flow [#53](#53)
-   implement support for large text fields [#55](#55)
-   use optimized Base58 implementation from Ledger BTC app [#66](#66)

## Supported in v.2.0.0

### Transaction Versions:

- v0
- v1 (_added_)
- v2 (_added_)

### Signing Algorithms:

- Ecdsa

### Operation Types:

- Get PublicKey
- Get App Configuration
- Sign Message (_added_)
- Sign Transaction

### Transaction Types:

- v0
  - Transfer
  - Vote
- v1 (_added_)
  - Transfer
  - Vote
- v2 (_added_)
  - Transfer
  - Second Signature Registration
  - Vote
  - IPFS
  - Htlc Lock
  - Htlc Claim
  - Htlc Refund

## Checklist

- [x] Documentation _(if necessary)_
- [x] Ready to be merged
sleepdefic1t added a commit that referenced this pull request Feb 8, 2020
@sleepdefic1t
release: ARK Ledger App v.2.0.1
4529e3f 
## Summary


While there are no breaking changes from a users perspective, this release includes a massive rewrite of the project.


Specific objectives accomplished within this release:

- Support ARK Core v2 Transactions.
- Support Message Signing.
- Merge changes from `LedgerHQ/ledger-app-ark`.
- Update the ARK Ledger App to use Ledger Nano FW v.1.6.0.
- Implement optimized Base58 from Ledger BTC App.
- Improve overall project layout.

- Add files to support development environment setup using Vagrant.
- Update documentation.



Significant changes can be found in the CHANGELOG, as well as the following pull requests:

-   added message signing features [#40](#40)
-   implement v2 Transactions [#27](#27)
-   added VendorField display support [#29](#29)
-   added build options and documentation [#32](#32)
-   merged updates from LedgerHQ/ledger-app-ark [#23](#23)
-   cleaned up warnings and refactored implementation [#25](#25)
-   upgraded `nanos-secure-sdk` version `1553` -> `160` [#46](#46)
-   refactor transactions classes to decouple Ledger SDK code [#51](#51)
-   unify Ledger NanoS and NanoX ux display flow [#53](#53)
-   implement support for large text fields [#55](#55)
-   use optimized Base58 implementation from Ledger BTC app [#66](#66)

## Supported in v.2.0.0

### Transaction Versions:

- v0
- v1 (_added_)
- v2 (_added_)

### Signing Algorithms:

- Ecdsa

### Operation Types:

- Get PublicKey
- Get App Configuration
- Sign Message (_added_)
- Sign Transaction

### Transaction Types:

- v0
  - Transfer
  - Vote
- v1 (_added_)
  - Transfer
  - Vote
- v2 (_added_)
  - Transfer
  - Second Signature Registration
  - Vote
  - IPFS
  - Htlc Lock
  - Htlc Claim
  - Htlc Refund

## Checklist

- [x] Documentation _(if necessary)_
- [x] Ready to be merged
sleepdefic1t added a commit that referenced this pull request Feb 8, 2020
@sleepdefic1t
release: ARK Ledger App v.2.0.1
dce8a6d 
## Summary


While there are no breaking changes from a users perspective, this release includes a massive rewrite of the project.


Specific objectives accomplished within this release:

- Support ARK Core v2 Transactions.
- Support Message Signing.
- Merge changes from `LedgerHQ/ledger-app-ark`.
- Update the ARK Ledger App to use Ledger Nano FW v.1.6.0.
- Implement optimized Base58 from Ledger BTC App.
- Improve overall project layout.

- Add files to support development environment setup using Vagrant.
- Update documentation.



Significant changes can be found in the CHANGELOG, as well as the following pull requests:

-   added message signing features [#40](#40)
-   implement v2 Transactions [#27](#27)
-   added VendorField display support [#29](#29)
-   added build options and documentation [#32](#32)
-   merged updates from LedgerHQ/ledger-app-ark [#23](#23)
-   cleaned up warnings and refactored implementation [#25](#25)
-   upgraded `nanos-secure-sdk` version `1553` -> `160` [#46](#46)
-   refactor transactions classes to decouple Ledger SDK code [#51](#51)
-   unify Ledger NanoS and NanoX ux display flow [#53](#53)
-   implement support for large text fields [#55](#55)
-   use optimized Base58 implementation from Ledger BTC app [#66](#66)

## Supported in v.2.0.0

### Transaction Versions:

- v0
- v1 (_added_)
- v2 (_added_)

### Signing Algorithms:

- Ecdsa

### Operation Types:

- Get PublicKey
- Get App Configuration
- Sign Message (_added_)
- Sign Transaction

### Transaction Types:

- v0
  - Transfer
  - Vote
- v1 (_added_)
  - Transfer
  - Vote
- v2 (_added_)
  - Transfer
  - Second Signature Registration
  - Vote
  - IPFS
  - Htlc Lock
  - Htlc Claim
  - Htlc Refund

## Checklist

- [x] Documentation _(if necessary)_
- [x] Ready to be merged

## Additional Discussion

This patch release adds #66 to #65
@sleepdefic1t sleepdefic1t mentioned this pull request Feb 8, 2020
Merged
2 tasks
@sleepdefic1t sleepdefic1t deleted the chore/support-large-text-fields branch February 10, 2020 18:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fix fix Awaiting requested review from fix

@kristjank kristjank Awaiting requested review from kristjank

@vasild vasild Awaiting requested review from vasild

Assignees
No one assigned
Labels
Complexity: High More than 256 lines changed. Type: Task The issue is a request to setup third-party integrations or any general non-code related tasks.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@sleepdefic1t