Skip to content

Commit

Permalink
docs: small improvements and consistency
Browse files Browse the repository at this point in the history
  • Loading branch information
marc0olo authored and thepiwo committed Apr 1, 2022
1 parent c0579bd commit 187b166
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 9 deletions.
2 changes: 2 additions & 0 deletions docs/cli/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ Helper and utilities for AEproject use, e.g. prefunded wallets, network definiti
const { networks, utils, wallets } = require('@aeternity/aeproject');
```

Read [AEproject Library](../lib.md) for a more detailed explanation about the usage of these imports.

### 2. SDK and Snapshotting Setup

Provide your initializations in mocha which need to be done once before all tests:
Expand Down
18 changes: 9 additions & 9 deletions docs/lib.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,42 +11,42 @@ const { utils, wallets, networks } = require('@aeternity/aeproject');
```javascript
utils.getContractContent(contractPath);
```
Read contract source from given path, just a wrapper for `fs.readFileSync` using `utf-8` encoding.
Read the contract source from given path, just a wrapper for `fs.readFileSync` using `utf-8` encoding.

```javascript
utils.getFilesystem(contractPath);
```
Add required filesystem imports for contract from given path, excluding the sophia provided library imports.
Add the required filesystem imports for contract from given path, excluding the Sophia provided library imports.

```javascript
utils.get(url);
```
Promisified zero dependencies http `GET` request, usually used to control aeternity node devmode endpoints.
Promisified zero dependencies http `GET` request, usually used to control æternity node devmode endpoints.

```javascript
utils.getSdk();
```
Initialize aeternity sdk, preconfigured for optimal use in an AEproject project using aeternity node devmode.
Initialize the æternity SDK, pre-configured for optimal use in an AEproject project using æternity node devmode.

```javascript
utils.awaitKeyBlocks(aeSdk, n);
```
Util to create and wait for `n` number of key-blocks with the aeternity node devmode, checked using the passed `aeSdk`.
Create and wait for `n` number of key-blocks with the æternity node devmode, checked using the passed `aeSdk`.

```javascript
utils.createSnapshot(aeSdk);
```
Util to create a snapshot of the current chain state using the aeternity node devmode, using the passed `aeSdk`.
Create a snapshot of the current chain state using the æternity node devmode, using the passed `aeSdk`.

```javascript
utils.rollbackSnapshot(aeSdk);
```
Util to rollback to the latest snapshot using the aeternity node devmode, using the passed `aeSdk`.
Rollback to the latest snapshot using the æternity node devmode, using the passed `aeSdk`.

## Wallets

List of configured keypairs that are prefunded using the aeternity node devmode as provided in AEproject.
List of configured keypairs that are pre-funded using the æternity node devmode as provided in AEproject.

## Networks

Exposed urls for commonly used `nodeUrl` and `compilerUrl`, per default local `devmode` and optionally hosted urls for `mainnet` and `testnet`.
Exposed URLs for commonly used `nodeUrl` and `compilerUrl`, per default local `devmode` and optionally hosted URLs for `mainnet` and `testnet`.

0 comments on commit 187b166

Please sign in to comment.