update

2024-06-01 12:06:28 +05:00
parent ff9f00f893
commit 885f49922a
1 changed files with 98 additions and 9 deletions
@@ -1,4 +1,4 @@
-# cooptypes
+# COOPTYPES

 [![npm version][npm-version-src]][npm-version-href]
 [![npm downloads][npm-downloads-src]][npm-downloads-href]
@@ -6,20 +6,109 @@
 [![JSDocs][jsdocs-src]][jsdocs-href]
 [![License][license-src]][license-href]

-## Обозначения
-_username - имя аккаунта пользователя до 12 символов.
+Модуль cooptypes содержит информацию для работы со смарт-контрактами кооперативной экономики. В этом модуле представлены реестры действий и таблиц каждого смарт-контракта, а также имена аккаунтов для разных блокчейн-сетей.

-_coopname - имя аккаунта кооператива до 12 символов.
+Каждое действие содержит интерфейс транзакции, информацию о требуемой авторизации и имя действия, которое нужно вызвать на уровне смарт-контракта.

-_chairman - имя аккаунта председателя кооператива до 12 символов.
+Каждая таблица содержит интерфейс для работы с данными и информацию о пространстве хранения информации в блокчейне.

-_admin - имя аккаунта администратора кооператива до 12 символов.
+## Как пользоваться
+Перейти на страницу документации и ознакомиться с набором пространств имен контрактов, в каджом из которых есть действия и таблицы, а также, интерфейсы данных, имена контрактов, пространств хранения и требуемая авторизация. Всё это доступно из интерфейса IDE после импорта контракта.

-_contract - собственное имя аккаунта контракта до 12 символов, в котором вызывается действие.
+### Получение таблиц

-## License
+```
+import EosApi from 'eosjs-api';
+import {SovietContract} from 'cooptypes'

-[MIT](./LICENSE) License © 2024-PRESENT [Alex Ant](https://github.com/dacom-dark-sun)
+const options = {
+    httpEndpoint: 'http://127.0.0.1:8888',
+  };
+
+const api = new EosApi(options);
+const coopname = 'testcoop' - тестовое имя аккаунта кооператива
+
+const _scope = SovietContract.Tables.Boards.scope
+
+Получив _scope, необходимо проверить его и подставить переменную:
+let scope
+
+if (_scope === '_coopname' )
+  scope = coopname
+if (_scope === '_username)
+  scope = username
+... и так далее
+
+```
+scope - это области памяти хранения информации в смарт-контракте, которые представлены в виде универсальных параметров _username, _coopname или прочих, в соответствии с которыми необходимо подставить переменную.
+
+Например, для получения таблицы с членами совета кооператива, необходимо подставить область памяти _coopname, или, 'testcoop', как было определено выше для тестового кооператива. Также, вместо _coopname могут быть указаны имена других контрактов или пользователей. Область памяти определяется тем, как именно смарт-контракт хранит информацию.
+
+После подстановок, мы можем получить информацию из таблицы смарт-контракта блокчейна:
+```
+api.getTableRows(
+    {
+        json: true,
+        code: SovietContract.contractName.production, //извлекаем имя контракта
+        scope, //подставляем ранее полученную область памяти
+        table: SovietContract.Tables.Boards.tableName, //извлекаем имя таблицы в контракте
+        limit: 10, // устанавливаем лимит
+
+        // не обязательные параметры запроса
+        /*  upper_bound, // - верхняя граница
+            lower_bound, // - нижняя граница
+            key_type, // - тип ключа
+            index_position, // нижняя граница
+        */
+    })
+```
+
+Те же параметры scope, table, code могут быть использованы для получения информации из модуля [COOPARSER](https://github.com/copenomics/cooparser). Последнее используется, когда необходимо получить исторические данные и нет необходимости проверять их актуальность по наличию таблиц в блокчейне. Однако, таблицы в блокчейне необходимо всегда проверять перед отправкой любой транзакции действия. Нельзя полагаться на данные из парсера при подготовке транзакции действия.
+
+### Транзакция действий
+Состояние любого смарт-контракта может изменяться только с помощью действий. Для того, чтобы совершить действия, необходимо сформировать и отправить транзакцию с помощью библиотеки eosjs или альтернатив.
+
+```
+import { Api, JsonRpc } from 'eosjs';
+import { JsSignatureProvider } from 'eosjs/dist/eosjs-jssig';
+import { TextEncoder, TextDecoder } from 'util';
+import fetch from 'isomorphic-fetch';
+
+const signatureProvider = new JsSignatureProvider([wif]);
+const api = new Api({ rpc, signatureProvider, textDecoder: new TextDecoder(), textEncoder: new TextEncoder() });
+```
+
+транзакция может содержать в себе массив действий, которые будут применяться последовательно друг за другом. Ниже мы сформируем транзакцию регистрации нового аккаунта, которая может быть вызвана только администратором или председателем кооператива.
+
+```
+  const result = await eos.transact(
+    {
+      actions: [
+        {
+          //здесь мы извлекаем имя контракта
+          account: RegistratorContract.contractName.production,
+          //здесь мы извлекаем имя действия
+          name: RegistratorContract.Actions.CreateAccount.actionName,
+          authorization: [
+            {
+              // требуемые авторизации хранятся в RegistratorContract.Actions.CreateAccount.authorizations, откуда могут быть извлечены программно или вручную.
+              actor: chairman,
+              permission: 'active',
+            },
+          ],
+          data: {
+            // подставляем данные действия
+          } as RegistratorContract.Actions.CreateAccount.ICreateAccount,
+          // здесь извлекаем интерфейс для действия
+        },
+      ]
+    }
+  );
+```
+
+## Лицензия
+
+[MIT](./LICENSE) License © 2024-PRESENT [CBS VOSKHOD](https://github.com/copenomics)

 <!-- Badges -->