@webb-tools/tangle-substrate-types 0.5.9 → 0.5.12

package/README.md

@@ -6,10 +6,11 @@ The package builds the types against the tangle standalone runtime.
 
 ### Update Types
 
-In order to update types after making changes to the tangle api do the following:
+In order to update types after making changes to the Tangle APIs, do the following:
 
 - Run a local instance of the appropriate runtime. The types in this package correspond to the tangle standalone runtime.
-
+- Change your working directory into the `/types` folder (`cd types`).
+- Install dependencies using `yarn`.
 - Run the following yarn scripts:
 ```
 yarn update:metadata
@@ -22,3 +23,11 @@ After updating the types, run a build for the package with
 ```
 yarn build
 ```
+
+Note that you may run into some errors of missing imports while building. To resolve this, manually add the missing imports on the files with errors. If using VSCode, you can also use its `Add all missing imports` feature to speed up the process.
+
+### Publishing and consuming types package
+
+Once the types have been updated, open a new PR on this repository to submit your changes. Remember to update the types package's version. Once the PR is merged into the `master`, a GitHub Actions workflow will automatically publish them to NPM.
+
+In case that you need to use or prototype the types before they are officially published to NPM, consider installing the package locally and using the local package until its updated version is published to NPM.

package/{build/interfaces → interfaces}/augment-api-consts.d.ts

@@ -1,11 +1,11 @@
-import '@polkadot/api-base/types/consts';
-import type { ApiTypes, AugmentedConst } from '@polkadot/api-base/types';
-import type { BTreeMap, Bytes, Option, U256, U8aFixed, Vec, bool, u128, u16, u32, u64, u8 } from '@polkadot/types-codec';
-import type { Codec, ITuple } from '@polkadot/types-codec/types';
-import type { AccountId32, H160, Perbill, Permill } from '@polkadot/types/interfaces/runtime';
-import { SpWeightsWeightV2Weight, FrameSupportPalletId, StagingXcmV4AssetAssetId, FrameSystemLimitsBlockLength, FrameSystemLimitsBlockWeights, SpWeightsRuntimeDbWeight, SpVersionRuntimeVersion } from '@polkadot/types/lookup';
+import "@polkadot/api-base/types/consts";
+import type { ApiTypes, AugmentedConst } from "@polkadot/api-base/types";
+import type { BTreeMap, Bytes, Option, U256, U8aFixed, Vec, bool, u128, u16, u32, u64, u8 } from "@polkadot/types-codec";
+import type { Codec, ITuple } from "@polkadot/types-codec/types";
+import type { AccountId32, H160, Perbill, Permill } from "@polkadot/types/interfaces/runtime";
+import { SpWeightsWeightV2Weight, FrameSupportPalletId, StagingXcmV4AssetAssetId, FrameSystemLimitsBlockLength, FrameSystemLimitsBlockWeights, SpWeightsRuntimeDbWeight, SpVersionRuntimeVersion } from "@polkadot/types/lookup";
 export type __AugmentedConst<ApiType extends ApiTypes> = AugmentedConst<ApiType>;
-declare module '@polkadot/api-base/types/consts' {
+declare module "@polkadot/api-base/types/consts" {
     interface AugmentedConsts<ApiType extends ApiTypes> {
         assets: {
             /**
@@ -525,9 +525,28 @@ declare module '@polkadot/api-base/types/consts' {
              **/
             [key: string]: Codec;
         };
-        jobs: {
+        lst: {
             /**
-             * `PalletId` for the jobs pallet.
+             * The maximum pool points-to-balance ratio that an `open` pool can have.
+             *
+             * This is important in the event slashing takes place and the pool's points-to-balance
+             * ratio becomes disproportional.
+             *
+             * Moreover, this relates to the `RewardCounter` type as well, as the arithmetic operations
+             * are a function of number of points, and by setting this value to e.g. 10, you ensure
+             * that the total number of points in the system are at most 10 times the total_issuance of
+             * the chain, in the absolute worse case.
+             *
+             * For a value of 10, the threshold would be a pool points-to-balance ratio of 10:1.
+             * Such a scenario would also be the equivalent of the pool being 90% slashed.
+             **/
+            maxPointsToBalance: u8 & AugmentedConst<ApiType>;
+            /**
+             * The maximum number of simultaneous unbonding chunks that can exist per member.
+             **/
+            maxUnbonding: u32 & AugmentedConst<ApiType>;
+            /**
+             * The nomination pool's pallet id.
              **/
             palletId: FrameSupportPalletId & AugmentedConst<ApiType>;
             /**
@@ -537,11 +556,11 @@ declare module '@polkadot/api-base/types/consts' {
         };
         multiAssetDelegation: {
             /**
-             * The duration for which the bond is locked.
+             * The duration for which the stake is locked.
              **/
             bondDuration: u32 & AugmentedConst<ApiType>;
             /**
-             * Number of rounds that delegation bond less requests must wait before being executable.
+             * Number of rounds that delegation unstake requests must wait before being executable.
              **/
             delegationBondLessDelay: u32 & AugmentedConst<ApiType>;
             /**
@@ -553,15 +572,15 @@ declare module '@polkadot/api-base/types/consts' {
              **/
             leaveOperatorsDelay: u32 & AugmentedConst<ApiType>;
             /**
-             * The minimum amount of bond required for a delegate.
+             * The minimum amount of stake required for a delegate.
              **/
             minDelegateAmount: u128 & AugmentedConst<ApiType>;
             /**
-             * The minimum amount of bond required for an operator.
+             * The minimum amount of stake required for an operator.
              **/
             minOperatorBondAmount: u128 & AugmentedConst<ApiType>;
             /**
-             * Number of rounds operator requests to decrease self-bond must wait to be executable.
+             * Number of rounds operator requests to decrease self-stake must wait to be executable.
              **/
             operatorBondLessDelay: u32 & AugmentedConst<ApiType>;
             /**
@@ -666,16 +685,6 @@ declare module '@polkadot/api-base/types/consts' {
              **/
             [key: string]: Codec;
         };
-        roles: {
-            /**
-             * Max roles per account.
-             **/
-            maxRolesPerAccount: u32 & AugmentedConst<ApiType>;
-            /**
-             * Generic const
-             **/
-            [key: string]: Codec;
-        };
         scheduler: {
             /**
              * The maximum weight that may be scheduled per block for any dispatchables.
@@ -694,6 +703,92 @@ declare module '@polkadot/api-base/types/consts' {
              **/
             [key: string]: Codec;
         };
+        services: {
+            /**
+             * Maximum number of binaries per gadget.
+             **/
+            maxBinariesPerGadget: u32 & AugmentedConst<ApiType>;
+            /**
+             * binary name maximum length.
+             **/
+            maxBinaryNameLength: u32 & AugmentedConst<ApiType>;
+            /**
+             * Maximum number of blueprints per operator.
+             **/
+            maxBlueprintsPerOperator: u32 & AugmentedConst<ApiType>;
+            /**
+             * Container image name maximum length.
+             **/
+            maxContainerImageNameLength: u32 & AugmentedConst<ApiType>;
+            /**
+             * Container image tag maximum length.
+             **/
+            maxContainerImageTagLength: u32 & AugmentedConst<ApiType>;
+            /**
+             * Container registry maximum length.
+             **/
+            maxContainerRegistryLength: u32 & AugmentedConst<ApiType>;
+            /**
+             * Maximum number of fields in a job call.
+             **/
+            maxFields: u32 & AugmentedConst<ApiType>;
+            /**
+             * Maximum size of a field in a job call.
+             **/
+            maxFieldsSize: u32 & AugmentedConst<ApiType>;
+            /**
+             * Git owner maximum length.
+             **/
+            maxGitOwnerLength: u32 & AugmentedConst<ApiType>;
+            /**
+             * Git repository maximum length.
+             **/
+            maxGitRepoLength: u32 & AugmentedConst<ApiType>;
+            /**
+             * Git tag maximum length.
+             **/
+            maxGitTagLength: u32 & AugmentedConst<ApiType>;
+            /**
+             * IPFS hash maximum length.
+             **/
+            maxIpfsHashLength: u32 & AugmentedConst<ApiType>;
+            /**
+             * Maximum number of jobs per service.
+             **/
+            maxJobsPerService: u32 & AugmentedConst<ApiType>;
+            /**
+             * Maximum length of metadata string length.
+             **/
+            maxMetadataLength: u32 & AugmentedConst<ApiType>;
+            /**
+             * Maximum number of Operators per service.
+             **/
+            maxOperatorsPerService: u32 & AugmentedConst<ApiType>;
+            /**
+             * Maximum number of permitted callers per service.
+             **/
+            maxPermittedCallers: u32 & AugmentedConst<ApiType>;
+            /**
+             * Maximum number of services per operator.
+             **/
+            maxServicesPerOperator: u32 & AugmentedConst<ApiType>;
+            /**
+             * Maximum number of services per user.
+             **/
+            maxServicesPerUser: u32 & AugmentedConst<ApiType>;
+            /**
+             * Maximum number of sources per gadget.
+             **/
+            maxSourcesPerGadget: u32 & AugmentedConst<ApiType>;
+            /**
+             * `PalletId` for the services pallet.
+             **/
+            palletId: FrameSupportPalletId & AugmentedConst<ApiType>;
+            /**
+             * Generic const
+             **/
+            [key: string]: Codec;
+        };
         staking: {
             /**
              * Number of eras that staked funds must remain bonded for.