NoBey/openzeppelin-contracts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improved comments.

Browse Source
This commit is contained in:
Alberto Cuesta Cañada
2020-01-21 09:36:51 +00:00
parent bf335ca6eb
commit 580bbddb90
3 changed files with 17 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
contracts/mocks/EnumerableSetMock.sol
View File

@ -4,7 +4,7 @@ import "../utils/EnumerableSet.sol";
/**
* @title EnumerableSetMock
* @dev Data structure
* @dev Data structure - https://en.wikipedia.org/wiki/Set_(abstract_data_type)
* @author Alberto Cuesta Cañada
*/
contract EnumerableSetMock{

18
contracts/utils/EnumerableSet.sol
View File

@ -3,7 +3,15 @@ pragma solidity ^0.5.10;
/**
* @title EnumerableSet
* @dev Data structure
* @dev Data structure - https://en.wikipedia.org/wiki/Set_(abstract_data_type)
*
* EnumerableSet is a data structure that can contain an arbitrary number of unique addresses.
* The contents of the set can be retrieved as an array, but two separate calls to `enumerate`
* are not guaranteed to return values in the same order.
*
* Initialization of a set must include an empty array:
* `EnumerableSet.Set set = EnumerableSet.Set({values: new address[](0)});`
*
* @author Alberto Cuesta Cañada
*/
library EnumerableSet {
@ -19,7 +27,7 @@ library EnumerableSet {
}
/**
* @dev Add a value.
* @dev Add a value. O(1).
*/
function add(Set storage set, address value)
internal
@ -31,7 +39,7 @@ library EnumerableSet {
}
/**
* @dev Remove a value.
* @dev Remove a value. O(1).
*/
function remove(Set storage set, address value)
internal
@ -45,7 +53,7 @@ library EnumerableSet {
}
/**
* @dev Returns true if the value is in the set.
* @dev Returns true if the value is in the set. O(1).
*/
function contains(Set storage set, address value)
internal
@ -56,7 +64,7 @@ library EnumerableSet {
}
/**
* @dev Return an array with all values in the set.
* @dev Return an array with all values in the set. O(N).
*/
function enumerate(Set storage set)
internal

6
test/utils/EnumerableSet.test.js
View File

@ -18,7 +18,7 @@ describe('EnumerableSet', function () {
expect(await this.set.testContains(a)).to.equal(false);
});
it('adds an value.', async function () {
it('adds a value.', async function () {
await this.set.testAdd(a);
expect(await this.set.testContains(a)).to.equal(true);
});
@ -37,11 +37,11 @@ describe('EnumerableSet', function () {
expect(await this.set.testContains(a)).to.equal(false);
});
it('Retrieve an empty array', async function () {
it('enumerates values as an empty array', async function () {
expect(await this.set.testEnumerate()).to.eql([]);
});
it('Retrieve an array of values', async function () {
it('enumerates an array of values', async function () {
await this.set.testAdd(a);
await this.set.testAdd(b);
await this.set.testAdd(c);