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.

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

Add reference implementation links #503

Merged
merged 9 commits into from Dec 15, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions proposals/lip-0037.md
Expand Up @@ -144,6 +144,11 @@ def verifyEd25519(pk: bytes, tag: bytes, chainID: bytes, m: bytes, sig: bytes) -

Due to adding message tags to transaction and block signatures, the proposed signature scheme is incompatible with the current one and implies a hard fork.

## Reference Implementation

- [Update generic message signing](https://github.com/LiskHQ/lisk-sdk/pull/8805)
- [Update exposed crypto structure - Closes #6710 #7310](https://github.com/LiskHQ/lisk-sdk/pull/7310)
sergeyshemyakov marked this conversation as resolved.
Show resolved Hide resolved

## Appendix

### Examples
Expand Down
4 changes: 4 additions & 0 deletions proposals/lip-0038.md
Expand Up @@ -185,6 +185,10 @@ Notice that only during the [bootstrap period of Lisk Core v4](https://github.co

This LIP is purely informational. Therefore, it does not imply any incompatibilities.

## Reference Implementation

- [Create signBLS, verifyBLS, createAggSig, verifyAggSig and verifyWeightedAggSig function](https://github.com/LiskHQ/lisk-sdk/pull/6484)

## Appendix

### Key Management
Expand Down
5 changes: 5 additions & 0 deletions proposals/lip-0039.md
Expand Up @@ -724,6 +724,11 @@ proof = {

This proposal does not introduce any fork(s) in the network, as it only defines the specification of sparse Merkle trees in the Lisk protocol.

## Reference Implementation

- [Update tree interface - Closes #6491 and #6510 #6509](https://github.com/LiskHQ/lisk-sdk/pull/6509)
sergeyshemyakov marked this conversation as resolved.
Show resolved Hide resolved
- [Update Leafs of Regular Merkle Tree - Closes #6493 #6585](https://github.com/LiskHQ/lisk-sdk/pull/6585)

## References

[1] Rasmus Dahlberg, Tobias Pulls, and Roel Peeters, [Efficient Sparse Merkle Trees](https://eprint.iacr.org/2016/683.pdf)
Expand Down
4 changes: 4 additions & 0 deletions proposals/lip-0040.md
Expand Up @@ -111,3 +111,7 @@ This LIP is purely informational, hence it does not imply any incompatibilities
[lip-0039]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0039.md
[lip-0039#specs]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0039.md#specification
[lip-0053]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0053.md

## Reference Implementation

- [https://github.com/LiskHQ/lisk-sdk/issues/6554](https://github.com/LiskHQ/lisk-sdk/issues/6554)
5 changes: 5 additions & 0 deletions proposals/lip-0041.md
Expand Up @@ -630,3 +630,8 @@ def beforeCommandExecute(trs: Transaction) -> None:
## Backwards Compatibility

This LIP defines a new storage interface for the Auth module, which in turn will become part of the state tree and will be authenticated by the state root. An existing chain including the Auth module will need to perform a hardfork.

## Reference Implementation

- [Bootstrap auth module with initials](https://github.com/LiskHQ/lisk-sdk/pull/6770)
ishantiw marked this conversation as resolved.
Show resolved Hide resolved
- [Update Auth module according update of LIP0041](https://github.com/LiskHQ/lisk-sdk/pull/7392)
2 changes: 1 addition & 1 deletion proposals/lip-0042.md
Expand Up @@ -216,7 +216,7 @@ This LIP defines the interface for the Reward module but does not introduce any

## Reference Implementation

TBA
[Introduce Reward Module](https://github.com/LiskHQ/lisk-sdk/issues/6686)

[creative]: https://creativecommons.org/publicdomain/zero/1.0/
[block-schema-lip]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0055.md
Expand Down
2 changes: 1 addition & 1 deletion proposals/lip-0043.md
Expand Up @@ -608,7 +608,7 @@ This proposal, together with [LIP 0045][lip-0045], [LIP 0053][lip-0053], [LIP 00

## Reference Implementation

TBA
[Introduce interoperability modules](https://github.com/LiskHQ/lisk-sdk/issues/6915)

[creative]: https://creativecommons.org/publicdomain/zero/1.0/
[lip-0037]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0037.md
Expand Down
2 changes: 1 addition & 1 deletion proposals/lip-0044.md
Expand Up @@ -638,7 +638,7 @@ This LIP defines a new module and specify its store, which in turn will become p

## Reference Implementation

TBA
[Introduce Validators module](https://github.com/LiskHQ/lisk-sdk/issues/6668)

[bls-specs-v4-popverify]: https://tools.ietf.org/html/draft-irtf-cfrg-bls-signature-04#section-3.3.3
[lip-0038#public-key-registration]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0038.md#public-key-registration-and-proof-of-possession
Expand Down
4 changes: 4 additions & 0 deletions proposals/lip-0045.md
Expand Up @@ -1747,3 +1747,7 @@ This proposal, together with [LIP 0043][lip-0043], [LIP 0049][lip-0049], [LIP 00
[lip-0054]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0054.md
[lip-0055#block-processing-stages]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0055.md#block-processing-stages
[lip-0061#certificate-schema]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0061.md#schema

## Reference Implementation

[Introduce interoperability modules](https://github.com/LiskHQ/lisk-sdk/issues/6915)
2 changes: 1 addition & 1 deletion proposals/lip-0046.md
Expand Up @@ -308,7 +308,7 @@ This LIP defines a new store interface for the Random module, which in turn will

## Reference Implementation

TBA
[Introduce Random module](https://github.com/LiskHQ/lisk-sdk/issues/6773)

[creative]: https://creativecommons.org/publicdomain/zero/1.0/
[lip-0022#hash-onion-computation]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0022.md#b-hash-onion-computation
Expand Down
2 changes: 1 addition & 1 deletion proposals/lip-0047.md
Expand Up @@ -768,7 +768,7 @@ This LIP introduces a new module for sidechains in the Lisk ecosystem. As such i

## Reference Implementation

TBA
[Introduce PoA module](https://github.com/LiskHQ/lisk-sdk/issues/6930)

[creative]: https://creativecommons.org/publicdomain/zero/1.0/
[ethereum:poa]: https://github.com/ethereum/guide/blob/master/poa.md
Expand Down
2 changes: 1 addition & 1 deletion proposals/lip-0048.md
Expand Up @@ -395,7 +395,7 @@ This LIP defines a new Fee module, which follows the same protocol as currently

## Reference Implementation

TBA
[Introduce Fee module](https://github.com/LiskHQ/lisk-sdk/issues/6691)

[lip-0013]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0013.md
[lip-0040]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0040.md
Expand Down
2 changes: 1 addition & 1 deletion proposals/lip-0049.md
Expand Up @@ -631,7 +631,7 @@ This proposal, together with [LIP 0043][lip-0043], [LIP 0045][lip-0045], [LIP 00

## Reference Implementation

TBA
[Bootstrap cross chain commands for mainchain/sidechain modules](https://github.com/LiskHQ/lisk-sdk/issues/7024)
sergeyshemyakov marked this conversation as resolved.
Show resolved Hide resolved

[lip-0043]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0043.md
[lip-0045]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0045.md
Expand Down
3 changes: 2 additions & 1 deletion proposals/lip-0050.md
Expand Up @@ -421,7 +421,8 @@ This LIP defines a new module and specifies its store, which in turn will become

## Reference Implementation

TBA
[Merge feature/7136-support-legacy-blocks-and-transactions to development](https://github.com/LiskHQ/lisk-sdk/pull/7680)
sergeyshemyakov marked this conversation as resolved.
Show resolved Hide resolved


[lip-0018]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0018.md
[lip-0018#AccountsWithoutPKey]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0018.md#accounts-without-public-key
Expand Down
2 changes: 1 addition & 1 deletion proposals/lip-0051.md
Expand Up @@ -2664,7 +2664,7 @@ This introduces a different token handling mechanism for the whole Lisk ecosyste

## Reference Implementation

TBA
[Update token module to align with updated architecture](https://github.com/LiskHQ/lisk-sdk/issues/6871)
sergeyshemyakov marked this conversation as resolved.
Show resolved Hide resolved

[lip-0037#chain-identifiers-1]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0037.md#chain-identifiers-1
[lip-0037#getMainchainID]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0037.md#mainchain-chain-id
Expand Down
2 changes: 1 addition & 1 deletion proposals/lip-0052.md
Expand Up @@ -2413,7 +2413,7 @@ Chains adding support for the NFT module specified in this document need to do s

## Reference Implementation

TBA
[Prepare Lisk SDK v6.1.0 for rc](https://github.com/LiskHQ/lisk-sdk/issues/7245)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe a link to the module itself (https://github.com/LiskHQ/lisk-sdk/tree/release/6.1.0/framework/src/modules/nft) would be more clear, since the user will not have to dig through many links.
Or you could link this epic: LiskHQ/lisk-sdk#6917


[lip-0043]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0043.md
[lip-0045]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0045.md
Expand Down
2 changes: 1 addition & 1 deletion proposals/lip-0053.md
Expand Up @@ -781,7 +781,7 @@ This proposal, together with [LIP 0043][lip-0043], [LIP 0049][lip-0049], and [LI

## Reference Implementation

TBA
[Introduce interoperability modules](https://github.com/LiskHQ/lisk-sdk/issues/6915)

## Appendix

Expand Down
2 changes: 1 addition & 1 deletion proposals/lip-0054.md
Expand Up @@ -866,7 +866,7 @@ This LIP introduces new commands with new effects to the Lisk mainchain state, t

## Reference Implementation

TBA
[Introduce interoperability modules](https://github.com/LiskHQ/lisk-sdk/issues/6915)

[creative]: https://creativecommons.org/publicdomain/zero/1.0/
[lip-0031#appendixC]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0031.md#appendix-c-proof-of-inclusion-protocol-for-leaf-nodes
Expand Down
4 changes: 3 additions & 1 deletion proposals/lip-0055.md
Expand Up @@ -596,7 +596,9 @@ This LIP results in a hard fork as nodes following the proposed protocol will re

## Reference Implementation

TBA
- [Update hooks and property name to be more clear - Closes #6888 #6942](https://github.com/LiskHQ/lisk-sdk/pull/6942)
- [Update block verification - Closes #6754 #6872](https://github.com/LiskHQ/lisk-sdk/pull/6872)
- [Update block schema - Closes #6739 #6765](https://github.com/LiskHQ/lisk-sdk/pull/6765)

[lip-0004]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0004.md
[lip-0014#block-header-properties]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0014.md#additional-block-header-properties
Expand Down
4 changes: 4 additions & 0 deletions proposals/lip-0056.md
Expand Up @@ -280,3 +280,7 @@ This LIP together with [LIP 0058][lip-0058] changes how a block is processed and
[lip-0047]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0047.md
[lisk-bft-paper]: https://arxiv.org/abs/1903.11434
[lip-0058]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0058.md

## Reference Implementation

[Introduce BFT module](https://github.com/LiskHQ/lisk-sdk/issues/6742)
2 changes: 1 addition & 1 deletion proposals/lip-0057.md
Expand Up @@ -2084,7 +2084,7 @@ This LIP defines a new store interface for the PoS module, which in turn will be

## Reference Implementation

TBA
[Update DPoS terminologies to PoS #7803](https://github.com/LiskHQ/lisk-sdk/pull/7803)
sergeyshemyakov marked this conversation as resolved.
Show resolved Hide resolved

[lip-0003]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0003.md
[lip-0022]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0022.md
Expand Down
2 changes: 1 addition & 1 deletion proposals/lip-0058.md
Expand Up @@ -827,7 +827,7 @@ This LIP changes how a block is processed and therefore introduces a hardfork.

## Reference Implementation

TBD
[Introduce BFT module](https://github.com/LiskHQ/lisk-sdk/issues/6742)

[lip-0042]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0042.md
[lip-0044]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0044.md
Expand Down
5 changes: 5 additions & 0 deletions proposals/lip-0059.md
Expand Up @@ -89,3 +89,8 @@ This LIP introduces a soft fork as the validity condition for the unlocking tran
[lip-0057#roundnumber]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0057.md#roundnumber
[lip-0058]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0058.md
[lip-0061]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0061.md


## Reference Implementation

[Introduce certificate generation mechanism](https://github.com/LiskHQ/lisk-sdk/issues/6837)
sergeyshemyakov marked this conversation as resolved.
Show resolved Hide resolved
6 changes: 6 additions & 0 deletions proposals/lip-0060.md
Expand Up @@ -160,3 +160,9 @@ This LIP defines a new block schema and processing, but does not imply a hardfor
[lip-0055#header-schema]:https://github.com/LiskHQ/lips/blob/main/proposals/lip-0055.md#block-header-json-schema
[lip-0055#state-root]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0055.md#state-root
[lip-0055#validation]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0055.md#validation

## Reference Implementation

- [Update hooks and property name to be more clear - Closes #6888 #6942](https://github.com/LiskHQ/lisk-sdk/pull/6942)
- [Update block verification - Closes #6754 #6872](https://github.com/LiskHQ/lisk-sdk/pull/6872)
- [Update block schema - Closes #6739 #6765](https://github.com/LiskHQ/lisk-sdk/pull/6765)
5 changes: 5 additions & 0 deletions proposals/lip-0061.md
Expand Up @@ -818,3 +818,8 @@ def computeEligibleSingleCommits(addressToBFTWeight: dict[bytes, uint64], lastCe
[lip-0063#bootstrap-period]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0063.md#bootstrap-period
[lip-0063#constants-1]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0063.md#constants-1
[lip-0064]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0064.md


## Reference Implementation

[Introduce certificate generation mechanism](https://github.com/LiskHQ/lisk-sdk/issues/6837)
2 changes: 1 addition & 1 deletion proposals/lip-0062.md
Expand Up @@ -154,7 +154,7 @@ The `signBLS`, `verifyBLS`, `verifyAggSig`, and `verifyWeightedAggSig` functions

## Reference Implementation

TBD
[Create signBLS, verifyBLS, createAggSig, verifyAggSig and verifyWeightedAggSig function](https://github.com/LiskHQ/lisk-sdk/pull/6484)

## Backwards Compatibility

Expand Down
2 changes: 1 addition & 1 deletion proposals/lip-0064.md
Expand Up @@ -65,7 +65,7 @@ From the Lisk JSON schemas used in the protocol of Lisk SDK 5, only the [block h

## Reference Implementation

TBD
- [Update block schema - Closes #6739 #6765](https://github.com/LiskHQ/lisk-sdk/pull/6765)
sergeyshemyakov marked this conversation as resolved.
Show resolved Hide resolved

## Appendix

Expand Down
4 changes: 4 additions & 0 deletions proposals/lip-0065.md
Expand Up @@ -270,3 +270,7 @@ This LIP, and in general the new block header proposed in [LIP 0055][lip-0055],
[lip-0055#block-processing-stages]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0055.md#block-processing-stages
[lip-0055#failing]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0055.md#failing-and-invalid-transactions
[lip-0055#separation]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0055.md#separation-between-block-header-and-block-assets

## Reference Implementation

[Update event definition, event queue and block header - Closes #7124 and #7125 #7157](https://github.com/LiskHQ/lisk-sdk/pull/7157)
2 changes: 1 addition & 1 deletion proposals/lip-0066.md
Expand Up @@ -214,7 +214,7 @@ This proposal is backwards compatible since the protocol is not changed.

## Reference Implementation

TBD
[Update exposed crypto structure ](https://github.com/LiskHQ/lisk-sdk/pull/7310)
ishantiw marked this conversation as resolved.
Show resolved Hide resolved

## Appendix

Expand Down
3 changes: 2 additions & 1 deletion proposals/lip-0067.md
Expand Up @@ -199,7 +199,8 @@ There are no incompatibilities since the protocol is not changed.

## Reference Implementation

TBD
- [Add semgrep config and fix identified issues #8593](https://github.com/LiskHQ/lisk-sdk/pull/8593)
sergeyshemyakov marked this conversation as resolved.
Show resolved Hide resolved
sergeyshemyakov marked this conversation as resolved.
Show resolved Hide resolved
- [Rename ed function getKeyPairFromPhraseAndPath to getPrivateKeyFromPhraseAndPath - Closes #7563 #7628](https://github.com/LiskHQ/lisk-sdk/pull/7628)

## Appendix

Expand Down
2 changes: 1 addition & 1 deletion proposals/lip-0068.md
Expand Up @@ -182,7 +182,7 @@ This LIP results in a hard fork as nodes following the proposed protocol will re

## Reference Implementation

TBD
[Update lisk-chain to support the on-chain architecture #5609](https://github.com/LiskHQ/lisk-sdk/issues/5609)
sergeyshemyakov marked this conversation as resolved.
Show resolved Hide resolved

## Appendix

Expand Down
4 changes: 4 additions & 0 deletions proposals/lip-0069.md
Expand Up @@ -178,3 +178,7 @@ For example, the `seedReveal` property is added to the block asset in this hook
This LIP is informational. It does not introduce any protocol change.

[lip-0065]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0065.md

## Reference Implementation

[Update lisk-chain to support the on-chain architecture #5609](https://github.com/LiskHQ/lisk-sdk/issues/5609)
sergeyshemyakov marked this conversation as resolved.
Show resolved Hide resolved
3 changes: 2 additions & 1 deletion proposals/lip-0070.md
Expand Up @@ -525,7 +525,8 @@ This LIP adds extra functionality (commands, events, protocol logic) to the PoS

## Reference Implementation

TBA
- [COMMISSION_INCREASE_PERIOD](https://github.com/LiskHQ/lisk-sdk/commit/12c5d4c37e4d4ee46e2d7e977b29a8eda8e63e03)
sergeyshemyakov marked this conversation as resolved.
Show resolved Hide resolved
- [Adds reward sharing events #7735](https://github.com/LiskHQ/lisk-sdk/pull/7735)

## Appendix

Expand Down
5 changes: 5 additions & 0 deletions proposals/lip-0071.md
Expand Up @@ -396,3 +396,8 @@ This LIP defines the interface for the Dynamic Reward module but does not introd
[lip-0058]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0058.md
[lip-0063#constants]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0063.md#constants-1
[lip-0070#updatesharedrewards]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0070.md#updatesharedrewards


## Reference Implementation

[Update reward and auth to use base event](https://github.com/LiskHQ/lisk-sdk/pull/7778)
sergeyshemyakov marked this conversation as resolved.
Show resolved Hide resolved
6 changes: 5 additions & 1 deletion proposals/lip-0072.md
Expand Up @@ -551,4 +551,8 @@ This LIP results in a hard fork of the sidechain Interoperability module, as nod
[lip0053#auxiliary-functions]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0053.md#auxiliary-functions
[lip-0053#verifyroutingrules]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0053.md#verifyroutingrules
[lip0053#sidechain-ccu]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0053.md#sidechaincrosschainupdate
[lip-0058#computevalidatorshash]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0058.md#computevalidatorshash
[lip-0058#computevalidatorshash]: https://github.com/LiskHQ/lips/blob/main/proposals/lip-0058.md#computevalidatorshash

## Reference Implementation

TBD