golos-lib-js/docs/README.md

Golos-js the JavaScript library with API for GOLOS blockchain

# Документация

- [Авторизация и ключи](./files/auth.md)
- [Database API](./files/database.md)
    - [Подписка на события](./files/database.md#подписка-на-события)
    - [Тэги постов](./files/database.md#тэги-постов)
    - [Блоки и транзакции](./files/database.md#блоки-и-транзакции)
    - [Глобальные объекты](./files/database.md#глобальные-объекты)
    - [Ключи](./files/database.md#ключи)
    - [Аккаунты](./files/database.md#аккаунты)
    - [Authority и валидация](./files/database.md#authority-и-валидация)
    - [Посты и комментарии](./files/database.md#посты-и-комментарии)
    - [Голосование за посты](./files/database.md#голосование-за-посты)
    - [Делегаты](./files/database.md#делегаты)
- [Подписчики](./files/follow.md)
- [Воркеры](./files/workers.md)
- [Внутренняя биржа](./files/market.md)
- [UIA](./files/UIA.md)
- [Операции](./files/operations.md)
- [Примеры отправки операций](./files/operations.md#примеры-отправки-операций)
- [Golos Messenger](./files/msgs.md)
- [Платные подписки](./files/paid_subscriptions.md)
- [NFT](./files/nft.md)
- [Шифрование платных постов (Cryptor)](./files/cryptor.md)
- [Утилиты, ускоряющие разработку клиентов](./files/utils)
    - [Валидация имен аккаунтов](./files/utils/validate_account_name.md)
    - [Asset для финансовых расчетов](./files/utils/asset.md)
    - [Formatter](./files/utils/formatter.md)
    - [fetchEx, AbortController и тайм-ауты](./files/utils/fetchEx.md)

## Установка
```
$ npm install golos-lib-js --save
```

Полная документация здесь:
https://github.com/golos-blockchain/libs/tree/master/golos-lib-js/docs

#### React и Webpack 5

В этом случае есть свои важные нюансы, описано [здесь](./files/webpack5.md).

## Использование без npm/yarn

Библиотека доступна на [jsDelivr CDN](https://cdn.jsdelivr.net/npm/golos-lib-js@latest/dist/golos.min.js) и [Unpkg CDN](https://unpkg.com/golos-lib-js@latest/dist/golos.min.js), и позволяет использовать библиотеку в любом проекте, даже не использующем Node.js. Все, что нужно, - это браузер.

```html 
<script src="./golos.min.js"></script>
<script>
// По умолчанию библиотека подключается к одной из нод майннета блокчейна Golos
golos.api.getAccounts(['ned', 'dan'], (err, response) => {
    console.log(err, response);
});
</script>
```

## Сборка своей golos-lib-js (с загрузкой в npm)

Вы можете собрать свою собственную копию golos-lib-js, чтобы дополнительно проаудировать ее, или, к примеру,  доработать для использования в специфических проектах\задачах.

[См. здесь](./files/build.md).

## Загрузка модуля WebAssembly

[См. здесь](./files/wasm.md).

## Протоколы WebSockets и HTTP

Библиотека поддерживает 2 транспортных протокола: ws/wss и http/https, для общения с нодами блокчейна Golos. Данные внутри библиотеки передаются в формате JSON-RPC.

Рекомендуемые ноды:

wss://api-golos.blckchnd.com/ws<br/>
wss://api.aleksw.space/ws<br/>
wss://golos.lexai.host/ws<br/>

https://api-golos.blckchnd.com/<br/>
https://api.aleksw.space/<br/>
https://golos.lexai.host/<br/>

```js
golos.config.set('websocket','wss://golos.lexai.host/ws');
```
или
```js
golos.config.set('websocket','https://golos.lexai.host/');
```