From b459bd6292245bfafa8efd2081b026db711da805 Mon Sep 17 00:00:00 2001 From: b00ste Date: Tue, 13 Feb 2024 16:09:29 +0200 Subject: [PATCH] chore: create packages table --- README.md | 15 +++++++++ packages/lsp0-contracts/README.md | 2 +- packages/lsp1-contracts/README.md | 6 ++-- packages/lsp3-contracts/README.md | 52 ++----------------------------- 4 files changed, 20 insertions(+), 55 deletions(-) diff --git a/README.md b/README.md index 9144893d9..6ccd5735e 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,21 @@ For more information see [Documentation](https://docs.lukso.tech/standards/smart | :warning: | _This package is currently in early stages of development,
use for testing or experimentation purposes only._ | | :-------: | :----------------------------------------------------------------------------------------------------------------- | +## Packages + +This repo contains packages around SwapKit sdk and its integrations with different blockchains. + +| Package | NPM | Description | +| ------------------------------------------------------------------ | ----------------------------------------------------------------------------------------- | -------------------------------- | +| [@lukso/lsp0-contracts](./packages/lsp0-contracts) | ![npm version](https://img.shields.io/npm/v/@lukso/lsp0-contracts.svg?style=flat) | LSP0 ERC725Account | +| [@lukso/lsp1-contracts](./packages/lsp1-contracts) | ![npm version](https://img.shields.io/npm/v/@lukso/lsp1-contracts.svg?style=flat) | LSP1 Unviersal Receiver | +| [@lukso/lsp1delegate-contracts](./packages/lsp1delegate-contracts) | ![npm version](https://img.shields.io/npm/v/@lukso/lsp1delegate-contracts.svg?style=flat) | LSP1 Unviersal Receiver Delegate | +| [@lukso/lsp2-contracts](./packages/lsp2-contracts) | ![npm version](https://img.shields.io/npm/v/@lukso/lsp2-contracts.svg?style=flat) | LSP2 ERC725Y JSON Schema | +| [@lukso/lsp3-contracts](./packages/lsp3-contracts) | ![npm version](https://img.shields.io/npm/v/@lukso/lsp3-contracts.svg?style=flat) | LSP3 Profile Metadata | +| [@lukso/lsp4-contracts](./packages/lsp4-contracts) | ![npm version](https://img.shields.io/npm/v/@lukso/lsp4-contracts.svg?style=flat) | LSP4 Digital Asset Metadata | +| [@lukso/lsp5-contracts](./packages/lsp5-contracts) | ![npm version](https://img.shields.io/npm/v/@lukso/lsp5-contracts.svg?style=flat) | LSP5 Received Assets | +| [@lukso/lsp6-contracts](./packages/lsp6-contracts) | ![npm version](https://img.shields.io/npm/v/@lukso/lsp6-contracts.svg?style=flat) | LSP6 Key Manager | + ## Installation ### npm diff --git a/packages/lsp0-contracts/README.md b/packages/lsp0-contracts/README.md index d2a3f5fa2..7e1dd5656 100644 --- a/packages/lsp0-contracts/README.md +++ b/packages/lsp0-contracts/README.md @@ -1,3 +1,3 @@ # LSP0 ERC725Account -Package for the LSP0 ER725Account standard. +Package for the LSP0 ERC725Account standard. diff --git a/packages/lsp1-contracts/README.md b/packages/lsp1-contracts/README.md index 69b3ff4ff..f3b35a9dc 100755 --- a/packages/lsp1-contracts/README.md +++ b/packages/lsp1-contracts/README.md @@ -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. diff --git a/packages/lsp3-contracts/README.md b/packages/lsp3-contracts/README.md index 44c90d86b..a2d11ff40 100644 --- a/packages/lsp3-contracts/README.md +++ b/packages/lsp3-contracts/README.md @@ -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.