Rework folder structure

lukso-network · Feb 2, 2024 · 81af848 · 81af848
1 parent 7de32b0
commit 81af848
Show file tree

Hide file tree

Showing 21 changed files with 14 additions and 8 deletions.
diff --git 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
@@ -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 → digital-assets/README.md b/transfer-token/README.md → digital-assets/README.md
diff --git a/transfer-token/backend-token-transaction.ts → digital-assets/backend-token-transaction.ts b/transfer-token/backend-token-transaction.ts → digital-assets/backend-token-transaction.ts
diff --git a/extract-data/extract-asset-data.ts → digital-assets/extract-asset-data.ts b/extract-data/extract-asset-data.ts → digital-assets/extract-asset-data.ts
diff --git a/fetch-asset/fetch-json-data.ts → digital-assets/fetch-json-data.ts b/fetch-asset/fetch-json-data.ts → digital-assets/fetch-json-data.ts
diff --git a/fetch-asset/get-data-keys.ts → digital-assets/get-data-keys.ts b/fetch-asset/get-data-keys.ts → digital-assets/get-data-keys.ts
diff --git a/transfer-token/regular-token-transaction.ts → digital-assets/regular-token-transaction.ts b/transfer-token/regular-token-transaction.ts → digital-assets/regular-token-transaction.ts
diff --git a/interface-detection/README.md 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
@@ -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
@@ -0,0 +1 @@
+# Metadata detection
diff --git a/hardhat-deploy/.env.example → smart-contracts-hardhat/.env.example b/hardhat-deploy/.env.example → smart-contracts-hardhat/.env.example
diff --git a/hardhat-deploy/.gitignore → smart-contracts-hardhat/.gitignore b/hardhat-deploy/.gitignore → smart-contracts-hardhat/.gitignore
diff --git a/hardhat-deploy/README.md → smart-contracts-hardhat/README.md b/hardhat-deploy/README.md → smart-contracts-hardhat/README.md
diff --git a/hardhat-deploy/bun.lockb → smart-contracts-hardhat/bun.lockb b/hardhat-deploy/bun.lockb → smart-contracts-hardhat/bun.lockb
diff --git a/hardhat-deploy/contracts/MyCustomToken.sol → ...racts-hardhat/contracts/MyCustomToken.sol b/hardhat-deploy/contracts/MyCustomToken.sol → ...racts-hardhat/contracts/MyCustomToken.sol
diff --git a/hardhat-deploy/hardhat.config.ts → smart-contracts-hardhat/hardhat.config.ts b/hardhat-deploy/hardhat.config.ts → smart-contracts-hardhat/hardhat.config.ts
diff --git a/hardhat-deploy/package.json → smart-contracts-hardhat/package.json b/hardhat-deploy/package.json → smart-contracts-hardhat/package.json
diff --git a/hardhat-deploy/scripts/deployEOA.ts → smart-contracts-hardhat/scripts/deployEOA.ts b/hardhat-deploy/scripts/deployEOA.ts → smart-contracts-hardhat/scripts/deployEOA.ts
diff --git a/hardhat-deploy/scripts/deployUP.ts → smart-contracts-hardhat/scripts/deployUP.ts b/hardhat-deploy/scripts/deployUP.ts → smart-contracts-hardhat/scripts/deployUP.ts
diff --git a/hardhat-deploy/tsconfig.json → smart-contracts-hardhat/tsconfig.json b/hardhat-deploy/tsconfig.json → smart-contracts-hardhat/tsconfig.json