Newer
Older
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
required: false
schema:
type: string
description: Block identifier, as the block height or block hash.
format: unsignedInteger or $hex
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/StakingProgress'
"400":
description: invalid blockId supplied for at query param
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/runtime/metadata:
get:
tags:
- runtime
summary: Get the runtime metadata in decoded, JSON form.
description: >-
Returns the runtime metadata as a JSON object.
Substrate Reference:
- FRAME Support: https://crates.parity.io/frame_support/metadata/index.html
- Knowledge Base: https://substrate.dev/docs/en/knowledgebase/runtime/metadata
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
parameters:
- name: at
in: query
description: Block at which to retrieve the metadata at.
required: false
schema:
type: string
description: Block identifier, as the block height or block hash.
format: unsignedInteger or $hex
responses:
"200":
description: successful operation
content:
application/json:
schema:
type: object
description: Response is dependent on the runtime metadata contents.
/runtime/code:
get:
tags:
- runtime
summary: Get the runtime wasm blob.
description: Returns the runtime Wasm blob in hex format.
parameters:
- name: at
in: query
description: Block at which to retrieve the runtime wasm blob at.
required: false
schema:
type: string
description: Block identifier, as the block height or block hash.
format: unsignedInteger or $hex
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/RuntimeCode'
/runtime/spec:
get:
tags:
- runtime
summary: Get version information of the Substrate runtime.
description: Returns version information related to the runtime.
parameters:
- name: at
in: query
description: Block at which to retrieve runtime version information at.
required: false
schema:
type: string
description: Block identifier, as the block height or block hash.
format: unsignedInteger or $hex
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/RuntimeSpec'
/pallets/{palletId}/storage:
get:
tags:
- pallets
summary: Get a list of storage items for a pallet.
description: Returns a list of storage item metadata for storage items of the
specified palletId.
parameters:
- name: palletId
in: path
description: 'Name or index of the pallet to query the storage of. Note: the pallet name must match what is
specified in the runtime metadata.'
required: true
schema:
type: string
- name: adjustMetadataV13
in: query
description: Instruct sidecar to return `StorageEntryType` in the V13 metadata
format rather than V14. This is a **temporary** flag to allow existing systems to migrate.
required: false
schema:
type: boolean
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
- name: onlyIds
in: query
description: Only return the names (IDs) of the storage items instead of all of each storage
item's metadata.
required: false
schema:
type: boolean
- name: at
in: query
description: Block at which to retrieve a list of
the pallet's storage items.
required: false
schema:
type: string
description: Block identifier, as the block height or block hash.
format: unsignedInteger or $hex
responses:
"200":
description: successful operation
content:
application/json:
schema:
type: array
description: Pallet info and Array of storageItemIds.
items:
$ref: '#/components/schemas/PalletStorage'
"400":
description: invalid blockId supplied for at query param
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
"404":
description: could not find pallet with palletId
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/pallets/{palletId}/storage/{storageItemId}:
get:
tags:
- pallets
summary: Get the value of a storage item.
description: Returns the value stored under the storageItemId. If it is a
map, query param key1 is required. If the storage item is double map
query params key1 and key2 are required.
parameters:
- name: palletId
in: path
description: 'Name or index of the pallet to query the storage of. Note: pallet name aligns with
pallet name as specified in runtime metadata.'
required: true
schema:
type: string
- name: storageItemId
in: path
description: Id of the storage item to query for.
required: true
schema:
type: string
- name: adjustMetadataV13
in: query
description: Instruct sidecar to return `StorageEntryType` in the V13 metadata
format rather than V14. This is a **temporary** flag to allow existing systems to migrate.
required: false
schema:
type: boolean
description: Set of N keys used for querying a storage map. It should be queried using the
following format - ?keys[]=key1&keys[]=key2. Order matters, as it will determine the
order the keys are passed into the storage calls.
required: false
schema:
type: array
items:
type: string
description: An array of storage keys.
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
- name: at
in: query
description: Block at which to query the storage item at.
required: false
schema:
type: string
description: Block identifier, as the block height or block hash.
format: unsignedInteger or $hex
- name: metadata
in: query
description: Include the storage items metadata (including documentation)
if set to true.
required: false
schema:
default: false
type: boolean
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/PalletStorageItem'
"400":
description: invalid blockId supplied for at query param
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
"404":
description: could not find resource with with id
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
get:
tags:
- paras
summary: |
List all registered paras (parathreads & parachains).
description: Returns all registered parachains and parathreads with lifecycle info.
parameters:
- name: at
in: query
description: Block at which to retrieve paras list at.
required: false
schema:
type: string
description: Block identifier, as the block height or block hash.
format: unsignedInteger or $hex
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Paras'
/paras/leases/current:
get:
tags:
- paras
summary: |
Get general information about the current lease period.
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
description: |
Returns an overview of the current lease period, including lease holders.
parameters:
- name: at
in: query
description: Block at which to retrieve current lease period info at.
required: false
schema:
type: string
description: Block identifier, as the block height or block hash.
format: unsignedInteger or $hex
- name: currentLeaseHolders
in: query
description: |
Wether or not to include the `currentLeaseHolders` property. Inclusion
of the property will likely result in a larger payload and increased
response time.
required: false
schema:
type: boolean
default: true
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ParasLeasesCurrent'
/paras/auctions/current:
get:
tags:
- paras
summary: |
Get the status of the current auction.
Returns an overview of the current auction. There is only one auction
at a time. If there is no auction most fields will be `null`. If the current
auction phase is in `vrfDelay` and you are looking to retrieve the latest winning
bids, it is advised to query one block before `finishEnd` in the `endingPeriod` phase
for that auction as there technically are no winners during the `vrfDelay` and thus
the field is `null`.
parameters:
- name: at
in: query
description: Block at which to retrieve auction progress at.
required: false
schema:
type: string
description: Block identifier, as the block height or block hash.
format: unsignedInteger or $hex
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ParasAuctionsCurrent'
get:
tags:
- paras
summary: |
List all stored crowdloans.
description: |
Returns a list of all the crowdloans and their associated paraIds.
parameters:
- name: at
in: query
description: Block at which to retrieve the list of paraIds that have crowdloans at.
required: false
schema:
type: string
description: Block identifier, as the block height or block hash.
format: unsignedInteger or $hex
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ParasCrowdloans'
/paras/{paraId}/crowdloan-info:
Get crowdloan information for a `paraId`.
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
description: |
Returns crowdloan's `fundInfo` and the set of `leasePeriods` the crowdloan`
covers.
parameters:
- name: paraId
in: path
description: paraId to query the crowdloan information of.
required: true
schema:
type: number
- name: at
in: query
description: Block at which to retrieve info at.
required: false
schema:
type: string
description: Block identifier, as the block height or block hash.
format: unsignedInteger or $hex
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ParasCrowdloanInfo'
/paras/{paraId}/lease-info:
get:
tags:
- paras
summary: |
Get current and future leases as well as the lifecycle stage for a given `paraId`.
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
description: |
Returns a list of leases that belong to the `paraId` as well as the
`paraId`'s current lifecycle stage.
parameters:
- name: paraId
in: path
description: paraId to query the crowdloan information of.
required: true
schema:
type: number
- name: at
in: query
description: Block at which to retrieve para's leases at.
required: false
schema:
type: string
description: Block identifier, as the block height or block hash.
format: unsignedInteger or $hex
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ParasLeaseInfo'
Tarik Gul
committed
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
/paras/head/included-candidates:
get:
tags:
- paras
summary: |
Get the heads of the included (backed and considered available) parachain candidates at the
specified block height or at the most recent finalized head otherwise.
description: |
Returns an object with all the parachain id's as keys, and their headers as values.
parameters:
- name: at
in: query
description: Block at which to retrieve para's heads at.
required: false
schema:
type: string
description: Block identifier, as the block height or block hash.
format: unsignedInteger or $hex
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ParasHeaders'
/paras/head/backed-candidates:
get:
tags:
- paras
summary: |
Get the heads of the backed parachain candidates at the specified block height or at the most recent finalized head otherwise.
description: |
Returns an object with all the parachain id's as keys, and their headers as values.
parameters:
- name: at
in: query
description: Block at which to retrieve para's heads at.
required: false
schema:
type: string
description: Block identifier, as the block height or block hash.
format: unsignedInteger or $hex
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ParasHeaders'
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
/experimental/blocks/head/traces:
get:
tags:
- trace
summary: |
[Experimental - subject to breaking change.] Get traces for the most
recently finalized block.
description: |
Returns traces (spans and events) of the most recently finalized block from
RPC `state_straceBlock`. Consult the [RPC docs](https://github.com/paritytech/substrate/blob/aba876001651506f85c14baf26e006b36092e1a0/client/rpc-api/src/state/mod.rs#L140)
for conceptual info.
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/BlocksTrace'
/experimental/blocks/{blockId}/traces:
get:
tags:
- trace
summary: |
[Experimental - subject to breaking change.] Get traces for the given `blockId`.
description: |
Returns traces (spans and events) of the specified block from
RPC `state_straceBlock`. Consult the [RPC docs](https://github.com/paritytech/substrate/blob/aba876001651506f85c14baf26e006b36092e1a0/client/rpc-api/src/state/mod.rs#L140) for conceptual info.
parameters:
- name: blockId
in: path
description: Block identifier, as the block height or block hash.
required: true
schema:
pattern: 'a-km-zA-HJ-NP-Z1-9{8,64}'
type: string
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/BlocksTrace'
/experimental/blocks/head/traces/operations:
get:
tags:
- trace
summary: |
[Experimental - subject to breaking change.] Get the operations from the
most recently finalized block.
description: |
Returns the operations from the most recently finalized block. Operations
represent one side of a balance change. For example if Alice transfers
100unit to Bob there will be two operations; 1) Alice - 100 2) Bob + 100.
Given account A and A's balance at block k0 (Ak0), if we sum all the
operations for A from block k1 through kn against Ak0, we will end up
with A's balance at block kn (Akn). Thus, operations can be used to audit
that balances change as expected.
This is useful for Substrate based chains because the advanced business
logic can make it difficult to ensure auditable balance reconciliation
based purely on events. Instead of using events one can use the
operations given from this endpoint.
Note - each operation corresponds to a delta of a single field of the
`system::AccountData` storage item (i.e `free`, `reserved`, `misc_frozen`
and `fee_frozen`).
Note - operations are assigned a block execution phase (and extrinsic index
for those in the apply extrinsic phase) based on an "action group". For
example all the operations for 1 extrinsic will be in the same action group.
The action groups can optionally be fetched with the `action` query param
for closer auditing.
Note - There are no 0 value operations (e.g. a transfer of 0, or a
transfer to itself)
To learn more about operation and action group creation please consult
[this diagram](https://docs.google.com/drawings/d/1vZoJo9jaXlz0LmrdTOgHck9_1LsfuQPRmTr-5g1tOis/edit?usp=sharing)
parameters:
- name: actions
in: query
description: Whether or not to include action groups.
required: false
schema:
type: boolean
default: false
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/BlocksTraceOperations'
/experimental/blocks/{blockId}/traces/operations:
get:
tags:
- trace
summary: |
[Experimental - subject to breaking change.] Get the operations from the
specified block.
description: |
Returns the operations from the most recently finalized block. Operations
represent one side of a balance change. For example if Alice transfers
100unit to Bob there will be two operations; 1) Alice - 100 2) Bob + 100.
Given account A and A's balance at block k0 (Ak0), if we sum all the
operations for A from block k1 through kn against Ak0, we will end up
with A's balance at block kn (Akn). Thus, operations can be used to audit
that balances change as expected.
This is useful for Substrate based chains because the advanced business
logic can make it difficult to ensure auditable balance reconciliation
based purely on events. Instead of using events one can use the
operations given from this endpoint.
Note - each operation corresponds to a delta of a single field of the
`system::AccountData` storage item (i.e `free`, `reserved`, `misc_frozen`
and `fee_frozen`).
Note - operations are assigned a block execution phase (and extrinsic index
for those in the apply extrinsic phase) based on an "action group". For
example all the operations for 1 extrinsic will be in the same action group.
The action groups can optionally be fetched with the `action` query param
for closer auditing.
Note - There are no 0 value operations (e.g. a transfer of 0, or a
transfer to itself)
To learn more about operation and action group creation please consult
[this diagram](https://docs.google.com/drawings/d/1vZoJo9jaXlz0LmrdTOgHck9_1LsfuQPRmTr-5g1tOis/edit?usp=sharing)
parameters:
- name: blockId
in: path
description: Block identifier, as the block height or block hash.
required: true
schema:
pattern: 'a-km-zA-HJ-NP-Z1-9{8,64}'
type: string
- name: actions
in: query
description: Whether or not to include action groups.
required: false
schema:
type: boolean
default: false
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/BlocksTraceOperations'
components:
schemas:
type: object
properties:
at:
$ref: '#/components/schemas/BlockIdentifiers'
amount:
type: string
description: The amount of funds approved for the balance transfer from the owner
to some delegated target.
format: unsignedInteger
description: The amount reserved on the owner's account to hold this item in storage.
format: unsignedInteger
AccountAssetsBalances:
type: object
properties:
at:
$ref: '#/components/schemas/BlockIdentifiers'
assets:
type: array
description: An array of queried assets.
items:
$ref: '#/components/schemas/AssetsBalance'
AccountBalanceInfo:
type: object
properties:
at:
$ref: '#/components/schemas/BlockIdentifiers'
nonce:
type: string
description: Account nonce.
format: unsignedInteger
tokenSymbol:
type: string
description: Token symbol of the balances displayed in this response.
format: unsignedInteger
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
free:
type: string
description: Free balance of the account. Not equivalent to _spendable_
balance. This is the only balance that matters in terms of most operations
on tokens.
format: unsignedInteger
reserved:
type: string
description: Reserved balance of the account.
format: unsignedInteger
miscFrozen:
type: string
description: The amount that `free` may not drop below when withdrawing
for anything except transaction fee payment.
format: unsignedInteger
feeFrozen:
type: string
description: The amount that `free` may not drop below when withdrawing
specifically for transaction fee payment.
format: unsignedInteger
locks:
type: array
description: Array of locks on a balance. There can be many of these on
an account and they "overlap", so the same balance is frozen by multiple
locks
items:
$ref: '#/components/schemas/BalanceLock'
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
AccountConvert:
type: object
properties:
ss58Prefix:
type: string
description: SS58 prefix based on which the account ID or Public Key (hex) is converted to an SS58 address.
format: unsignedInteger
network:
type: string
description: The network based on which the returned address is encoded. It depends on the prefix
that was given as a query param.
address:
type: string
description: The returned SS58 address which is the result of the conversion
of the account ID or Public Key (hex).
accountId:
type: string
description: The given account ID or Public Key (hex) that is converted to an SS58 address.
scheme:
type: string
description: The cryptographic scheme/algorithm used to encode the given account ID or Public Key (hex).
publicKey:
type: boolean
description: Whether the given path parameter is a Public Key (hex) or not.
type: object
properties:
at:
$ref: '#/components/schemas/BlockIdentifiers'
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
rewardDestination:
type: string
description: The account to which rewards will be paid. Can be 'Staked' (Stash
account, adding to the amount at stake), 'Stash' (Stash address, not
adding to the amount at stake), or 'Controller' (Controller address).
format: ss58
enum:
- Staked
- Stash
- Controller
controller:
type: string
description: Controller address for the given Stash.
format: ss58
numSlashingSpans:
type: string
description: Number of slashing spans on Stash account; `null` if provided address
is not a Controller.
format: unsignedInteger
nominations:
$ref: '#/components/schemas/Nominations'
stakingLedger:
$ref: '#/components/schemas/StakingLedger'
description: >-
Note: Runtime versions of Kusama less than 1062 will either have `lastReward` in place of
`claimedRewards`, or no field at all. This is related to changes in reward distribution. See: [Lazy Payouts](https://github.com/paritytech/substrate/pull/4474), [Simple Payouts](https://github.com/paritytech/substrate/pull/5406)
AccountStakingPayouts:
type: object
properties:
at:
$ref: '#/components/schemas/BlockIdentifiers'
erasPayouts:
type: object
properties:
era:
type: string
format: unsignedInteger
description: Era this information is associated with.
totalEraRewardPoints:
type: string
format: unsignedInteger
description: Total reward points for the era. Equals the sum of
reward points for all the validators in the set.
totalEraPayout:
type: string
format: unsignedInteger
description: Total payout for the era. Validators split the payout
based on the portion of `totalEraRewardPoints` they have.
payouts:
$ref: '#/components/schemas/Payouts'
AccountValidation:
type: object
properties:
isValid:
type: boolean
description: Whether the given address is valid ss58 formatted.
ss58Prefix:
type: string
description: SS58 prefix of the given address. If the address is a valid
base58 format, but incorrect ss58, a prefix for the given address will still be returned.
format: unsignedInteger
Dominique
committed
network:
type: string
description: The network based on which the given address is encoded.
accountId:
type: string
description: The account id of the given address.
AccountVestingInfo:
type: object
description: Sidecar version's <= v10.0.0 have a`vesting` return value that defaults to an object for
when there is no available vesting-info data. It also returns a `VestingInfo` as an object.
For Sidecar >=11.0.0, that value will now default as an array when there is no value, and `Vec<PalletsPalletVestingInfo>`
is returned when there is.
properties:
at:
$ref: '#/components/schemas/BlockIdentifiers'
vesting:
$ref: '#/components/schemas/VestingSchedule'
AssetsBalance:
type: object
properties:
assetId:
type: string
description: The identifier of the asset.
format: unsignedInteger
type: string
description: The balance of the asset.
format: unsignedInteger
type: boolean
description: Whether the asset is frozen for non-admin transfers.
type: boolean
description: Whether a non-zero balance of this asset is a deposit of sufficient
value to account for the state bloat associated with its balance storage. If set to
`true`, then non-zero balances may be stored without a `consumer` reference (and thus
an ED in the Balances pallet or whatever else is used to control user-account state
growth).
AssetInfo:
type: object
properties:
owner:
type: string
description: Owner of the assets privileges.
format: SS58
type: string
description: The `AccountId` able to mint tokens.
format: SS58
type: string
description: The `AccountId` that can thaw tokens, force transfers and burn token from
any account.
format: SS58
type: string
description: The `AccountId` that can freeze tokens.
format: SS58
type: string
description: The total supply across accounts.
format: unsignedInteger
type: string
description: The balance deposited for this. This pays for the data stored.
format: unsignedInteger
type: string
description: The ED for virtual accounts.
format: unsignedInteger
type: boolean
description: If `true`, then any account with this asset is given a provider reference. Otherwise, it
requires a consumer reference.
type: string
description: The total number of accounts.
format: unsignedInteger
type: string
description: The total number of accounts for which is placed a self-sufficient reference.
type: string
description: The total number of approvals.
format: unsignedInteger
isFrozen:
type: boolean
description: Whether the asset is frozen for non-admin transfers.
AssetMetadata:
type: object
properties:
type: string
description: The balance deposited for this metadata. This pays for the data
stored in this struct.
format: unsignedInteger
type: string
description: The user friendly name of this asset.
format: $hex
type: string
description: The ticker symbol for this asset.
format: $hex
decimals:
type: string
description: The number of decimals this asset uses to represent one unit.
format: unsignedInteger
type: boolean
description: Whether the asset metadata may be changed by a non Force origin.
type: object
properties:
description: An identifier for this lock. Only one lock may be in existence
for each identifier.
amount:
description: The amount below which the free balance may not drop with this
lock in effect.
format: unsignedInteger
description: Reasons for withdrawing balance.
enum:
- Fee = 0
- Misc = 1
- All = 2
Block:
type: object
properties:
hash:
description: The block's hash.
format: hex
number:
type: string
description: The block's height.
format: unsignedInteger
parentHash:
type: string
description: The hash of the parent block.
format: hex
stateRoot:
type: string
description: The state root after executing this block.
format: hex
extrinsicRoot:
type: string
description: The Merkle root of the extrinsics.
format: hex
authorId:
type: string
description: The account ID of the block author (may be undefined for some
chains).
format: ss58
logs:
type: array
items:
$ref: '#/components/schemas/DigestItem'
description: Array of `DigestItem`s associated with the block.
onInitialize:
$ref: '#/components/schemas/BlockInitialize'
extrinsics:
type: array
description: Array of extrinsics (inherents and transactions) within the
block.
items:
$ref: '#/components/schemas/Extrinsic'
onFinalize:
$ref: '#/components/schemas/BlockFinalize'
finalized:
type: boolean
description: >-
A boolean identifying whether the block is finalized or not.
Note: on chains that do not have deterministic finality this field is omitted.
description: >-
Note: Block finalization does not correspond to consensus, i.e. whether
the block is in the canonical chain. It denotes the finalization of block
_construction._
Blocks:
type: array
items:
$ref: '#/components/schemas/Block'
type: object
properties:
type: array
items:
$ref: '#/components/schemas/SanitizedEvent'
description: Object with an array of `SanitizedEvent`s that occurred during
block construction finalization with the `method` and `data` for each.
BlockHeader:
type: object
properties:
description: The hash of the parent block.
format: hex
number:
description: The block's height.
format: unsignedInteger
description: The state root after executing this block.
format: hex
extrinsicRoot:
description: The Merkle root of the extrinsics.
format: hex
digest:
type: object
logs:
type: array
items:
$ref: '#/components/schemas/DigestItem'
description: Array of `DigestItem`s associated with the block.
BlockIdentifiers:
type: object
properties:
hash:
type: string
description: The block's hash.
format: hex
height:
type: string
description: The block's height.
format: unsignedInteger
description: Block number and hash at which the call was made.
type: object
properties:
events:
type: array
items:
$ref: '#/components/schemas/SanitizedEvent'
description: Object with an array of `SanitizedEvent`s that occurred during
block initialization with the `method` and `data` for each.
BlocksTrace: