Have ideas to improve npm?Join in the discussion! »

ethereum-libraries-array-utils

1.2.1 • Public • Published

Array Utility Libraries

Build Status Discord

An array utility library provided by Modular .

Note: Each uint array type now has its own library. If your storage array contains uint16[] types, for instance, then you would link to the Array16Lib.sol library. This README uses the Array256Lib for all examples.

Library Addresses

Array256Lib

Main Ethereum Network: 0xE258E2Ed46163eB08977ADE5A935079AFF1B2053
Rinkeby Test Network: 0xbe977ea7aae183528c1e3d4950ba95cfd867c1ad

Array128Lib

Main Ethereum Network: 0xCD52b34a42E8302050e8Df012E286493e371196B
Rinkeby Test Network: 0x523ca3cf413fda367c7c77287806a2dde7c39b3c

Array64Lib

Main Ethereum Network: 0x0a58508723737061B5b464dCF0E840F760c50db9
Rinkeby Test Network: 0xdce9e7b82e2bc35fb383d76644402da1d4dc6518

Array32Lib

Main Ethereum Network: 0x5c8bc089E0B5D7Acc066020872F5968708f25BF3
Rinkeby Test Network: 0xfa8b2630ffcc0f755aac19c4fbc32fa40957d4fa

Array16Lib

Main Ethereum Network: 0xB7B005615878EdeE1D7d9C3eaBD19f57120C9982
Rinkeby Test Network: 0xde89c9f106979ec20d6ed2d21ca6b214eaad4580

Array8Lib

Main Ethereum Network: 0x63cD1d8D592742F2157513B5e4510d46CA3F1376
Rinkeby Test Network: 0x7811ffaecf8fa90a6dde2dba97c5f5388db5f22c

License and Warranty

Be advised that while we strive to provide professional grade, tested code we cannot guarantee its fitness for your application. This is released under The MIT License (MIT) and as such we will not be held liable for lost funds, etc. Please use your best judgment and note the following:

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Installation and Usage

How to install

npm install ethereum-libraries-array-utils

How to link

This process will allow you to both link your contract to the current on-chain library as well as deploy it in your local environment for development.

Amend the deployment .js file in your truffle migrations/ directory as follows:

var Array256Lib = artifacts.require("ethereum-libraries-array-utils/build/contracts/Array256Lib.json");
var OtherLibs = artifacts.require("./OtherLibs.sol");
var YourOtherContract = artifacts.require("./YourOtherContract.sol");
...
 
module.exports = function(deployer) {
  deployer.deploy(Array256Lib, {overwrite: false});
  deployer.link(Array256Lib, YourOtherContract);
  deployer.deploy(YourOtherContract);
};

Note: The .link() function should be called before you .deploy(YourOtherContract). Also, be sure to include the {overwrite: false} when writing the deployer i.e. .deploy(Array256Lib, {overwrite: false}). This prevents deploying the library onto the main network or Rinkeby test network at your cost and uses the library already on the blockchain. The function should still be called however because it allows you to use it in your development environment. See below

Testing

Test: npm run test

Test Coverage: npm run test:coverage

solc Installation

version 0.4.21

For direction and instructions on how the Solidity command line compiler works see the documentation.

With standard JSON input

The Standard JSON Input provides an easy interface to include libraries. Include the following as part of your JSON input file:

{
  "language": "Solidity",
  "sources":
  {
    "YourContract.sol": {
      ...
      ...
    },
    "Array256Lib.sol": {
      "content": "[Contents of Array256Lib.sol]"
    }
  },
  "settings":
  {
    ...
    "libraries": {
      "YourContract.sol": {
        "Array256Lib": "0xE258E2Ed46163eB08977ADE5A935079AFF1B2053"
      }
    }
  }
}

Note: The library name should match the name used in your contract.

solc without standard JSON input

When creating unlinked binary, the compiler currently leaves special substrings in the compiled bytecode in the form of 'LibraryName____' which leaves a 20 byte space for the library's address. In order to include the deployed library in your bytecode add the following flag to your command:

--libraries "Array256Lib:0xE258E2Ed46163eB08977ADE5A935079AFF1B2053"

Additionally, if you have multiple libraries, you can create a file with one library string per line and include this library as follows:

"Array256Lib:0xE258E2Ed46163eB08977ADE5A935079AFF1B2053"

then add the following flag to your command:

--libraries filename

Finally, if you have an unlinked binary already stored with the 'LibraryName____' placeholder, you can run the compiler with the --link flag and also include the following flag:

--libraries "Array256Lib:0xE258E2Ed46163eB08977ADE5A935079AFF1B2053"

solc documentation

See the solc documentation for further information.

solc-js Installation

version 0.4.21

Solc-js provides javascript bindings for the Solidity compiler and can be found here. Please refer to their documentation for detailed use.

This version of Solc-js also uses the standard JSON input to compile a contract. The entry function is compileStandardWrapper() and you can create a standard JSON object explained under the solc section and incorporate it as follows:

var solc = require('solc');
var fs = require('fs');
 
var file = fs.readFileSync('/path/to/YourContract.sol','utf8');
var lib = fs.readFileSync('./path/to/Array256Lib.sol','utf8');
 
var input = {
  "language": "Solidity",
  "sources":
  {
    "YourContract.sol": {
      "content": file
    },
    "Array256Lib.sol": {
      "content": lib
    }
  },
  "settings":
  {
    ...
    "libraries": {
      "YourContract.sol": {
        "Array256Lib": "0xE258E2Ed46163eB08977ADE5A935079AFF1B2053"
      }
    }
    ...
  }
}
 
var output = JSON.parse(solc.compileStandardWrapper(JSON.stringify(input)));
 
//Where the output variable is a standard JSON output object.

Solc-js Installation via Linking

Solc-js also provides a linking method if you have compiled binary code already with the placeholder. To link this library the call would be:

bytecode = solc.linkBytecode(bytecode, { 'Array256Lib': '0xE258E2Ed46163eB08977ADE5A935079AFF1B2053' });

Solc-js documentation

See the Solc-js documentation for further information.

Overview

Basic Usage

Disclaimer: While we make every effort to produce professional grade code we can not guarantee the security and performance of these libraries in your smart contracts. Please use good judgement and security practices while developing, we do not take responsibility for any issues you, your customers, or your applications encounter when using these open source resources.

For a detailed explanation on how libraries are used please read the following from the Solidity documentation:

The Array Utility libraries provide several utility functions for contracts that contain storage arrays. Each library handles the specified uint type and either returns the uint value or, in the case of heapSort, sorts the given array in place which helps to reduce gas costs because of low memory usage.

When using the indexOf function be sure to provide a return tuple and check to ensure the value was found in the array. The function will return 0 as the index if the value was not found. See the usage example below.

Usage Example

pragma solidity ^0.4.21;

import "example-libraries-array-utils/contracts/Array256Lib.sol";

contract YourContract {
  using Array256Lib for uint256[];

  uint256[] array;

  //Then in your function you can call array.function([second argument])
  //Your arguments should be of the same type you bound the library to
  function getSortedIndexOf() returns (bool,uint256){
    bool found;
    uint256 index;
    //The first value in the arguments is the value we're searching for and true
    //indicates the array is sorted
    (found,index) = array.indexOf(7,true);

    //found will now be true if 7 is in the array and index will be the index of 7
  }

  function sortMyStorageArray(){
    array.heapSort();

    //Your array is now sorted
  }
}

Binding the library allows you to call the function in the format array.function(otherParameter)

Usage Note

All of the functions only accept storage arrays containing the appropriate uint type.

Functions

The following is the list of functions available to use in your smart contract.

sumElements(uint256[] storage) public view returns(uint256)

(Array256Lib.sol, line 35)

Returns the sum of the array elements

Arguments

uint256[] storage variable self

Returns

uint256 sum

getMax(uint256[] storage) public view returns(uint256)

(Array256Lib.sol, line 48)

Returns the maximum value in the given array.

Arguments

uint256[] storage self

Returns

uint256 maxValue

getMin(uint256[] storage) public view returns(uint256)

(Array256Lib.sol, line 65)

Returns the minimum value in the given array.

Arguments

uint256[] storage self

Returns

uint256 minValue

indexOf(uint256[] storage, uint256, bool) public view returns(bool, uint256)

(Array256Lib.sol, line 85)

Returns true and the index of the given value if found or false and 0 otherwise

Arguments

uint256[] storage self
uint256 value
bool isSorted

Returns

bool found
uint256 index

heapSort(uint256[] storage self) public

(ArrayUtilsLib.sol, line 147)

Sorts the given array.

Arguments

uint256[] storage self

uniq(uint256[] storage) public returns (uint256)

(Array256Lib.sol, line 211)

Removes duplicates from a given array.

Arguments

uint256[] storage self

Returns

uint256 length

Install

npm i ethereum-libraries-array-utils

DownloadsWeekly Downloads

3

Version

1.2.1

License

MIT

Unpacked Size

4.8 MB

Total Files

26

Last publish

Collaborators

  • avatar