Skip to content

Commit

Permalink
chore: Add constants section in readme to each package
Browse files Browse the repository at this point in the history
  • Loading branch information
YamenMerhi committed Apr 5, 2024
1 parent fb9fd88 commit 7117d3b
Show file tree
Hide file tree
Showing 19 changed files with 168 additions and 0 deletions.
17 changes: 17 additions & 0 deletions packages/lsp-smart-contracts/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
# `@lukso/lsp-smart-contracts`

Package for the LSP Smart Contracts.

## Available Constants & Types

The `@lukso/lsp-smart-contracts` npm package contains useful constants such as InterfaceIds, and ERC725Y Data Keys related to the LSP Standards. You can import and access them as follow:

```js
import {
INTERFACE_IDS,
LSP8_TOKEN_ID_FORMAT,
OPERATIONS,
SupportedStandards,
ERC725YDataKeys,
INTERFACE_ID_LSP1DELEGATE,
LSP6DataKeys,
LSP25_VERSION,
} from "@lukso/lsp-smart-contracts";
```
8 changes: 8 additions & 0 deletions packages/lsp0-contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,11 @@ Package for the LSP0 ERC725Account standard.
```bash
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:

```js
import { INTERFACE_ID_LSP0, OPERATION_TYPES } from "@lukso/lsp0-contracts";
```
8 changes: 8 additions & 0 deletions packages/lsp1-contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,11 @@ Package for the LSP1 Universal Receiver standard.
```bash
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:

```js
import { INTERFACE_ID_LSP1, LSP1DataKeys } from "@lukso/lsp1-contracts";
```
8 changes: 8 additions & 0 deletions packages/lsp10-contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,11 @@ Package for the LSP10 Received Vaults standard.
```bash
npm install @lukso/lsp10-contracts
```

## Available Constants & Types

The `@lukso/lsp10-contracts` npm package contains useful constants such as ERC725Y Data Keys related to the LSP10 Standard. You can import and access them as follow:

```js
import { LSP10DataKeys } from "@lukso/lsp10-contracts";
```
8 changes: 8 additions & 0 deletions packages/lsp12-contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,11 @@ Package for the LSP12 Issued Assets standard.
```bash
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:

```js
import { LSP12DataKeys } from "@lukso/lsp12-contracts";
```
8 changes: 8 additions & 0 deletions packages/lsp14-contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,11 @@ Package for the LSP14 Ownable 2 Step standard.
```bash
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:

```js
import { LSP14_TYPE_IDS, INTERFACE_ID_LSP14 } from "@lukso/lsp14-contracts";
```
8 changes: 8 additions & 0 deletions packages/lsp17-contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,11 @@ Package for the LSP17 Extensions, that includes the following extensions:
```bash
npm install @lukso/lsp17-contracts
```

## Available Constants & Types

The `@lukso/lsp17-contracts` npm package contains useful constants such as InterfaceIds related to the LSP17 Extensions. You can import and access them as follow:

```js
import { INTERFACE_ID_LSP17Extension } from "@lukso/lsp17-contracts";
```
11 changes: 11 additions & 0 deletions packages/lsp17contractextension-contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,14 @@ Package for the LSP17 Contract Extension
```bash
npm install @lukso/lsp17contractextension-contracts
```

## Available Constants & Types

The `@lukso/lsp17contractextension-contracts` npm package contains useful constants such as InterfaceIds, and ERC725Y Data Keys related to the LSP17 Standard. You can import and access them as follow:

```js
import {
INTERFACE_ID_LSP17Extendable,
LSP17DataKeys,
} from "@lukso/lsp17contractextension-contracts";
```
8 changes: 8 additions & 0 deletions packages/lsp1delegate-contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,11 @@ Currently there are Universal Receiver Delegate contracts for:
```bash
npm install @lukso/lsp1delegate-contracts
```

## Available Constants & Types

The `@lukso/lsp1delegate-contracts` npm package contains useful constants such as InterfaceIds related to the LSP1Delegate Standard. You can import and access them as follow:

```js
import { INTERFACE_ID_LSP1DELEGATE } from "@lukso/lsp1delegate-contracts";
```
8 changes: 8 additions & 0 deletions packages/lsp2-contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,11 @@ Package for the LSP2 ERC725Y JSON Schema standard.
```bash
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:

```js
import { LSP2ArrayKey, Verification } from "@lukso/lsp2-contracts";
```
12 changes: 12 additions & 0 deletions packages/lsp20-contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,15 @@ Package for the LSP20 Call Verification standard.
```bash
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:

```js
import {
LSP20_SUCCESS_VALUES,
INTERFACE_ID_LSP20CallVerifier,
INTERFACE_ID_LSP20CallVerification,
} from "@lukso/lsp20-contracts";
```
8 changes: 8 additions & 0 deletions packages/lsp25-contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,11 @@ Package for the LSP25 Execute Relay Call standard.
```bash
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:

```js
import { LSP25_VERSION, INTERFACE_ID_LSP25 } from "@lukso/lsp25-contracts";
```
8 changes: 8 additions & 0 deletions packages/lsp3-contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,11 @@ Package for the LSP3 Profile Metadata standard.
```bash
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 follow:

```js
import { LSP3DataKeys, LSP3SupportedStandard } from "@lukso/lsp3-contracts";
```
8 changes: 8 additions & 0 deletions packages/lsp4-contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,11 @@ Package for the LSP4 Digital Asset Metadata standard.
```bash
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 follow:

```js
import { LSP4_TOKEN_TYPES, LSP4DataKeys } from "@lukso/lsp4-contracts";
```
8 changes: 8 additions & 0 deletions packages/lsp5-contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,11 @@ Package for the LSP5 Received Assets standard.
```bash
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:

```js
import { LSP5DataKeys } from "@lukso/lsp5-contracts";
```
8 changes: 8 additions & 0 deletions packages/lsp6-contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,11 @@ Package for the LSP6 Key Manager standard, to enable granting multiple permissio
```bash
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:

```js
import { INTERFACE_ID_LSP6, LSP6DataKeys } from "@lukso/lsp6-contracts";
```
8 changes: 8 additions & 0 deletions packages/lsp7-contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,11 @@ Package for the LSP7 Digital Asset standard.
```bash
npm install @lukso/lsp7-contracts
```

## Available Constants & Types

The `@lukso/lsp7-contracts` npm package contains useful constants such as InterfaceIds or ERC725Y Data Keys related to the LSP7 Standard. You can import and access them as follow:

```js
import { INTERFACE_ID_LSP7, LSP7_TYPE_IDS } from "@lukso/lsp7-contracts";
```
8 changes: 8 additions & 0 deletions packages/lsp8-contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,11 @@ Package for the LSP8 Identifiable Digital Asset Standard.
```bash
npm install @lukso/lsp8-contracts
```

## Available Constants & Types

The `@lukso/lsp8-contracts` npm package contains useful constants such as InterfaceIds or ERC725Y Data Keys related to the LSP8 Standard. You can import and access them as follow:

```js
import { INTERFACE_ID_LSP8, LSP8_TOKEN_ID_FORMAT } from "@lukso/lsp8-contracts";
```
8 changes: 8 additions & 0 deletions packages/lsp9-contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,11 @@ Package for the LSP9 Vault standard.
```bash
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:

```js
import { OPERATION_TYPES, INTERFACE_ID_LSP9 } from "@lukso/lsp9-contracts";
```

0 comments on commit 7117d3b

Please sign in to comment.