@polymeshassociation/polymesh-types
Version:
Substrate types used in Polymesh chain
916 lines • 129 kB
TypeScript
import '@polkadot/api-base/types/storage';
import type { ApiTypes, AugmentedQuery, QueryableStorageEntry } from '@polkadot/api-base/types';
import type { BTreeSet, Bytes, Null, Option, U8aFixed, Vec, WrapperOpaque, bool, u128, u16, u32, u64, u8 } from '@polkadot/types-codec';
import type { AnyNumber, ITuple } from '@polkadot/types-codec/types';
import type { AccountId32, Call, H256, Perbill, Percent, Permill } from '@polkadot/types/interfaces/runtime';
import type { FrameSupportDispatchPerDispatchClassWeight, FrameSystemAccountInfo, FrameSystemEventRecord, FrameSystemLastRuntimeUpgradeInfo, FrameSystemPhase, PalletAssetAssetDetails, PalletAssetTickerRegistration, PalletAssetTickerRegistrationConfig, PalletBalancesBalanceLock, PalletCommitteePolymeshVotes, PalletContractsStorageContractInfo, PalletContractsStorageDeletedContract, PalletContractsWasmOwnerInfo, PalletContractsWasmPrefabWasmModule, PalletCorporateActionsBallotBallotMeta, PalletCorporateActionsBallotBallotTimeRange, PalletCorporateActionsBallotBallotVote, PalletCorporateActionsCaId, PalletCorporateActionsCorporateAction, PalletCorporateActionsDistribution, PalletCorporateActionsTargetIdentities, PalletElectionProviderMultiPhasePhase, PalletElectionProviderMultiPhaseReadySolution, PalletElectionProviderMultiPhaseRoundSnapshot, PalletElectionProviderMultiPhaseSignedSignedSubmission, PalletElectionProviderMultiPhaseSolutionOrSnapshotSize, PalletGrandpaStoredPendingChange, PalletGrandpaStoredState, PalletIdentityClaim1stKey, PalletIdentityClaim2ndKey, PalletImOnlineBoundedOpaqueNetworkState, PalletImOnlineSr25519AppSr25519Public, PalletPipsDepositInfo, PalletPipsPip, PalletPipsPipsMetadata, PalletPipsProposalState, PalletPipsSnapshotMetadata, PalletPipsSnapshottedPip, PalletPipsVote, PalletPipsVotingResult, PalletPreimageRequestStatus, PalletRelayerSubsidy, PalletSchedulerScheduled, PalletStakingActiveEraInfo, PalletStakingEraRewardPoints, PalletStakingExposure, PalletStakingForcing, PalletStakingNominations, PalletStakingPermissionedIdentityPrefs, PalletStakingRewardDestination, PalletStakingSlashingSlashingSpans, PalletStakingSlashingSpanRecord, PalletStakingSlashingSwitch, PalletStakingStakingLedger, PalletStakingUnappliedSlash, PalletStakingValidatorPrefs, PalletStoFundraiser, PalletTransactionPaymentReleases, PolymeshCommonUtilitiesCheckpointNextCheckpoints, PolymeshCommonUtilitiesCheckpointScheduleCheckpoints, PolymeshCommonUtilitiesProtocolFeeProtocolOp, PolymeshContractsApi, PolymeshContractsApiCodeHash, PolymeshContractsChainExtensionExtrinsicId, PolymeshContractsNextUpgrade, PolymeshPrimitivesAgentAgentGroup, PolymeshPrimitivesAssetAssetId, PolymeshPrimitivesAssetIdentifier, PolymeshPrimitivesAssetMetadataAssetMetadataKey, PolymeshPrimitivesAssetMetadataAssetMetadataSpec, PolymeshPrimitivesAssetMetadataAssetMetadataValueDetail, PolymeshPrimitivesAuthorization, PolymeshPrimitivesComplianceManagerAssetCompliance, PolymeshPrimitivesConditionTrustedIssuer, PolymeshPrimitivesDocument, PolymeshPrimitivesGroupInactiveMember, PolymeshPrimitivesIdentityClaim, PolymeshPrimitivesIdentityDidRecord, PolymeshPrimitivesIdentityId, PolymeshPrimitivesIdentityIdPortfolioId, PolymeshPrimitivesMaybeBlock, PolymeshPrimitivesMemo, PolymeshPrimitivesMultisigProposalState, PolymeshPrimitivesMultisigProposalVoteCount, PolymeshPrimitivesNftNftCollection, PolymeshPrimitivesSecondaryKeyExtrinsicPermissions, PolymeshPrimitivesSecondaryKeyKeyRecord, PolymeshPrimitivesSecondaryKeySignatory, PolymeshPrimitivesSettlementAffirmationStatus, PolymeshPrimitivesSettlementInstruction, PolymeshPrimitivesSettlementInstructionStatus, PolymeshPrimitivesSettlementLeg, PolymeshPrimitivesSettlementLegStatus, PolymeshPrimitivesSettlementMediatorAffirmationStatus, PolymeshPrimitivesSettlementVenue, PolymeshPrimitivesStatisticsStat1stKey, PolymeshPrimitivesStatisticsStat2ndKey, PolymeshPrimitivesStatisticsStatType, PolymeshPrimitivesSubsetSubsetRestrictionAssetId, PolymeshPrimitivesSubsetSubsetRestrictionPortfolioId, PolymeshPrimitivesTicker, PolymeshPrimitivesTransferComplianceAssetTransferCompliance, PolymeshPrimitivesTransferComplianceTransferConditionExemptKey, PolymeshRuntimeDevelopRuntimeSessionKeys, SpConsensusBabeAppPublic, SpConsensusBabeBabeEpochConfiguration, SpConsensusBabeDigestsNextConfigDescriptor, SpConsensusBabeDigestsPreDigest, SpCoreCryptoKeyTypeId, SpNposElectionsElectionScore, SpRuntimeDigest, SpStakingOffenceOffenceDetails } from '@polkadot/types/lookup';
import type { Observable } from '@polkadot/types/types';
export type __AugmentedQuery<ApiType extends ApiTypes> = AugmentedQuery<ApiType, () => unknown>;
export type __QueryableStorageEntry<ApiType extends ApiTypes> = QueryableStorageEntry<ApiType>;
declare module '@polkadot/api-base/types/storage' {
interface AugmentedQueries<ApiType extends ApiTypes> {
asset: {
/**
* All [`Document`] attached to an asset.
**/
assetDocuments: AugmentedQuery<ApiType, (arg1: PolymeshPrimitivesAssetAssetId | string | Uint8Array, arg2: u32 | AnyNumber | Uint8Array) => Observable<Option<PolymeshPrimitivesDocument>>, [
PolymeshPrimitivesAssetAssetId,
u32
]>;
/**
* [`DocumentId`] counter per [`AssetId`].
**/
assetDocumentsIdSequence: AugmentedQuery<ApiType, (arg: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => Observable<u32>, [
PolymeshPrimitivesAssetAssetId
]>;
/**
* Maps each [`AssetId`] to its asset identifiers ([`AssetIdentifier`]).
**/
assetIdentifiers: AugmentedQuery<ApiType, (arg: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => Observable<Vec<PolymeshPrimitivesAssetIdentifier>>, [
PolymeshPrimitivesAssetAssetId
]>;
/**
* Maps all [`AssetId`] that are mapped to a [`Ticker`].
**/
assetIdTicker: AugmentedQuery<ApiType, (arg: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => Observable<Option<PolymeshPrimitivesTicker>>, [
PolymeshPrimitivesAssetAssetId
]>;
/**
* Asset Metadata Global Key -> Name.
**/
assetMetadataGlobalKeyToName: AugmentedQuery<ApiType, (arg: u64 | AnyNumber | Uint8Array) => Observable<Option<Bytes>>, [
u64
]>;
/**
* Asset Metadata Global Name -> Key.
**/
assetMetadataGlobalNameToKey: AugmentedQuery<ApiType, (arg: Bytes | string | Uint8Array) => Observable<Option<u64>>, [
Bytes
]>;
/**
* Asset Metadata Global Key specs.
**/
assetMetadataGlobalSpecs: AugmentedQuery<ApiType, (arg: u64 | AnyNumber | Uint8Array) => Observable<Option<PolymeshPrimitivesAssetMetadataAssetMetadataSpec>>, [
u64
]>;
/**
* Asset Metadata Local Key -> Name.
**/
assetMetadataLocalKeyToName: AugmentedQuery<ApiType, (arg1: PolymeshPrimitivesAssetAssetId | string | Uint8Array, arg2: u64 | AnyNumber | Uint8Array) => Observable<Option<Bytes>>, [
PolymeshPrimitivesAssetAssetId,
u64
]>;
/**
* Asset Metadata Local Name -> Key.
**/
assetMetadataLocalNameToKey: AugmentedQuery<ApiType, (arg1: PolymeshPrimitivesAssetAssetId | string | Uint8Array, arg2: Bytes | string | Uint8Array) => Observable<Option<u64>>, [
PolymeshPrimitivesAssetAssetId,
Bytes
]>;
/**
* Asset Metadata Local Key specs.
**/
assetMetadataLocalSpecs: AugmentedQuery<ApiType, (arg1: PolymeshPrimitivesAssetAssetId | string | Uint8Array, arg2: u64 | AnyNumber | Uint8Array) => Observable<Option<PolymeshPrimitivesAssetMetadataAssetMetadataSpec>>, [
PolymeshPrimitivesAssetAssetId,
u64
]>;
/**
* Details for an asset's Metadata values.
**/
assetMetadataValueDetails: AugmentedQuery<ApiType, (arg1: PolymeshPrimitivesAssetAssetId | string | Uint8Array, arg2: PolymeshPrimitivesAssetMetadataAssetMetadataKey | {
Global: any;
} | {
Local: any;
} | string | Uint8Array) => Observable<Option<PolymeshPrimitivesAssetMetadataAssetMetadataValueDetail>>, [
PolymeshPrimitivesAssetAssetId,
PolymeshPrimitivesAssetMetadataAssetMetadataKey
]>;
/**
* Metatdata values for an asset.
**/
assetMetadataValues: AugmentedQuery<ApiType, (arg1: PolymeshPrimitivesAssetAssetId | string | Uint8Array, arg2: PolymeshPrimitivesAssetMetadataAssetMetadataKey | {
Global: any;
} | {
Local: any;
} | string | Uint8Array) => Observable<Option<Bytes>>, [
PolymeshPrimitivesAssetAssetId,
PolymeshPrimitivesAssetMetadataAssetMetadataKey
]>;
/**
* Maps each [`AssetId`] to its underling [`AssetName`].
**/
assetNames: AugmentedQuery<ApiType, (arg: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => Observable<Option<Bytes>>, [
PolymeshPrimitivesAssetAssetId
]>;
/**
* A per account nonce that is used for generating an [`AssetId`].
**/
assetNonce: AugmentedQuery<ApiType, (arg: AccountId32 | string | Uint8Array) => Observable<u64>, [
AccountId32
]>;
/**
* Maps each [`AssetId`] to its underling [`AssetDetails`].
**/
assets: AugmentedQuery<ApiType, (arg: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => Observable<Option<PalletAssetAssetDetails>>, [
PolymeshPrimitivesAssetAssetId
]>;
/**
* A list of assets that exempt all users from affirming its receivement.
**/
assetsExemptFromAffirmation: AugmentedQuery<ApiType, (arg: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => Observable<bool>, [
PolymeshPrimitivesAssetAssetId
]>;
/**
* Tracks the total [`Balance`] for each [`AssetId`] per [`IdentityId`].
**/
balanceOf: AugmentedQuery<ApiType, (arg1: PolymeshPrimitivesAssetAssetId | string | Uint8Array, arg2: PolymeshPrimitivesIdentityId | string | Uint8Array) => Observable<u128>, [
PolymeshPrimitivesAssetAssetId,
PolymeshPrimitivesIdentityId
]>;
/**
* The last [`AssetMetadataGlobalKey`] used for a global key.
**/
currentAssetMetadataGlobalKey: AugmentedQuery<ApiType, () => Observable<Option<u64>>, []>;
/**
* The last [`AssetMetadataLocalKey`] used for [`AssetId`].
**/
currentAssetMetadataLocalKey: AugmentedQuery<ApiType, (arg: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => Observable<Option<u64>>, [
PolymeshPrimitivesAssetAssetId
]>;
/**
* The next `AssetType::Custom` ID in the sequence.
*
* Numbers in the sequence start from 1 rather than 0.
**/
customTypeIdSequence: AugmentedQuery<ApiType, () => Observable<u32>, []>;
/**
* Maps custom asset type ids to the registered string contents.
**/
customTypes: AugmentedQuery<ApiType, (arg: u32 | AnyNumber | Uint8Array) => Observable<Bytes>, [
u32
]>;
/**
* Inverse map of `CustomTypes`, from registered string contents to custom asset type ids.
**/
customTypesInverse: AugmentedQuery<ApiType, (arg: Bytes | string | Uint8Array) => Observable<Option<u32>>, [
Bytes
]>;
/**
* Returns `true` if transfers for the asset are frozen. Otherwise, returns `false`.
**/
frozen: AugmentedQuery<ApiType, (arg: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => Observable<bool>, [
PolymeshPrimitivesAssetAssetId
]>;
/**
* Maps each [`AssetId`] to the name of its founding round ([`FundingRoundName`]).
**/
fundingRound: AugmentedQuery<ApiType, (arg: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => Observable<Bytes>, [
PolymeshPrimitivesAssetAssetId
]>;
/**
* The total [`Balance`] of tokens issued in all recorded funding rounds ([`FundingRoundName`]).
**/
issuedInFundingRound: AugmentedQuery<ApiType, (arg: ITuple<[PolymeshPrimitivesAssetAssetId, Bytes]> | [PolymeshPrimitivesAssetAssetId | string | Uint8Array, Bytes | string | Uint8Array]) => Observable<u128>, [
ITuple<[PolymeshPrimitivesAssetAssetId, Bytes]>
]>;
/**
* The list of mandatory mediators for every ticker.
**/
mandatoryMediators: AugmentedQuery<ApiType, (arg: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => Observable<BTreeSet<PolymeshPrimitivesIdentityId>>, [
PolymeshPrimitivesAssetAssetId
]>;
/**
* All assets that don't need an affirmation to be received by an identity.
**/
preApprovedAsset: AugmentedQuery<ApiType, (arg1: PolymeshPrimitivesIdentityId | string | Uint8Array, arg2: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => Observable<bool>, [
PolymeshPrimitivesIdentityId,
PolymeshPrimitivesAssetAssetId
]>;
/**
* All assets owned by a user.
**/
securityTokensOwnedByUser: AugmentedQuery<ApiType, (arg1: PolymeshPrimitivesIdentityId | string | Uint8Array, arg2: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => Observable<bool>, [
PolymeshPrimitivesIdentityId,
PolymeshPrimitivesAssetAssetId
]>;
/**
* Storage version.
**/
storageVersion: AugmentedQuery<ApiType, () => Observable<u8>, []>;
/**
* Maps all [`Ticker`] that are linked to an [`AssetId`].
**/
tickerAssetId: AugmentedQuery<ApiType, (arg: PolymeshPrimitivesTicker | string | Uint8Array) => Observable<Option<PolymeshPrimitivesAssetAssetId>>, [
PolymeshPrimitivesTicker
]>;
/**
* Returns [`TickerRegistrationConfig`] for assessing if a ticker is valid.
**/
tickerConfig: AugmentedQuery<ApiType, () => Observable<PalletAssetTickerRegistrationConfig>, [
]>;
/**
* All tickers owned by a user.
**/
tickersOwnedByUser: AugmentedQuery<ApiType, (arg1: PolymeshPrimitivesIdentityId | string | Uint8Array, arg2: PolymeshPrimitivesTicker | string | Uint8Array) => Observable<bool>, [
PolymeshPrimitivesIdentityId,
PolymeshPrimitivesTicker
]>;
/**
* Map each [`Ticker`] to its registration details ([`TickerRegistration`]).
**/
uniqueTickerRegistration: AugmentedQuery<ApiType, (arg: PolymeshPrimitivesTicker | string | Uint8Array) => Observable<Option<PalletAssetTickerRegistration>>, [
PolymeshPrimitivesTicker
]>;
};
authorship: {
/**
* Author of current block.
**/
author: AugmentedQuery<ApiType, () => Observable<Option<AccountId32>>, []>;
};
babe: {
/**
* Current epoch authorities.
**/
authorities: AugmentedQuery<ApiType, () => Observable<Vec<ITuple<[SpConsensusBabeAppPublic, u64]>>>, [
]>;
/**
* This field should always be populated during block processing unless
* secondary plain slots are enabled (which don't contain a VRF output).
*
* It is set in `on_finalize`, before it will contain the value from the last block.
**/
authorVrfRandomness: AugmentedQuery<ApiType, () => Observable<Option<U8aFixed>>, []>;
/**
* Current slot number.
**/
currentSlot: AugmentedQuery<ApiType, () => Observable<u64>, []>;
/**
* The configuration for the current epoch. Should never be `None` as it is initialized in
* genesis.
**/
epochConfig: AugmentedQuery<ApiType, () => Observable<Option<SpConsensusBabeBabeEpochConfiguration>>, [
]>;
/**
* Current epoch index.
**/
epochIndex: AugmentedQuery<ApiType, () => Observable<u64>, []>;
/**
* The block numbers when the last and current epoch have started, respectively `N-1` and
* `N`.
* NOTE: We track this is in order to annotate the block number when a given pool of
* entropy was fixed (i.e. it was known to chain observers). Since epochs are defined in
* slots, which may be skipped, the block numbers may not line up with the slot numbers.
**/
epochStart: AugmentedQuery<ApiType, () => Observable<ITuple<[u32, u32]>>, []>;
/**
* The slot at which the first epoch actually started. This is 0
* until the first block of the chain.
**/
genesisSlot: AugmentedQuery<ApiType, () => Observable<u64>, []>;
/**
* Temporary value (cleared at block finalization) which is `Some`
* if per-block initialization has already been called for current block.
**/
initialized: AugmentedQuery<ApiType, () => Observable<Option<Option<SpConsensusBabeDigestsPreDigest>>>, [
]>;
/**
* How late the current block is compared to its parent.
*
* This entry is populated as part of block execution and is cleaned up
* on block finalization. Querying this storage entry outside of block
* execution context should always yield zero.
**/
lateness: AugmentedQuery<ApiType, () => Observable<u32>, []>;
/**
* Next epoch authorities.
**/
nextAuthorities: AugmentedQuery<ApiType, () => Observable<Vec<ITuple<[SpConsensusBabeAppPublic, u64]>>>, [
]>;
/**
* The configuration for the next epoch, `None` if the config will not change
* (you can fallback to `EpochConfig` instead in that case).
**/
nextEpochConfig: AugmentedQuery<ApiType, () => Observable<Option<SpConsensusBabeBabeEpochConfiguration>>, [
]>;
/**
* Next epoch randomness.
**/
nextRandomness: AugmentedQuery<ApiType, () => Observable<U8aFixed>, []>;
/**
* Pending epoch configuration change that will be applied when the next epoch is enacted.
**/
pendingEpochConfigChange: AugmentedQuery<ApiType, () => Observable<Option<SpConsensusBabeDigestsNextConfigDescriptor>>, [
]>;
/**
* The epoch randomness for the *current* epoch.
*
* # Security
*
* This MUST NOT be used for gambling, as it can be influenced by a
* malicious validator in the short term. It MAY be used in many
* cryptographic protocols, however, so long as one remembers that this
* (like everything else on-chain) it is public. For example, it can be
* used where a number is needed that cannot have been chosen by an
* adversary, for purposes such as public-coin zero-knowledge proofs.
**/
randomness: AugmentedQuery<ApiType, () => Observable<U8aFixed>, []>;
/**
* Randomness under construction.
*
* We make a trade-off between storage accesses and list length.
* We store the under-construction randomness in segments of up to
* `UNDER_CONSTRUCTION_SEGMENT_LENGTH`.
*
* Once a segment reaches this length, we begin the next one.
* We reset all segments and return to `0` at the beginning of every
* epoch.
**/
segmentIndex: AugmentedQuery<ApiType, () => Observable<u32>, []>;
/**
* A list of the last 100 skipped epochs and the corresponding session index
* when the epoch was skipped.
*
* This is only used for validating equivocation proofs. An equivocation proof
* must contains a key-ownership proof for a given session, therefore we need a
* way to tie together sessions and epoch indices, i.e. we need to validate that
* a validator was the owner of a given key on a given session, and what the
* active epoch index was during that session.
**/
skippedEpochs: AugmentedQuery<ApiType, () => Observable<Vec<ITuple<[u64, u32]>>>, []>;
/**
* TWOX-NOTE: `SegmentIndex` is an increasing integer, so this is okay.
**/
underConstruction: AugmentedQuery<ApiType, (arg: u32 | AnyNumber | Uint8Array) => Observable<Vec<U8aFixed>>, [
u32
]>;
};
balances: {
/**
* Any liquidity locks on some account balances.
* NOTE: Should only be accessed when setting, changing and freeing a lock.
**/
locks: AugmentedQuery<ApiType, (arg: AccountId32 | string | Uint8Array) => Observable<Vec<PalletBalancesBalanceLock>>, [
AccountId32
]>;
/**
* The total units issued in the system.
**/
totalIssuance: AugmentedQuery<ApiType, () => Observable<u128>, []>;
};
capitalDistribution: {
/**
* All capital distributions, tied to their respective corporate actions (CAs).
*
* (CAId) => Distribution
**/
distributions: AugmentedQuery<ApiType, (arg: PalletCorporateActionsCaId | {
assetId?: any;
localId?: any;
} | string | Uint8Array) => Observable<Option<PalletCorporateActionsDistribution>>, [
PalletCorporateActionsCaId
]>;
/**
* Has an asset holder been paid yet?
*
* (CAId, DID) -> Was DID paid in the CAId?
**/
holderPaid: AugmentedQuery<ApiType, (arg: ITuple<[PalletCorporateActionsCaId, PolymeshPrimitivesIdentityId]> | [
PalletCorporateActionsCaId | {
assetId?: any;
localId?: any;
} | string | Uint8Array,
PolymeshPrimitivesIdentityId | string | Uint8Array
]) => Observable<bool>, [
ITuple<[PalletCorporateActionsCaId, PolymeshPrimitivesIdentityId]>
]>;
/**
* Storage version.
**/
storageVersion: AugmentedQuery<ApiType, () => Observable<u8>, []>;
};
cddServiceProviders: {
/**
* The current "active" membership, stored as an ordered Vec.
**/
activeMembers: AugmentedQuery<ApiType, () => Observable<Vec<PolymeshPrimitivesIdentityId>>, [
]>;
/**
* Limit of how many "active" members there can be.
**/
activeMembersLimit: AugmentedQuery<ApiType, () => Observable<u32>, []>;
/**
* The current "inactive" membership, stored as an ordered Vec.
**/
inactiveMembers: AugmentedQuery<ApiType, () => Observable<Vec<PolymeshPrimitivesGroupInactiveMember>>, [
]>;
};
checkpoint: {
/**
* Balance of a DID at a checkpoint.
*
* ([`AssetId`], did, checkpoint ID) -> Balance of a DID at a checkpoint
**/
balance: AugmentedQuery<ApiType, (arg1: ITuple<[PolymeshPrimitivesAssetAssetId, u64]> | [PolymeshPrimitivesAssetAssetId | string | Uint8Array, u64 | AnyNumber | Uint8Array], arg2: PolymeshPrimitivesIdentityId | string | Uint8Array) => Observable<u128>, [
ITuple<[PolymeshPrimitivesAssetAssetId, u64]>,
PolymeshPrimitivesIdentityId
]>;
/**
* Checkpoints where a DID's balance was updated.
* ([`AssetId`], did) -> [checkpoint ID where user balance changed]
**/
balanceUpdates: AugmentedQuery<ApiType, (arg1: PolymeshPrimitivesAssetAssetId | string | Uint8Array, arg2: PolymeshPrimitivesIdentityId | string | Uint8Array) => Observable<Vec<u64>>, [
PolymeshPrimitivesAssetAssetId,
PolymeshPrimitivesIdentityId
]>;
/**
* Cached next checkpoint for each schedule.
*
* This is used to quickly find the next checkpoint from a asset's schedules.
*
* ([`AssetId`]) -> next checkpoints
**/
cachedNextCheckpoints: AugmentedQuery<ApiType, (arg: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => Observable<Option<PolymeshCommonUtilitiesCheckpointNextCheckpoints>>, [
PolymeshPrimitivesAssetAssetId
]>;
/**
* Checkpoints ID generator sequence.
* ID of first checkpoint is 1 instead of 0.
*
* ([`AssetId`]) -> no. of checkpoints
**/
checkpointIdSequence: AugmentedQuery<ApiType, (arg: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => Observable<u64>, [
PolymeshPrimitivesAssetAssetId
]>;
/**
* Scheduled checkpoints.
*
* ([`AssetId`], schedule ID) -> schedule checkpoints
**/
scheduledCheckpoints: AugmentedQuery<ApiType, (arg1: PolymeshPrimitivesAssetAssetId | string | Uint8Array, arg2: u64 | AnyNumber | Uint8Array) => Observable<Option<PolymeshCommonUtilitiesCheckpointScheduleCheckpoints>>, [
PolymeshPrimitivesAssetAssetId,
u64
]>;
/**
* Checkpoint schedule ID sequence for assets.
*
* ([`AssetId`]) -> schedule ID
**/
scheduleIdSequence: AugmentedQuery<ApiType, (arg: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => Observable<u64>, [
PolymeshPrimitivesAssetAssetId
]>;
/**
* All the checkpoints a given schedule originated.
*
* ([`AssetId`], schedule ID) -> [checkpoint ID]
**/
schedulePoints: AugmentedQuery<ApiType, (arg1: PolymeshPrimitivesAssetAssetId | string | Uint8Array, arg2: u64 | AnyNumber | Uint8Array) => Observable<Vec<u64>>, [
PolymeshPrimitivesAssetAssetId,
u64
]>;
/**
* How many "strong" references are there to a given `ScheduleId`?
*
* The presence of a "strong" reference, in the sense of `Rc<T>`,
* entails that the referenced schedule cannot be removed.
* Thus, as long as `strong_ref_count(schedule_id) > 0`,
* `remove_schedule(schedule_id)` will error.
*
* ([`AssetId`], schedule ID) -> strong ref count
**/
scheduleRefCount: AugmentedQuery<ApiType, (arg1: PolymeshPrimitivesAssetAssetId | string | Uint8Array, arg2: u64 | AnyNumber | Uint8Array) => Observable<u32>, [
PolymeshPrimitivesAssetAssetId,
u64
]>;
/**
* The maximum complexity allowed for an asset's schedules.
**/
schedulesMaxComplexity: AugmentedQuery<ApiType, () => Observable<u64>, []>;
/**
* Storage version.
**/
storageVersion: AugmentedQuery<ApiType, () => Observable<u8>, []>;
/**
* Checkpoint timestamps.
*
* Every schedule-originated checkpoint maps its ID to its due time.
* Every checkpoint manually created maps its ID to the time of recording.
*
* ([`AssetId`]) -> (checkpoint ID) -> checkpoint timestamp
**/
timestamps: AugmentedQuery<ApiType, (arg1: PolymeshPrimitivesAssetAssetId | string | Uint8Array, arg2: u64 | AnyNumber | Uint8Array) => Observable<u64>, [
PolymeshPrimitivesAssetAssetId,
u64
]>;
/**
* Total supply of the token at the checkpoint.
*
* ([`AssetId`], checkpointId) -> total supply at given checkpoint
**/
totalSupply: AugmentedQuery<ApiType, (arg1: PolymeshPrimitivesAssetAssetId | string | Uint8Array, arg2: u64 | AnyNumber | Uint8Array) => Observable<u128>, [
PolymeshPrimitivesAssetAssetId,
u64
]>;
};
committeeMembership: {
/**
* The current "active" membership, stored as an ordered Vec.
**/
activeMembers: AugmentedQuery<ApiType, () => Observable<Vec<PolymeshPrimitivesIdentityId>>, [
]>;
/**
* Limit of how many "active" members there can be.
**/
activeMembersLimit: AugmentedQuery<ApiType, () => Observable<u32>, []>;
/**
* The current "inactive" membership, stored as an ordered Vec.
**/
inactiveMembers: AugmentedQuery<ApiType, () => Observable<Vec<PolymeshPrimitivesGroupInactiveMember>>, [
]>;
};
complianceManager: {
/**
* Compliance for an asset ([`AssetId`] -> [`AssetCompliance`])
**/
assetCompliances: AugmentedQuery<ApiType, (arg: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => Observable<PolymeshPrimitivesComplianceManagerAssetCompliance>, [
PolymeshPrimitivesAssetAssetId
]>;
/**
* Storage version.
**/
storageVersion: AugmentedQuery<ApiType, () => Observable<u8>, []>;
/**
* List of trusted claim issuer [`AssetId`] -> Issuer Identity
**/
trustedClaimIssuer: AugmentedQuery<ApiType, (arg: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => Observable<Vec<PolymeshPrimitivesConditionTrustedIssuer>>, [
PolymeshPrimitivesAssetAssetId
]>;
};
contracts: {
/**
* A mapping between an original code hash and instrumented wasm code, ready for execution.
**/
codeStorage: AugmentedQuery<ApiType, (arg: H256 | string | Uint8Array) => Observable<Option<PalletContractsWasmPrefabWasmModule>>, [
H256
]>;
/**
* The code associated with a given account.
*
* TWOX-NOTE: SAFE since `AccountId` is a secure hash.
**/
contractInfoOf: AugmentedQuery<ApiType, (arg: AccountId32 | string | Uint8Array) => Observable<Option<PalletContractsStorageContractInfo>>, [
AccountId32
]>;
/**
* Evicted contracts that await child trie deletion.
*
* Child trie deletion is a heavy operation depending on the amount of storage items
* stored in said trie. Therefore this operation is performed lazily in `on_initialize`.
**/
deletionQueue: AugmentedQuery<ApiType, () => Observable<Vec<PalletContractsStorageDeletedContract>>, [
]>;
/**
* This is a **monotonic** counter incremented on contract instantiation.
*
* This is used in order to generate unique trie ids for contracts.
* The trie id of a new contract is calculated from hash(account_id, nonce).
* The nonce is required because otherwise the following sequence would lead to
* a possible collision of storage:
*
* 1. Create a new contract.
* 2. Terminate the contract.
* 3. Immediately recreate the contract with the same account_id.
*
* This is bad because the contents of a trie are deleted lazily and there might be
* storage of the old instantiation still in it when the new contract is created. Please
* note that we can't replace the counter by the block number because the sequence above
* can happen in the same block. We also can't keep the account counter in memory only
* because storage is the only way to communicate across different extrinsics in the
* same block.
*
* # Note
*
* Do not use it to determine the number of contracts. It won't be decremented if
* a contract is destroyed.
**/
nonce: AugmentedQuery<ApiType, () => Observable<u64>, []>;
/**
* A mapping between an original code hash and its owner information.
**/
ownerInfoOf: AugmentedQuery<ApiType, (arg: H256 | string | Uint8Array) => Observable<Option<PalletContractsWasmOwnerInfo>>, [
H256
]>;
/**
* A mapping from an original code hash to the original code, untouched by instrumentation.
**/
pristineCode: AugmentedQuery<ApiType, (arg: H256 | string | Uint8Array) => Observable<Option<Bytes>>, [
H256
]>;
};
corporateAction: {
/**
* Associations from CAs to `Document`s via their IDs.
* (CAId => [DocumentId])
*
* The `CorporateActions` map stores `AssetId => LocalId => The CA`,
* so we can infer `AssetId => CAId`. Therefore, we don't need a double map.
**/
caDocLink: AugmentedQuery<ApiType, (arg: PalletCorporateActionsCaId | {
assetId?: any;
localId?: any;
} | string | Uint8Array) => Observable<Vec<u32>>, [
PalletCorporateActionsCaId
]>;
/**
* The next per-`AssetId` CA ID in the sequence.
* The full ID is defined as a combination of `AssetId` and a number in this sequence.
**/
caIdSequence: AugmentedQuery<ApiType, (arg: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => Observable<u32>, [
PolymeshPrimitivesAssetAssetId
]>;
/**
* All recorded CAs thus far.
* Only generic information is stored here.
* Specific `CAKind`s, e.g., benefits and corporate ballots, may use additional on-chain storage.
*
* (AssetId => local ID => the corporate action)
**/
corporateActions: AugmentedQuery<ApiType, (arg1: PolymeshPrimitivesAssetAssetId | string | Uint8Array, arg2: u32 | AnyNumber | Uint8Array) => Observable<Option<PalletCorporateActionsCorporateAction>>, [
PolymeshPrimitivesAssetAssetId,
u32
]>;
/**
* The identities targeted by default for CAs for this asset,
* either to be excluded or included.
*
* (AssetId => target identities)
**/
defaultTargetIdentities: AugmentedQuery<ApiType, (arg: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => Observable<PalletCorporateActionsTargetIdentities>, [
PolymeshPrimitivesAssetAssetId
]>;
/**
* The default amount of tax to withhold ("withholding tax", WT) for this asset when distributing dividends.
*
* To understand withholding tax, e.g., let's assume that you hold ACME shares.
* ACME now decides to distribute 100 SEK to Alice.
* Alice lives in Sweden, so Skatteverket (the Swedish tax authority) wants 30% of that.
* Then those 100 * 30% are withheld from Alice, and ACME will send them to Skatteverket.
*
* (AssetId => % to withhold)
**/
defaultWithholdingTax: AugmentedQuery<ApiType, (arg: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => Observable<Permill>, [
PolymeshPrimitivesAssetAssetId
]>;
/**
* Associates details in free-form text with a CA by its ID.
* (CAId => CADetails)
**/
details: AugmentedQuery<ApiType, (arg: PalletCorporateActionsCaId | {
assetId?: any;
localId?: any;
} | string | Uint8Array) => Observable<Bytes>, [
PalletCorporateActionsCaId
]>;
/**
* The amount of tax to withhold ("withholding tax", WT) for a certain AssetId x DID.
* If an entry exists for a certain DID, it overrides the default in `DefaultWithholdingTax`.
*
* (AssetId => [(did, % to withhold)]
**/
didWithholdingTax: AugmentedQuery<ApiType, (arg: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => Observable<Vec<ITuple<[PolymeshPrimitivesIdentityId, Permill]>>>, [
PolymeshPrimitivesAssetAssetId
]>;
/**
* Determines the maximum number of bytes that the free-form `details` of a CA can store.
*
* Note that this is not the number of `char`s or the number of [graphemes].
* While this may be unnatural in terms of human understanding of a text's length,
* it more closely reflects actual storage costs (`'a'` is cheaper to store than an emoji).
*
* [graphemes]: https://en.wikipedia.org/wiki/Grapheme
**/
maxDetailsLength: AugmentedQuery<ApiType, () => Observable<u32>, []>;
/**
* Storage version.
**/
storageVersion: AugmentedQuery<ApiType, () => Observable<u8>, []>;
};
corporateBallot: {
/**
* Metadata of a corporate ballot.
*
* (CAId) => BallotMeta
**/
metas: AugmentedQuery<ApiType, (arg: PalletCorporateActionsCaId | {
assetId?: any;
localId?: any;
} | string | Uint8Array) => Observable<Option<PalletCorporateActionsBallotBallotMeta>>, [
PalletCorporateActionsCaId
]>;
/**
* Stores how many choices there are in each motion.
*
* At all times, the invariant holds that `motion_choices[idx]` is equal to
* `metas.unwrap().motions[idx].choices.len()`. That is, this is just a cache,
* used to avoid fetching all the motions with their associated texts.
*
* `u16` choices should be more than enough to fit real use cases.
*
* (CAId) => Number of choices in each motion.
**/
motionNumChoices: AugmentedQuery<ApiType, (arg: PalletCorporateActionsCaId | {
assetId?: any;
localId?: any;
} | string | Uint8Array) => Observable<Vec<u16>>, [
PalletCorporateActionsCaId
]>;
/**
* Is ranked choice voting (RCV) enabled for this ballot?
* For an understanding of how RCV is handled, see note on `BallotVote`'s `fallback` field.
*
* (CAId) => bool
**/
rcv: AugmentedQuery<ApiType, (arg: PalletCorporateActionsCaId | {
assetId?: any;
localId?: any;
} | string | Uint8Array) => Observable<bool>, [
PalletCorporateActionsCaId
]>;
/**
* Stores the total vote tally on each choice.
*
* RCV is not accounted for,
* as there are too many wants to interpret the graph,
* and because it would not be efficient.
*
* (CAId) => [current vote weights]
**/
results: AugmentedQuery<ApiType, (arg: PalletCorporateActionsCaId | {
assetId?: any;
localId?: any;
} | string | Uint8Array) => Observable<Vec<u128>>, [
PalletCorporateActionsCaId
]>;
/**
* Storage version.
**/
storageVersion: AugmentedQuery<ApiType, () => Observable<u8>, []>;
/**
* Time details of a corporate ballot associated with a CA.
* The timestamps denote when voting starts and stops.
*
* (CAId) => BallotTimeRange
**/
timeRanges: AugmentedQuery<ApiType, (arg: PalletCorporateActionsCaId | {
assetId?: any;
localId?: any;
} | string | Uint8Array) => Observable<Option<PalletCorporateActionsBallotBallotTimeRange>>, [
PalletCorporateActionsCaId
]>;
/**
* Stores each DID's votes in a given ballot.
* See the documentation of `BallotVote` for notes on semantics.
*
* (CAId) => (DID) => [vote weight]
*
* User must enter 0 vote weight if they don't want to vote for a choice.
**/
votes: AugmentedQuery<ApiType, (arg1: PalletCorporateActionsCaId | {
assetId?: any;
localId?: any;
} | string | Uint8Array, arg2: PolymeshPrimitivesIdentityId | string | Uint8Array) => Observable<Vec<PalletCorporateActionsBallotBallotVote>>, [
PalletCorporateActionsCaId,
PolymeshPrimitivesIdentityId
]>;
};
electionProviderMultiPhase: {
/**
* Current phase.
**/
currentPhase: AugmentedQuery<ApiType, () => Observable<PalletElectionProviderMultiPhasePhase>, [
]>;
/**
* Desired number of targets to elect for this round.
*
* Only exists when [`Snapshot`] is present.
**/
desiredTargets: AugmentedQuery<ApiType, () => Observable<Option<u32>>, []>;
/**
* The minimum score that each 'untrusted' solution must attain in order to be considered
* feasible.
*
* Can be set via `set_minimum_untrusted_score`.
**/
minimumUntrustedScore: AugmentedQuery<ApiType, () => Observable<Option<SpNposElectionsElectionScore>>, [
]>;
/**
* Current best solution, signed or unsigned, queued to be returned upon `elect`.
**/
queuedSolution: AugmentedQuery<ApiType, () => Observable<Option<PalletElectionProviderMultiPhaseReadySolution>>, [
]>;
/**
* Internal counter for the number of rounds.
*
* This is useful for de-duplication of transactions submitted to the pool, and general
* diagnostics of the pallet.
*
* This is merely incremented once per every time that an upstream `elect` is called.
**/
round: AugmentedQuery<ApiType, () => Observable<u32>, []>;
/**
* A sorted, bounded vector of `(score, block_number, index)`, where each `index` points to a
* value in `SignedSubmissions`.
*
* We never need to process more than a single signed submission at a time. Signed submissions
* can be quite large, so we're willing to pay the cost of multiple database accesses to access
* them one at a time instead of reading and decoding all of them at once.
**/
signedSubmissionIndices: AugmentedQuery<ApiType, () => Observable<Vec<ITuple<[SpNposElectionsElectionScore, u32, u32]>>>, [
]>;
/**
* The next index to be assigned to an incoming signed submission.
*
* Every accepted submission is assigned a unique index; that index is bound to that particular
* submission for the duration of the election. On election finalization, the next index is
* reset to 0.
*
* We can't just use `SignedSubmissionIndices.len()`, because that's a bounded set; past its
* capacity, it will simply saturate. We can't just iterate over `SignedSubmissionsMap`,
* because iteration is slow. Instead, we store the value here.
**/
signedSubmissionNextIndex: AugmentedQuery<ApiType, () => Observable<u32>, []>;
/**
* Unchecked, signed solutions.
*
* Together with `SubmissionIndices`, this stores a bounded set of `SignedSubmissions` while
* allowing us to keep only a single one in memory at a time.
*
* Twox note: the key of the map is an auto-incrementing index which users cannot inspect or
* affect; we shouldn't need a cryptographically secure hasher.
**/
signedSubmissionsMap: AugmentedQuery<ApiType, (arg: u32 | AnyNumber | Uint8Array) => Observable<Option<PalletElectionProviderMultiPhaseSignedSignedSubmission>>, [
u32
]>;
/**
* Snapshot data of the round.
*
* This is created at the beginning of the signed phase and cleared upon calling `elect`.
**/
snapshot: AugmentedQuery<ApiType, () => Observable<Option<PalletElectionProviderMultiPhaseRoundSnapshot>>, [
]>;
/**
* The metadata of the [`RoundSnapshot`]
*
* Only exists when [`Snapshot`] is present.
**/
snapshotMetadata: AugmentedQuery<ApiType, () => Observable<Option<PalletElectionProviderMultiPhaseSolutionOrSnapshotSize>>, [
]>;
};
externalAgents: {
/**
* Maps an agent (`IdentityId`) to all assets they belong to, if any.
**/
agentOf: AugmentedQuery<ApiType, (arg1: PolymeshPrimitivesIdentityId | string | Uint8Array, arg2: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => Observable<Null>, [
PolymeshPrimitivesIdentityId,
PolymeshPrimitivesAssetAssetId
]>;
/**
* The next per-asset AG ID in the sequence.
*
* The full ID is defined as a combination of `AssetId` and a number in this sequence,
* which starts from 1, rather than 0.
**/
agIdSequence: AugmentedQuery<ApiType, (arg: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => Observable<u32>, [
PolymeshPrimitivesAssetAssetId
]>;
/**
* Maps agents (`IdentityId`) for an `AssetId` to what AG they belong to, if any.
**/
groupOfAgent: AugmentedQuery<ApiType, (arg1: PolymeshPrimitivesAssetAssetId | string | Uint8Array, arg2: PolymeshPrimitivesIdentityId | string | Uint8Array) => Observable<Option<PolymeshPrimitivesAgentAgentGroup>>, [
PolymeshPrimitivesAssetAssetId,
PolymeshPrimitivesIdentityId
]>;
/**
* For custom AGs of an `AssetId`, maps to what permissions an agent in that AG would have.
**/
groupPermissions: AugmentedQuery<ApiType, (arg1: PolymeshPrimitivesAssetAssetId | string | Uint8Array, arg2: u32 | AnyNumber | Uint8Array) => Observable<Option<PolymeshPrimitivesSecondaryKeyExtrinsicPermissions>>, [
PolymeshPrimitivesAssetAssetId,
u32
]>;
/**
* Maps an `AssetId` to the number of `Full` agents for it.
**/
numFullAgents: AugmentedQuery<ApiType, (arg: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => Observable<u32>, [
PolymeshPrimitivesAssetAssetId
]>;
/**
* Storage version.
**/
storageVersion: AugmentedQuery<ApiType, () => Observable<u8>, []>;
};
grandpa: {
/**
* The number of changes (both in terms of keys and underlying economic responsibilities)
* in the "set" of Grandpa validators from genesis.
**/
currentSetId: Augment