https://github.com/vittominacori/solidity-linked-list

An utility library for working with sorted linked list data structures in your Solidity project.
https://github.com/vittominacori/solidity-linked-list

ethereum linked-list smart-contracts solidity truffle-framework

Last synced: 4 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/vittominacori/solidity-linked-list
• Owner: vittominacori
• License: mit
• Created: 2018-10-18T15:31:04.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-10-21T18:18:04.000Z (26 days ago)
• Last Synced: 2024-10-30T04:55:34.585Z (17 days ago)
• Topics: ethereum, linked-list, smart-contracts, solidity, truffle-framework
• Language: JavaScript
• Homepage: https://vittominacori.github.io/solidity-linked-list/
• Size: 4.81 MB
• Stars: 71
• Watchers: 3
• Forks: 19
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Solidity Linked List

[![NPM Package](https://img.shields.io/npm/v/solidity-linked-list.svg?style=flat-square)](https://www.npmjs.org/package/solidity-linked-list)

[![CI](https://github.com/vittominacori/solidity-linked-list/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/vittominacori/solidity-linked-list/actions/workflows/ci.yml)

[![Coverage Status](https://codecov.io/gh/vittominacori/solidity-linked-list/graph/badge.svg)](https://codecov.io/gh/vittominacori/solidity-linked-list)

[![MIT licensed](https://img.shields.io/github/license/vittominacori/solidity-linked-list.svg)](https://github.com/vittominacori/solidity-linked-list/blob/master/LICENSE)

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

## Install

```bash

npm install solidity-linked-list

```

## Usage

```solidity

pragma solidity ^0.8.0;

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

contract MyContract {

    using StructuredLinkedList for StructuredLinkedList.List;

    StructuredLinkedList.List list;

    // your stuff

}

```

## Code

* [StructuredLinkedList.sol](https://github.com/vittominacori/solidity-linked-list/blob/master/contracts/StructuredLinkedList.sol)

## Documentation

* [Solidity API](https://github.com/vittominacori/solidity-linked-list/blob/master/docs/index.md)

## Code Analysis

* [Control Flow](https://github.com/vittominacori/solidity-linked-list/tree/master/analysis/control-flow)

* [Description Table](https://github.com/vittominacori/solidity-linked-list/tree/master/analysis/description-table)

* [Inheritance Tree](https://github.com/vittominacori/solidity-linked-list/tree/master/analysis/inheritance-tree)

* [UML](https://github.com/vittominacori/solidity-linked-list/tree/master/analysis/uml)

## 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](https://github.com/vittominacori/solidity-linked-list/blob/master/LICENSE).