Skip to content

Commit

Permalink
chore: update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
adamant-al committed Jul 16, 2022
1 parent d973ba0 commit da55b9c
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,33 @@ Adamant-console is Command-line utilities to interact with ADAMANT blockchain. I

## Understanding interaction with ADAMANT blockchain

ADAMANT node is based on Lisk 0.9 code, but with important difference. ADAMANT has *only secure API*, and you cannot transfer passphrase to node to make any action with wallet, like Lisk 0.9 does. Instead, node *requires signed transaction* to make any action.
ADAMANT has *only secure API*, and you cannot transfer passphrase to node to make any action with wallet. Instead, node *requires signed transaction* to make any action.

Adamant-console connects to ADAMANT nodes on your choice (set in configuration file), it can be any node, locally installed on your machine, or from other side of the Earth. As Console doesn’t transfer passphrases to nodes, it is safe to connect to any node. Important thing, node you connect should have [API enabled](https://medium.com/adamant-im/how-to-run-your-adamant-node-on-ubuntu-990e391e8fcc#fe7e).
Adamant-console connects to ADAMANT nodes on your choice (set in configuration file), it can be any node, locally installed on your machine, or from other side of the Earth. As Console doesn’t transfer passphrases to nodes, it's safe to connect to any node. Node you connect should have [API enabled](https://medium.com/adamant-im/how-to-run-your-adamant-node-on-ubuntu-990e391e8fcc#fe7e).

You can use any programming languages to interact with Adamant-console, like PHP, Python, NodeJS, bash.

Alternative ways to interact with ADAMANT blockchain:

- [Direct node's API](https://github.com/Adamant-im/adamant/wiki)
- [JS API library](https://github.com/Adamant-im/adamant-api-jsclient/wiki)

## Installing and configuring

The installation and configuration are described in [Adamant-console Wiki](https://github.com/Adamant-im/adamant-console/wiki/Installation-and-configuration).

Note, by default, `network` parameter set to `testnet`. If you want to work with mainnet, set the value to `mainnet`.

## Using
## Using Console

There are 3 ways of using ADAMANT Console tool:

There are 3 ways of interacting with ADAMANT blockchain:
- command-line interface (CLI). List of available for commands see in [Adamant-console Wiki](https://github.com/Adamant-im/adamant-console/wiki/Available-Commands).
- Command-line interface (CLI). List of available for commands see in [Adamant-console Wiki](https://github.com/Adamant-im/adamant-console/wiki/Available-Commands).
- JSON-RPC. To use this interface, [start JSON-RPC daemon](https://github.com/Adamant-im/adamant-console/wiki/JSON-RPC) on Adamant-console.
- directly through the built-in library. The available methods see in [Adamant-console Wiki](https://github.com/Adamant-im/adamant-console/wiki/Running-Commands-in-Adamant-library) also.
- Directly through the built-in library. The available methods see in [Adamant-console Wiki](https://github.com/Adamant-im/adamant-console/wiki/Running-Commands-in-Adamant-library) also.

See [Running Commands in Adamant console](https://github.com/Adamant-im/adamant-console/wiki/Running-Commands-in-Adamant-console).

## Integration notes with ADM token for Exchanges

We wrote [Integration notes with ADM token for Exchanges](https://medium.com/adamant-im/integration-notes-with-adm-token-for-exchanges-d51a80c36aaf). Document describes how to create accounts for deposits, get balances and transactions info, as well as, how to make withdrawals.
See [Integration notes with ADM token for Exchanges](https://medium.com/adamant-im/integration-notes-with-adm-token-for-exchanges-d51a80c36aaf). Document describes how to create accounts for deposits, get balances and transactions info, as well as, how to make withdrawals.

0 comments on commit da55b9c

Please sign in to comment.