diff --git a/.github/workflows/build-lint.yaml b/.github/workflows/build-lint.yaml index 8a550d8..86a7987 100644 --- a/.github/workflows/build-lint.yaml +++ b/.github/workflows/build-lint.yaml @@ -1,5 +1,5 @@ # This workflow will do a clean install of bun dependencies and lint the code -# It will also compile the contracts under `hardhat-deploy/` folder to make sure code examples are correct. +# It will also compile the contracts under `smart-contracts-hardhat/` folder to make sure code examples are correct. name: Build + Lint on: @@ -29,4 +29,4 @@ jobs: run: bun run lint - name: 👷 Build contracts on Hardhat folders - run: cd hardhat-deploy && bun install && bun run build + run: cd smart-contracts-hardhat && bun install && bun run build diff --git a/README.md b/README.md index 985cc19..99ca221 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,16 @@ Convenient code snippets to interact with [LSP](https://docs.lukso.tech/standard ## Contents -- [`universal-profile`](./universal-profile): Universal Profile -- [`extract-data`](./extract-data): Extract LSP3 and LSP4 JSON Data -- [`fetch-asset`](./fetch-asset): Asset-related Data Fetches and Operations -- [`hardhat-deploy`](./hardhat-deploy): Smart Contract Deployment Setup and Scripts +- [`universal-profile`](./universal-profile): Universal Profile related scripts - [`interface-detection`](./interface-detection): Verify EIP165 Standard Compatibility - [`key-manager`](./key-manager): Permission Management of Controller Keys - [`metadata-detection`](./metadata-detection): Verify ERC725Y Storage Compatability -- [`transfer-lyx`](./transfer-lyx): Coin Transfers for Backend and Exetnsion -- [`transfer-token`](./transfer-token/): Token Transfers for Backend and Exetnsion +- [`transfer-lyx`](./transfer-lyx): Coin Transfers for Backend and Extension +- [`digital-assets`](./digital-assets/): Digital assets (LSP7/8) scripts + +### 📑 Smart contracts + +- [`smart-contracts-hardhat`](./smart-contracts-hardhat): Hardhat Smart Contract Deployment Setup and Scripts ### LUKSO Libraries diff --git a/transfer-token/README.md b/digital-assets/README.md similarity index 100% rename from transfer-token/README.md rename to digital-assets/README.md diff --git a/transfer-token/backend-token-transaction.ts b/digital-assets/backend-token-transaction.ts similarity index 100% rename from transfer-token/backend-token-transaction.ts rename to digital-assets/backend-token-transaction.ts diff --git a/extract-data/extract-asset-data.ts b/digital-assets/extract-asset-data.ts similarity index 100% rename from extract-data/extract-asset-data.ts rename to digital-assets/extract-asset-data.ts diff --git a/fetch-asset/fetch-json-data.ts b/digital-assets/fetch-json-data.ts similarity index 100% rename from fetch-asset/fetch-json-data.ts rename to digital-assets/fetch-json-data.ts diff --git a/fetch-asset/get-data-keys.ts b/digital-assets/get-data-keys.ts similarity index 100% rename from fetch-asset/get-data-keys.ts rename to digital-assets/get-data-keys.ts diff --git a/transfer-token/regular-token-transaction.ts b/digital-assets/regular-token-transaction.ts similarity index 100% rename from transfer-token/regular-token-transaction.ts rename to digital-assets/regular-token-transaction.ts diff --git a/interface-detection/README.md b/interface-detection/README.md new file mode 100644 index 0000000..1c7500a --- /dev/null +++ b/interface-detection/README.md @@ -0,0 +1,3 @@ +# Interface detection + +- https://docs.lukso.tech/learn/dapp-developer/standard-detection diff --git a/interface-detection/erc165-interface-check.ts b/interface-detection/erc165-interface-check.ts index a508b81..a83f823 100644 --- a/interface-detection/erc165-interface-check.ts +++ b/interface-detection/erc165-interface-check.ts @@ -5,6 +5,7 @@ import UniversalProfile from '@lukso/lsp-smart-contracts/artifacts/UniversalProf import { INTERFACE_IDS } from '@lukso/lsp-smart-contracts'; // https://docs.lukso.tech/contracts/interface-ids +// https://docs.lukso.tech/learn/dapp-developer/standard-detection // Asset Example const myAsset = new ERC725( diff --git a/metadata-detection/README.md b/metadata-detection/README.md new file mode 100644 index 0000000..9caf20c --- /dev/null +++ b/metadata-detection/README.md @@ -0,0 +1 @@ +# Metadata detection diff --git a/hardhat-deploy/.env.example b/smart-contracts-hardhat/.env.example similarity index 100% rename from hardhat-deploy/.env.example rename to smart-contracts-hardhat/.env.example diff --git a/hardhat-deploy/.gitignore b/smart-contracts-hardhat/.gitignore similarity index 100% rename from hardhat-deploy/.gitignore rename to smart-contracts-hardhat/.gitignore diff --git a/hardhat-deploy/README.md b/smart-contracts-hardhat/README.md similarity index 100% rename from hardhat-deploy/README.md rename to smart-contracts-hardhat/README.md diff --git a/hardhat-deploy/bun.lockb b/smart-contracts-hardhat/bun.lockb similarity index 100% rename from hardhat-deploy/bun.lockb rename to smart-contracts-hardhat/bun.lockb diff --git a/hardhat-deploy/contracts/MyCustomToken.sol b/smart-contracts-hardhat/contracts/MyCustomToken.sol similarity index 100% rename from hardhat-deploy/contracts/MyCustomToken.sol rename to smart-contracts-hardhat/contracts/MyCustomToken.sol diff --git a/hardhat-deploy/hardhat.config.ts b/smart-contracts-hardhat/hardhat.config.ts similarity index 100% rename from hardhat-deploy/hardhat.config.ts rename to smart-contracts-hardhat/hardhat.config.ts diff --git a/hardhat-deploy/package.json b/smart-contracts-hardhat/package.json similarity index 100% rename from hardhat-deploy/package.json rename to smart-contracts-hardhat/package.json diff --git a/hardhat-deploy/scripts/deployEOA.ts b/smart-contracts-hardhat/scripts/deployEOA.ts similarity index 100% rename from hardhat-deploy/scripts/deployEOA.ts rename to smart-contracts-hardhat/scripts/deployEOA.ts diff --git a/hardhat-deploy/scripts/deployUP.ts b/smart-contracts-hardhat/scripts/deployUP.ts similarity index 100% rename from hardhat-deploy/scripts/deployUP.ts rename to smart-contracts-hardhat/scripts/deployUP.ts diff --git a/hardhat-deploy/tsconfig.json b/smart-contracts-hardhat/tsconfig.json similarity index 100% rename from hardhat-deploy/tsconfig.json rename to smart-contracts-hardhat/tsconfig.json