1import {ApiPromise, WsProvider} from '@polkadot/api';2import type {IKeyringPair} from '@polkadot/types/types';3import {ChainHelperBase, EthereumBalanceGroup, HelperGroup, SubstrateBalanceGroup, UniqueHelper} from './unique.js';4import type {ILogger, TSigner, TSubstrateAccount} from './types.js';5import type {AcalaAssetMetadata, DemocracyStandardAccountVote, IForeignAssetMetadata, MoonbeamAssetInfo} from './types.xcm.js';678export class XcmChainHelper extends ChainHelperBase {9 override async connect(wsEndpoint: string, _listeners?: any): Promise<void> {10 const wsProvider = new WsProvider(wsEndpoint);11 this.api = new ApiPromise({12 provider: wsProvider,13 });14 await this.api.isReadyOrError;15 this.network = await UniqueHelper.detectNetwork(this.api);16 }17}1819class AcalaAssetRegistryGroup extends HelperGroup<AcalaHelper> {20 async registerForeignAsset(signer: TSigner, destination: any, metadata: AcalaAssetMetadata) {21 await this.helper.executeExtrinsic(signer, 'api.tx.assetRegistry.registerForeignAsset', [destination, metadata], true);22 }23}2425class MoonbeamAssetManagerGroup extends HelperGroup<MoonbeamHelper> {26 makeRegisterForeignAssetProposal(assetInfo: MoonbeamAssetInfo) {27 const apiPrefix = 'api.tx.assetManager.';2829 const registerTx = this.helper.constructApiCall(30 apiPrefix + 'registerForeignAsset',31 [assetInfo.location, assetInfo.metadata, assetInfo.existentialDeposit, assetInfo.isSufficient],32 );3334 const setUnitsTx = this.helper.constructApiCall(35 apiPrefix + 'setAssetUnitsPerSecond',36 [assetInfo.location, assetInfo.unitsPerSecond, assetInfo.numAssetsWeightHint],37 );3839 const batchCall = this.helper.getApi().tx.utility.batchAll([registerTx, setUnitsTx]);40 const encodedProposal = batchCall?.method.toHex() || '';41 return encodedProposal;42 }4344 async assetTypeId(location: any) {45 return await this.helper.callRpc('api.query.assetManager.assetTypeId', [location]);46 }47}4849class MoonbeamDemocracyGroup extends HelperGroup<MoonbeamHelper> {50 notePreimagePallet: string;5152 constructor(helper: MoonbeamHelper, options: { [key: string]: any } = {}) {53 super(helper);54 this.notePreimagePallet = options.notePreimagePallet;55 }5657 async notePreimage(signer: TSigner, encodedProposal: string) {58 await this.helper.executeExtrinsic(signer, `api.tx.${this.notePreimagePallet}.notePreimage`, [encodedProposal], true);59 }6061 externalProposeMajority(proposal: any) {62 return this.helper.constructApiCall('api.tx.democracy.externalProposeMajority', [proposal]);63 }6465 fastTrack(proposalHash: string, votingPeriod: number, delayPeriod: number) {66 return this.helper.constructApiCall('api.tx.democracy.fastTrack', [proposalHash, votingPeriod, delayPeriod]);67 }6869 async referendumVote(signer: TSigner, referendumIndex: number, accountVote: DemocracyStandardAccountVote) {70 await this.helper.executeExtrinsic(signer, 'api.tx.democracy.vote', [referendumIndex, {Standard: accountVote}], true);71 }72}7374class MoonbeamCollectiveGroup extends HelperGroup<MoonbeamHelper> {75 collective: string;7677 constructor(helper: MoonbeamHelper, collective: string) {78 super(helper);7980 this.collective = collective;81 }8283 async propose(signer: TSigner, threshold: number, proposalHash: string, lengthBound: number) {84 await this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.propose`, [threshold, proposalHash, lengthBound], true);85 }8687 async vote(signer: TSigner, proposalHash: string, proposalIndex: number, approve: boolean) {88 await this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.vote`, [proposalHash, proposalIndex, approve], true);89 }9091 async close(signer: TSigner, proposalHash: string, proposalIndex: number, weightBound: any, lengthBound: number) {92 await this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.close`, [proposalHash, proposalIndex, weightBound, lengthBound], true);93 }9495 async proposalCount() {96 return Number(await this.helper.callRpc(`api.query.${this.collective}.proposalCount`, []));97 }98}99100class PolkadexXcmHelperGroup<T extends ChainHelperBase> extends HelperGroup<T> {101 async whitelistToken(signer: TSigner, assetId: any) {102 await this.helper.executeExtrinsic(signer, 'api.tx.xcmHelper.whitelistToken', [assetId], true);103 }104}105106export class ForeignAssetsGroup extends HelperGroup<UniqueHelper> {107 async register(signer: TSigner, ownerAddress: TSubstrateAccount, location: any, metadata: IForeignAssetMetadata) {108 await this.helper.executeExtrinsic(109 signer,110 'api.tx.foreignAssets.registerForeignAsset',111 [ownerAddress, location, metadata],112 true,113 );114 }115116 async update(signer: TSigner, foreignAssetId: number, location: any, metadata: IForeignAssetMetadata) {117 await this.helper.executeExtrinsic(118 signer,119 'api.tx.foreignAssets.updateForeignAsset',120 [foreignAssetId, location, metadata],121 true,122 );123 }124}125126export class XcmGroup<T extends ChainHelperBase> extends HelperGroup<T> {127 palletName: string;128129 constructor(helper: T, palletName: string) {130 super(helper);131132 this.palletName = palletName;133 }134135 async limitedReserveTransferAssets(signer: TSigner, destination: any, beneficiary: any, assets: any, feeAssetItem: number, weightLimit: any) {136 await this.helper.executeExtrinsic(signer, `api.tx.${this.palletName}.limitedReserveTransferAssets`, [destination, beneficiary, assets, feeAssetItem, weightLimit], true);137 }138139 async setSafeXcmVersion(signer: TSigner, version: number) {140 await this.helper.executeExtrinsic(signer, `api.tx.${this.palletName}.forceDefaultXcmVersion`, [version], true);141 }142143 async teleportAssets(signer: TSigner, destination: any, beneficiary: any, assets: any, feeAssetItem: number) {144 await this.helper.executeExtrinsic(signer, `api.tx.${this.palletName}.teleportAssets`, [destination, beneficiary, assets, feeAssetItem], true);145 }146147 async teleportNativeAsset(signer: TSigner, destinationParaId: number, targetAccount: Uint8Array, amount: bigint, xcmVersion = 3) {148 const destinationContent = {149 parents: 0,150 interior: {151 X1: {152 Parachain: destinationParaId,153 },154 },155 };156157 const beneficiaryContent = {158 parents: 0,159 interior: {160 X1: {161 AccountId32: {162 network: 'Any',163 id: targetAccount,164 },165 },166 },167 };168169 const assetsContent = [170 {171 id: {172 Concrete: {173 parents: 0,174 interior: 'Here',175 },176 },177 fun: {178 Fungible: amount,179 },180 },181 ];182183 let destination;184 let beneficiary;185 let assets;186187 if(xcmVersion == 2) {188 destination = {V1: destinationContent};189 beneficiary = {V1: beneficiaryContent};190 assets = {V1: assetsContent};191192 } else if(xcmVersion == 3) {193 destination = {V2: destinationContent};194 beneficiary = {V2: beneficiaryContent};195 assets = {V2: assetsContent};196197 } else {198 throw Error('Unknown XCM version: ' + xcmVersion);199 }200201 const feeAssetItem = 0;202203 await this.teleportAssets(signer, destination, beneficiary, assets, feeAssetItem);204 }205206 async send(signer: IKeyringPair, destination: any, message: any) {207 await this.helper.executeExtrinsic(208 signer,209 `api.tx.${this.palletName}.send`,210 [211 destination,212 message,213 ],214 true,215 );216 }217}218219export class XTokensGroup<T extends ChainHelperBase> extends HelperGroup<T> {220 async transfer(signer: TSigner, currencyId: any, amount: bigint, destination: any, destWeight: any) {221 await this.helper.executeExtrinsic(signer, 'api.tx.xTokens.transfer', [currencyId, amount, destination, destWeight], true);222 }223224 async transferMultiasset(signer: TSigner, asset: any, destination: any, destWeight: any) {225 await this.helper.executeExtrinsic(signer, 'api.tx.xTokens.transferMultiasset', [asset, destination, destWeight], true);226 }227228 async transferMulticurrencies(signer: TSigner, currencies: any[], feeItem: number, destLocation: any, destWeight: any) {229 await this.helper.executeExtrinsic(signer, 'api.tx.xTokens.transferMulticurrencies', [currencies, feeItem, destLocation, destWeight], true);230 }231}232233234235export class TokensGroup<T extends ChainHelperBase> extends HelperGroup<T> {236 async accounts(address: string, currencyId: any) {237 const {free} = (await this.helper.callRpc('api.query.tokens.accounts', [address, currencyId])).toJSON() as any;238 return BigInt(free);239 }240}241242export class AssetsGroup<T extends ChainHelperBase> extends HelperGroup<T> {243 async create(signer: TSigner, assetId: number | bigint, admin: string, minimalBalance: bigint) {244 await this.helper.executeExtrinsic(signer, 'api.tx.assets.create', [assetId, admin, minimalBalance], true);245 }246247 async forceCreate(signer: TSigner, assetId: number | bigint, admin: string, minimalBalance: bigint, isSufficient = true) {248 await this.helper.executeExtrinsic(signer, 'api.tx.assets.forceCreate', [assetId, admin, isSufficient, minimalBalance], true);249 }250251 async setMetadata(signer: TSigner, assetId: number | bigint, name: string, symbol: string, decimals: number) {252 await this.helper.executeExtrinsic(signer, 'api.tx.assets.setMetadata', [assetId, name, symbol, decimals], true);253 }254255 async mint(signer: TSigner, assetId: number | bigint, beneficiary: string, amount: bigint) {256 await this.helper.executeExtrinsic(signer, 'api.tx.assets.mint', [assetId, beneficiary, amount], true);257 }258259 async account(assetId: string | number | bigint, address: string) {260 const accountAsset = (261 await this.helper.callRpc('api.query.assets.account', [assetId, address])262 ).toJSON()! as any;263264 if(accountAsset !== null) {265 return BigInt(accountAsset['balance']);266 } else {267 return null;268 }269 }270}271272export class RelayHelper extends XcmChainHelper {273 balance: SubstrateBalanceGroup<RelayHelper>;274 xcm: XcmGroup<RelayHelper>;275276 constructor(logger?: ILogger, options: { [key: string]: any } = {}) {277 super(logger, options.helperBase ?? RelayHelper);278279 this.balance = new SubstrateBalanceGroup(this);280 this.xcm = new XcmGroup(this, 'xcmPallet');281 }282}283284export class WestmintHelper extends XcmChainHelper {285 balance: SubstrateBalanceGroup<WestmintHelper>;286 xcm: XcmGroup<WestmintHelper>;287 assets: AssetsGroup<WestmintHelper>;288 xTokens: XTokensGroup<WestmintHelper>;289290 constructor(logger?: ILogger, options: { [key: string]: any } = {}) {291 super(logger, options.helperBase ?? WestmintHelper);292293 this.balance = new SubstrateBalanceGroup(this);294 this.xcm = new XcmGroup(this, 'polkadotXcm');295 this.assets = new AssetsGroup(this);296 this.xTokens = new XTokensGroup(this);297 }298}299300export class MoonbeamHelper extends XcmChainHelper {301 balance: EthereumBalanceGroup<MoonbeamHelper>;302 assetManager: MoonbeamAssetManagerGroup;303 assets: AssetsGroup<MoonbeamHelper>;304 xTokens: XTokensGroup<MoonbeamHelper>;305 democracy: MoonbeamDemocracyGroup;306 collective: {307 council: MoonbeamCollectiveGroup,308 techCommittee: MoonbeamCollectiveGroup,309 };310311 constructor(logger?: ILogger, options: { [key: string]: any } = {}) {312 super(logger, options.helperBase ?? MoonbeamHelper);313314 this.balance = new EthereumBalanceGroup(this);315 this.assetManager = new MoonbeamAssetManagerGroup(this);316 this.assets = new AssetsGroup(this);317 this.xTokens = new XTokensGroup(this);318 this.democracy = new MoonbeamDemocracyGroup(this, options);319 this.collective = {320 council: new MoonbeamCollectiveGroup(this, 'councilCollective'),321 techCommittee: new MoonbeamCollectiveGroup(this, 'techCommitteeCollective'),322 };323 }324}325326export class AstarHelper extends XcmChainHelper {327 balance: SubstrateBalanceGroup<AstarHelper>;328 assets: AssetsGroup<AstarHelper>;329 xcm: XcmGroup<AstarHelper>;330331 constructor(logger?: ILogger, options: { [key: string]: any } = {}) {332 super(logger, options.helperBase ?? AstarHelper);333334 this.balance = new SubstrateBalanceGroup(this);335 this.assets = new AssetsGroup(this);336 this.xcm = new XcmGroup(this, 'polkadotXcm');337 }338}339340export class AcalaHelper extends XcmChainHelper {341 balance: SubstrateBalanceGroup<AcalaHelper>;342 assetRegistry: AcalaAssetRegistryGroup;343 xTokens: XTokensGroup<AcalaHelper>;344 tokens: TokensGroup<AcalaHelper>;345 xcm: XcmGroup<AcalaHelper>;346347 constructor(logger?: ILogger, options: { [key: string]: any } = {}) {348 super(logger, options.helperBase ?? AcalaHelper);349350 this.balance = new SubstrateBalanceGroup(this);351 this.assetRegistry = new AcalaAssetRegistryGroup(this);352 this.xTokens = new XTokensGroup(this);353 this.tokens = new TokensGroup(this);354 this.xcm = new XcmGroup(this, 'polkadotXcm');355 }356}357358export class PolkadexHelper extends XcmChainHelper {359 assets: AssetsGroup<PolkadexHelper>;360 balance: SubstrateBalanceGroup<PolkadexHelper>;361 xTokens: XTokensGroup<PolkadexHelper>;362 xcm: XcmGroup<PolkadexHelper>;363 xcmHelper: PolkadexXcmHelperGroup<PolkadexHelper>;364365 constructor(logger?: ILogger, options: { [key: string]: any } = {}) {366 super(logger, options.helperBase ?? PolkadexHelper);367368 this.assets = new AssetsGroup(this);369 this.balance = new SubstrateBalanceGroup(this);370 this.xTokens = new XTokensGroup(this);371 this.xcm = new XcmGroup(this, 'polkadotXcm');372 this.xcmHelper = new PolkadexXcmHelperGroup(this);373 }374}375