@polymeshassociation/polymesh-sdk 23.0.0-alpha.2 → 23.0.0-alpha.21

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, PalletRewardsItnRewardStatus, 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, 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, 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";
 export declare type __AugmentedSubmittable = AugmentedSubmittable<() => unknown>;
 export declare type __SubmittableExtrinsic<ApiType extends ApiTypes> = SubmittableExtrinsic<ApiType>;
 export declare type __SubmittableExtrinsicFunction<ApiType extends ApiTypes> = SubmittableExtrinsicFunction<ApiType>;
@@ -3139,6 +3139,7 @@ declare module '@polkadot/api-base/types/submittable' {
              * * `expiry` - Optional proposal expiry time.
              * * `auto_close` - Close proposal on receiving enough reject votes.
              * If this is 1 out of `m` multisig, the proposal will be immediately executed.
+             * #[deprecated(since = "6.0.0", note = "Please use the `create_proposal_as_identity` and `approve_as_identity` instead")]
              **/
             createOrApproveProposalAsIdentity: AugmentedSubmittable<(multisig: AccountId32 | string | Uint8Array, proposal: Call | IMethod | string | Uint8Array, expiry: Option<u64> | null | Uint8Array | u64 | AnyNumber, autoClose: bool | boolean | Uint8Array) => SubmittableExtrinsic<ApiType>, [
                 AccountId32,
@@ -3155,6 +3156,7 @@ declare module '@polkadot/api-base/types/submittable' {
              * * `expiry` - Optional proposal expiry time.
              * * `auto_close` - Close proposal on receiving enough reject votes.
              * If this is 1 out of `m` multisig, the proposal will be immediately executed.
+             * #[deprecated(since = "6.0.0", note = "Please use the `create_proposal_as_key` and `approve_as_key` instead")]
              **/
             createOrApproveProposalAsKey: AugmentedSubmittable<(multisig: AccountId32 | string | Uint8Array, proposal: Call | IMethod | string | Uint8Array, expiry: Option<u64> | null | Uint8Array | u64 | AnyNumber, autoClose: bool | boolean | Uint8Array) => SubmittableExtrinsic<ApiType>, [
                 AccountId32,
@@ -3945,7 +3947,7 @@ declare module '@polkadot/api-base/types/submittable' {
              * # Errors
              * * `BadOrigin` - Only root allowed.
              **/
-            changeBaseFee: AugmentedSubmittable<(op: PolymeshCommonUtilitiesProtocolFeeProtocolOp | 'AssetRegisterTicker' | 'AssetIssue' | 'AssetAddDocuments' | 'AssetCreateAsset' | 'CheckpointCreateSchedule' | 'ComplianceManagerAddComplianceRequirement' | 'IdentityCddRegisterDid' | 'IdentityAddClaim' | 'IdentityAddSecondaryKeysWithAuthorization' | 'PipsPropose' | 'ContractsPutCode' | 'CorporateBallotAttachBallot' | 'CapitalDistributionDistribute' | 'NFTCreateCollection' | 'NFTMint' | number | Uint8Array, baseFee: u128 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [
+            changeBaseFee: AugmentedSubmittable<(op: PolymeshCommonUtilitiesProtocolFeeProtocolOp | 'AssetRegisterTicker' | 'AssetIssue' | 'AssetAddDocuments' | 'AssetCreateAsset' | 'CheckpointCreateSchedule' | 'ComplianceManagerAddComplianceRequirement' | 'IdentityCddRegisterDid' | 'IdentityAddClaim' | 'IdentityAddSecondaryKeysWithAuthorization' | 'PipsPropose' | 'ContractsPutCode' | 'CorporateBallotAttachBallot' | 'CapitalDistributionDistribute' | 'NFTCreateCollection' | 'NFTMint' | 'IdentityCreateChildIdentity' | number | Uint8Array, baseFee: u128 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [
                 PolymeshCommonUtilitiesProtocolFeeProtocolOp,
                 u128
             ]>;
@@ -4061,42 +4063,6 @@ declare module '@polkadot/api-base/types/submittable' {
                 u128
             ]>;
         };
-        rewards: {
-            /**
-             * Claim an ITN reward.
-             *
-             * ## Arguments
-             * * `itn_address` specifying the awarded address on ITN.
-             * * `signature` authenticating the claim to the reward.
-             * The signature should contain `reward_address` followed by the suffix `"claim_itn_reward"`,
-             * and must have been signed by `itn_address`.
-             *
-             * # Errors
-             * * `InsufficientBalance` - Itn rewards has insufficient funds to issue the reward.
-             * * `InvalidSignature` - `signature` had an invalid signer or invalid message.
-             * * `ItnRewardAlreadyClaimed` - Reward issued to the `itn_address` has already been claimed.
-             * * `UnknownItnAddress` - `itn_address` is not in the rewards table and has no reward to be claimed.
-             **/
-            claimItnReward: AugmentedSubmittable<(rewardAddress: AccountId32 | string | Uint8Array, itnAddress: AccountId32 | string | Uint8Array, signature: SpRuntimeMultiSignature | {
-                Ed25519: any;
-            } | {
-                Sr25519: any;
-            } | {
-                Ecdsa: any;
-            } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
-                AccountId32,
-                AccountId32,
-                SpRuntimeMultiSignature
-            ]>;
-            setItnRewardStatus: AugmentedSubmittable<(itnAddress: AccountId32 | string | Uint8Array, status: PalletRewardsItnRewardStatus | {
-                Unclaimed: any;
-            } | {
-                Claimed: any;
-            } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
-                AccountId32,
-                PalletRewardsItnRewardStatus
-            ]>;
-        };
         scheduler: {
             /**
              * Cancel an anonymously scheduled task.
@@ -4267,8 +4233,8 @@ declare module '@polkadot/api-base/types/submittable' {
              * Provide affirmation to an existing instruction.
              *
              * # Arguments
-             * * `id` - The `InstructionId` of the instruction to be affirmed.
-             * * `portfolios` - Portfolios that the sender controls and wants to affirm this instruction.
+             * * `id` - the [`InstructionId`] of the instruction being affirmed.
+             * * `portfolios` - a vector of [`PortfolioId`] under the caller's control and intended for affirmation.
              *
              * # Permissions
              * * Portfolio
@@ -4281,15 +4247,37 @@ declare module '@polkadot/api-base/types/submittable' {
                 Vec<PolymeshPrimitivesIdentityIdPortfolioId>
             ]>;
             /**
-             * Accepts an instruction and claims a signed receipt.
+             * Provide affirmation to an existing instruction.
+             *
+             * # Arguments
+             * * `id` - the [`InstructionId`] of the instruction being affirmed.
+             * * `portfolios` - a vector of [`PortfolioId`] under the caller's control and intended for affirmation.
+             * * `number_of_assets` - an optional [`AffirmationCount`] that will be used for a precise fee estimation before executing the extrinsic.
+             *
+             * Note: calling the rpc method `get_affirmation_count` returns an instance of [`AffirmationCount`].
+             *
+             * # Permissions
+             * * Portfolio
+             **/
+            affirmInstructionWithCount: AugmentedSubmittable<(id: u64 | AnyNumber | Uint8Array, portfolios: Vec<PolymeshPrimitivesIdentityIdPortfolioId> | (PolymeshPrimitivesIdentityIdPortfolioId | {
+                did?: any;
+                kind?: any;
+            } | string | Uint8Array)[], numberOfAssets: Option<PolymeshPrimitivesSettlementAffirmationCount> | null | Uint8Array | PolymeshPrimitivesSettlementAffirmationCount | {
+                senderAssetCount?: any;
+                receiverAssetCount?: any;
+                offchainCount?: any;
+            } | string) => SubmittableExtrinsic<ApiType>, [
+                u64,
+                Vec<PolymeshPrimitivesIdentityIdPortfolioId>,
+                Option<PolymeshPrimitivesSettlementAffirmationCount>
+            ]>;
+            /**
+             * Affirms an instruction using receipts for offchain transfers.
              *
              * # Arguments
-             * * `id` - Target instruction id.
-             * * `leg_id` - Target leg id for the receipt
-             * * `receipt_uid` - Receipt ID generated by the signer.
-             * * `signer` - Signer of the receipt.
-             * * `signed_data` - Signed receipt.
-             * * `portfolios` - Portfolios that the sender controls and wants to accept this instruction with.
+             * * `id` - the [`InstructionId`] of the instruction being affirmed.
+             * * `receipt_details` - a vector of [`ReceiptDetails`], which contain the details about the offchain transfer.
+             * * `portfolios` - a vector of [`PortfolioId`] under the caller's control and intended for affirmation.
              *
              * # Permissions
              * * Portfolio
@@ -4309,6 +4297,40 @@ declare module '@polkadot/api-base/types/submittable' {
                 Vec<PolymeshPrimitivesSettlementReceiptDetails>,
                 Vec<PolymeshPrimitivesIdentityIdPortfolioId>
             ]>;
+            /**
+             * Affirms an instruction using receipts for offchain transfers.
+             *
+             * # Arguments
+             * * `id` - the [`InstructionId`] of the instruction being affirmed.
+             * * `receipt_details` - a vector of [`ReceiptDetails`], which contain the details about the offchain transfer.
+             * * `portfolios` - a vector of [`PortfolioId`] under the caller's control and intended for affirmation.
+             * * `number_of_assets` - an optional [`AffirmationCount`] that will be used for a precise fee estimation before executing the extrinsic.
+             *
+             * Note: calling the rpc method `get_affirmation_count` returns an instance of [`AffirmationCount`].
+             *
+             * # Permissions
+             * * Portfolio
+             **/
+            affirmWithReceiptsWithCount: AugmentedSubmittable<(id: u64 | AnyNumber | Uint8Array, receiptDetails: Vec<PolymeshPrimitivesSettlementReceiptDetails> | (PolymeshPrimitivesSettlementReceiptDetails | {
+                uid?: any;
+                instructionId?: any;
+                legId?: any;
+                signer?: any;
+                signature?: any;
+                metadata?: any;
+            } | string | Uint8Array)[], portfolios: Vec<PolymeshPrimitivesIdentityIdPortfolioId> | (PolymeshPrimitivesIdentityIdPortfolioId | {
+                did?: any;
+                kind?: any;
+            } | string | Uint8Array)[], numberOfAssets: Option<PolymeshPrimitivesSettlementAffirmationCount> | null | Uint8Array | PolymeshPrimitivesSettlementAffirmationCount | {
+                senderAssetCount?: any;
+                receiverAssetCount?: any;
+                offchainCount?: any;
+            } | string) => SubmittableExtrinsic<ApiType>, [
+                u64,
+                Vec<PolymeshPrimitivesSettlementReceiptDetails>,
+                Vec<PolymeshPrimitivesIdentityIdPortfolioId>,
+                Option<PolymeshPrimitivesSettlementAffirmationCount>
+            ]>;
             /**
              * Allows additional venues to create instructions involving an asset.
              *
@@ -4393,8 +4415,8 @@ declare module '@polkadot/api-base/types/submittable' {
              * Rejects an existing instruction.
              *
              * # Arguments
-             * * `id` - Instruction id to reject.
-             * * `portfolio` - Portfolio to reject the instruction.
+             * * `id` - the [`InstructionId`] of the instruction being rejected.
+             * * `portfolio` - the [`PortfolioId`] that belongs to the instruction and is rejecting it.
              *
              * # Permissions
              * * Portfolio
@@ -4406,6 +4428,31 @@ declare module '@polkadot/api-base/types/submittable' {
                 u64,
                 PolymeshPrimitivesIdentityIdPortfolioId
             ]>;
+            /**
+             * Rejects an existing instruction.
+             *
+             * # Arguments
+             * * `id` - the [`InstructionId`] of the instruction being rejected.
+             * * `portfolio` - the [`PortfolioId`] that belongs to the instruction and is rejecting it.
+             * * `number_of_assets` - an optional [`AssetCount`] that will be used for a precise fee estimation before executing the extrinsic.
+             *
+             * Note: calling the rpc method `get_execute_instruction_info` returns an instance of [`ExecuteInstructionInfo`], which contain the asset count.
+             *
+             * # Permissions
+             * * Portfolio
+             **/
+            rejectInstructionWithCount: AugmentedSubmittable<(id: u64 | AnyNumber | Uint8Array, portfolio: PolymeshPrimitivesIdentityIdPortfolioId | {
+                did?: any;
+                kind?: any;
+            } | string | Uint8Array, numberOfAssets: Option<PolymeshPrimitivesSettlementAssetCount> | null | Uint8Array | PolymeshPrimitivesSettlementAssetCount | {
+                fungible?: any;
+                nonFungible?: any;
+                offChain?: any;
+            } | string) => SubmittableExtrinsic<ApiType>, [
+                u64,
+                PolymeshPrimitivesIdentityIdPortfolioId,
+                Option<PolymeshPrimitivesSettlementAssetCount>
+            ]>;
             /**
              * Enables or disabled venue filtering for a token.
              *
@@ -4455,8 +4502,8 @@ declare module '@polkadot/api-base/types/submittable' {
              * Withdraw an affirmation for a given instruction.
              *
              * # Arguments
-             * * `id` - Instruction id for that affirmation get withdrawn.
-             * * `portfolios` - Portfolios that the sender controls and wants to withdraw affirmation.
+             * * `id` - the [`InstructionId`] of the instruction getting an affirmation withdrawn.
+             * * `portfolios` - a vector of [`PortfolioId`] under the caller's control and intended for affirmation withdrawal.
              *
              * # Permissions
              * * Portfolio
@@ -4468,6 +4515,31 @@ declare module '@polkadot/api-base/types/submittable' {
                 u64,
                 Vec<PolymeshPrimitivesIdentityIdPortfolioId>
             ]>;
+            /**
+             * Withdraw an affirmation for a given instruction.
+             *
+             * # Arguments
+             * * `id` - the [`InstructionId`] of the instruction getting an affirmation withdrawn.
+             * * `portfolios` - a vector of [`PortfolioId`] under the caller's control and intended for affirmation withdrawal.
+             * * `number_of_assets` - an optional [`AffirmationCount`] that will be used for a precise fee estimation before executing the extrinsic.
+             *
+             * Note: calling the rpc method `get_affirmation_count` returns an instance of [`AffirmationCount`].
+             *
+             * # Permissions
+             * * Portfolio
+             **/
+            withdrawAffirmationWithCount: AugmentedSubmittable<(id: u64 | AnyNumber | Uint8Array, portfolios: Vec<PolymeshPrimitivesIdentityIdPortfolioId> | (PolymeshPrimitivesIdentityIdPortfolioId | {
+                did?: any;
+                kind?: any;
+            } | string | Uint8Array)[], numberOfAssets: Option<PolymeshPrimitivesSettlementAffirmationCount> | null | Uint8Array | PolymeshPrimitivesSettlementAffirmationCount | {
+                senderAssetCount?: any;
+                receiverAssetCount?: any;
+                offchainCount?: any;
+            } | string) => SubmittableExtrinsic<ApiType>, [
+                u64,
+                Vec<PolymeshPrimitivesIdentityIdPortfolioId>,
+                Option<PolymeshPrimitivesSettlementAffirmationCount>
+            ]>;
         };
         staking: {
             /**