-
Notifications
You must be signed in to change notification settings - Fork 50
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
docs: add packages table, npm version to each package #886
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # LSP0 ERC725Account | ||
| # LSP0 ERC725Account · [](https://www.npmjs.com/package/@lukso/lsp0-contracts) | ||
|
|
||
| Package for the LSP0 ER725Account standard. | ||
| Package for the LSP0 ERC725Account standard. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,3 @@ | ||
| # LSP Template | ||
| # LSP1 Universal Receiver · [](https://www.npmjs.com/package/@lukso/lsp1-contracts) | ||
|
|
||
| This project can be used as a skeleton to build a package for a LSP implementation in Solidity (LUKSO Standard Proposal) | ||
|
|
||
| It is based on Hardhat. | ||
| Package for the LSP1 Universal Receiver standard. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,3 @@ | ||
| # LSP Template | ||
| # LSP10 Received Vaults · [](https://www.npmjs.com/package/@lukso/lsp10-contracts) | ||
|
|
||
| This project can be used as a skeleton to build a package for a LSP implementation in Solidity (LUKSO Standard Proposal) | ||
|
|
||
| It is based on Hardhat. | ||
| Package for the LSP10 Received Vaults standard. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # LSP12 Issued Assets | ||
| # · [](https://www.npmjs.com/package/@lukso/lsp12-contracts) | ||
|
|
||
| Package for the LSP12 Issued Assets standard. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # LSP14 Ownable 2 Step | ||
| # LSP14 Ownable 2 Step · [](https://www.npmjs.com/package/@lukso/lsp14-contracts) | ||
|
|
||
| Package for the LSP14 Ownable 2 Step standard. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # LSP16 Universal Factory | ||
| # LSP16 Universal Factory · [](https://www.npmjs.com/package/@lukso/lsp16-contracts) | ||
|
|
||
| Package for the [LSP16-UniversalFactory](https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-16-UniversalFactory.md) standard, contains a contract that allows deploying contracts on multiple chains with the same address. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # LSP17 Contract Extension Package | ||
| # LSP17 Contract Extension Package · [](https://www.npmjs.com/package/@lukso/lsp17contractextension-contracts) | ||
|
|
||
| Package for the LSP17 Contract Extension |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # LSP2 ERC725Y JSON Schema | ||
| # LSP2 ERC725Y JSON Schema · [](https://www.npmjs.com/package/@lukso/lsp2-contracts) | ||
|
|
||
| Package for the LSP2 ERC725Y JSON Schema standard. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # LSP20 Call Verification | ||
| # LSP20 Call Verification · [](https://www.npmjs.com/package/@lukso/lsp20-contracts) | ||
|
|
||
| Package for the LSP20 Call Verification standard. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # LSP23 Linked Contracts Factory | ||
| # LSP23 Linked Contracts Factory · [](https://www.npmjs.com/package/@lukso/lsp23-contracts) | ||
|
|
||
| Package for the LSP23 Linked Contracts Factory. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # LSP25 Execute Relay Call | ||
| # LSP25 Execute Relay Call · [](https://www.npmjs.com/package/@lukso/lsp25-contracts) | ||
|
|
||
| Package for the LSP25 Execute Relay Call standard. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,51 +1,3 @@ | ||
| # LSP Package Template | ||
| # LSP3 Profile Metadata · [](https://www.npmjs.com/package/@lukso/lsp3-contracts) | ||
|
|
||
| This project can be used as a skeleton to build a package for a LSP implementation in Solidity (LUKSO Standard Proposal) | ||
|
|
||
| It is based on Hardhat. | ||
|
|
||
| ## How to setup a LSP as a package? | ||
|
|
||
| 1. Copy the `template/` folder and paste it under the `packages/` folder. Then rename this `template/` folder that you copied with the LSP name. | ||
|
|
||
| You can do so either: | ||
|
|
||
| - manually, by copying the folder and pasting it inside `packages` and then renaming it. | ||
| or | ||
| - by running the following command from the root of the repository. | ||
|
|
||
| ```bash | ||
| cp -r template packages/lsp-name | ||
| ``` | ||
|
|
||
| 2. Update the `"name"` and `"description"` field inside the `package.json` for this LSP package you just created. | ||
|
|
||
| 3. Setup the dependencies | ||
|
|
||
| If this LSP uses external dependencies like `@openzeppelin/contracts`, put them under `dependencies` with the version number. | ||
|
|
||
| ```json | ||
| "@openzeppelin/contracts": "^4.9.3" | ||
| ``` | ||
|
|
||
| If this LSP uses other LSP as dependencies, put each LSP dependency as shown below. This will use the current code in the package: | ||
|
|
||
| ```json | ||
| "@lsp2": "*" | ||
| ``` | ||
|
|
||
| 4. Setup the npm commands for linting, building, testing, etc... under the `"scripts"` in the `package.json` | ||
|
|
||
| 5. Test that all commands you setup run successfully | ||
|
|
||
| By running the commands below, your LSP package should come up in the list of packages that Turbo is running this command for. | ||
|
|
||
| ```bash | ||
| turbo build | ||
| turbo lint | ||
| turbo lint:solidity | ||
| turbo test | ||
| turbo test:foundry | ||
| ``` | ||
|
|
||
| 6. Finally update the relevant information in the `README.md` file in the folder of the newly created package, such as the title at the top, some description, etc... | ||
| Package for the LSP3 Profile Metadata standard. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # LSP4 Digital Asset Metadata | ||
| # LSP4 Digital Asset Metadata · [](https://www.npmjs.com/package/@lukso/lsp4-contracts) | ||
|
|
||
| Package for the LSP4 Digital Asset Metadata standard. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # LSP5 Received Assets | ||
| # LSP5 Received Assets · [](https://www.npmjs.com/package/@lukso/lsp5-contracts) | ||
|
|
||
| Package for the LSP5 Received Assets standard. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # LSP6 Key Manager | ||
| # LSP6 Key Manager · [](https://www.npmjs.com/package/@lukso/lsp6-contracts) | ||
|
|
||
| Package for the LSP6 Key Manager standard, to enable granting multiple permissions to controllers. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # LSP7 Digital Asset | ||
| # LSP7 Digital Asset · [](https://www.npmjs.com/package/@lukso/lsp7-contracts) | ||
|
|
||
| Package for the LSP7 Digital Asset standard. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # LSP8 Identifiable Digital Asset | ||
| # LSP8 Identifiable Digital Asset · [](https://www.npmjs.com/package/@lukso/lsp8-contracts) | ||
|
|
||
| Package for the LSP8 Identifiable Digital Asset Standard. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # LSP9 Vault | ||
| # LSP9 Vault · [](https://www.npmjs.com/package/@lukso/lsp9-contracts) | ||
|
|
||
| Package for the LSP9 Vault standard. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think since
@lukso/lsp-smart-contractswill move to its own package, we can update the README at the root to be more reflective of the monorepo.For instance with infos like mentioned in Swapkit SDK README.
mainanddevelopfor.