@moonbeam-network/xcm-utils 1.0.0-dev.29 → 1.0.0-dev.290

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2022 PureStake
+Copyright 2024 Moonbeam Foundation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/README.md

@@ -1,9 +1,20 @@
-![Moonbeam](https://docs.moonbeam.network/images/builders/interoperability/xcm/sdk/xcm-sdk-banner.png)
+The Utils package contains the utility functions for the Moonbeam XCM SDK and MRL SDK.
 
-The Moonbeam XCM SDK enables developers to easily deposit and withdraw assets to Moonbeam/Moonriver from the relay chain and other parachains in the Polkadot/Kusama ecosystem. With the SDK, you don't need to worry about determining the multilocation of the origin or destination assets or which extrinsics are used on which networks to send XCM transfers. To deposit or withdraw assets, you simply define the asset and origin chain you want to deposit from or withdraw back to, along with the sending account's signer, and the amount to send.
+# Documentation for the Moonbeam XCM SDK
 
-# Documentation
+## v3 (current)
 
-## v1 (current)
+### Usage
 
-- TODO: (coming soon)
+- [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
+
+- [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)
+
+- [usage](https://moonbeam-foundation.github.io/xcm-sdk/v2/example-usage)
+- [references](https://moonbeam-foundation.github.io/xcm-sdk/v2/reference/interfaces)

package/build/index.d.ts

@@ -1,35 +1,45 @@
 import { RoundingMode } from 'big.js';
 import { ApiPromise } from '@polkadot/api';
 
-declare function formatAssetIdToERC20(id: string): string;
+declare function isHexString(asset: unknown): boolean;
+declare function isEthAddress(address: string): boolean;
 
-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;
+declare function formatAssetIdToERC20(id: string): string;
+declare function convertAddressTo32Bytes(address: string): string;
 
-declare function getPolkadotApi(ws: string): Promise<ApiPromise>;
+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;
 
-export {
-  convertDecimals,
-  formatAssetIdToERC20,
-  getPolkadotApi,
-  hasDecimalOverflow,
-  toBigInt,
-  toDecimal,
+/**
+ * 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 };