Skip to content
This repository has been archived by the owner on Sep 28, 2023. It is now read-only.

xcm list support #34

Draft
wants to merge 11 commits into
base: main
Choose a base branch
from
Draft

xcm list support #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
18f2b8a
xcm list support
freehere107 Aug 2, 2022
67a6e16
Merge branch 'main' of github.com:itering/subscan-api-docs into feat/xcm
freehere107 Aug 30, 2022
810e76a
Add xcm channels api
freehere107 Aug 30, 2022
51a0768
Add xcm info api
freehere107 Sep 9, 2022
681c772
Bump xcm list api
freehere107 Sep 14, 2022
19ff1c8
Bump xcm list api
freehere107 Sep 15, 2022
bfd5896
check_hash add xcm_messages support
freehere107 Sep 19, 2022
26cb06b
xcm add message_hash param
freehere107 Oct 24, 2022
42286e1
update xcm/info and message_type
freehere107 Oct 27, 2022
4291d45
Merge branch 'main' of github.com:itering/subscan-api-docs into feat/xcm
freehere107 Nov 2, 2022
d7e1db9
Add xcm/check_hash
freehere107 Nov 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions source/includes/_general.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1172,6 +1172,25 @@ curl -X POST 'https://polkadot.api.subscan.io/api/scan/check_hash' \
}
```

xcm message

```json
{
"code": 0,
"message": "Success",
"generated_at": 1663557135,
"data": {
"hash_type": "xcm_messages",
"messages": [
{
"unique_id": "2be37445d2c64b8042447117715f3d070fcdc297"
}
]
}
}
```


## token

Current network tokens detail
Expand Down
348 changes: 348 additions & 0 deletions source/includes/_xcm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,348 @@
# XCM API (Unstable)

## xcm list

```shell
curl -X POST 'https://polkadot.api.subscan.io/api/scan/xcm/list' \
--header 'Content-Type: application/json' \
--data-raw '{
"row": 10,
"page":0
}'
```

### Request URL

`POST /api/scan/xcm/list`

### Payload

| Parameter | Type | Require | Default | Description |
|-----------------|--------|---------|---------|-----------------------------------------------------------|
| row | INT | yes | | |
| page | INT | NO | | |
| address | string | NO | | send or dest address(ss58 or h160) |
| origin_para_id | INT | NO | | |
| dest_para_id | INT | NO | | |
| extrinsic_index | string | NO | | |
| block_range | string | NO | | block range(like 1-100 or 10000-20000) |
| status | string | NO | | status filter, it can be (pending relayed success failed) |
| protocol | string | NO | | protocol filter, it can be (VMP HRMP UMP DMP) |
| filter_para_id | INT | no | 0 | filter by para_id |
| message_hash | string | no | | filter by message_hash |
| message_type | string | no | | filter by message_type(transfer message) |

> Example Response

```json
{
"code": 0,
"message": "Success",
"generated_at": 1661840427,
"data": {
"count": 1,
"list": [
{
"message_hash": "0x3c7f751839a0f3723511358242e36f30e59800d4fdf0fee20ff54dca2e6b44e1",
"origin_event_index": "1074412-10",
"from_account_id": "1a90d0431b84c3be14bcc627d3d1999ce2146d5280e5dbf49d9525bec916cb55",
"origin_para_id": 2032,
"origin_block_timestamp": 1661685330,
"relayed_block_timestamp": 1661685342,
"block_num": 11800671,
"status": "success",
"relayed_event_index": "11800671-2",
"dest_event_index": "1747720-2",
"dest_para_id": 2004,
"to_account_id": "0x2bf7145b9da25567569c15c57758e6a13bbc00f2",
"confirm_block_timestamp": 1661685348,
"extrinsic_index": "1074412-2",
"relayed_extrinsic_index": "11800671-1",
"dest_extrinsic_index": "1747720-0",
"child_para_id": 0,
"child_dest": "",
"assets": [
{
"enum_key": "Concrete",
"asset_module": "tokens",
"amount": "300000000000",
"decimals": 10,
"symbol": "INTR"
}
]
}
]
}
}
```

## xcm meta

```shell
curl -X POST 'https://polkadot.api.subscan.io/api/scan/xcm/meta' \
--header 'Content-Type: application/json' \
--data-raw '{}'
```

### Request URL

`POST /api/scan/xcm/meta`

### Payload

| Parameter | Type | Require | Default | Description |
|-----------|------|---------|---------|---------------------------|
| para_id | INT | no | 0 | filter parachain metadata |

> Example Response

```json
{
"code": 0,
"message": "Success",
"generated_at": 1661841040,
"data": {
"online_parachain": 0,
"support_parachain": 17,
"open_channel": 2,
"all_channel": 8,
"relayed_transfer_count": 1
}
}
```

## xcm channels

```shell
curl -X POST 'https://polkadot.api.subscan.io/api/scan/xcm/channels' \
--header 'Content-Type: application/json' \
--data-raw '{}'
```

### Request URL

`POST /api/scan/xcm/channels`

### Payload

| Parameter | Type | Require | Default | Description |
|----------------|--------|---------|---------|------------------------------------|
| sender | INT | no | 0 | para_id |
| recipient | INT | no | 0 | para_id |
| status | String | no | | closed accepted canceled requested |
| filter_para_id | INT | no | 0 | filter para_id channel |

> Example Response

```json
{
"code": 0,
"message": "Success",
"generated_at": 1661841178,
"data": {
"list": [
{
"sender": 2012,
"recipient": 1000,
"status": "requested",
"transfer_count": 2,
"active_at": 0,
"proposed_max_capacity": 1000,
"proposed_max_message_size": 102400
}
]
}
}
```

## xcm channel info

```shell
curl -X POST 'https://polkadot.api.subscan.io/api/scan/xcm/channel' \
--header 'Content-Type: application/json' \
--data-raw '{
"sender": 2000,"recipient":2001
}'
```

### Request URL

`POST /api/scan/xcm/channel`

### Payload

| Parameter | Type | Require | Default | Description |
|----------------|--------|---------|---------|------------------------------------|
| sender | INT | yes | 0 | para_id |
| recipient | INT | yes | 0 | para_id |

> Example Response

```json
{
"code": 0,
"message": "Success",
"generated_at": 1661841260,
"data": {
"sender": 2000,
"recipient": 2004,
"status": "accepted",
"transfer_count": 0,
"active_at": 1652243898,
"proposed_max_capacity": 1000,
"proposed_max_message_size": 102400
}
}
```

## xcm stat

```shell
curl -X POST 'https://polkadot.api.subscan.io/api/scan/xcm/stat' \
--header 'Content-Type: application/json' \
--data-raw '{
"start": "2022-08-01","recipient":"2002-08-31"
}'
```

### Request URL

`POST /api/scan/xcm/stat`

### Payload

| Parameter | Type | Require | Default | Description |
|----------------|--------|---------|---------|----------------------|
| start | string | yes | | timeDate(2022-08-01) |
| end | string | yes | | timeDate(2022-08-01) |
| filter_para_id | INT | no | 0 | para_id |

> Example Response

```json
{
"code": 0,
"message": "Success",
"generated_at": 1661841586,
"data": {
"receiver": [
{
"time_utc": "2022-08-31",
"total": 2
}
],
"send": [
{
"time_utc": "2022-08-30",
"total": 1
}
],
"all": [
{
"time_utc": "2022-08-30",
"total": 1
}
]
}
}
```


## xcm info

```shell
curl -X POST 'https://polkadot.api.subscan.io/api/scan/xcm/info' \
--header 'Content-Type: application/json' \
--data-raw '{
"unique_id": "2be37445d2c64b8042447117715f3d070fcdc297"
}'
```

### Request URL

`POST /api/scan/xcm/info`

### Payload

| Parameter | Type | Require | Default | Description |
|-----------|--------|---------|---------|-------------|
| unique_id | string | yes | | |


> Example Response

```json
{
"code": 0,
"message": "Success",
"generated_at": 1662702180,
"data": {
"message_hash": "0x59200eea7a3a3578a29d9196389c5570addc73a7a7e1124dba09abf5c72a70bb",
"origin_event_index": "1523869-36",
"from_account_id": "0x3a531c90e52a02817c0d31794d0ac4ea35a66602",
"origin_para_id": 2004,
"origin_block_timestamp": 1658889546,
"relayed_block_timestamp": 0,
"block_num": 11338971,
"status": "success",
"relayed_event_index": "0-0",
"dest_event_index": "11338971-23",
"dest_para_id": 0,
"to_account_id": "c83bab32181ce772142dda747403916a41bd9cc59d0abe6621636bef36ca8e32",
"confirm_block_timestamp": 1658889558,
"extrinsic_index": "1523869-6",
"relayed_extrinsic_index": "",
"dest_extrinsic_index": "11338971-1",
"child_para_id": 0,
"child_dest": "",
"assets": [
{
"enum_key": "Concrete",
"asset_module": "Balances",
"amount": "40990048395687",
"decimals": 9,
"symbol": "CRAB"
}
]
}
}
```

## xcm-check-hash

```shell
curl -X POST 'https://kusama.api.subscan.io/api/scan/xcm/check_hash' \
--header 'Content-Type: application/json' \
--data-raw '{
"dest_event_id":"2344759-4",
"dest_para_id":2001,
"message_hash":"0x8421ad7e06bade144621069fd70d25ec71dcac3bf3d0703447a3bbc72e248850"
}'
```

### Request URL

`POST /api/scan/xcm/check_hash`

### Payload

| Parameter | Type | Require | Default | Description |
|-----------------|--------|---------|---------|-------------|
| message_hash | string | yes | | |
| dest_event_id | string | no | | |
| dest_para_id | int | no | 0 | |
| origin_event_id | string | no | | |
| origin_para_id | int | no | 0 | |


> Example Response

Will return xcm message unique id
```json
{
"code": 0,
"message": "Success",
"generated_at": 1667373481,
"data": "29b1e4d077e4f29213cf331bed714787ad43452b"
}
```
1 change: 1 addition & 0 deletions source/index.html.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ includes:
- v2
- para
- evm
- xcm
- crust
- assets

Expand Down