Слияние кода завершено, страница обновится автоматически
Добавление новой группы, где ID группы должен совпадать с тем, что указан в цепочке.
a) Протокол сетевой передачи: HTTP протокол
b) Адрес запроса: /fisco-bcos-browser/group/add
c) Метод запроса: POST
d) Формат ответа: json
| Номер | Входной параметр | Тип | Обязательность | Примечание |
|---|---|---|---|---|
| 1 | groupId | int | Нет | ID группы |
| 2 | groupName | string | Нет | Название группы |
| 3 | groupDesc | string | Да | Описание группы |
| Номер | Выходной параметр | Тип | Обязательность | Примечание |
|---|---|---|---|---|
| 1 | code | int | Нет | Информация о коде выхода, см. Приложение 1 |
| 2 | message | string | Нет | Сообщение |
| 3 | data | object | Да | Элементы данных |
http://localhost:5101/fisco-bcos-browser/group/add
{
"groupId": 1,
"groupName": "test",
"groupDesc": "тест"
}
Успешный ответ:
{
"code": 0,
"message": "успех",
"data": null
}
Неудачный ответ:
{
"code": 105001,
"message": "системная ошибка",
"data": null
}
Получение списка информации о группах
a) Протокол сетевой передачи: HTTP протокол
b) Адрес запроса: /fisco-bcos-browser/group/groupListc) Метод запроса: GET
d) Формат ответа: json
| Номер | Входной параметр | Тип | Может быть пустым | Примечание |
|---|---|---|---|---|
| Номер | Выходной параметр | Тип | Может быть пустым | Примечание |
| 1 | code | int | Нет | Информация о коде возврата смотрите в приложении 1 |
| 2 | message | String | Нет | Описание |
| 3 | data | object | Да | Элементы информации возврата |
| 3.1 | List | Список групп | ||
| 3.1.1 | groupId | int | Нет | Номер группы |
| 3.1.2 | groupName | String | Нет | Название группы |
| 3.1.3 | groupDesc | String | Нет | Описание группы |
http://localhost:5101/fisco-bcos-browser/group/groupList
а) Успешный ответ:
{
"code": 0,
"message": "success",
"data": [
{
"groupId": 1,
"groupName": "test",
"groupDesc": "тест"
},
{
"groupId": 2,
"groupName": "test2",
"groupDesc": "тест2"
}
]
}
б) Несоответствие:
{
"code": 105001,
"message": "системная ошибка",
"data": null
}
Удаление группы по её ID вместе с узлами, блоками и связанными данными.
б) Адрес запроса: /fisco-bcos-browser/group/deleteById/{groupId}
в) Метод запроса: DELETE
г) Формат возврата: json
| № | Входной параметр | Тип | Обязательность | Примечание |
|---|---|---|---|---|
| 1 | groupId | int | Нет | ID группы |
| № | Выходной параметр | Тип | Обязательность | Примечание |
| 1 | code | int | Нет | Код возврата, см. приложение 1 |
| 2 | message | String | Нет | Описание ошибки |
| 3 | data | object | Да | Элементы возвращаемых данных |
http://localhost:5101/fisco-bcos-browser/group/deleteById/3
а) Успешный ответ:
{
"code": 0,
"message": "success",
"data": null
}
б) Несоответствие:
{
"code": 105001,
"message": "системная ошибка",
"data": null
}
Получение информации об общем состоянии блокчейна текущей группы.
а) Протокол сетевой передачи: HTTP
б) Адрес запроса: /fisco-bcos-browser/home/blockChainInfo/{groupId}
в) Метод запроса: GET
г) Формат возврата: json### Подробная информация о параметрах| Номер | Входной параметр | Тип | Допускается null | Примечание | | ----- | ---------------- | ---- | ----------------- | ----------------------------- | | 1 | groupId | int | Нет | Групповой номер | | Номер | Выходной параметр | Тип | Допускается null | Примечание | | 1 | code | int | Нет | Информацию о коде возврата смотрите в приложении 1 | | 2 | message | String | Нет | Описание | | 3 | data | Object | Нет | Объект возвращаемой информации | | 3.1 | groupId | int | Нет | Групповой номер | | 3.2 | latestNumber | int | Нет | Последний уровень блока | | 3.3 | txn | int | Нет | Общее количество транзакций | | 3.4 | pendingTxn | int | Нет | Количество ожидающих транзакций | | 3.5 | pbftView | int | Нет | Вид | | 3.6 | nodeCount | int | Нет | Количество узлов |
а) Успешный ответ:
{
"code": 0,
"message": "success",
"data": {
"groupId": 1,
"latestNumber": 2,
"txn": 2,
"pendingTxn": 0,
"pbftView": 73807,
"nodeCount": 2
}
}
б) Несоответствие:
{
"code": 105001,
"message": "system error",
"data": null
}
Получение информации о количестве транзакций в группе за указанный период времени.
а) Протокол сетевой передачи данных: используется HTTP протокол
б) Адрес запроса: /fisco-bcos-browser/home/txnLately/{groupId}/{dateTimeBegin}/{dateTimeEnd}
в) Метод запроса: GET
г) Формат возврата: JSON
| № | Входной параметр | Тип | Обязательность | Примечание |
|---|---|---|---|---|
| 1 | groupId | int | Да | ID группы |
| 2 | dateTimeBegin | string | Да | Начальное время (формат: 2019-02-10) |
| 3 | dateTimeEnd | string | Да | Конечное время (формат: 2019-02-10) |
| № | Выходной параметр | Тип | Обязательность | Примечание |
|---|---|---|---|---|
| 1 | code | int | Да | Код возврата, подробнее см. Приложение 1 |
| 2 | message | string | Да | Сообщение |
| 3 | data | object | Да | Элементы возвращаемых данных |
| 3.1 | list | - | Список элементов | |
| 3.1.1 | dateStr | string | Да | Дата |
| 3.1.2 | txn | int | Да | Количество транзакций |
а) Успешный ответ:
{
"code": 0,
"message": "success",
"data": [
{
"dateStr": "2/22",
"txn": 5
},
{
"dateStr": "2/21",
"txn": 3
}
]
}
б) Несоответствие:
{
"code": 105001,
"message": "system error",
"data": null
}
Запрос о состоянии настроек прав доступа
a) Нетворк протокол передачи данных: использование HTTP протокола
b) Адрес запроса: /fisco-bcos-browser/home/isConfigAuth
c) Метод запроса: GET
d) Формат возврата: json
| № | Входной параметр | Тип | Может быть пустым | Примечание |
|---|---|---|---|---|
| № | Выходной параметр | Тип | Может быть пустым | Примечание |
| 1 | code | int | Нет | Информацию о коде возврата смотрите в Приложении 1 |
| 2 | message | String | Нет | Описание |
| 3 | data | object | Нет | Элементы информации возврата |
http://localhost:5101/fisco-bcos-browser/home/isConfigAuth
а) Успешный:
{
"code": 0,
"message": "success",
"data": true
}
б) Неудачный:
{
"code": 105001,
"message": "system error",
"data": null
}
a) Нетворк протокол передачи данных: использование HTTP протокола
b) Адрес запроса: /fisco-bcos-browser/node/add
c) Метод запроса: POST
d) Формат возврата: JSON
| № | Входной параметр | Тип | Может быть пустым | Примечание |
|---|---|---|---|---|
| 1 | groupId | int | Нет | Номер группы |
| 2 | data | List | Нет | Список информации узлов |
| 2.1 | ip | String | Нет | IP адрес узла |
| 2.2 | rpcPort | String | Нет | RPC порт узла |
| 2.3 | p2pPort | String | Нет | P2P порт узла |
| № | Выходной параметр | Тип | Может быть пустым | Примечание |
| 1 | code | int | Нет | Информация о коде возврата смотрите приложение 1 |
| 2 | message | String | Нет | Описание |
| 3 | data | object | Да | Элементы информации возврата |
http://localhost:5101/fisco-bcos-browser/node/add
{
"groupId": 1,
"data": [
{
"ip": "127.0.0.1",
"rpcPort": "8545",
"p2pPort": "30300"
}
]
}
а) Успешный ответ:
{
"code": 0,
"message": "success",
"data": null
}
б) Несоответствие:```json { "code": 105001, "message": "ошибка системы", "data": null }
## 3.2 Список узлов
Получение списка информации о ноде в текущей группе
### Спецификация протокола передачи
а) Протокол сетевой передачи: используется протокол HTTP
б) Адрес запроса:
`/fisco-bcos-browser/node/nodeList/{groupId}/{pageNumber}/{pageSize}?type={type}&ip={ip}&rpcPort={rpcPort}&p2pPort={p2pPort}`
в) Метод запроса: GET
г) Формат возврата: json### Подробная информация о параметрах| Номер | Входящие параметры | Тип | Допускается null | Примечание |
| ----- | ------------------ | ---- | ----------------- | ----------------------------------------------- |
| 1 | groupId | int | Нет | Номер группы |
| 2 | pageNumber | int | Нет | Текущий номер страницы |
| 3 | pageSize | int | Нет | Количество записей на странице |
| 4 | type | int | Да | Тип узла (0 — добавлено вручную) |
| 5 | ip | String | Да | IP адрес узла |
| 6 | rpcPort | String | Да | RPC порт узла |
| 7 | p2pPort | String | Да | P2P порт узла |
| **Номер** | **Выходные параметры** | **Тип** | **Допускается null** | **Примечание** |
| 1 | code | int | Нет | Информация о коде ответа, см приложение 1 |
| 2 | message | String | Нет | Описание |
| 3 | data | object | Да | Объект с информацией ответа |
| 3. 1 | | List | | Список информации |
| 3. 1. 1 | groupId | int | Нет | Номер группы |
| 3. 1. 2 | nodeId | int | Нет | ID узла |
| 3. 1. 3 | groupDesc | String | Нет | Описание группы |
| 3. 1. 4 | ip | String | Нет | IP адрес узла |
| 3. 1. 5 | rpcPort | String | Нет | RPC порт узла |
| 3. 1. 6 | p2pPort | String | Нет | P2P порт узла |6 | p2pPort | String | Нет | P2P-порт узла |
| 3. 1. 7 | blockNumber | int | Нет | Высота блока узла |
| 3. 1. 8 | pbftView | int | Нет | Вид узла |
| 3. 1. 9 | status | int | Нет | Состояние узла (0 — нормальное, 1 — аномальное, 2 — отключено) |
| 3. 2. 0 | type | int | Нет | Тип узла |
| 4 | totalCount | int | Нет | Общее количество записей |### Пример входных данных```
http://localhost:5101/fisco-bcos-browser/node/nodeList/1/1/5?ip=127.0.0.1
а) Успешный ответ:
{
"code": 0,
"message": "успех",
"data": [
{
"nodeId": 1,
"groupId": 1,
"ip": "127.0.0.1",
"rpcPort": "8545",
"p2pPort": "30300",
"blockNumber": 2,
"pbftView": 1002,
"status": 0,
"type": 0
}
],
"totalCount": 1
}
б) Несоответствие:
{
"code": 105001,
"message": "системная ошибка",
"data": null
}
Удаление узла по его ID.
а) Протокол сетевой передачи: HTTP
б) Адрес запроса: /fisco-bcos-browser/node/deleteById/{groupId}/{nodeId}
в) Метод запроса: DELETE
г) Формат возврата: JSON
| № | Входной параметр | Тип | Обязательность | Примечание |
|---|---|---|---|---|
| 1 | groupId | int | Да | Групповой номер |
| 2 | nodeId | string | Да | Уникальный идентификатор узла |
| № | Выходной параметр | Тип | Обязательность | Примечание |
|---|---|---|---|---|
| 1 | code | int | Да | Информация о коде возврата, см. Приложение 1 |
| 2 | message | string | Да | Сообщение |
| 3 | data | object | Да | Элементы возвращаемой информации |
http://localhost:5101/fisco-bcos-browser/node/deleteById/1/xxxxxxx
а) Успешный ответ:
{
"code": 0,
"message": "успех",
"data": null
}
б) Несоответствие:```json { "code": 105001, "message": "ошибка системы", "data": null }
# 4 Блоки
## 4.1 Список информации о блоках
Получение списка информации о блоках текущей группы.
### Описание протокола передачи
а) Протокол сетевой передачи: HTTP
б) Адрес запроса: `/fisco-bcos-browser/block/blockList/{groupId}/{pageNumber}/{pageSize}?blockHash={blockHash}&blockNumber={blockNumber}`в) Метод запроса: GET| Номер | Входящий параметр | Тип | Может быть пустым | Примечание |
| ----- | ------------------ | ---- | -------------------- | -------------------------- |
| 1 | groupId | int | Нет | Номер группы |
| 2 | pageNumber | int | Нет | Текущая страница |
| 3 | pageSize | int | Нет | Количество записей на странице |
| 4 | blockHash | String | Да | Хэш блока |
| 5 | blockNumber | String | Да | Высота блока |
| **Номер** | **Выходной параметр** | **Тип** | **Может быть пустым** | **Примечание** |
| 1 | code | int | Нет | Информация о коде возврата см. приложение 1 |
| 2 | message | String | Нет | Описание |
| 3 | data | object | Да | Экземпляр информации о возврате |
| 3.1 | | List | | Список информации |
| 3.1.1 | blockHash | String | Нет | Хэш блока |
| 3.1.2 | number | int | Нет | Высота блока |
| 3.1.3 | sealer | String | Нет | Автор блока |
| 3.1.4 | dateTimeStr | String | Нет | Дата и время создания блока |
| 3.1.5 | txn | int | Нет | Количество транзакций в блоке |
| 4 | totalCount | int | Нет | Общее количество записей |
### Пример входных данныхhttp://localhost:5101/fisco-bcos-browser/block/blockList/1/1/5
### Пример выходных данных
**а) Успешный ответ:**
```json
{
"code": 0,
"message": "success",
"data": [
{
"blockHash": "0x973cbc3ff1611599523edcdb1b2fa869a3941f4ada798dc45a0225b5de0a401b",
"number": 2,
"sealer": "0x1",
"dateTimeStr": "2019-02-21 17:55:00:777",
"txn": 1
}
],
"totalCount": 1
}
б) Несущественный ответ:
{
"code": 105001,
"message": "системная ошибка",
"data": null
}
Получение информации о блоке по его хешу.
а) Протокол сетевой передачи: HTTP протокол
б) Адрес запроса: /fisco-bcos-browser/block/blockByHash/{groupId}/{blockHash}
в) Метод запроса: GET
г) Формат возврата: json
| № | Входной параметр | Тип | Может быть пустым | Примечание |
|---|---|---|---|---|
| 1 | groupId | int | Нет | Номер группы |
| 2 | blockHash | String | Нет | Хеш блока |
| № | Выходной параметр | Тип | Может быть пустым | Примечание |
| 1 | code | int | Нет | Информация о коде возврата, см. приложение 1 |
| 2 | message | String | Нет | Описание |
| 3 | data | object | Нет | Объект с информацией о блоке |
{
"code": 0,
"message": "успех",
"data": {
"sealer": "0x0",
"gasLimit": "0x0",
"logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"number": "0x1",
"gasUsed": "0x0",
"extraData": [],
"transactionsRoot": "0xAF0B34F0D1DD6D148CAD0CB5D92F8228BC63D7963622E8E1351B0D7272E5B3D7",
"stateRoot": "0xAAE025C9A89626A9465D0C3D81D73CDFFC79AD646989C3B37ED422985ECFB3BF",
"parentHash": "0xCB35AB7696D19F9376AEe7F01C8CEBBEF073E5E4FFEEBAEA87F5BFD19A1471D",
"transactions": [
{
"blockHash": "0x6060DFFC89A336CEF58589C6D1F7180704B4F31E367F43C7722BBFC994180A7",
"input": "0x48F85BCE000000000000000000000000000000000000000000000000000000000000001BF5BD8A9E7BA8B936EA704292FF4AAA5797BF671FDC8526Dcd159F23C1F5A05F44E9FA862834DC7CB4541558F2B4961DC39EAAF0AF7F7395028658D0E01B86A37",
"blockNumber": "0x1",
"gas": "0x9184E729FFF",
"from": "0x0EfAA59AE8A68C8833DCFa59E0ECA7A95DC9B4BA",
"transactionIndex": "0x0",
"to": "0xD6F1A71052366DBAE2F7Ab2D5D5845E77965CF0D",
"nonce": "0x2ADE583745343A8F9A70B40Db996FBe69C635318328581550547418000017516",
"value": "0x0",
"hash": "0x01185AAD6D8B2F430DF19514Ec20A8DEEA14Ca2B861773B9583F0C42BABDF710",
"gasPrice": "0x174876E7FF"
}
],
"hash": "0x6060DFFC89A336CEF58589C6D1F7180704B4F31E367F43C7722BBFC994180A7",
"timestamp": "0x16903D3FEc8"
}
}
б) Ошибка:```json { "code": 105001, "message": "системная ошибка", "data": null }
# 5. Транзакционные интерфейсы
## 5.1 Список информации о транзакциях
Получение списка информации о транзакциях в текущей группе
### Протокол передачи данных
a) Сетевой протокол передачи данных: используется HTTP протокол
b) Адрес запроса: `/fisco-bcos-browser/transaction/transactionList/{groupId}/{pageNumber}/{pageSize}?transHash={transHash}&blockNumber={blockNumber}`
c) Метод запроса: GET
d) Формат ответа: json
### Подробная информация о параметрах
| Номер | Входной параметр | Тип | Обязательность | Примечание |
| ----- | ---------------- | ---- | -------------- | ----------- |
| 1 | groupId | int | Нет | Номер группы |
| 2 | pageNumber | int | Нет | Номер страницы |
| 3 | pageSize | int | Нет | Количество записей на странице |
| 4 | transHash | String | Да | Хэш транзакции |
| 5 | blockNumber | String | Да | Высота блока |
| Номер | Исходящий параметр | Тип | Обязательность | Примечание |
| ----- | ------------------ | ---- | -------------- | ----------- |
| 1 | code | int | Нет | Информация о коде выхода, см. Приложение 1 |
| 2 | message | String | Нет | Описание |
| 3 | data | object | Да | Элементы возвращаемой информации |
| 3.1 | | List | | Список информации |
| 3.1.1 | transHash | String | Нет | Хэш транзакции |
| 3.1.2 | blockHash | String | Нет | Хэш блока |
| 3.1.3 | blockNumber | int | Нет | Высота блока |
| 3.1.4 | blockTimesStr | String | Нет | Время создания блока |
| 3.1.5 | from | String | Нет | Отправитель |
| 3.1.6 | to | String | Нет | Получатель |
| 3.1.7 | transIndex | int | Нет | Индекс транзакции |
| 3.1.8 | method | String | Нет | Вызванный метод |
| 4 | totalCount | int | Нет | Общее количество записей |### Пример входных параметров
http://localhost:5101/fisco-bcos-browser/transaction/transactionList/1/1/5
### Пример выходных данных
**а) Успешный ответ:**
```json
{
"code": 0,
"message": "success",
"data": [
{
"transHash": "0x8f6d3d24bd9c5676ebb7b655a05ad9da1e254d8049daba1c13b2941a0eb4b990",
"blockHash": "0x973cbc3ff1611599523edcdb1b2fa869a3941f4ada798dc45a0225b5de0a401b",
"blockNumber": 2,
"blockTimesStr": "2019-02-21 17:55:00:777",
"from": "0x494c9042dd1801e8f21cfd2be2eca9aa0550b71a",
"to": "0xd6f1a71052366dbae2f7ab2d5d5845e77965cf0d",
"transIndex": 0,
"method": "set"
}
],
"totalCount": 1
}
б) Несуспешный ответ:
{
"code": 105001,
"message": "system error",
"data": null
}
Получение информации о транзакции по её хешу.
а) Сетевой протокол передачи: HTTP
б) Адрес запроса: /fisco-bcos-browser/transaction/transactionByHash/{groupId}/{transHash}
в) Метод запроса: GET
г) Формат возврата: JSON
| № | Входной параметр | Тип | Обязательность | Примечание |
|---|---|---|---|---|
| 1 | groupId | int | Да | Групповой номер |
| 2 | transHash | String | Да | Хэш транзакции |
| № | Выходной параметр | Тип | Обязательность | Примечание |
|---|---|---|---|---|
| 1 | code | int | Да | Код возврата, см. приложение 1 |
| 2 | message | String | Да | Сообщение |
| 3 | data | Object | Да | Элементы возвращаемых данных |
а) Успешный ответ:
{
"code": 0,
"message": "успех",
"data": {
"blockHash": "0x6060dffc89a336cefa58589c6d1f7180704b4f31e367f43c7722bbfc994180a7",
"input": "0x48f85bce000000000000000000000000000000000000000000000000000000000000001bf5bd8a9e7ba8b936ea704292ff4aaa5797bf671fdc8526dcd159f23c1f5a05f44e9fa862834dc7cb4541558f2b4961dc39eaaf0af7f7395028658d0e01b86a37",
"blockNumber": "0x1",
"gas": "0x9184e729fff",
"from": "0x0efaa59ae8a68c8833dcfa59e0eca7a95dc9b4ba",
"transactionIndex": "0x0",
"to": "0xd6f1a71052366dbae2f7ab2d5d5845e77965cf0d",
"nonce": "0x2ade583745343a8f9a70b40db996fbe69c635318328581550547418000017516",
"value": "0x0",
"hash": "0x01185aad6d8b2f430df19514ec20a8deea14ca2b861773b9583f0c42babdf710",
"gasPrice": "0x174876e7ff"
}
}
б) Ошибка:
{
"code": 105001,
"message": "системная ошибка",
"data": null
}
Получение информации о завершении транзакции по её хешу.
a) Протокол сетевой передачи: используется протокол HTTP
b) Адрес запроса: /fisco-bcos-browser/transaction/receiptByHash/{groupId}/{transHash}
c) Метод запроса: GET
d) Формат возврата: JSON
| ------- | ---------------- | ------- | ------------------ | ------------------------- | | 1 | groupId | int | Нет | Номер группы | | 2 | transHash | String | Нет | Хэш транзакции | | № | Выходной параметр | Тип | Может быть пустым | Примечание | | 1 | code | int | Нет | Информация о коде возврата, см. приложение 1 | | 2 | message | String | Нет | Описание | | 3 | data | object | Нет | Элементы возвращаемой информации |### Пример входных параметров
a) Успешный ответ:
{
"code": 0,
"message": "успех",
"data": {
"output": "0x",
"blockHash": "0x6060dffc89a336cefa58589c6d1f7180704b4f31e367f43c7722bbfc994180a7",
"logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"gasUsed": "0x64d8",
"blockNumber": "0x1",
"contractAddress": "0x0000000000000000000000000000000000000000",
"from": "0x0efaa59ae8a68c8833dcfa59e0eca7a95dc9b4ba",
"transactionIndex": "0x0",
"to": "0xd6f1a71052366dbae2f7ab2d5d5845e77965cf0d",
"logs": [],
"transactionHash": "0x01185aad6d8b2f430df19514ec20a8deea14ca2b861773b9583f0c42babdf710",
"status": "0x0"
}
}
b) Ошибка:
{
"code": 105001,
"message": "системная ошибка",
"data": null
}
Получение бинарного кода контракта по адресу контракта
a) Сетевой протокол передачи: используется HTTP протокол
b) Адрес запроса: /fisco-bcos-browser/contract/code
c) Метод запроса: POST
d) Формат возврата: json
| ------- | ---------------- | -------------- | ------------------ | ----------------------------- | | 1 | groupId | int | Нет | Групповой номер | | 2 | data | List
| Нет | Список адресов контрактов | | № | Выходной параметр | Тип | Может быть пустым | Примечание | | 1 | code | int | Нет | Информация о коде возврата, см. приложение 1 | | 2 | message | String | Нет | Описание | | 3 | data | объект | Нет | Объект информации возврата |### Пример входных данныхhttp://localhost:5101/fisco-bcos-browser/contract/code
{
"groupId": 1,
"data": [
"0x0000000000000000000000000000000000001004"
]
}
a) Успешный:
{
"code": 0,
"message": "успех",
"data": [
"0x"
]
}
b) Ошибка:
{
"code": 105001,
"message": "системная ошибка",
"data": null
}
Получение данных анализа транзакций по хэшу транзакции
a) Сетевой протокол передачи: используется HTTP протокол
b) Адрес запроса: /fisco-bcos-browser/transaction/analyzeData
c) Метод запроса: POST
d) Формат возврата: JSON### Подробная информация о параметрах| Номер | Входной параметр | Тип | Может быть пустым | Примечание | | ----- | ---------------------- | ------- | ------------------ | ------------------------- | | 1 | groupId | int | Нет | Групповой номер | | 2 | data | List | Нет | Список | | 2.1 | transHash | String | Да | Хэш транзакции | | Номер | Выходной параметр | Тип | Может быть пустым | Примечание | | 1 | code | int | Нет | Код возврата | | 2 | message | String | Нет | Описание | | 3 | data | Object | Да | Элемент информации возврата | | 3.1 | | List | | Список информации | | 3.1.1 | transactionFromChain | Object | Нет | Информация о транзакции | | 3.1.2 | receiptFromChain | Object | Нет | Информация о приеме транзакции |
{
"groupId": 1,
"data": [
{
"transHash": "XXXX"
},
{
"transHash": "XXXX"
}
]
}
{
"code": 0,
"message": "успешно",
"data": [
{
"transactionFromChain": {
"blockHash": "0x582c13681b26ea942fa46f13146e0c44311de89cbd5305e48ad5925ff8ab3215",
``````markdown
"input": "0xa216464b000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000000c00000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000016000000000000000000000000000000000000000000000000000000000000000a48656c6c6f576f726c6400000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 "logs": [
],
"transactionHash": "0xb8e078e26222a247c97b822bfd071c579474e6b8e8780720931542846ceb7689",
"status": "0x0"
}
]
}
```b) Провал:``````json { "code": 105001, "message": "системная ошибка", "data": null }
# 6. Контрактные интерфейсы
## 6.1 Сохранение контракта
Сохраняет информацию о контракте в базе данных.
### Протокол передачи данных
a) Сетевой протокол: используется HTTP протокол
b) Адрес запроса: `/fisco-bcos-browser/contract/add`
c) Метод запроса: POST
d) Формат ответа: JSON
### Подробная информация о параметрах
| № | Входной параметр | Тип | Обязательность | Примечание |
| -- | ---------------- | --------- | -------------- | --------------------------- |
| 1 | data | List | Нет | Список контрактов |
| 1.1 | contractName | String | Нет | Название контракта |
| 1.2 | contractDesc | String | Нет | Описание контракта |
| 1.3 | contractSource | String | Нет | Исходный код контракта |
| 1.4 | contractPath | String | Нет | Путь к контракту |
| **№** | **Выходной параметр** | **Тип** | **Обязательность** | **Примечание** |
| 1 | code | int | Нет | Информация о коде выхода, см. Приложение Yöntem 1 |
| 2 | message | String | Нет | Описание |
| 3 | data | Object | Да | Элементы возвращаемой информации |
### Пример входных данных
http://localhost:5101/fisco-bcos-browser/contract/add
```json
{
"data": [
{
"contractName": "Helloworld",
"contractDesc": "",
"contractSource": "",
"contractPath": "/"
}
]
}
a) Успешный:
{
"code": 0,
"message": "успех",
"data": null
}
b) Провальный:
{
"code": 105001,
"message": "системная ошибка",
"data": null
}
a) Сетевой протокол: используется HTTP протокол
b) Адрес запроса: /fisco-bcos-browser/contract/contractList/{pageNumber}/{pageSize}
c) Метод запроса: GET
d) Формат ответа: JSON### Подробная информация о параметрах| Номер | Входной параметр | Тип | Допускается null | Примечание | | ----- | ----------------- | ---- | ----------------- | ----------------------------- | | 1 | pageNumber | int | Нет | Номер текущей страницы | | 2 | pageSize | int | Нет | Количество записей на странице| | Номер | Выходной параметр | Тип | Допускается null | Примечание | | 1 | code | int | Нет | Информация о коде возврата, см. Приложение 1 | | 2 | message | String | Нет | Описание | | 3 | data | object | Да | Экземпляр информации о возврате | | 3.1 | | List | | Список информации | | 3.1.1 | contractId | int | Нет | Номер контракта | | 3.1.3 | contractName | String | Нет | Наименование контракта | | 3.1.4 | contractDesc | String | Да | Описание контракта | | 3.1.5 | contractBin | String | Да | Бинарный код контракта | | 3.1.6 | contractAbi | String | Да | ABI контракта | | 3.1.7 | contractSource | String | Нет | Исходный код контракта | | 3.1.8 | contractStatus | int | Нет | Статус контракта | | 3.1.9 | errorInfo | String | Да | Информация об ошибках компиляции | | 4 | totalCount | int | Нет | Общее количество записей |
а) Успешный ответ:
{
"code": 0,
"message": "успех",
"data": [
{
"contractId": 300001,
"contractName": "OK",
"contractDesc": "XXXX",
"contractBin": "XXXX",
"contractAbi": "XXXX",
"contractSource": "XXXX",
"contractStatus": 1,
"errorInfo": "XXXX"
},
{
"contractId": 300001,
"contractName": "OK",
"contractDesc": "XXXX",
"contractBin": "XXXX",
"contractAbi": "XXXX",
"contractSource": "XXXX",
"contractStatus": 1,
"errorInfo": "XXXX"
}
],
"totalCount": 13
}
б) Несоответствие:
{
"code": 105001,
"message": "системная ошибка",
"data": null
}
Сохранение информации после компиляции контракта в базу данных.
а) Протокол сетевой передачи: HTTP
б) Адрес запроса: /fisco-bcos-browser/contract/update
в) Метод запроса: PUT
г) Формат ответа: json
| -- | ---------------- | --- | ------------------ | ----------- | | 1 | data | List | Нет | Информация о контракте | | 1.1 | contractId | int | Да | ID контракта | | 1.2 | contractBin | String | Да | Бинарный код контракта | | 1.3 | contractAbi | String | Да | ABI контракта | | 1.4 | contractAddress | String | Да | Адрес контракта | | 1.5 | errorInfo | String | Да | Информация об ошибке при компиляции | | № | Выходной параметр | Тип | Может быть пустым | Примечание | | 1 | code | int | Нет | Код ответа, подробнее см. Приложение OnClickListener | | 2 | message | String | Нет | Описание | | 3 | data | object | Да | Элементы ответа |### Пример входных данных
http://localhost:5101/fisco-bcos-browser/contract/update``` { "data": [ { "contractId": 1, "contractBin": "XXXX", "contractAbi": "XXXX", "contractAddress": "XXXX", "errorInfo": "XXXX" }, { "contractId": 1, "contractBin": "XXXX", "contractAbi": "XXXX", "contractAddress": "XXXX", "errorInfo": "XXXX" } ] }
### Пример выходных данных
**а) Успешный ответ:**
{ "code": 0, "message": "Успех", "data": null }
**б) Несоответствие:**
{ "code": 105001, "message": "Системная ошибка", "data": null }
## 6.4 Удаление контракта
Удаление контракта по его ID.
### Транспортные протоколы
а) Транспортный протокол: HTTP
б) Адрес запроса: `/fisco-bcos-browser/contract/deleteById?contractId={contractId}`
в) Метод запроса: DELETE
г) Формат возврата: JSON
### Детали входных параметров
| № | Входной параметр | Тип | Обязательность | Примечание |
| ------- | ---------------- | ------- | ------------- | ------------------------------------ |
| 1 | contractId | String | Нет | ID контракта, несколько через запятую |
| **№** | **Выходной параметр** | **Тип** | **Обязательность** | **Примечание** |
| 1 | code | int | Нет | Информация о коде возврата, см. приложение 1 |
| 2 | message | String | Нет | Описание |
| 3 | data | объект | Да | Элементы возвращаемых данных |
### Примеры входных данных
http://localhost:5101/fisco-bcos-browser/contract/deleteById?contractId=1,2
### Примеры выходных данных
**а) Успешный ответ:**```
{
"code": 0,
"message": "Успех",
"data": null
}
б) Несоответствие:
{
"code": 105001,
"message": "Системная ошибка",
"data": null
}
Сохранение информации о методах контрактов.
а) Транспортный протокол: HTTP
б) Адрес запроса: /fisco-bcos-browser/contract/addFunction
в) Метод запроса: PUT
г) Формат возврата: json
| Номер | Входящие параметры | Тип | Может быть пустым | Примечание |
|---|---|---|---|---|
| 1 | data | List | Нет | Информация о методах контракта |
| 1.1 | methodId | String | Да | Информация о методе |
| 1.2 | abiInfo | String | Да | Информация ABI |
| 1.3 | type | String | Да | Тип метода |
| Номер | Выходные параметры | Тип | Может быть пустым | Примечание |
| 1 | code | int | Нет | Информацию о коде возврата см. приложение 1 |
| 2 | message | String | Нет | Описание |
| 3 | data | object | Да | Экземпляр информации возврата |
http://localhost:5101/fisco-bcos-browser/contract/addFunction```json { "data": [ { "methodId": "XXXX", "abiInfo": "XXXX", "type": "XXXX" }, { "methodId": "XXXX", "abiInfo": "XXXX", "type": "XXXX" } ] }
### Пример выходных данных
**а) Успешный ответ:**
```json
{
"code": 0,
"message": "успех",
"data": null
}
б) Несоответствие:
{
"code": 105001,
"message": "системная ошибка",
"data": null
}
Получение информации о методах контракта по methodId.
а) Протокол сетевой передачи данных: HTTP.
б) Адрес запроса: /fisco-bcos-browser/contract/function/{methodId}.
в) Метод запроса: GET.
г) Формат возврата: JSON.
| № | Входной параметр | Тип | Обязательность | Примечание |
|---|---|---|---|---|
| 1 | methodId | String | Да | ID метода |
| № | Выходной параметр | Тип | Обязательность | Примечание |
| 1 | code | int | Да | Информация о коде возврата, см. приложение 1 |
| 2 | message | String | Да | Описание |
| 3 | data | Object | Да | Элементы возвращаемых данных |
http://localhost:5101/fisco-bcos-browser/contract/function/0x11111
а) Успешный ответ:
{
"code": 0,
"message": "успех",
"data": {
"methodId": "XXXX",
"abiInfo": "XXXX",
"type": "XXXX"
}
}
б) Несоответствие:
{
"code": 105001,
"message": "системная ошибка",
"data": null
}
```## 6.7 Поиск ABI контракта
Поиск ABI контракта по данным входа.
### Описание протокола передачи данных
а) Протокол сетевой передачи данных: HTTP.
б) Адрес запроса: `/fisco-bcos-browser/contract/abi/{input}`.
в) Метод запроса: GET.
г) Формат возврата: JSON.
### Детали параметров
| № | Входной параметр | Тип | Может быть пустым | Примечание |
| ------- | ---------------- | ------ | ------------------ | ----------------------------- |
| 1 | input | String | Нет | Информация входного параметра контракта метода |
| **№** | **Выходной параметр** | **Тип** | **Может быть пустым** | **Примечание** |
| ------- | --------------------- | ------- | ---------------------- | --------------------------- |
| 1 | code | Int | Нет | Информацию о кодах возврата смотрите в приложении 1 |
| 2 | message | String | Нет | Описание |
| 3 | data | Object | Нет | Экземпляр информации возврата |
### Пример входных данных
http://localhost:5101/fisco-bcos-browser/contract/abi/xxxxx
### Пример выходных данных
**а) Успешный ответ:**
```json
{
"code": 0,
"message": "success",
"data": {
"XXXX"
}
}
б) Несоответствие:
{
"code": 105001,
"message": "system error",
"data": null
}
а) Протокол сетевой передачи данных: используется HTTP протокол.
б) Адрес запроса: /fisco-bcos-browser/user/add.
в) Метод запроса: POST.
г) Формат возврата: JSON.
| ------- | ---------------- | ------- | ------------------ | ----------------------------- | | 1 | groupId | int | Нет | Номер группы | | 2 | userName | String | Нет | Имя пользователя | | 3 | address | String | Нет | Адрес открытого ключа пользователя | | 4 | description | String | Да | Описание | | № | Выходной параметр | Тип | Может быть пустым | Примечание | | 1 | code | int | Нет | Информация о коде возврата, см. приложение 1 | | 2 | message | String | Нет | Описание | | 3 | data | object | Да | Объект информации возврата |
http://localhost:5101/fisco-bcos-browser/user/add
{
"address": "0xd93ca98d540b5ed09ef49e9e035ada3d5236ecb0",
"description": "тест",
"groupId": 1,
"userName": "alice"
}
а) Успешный ответ:
{
"code": 0,
"message": "success",
"data": {
"userId": 700001,
"userName": "alice",
"groupId": 1,
"address": "0xd93ca98d540b5ed09ef49e9e035ada3d5236ecb0",
"description": "тест",
"createTime": "2020-11-13 11:38:19",
"modifyTime": "2020-11-13 11:38:19"
}
}
б) Несоответствие:
{
"code": 105001,
"message": "системная ошибка",
"data": null
}
а) Протокол сетевой передачи данных: используется HTTP протокол
б) Адрес запроса: /fisco-bcos-browser/user/userList/{groupId}/{pageNumber}/{pageSize}?userParam={userParam}в) Метод запроса: GET
г) Формат возврата: json### Детали параметров входных данных
| Номер | Входящий параметр | Тип | Может быть пустым | Примечание |
|---|---|---|---|---|
| 1 | groupId | int | Нет | Номер группы, к которой принадлежит |
| 2 | pageNumber | int | Нет | Номер текущей страницы |
| 3 | pageSize | int | Нет | Количество записей на странице |
| 4 | userParam | String | Да | Имя пользователя или адрес его открытого ключа |
| Номер | Выходной параметр | Тип | Может быть пустым | Примечание |
|---|---|---|---|---|
| 1 | code | int | Нет | Информация о коде возврата, см. Приложение 1 |
| 2 | message | String | Нет | Описание |
| 3 | data | object | Да | Объект с информацией о возврате |
| 3.1 | List | Список информации | ||
| 3.1.1 | userId | int | Нет | Номер пользователя |
| 3.1.2 | groupId | int | Нет | Номер группы, к которой принадлежит |
| 3.1.3 | userName | String | Нет | Имя пользователя |
| 3.1.4 | address | String | Нет | Адрес открытого ключа пользователя |
| 3.1.5 | description | String | Да | Описание |
| 4 | totalCount | int | Нет | Общее количество записей |
http://localhost:5101/fisco-bcos-browser/user/userList/1/1/1
а) Успешный ответ:
{
"code": 0,
"message": "Успех",
"data": [
{
"userId": 700001,
"userName": "alice",
"groupId": 1,
"address": "0xd93ca98d540b5ed09ef49e9e035ada3d5236ecb0",
"description": "тест",
"createTime": "2020-11-13 11:38:19",
"modifyTime": "2020-11-13 11:38:19"
}
],
"totalCount": 1
}
б) Неудачный ответ:
{
"code": 105001,
"message": "Системная ошибка",
"data": null
}
а) Протокол сетевой передачи: HTTP
б) Адрес запроса: /fisco-bcos-browser/user/update
в) Метод запроса: PUT
г) Формат возврата: json
| Номер | Входной параметр | Тип | Может быть пустым | Примечание |
|---|---|---|---|---|
| 1 | userId | int | Нет | Уникальный идентификатор пользователя |
| 2 | userName | String | Нет | Имя пользователя |
| 3 | address | String | Нет | Адрес публичного ключа пользователя |
| 4 | description | String | Да | Описание |
| Номер | Выходной параметр | Тип | Может быть пустым | Примечание |
|---|---|---|---|---|
| 1 | code | int | Нет | Информация о коде возврата, см. Приложение 1 |
| 2 | message | String | Нет | Описание |
| 3 | data | Object | Да | Объект с информацией о возврате |
{
"address": "0xd93ca98d540b5ed09ef49e9e035ada3d5236ecb0",
"description": "обновление",
"userId": 700001,
"userName": "alice"
}
а) Успешный ответ:
{
"code": 0,
"message": "успех",
"data": {
"userId": 700001,
"userName": "alice",
"groupId": 1,
"address": "0xd93ca98d540b5ed09ef49e9e035ada3d5236ecb0",
"description": "обновление",
"createTime": "2020-11-13 11:38:19",
"modifyTime": "2020-11-13 11:52:58"
}
}
б) Несоответствие:
{
"code": 105001,
"message": "системная ошибка",
"data": null
}
Удаление пользователя по его ID.
а) Транспортный протокол сети: HTTP протокол
б) Адрес запроса: /fisco-bcos-browser/user/deleteById/{userId}
в) Метод запроса: DELETE
г) Формат возврата: JSON
| № | Входной параметр | Тип | Обязательность | Примечание |
|---|---|---|---|---|
| 1 | userId | int | Да | ID пользователя |
| № | Выходной параметр | Тип | Обязательность | Примечание |
| 1 | code | int | Да | Код возврата, см. Приложение 1 |
| 2 | message | string | Да | Описание |
| 3 | data | object | Да | Элементы возвращаемых данных |
http://localhost:5101/fisco-bcos-browser/user/deleteById/700001
а) Успешный ответ:
{
"code": 0,
"message": "успех",
"data": null
}
б) Несоответствие:```json { "code": 105001, "message": "системная ошибка", "data": null }
# Приложения## 1. Список кодов возврата
| Код | Сообщение | Описание |
|--------|------------------------------------------------|-----------------------------------------------|
| 0 | Успешно | Успешно |
| 105001 | Системная ошибка | Системная ошибка |
| 105002 | Ошибка валидации параметров | Ошибка валидации параметров |
| 205001 | Название группы не может быть пустым | Название группы не может быть пустым |
| 205002 | ID группы не может быть пустым | ID группы не может быть пустым |
| 205003 | ID узла не может быть пустым | ID узла не может быть пустым |
| 205004 | IP адрес узла не может быть пустым | IP адрес узла не может быть пустым |
| 205005 | RPC порт узла не может быть пустым | RPC порт узла не может быть пустым |
| 205006 | P2P порт узла не может быть пустым | P2P порт узла не может быть пустым |
| 205007 | ID пользователя не может быть пустым | ID пользователя не может быть пустым |
| 205008 | Имя пользователя не может быть пустым | Имя пользователя не может быть пустым |
| 205009 | Адрес ключа публичного ключа не может быть пустым | Адрес ключа публичного ключа не может быть пустым |
| 305001 | ID группы уже существует | ID группы уже существует |
| 305002 | Название группы уже существует | Название группы уже существует |
| 305003 | RPC порт и P2P порт узла не могут совпадать | RPC порт и P2P порт узла не могут совпадать |
| 305004 | В этой группе уже есть IP адрес и RPC порт этого узла | В этой группе уже есть IP адрес и RPC порт этого узла |
| 305005 | В этой группе уже есть IP адрес и P2P порт этого узла | В этой группе уже есть IP адрес и P2P порт этого узла |```
| 305006 | ip format error | Ошибка формата IP адреса |
| 305007 | node error or not alive | Ошибка данных узла или узел недоступен |
| 305008 | node do not belong to this group | Данные узла не относятся к данной группе |
| 305009 | the file is empty! | Файл пустой! |
| 305010 | it is not a zip file | Это не архив ZIP |
| 305011 | Ошибка формата файла | file format error |
| 305012 | Архив не может содержать вложенные архивы | zip file can't contain nested zip files |
| 305013 | Отсутствие разрешений на папки | folders permissions missing |
| 305014 | Папка уже существует | folder already exists |
| 305015 | Узел может быть нерабочим, проверьте | Узел может быть нерабочим, проверьте |
| 305016 | Нет прав доступа, проверьте конфигурацию | Нет прав доступа, проверьте конфигурацию |
| 305017 | Групповой ID отсутствует | Групповой ID отсутствует |
| 305018 | Запрошенный номер блока выше последнего | Запрошенный номер блока превышает последний |
| 305101 | Пользователь уже существует | Пользователь уже существует |
| 305102 | Пользовательский ID отсутствует | Пользовательский ID отсутствует |
| 305103 | Адрес публичного ключа недействителен | Адрес публичного ключа недействителен |
Вы можете оставить комментарий после Вход в систему
Неприемлемый контент может быть отображен здесь и не будет показан на странице. Вы можете проверить и изменить его с помощью соответствующей функции редактирования.
Если вы подтверждаете, что содержание не содержит непристойной лексики/перенаправления на рекламу/насилия/вульгарной порнографии/нарушений/пиратства/ложного/незначительного или незаконного контента, связанного с национальными законами и предписаниями, вы можете нажать «Отправить» для подачи апелляции, и мы обработаем ее как можно скорее.
Опубликовать ( 0 )