-
Notifications
You must be signed in to change notification settings - Fork 50
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
20 additions
and
55 deletions.
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 | ||
|
||
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 Unviersal Receiver | ||
|
||
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 Unviersal 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,51 +1,3 @@ | ||
# LSP Package Template | ||
# LSP3 Profile Metadata | ||
|
||
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. |