Merge pull request #198 from skalenetwork/beta

1.0.1

.github/CODEOWNERS

@@ -1,2 +1,3 @@
 * @dmytronazarenko @kladkogex
-*.md @cstrangedk
+/docs/ @skalenetwork/docowners
+*.md @skalenetwork/docowners

.github/workflows/publish.yml

@@ -16,7 +16,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
         with:
-          node-version: '12.x'
+          node-version: '14.x'
           registry-url: 'https://registry.npmjs.org'
       - name: Install dependencies
         run: |

.github/workflows/test.yml

@@ -7,13 +7,13 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        node: [10, 12, 14]
+        node: [12, 14, 16]
         os: [ubuntu-latest, windows-latest]
     env:
+      VERSION: 3.9.1-develop.4
       ENDPOINT: ${{ secrets.ENDPOINT }}
       USER: ${{ secrets.USER }}
       SCHEME: ${{ secrets.SCHEME }}
-      VERSION: ${{ secrets.VERSION }}
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
       SCHAIN_OWNER_PK: ${{ secrets.SCHAIN_OWNER_PK }}
       PRIVATEKEY: ${{ secrets.PRIVATEKEY }}
@@ -24,6 +24,12 @@ jobs:
       uses: actions/setup-node@v1
       with:
         node-version: ${{ matrix.node }}
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.8
+
     - name: Install dependencies
       run: |
         npm i

.gitignore

@@ -7,6 +7,7 @@ artifacts.json
 
 # Dependency directories
 node_modules/
+venv/
 
 # Idea files
 .idea/
@@ -15,3 +16,4 @@ node_modules/
 .eslintcache
 .nyc_output
 coverage
+

README.md

@@ -253,27 +253,119 @@ Content `Object` for directory contains:
 
 Reserve space for certain address in Filestorage in bytes.
 
--   **Note**: could be called only by sChain owner
+-   **Note**: can be called only by ALLOCATOR_ROLE (or schain owner in v1 chains)
 
 ```javascript
-filestorage.reserveSpace(ownerAddress, addressToReserve, reservedSpace, privateKey);
+filestorage.reserveSpace(allocatorAddress, addressToReserve, reservedSpace, privateKey);
 ```
 
-Create directory using external signing (Metamask etc):
+Reserve space using external signing (Metamask etc):
 
 ```javascript
-filestorage.reserveSpace(ownerAddress, addressToReserve, reservedSpace);
+filestorage.reserveSpace(allocatorAddress, addressToReserve, reservedSpace);
 ```
 
 ##### Parameters
 
 | Parameter                 | Description                                                 |
 | ------------------------- | ----------------------------------------------------------- |
-| `String` ownerAddress     | sChain owner address                                        |
+| `String` allocatorAddress | Address with ALLOCATOR_ROLE                                 |
 | `String` addressToReserve | Address to reserve space for                                |
 | `String` reservedSpace    | Reserved space in bytes                                     |
 | `String` privateKey       | _(optional)_ sChain owner private key, to sign transactions |
 
+#### Grant allocator role
+
+Granting allocator role to be able to reserve space in Filestorage
+
+-   **Note**: can be called only by ADMIN_ROLE (on v2+ chains)
+
+```javascript
+filestorage.grantAllocatorRole(adminAddress, allocatorAddress, adminPrivateKey);
+```
+
+Grant allocator role using external signing (Metamask etc):
+
+```javascript
+filestorage.grantAllocatorRole(adminAddress, allocatorAddress, adminPrivateKey);
+```
+
+##### Parameters
+
+| Parameter                 | Description                                                 |
+| ------------------------- | ----------------------------------------------------------- |
+| `String` adminAddress     | DEFAULT_ADMIN address                                       |
+| `String` allocatorAddress | Address to grant role for                                   |
+| `String` adminPrivateKey  | _(optional)_ DEFAULT_ADMIN private key, to sign transactions|
+
+#### Get reserved space
+
+Get information about reserved space for account in bytes.
+
+```javascript
+filestorage.getReservedSpace(address);
+```
+
+##### Parameters
+
+| Parameter                 | Description                                                 |
+| ------------------------- | ----------------------------------------------------------- |
+| `String` address          | Account address                                             |
+
+##### Returns
+
+| Parameter              | Description                                      |
+| ---------------------- | ------------------------------------------------ |
+| `Number` reservedSpace | Reserved space in bytes                          |
+
+#### Get occupied space
+
+Get information about occupied (actually used) space for account in bytes.
+
+```javascript
+filestorage.getOccupiedSpace(address);
+```
+
+##### Parameters
+
+| Parameter                 | Description                                                 |
+| ------------------------- | ----------------------------------------------------------- |
+| `String` address          | Account address                                             |
+
+##### Returns
+
+| Parameter              | Description                                      |
+| ---------------------- | ------------------------------------------------ |
+| `Number` occupiedSpace | Occupied space in bytes                          |
+
+#### Get total space in Filestorage
+
+Get information about total space in Filestorage in bytes.
+
+```javascript
+filestorage.getTotalSpace();
+```
+
+##### Returns
+
+| Parameter              | Description                                      |
+| ---------------------- | ------------------------------------------------ |
+| `Number` space         | Total space in Filestorage in bytes              |
+
+#### Get total reserved space
+
+Get information about total reserved space (sum of all reserved spaces) in bytes.
+
+```javascript
+filestorage.getTotalReservedSpace();
+```
+
+##### Returns
+
+| Parameter              | Description                                      |
+| ---------------------- | ------------------------------------------------ |
+| `Number` reservedSpace | Total reserved space in bytes                    |
+
 ## Development
 
 ### Install
@@ -380,4 +472,4 @@ Example:
 
 ![GitHub](https://img.shields.io/github/license/skalenetwork/filestorage.js.svg)
 
-All contributions are made under the [GNU Affero General Public License v3](https://www.gnu.org/licenses/agpl-3.0.en.html). See [LICENSE](LICENSE).
+All contributions are made under the [GNU Lesser General Public License v3](https://www.gnu.org/licenses/lgpl-3.0.en.html). See [LICENSE](LICENSE).