@polymeshassociation/polymesh-sdk 23.0.0-beta.1 → 23.0.0-beta.2

package/polkadot/augment-api-tx.d.ts

@@ -3,7 +3,7 @@ import type { ApiTypes, AugmentedSubmittable, SubmittableExtrinsic, SubmittableE
 import type { BTreeSet, Bytes, Compact, Option, U8aFixed, Vec, bool, u128, u16, u32, u64, u8 } from '@polkadot/types-codec';
 import type { AnyNumber, IMethod, ITuple } from '@polkadot/types-codec/types';
 import type { AccountId32, Call, H256, MultiAddress, Perbill, Percent, Permill } from '@polkadot/types/interfaces/runtime';
-import type { PalletBridgeBridgeTx, PalletContractsWasmDeterminism, PalletCorporateActionsBallotBallotMeta, PalletCorporateActionsBallotBallotTimeRange, PalletCorporateActionsBallotBallotVote, PalletCorporateActionsCaId, PalletCorporateActionsCaKind, PalletCorporateActionsInitiateCorporateActionArgs, PalletCorporateActionsRecordDateSpec, PalletCorporateActionsTargetIdentities, PalletImOnlineHeartbeat, PalletImOnlineSr25519AppSr25519Signature, PalletPipsSnapshotResult, PalletStakingCompactAssignments, PalletStakingElectionSize, PalletStakingRewardDestination, PalletStakingSlashingSwitch, PalletStakingValidatorPrefs, PalletStoPriceTier, PalletUtilityUniqueCall, PolymeshCommonUtilitiesCheckpointScheduleCheckpoints, PolymeshCommonUtilitiesIdentityCreateChildIdentityWithAuth, PolymeshCommonUtilitiesIdentitySecondaryKeyWithAuth, PolymeshCommonUtilitiesMaybeBlock, PolymeshCommonUtilitiesProtocolFeeProtocolOp, PolymeshContractsChainExtensionExtrinsicId, PolymeshPrimitivesAgentAgentGroup, PolymeshPrimitivesAssetAssetType, PolymeshPrimitivesAssetIdentifier, PolymeshPrimitivesAssetMetadataAssetMetadataKey, PolymeshPrimitivesAssetMetadataAssetMetadataSpec, PolymeshPrimitivesAssetMetadataAssetMetadataValueDetail, PolymeshPrimitivesAssetNonFungibleType, PolymeshPrimitivesAuthorizationAuthorizationData, PolymeshPrimitivesBeneficiary, PolymeshPrimitivesComplianceManagerComplianceRequirement, PolymeshPrimitivesCondition, PolymeshPrimitivesConditionTrustedIssuer, PolymeshPrimitivesDocument, PolymeshPrimitivesIdentityClaimClaim, PolymeshPrimitivesIdentityClaimClaimType, PolymeshPrimitivesIdentityClaimScope, PolymeshPrimitivesIdentityId, PolymeshPrimitivesIdentityIdPortfolioId, PolymeshPrimitivesIdentityIdPortfolioKind, PolymeshPrimitivesMemo, PolymeshPrimitivesNftNftCollectionKeys, PolymeshPrimitivesNftNftMetadataAttribute, PolymeshPrimitivesPortfolioFund, PolymeshPrimitivesPosRatio, PolymeshPrimitivesSecondaryKey, PolymeshPrimitivesSecondaryKeyPermissions, PolymeshPrimitivesSecondaryKeySignatory, PolymeshPrimitivesSettlementAffirmationCount, PolymeshPrimitivesSettlementAssetCount, PolymeshPrimitivesSettlementLeg, PolymeshPrimitivesSettlementReceiptDetails, PolymeshPrimitivesSettlementSettlementType, PolymeshPrimitivesSettlementVenueType, PolymeshPrimitivesStatisticsAssetScope, PolymeshPrimitivesStatisticsStatType, PolymeshPrimitivesStatisticsStatUpdate, PolymeshPrimitivesSubsetSubsetRestrictionPalletPermissions, PolymeshPrimitivesTicker, PolymeshPrimitivesTransferComplianceTransferCondition, PolymeshPrimitivesTransferComplianceTransferConditionExemptKey, PolymeshRuntimeDevelopRuntimeOriginCaller, PolymeshRuntimeDevelopRuntimeSessionKeys, SpConsensusBabeDigestsNextConfigDescriptor, SpConsensusGrandpaEquivocationProof, SpConsensusSlotsEquivocationProof, SpNposElectionsElectionScore, SpRuntimeMultiSignature, SpSessionMembershipProof, SpWeightsWeightV2Weight } from "./types-lookup.ts";
+import type { PalletBridgeBridgeTx, PalletContractsWasmDeterminism, PalletCorporateActionsBallotBallotMeta, PalletCorporateActionsBallotBallotTimeRange, PalletCorporateActionsBallotBallotVote, PalletCorporateActionsCaId, PalletCorporateActionsCaKind, PalletCorporateActionsInitiateCorporateActionArgs, PalletCorporateActionsRecordDateSpec, PalletCorporateActionsTargetIdentities, PalletImOnlineHeartbeat, PalletImOnlineSr25519AppSr25519Signature, PalletPipsSnapshotResult, PalletStakingCompactAssignments, PalletStakingElectionSize, PalletStakingRewardDestination, PalletStakingSlashingSwitch, PalletStakingValidatorPrefs, PalletStoPriceTier, PalletUtilityUniqueCall, PolymeshCommonUtilitiesCheckpointScheduleCheckpoints, PolymeshCommonUtilitiesIdentityCreateChildIdentityWithAuth, PolymeshCommonUtilitiesIdentitySecondaryKeyWithAuth, PolymeshCommonUtilitiesMaybeBlock, PolymeshCommonUtilitiesProtocolFeeProtocolOp, PolymeshContractsApi, PolymeshContractsChainExtensionExtrinsicId, PolymeshContractsNextUpgrade, PolymeshPrimitivesAgentAgentGroup, PolymeshPrimitivesAssetAssetType, PolymeshPrimitivesAssetIdentifier, PolymeshPrimitivesAssetMetadataAssetMetadataKey, PolymeshPrimitivesAssetMetadataAssetMetadataSpec, PolymeshPrimitivesAssetMetadataAssetMetadataValueDetail, PolymeshPrimitivesAssetNonFungibleType, PolymeshPrimitivesAuthorizationAuthorizationData, PolymeshPrimitivesBeneficiary, PolymeshPrimitivesComplianceManagerComplianceRequirement, PolymeshPrimitivesCondition, PolymeshPrimitivesConditionTrustedIssuer, PolymeshPrimitivesDocument, PolymeshPrimitivesIdentityClaimClaim, PolymeshPrimitivesIdentityClaimClaimType, PolymeshPrimitivesIdentityClaimScope, PolymeshPrimitivesIdentityId, PolymeshPrimitivesIdentityIdPortfolioId, PolymeshPrimitivesIdentityIdPortfolioKind, PolymeshPrimitivesMemo, PolymeshPrimitivesNftNfTs, PolymeshPrimitivesNftNftCollectionKeys, PolymeshPrimitivesNftNftMetadataAttribute, PolymeshPrimitivesPortfolioFund, PolymeshPrimitivesPosRatio, PolymeshPrimitivesSecondaryKey, PolymeshPrimitivesSecondaryKeyPermissions, PolymeshPrimitivesSecondaryKeySignatory, PolymeshPrimitivesSettlementAffirmationCount, PolymeshPrimitivesSettlementAssetCount, PolymeshPrimitivesSettlementLeg, PolymeshPrimitivesSettlementReceiptDetails, PolymeshPrimitivesSettlementSettlementType, PolymeshPrimitivesSettlementVenueType, PolymeshPrimitivesStatisticsAssetScope, PolymeshPrimitivesStatisticsStatType, PolymeshPrimitivesStatisticsStatUpdate, PolymeshPrimitivesSubsetSubsetRestrictionPalletPermissions, PolymeshPrimitivesTicker, PolymeshPrimitivesTransferComplianceTransferCondition, PolymeshPrimitivesTransferComplianceTransferConditionExemptKey, PolymeshRuntimeDevelopRuntimeOriginCaller, PolymeshRuntimeDevelopRuntimeSessionKeys, SpConsensusBabeDigestsNextConfigDescriptor, SpConsensusGrandpaEquivocationProof, SpConsensusSlotsEquivocationProof, SpNposElectionsElectionScore, SpRuntimeMultiSignature, SpSessionMembershipProof, SpWeightsWeightV2Weight } from "./types-lookup.ts";
 export declare type __AugmentedSubmittable = AugmentedSubmittable<() => unknown>;
 export declare type __SubmittableExtrinsic<ApiType extends ApiTypes> = SubmittableExtrinsic<ApiType>;
 export declare type __SubmittableExtrinsicFunction<ApiType extends ApiTypes> = SubmittableExtrinsicFunction<ApiType>;
@@ -179,7 +179,7 @@ declare module '@polkadot/api-base/types/submittable' {
                 PolymeshPrimitivesTicker
             ]>;
             /**
-             * Freezes transfers and minting of a given token.
+             * Freezes transfers of a given token.
              *
              * # Arguments
              * * `origin` - the secondary key of the sender.
@@ -593,7 +593,7 @@ declare module '@polkadot/api-base/types/submittable' {
                 Bytes
             ]>;
             /**
-             * Unfreezes transfers and minting of a given token.
+             * Unfreezes transfers of a given token.
              *
              * # Arguments
              * * `origin` - the secondary key of the sender.
@@ -3025,6 +3025,7 @@ declare module '@polkadot/api-base/types/submittable' {
              *
              * # Arguments
              * * `auth_id` - Auth id of the authorization.
+             * #[deprecated(since = "6.1.0", note = "Identity based signers not supported")]
              **/
             acceptMultisigSignerAsIdentity: AugmentedSubmittable<(authId: u64 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [
                 u64
@@ -3294,6 +3295,36 @@ declare module '@polkadot/api-base/types/submittable' {
             ]>;
         };
         nft: {
+            /**
+             * Forces the transfer of NFTs from a given portfolio to the caller's portfolio.
+             *
+             * # Arguments
+             * * `origin` - is a signer that has permissions to act as an agent of `ticker`.
+             * * `ticker` - the [`Ticker`] of the NFT collection.
+             * * `nft_id` - the [`NFTId`] of the NFT to be transferred.
+             * * `source_portfolio` - the [`PortfolioId`] that currently holds the NFT.
+             * * `callers_portfolio_kind` - the [`PortfolioKind`] of the caller's portfolio.
+             *
+             * # Permissions
+             * * Asset
+             * * Portfolio
+             **/
+            controllerTransfer: AugmentedSubmittable<(ticker: PolymeshPrimitivesTicker | string | Uint8Array, nfts: PolymeshPrimitivesNftNfTs | {
+                ticker?: any;
+                ids?: any;
+            } | string | Uint8Array, sourcePortfolio: PolymeshPrimitivesIdentityIdPortfolioId | {
+                did?: any;
+                kind?: any;
+            } | string | Uint8Array, callersPortfolioKind: PolymeshPrimitivesIdentityIdPortfolioKind | {
+                Default: any;
+            } | {
+                User: any;
+            } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
+                PolymeshPrimitivesTicker,
+                PolymeshPrimitivesNftNfTs,
+                PolymeshPrimitivesIdentityIdPortfolioId,
+                PolymeshPrimitivesIdentityIdPortfolioKind
+            ]>;
             /**
              * Cretes a new `NFTCollection`.
              *
@@ -3680,6 +3711,31 @@ declare module '@polkadot/api-base/types/submittable' {
             ]>;
         };
         polymeshContracts: {
+            /**
+             * Instantiates a smart contract defining it with the given `code` and `salt`.
+             *
+             * The contract will be attached as a primary key of a newly created child identity of the caller.
+             *
+             * # Arguments
+             * - `endowment`: Amount of POLYX to transfer to the contract.
+             * - `gas_limit`: For how much gas the `deploy` code in the contract may at most consume.
+             * - `storage_deposit_limit`: The maximum amount of balance that can be charged/reserved from the caller to pay for the storage consumed.
+             * - `code`: The WASM binary defining the smart contract.
+             * - `data`: The input data to pass to the contract constructor.
+             * - `salt`: Used for contract address derivation. By varying this, the same `code` can be used under the same identity.
+             *
+             **/
+            instantiateWithCodeAsPrimaryKey: AugmentedSubmittable<(endowment: u128 | AnyNumber | Uint8Array, gasLimit: SpWeightsWeightV2Weight | {
+                refTime?: any;
+                proofSize?: any;
+            } | string | Uint8Array, storageDepositLimit: Option<u128> | null | Uint8Array | u128 | AnyNumber, code: Bytes | string | Uint8Array, data: Bytes | string | Uint8Array, salt: Bytes | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
+                u128,
+                SpWeightsWeightV2Weight,
+                Option<u128>,
+                Bytes,
+                Bytes,
+                Bytes
+            ]>;
             /**
              * Instantiates a smart contract defining it with the given `code` and `salt`.
              *
@@ -3722,6 +3778,33 @@ declare module '@polkadot/api-base/types/submittable' {
                 Bytes,
                 PolymeshPrimitivesSecondaryKeyPermissions
             ]>;
+            /**
+             * Instantiates a smart contract defining using the given `code_hash` and `salt`.
+             *
+             * Unlike `instantiate_with_code`, this assumes that at least one contract with the same WASM code has already been uploaded.
+             *
+             * The contract will be attached as a primary key of a newly created child identity of the caller.
+             *
+             * # Arguments
+             * - `endowment`: amount of POLYX to transfer to the contract.
+             * - `gas_limit`: for how much gas the `deploy` code in the contract may at most consume.
+             * - `storage_deposit_limit`: The maximum amount of balance that can be charged/reserved from the caller to pay for the storage consumed.
+             * - `code_hash`: of an already uploaded WASM binary.
+             * - `data`: The input data to pass to the contract constructor.
+             * - `salt`: used for contract address derivation. By varying this, the same `code` can be used under the same identity.
+             *
+             **/
+            instantiateWithHashAsPrimaryKey: AugmentedSubmittable<(endowment: u128 | AnyNumber | Uint8Array, gasLimit: SpWeightsWeightV2Weight | {
+                refTime?: any;
+                proofSize?: any;
+            } | string | Uint8Array, storageDepositLimit: Option<u128> | null | Uint8Array | u128 | AnyNumber, codeHash: H256 | string | Uint8Array, data: Bytes | string | Uint8Array, salt: Bytes | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
+                u128,
+                SpWeightsWeightV2Weight,
+                Option<u128>,
+                H256,
+                Bytes,
+                Bytes
+            ]>;
             /**
              * Instantiates a smart contract defining using the given `code_hash` and `salt`.
              *
@@ -3777,11 +3860,43 @@ declare module '@polkadot/api-base/types/submittable' {
             updateCallRuntimeWhitelist: AugmentedSubmittable<(updates: Vec<ITuple<[PolymeshContractsChainExtensionExtrinsicId, bool]>> | [PolymeshContractsChainExtensionExtrinsicId, bool | boolean | Uint8Array][]) => SubmittableExtrinsic<ApiType>, [
                 Vec<ITuple<[PolymeshContractsChainExtensionExtrinsicId, bool]>>
             ]>;
+            upgradeApi: AugmentedSubmittable<(api: PolymeshContractsApi | {
+                desc?: any;
+                major?: any;
+            } | string | Uint8Array, nextUpgrade: PolymeshContractsNextUpgrade | {
+                chainVersion?: any;
+                apiHash?: any;
+            } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
+                PolymeshContractsApi,
+                PolymeshContractsNextUpgrade
+            ]>;
         };
         portfolio: {
             acceptPortfolioCustody: AugmentedSubmittable<(authId: u64 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [
                 u64
             ]>;
+            /**
+             * Adds an identity that will be allowed to create and take custody of a portfolio under the caller's identity.
+             *
+             * # Arguments
+             * * `trusted_identity` - the [`IdentityId`] that will be allowed to call `create_custody_portfolio`.
+             *
+             **/
+            allowIdentityToCreatePortfolios: AugmentedSubmittable<(trustedIdentity: PolymeshPrimitivesIdentityId | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
+                PolymeshPrimitivesIdentityId
+            ]>;
+            /**
+             * Creates a portfolio under the `portfolio_owner_id` identity and transfers its custody to the caller's identity.
+             *
+             * # Arguments
+             * * `portfolio_owner_id` - the [`IdentityId`] that will own the new portfolio.
+             * * `portfolio_name` - the [`PortfolioName`] of the new portfolio.
+             *
+             **/
+            createCustodyPortfolio: AugmentedSubmittable<(portfolioOwnerId: PolymeshPrimitivesIdentityId | string | Uint8Array, portfolioName: Bytes | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
+                PolymeshPrimitivesIdentityId,
+                Bytes
+            ]>;
             /**
              * Creates a portfolio with the given `name`.
              **/
@@ -3900,6 +4015,16 @@ declare module '@polkadot/api-base/types/submittable' {
                 u64,
                 Bytes
             ]>;
+            /**
+             * Removes permission of an identity to create and take custody of a portfolio under the caller's identity.
+             *
+             * # Arguments
+             * * `identity` - the [`IdentityId`] that will have the permissions to call `create_custody_portfolio` revoked.
+             *
+             **/
+            revokeCreatePortfoliosPermission: AugmentedSubmittable<(identity: PolymeshPrimitivesIdentityId | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
+                PolymeshPrimitivesIdentityId
+            ]>;
         };
         preimage: {
             /**