Solidity Linked List

Appearance

Solidity Linked List ​

NPM PackageCICoverage StatusMIT licensed

An utility library for working with sorted linked list data structures in your Solidity project.

Installation ​

Hardhat ​

bash
npm install solidity-linked-list

Foundry ​

bash
forge install vittominacori/solidity-linked-list

Add the below in remappings.txt:

bash
solidity-linked-list/contracts/=lib/solidity-linked-list/contracts/

Usage ​

solidity
pragma solidity ^0.8.20;

import {StructuredLinkedList} from "solidity-linked-list/contracts/StructuredLinkedList.sol";

contract MyContract {
    using StructuredLinkedList for StructuredLinkedList.List;

    StructuredLinkedList.List list;

    // your stuff
}

Code ​

Documentation ​

Code Analysis ​

Development ​

Install dependencies ​

bash
npm install

Compile ​

bash
npm run compile

Test ​

bash
npm test

Code Coverage ​

bash
npm run coverage

Linter ​

Check Solidity files

bash
npm run lint:sol

Check JS/TS files

bash
npm run lint:js

Fix JS and Solidity files

bash
npm run lint:fix

License ​

Code released under the MIT License.