Skip to content

Commit

Permalink
Solve weekly technical debt (#56)
Browse files Browse the repository at this point in the history
  • Loading branch information
@anastasiia-bilova
anastasiia-bilova authored May 20, 2019
1 parent e9bdfc5 commit c7c29c1
Show file tree
Hide file tree
Showing 58 changed files with 524 additions and 530 deletions.
150 changes: 76 additions & 74 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -160,10 +160,10 @@ Options:

Get balance of the account by its address — ``remme account get-balance``:

| Arguments | Type | Required | Description |
| :-------: | :----: | :-------: | ------------------------------------ |
| address | String | Yes | Account address to get a balance by. |
| node-url | String | No | Node URL to apply a command to. |
| Arguments | Type | Required | Description |
| :-------: | :----: | :------: | ------------------------------------ |
| address | String | Yes | Account address to get a balance by. |
| node-url | String | No | Node URL to apply a command to. |

```bash
$ remme account get-balance \
Expand All @@ -178,12 +178,12 @@ $ remme account get-balance \

Transfer tokens to address — ``remme account transfer-tokens``:

| Arguments | Type | Required | Description |
| :---------: | :-----: | :-------: | ---------------------------------------------- |
| private-key | String | Yes | Account's private key to transfer tokens from. |
| address-to | String | Yes | Account address to transfer tokens to. |
| amount | Integer | Yes | Amount to transfer. |
| node-url | String | No | Node URL to apply a command to. |
| Arguments | Type | Required | Description |
| :---------: | :-----: | :------: | ---------------------------------------------- |
| private-key | String | Yes | Account's private key to transfer tokens from. |
| address-to | String | Yes | Account address to transfer tokens to. |
| amount | Integer | Yes | Amount to transfer. |
| node-url | String | No | Node URL to apply a command to. |

```bash
$ remme account transfer-tokens \
Expand All @@ -202,10 +202,10 @@ $ remme account transfer-tokens \

Get information about the node account by its address — ``remme node-account get``:

| Arguments | Type | Required | Description |
| :---------: | :----: | :------: | -------------------------------------------------------------- |
| address | String | Yes | Node account address to get information about node account by. |
| node-url | String | No | Node URL to apply a command to. |
| Arguments | Type | Required | Description |
| :-------: | :----: | :------: | -------------------------------------------------------------- |
| address | String | Yes | Node account address to get information about node account by. |
| node-url | String | No | Node URL to apply a command to. |

```bash
$ remme node-account get \
Expand Down Expand Up @@ -238,14 +238,14 @@ $ remme node-account get \

Get a list of blocks — ``remme block get-list``:

| Arguments | Type | Required | Description |
| :---------: | :-----: | :-------: | -------------------------------------------------- |
| ids | String | No | Identifiers to get a list of blocks by. |
| limit | Integer | No | Maximum amount of blocks to return. |
| head | Integer | No | Block identifier to get a list of transactions to. |
| ids-only | Bool | No | The flag to get a list of blocks' identifiers. |
| reverse | Bool | No | Parameter to reverse result. |
| node-url | String | No | Node URL to apply a command to. |
| Arguments | Type | Required | Description |
| :-------: | :-----: | :------: | -------------------------------------------------- |
| ids | String | No | Identifiers to get a list of blocks by. |
| limit | Integer | No | Maximum amount of blocks to return. |
| head | Integer | No | Block identifier to get a list of transactions to. |
| ids-only | Bool | No | The flag to get a list of blocks' identifiers. |
| reverse | Bool | No | Parameter to reverse result. |
| node-url | String | No | Node URL to apply a command to. |

```bash
$ remme block get-list \
Expand Down Expand Up @@ -327,10 +327,10 @@ $ remme block get-list --ids-only --node-url=node-6-testnet.remme.io

Get information about the block by its identifier — ``remme block get``:

| Arguments | Type | Required | Description |
| :-------: | :----: | :-------: | ------------------------------------------------------ |
| id | String | Yes | Identifier of the block to fetch information about by. |
| node-url | String | No | Node URL to apply a command to. |
| Arguments | Type | Required | Description |
| :-------: | :----: | :------: | ------------------------------------------------------ |
| id | String | Yes | Identifier of the block to fetch information about by. |
| node-url | String | No | Node URL to apply a command to. |

```bash
$ remme block get \
Expand Down Expand Up @@ -473,10 +473,10 @@ $ remme atomic-swap get-info \

Get a batch by identifier — ``remme batch get``:

| Arguments | Type | Required | Description |
| :-------: | :----: | :-------: | -------------------------------- |
| id | String | Yes | Identifier to get a batch by. |
| node-url | String | No | Node URL to apply a command to. |
| Arguments | Type | Required | Description |
| :-------: | :----: | :------: | ------------------------------- |
| id | String | Yes | Identifier to get a batch by. |
| node-url | String | No | Node URL to apply a command to. |

```bash
$ remme batch get \
Expand Down Expand Up @@ -521,10 +521,10 @@ $ remme batch get \

Get a batch status by its identifier — ``remme batch get-status``:

| Arguments | Type | Required | Description |
| :---------: | :----: | :-------: | ------------------------------------ |
| id | String | Yes | Identifier to get a batch status by. |
| node-url | String | No | Node URL to apply a command to. |
| Arguments | Type | Required | Description |
| :-------: | :----: | :------: | ------------------------------------ |
| id | String | Yes | Identifier to get a batch status by. |
| node-url | String | No | Node URL to apply a command to. |

```bash
$ remme batch get-status \
Expand All @@ -537,15 +537,15 @@ $ remme batch get-status \

Get a list of batches — ``remme batch get-list``:

| Arguments | Type | Required | Description |
| :--------: | :----: | :-------: | ----------------------------------------------------- |
| ids | String | No | Identifiers to get a list of batches by. |
| start | String | No | Batch identifier to get a list of batches starting from.|
| limit | Integer| No | Maximum amount of batches to return. |
| head | String | No | Block identifier to get a list of batches from. |
| reverse | Bool | No | Parameter to reverse result. |
| ids-only | Bool | No | The flag to get a list of batches' identifiers. |
| node-url | String | No | Node URL to apply a command to. |
| Arguments | Type | Required | Description |
| :-------: | :-----: | :------: | -------------------------------------------------------- |
| ids | String | No | Identifiers to get a list of batches by. |
| start | String | No | Batch identifier to get a list of batches starting from. |
| limit | Integer | No | Maximum amount of batches to return. |
| head | String | No | Block identifier to get a list of batches from. |
| reverse | Bool | No | Parameter to reverse result. |
| ids-only | Bool | No | The flag to get a list of batches' identifiers. |
| node-url | String | No | Node URL to apply a command to. |

```bash
$ remme batch get-list \
Expand Down Expand Up @@ -600,20 +600,20 @@ Get a list of batches' identifiers (can be combined with other parameters like `
$ remme batch get-list --ids-only --node-url=node-6-testnet.remme.io
{
"result": [
"e4d5089f2ef1...6b0f185b3b6ca",
"df5e555f...317f039501",
"6bd3382e3deef34d0bc63a7b450c88c7ae00152f5168c7b4dc4357feff6d52175209919cd0710441fa2768f4c12adf97143440ef8414bb5144b9459d78ff3e0e",
"7a5daba99d5757adc997ea6a0b1b83263b3c16604dbd83c0153dc01c9fd780af4b570338c2ec60e086b1db58a4397a4dc661d6c93b0a7250fe75642e15b26e81",
...
]
}
```

### Node

Get node configurations — ``remme node get-configs``:
Get the node configurations — ``remme node get-configs``:

| Arguments | Type | Required | Description |
| :-------: | :----: | :-------: | ------------------------------- |
| node-url | String | No | Node URL to apply a command to. |
| Arguments | Type | Required | Description |
| :-------: | :----: | :------: | ------------------------------- |
| node-url | String | No | Node URL to apply a command to. |

```bash
$ remme node get-configs --node-url=node-genesis-testnet.remme.io
Expand All @@ -629,9 +629,9 @@ $ remme node get-configs --node-url=node-genesis-testnet.remme.io

Get the node's peers — ``remme node get-peers``:

| Arguments | Type | Required | Description |
| :-------: | :----: | :-------: | ------------------------------- |
| node-url | String | No | Node URL to apply a command to. |
| Arguments | Type | Required | Description |
| :-------: | :----: | :------: | ------------------------------- |
| node-url | String | No | Node URL to apply a command to. |

```bash
$ remme node get-peers --node-url=node-genesis-testnet.remme.io
Expand Down Expand Up @@ -754,13 +754,13 @@ $ remme state get \

Get a list of states — ``remme state get-list``:

| Arguments | Type | Required | Description |
| :---------: | :----: | :-------: | ----------------------------------------------------- |
| address | String | No | Account address to get a list of states by. |
| limit | Integer| No | Maximum amount of transactions to return. |
| head | String | No | Block identifier to get a list of states to. |
| reverse | Bool | No | Parameter to reverse result. |
| node-url | String | No | Node URL to apply a command to. |
| Arguments | Type | Required | Description |
| :-------: | :-----: | :------: | -------------------------------------------- |
| address | String | No | Account address to get a list of states by. |
| limit | Integer | No | Maximum amount of transactions to return. |
| head | String | No | Block identifier to get a list of states to. |
| reverse | Bool | No | Parameter to reverse result. |
| node-url | String | No | Node URL to apply a command to. |

```bash
$ remme state get-list \
Expand All @@ -783,16 +783,16 @@ $ remme state get-list \

Get a list of transactions — ``remme transaction get-list``:

| Arguments | Type | Required | Description |
| :---------: | :----: | :-------: | ----------------------------------------------------- |
| ids | String | No | Identifiers to get a list of transactions by. |
| start | String | No | Transaction identifier to get a list transaction starting from.|
| limit | Integer| No | Maximum amount of transactions to return. |
| head | String | No | Block identifier to get a list of transactions from. |
| reverse | Bool | No | Parameter to reverse result. |
| ids-only | Bool | No | The flag to get a list of transactions' identifiers. |
| node-url | String | No | Node URL to apply a command to. |
| family-name | String | No | List of transactions by its family name. |
| Arguments | Type | Required | Description |
| :---------: | :-----: | :------: | -------------------------------------------------------------- |
| ids | String | No | Identifiers to get a list of transactions by. |
| start | String | No | Transaction identifier to get a list transaction starting from. |
| limit | Integer | No | Maximum amount of transactions to return. |
| head | String | No | Block identifier to get a list of transactions from. |
| reverse | Bool | No | Parameter to reverse result. |
| ids-only | Bool | No | The flag to get a list of transactions' identifiers. |
| family-name | String | No | List of transactions by its family name. |
| node-url | String | No | Node URL to apply a command to. |

```bash
$ remme transaction get-list \
Expand Down Expand Up @@ -855,10 +855,10 @@ $ remme transaction get-list --ids-only --node-url=node-6-testnet.remme.io

Get a transaction by identifier — ``remme transaction get``:

| Arguments | Type | Required | Description |
| :---------: | :----: | :-------: | -------------------------------- |
| id | String | Yes | Identifier to get transaction by. |
| node-url | String | No | Node URL to apply a command to. |
| Arguments | Type | Required | Description |
| :-------: | :----: | :------: | --------------------------------- |
| id | String | Yes | Identifier to get transaction by. |
| node-url | String | No | Node URL to apply a command to. |

```bash
$ remme transaction get \
Expand Down Expand Up @@ -972,8 +972,10 @@ $ docker exec -it remme-core-cli bash
And now being in the container, you can develop the project. For instance, run tests and linters:

```bash
$ pytest -vv tests/
$ coverage run -m pytest -vv tests
$ coverage report -m && coverage xml
$ flake8 cli && flake8 tests/
$ bash <(curl -s https://linters.io/isort-diff) cli tests
```

When you have developed new functionality, check it with the following command. This command creates the ``Python package``
Expand Down
4 changes: 2 additions & 2 deletions cli/account/forms.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ class GetAccountBalanceForm(Schema):
"""

address = AccountAddressField(required=True)
node_url = NodeUrlField(required=False)
node_url = NodeUrlField(required=True)


class TransferTokensForm(Schema):
Expand All @@ -37,4 +37,4 @@ class TransferTokensForm(Schema):
validate.Range(min=1, error='Amount must be greater than 0.'),
],
)
node_url = NodeUrlField(required=False)
node_url = NodeUrlField(required=True)
2 changes: 1 addition & 1 deletion cli/atomic_swap/cli.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ def atomic_swap_commands():
@atomic_swap_commands.command('get-public-key')
def get_public_key(node_url):
"""
Get public key of atomic swap.
Get the public key of atomic swap.
"""
arguments, errors = GetAtomicSwapPublicKeyForm().load({
'node_url': node_url,
Expand Down
6 changes: 3 additions & 3 deletions cli/atomic_swap/forms.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ class GetAtomicSwapInformationForm(Schema):
"""

id = SwapIdentifierField(required=True)
node_url = NodeUrlField(required=False)
node_url = NodeUrlField(required=True)


class GetAtomicSwapPublicKeyForm(Schema):
"""
Get public key of the atomic swap form.
Get the public key of the atomic swap form.
"""

node_url = NodeUrlField(required=False)
node_url = NodeUrlField(required=True)
2 changes: 1 addition & 1 deletion cli/atomic_swap/interfaces.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ class AtomicSwapInterface:

def get_public_key(self):
"""
Get public key of atomic swap.
Get the public key of atomic swap.
"""
pass

Expand Down
2 changes: 1 addition & 1 deletion cli/atomic_swap/service.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ def __init__(self, service):

def get_public_key(self):
"""
Get public key of atomic swap.
Get the public key of atomic swap.
"""
try:
public_key = loop.run_until_complete(self.service.swap.get_public_key())
Expand Down
Loading

0 comments on commit c7c29c1

Please sign in to comment.