Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
leonardocustodio authored Oct 18, 2023
1 parent bb36938 commit 3c2ca51
Showing 1 changed file with 14 additions and 35 deletions.
49 changes: 14 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,61 +8,40 @@

This library provides a clean wrapper around all the methods exposed by a Polkadot/Substrate network client and defines all the types exposed by a node, this API provides developers the ability to query a node and interact with the Polkadot or Substrate chains using Dart.

This library is funded by [Web3 Foundation](https://web3.foundation/) via their [Open Grants Program](https://github.com/w3f/Open-Grants-Program)
This library is funded by [Web3 Foundation](https://web3.foundation) via their [Open Grants Program](https://github.com/w3f/Open-Grants-Program)

## [polkadart-scale-codec](./packages/polkadart_scale_codec/)
## [polkadart-scale-codec](./packages/polkadart_scale_codec)

A Dart implementation of [SCALE](https://docs.substrate.io/reference/scale-codec/), Substrate uses a lightweight and efficient encoding and decoding program to optimize how data is sent and received over the network. The program used to serialize and deserialize data is called the SCALE codec, with SCALE being an acronym for simple concatenated aggregate little-endian.
A Dart implementation of [SCALE](https://docs.substrate.io/reference/scale-codec), Substrate uses a lightweight and efficient encoding and decoding program to optimize how data is sent and received over the network. The program used to serialize and deserialize data is called the SCALE codec, with SCALE being an acronym for simple concatenated aggregate little-endian.

## [ss58](./packages/ss58/)
## [ss58](./packages/ss58)

A Dart implementation of [SS58](https://docs.substrate.io/reference/address-formats/). The SS58 is the default Substrate address format, this encoded address format is based on the Bitcoin Base-58-check format, but with a few modifications specifically designed to suit Substrate-based chains. You can use other address formats for Substrate-based chains. However, the SS58 address format provides a base-58 encoded value that can identify a specific account on any Substrate chain. Because different chains can have different ways of identifying accounts, the SS58 address is designed to be extensible.
A Dart implementation of [SS58](https://docs.substrate.io/reference/address-formats). The SS58 is the default Substrate address format, this encoded address format is based on the Bitcoin Base-58-check format, but with a few modifications specifically designed to suit Substrate-based chains. You can use other address formats for Substrate-based chains. However, the SS58 address format provides a base-58 encoded value that can identify a specific account on any Substrate chain. Because different chains can have different ways of identifying accounts, the SS58 address is designed to be extensible.

### Basic format

```
base58encode ( concat ( <address-type>, <address>, <checksum> ) )
```

## [substrate-metadata](./packages/substrate_metadata/)
## [substrate-metadata](./packages/substrate_metadata)

One of the most important things to understand about **polkadart** is that most interfaces are generated automatically when it connects to a running node. This is quite a departure from other APIs in projects where the interfaces are static. While sounding quite scary, it is a powerful concept that exists in both Polkadot and Substrate chains and allows the API to be used in environments where the chain is customized.

## Requirements

You need to have `git-lfs` installed to run the tests. Download from [Github](https://git-lfs.github.com)

On Mac OS X:

```bash
brew install git-lfs
```

On Ubuntu:

```bash
sudo apt-get install git-lfs
```

## Fetching files

To ensure the `git-lfs files` are fetched inside the cloned git repository. Run these commands from the root of `polkadart repo`.
## Documentation and Tests

```bash
git lfs fetch
git lfs checkout
```
You can run all tests from the library by running `docker compose up`;
Or if you have [Melos](https://melos.invertase.dev/~melos-latest/getting-started) installed globally you can run `melos test`.

## Documentation and Tests

You can run all tests from the library by running `docker compose up`.
| Package | Path
|----------|----------|
| polkadart | [packages/polkadart](./packages/polkadart) |
| polkadart_cli | [packages/polkadart_cli/](./packages/polkadart_cli/) |
| polkadart_scale_codec | [packages/polkadart_scale_codec/](./packages/polkadart_scale_codec/) |
| ss58 | [packages/ss58/](./packages/ss58/) |
| substrate_metadata | [packages/substrate_metadata/](./packages/substrate_metadata/) |
| polkadart_cli | [packages/polkadart_cli](./packages/polkadart_cli) |
| polkadart_scale_codec | [packages/polkadart_scale_codec](./packages/polkadart_scale_codec) |
| ss58 | [packages/ss58](./packages/ss58) |
| substrate_bip39 | [packages/substrate_bip39](./packages/substrate_metadata) |
| substrate_metadata | [packages/substrate_metadata](./packages/substrate_metadata) |

## Road map and current state

Expand Down

0 comments on commit 3c2ca51

Please sign in to comment.