A collection of common data structures implemented in Solidity, organized and tested using Truffle Suite.
The motivation of this project is to provide secure, optimized, extensible data structures for use in smart contract systems. Where possible, the data structures have been implemented with different underlying storage mechanisms (dynamically sized array, mapping, etc.) to showcase various implementation strategies.
This project is in active development. Data structures must pass a comprehensive test suite to be considered 'completed'.
Completed:
- StackMapping.sol: Stack backed by a mapping.
- StackArray.sol: Stack backed by a dynamically sized array.
- QueueMapping.sol: Queue backed by a mapping.
In development:
- QueueArray.sol: Queue backed by a dynamically sized array.
- HashMap.sol: Mapping structure supporting key iteration.
- LinkedList.sol: Native implementation.
- DoublyLinkedList.sol: Doubly Linked List backed by a dynamically sized array.
- CircularLinkedList.sol: Native implementation.
Future work:
- BinarySearchTree.sol
- RedBlackTree.sol
- Minimum Heap.sol
- Maximum Heap.sol
- GraphAdjList.sol: Graph backed by an adjacency list.
- As high gas costs can be incurred when iterating over collections of elements, care has been taken to minimize item iteration where possible.
- Due to privacy concerns and in accordance with OOD principles, only the core functionality is exposed while underlying mechanisms are hidden through the use of
privateandinternalmodifiers.
Each data structure is accompanied by an associated test suite. To run the tests, follow these steps:
- Install packages:
npm install - Start the truffle environment:
truffle develop - In another tab, run tests:
truffle test
WARNING: These contracts have not undergone an external audit, use them at your own risk.
The author welcomes pull requests, feature requests, testing assistance and feedback.
This project is licensed under the MIT License.