From 71361a8aa2d57ad278cf54508be34f6c55a13b6f Mon Sep 17 00:00:00 2001 From: CJ42 Date: Wed, 5 Feb 2025 12:22:17 +0100 Subject: [PATCH] docs: fix + document syntax to import Solidity constants --- packages/lsp-smart-contracts/README.md | 2 +- packages/lsp0-contracts/README.md | 20 +++++++++++- packages/lsp1-contracts/README.md | 16 +++++++++- packages/lsp11-contracts/README.md | 14 ++++++++- packages/lsp12-contracts/README.md | 14 ++++++++- packages/lsp14-contracts/README.md | 16 +++++++++- packages/lsp17-contracts/README.md | 2 +- .../README.md | 15 ++++++++- packages/lsp2-contracts/README.md | 15 ++++++++- packages/lsp20-contracts/README.md | 17 +++++++++- packages/lsp25-contracts/README.md | 14 ++++++++- packages/lsp26-contracts/README.md | 15 ++++++++- packages/lsp3-contracts/README.md | 15 ++++++++- packages/lsp4-contracts/README.md | 23 +++++++++++++- packages/lsp5-contracts/README.md | 14 ++++++++- packages/lsp6-contracts/README.md | 15 ++++++++- packages/lsp7-contracts/README.md | 20 +++++++++++- packages/lsp8-contracts/README.md | 31 ++++++++++++++++++- packages/lsp9-contracts/README.md | 2 +- packages/universalprofile-contracts/README.md | 4 +-- 20 files changed, 263 insertions(+), 21 deletions(-) diff --git a/packages/lsp-smart-contracts/README.md b/packages/lsp-smart-contracts/README.md index 77c3633b4..9485312d1 100644 --- a/packages/lsp-smart-contracts/README.md +++ b/packages/lsp-smart-contracts/README.md @@ -10,7 +10,7 @@ npm install @lukso/lsp-smart-contracts ## Available Constants & Types -The `@lukso/lsp-smart-contracts` npm package contains useful constants such as interface IDs, and ERC725Y data keys related to the LSP Standards. You can import and access them as follows: +The `@lukso/lsp-smart-contracts` npm package contains useful constants such as interface IDs, and ERC725Y data keys related to the LSP Standards. You can import and access them as follows. ```js import { diff --git a/packages/lsp0-contracts/README.md b/packages/lsp0-contracts/README.md index da698b030..d1e808ae2 100644 --- a/packages/lsp0-contracts/README.md +++ b/packages/lsp0-contracts/README.md @@ -10,7 +10,9 @@ npm install @lukso/lsp0-contracts ## Available Constants & Types -The `@lukso/lsp0-contracts` npm package contains useful constants such as InterfaceIds, and ERC725Y Data Keys related to the LSP0 Standard. You can import and access them as follow: +The `@lukso/lsp0-contracts` npm package contains useful constants such as interface Ids, and ERC725Y data keys related to the LSP0 Standard. You can import and access them as follows. + +In Javascript. ```js import { @@ -20,3 +22,19 @@ import { ERC1271_VALUES, } from "@lukso/lsp0-contracts"; ``` + +In Solidity. + + +```solidity +import { + _INTERFACEID_LSP0, + _INTERFACEID_ERC1271, + _ERC1271_SUCCESSVALUE, + _ERC1271_FAILVALUE, + _TYPEID_LSP0_VALUE_RECEIVED, + _TYPEID_LSP0_OwnershipTransferStarted, + _TYPEID_LSP0_OwnershipTransferred_SenderNotification, + _TYPEID_LSP0_OwnershipTransferred_RecipientNotification +} from "@lukso/lsp0-contracts/contracts/LSP0Constants.soll"; +``` diff --git a/packages/lsp1-contracts/README.md b/packages/lsp1-contracts/README.md index 048dc5810..3fc8d4887 100755 --- a/packages/lsp1-contracts/README.md +++ b/packages/lsp1-contracts/README.md @@ -10,8 +10,22 @@ npm install @lukso/lsp1-contracts ## Available Constants & Types -The `@lukso/lsp1-contracts` npm package contains useful constants such as InterfaceIds, and ERC725Y Data Keys related to the LSP1 Standard. You can import and access them as follow: +The `@lukso/lsp1-contracts` npm package contains useful constants such as interface IDs, and ERC725Y data keys related to the LSP1 Standard. You can import and access them as follows. + +In Javascript. ```js import { INTERFACE_ID_LSP1, LSP1DataKeys } from "@lukso/lsp1-contracts"; ``` + +In Solidity. + + +```solidity +import { + _INTERFACEID_LSP1, + _INTERFACEID_LSP1_DELEGATE, + _LSP1_UNIVERSAL_RECEIVER_DELEGATE_PREFIX, + _LSP1_UNIVERSAL_RECEIVER_DELEGATE_KEY +} from "@lukso/lsp1-contracts/contracts/LSP1Constants.sol"; +``` diff --git a/packages/lsp11-contracts/README.md b/packages/lsp11-contracts/README.md index dd5d78b75..cac3e2b3f 100755 --- a/packages/lsp11-contracts/README.md +++ b/packages/lsp11-contracts/README.md @@ -10,8 +10,20 @@ npm install @lukso/lsp11-contracts ## Available Constants & Types -The `@lukso/lsp11-contracts` npm package contains useful constants such as interface ID related to the LSP11 standard. You can import and access them as follows: +The `@lukso/lsp11-contracts` npm package contains useful constants such as interface ID related to the LSP11 standard. You can import and access them as follows. + +In Javascript. ```js import { INTERFACE_ID_LSP11 } from "@lukso/lsp11-contracts"; ``` + +In Solidity. + + +```solidity +import { + _INTERFACEID_LSP11, + LSP11_VERSION +} from "@lukso/lsp11-contracts/contracts/LSP11Constants.sol"; +``` diff --git a/packages/lsp12-contracts/README.md b/packages/lsp12-contracts/README.md index d3a898c32..45de251f7 100644 --- a/packages/lsp12-contracts/README.md +++ b/packages/lsp12-contracts/README.md @@ -10,8 +10,20 @@ npm install @lukso/lsp12-contracts ## Available Constants & Types -The `@lukso/lsp12-contracts` npm package contains useful constants such as ERC725Y Data Keys related to the LSP12 Standard. You can import and access them as follow: +The `@lukso/lsp12-contracts` npm package contains useful constants such as ERC725Y Data Keys related to the LSP12 Standard. You can import and access them as follows. + +In Javascript. ```js import { LSP12DataKeys } from "@lukso/lsp12-contracts"; ``` + +In Solidity. + + +```solidity +import { + _LSP12_ISSUED_ASSETS_ARRAY_KEY, + _LSP12_ISSUED_ASSETS_MAP_KEY_PREFIX +} from "@lukso/lsp12-contracts/contracts/LSP12Constants.sol"; +``` diff --git a/packages/lsp14-contracts/README.md b/packages/lsp14-contracts/README.md index 4a9266458..21c0cb990 100755 --- a/packages/lsp14-contracts/README.md +++ b/packages/lsp14-contracts/README.md @@ -10,8 +10,22 @@ npm install @lukso/lsp14-contracts ## Available Constants & Types -The `@lukso/lsp14-contracts` npm package contains useful constants such as InterfaceIds, and ERC725Y Data Keys related to the LSP14 Standard. You can import and access them as follow: +The `@lukso/lsp14-contracts` npm package contains useful constants such as interface IDs, and ERC725Y data keys related to the LSP14 Standard. You can import and access them as follows. + +In Javascript. ```js import { LSP14_TYPE_IDS, INTERFACE_ID_LSP14 } from "@lukso/lsp14-contracts"; ``` + +In Solidity. + + +```solidity +import { + _INTERFACEID_LSP14, + _TYPEID_LSP14_OwnershipTransferStarted, + _TYPEID_LSP14_OwnershipTransferred_SenderNotification, + _TYPEID_LSP14_OwnershipTransferred_RecipientNotification +} from "@lukso/lsp14-contracts/contracts/LSP14Constants.sol"; +``` diff --git a/packages/lsp17-contracts/README.md b/packages/lsp17-contracts/README.md index 5382f82ce..dd2cbba41 100644 --- a/packages/lsp17-contracts/README.md +++ b/packages/lsp17-contracts/README.md @@ -14,7 +14,7 @@ npm install @lukso/lsp17-contracts ## Available Constants & Types -The `@lukso/lsp17-contracts` npm package contains useful constants such as interface IDs related to the LSP17 Extensions. You can import and access them as follows: +The `@lukso/lsp17-contracts` npm package contains useful constants such as interface IDs related to the LSP17 Extensions. You can import and access them as follows. ```js import { INTERFACE_ID_LSP17Extension } from "@lukso/lsp17-contracts"; diff --git a/packages/lsp17contractextension-contracts/README.md b/packages/lsp17contractextension-contracts/README.md index cd1475d5d..142e86c9c 100644 --- a/packages/lsp17contractextension-contracts/README.md +++ b/packages/lsp17contractextension-contracts/README.md @@ -10,7 +10,9 @@ npm install @lukso/lsp17contractextension-contracts ## Available Constants & Types -The `@lukso/lsp17contractextension-contracts` npm package contains useful constants such as interface IDs, and ERC725Y data keys related to the LSP17 Standard. You can import and access them as follows: +The `@lukso/lsp17contractextension-contracts` npm package contains useful constants such as interface IDs, and ERC725Y data keys related to the LSP17 Standard. You can import and access them as follows. + +In Javascript. ```js import { @@ -19,3 +21,14 @@ import { LSP17DataKeys, } from "@lukso/lsp17contractextension-contracts"; ``` + +In Solidity. + + +```solidity +import { + _INTERFACEID_LSP17_EXTENDABLE, + _INTERFACEID_LSP17_EXTENSION, + _LSP17_EXTENSION_PREFIX +} from "@lukso/lsp17-contracts/contracts/LSP17Constants.sol"; +``` diff --git a/packages/lsp2-contracts/README.md b/packages/lsp2-contracts/README.md index 7d6aab4a4..ef9b96cf7 100755 --- a/packages/lsp2-contracts/README.md +++ b/packages/lsp2-contracts/README.md @@ -10,8 +10,21 @@ npm install @lukso/lsp2-contracts ## Available Constants & Types -The `@lukso/lsp2-contracts` npm package contains useful constants such as ERC725Y Data Keys related to the LSP2 Standard. You can import and access them as follow: +The `@lukso/lsp2-contracts` npm package contains useful constants such as ERC725Y Data Keys related to the LSP2 Standard. You can import and access them as follows. + +In Javascript. ```js import { LSP2ArrayKey, Verification } from "@lukso/lsp2-contracts"; ``` + +In Solidity. + + +```solidity +import { + _KECCAK256_UTF8, + _KECCAK256_BYTES, + _KECCAK256_ECDSA +} from "@lukso/lsp2-contracts/contracts/LSP2Constants.sol"; +``` diff --git a/packages/lsp20-contracts/README.md b/packages/lsp20-contracts/README.md index 50aa7079c..b046b3ec8 100755 --- a/packages/lsp20-contracts/README.md +++ b/packages/lsp20-contracts/README.md @@ -10,7 +10,9 @@ npm i @lukso/lsp20-contracts ## Available Constants & Types -The `@lukso/lsp20-contracts` npm package contains useful constants such as InterfaceIds, and specific constants related to the LSP20 Standard. You can import and access them as follow: +The `@lukso/lsp20-contracts` npm package contains useful constants such as interface IDs, and specific constants related to the LSP20 Standard. You can import and access them as follows. + +In Javascript. ```js import { @@ -19,3 +21,16 @@ import { INTERFACE_ID_LSP20CallVerification, } from "@lukso/lsp20-contracts"; ``` + +In Solidity. + + +```solidity +import { + _INTERFACEID_LSP20_CALL_VERIFICATION, + _INTERFACEID_LSP20_CALL_VERIFIER, + _LSP20_VERIFY_CALL_SUCCESS_VALUE_WITH_POST_VERIFICATION, + _LSP20_VERIFY_CALL_SUCCESS_VALUE_WITHOUT_POST_VERIFICATION, + _LSP20_VERIFY_CALL_RESULT_SUCCESS_VALUE +} from "@lukso/lsp20-contracts/contracts/LSP20Constants.sol"; +``` diff --git a/packages/lsp25-contracts/README.md b/packages/lsp25-contracts/README.md index b20052e0d..31293c99f 100644 --- a/packages/lsp25-contracts/README.md +++ b/packages/lsp25-contracts/README.md @@ -10,8 +10,20 @@ npm i @lukso/lsp25-contracts ## Available Constants & Types -The `@lukso/lsp25-contracts` npm package contains useful constants such as InterfaceIds, and specific constants related to the LSP25 Standard. You can import and access them as follow: +The `@lukso/lsp25-contracts` npm package contains useful constants such as interface IDs, and specific constants related to the LSP25 Standard. You can import and access them as follows. + +In Javascript. ```js import { LSP25_VERSION, INTERFACE_ID_LSP25 } from "@lukso/lsp25-contracts"; ``` + +In Solidity. + + +```solidity +import { + _INTERFACEID_LSP25, + LSP25_VERSION +} from "@lukso/lsp25-contracts/contracts/LSP25Constants.sol"; +``` diff --git a/packages/lsp26-contracts/README.md b/packages/lsp26-contracts/README.md index e0b819a1a..a053fa17e 100644 --- a/packages/lsp26-contracts/README.md +++ b/packages/lsp26-contracts/README.md @@ -10,8 +10,21 @@ npm i @lukso/lsp26-contracts ## Available Constants & Types -The `@lukso/lsp26-contracts` npm package contains useful constants such as interface IDs, and specific constants related to the LSP26 Standard. You can import and access them as follows: +The `@lukso/lsp26-contracts` npm package contains useful constants such as interface IDs, and specific constants related to the LSP26 Standard. You can import and access them as follows. + +In Javascript. ```js import { INTERFACE_ID_LSP26, LSP26_TYPE_IDS } from "@lukso/lsp26-contracts"; ``` + +In Solidity. + + +```solidity +import { + _INTERFACEID_LSP26, + _TYPEID_LSP26_FOLLOW, + _TYPEID_LSP26_UNFOLLOW +} from "@lukso/lsp26-contracts/contracts/LSP26Constants.sol"; +``` diff --git a/packages/lsp3-contracts/README.md b/packages/lsp3-contracts/README.md index e826b346c..627ad903f 100644 --- a/packages/lsp3-contracts/README.md +++ b/packages/lsp3-contracts/README.md @@ -10,7 +10,9 @@ npm install @lukso/lsp3-contracts ## Available Constants & Types -The `@lukso/lsp3-contracts` npm package contains useful constants such as ERC725Y data keys related to the LSP3 Standard. You can import and access them as follows: +The `@lukso/lsp3-contracts` npm package contains useful constants such as ERC725Y data keys related to the LSP3 Standard. You can import and access them as follows. + +In Javascript. ```js import { @@ -23,3 +25,14 @@ import { AssetMetadata, } from "@lukso/lsp3-contracts"; ``` + +In Solidity. + + +```solidity +import { + _LSP3_SUPPORTED_STANDARDS_KEY, + _LSP3_SUPPORTED_STANDARDS_VALUE, + _LSP3_PROFILE_KEY +} from "@lukso/lsp3-contracts/contracts/LSP3Constants.sol"; +``` diff --git a/packages/lsp4-contracts/README.md b/packages/lsp4-contracts/README.md index c7e81acef..9a57539f9 100644 --- a/packages/lsp4-contracts/README.md +++ b/packages/lsp4-contracts/README.md @@ -10,7 +10,9 @@ npm install @lukso/lsp4-contracts ## Available Constants & Types -The `@lukso/lsp4-contracts` npm package contains useful constants such as ERC725Y data keys related to the LSP4 Standard. You can import and access them as follows: +The `@lukso/lsp4-contracts` npm package contains useful constants such as ERC725Y data keys related to the LSP4 Standard. You can import and access them as follows. + +In Javascript. ```js import { @@ -25,3 +27,22 @@ import { AttributeMetadata, } from "@lukso/lsp4-contracts"; ``` + +In Solidity. + + +```solidity +import { + _LSP4_TOKEN_TYPE_TOKEN, + _LSP4_TOKEN_TYPE_NFT, + _LSP4_TOKEN_TYPE_COLLECTION, + _LSP4_SUPPORTED_STANDARDS_KEY, + _LSP4_SUPPORTED_STANDARDS_VALUE, + _LSP4_TOKEN_NAME_KEY, + _LSP4_TOKEN_SYMBOL_KEY, + _LSP4_TOKEN_TYPE_KEY, + _LSP4_CREATORS_ARRAY_KEY, + _LSP4_CREATORS_MAP_KEY_PREFIX, + _LSP4_METADATA_KEY +} from "@lukso/lsp4-contracts/contracts/LSP4Constants.sol"; +``` diff --git a/packages/lsp5-contracts/README.md b/packages/lsp5-contracts/README.md index 76ebe0ba2..0461e5616 100644 --- a/packages/lsp5-contracts/README.md +++ b/packages/lsp5-contracts/README.md @@ -10,8 +10,20 @@ npm install @lukso/lsp5-contracts ## Available Constants & Types -The `@lukso/lsp5-contracts` npm package contains useful constants such as ERC725Y Data Keys related to the LSP5 Standard. You can import and access them as follow: +The `@lukso/lsp5-contracts` npm package contains useful constants such as ERC725Y Data Keys related to the LSP5 Standard. You can import and access them as follows. + +In Javascript. ```js import { LSP5DataKeys } from "@lukso/lsp5-contracts"; ``` + +In Solidity. + + +```solidity +import { + _LSP5_RECEIVED_ASSETS_ARRAY_KEY, + _LSP5_RECEIVED_ASSETS_MAP_KEY_PREFIX +} from "@lukso/lsp5-contracts/contracts/LSP5Constants.sol"; +``` diff --git a/packages/lsp6-contracts/README.md b/packages/lsp6-contracts/README.md index 984d2e3a8..84b1002bd 100644 --- a/packages/lsp6-contracts/README.md +++ b/packages/lsp6-contracts/README.md @@ -10,7 +10,9 @@ npm install @lukso/lsp6-contracts ## Available Constants & Types -The `@lukso/lsp6-contracts` npm package contains useful constants such as InterfaceIds or ERC725Y Data Keys related to the LSP6 Standard. You can import and access them as follow: +The `@lukso/lsp6-contracts` npm package contains useful constants such as interface IDs or ERC725Y Data Keys related to the LSP6 Standard. You can import and access them as follows. + +In Javascript. ```js import { @@ -23,3 +25,14 @@ import { LSP6PermissionName, } from "@lukso/lsp6-contracts"; ``` + +In Solidity. + + +```solidity +import { + _INTERFACEID_ERC1271, + _ERC1271_SUCCESSVALUE, + _ERC1271_FAILVALUE +} from "@lukso/lsp6-contracts/contracts/constants.sol"; +``` diff --git a/packages/lsp7-contracts/README.md b/packages/lsp7-contracts/README.md index af3eb115b..273f08ee8 100644 --- a/packages/lsp7-contracts/README.md +++ b/packages/lsp7-contracts/README.md @@ -10,7 +10,9 @@ npm install @lukso/lsp7-contracts ## Available Constants & Types -The `@lukso/lsp7-contracts` npm package contains useful constants such as interface IDs or ERC725Y data keys related to the LSP7 Standard. You can import and access them as follows: +The `@lukso/lsp7-contracts` npm package contains useful constants such as interface IDs or ERC725Y data keys related to the LSP7 Standard. You can import and access them as follows. + +In Javascript. ```js import { @@ -20,6 +22,22 @@ import { } from "@lukso/lsp7-contracts"; ``` +In Solidity. + + +```solidity +import { + _INTERFACEID_LSP7, + _INTERFACEID_LSP7_V0_12_0, + _INTERFACEID_LSP7_V0_14_0, + _TYPEID_LSP7_DELEGATOR, + _TYPEID_LSP7_DELEGATEE, + _TYPEID_LSP7_TOKENSSENDER, + _TYPEID_LSP7_TOKENSRECIPIENT, + _TYPEID_LSP7_TOKENOPERATOR +} from "@lukso/lsp7-contracts/contracts/LSP7Constants.sol"; +``` + The `LSP7_TYPE_IDS` includes type IDs for the following type of notifications: ```console diff --git a/packages/lsp8-contracts/README.md b/packages/lsp8-contracts/README.md index 4c7bcefc1..874534871 100644 --- a/packages/lsp8-contracts/README.md +++ b/packages/lsp8-contracts/README.md @@ -10,7 +10,9 @@ npm install @lukso/lsp8-contracts ## Available Constants & Types -The `@lukso/lsp8-contracts` npm package contains useful constants such as interface IDs or ERC725Y data keys related to the LSP8 Standard. You can import and access them as follows: +The `@lukso/lsp8-contracts` npm package contains useful constants such as interface IDs or ERC725Y data keys related to the LSP8 Standard. You can import and access them as follows. + +In Javascript. ```js import { @@ -21,3 +23,30 @@ import { LSP8_TOKEN_ID_FORMAT, } from "@lukso/lsp8-contracts"; ``` + +In Solidity. + + +```solidity +import { + _INTERFACEID_LSP8, + _INTERFACEID_LSP8_V0_12_0, + _INTERFACEID_LSP8_V0_14_0, + _LSP8_TOKENID_FORMAT_KEY, + _LSP8_TOKEN_METADATA_BASE_URI, + _LSP8_REFERENCE_CONTRACT, + _TYPEID_LSP8_TOKENSSENDER, + _TYPEID_LSP8_TOKENSRECIPIENT, + _TYPEID_LSP8_TOKENOPERATOR, + _LSP8_TOKENID_FORMAT_NUMBER, + _LSP8_TOKENID_FORMAT_STRING, + _LSP8_TOKENID_FORMAT_ADDRESS, + _LSP8_TOKENID_FORMAT_UNIQUE_ID, + _LSP8_TOKENID_FORMAT_HASH, + _LSP8_TOKENID_FORMAT_MIXED_DEFAULT_NUMBER, + _LSP8_TOKENID_FORMAT_MIXED_DEFAULT_STRING, + _LSP8_TOKENID_FORMAT_MIXED_DEFAULT_ADDRESS, + _LSP8_TOKENID_FORMAT_MIXED_DEFAULT_UNIQUE_ID, + _LSP8_TOKENID_FORMAT_MIXED_DEFAULT_HASH +} from "@lukso/lsp8-contracts/contracts/LSP8Constants.sol"; +``` diff --git a/packages/lsp9-contracts/README.md b/packages/lsp9-contracts/README.md index 718a0d8b4..ed6ac06f4 100644 --- a/packages/lsp9-contracts/README.md +++ b/packages/lsp9-contracts/README.md @@ -10,7 +10,7 @@ npm install @lukso/lsp9-contracts ## Available Constants & Types -The `@lukso/lsp9-contracts` npm package contains useful constants such as InterfaceIds, ERC725Y Data Keys related to the LSP9 Standard. You can import and access them as follow: +The `@lukso/lsp9-contracts` npm package contains useful constants such as InterfaceIds, ERC725Y Data Keys related to the LSP9 Standard. You can import and access them as follows. ```js import { diff --git a/packages/universalprofile-contracts/README.md b/packages/universalprofile-contracts/README.md index 2edbd8386..ade1c7585 100644 --- a/packages/universalprofile-contracts/README.md +++ b/packages/universalprofile-contracts/README.md @@ -10,7 +10,7 @@ npm i @lukso/universalprofile-contracts ## Solidity constants -The constants related to LSP3 Profile Metadata can be directly imported from the `Constants.sol` file. +The constants related to LSP3 Profile Metadata can be directly imported from the Solidity `Constants.sol` file. ```solidity @@ -18,5 +18,5 @@ import { _LSP3_SUPPORTED_STANDARDS_KEY, _LSP3_SUPPORTED_STANDARDS_VALUE, _LSP3_PROFILE_KEY -} from "universalprofile/contracts/Constants.sol"; +} from "@lukso/universalprofile-contracts/contracts/Constants.sol"; ```