@moonbeam-network/xcm-utils 4.2.2 → 4.2.4

package/README.md

@@ -1,20 +1,36 @@
-The Utils package contains the utility functions for the Moonbeam XCM SDK and MRL SDK.
+# @moonbeam-network/xcm-utils
 
-# Documentation for the Moonbeam XCM SDK
+Shared utility functions used across all other packages in the Moonbeam XCM SDK.
 
-## v3 (current)
+## Package Information
 
-### Usage
+**NPM Package:** [https://www.npmjs.com/package/@moonbeam-network/xcm-utils](https://www.npmjs.com/package/@moonbeam-network/xcm-utils)
+
+**Package Level:** Foundation (lowest level)  
+This package provides core utility functions and has no dependencies on other packages in the monorepo.
+
+## Documentation
+
+### v4 (current)
+
+#### Usage
 
 - [XCM SDK](https://moonbeam-foundation.github.io/xcm-sdk/latest/example-usage/xcm)
 - [MRL SDK](https://moonbeam-foundation.github.io/xcm-sdk/latest/example-usage/mrl)
 
-### References
+#### References
 
 - [XCM SDK](https://moonbeam-foundation.github.io/xcm-sdk/latest/reference/xcm)
 - [MRL SDK](https://moonbeam-foundation.github.io/xcm-sdk/latest/reference/mrl)
 
-## v2 (previous)
+### v3 (previous)
+
+#### Usage
+
+- [XCM SDK](https://moonbeam-foundation.github.io/xcm-sdk/v3/example-usage/xcm)
+- [MRL SDK](https://moonbeam-foundation.github.io/xcm-sdk/v3/example-usage/mrl)
+
+#### References
 
-- [usage](https://moonbeam-foundation.github.io/xcm-sdk/v2/example-usage)
-- [references](https://moonbeam-foundation.github.io/xcm-sdk/v2/reference/interfaces)
+- [XCM SDK](https://moonbeam-foundation.github.io/xcm-sdk/v3/reference/xcm)
+- [MRL SDK](https://moonbeam-foundation.github.io/xcm-sdk/v3/reference/mrl)

package/build/index.d.mts

@@ -0,0 +1,45 @@
+import { RoundingMode } from 'big.js';
+import { ApiPromise } from '@polkadot/api';
+
+declare function isHexString(asset: unknown): boolean;
+declare function isEthAddress(address: string): boolean;
+
+declare function formatAssetIdToERC20(id: string): string;
+declare function convertAddressTo32Bytes(address: string): string;
+
+declare function toDecimal(number: bigint | number | string, decimals: number, maxDecimal?: number, roundType?: RoundingMode): string;
+declare function toBigInt(amount: bigint | string | number, decimals: number): bigint;
+declare function convertDecimals(number: string | bigint, decimals: number, targetDecimals: number): bigint;
+declare function hasDecimalOverflow(fl: number | string, maxDecimal: number): boolean;
+
+/**
+ * reference: https://github.com/Moonsong-Labs/xcm-tools/blob/main/scripts/calculate-sovereign-account.ts
+ */
+declare function getSovereignAccountAddresses(paraId: number): {
+    generic: string;
+    moonbeam: string;
+    relay: string;
+};
+/**
+ * reference: https://github.com/Moonsong-Labs/xcm-tools/blob/main/scripts/calculate-multilocation-derivative-account.ts
+ */
+declare function getMultilocationDerivedAddresses({ paraId, address, parents, }: {
+    paraId?: number;
+    address: string;
+    parents?: 0 | 1 | 2;
+}): {
+    address20: `0x${string}`;
+    address32: `0x${string}`;
+};
+
+declare enum MRLTypes {
+    XcmVersionedMultiLocation = "XcmVersionedMultiLocation",
+    XcmVersionedLocation = "XcmVersionedLocation",
+    XcmRoutingUserAction = "XcmRoutingUserAction",
+    VersionedUserAction = "VersionedUserAction"
+}
+declare function getPolkadotApi(ws: string | string[]): Promise<ApiPromise>;
+
+declare function getPolkadotAppsUrl(ws: string): string;
+
+export { MRLTypes, convertAddressTo32Bytes, convertDecimals, formatAssetIdToERC20, getMultilocationDerivedAddresses, getPolkadotApi, getPolkadotAppsUrl, getSovereignAccountAddresses, hasDecimalOverflow, isEthAddress, isHexString, toBigInt, toDecimal };

package/build/index.d.ts

@@ -23,10 +23,10 @@ declare function getSovereignAccountAddresses(paraId: number): {
 /**
  * reference: https://github.com/Moonsong-Labs/xcm-tools/blob/main/scripts/calculate-multilocation-derivative-account.ts
  */
-declare function getMultilocationDerivedAddresses({ paraId, address, isParents, }: {
+declare function getMultilocationDerivedAddresses({ paraId, address, parents, }: {
     paraId?: number;
     address: string;
-    isParents?: boolean;
+    parents?: 0 | 1 | 2;
 }): {
     address20: `0x${string}`;
     address32: `0x${string}`;