Перейти к содержанию

Аккаунты

Аккаунты представляют собой многоуровневую структуру, которая связывает пользователей платформы с блокчейном. Каждый аккаунт содержит информацию о пользователе в различных контекстах: как пользователя блокчейна и участника кооперативной экономики, как пользователя системы ЦК, и как потенциального или действующего пайщика кооператива.

Данный раздел, в основном, презначен для разработчиков, однако получить общее представление о структуре аккаунта будет полезно каждому.

Структура аккаунта

Аккаунт в ЦК состоит из нескольких компонентов:

  • Blockchain Account — запись в области оперативной памяти блокчейна, которая отвечает за хранение публичного ключа доступа и прочей низкоуровневой, инфраструктурной информации о владельце;
  • Provider Account — общая информация об аккаунте в системе федерации Цифрового Кооператива, такая как электронная почта, статус в процессе регистрации, и так далее;
  • User Account — базовая информация об участнике кооперативной экономики, включает в себя состояние верификации;
  • Participant Account — информация о статусе пайщика в кооперативе, которая относится к конкретному кооперативу, т.к. технически один аккаунт может быть пайщиков одновременно в нескольких кооперативах;
  • Private Account — персональные данные пайщика (ФИО, ИНН, и так далее)

Компоненты аккаунта разделены по структурам потому как хранятся в разных местах. BlockchainAccount, принадлежит уровню блокчейн-протокола, providerAccount и privateAccount хранятся в системе ЦК кооператива, userAccount хранится в области памяти смарт-контракта registrator и принадлежит к кооперативной экономике, а participantAccount хранится в области памяти смарт-контракта soviet и принадлежит к конкретному кооперативу.

Что такое смарт-контракты и как они работают мы рассмотрим в отдельном разделе, а здесь мы лишь предоставим разработчикам минимально-достаточную информацию о методах работы с аккаунтами и о их структурах.

Система поддерживает три типа аккаунтов:

  • individual — физическое лицо
  • entrepreneur — индивидуальный предприниматель
  • organization — юридическое лицо

Каждый тип имеет специфичные поля данных, которые хранятся и используются в фабрике документов. Процесс регистрации аккаунта, как часть потока вступления в пайщики см. в разделе Регистрация пайщика.

Получить информацию об аккаунте

🛠️ SDK: Queries.Accounts.GetAccount | 🔗 GraphQL API: Query.getAccount

import { Queries } from '@coopenomics/sdk';

const variables: Queries.Accounts.GetAccount.IInput = {
  data: {
    username: <string>; // Имя аккаунта пользователя
  };
};

const { [Queries.Accounts.GetAccount.name]: result } = await client.Query(
  Queries.Accounts.GetAccount.query,
  { variables }
);
Результат 
interface IOutput {
  getAccount: {
    blockchain_account?: {
      account_name: <string>; // Имя аккаунта
      core_liquid_balance?: <null | string>; // Баланс
      cpu_limit: {
        available: <string>; // Доступные ресурсы
        current_used?: <null | string>; // Текущее использование ресурсов
        last_usage_update_time?: <null | string>; // Время последнего обновления использования ресурсов
        max: <string>; // Максимальное количество ресурсов
        used: <string>; // Использовано ресурсов
      };
      cpu_weight: <string>; // Вес CPU
      created: <string>; // Дата создания
      head_block_num: <number>; // Номер последнего блока
      head_block_time: <string>; // Время последнего блока
      last_code_update: <string>; // Время последнего обновления кода
      net_limit: {
        available: <string>; // Доступные ресурсы
        current_used?: <null | string>; // Текущее использование ресурсов
        last_usage_update_time?: <null | string>; // Время последнего обновления использования ресурсов
        max: <string>; // Максимальное количество ресурсов
        used: <string>; // Использовано ресурсов
      };
      net_weight: <string>; // Вес сети
      permissions: <{
          parent: <string>; // Родительское разрешение
          perm_name: <string>; // Имя разрешения
          required_auth: {
            accounts: <{
                permission: {
                  actor: <string>; // Актор
                  permission: <string>; // Разрешение
                };
                weight: <number>; // Вес
              }[]>; // Уровни разрешений
            keys: <{
                key: <string>; // Ключ
                weight: <number>; // Вес
              }[]>; // Ключи
            threshold: <number>; // Порог
            waits: <{
                wait_sec: <number>; // Время ожидания в секундах
                weight: <number>; // Вес
              }[]>; // Вес ожидания
          };
        }[]>; // Разрешения
      privileged: <boolean>; // Флаг привилегий
      ram_quota: <number>; // Квота RAM
      ram_usage: <number>; // Использование RAM
      refund_request?: {
        cpu_amount: <string>; // Сумма CPU
        net_amount: <string>; // Сумма сети
        owner: <string>; // Владелец
        request_time: <string>; // Время запроса
      };
      rex_info?: <null | string>; // Информация о REX
      self_delegated_bandwidth?: {
        cpu_weight: <string>; // Вес CPU
        from: <string>; // Отправитель
        net_weight: <string>; // Вес сети
        to: <string>; // Получатель
      };
      total_resources?: {
        cpu_weight: <string>; // Вес CPU
        net_weight: <string>; // Вес сети
        owner: <string>; // Владелец
        ram_bytes: <number>; // Используемая RAM
      };
      voter_info?: <null | string>; // Информация о голосовании
    };
    participant_account?: {
      braname?: <null | string>; // Имя кооперативного участка
      created_at: <unknown>; // Время создания записи о члене
      has_vote: <boolean>; // LEGACY Флаг, имеет ли член право голоса
      initial_amount?: <null | string>; // Сумма вступительного взноса
      is_initial: <boolean>; // LEGACY Флаг, внесен ли регистрационный взнос
      is_minimum: <boolean>; // LEGACY Флаг, внесен ли минимальный паевый взнос
      last_min_pay: <unknown>; // Время последнего минимального платежа
      last_update: <unknown>; // Время последнего обновления информации о члене
      minimum_amount?: <null | string>; // Сумма минимального паевого взноса
      status: <string>; // Статус члена кооператива (accepted | blocked)
      type?: <null | string>; // Тип участника (individual | entrepreneur | organization)
      username: <string>; // Уникальное имя члена кооператива
    };
    private_account?: {
      entrepreneur_data?: {
        birthdate: <string>; // Дата рождения
        city: <string>; // Город
        country: <string>; // Страна
        details: {
          inn: <string>; // ИНН
          ogrn: <string>; // ОГРН
        };
        email: <string>; // Email
        first_name: <string>; // Имя
        full_address: <string>; // Юридический адрес
        last_name: <string>; // Фамилия
        middle_name: <string>; // Отчество
        phone: <string>; // Телефон
        username: <string>; // Имя аккаунта
      };
      individual_data?: {
        birthdate: <string>; // Дата рождения
        email: <string>; // Email
        first_name: <string>; // Имя
        full_address: <string>; // Полный адрес
        last_name: <string>; // Фамилия
        middle_name: <string>; // Отчество
        passport?: {
          code: <string>; // Код подразделения
          issued_at: <string>; // Дата выдачи
          issued_by: <string>; // Кем выдан
          number: <number>; // Номер паспорта
          series: <number>; // Серия паспорта
        };
        phone: <string>; // Телефон
        username: <string>; // Имя аккаунта
      };
      organization_data?: {
        city: <string>; // Город
        country: <string>; // Страна
        details: {
          inn: <string>; // ИНН
          kpp: <string>; // КПП
          ogrn: <string>; // ОГРН
        };
        email: <string>; // Email
        fact_address: <string>; // Фактический адрес
        full_address: <string>; // Юридический адрес
        full_name: <string>; // Полное название
        phone: <string>; // Телефон
        represented_by: {
          based_on: <string>; // На основании чего действует
          first_name: <string>; // Имя
          last_name: <string>; // Фамилия
          middle_name: <string>; // Отчество
          position: <string>; // Должность
        };
        short_name: <string>; // Краткое название
        type: <string>; // Тип организации
        username: <string>; // Имя аккаунта организации
      };
      type: <AccountType>; // Тип аккаунта
    };
    provider_account?: {
      email: <string>; // Электронная почта пользователя
      has_account: <boolean>; // Есть ли у пользователя аккаунт
      initial_order?: <null | string>; // ID начального заказа
      is_email_verified: <boolean>; // Подтверждена ли электронная почта
      is_registered: <boolean>; // Зарегистрирован ли пользователь
      message?: <null | string>; // Сообщение
      public_key: <string>; // Публичный ключ пользователя
      referer: <string>; // Реферер пользователя
      role: <string>; // Роль пользователя
      status: <UserStatus>; // Статус пользователя
      subscriber_hash: <string>; // Хэш подписчика для уведомлений
      subscriber_id: <string>; // Идентификатор подписчика для уведомлений
      type: <string>; // Тип пользователя
      username: <string>; // Имя пользователя
    };
    user_account?: {
      meta: <string>; // Метаинформация
      referer: <string>; // Реферал
      registered_at: <string>; // Дата регистрации
      registrator: <string>; // Регистратор
      status: <string>; // Статус аккаунта
      storages: <string[]>; // Список хранилищ
      type: <string>; // Тип учетной записи
      username: <string>; // Имя аккаунта
      verifications: <{
          created_at: <string>; // Дата создания верификации
          is_verified: <boolean>; // Флаг верификации
          last_update: <string>; // Дата последнего обновления верификации
          notice: <string>; // Заметка верификации
          procedure: <string>; // Процедура верификации
          verificator: <string>; // Имя верификатора
        }[]>; // Дата регистрации
    };
    username: <string>; // Имя аккаунта кооператива
  };
}

Получить список аккаунтов

🛠️ SDK: Queries.Accounts.GetAccounts | 🔗 GraphQL API: Query.getAccounts

import { Queries } from '@coopenomics/sdk';

const variables: Queries.Accounts.GetAccounts.IInput = {
  data?: {
    role?: <null | string>;
  };
  options?: {
    limit: <number>; // Количество элементов на странице
    page: <number>; // Номер страницы
    sortBy?: <null | string>; // Ключ сортировки (например, "name")
    sortOrder: <string>; // Направление сортировки ("ASC" или "DESC")
  };
};

const { [Queries.Accounts.GetAccounts.name]: result } = await client.Query(
  Queries.Accounts.GetAccounts.query,
  { variables }
);
Результат 
interface IOutput {
  getAccounts: {
    currentPage: <number>; // Текущая страница
    items: <{
        blockchain_account?: {
          account_name: <string>; // Имя аккаунта
          core_liquid_balance?: <null | string>; // Баланс
          cpu_limit: {
            available: <string>; // Доступные ресурсы
            current_used?: <null | string>; // Текущее использование ресурсов
            last_usage_update_time?: <null | string>; // Время последнего обновления использования ресурсов
            max: <string>; // Максимальное количество ресурсов
            used: <string>; // Использовано ресурсов
          };
          cpu_weight: <string>; // Вес CPU
          created: <string>; // Дата создания
          head_block_num: <number>; // Номер последнего блока
          head_block_time: <string>; // Время последнего блока
          last_code_update: <string>; // Время последнего обновления кода
          net_limit: {
            available: <string>; // Доступные ресурсы
            current_used?: <null | string>; // Текущее использование ресурсов
            last_usage_update_time?: <null | string>; // Время последнего обновления использования ресурсов
            max: <string>; // Максимальное количество ресурсов
            used: <string>; // Использовано ресурсов
          };
          net_weight: <string>; // Вес сети
          permissions: <{
              parent: <string>; // Родительское разрешение
              perm_name: <string>; // Имя разрешения
              required_auth: {
                accounts: <{
                    permission: {
                      actor: <...>; // Актор
                      permission: <...>; // Разрешение
                    };
                    weight: <number>; // Вес
                  }[]>; // Уровни разрешений
                keys: <{
                    key: <string>; // Ключ
                    weight: <number>; // Вес
                  }[]>; // Ключи
                threshold: <number>; // Порог
                waits: <{
                    wait_sec: <number>; // Время ожидания в секундах
                    weight: <number>; // Вес
                  }[]>; // Вес ожидания
              };
            }[]>; // Разрешения
          privileged: <boolean>; // Флаг привилегий
          ram_quota: <number>; // Квота RAM
          ram_usage: <number>; // Использование RAM
          refund_request?: {
            cpu_amount: <string>; // Сумма CPU
            net_amount: <string>; // Сумма сети
            owner: <string>; // Владелец
            request_time: <string>; // Время запроса
          };
          rex_info?: <null | string>; // Информация о REX
          self_delegated_bandwidth?: {
            cpu_weight: <string>; // Вес CPU
            from: <string>; // Отправитель
            net_weight: <string>; // Вес сети
            to: <string>; // Получатель
          };
          total_resources?: {
            cpu_weight: <string>; // Вес CPU
            net_weight: <string>; // Вес сети
            owner: <string>; // Владелец
            ram_bytes: <number>; // Используемая RAM
          };
          voter_info?: <null | string>; // Информация о голосовании
        };
        participant_account?: {
          braname?: <null | string>; // Имя кооперативного участка
          created_at: <unknown>; // Время создания записи о члене
          has_vote: <boolean>; // LEGACY Флаг, имеет ли член право голоса
          initial_amount?: <null | string>; // Сумма вступительного взноса
          is_initial: <boolean>; // LEGACY Флаг, внесен ли регистрационный взнос
          is_minimum: <boolean>; // LEGACY Флаг, внесен ли минимальный паевый взнос
          last_min_pay: <unknown>; // Время последнего минимального платежа
          last_update: <unknown>; // Время последнего обновления информации о члене
          minimum_amount?: <null | string>; // Сумма минимального паевого взноса
          status: <string>; // Статус члена кооператива (accepted | blocked)
          type?: <null | string>; // Тип участника (individual | entrepreneur | organization)
          username: <string>; // Уникальное имя члена кооператива
        };
        private_account?: {
          entrepreneur_data?: {
            birthdate: <string>; // Дата рождения
            city: <string>; // Город
            country: <string>; // Страна
            details: {
              inn: <string>; // ИНН
              ogrn: <string>; // ОГРН
            };
            email: <string>; // Email
            first_name: <string>; // Имя
            full_address: <string>; // Юридический адрес
            last_name: <string>; // Фамилия
            middle_name: <string>; // Отчество
            phone: <string>; // Телефон
            username: <string>; // Имя аккаунта
          };
          individual_data?: {
            birthdate: <string>; // Дата рождения
            email: <string>; // Email
            first_name: <string>; // Имя
            full_address: <string>; // Полный адрес
            last_name: <string>; // Фамилия
            middle_name: <string>; // Отчество
            passport?: {
              code: <string>; // Код подразделения
              issued_at: <string>; // Дата выдачи
              issued_by: <string>; // Кем выдан
              number: <number>; // Номер паспорта
              series: <number>; // Серия паспорта
            };
            phone: <string>; // Телефон
            username: <string>; // Имя аккаунта
          };
          organization_data?: {
            city: <string>; // Город
            country: <string>; // Страна
            details: {
              inn: <string>; // ИНН
              kpp: <string>; // КПП
              ogrn: <string>; // ОГРН
            };
            email: <string>; // Email
            fact_address: <string>; // Фактический адрес
            full_address: <string>; // Юридический адрес
            full_name: <string>; // Полное название
            phone: <string>; // Телефон
            represented_by: {
              based_on: <string>; // На основании чего действует
              first_name: <string>; // Имя
              last_name: <string>; // Фамилия
              middle_name: <string>; // Отчество
              position: <string>; // Должность
            };
            short_name: <string>; // Краткое название
            type: <string>; // Тип организации
            username: <string>; // Имя аккаунта организации
          };
          type: <AccountType>; // Тип аккаунта
        };
        provider_account?: {
          email: <string>; // Электронная почта пользователя
          has_account: <boolean>; // Есть ли у пользователя аккаунт
          initial_order?: <null | string>; // ID начального заказа
          is_email_verified: <boolean>; // Подтверждена ли электронная почта
          is_registered: <boolean>; // Зарегистрирован ли пользователь
          message?: <null | string>; // Сообщение
          public_key: <string>; // Публичный ключ пользователя
          referer: <string>; // Реферер пользователя
          role: <string>; // Роль пользователя
          status: <UserStatus>; // Статус пользователя
          subscriber_hash: <string>; // Хэш подписчика для уведомлений
          subscriber_id: <string>; // Идентификатор подписчика для уведомлений
          type: <string>; // Тип пользователя
          username: <string>; // Имя пользователя
        };
        user_account?: {
          meta: <string>; // Метаинформация
          referer: <string>; // Реферал
          registered_at: <string>; // Дата регистрации
          registrator: <string>; // Регистратор
          status: <string>; // Статус аккаунта
          storages: <string[]>; // Список хранилищ
          type: <string>; // Тип учетной записи
          username: <string>; // Имя аккаунта
          verifications: <{
              created_at: <string>; // Дата создания верификации
              is_verified: <boolean>; // Флаг верификации
              last_update: <string>; // Дата последнего обновления верификации
              notice: <string>; // Заметка верификации
              procedure: <string>; // Процедура верификации
              verificator: <string>; // Имя верификатора
            }[]>; // Дата регистрации
        };
        username: <string>; // Имя аккаунта кооператива
      }[]>; // Элементы текущей страницы
    totalCount: <number>; // Общее количество элементов
    totalPages: <number>; // Общее количество страниц
  };
}

Поиск по приватным данным

🛠️ SDK: Queries.Accounts.SearchPrivateAccounts | 🔗 GraphQL API: Query.searchPrivateAccounts

Поиск осуществляется по полям ФИО, ИНН, ОГРН, наименованию организации и другим приватным данным.

import { Queries } from '@coopenomics/sdk';

const variables: Queries.Accounts.SearchPrivateAccounts.IInput = {
  data: {
    query: <string>; // Поисковый запрос для поиска приватных аккаунтов
  };
};

const { [Queries.Accounts.SearchPrivateAccounts.name]: result } = await client.Query(
  Queries.Accounts.SearchPrivateAccounts.query,
  { variables }
);
Результат 
interface IOutput {
  searchPrivateAccounts: <{
      data: <unknown>; // Данные найденного аккаунта
      highlightedFields?: <null | string[]>; // Поля, в которых найдены совпадения
      score?: <null | number>; // Оценка релевантности результата
      type: <string>; // Тип аккаунта
    }[]>; // Поиск приватных данных аккаунтов по запросу. Поиск осуществляется по полям ФИО, ИНН, ОГРН, наименованию организации и другим приватным данным.
}