@lukso/lsp-smart-contracts

LSP Smart Contracts ·

The smart contracts reference implementation of the LUKSO Standard Proposals (LSPs).

For more information see Documentation on docs.lukso.tech.

:warning:	This package is currently in early stages of development, use for testing or experimentation purposes only.

Installation

npm

LSP smart contracts are available as a npm package.

npm install @lukso/lsp-smart-contracts

cloning the repository

Alternatively you can also clone the repository and install its dependencies to start using the smart contracts.

$ git clone https://github.com/lukso-network/lsp-smart-contracts.git
$ cd ./lsp-smart-contracts
$ npm install

Usage

in Javascript

You can use the contracts JSON ABI by importing them as follow:

import LSP0ERC725Account from "@lukso/lsp-smart-contracts/artifacts/LSP0ERC725Account.json";

const myContract = new web3.eth.Contract(
  LSP0ERC725Account.abi,
  "",
  defaultOptions
);

in Solidity

import "@lukso/lsp-smart-contracts/contracts/LSP0ERC725Account/LSP0ERC725Account.sol";

contract MyAccount is LSP0ERC725Account {
  constructor(address _newOwner) LSP0ERC725Account(_newOwner) {}
}

Deployment via hardhat

You can find more infos on how to deploy the contracts via hardhat in the DEPLOYMENT page.

Available Constants & Types

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

import {
  INTERFACE_IDS,
  ERC1271,
  OPERATIONS,
  SupportedStandards,
  ERC725YDataKeys,
  PERMISSIONS,
  ALL_PERMISSIONS,
  ErrorSelectors,
  EventSigHashes,
  FunctionSelectors,
  ContractsDocs,
  StateVariables,
} from "@lukso/lsp-smart-contracts";

Note: we also export it as @lukso/lsp-smart-contracts/constants or @lukso/lsp-smart-contracts/constants.js to keep it backward compatible.

It also includes constant values Array data keys to retrieve both the array length and for index access.

'LSP5ReceivedAssets[]': {
    length: '0x6460ee3c0aac563ccbf76d6e1d07bada78e3a9514e6382b736ed3f478ab7b90b',
    index: '0x6460ee3c0aac563ccbf76d6e1d07bada',
},

Typescript types

The following additional typescript types are also available.

import {
  LSP2ArrayKey,
  LSPSupportedStandard,
  LSP6PermissionName,
  LSPErrorInfo,
} from "@lukso/lsp-smart-contracts/constants";

Audits

NB: dates of the audit reports use the american date format YYYY-MM-DD.

The following audits and formal verification were conducted. All high-level issues were addressed, or were not deemed as critical.

• Chainsulting Audit, 2022-07-06, Final Result: Chainsulting_audit_06_07_2022.pdf
• Quantstamp Audit, 2022-09-07, Final Result: Quantstamp_audit_07_09_2022.pdf
• Watchpug Audit, 2022-10-20, Final Result: Watchpug_audit_20_10_2022.pdf
• Watchpug Audit, 2022-12-15, Final Result: Watchpug_audit_15_12_2022.pdf
• Runtime Verification - Formal Verification, 2023-02-20, Final Result: RuntimeVerification_formalVerification_2023_02_20.pdf
• Trust Audit, 2023-04-13, Final Result: Trust_audit_2023_04_13.pdf
• Watchpug Audit, 2023-04-21, Final Result: Watchpug_audit_2023_04_21.pdf

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Jean Cvllr 💻	Yamen Merhi 💻	Fabian Vogelsteller 💻	b00ste.lyx 💻	Matthew Stevens 💻	Reto Ryter 🔧 🚇	Callum Grindle 👀
Skima Harvey 💻	Jenea Vranceanu 💻	Hugo Masclet 👀 💻	Leondroid 👀	lucasmt 🐛	qian-hu 🛡️ 🐛	Magali Morin 💻
Hugo Montenegro 📖	Volodymyr Lykhonis 💻	Prosperity 📖	Michael Standen 💻
Add your contributions

This project follows the all-contributors specification. Contributions of any kind welcome!