Skip to main content

⚙️ Set Helper

Introduction​

The Set Helper library provides functions for working with OpenZeppelin's Enumerable Sets. The library promotes clean code practices by offering several functions to add or remove subsets from sets, thereby enhancing readability and maintainability

Functions​

To use the SetHelper library, you need to import it.

import "@solarity/solidity-lib/libs/arrays/SetHelper.sol";

And optionally bind it to the type with the using statement.

using SetHelper for *;

add​

function add(
    EnumerableSet.AddressSet storage set, 
    address[] memory array_
) internal;
function add(
    EnumerableSet.UintSet storage set, 
    uint256[] memory array_
) internal;
function add(
    EnumerableSet.Bytes32Set storage set, 
    bytes32[] memory array_
) internal;
function add(
    StringSet.Set storage set, 
    string[] memory array_
) internal;

Description​

This function adds the provided array_ to the provided set. Parameter set is always a storage array, whereas array_ is a memory array.

Time complexity​

Linear.

Example​

EnumerableSet.UintSet public nums;
nums.add(1); 
nums.add(2); 

uint256[] memory arr_ = new uint256[](2);
arr_[0] = 3; 
arr_[1] = 4;

nums.add(arr_); // [1, 2, 3, 4]

strictAdd​

function strictAdd(
    EnumerableSet.AddressSet storage set, 
    address[] memory array_
) internal;
function strictAdd(
    EnumerableSet.UintSet storage set, 
    uint256[] memory array_
) internal;
function strictAdd(
    EnumerableSet.Bytes32Set storage set, 
    bytes32[] memory array_
) internal;
function strictAdd(
    StringSet.Set storage set, 
    string[] memory array_
) internal;

Description​

This function strictly adds the provided array_ to the provided set. Parameter set is always a storage array, whereas array_ is a memory array. Reverts if elements duplicate.

Time complexity​

Linear.

Example​

EnumerableSet.UintSet public nums;
nums.add(1); 
nums.add(2); 

uint256[] memory arr_ = new uint256[](2);
arr_[0] = 3; 
arr_[1] = 4;

nums.add(arr_); // [1, 2, 3, 4]
nums.add(arr_); // Reverts with: "SetHelper: element already exists"

remove​

function remove(
    EnumerableSet.AddressSet storage set, 
    address[] memory array_
) internal;
function remove(
    EnumerableSet.UintSet storage set, 
    uint256[] memory array_
) internal;
function remove(
    EnumerableSet.Bytes32Set storage set, 
    bytes32[] memory array_
) internal;
function remove(
    StringSet.Set storage set, 
    string[] memory array_
) internal;

Description​

This function removes the provided array_ from the provided set. Parameter set is always a storage array, whereas array_ is a memory array.

Time complexity​

Linear.

Example​

EnumerableSet.UintSet public nums;
nums.add(1); 
nums.add(2); 
nums.add(3); 
nums.add(4);

uint256[] memory arr_ = new uint256[](4);
arr_[0] = 1; 
arr_[1] = 3; 
arr_[2] = 3; 
arr_[3] = 10;

nums.remove(arr_); // [2, 4]

strictRemove​

function strictRemove(
    EnumerableSet.AddressSet storage set, 
    address[] memory array_
) internal;
function strictRemove(
    EnumerableSet.UintSet storage set, 
    uint256[] memory array_
) internal;
function strictRemove(
    EnumerableSet.Bytes32Set storage set, 
    bytes32[] memory array_
) internal;
function strictRemove(
    StringSet.Set storage set, 
    string[] memory array_
) internal;

Description​

This function strictly removes the provided array_ from the provided set. Parameter set is always a storage array, whereas array_ is a memory array. Reverts if set doesn't contain provided elements.

Time complexity​

Linear.

Example​

EnumerableSet.UintSet public nums;
nums.add(1); 
nums.add(2); 
nums.add(3); 
nums.add(4);

uint256[] memory arr_ = new uint256[](4);
arr_[0] = 1; 
arr_[1] = 3;

nums.remove(arr_); // [2, 4]
nums.remove(arr_); // Reverts with: "SetHelper: no such element"