Newer
Older
format: unsignedInteger
unlocking:
type: string
description: Any balance that is becoming free, which may eventually be
transferred out of the _Stash_ (assuming it doesn't get slashed first).
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
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
Represented as an array of objects, each with an `era` at which `value`
will be unlocked.
format: unsignedInteger
claimedRewards:
type: array
description: Array of eras for which the stakers behind a validator have
claimed rewards. Only updated for _validators._
items:
type: string
format: unsignedInteger
description: The staking ledger.
Nominations:
type: object
properties:
targets:
type: array
items:
type: string
description: The targets of the nomination.
submittedIn:
type: string
format: unsignedInteger
description: >-
The era the nominations were submitted. (Except for initial
nominations which are considered submitted at era 0.)
suppressed:
type: boolean
description: Whether the nominations have been suppressed.
AccountStakingInfo:
type: object
properties:
at:
$ref: '#/components/schemas/BlockIdentifiers'
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)
type: array
items:
type: object
properties:
type: string
description: AccountId of the validator the payout is coming from.
nominatorStakingPayout:
type: string
format: unsignedInteger
description: Payout for the reward destination associated with the
accountId the query was made for.
claimed:
type: boolean
description: Whether or not the reward has been claimed.
totalValidatorRewardPoints:
type: string
format: unsignedInteger
description: Number of reward points earned by the validator.
validatorCommission:
type: string
format: unsignedInteger
description: The percentage of the total payout that the validator takes as commission,
expressed as a Perbill.
totalValidatorExposure:
type: string
format: unsignedInteger
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
description: The sum of the validator's and its nominators' stake.
nominatorExposure:
type: string
format: unsignedInteger
description: The amount of stake the nominator has behind the validator.
description: Payout for a nominating _Stash_ address and
information about the validator they were nominating.
AccountStakingPayouts:
type: object
properties:
at:
$ref: '#/components/schemas/BlockIdentifiers'
erasPayouts:
type: array
items:
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'
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
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
VestingSchedule:
type: object
properties:
locked:
type: string
description: Number of tokens locked at start.
format: unsignedInteger
perBlock:
type: string
description: Number of tokens that gets unlocked every block after `startingBlock`.
format: unsignedInteger
startingBlock:
type: string
description: Starting block for unlocking (vesting).
format: unsignedInteger
description: Vesting schedule for an account.
AccountVestingInfo:
type: object
properties:
at:
$ref: '#/components/schemas/BlockIdentifiers'
vesting:
$ref: '#/components/schemas/VestingSchedule'
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.
DigestItem:
type: object
properties:
type:
type: string
index:
type: string
format: unsignedInteger
value:
type: array
items:
type: string
SanitizedEvent:
type: object
properties:
method:
type: string
data:
type: array
items:
type: string
Signature:
type: object
properties:
signature:
type: string
format: hex
signer:
type: string
format: ss58
description: Object with `signature` and `signer`, or `null` if unsigned.
RuntimeDispatchInfo:
type: object
properties:
weight:
type: string
description: Extrinsic weight.
class:
type: string
description: Extrinsic class.
enum:
- Normal
- Operational
- Mandatory
partialFee:
type: string
description: The _inclusion fee_ of a transaction, i.e. the minimum fee required for a transaction. Includes weight and encoded length fees, but does not have access to any signed extensions, e.g. the `tip`.
format: unsignedInteger
description: RuntimeDispatchInfo for the transaction. Includes the `partialFee`.
ExtrinsicMethod:
type: object
properties:
pallet:
type: string
type: string
description: Extrinsic method
Extrinsic:
type: object
properties:
method:
$ref: '#/components/schemas/ExtrinsicMethod'
signature:
$ref: '#/components/schemas/Signature'
nonce:
type: string
description: Account nonce, if applicable.
format: unsignedInteger
args:
type: object
description: >-
Object of arguments keyed by parameter name. Note: if you are expecting an [`OpaqueCall`](https://substrate.dev/rustdocs/v2.0.0/pallet_multisig/type.OpaqueCall.html)
and it is not decoded in the response (i.e. it is just a hex string), then Sidecar was
not able to decode it and likely that it is not a valid call for the runtime.
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
tip:
type: string
description: Any tip added to the transaction.
format: unsignedInteger
hash:
type: string
description: The transaction's hash.
format: hex
info:
$ref: '#/components/schemas/RuntimeDispatchInfo'
events:
type: array
description: An array of `SanitizedEvent`s that occurred during extrinsic
execution.
items:
$ref: '#/components/schemas/SanitizedEvent'
success:
type: boolean
description: Whether or not the extrinsic succeeded.
paysFee:
type: boolean
description: Whether the extrinsic requires a fee. Careful! This field relates
to whether or not the extrinsic requires a fee if called as a transaction.
Block authors could insert the extrinsic as an inherent in the block
and not pay a fee. Always check that `paysFee` is `true` and that the
extrinsic is signed when reconciling old blocks.
ExtrinsicIndex:
type: object
properties:
at:
$ref: '#/components/schemas/BlockIdentifiers'
extrinsic:
$ref: '#/components/schemas/Extrinsic'
description: A single extrinsic at a given block.
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
BlockInitialize:
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.
BlockFinalize:
type: object
properties:
events:
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.
Block:
type: object
properties:
hash:
type: string
description: The block's hash.
format: hex
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
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._
NodeVersion:
type: object
properties:
clientImplName:
type: string
description: Node's implementation name.
chain:
type: string
description: Version information of the node.
NodeRole:
type: string
description: Role of this node. (N.B. Sentry nodes are being deprecated.)
enum:
- Full
- LightClient
- Authority
- Sentry
PeerInfo:
type: object
properties:
peerId:
type: string
description: Peer ID.
roles:
type: string
protocolVersion:
type: string
format: unsignedInteger
bestHash:
type: string
description: Hash of the best block on the peer's canon chain.
format: hex
bestNumber:
type: string
description: Height of the best block on the peer's canon chain.
format: unsignedInteger
NodeNetwork:
type: object
properties:
nodeRoles:
$ref: '#/components/schemas/NodeRole'
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
type: string
description: Number of peers the node is connected to.
format: unsignedInteger
isSyncing:
type: boolean
description: Whether or not the node is syncing. `False` indicates that the node is in sync.
shouldHavePeers:
type: boolean
description: Whether or not the node should be connected to peers. Might be false
for local chains or when running without discovery.
localPeerId:
type: string
description: Local copy of the `PeerId`.
localListenAddresses:
type: array
description: Multiaddresses that the local node is listening on. The addresses
include a trailing `/p2p/` with the local PeerId, and are thus suitable
to be passed to `system_addReservedPeer` or as a bootnode address for
example.
items:
type: string
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
type: array
items:
$ref: '#/components/schemas/PeerInfo'
RuntimeSpec:
type: object
properties:
at:
$ref: '#/components/schemas/BlockIdentifiers'
authoringVersion:
type: string
description: The version of the authorship interface. An authoring node
will not attempt to author blocks unless this is equal to its native runtime.
chainType:
type: string
description: Type of the chain.
enum:
- Development
- Local
- Live
implVersion:
type: string
description: Version of the implementation specification. Non-consensus-breaking
optimizations are about the only changes that could be made which would
result in only the `impl_version` changing. The `impl_version` is set to 0
when `spec_version` is incremented.
specName:
type: string
description: Identifies the different Substrate runtimes.
specVersion:
type: string
description: Version of the runtime specification.
transactionVersion:
1441
1442
1443
1444
1445
1446
1447
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
type: string
description: All existing dispatches are fully compatible when this number
doesn't change. This number must change when an existing dispatchable
(module ID, dispatch ID) is changed, either through an alteration in its
user-level semantics, a parameter added/removed/changed, a dispatchable
being removed, a module being removed, or a dispatchable/module changing
its index.
properties:
type: object
description: Arbitrary properties defined in the chain spec.
description: Version information related to the runtime.
UnappliedSlash:
type: object
properties:
validator:
type: string
description: Stash account ID of the offending validator.
format: ss58
own:
type: string
description: The amount the validator will be slashed.
format: unsignedInteger
others:
type: array
description: Array of tuples(`[accountId, amount]`) representing all the
stashes of other slashed stakers and the amount they will be slashed.
items:
type: string
format: tuple[ss58, unsignedInteger]
reporters:
type: array
description: Array of account IDs of the reporters of the offense.
items:
type: string
format: ss58
payout:
type: string
description: Amount of bounty payout to reporters.
format: unsignedInteger
ElectionStatus:
type: object
properties:
status:
type: object
description: >-
[Deprecated](Works for polkadot runtimes before v0.8.30).
Era election status: either `Close: null` or `Open: <BlockNumber>`.
A status of `Close` indicates that the submission window for solutions
from off-chain Phragmen is not open. A status of `Open` indicates that the
submission window for off-chain Phragmen solutions has been open since
BlockNumber. N.B. when the submission window is open, certain
extrinsics are not allowed because they would mutate the state that the
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
off-chain Phragmen calculation relies on for calculating results.
toggleEstimate:
type: string
description: Upper bound estimate of the block height at which the `status`
will switch.
format: unsignedInteger
description: Information about the off-chain election. Not included in response when
`forceEra.isForceNone`.
StakingProgress:
type: object
properties:
at:
$ref: '#/components/schemas/BlockIdentifiers'
activeEra:
type: string
description: |
`EraIndex` of the era being rewarded.
format: unsignedInteger
forceEra:
type: string
description: Current status of era forcing.
enum:
- ForceNone
- NotForcing
- ForceAlways
- ForceNew
nextActiveEraEstimate:
type: string
description: Upper bound estimate of the block height at which the next
active era will start. Not included in response when `forceEra.isForceNone`.
format: unsignedInteger
nextSessionEstimate:
type: string
description: Upper bound estimate of the block height at which the next
session will start.
format: unsignedInteger
unappliedSlashes:
type: array
items:
$ref: '#/components/schemas/UnappliedSlash'
description: Array of upcoming `UnappliedSlash` indexed by era.
electionStatus:
$ref: '#/components/schemas/ElectionStatus'
idealValidatorCount:
type: string
description: Upper bound of validator set size; considered the ideal size.
Not included in response when `forceEra.isForceNone`.
format: unsignedInteger
validatorSet:
type: array
description: Stash account IDs of the validators for the current session.
Not included in response when `forceEra.isForceNone`.
items:
type: string
format: ss58
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
TransactionDryRun:
type: object
properties:
resultType:
type: string
enum:
- DispatchOutcome
- TransactionValidityError
description: Either `DispatchOutcome` if the transaction is valid or `TransactionValidityError` if the result is invalid.
result:
type: string
enum:
- Ok
- CannotLookup
- NoUnsignedValidator
- Custom(u8)
- Call
- Payment
- Future
- Stale
- BadProof
- AncientBirthBlock
- ExhaustsResources
- BadMandatory
- MandatoryDispatch
description: 'If there was an error it will be the cause of the error. If the
transaction executed correctly it will be `Ok: []`'
validityErrorType:
type: string
enum:
- InvalidTransaction
- UnknownTransaction
description: >-
References:
- `UnknownTransaction`: https://crates.parity.io/sp_runtime/transaction_validity/enum.UnknownTransaction.html
- `InvalidTransaction`: https://crates.parity.io/sp_runtime/transaction_validity/enum.InvalidTransaction.html
Transaction:
type: object
properties:
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
type: string
format: hex
TransactionMaterial:
type: object
properties:
at:
$ref: '#/components/schemas/BlockIdentifiers'
genesisHash:
type: string
description: The hash of the chain's genesis block.
format: blockHash
chainName:
type: string
description: The chain's name.
specName:
type: string
description: The chain's spec.
specVersion:
type: string
description: The spec version. Always increased in a runtime upgrade.
txVersion:
type: string
description: The transaction version. Common `txVersion` numbers indicate
that the transaction encoding format and method indices are the same.
Needed for decoding in an offline environment. Adding new transactions
does not change `txVersion`.
metadata:
type: string
description: The chain's metadata in hex format.
description: >-
Note: `chainName`, `specName`, and `specVersion` are used to define a type registry with a set
of signed extensions and types. For Polkadot and Kusama, `chainName` is not used in defining
this registry, but in other Substrate-based chains that re-launch their network without
changing the `specName`, the `chainName` would be needed to create the correct registry.
Substrate Reference:
- `RuntimeVersion`: https://crates.parity.io/sp_version/struct.RuntimeVersion.html
- `SignedExtension`: https://crates.parity.io/sp_runtime/traits/trait.SignedExtension.html
- FRAME Support: https://crates.parity.io/frame_support/metadata/index.html
TransactionSuccess:
type: object
properties:
type: string
description: The hash of the encoded transaction.
TransactionFailedToParse:
type: object
properties:
code:
type: number
type: string
description: >-
`Failed to parse a tx.`
transaction:
type: string
format: hex
cause:
type: string
stack:
type: string
description: Error message when Sidecar fails to parse the transaction.
TransactionFailedToSubmit:
type: object
properties:
code:
type: number
description: Failed to submit transaction.
transaction:
type: string
format: hex
cause:
type: string
stack:
type: string
description: >-
Error message when the node rejects the submitted transaction.
TransactionFailure:
oneOf:
- $ref: '#/components/schemas/TransactionFailedToSubmit'
- $ref: '#/components/schemas/TransactionFailedToParse'
TransactionFeeEstimateFailure:
type: object
properties:
code:
type: number
at:
type: object
properties:
hash:
type: string
error:
description: Error description.
transaction:
type: string
format: hex
block:
type: string
description: Block hash of the block fee estimation was attempted at.
cause:
type: string
description: Error message from the client.
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
stack:
type: string
TransactionFeeEstimate:
type: object
properties:
weight:
type: string
description: Extrinsic weight.
class:
type: string
description: Extrinsic class.
enum:
- Normal
- Operational
- Mandatory
partialFee:
type: string
description: Expected inclusion fee for the transaction. Note that the fee
rate changes up to 30% in a 24 hour period and this will not be the exact
fee.
format: unsignedInteger
description: >-
Note: `partialFee` does not include any tips that you may add to increase a transaction's
priority. See [compute_fee](https://crates.parity.io/pallet_transaction_payment/struct.Module.html#method.compute_fee).
TransactionPool:
type: object
properties:
pool:
type: array
items:
type: object
properties:
hash:
type: string
format: hex
description: H256 hash of the extrinsic.
encodedExtrinsic:
type: string
format: hex
description: Scale encoded extrinsic.
RuntimeCode:
type: object
properties:
at:
$ref: '#/components/schemas/BlockIdentifiers'
code:
type: string
format: hex
Error:
type: object
properties:
code:
type: number
message:
type: string
stack:
type: string
PalletStorageType:
type: object
description: Info about the data structure used for storage.
example:
Map:
hasher: "Twox64Concat"
key:
example: "ReferendumIndex"
value: "ReferendumInfo"
linked: false
PalletStorageItemMetadata:
type: object
properties:
name:
type: string
example: "ReferendumInfoOf"
description: The storage item's name (which is the same as the storage item's ID).
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
modifier:
type: string
example: "Optional"
type:
$ref: '#/components/schemas/PalletStorageType'
fallback:
type: string
example: "0x00"
documentation:
type: string
example: " Information concerning any given referendum.\n\n TWOX-NOTE: SAFE as indexes are not under an attacker’s control."
description: Metadata of a storage item from a FRAME pallet.
PalletStorageItem:
type: object
properties:
at:
$ref: '#/components/schemas/BlockIdentifiers'
pallet:
type: string
description: Name of the pallet.
example: "democracy"
palletIndex:
type: string
description: Index of the pallet for looking up storage.
example: "15"
storageItem:
type: string
description: Name of the storage item.
example: "referendumInfoOf"
key1:
type: string
description: Key1 query param. Will not show up in response unless it was passed as part of the URI.
example: "2"
key2:
type: string
description: Key2 query param. Will not show up in response if not defined in URI.
example: ""
value:
type: object
description: Value returned by this storage query.
example:
Ongoing:
end: "1612800"
proposalHash: "0x7de70fc8be782076d0b5772be77153d172a5381c72dd56d3385e25f62abf507e"
threshold: "Supermajorityapproval"
delay: "403200"
tally:
ayes: "41925212461400000"
nays: "214535586500000"
turnout: "34485320658000000"
metadata:
$ref: '#/components/schemas/PalletStorageItemMetadata'
PalletStorage:
type: object
properties:
pallet:
type: string
description: Name of the pallet.
example: "democracy"
palletIndex:
type: string
description: Index of the pallet for looking up storage.
example: "15"
items:
type: array
items:
$ref: '#/components/schemas/PalletStorageItemMetadata'
description: Array containing metadata for each storage entry of the pallet.
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
ParaLifecycle:
type: string
enum:
- onboarding
- parathread
- parachain
- upgradingParathread
- downgradingParachain
- offboardingParathread
- offboardingParachain
description: |
The possible states of a para, to take into account delayed lifecycle
changes.
OnboardingAs:
type: string
enum:
- parachain
- parathread
description: |
This property only shows up when `paraLifecycle=onboarding`. It
describes if a particular para is onboarding as a `parachain` or a
`parathread`.
Para:
type: object
properties:
paraId:
type: string
format: unsignedInteger
paraLifecycle:
$ref: '#/components/schemas/ParaLifecycle'
onboardingAs:
$ref: '#/components/schemas/OnboardingAs'
Paras:
type: object
properties:
at:
$ref: '#/components/schemas/BlockIdentifiers'
paras:
type: array
items:
$ref: '#/components/schemas/Para'
ParasLeasesCurrent:
type: object
properties:
at:
$ref: '#/components/schemas/BlockIdentifiers'
leasePeriodIndex:
type: string
format: unsignedInteger
description: Current lease period index.
endOfLeasePeriod:
type: string
format: unsignedInteger
description: Last block (number) of the current lease period.
currentLeaseHolders:
type: array
items:
type: string
format: unsignedInteger
description: List of `paraId`s that currently hold a lease.
WinningData:
type: object
properties:
bid:
type: object
properties:
accountId:
type: string
paraId:
type: string
format: unsignedInteger
amount:
type: string
format: unsignedInteger
leaseSet:
type: array
items:
type: string
format: unsignedInteger
description: |
A currently winning bid and the set of lease periods the bid is for. The
`amount` of the bid is per lease period. The `bid` property will be `null`
if no bid has been made for the corresponding `leaseSet`.
ParasAuctionsCurrent:
type: object
properties:
at:
$ref: '#/components/schemas/BlockIdentifiers'
beginEnd:
type: string
format: unisgnedInteger or $null
description: |
Fist block (number) of the auction ending phase. `null` if there is no ongoing
auction.
finishEnd:
type: string
format: unisgnedInteger or $null
description: |
Last block (number) of the auction ending phase. `null` if there is no ongoing
auction.
phase:
type: string
enum:
- opening
- ending
description: |
Whether the auction is in the `opening` or `ending` phase. The
`ending` phase is where the eventual winners are retroactively
picked from. `null` if there is no ongoing auction.
auctionIndex:
type: string
format: unsignedInteger
description: |
The auction number. If there is no current auction this will be the number
of the previous auction.
leasePeriods:
type: array
items:
type: string
format: unsignedInteger
description: |
Lease period indexes that may be bid on in this auction. `null` if
there is no ongoing auction.
winning:
type: array
items:
$ref: '#/components/schemas/WinningData'
FundInfo:
type: object
properties:
depositor:
type: string
verifier:
type: string
deposit:
type: string
format: unsignedInteger
raised:
type: string
format: unsignedInteger
end:
type: string
format: unsignedInteger
cap:
type: string
format: unsignedInteger
lastConstribution:
type: string
enum:
- preEnding
- ending
firstSlot:
type: string
format: unsignedInteger
lastSlot:
type: string
format: unsignedInteger
trieIndex:
type: string
format: unsignedInteger
ParasCrowdloans:
type: object
properties:
at:
$ref: '#/components/schemas/BlockIdentifiers'