Skip to content

Update natspec for AddressArray #191

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions contracts/libraries/AddressArray.sol
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ pragma solidity ^0.8.0;

/**
* @title AddressArray
* @notice Implements a dynamic array of addresses using a mapping for storage efficiency, with the array length stored at index 0.
* @notice Implements a storage-efficient dynamic array of addresses, with the length encoded in the first storage slot.
* @dev This library provides basic functionalities such as push, pop, set, and retrieval of addresses in a storage-efficient manner.
*/
library AddressArray {
Expand All @@ -30,7 +30,7 @@ library AddressArray {
uint256 internal constant _LENGTH_OFFSET = 160;

/**
* @dev Struct containing the raw mapping used to store the addresses and the array length.
* @dev Internal address array where the first element encodes both the length and the first address value.
*/
struct Data {
uint256[1 << 32] _raw;
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@1inch/solidity-utils",
"version": "6.6.0",
"version": "6.6.1",
"main": "dist/src/index.js",
"types": "dist/src/index.d.ts",
"exports": {
Expand Down
Loading