Solidity Linked List

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

Installation

Hardhat

npm install solidity-linked-list

Foundry

forge install vittominacori/solidity-linked-list

Add the below in remappings.txt:

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

Usage

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

• StructuredLinkedList.sol

Documentation

• Solidity API

Code Analysis

• Control Flow
• Description Table
• Inheritance Tree
• UML

Development

Install dependencies

npm install

Compile

npm run compile

Test

npm test

Code Coverage

npm run coverage

Linter

Check Solidity files

npm run lint:sol

Check JS/TS files

npm run lint:js

Fix JS and Solidity files

npm run lint:fix

License

Code released under the MIT License.