@autonomys/auto-xdm 1.2.3

package/README.md

@@ -0,0 +1,85 @@
+# Autonomys Auto XDM SDK
+
+![Autonomys Banner](https://github.com/autonomys/auto-sdk/blob/main/.github/images/autonomys-banner.webp)
+
+[![Latest Github release](https://img.shields.io/github/v/tag/autonomys/auto-sdk.svg)](https://github.com/autonomys/auto-sdk/tags)
+[![Build status of the main branch on Linux/OSX](https://img.shields.io/github/actions/workflow/status/autonomys/auto-sdk/build.yaml?branch=main&label=Linux%2FOSX%20build)](https://github.com/autonomys/auto-sdk/actions/workflows/build.yaml)
+[![npm version](https://badge.fury.io/js/@autonomys%2Fauto-xdm.svg)](https://badge.fury.io/js/@autonomys%2Fauto-xdm)
+
+## Overview
+
+The **Autonomys Auto XDM SDK** (`@autonomys/auto-xdm`) provides functionalities for cross-domain transfer of native tokens.
+
+## Features
+
+- **Cross-Domain Transfer**: Transfer tokens between consensus and domain accounts.
+- **TypeScript Support**: Fully typed for enhanced developer experience.
+
+## Installation
+
+Install the package via npm or yarn:
+
+```bash
+# Using npm
+npm install @autonomys/auto-xdm
+
+# Using yarn
+yarn add @autonomys/auto-xdm
+```
+
+## Getting Started
+
+### Prerequisites
+
+- **Node.js** (version 14 or higher)
+- **TypeScript** (optional, but recommended for development)
+- Familiarity with async/await and promise handling in JavaScript/TypeScript.
+- **@autonomys/auto-utils** package installed (as it provides utility functions and API activation).
+
+## Usage Examples
+
+Below are examples demonstrating how to use the functions provided by `@autonomys/auto-xdm`.
+
+### 1. Transfer from Consensus to Domain using an EVM address
+
+```ts
+import { activateWallet } from '@autonomys/auto-utils'
+import { transferToDomainAccount20Type } from '@autonomys/auto-xdm'
+
+const api = await activateWallet({ networkId: 'taurus', uri: '//alice' })
+const tx = await transferToDomainAccount20Type(
+  api,
+  0, // Receiver domain (0 is Auto EVM on Taurus Testnet)
+  '0x1234567890abcdef', // Receiver domain account
+  '1000000000000000000',
+)
+```
+
+### 2. Transfer from Consensus to Domain using an substrate address
+
+```ts
+import { activateWallet } from '@autonomys/auto-utils'
+import { transferToDomainAccount32Type } from '@autonomys/auto-xdm'
+
+const api = await activateWallet({ networkId: 'taurus', uri: '//alice' })
+const tx = await transferToDomainAccount32Type(
+  api,
+  0, // Receiver domain (0 is Auto EVM on Taurus Testnet)
+  'su1234567890abcdef', // Receiver domain account
+  '1000000000000000000',
+)
+```
+
+### 3. Transfer from Domain to Consensus
+
+```ts
+import { activateWallet } from '@autonomys/auto-utils'
+import { transferToConsensus } from '@autonomys/auto-xdm'
+
+const api = await activateWallet({ networkId: 'taurus', domainId: 0, uri: '//alice' })
+const tx = await transferToConsensus(
+  api,
+  'su1234567890abcdef', // Receiver consensus account,
+  '1000000000000000000',
+)
+```

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './info';
+export * from './transfer';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAA;AACtB,cAAc,YAAY,CAAA"}

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./info"), exports);
+__exportStar(require("./transfer"), exports);

package/dist/info.d.ts

@@ -0,0 +1,8 @@
+import type { ApiPromise, Codec } from '@autonomys/auto-utils';
+export declare const chainAllowlist: (api: ApiPromise) => Promise<Codec>;
+export declare const allCancelledTransfers: (api: ApiPromise) => Promise<Codec>;
+export declare const chainTransfers: (api: ApiPromise) => Promise<Codec>;
+export declare const allDomainBalances: (api: ApiPromise) => Promise<Codec>;
+export declare const domainBalances: (api: ApiPromise, domainId: number) => Promise<Codec>;
+export declare const allUnconfirmedTransfers: (api: ApiPromise) => Promise<Codec>;
+//# sourceMappingURL=info.d.ts.map

package/dist/info.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"info.d.ts","sourceRoot":"","sources":["../src/info.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAA;AAE9D,eAAO,MAAM,cAAc,QAAe,UAAU,mBAEnD,CAAA;AAED,eAAO,MAAM,qBAAqB,QAAe,UAAU,mBAE1D,CAAA;AAED,eAAO,MAAM,cAAc,QAAe,UAAU,mBAEnD,CAAA;AAED,eAAO,MAAM,iBAAiB,QAAe,UAAU,mBAEtD,CAAA;AAED,eAAO,MAAM,cAAc,QAAe,UAAU,YAAY,MAAM,mBAErE,CAAA;AAED,eAAO,MAAM,uBAAuB,QAAe,UAAU,mBAE5D,CAAA"}

package/dist/info.js

@@ -0,0 +1,38 @@
+"use strict";
+// file: src/types/index.ts
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.allUnconfirmedTransfers = exports.domainBalances = exports.allDomainBalances = exports.chainTransfers = exports.allCancelledTransfers = exports.chainAllowlist = void 0;
+const auto_consensus_1 = require("@autonomys/auto-consensus");
+const chainAllowlist = (api) => __awaiter(void 0, void 0, void 0, function* () {
+    return yield (0, auto_consensus_1.query)(api, 'messenger.chainAllowlist', []);
+});
+exports.chainAllowlist = chainAllowlist;
+const allCancelledTransfers = (api) => __awaiter(void 0, void 0, void 0, function* () {
+    return yield (0, auto_consensus_1.query)(api, 'transporter.cancelledTransfers', []);
+});
+exports.allCancelledTransfers = allCancelledTransfers;
+const chainTransfers = (api) => __awaiter(void 0, void 0, void 0, function* () {
+    return yield (0, auto_consensus_1.query)(api, 'transporter.chainTransfers', []);
+});
+exports.chainTransfers = chainTransfers;
+const allDomainBalances = (api) => __awaiter(void 0, void 0, void 0, function* () {
+    return yield (0, auto_consensus_1.query)(api, 'transporter.domainBalances', []);
+});
+exports.allDomainBalances = allDomainBalances;
+const domainBalances = (api, domainId) => __awaiter(void 0, void 0, void 0, function* () {
+    return yield (0, auto_consensus_1.query)(api, 'transporter.domainBalances', [domainId]);
+});
+exports.domainBalances = domainBalances;
+const allUnconfirmedTransfers = (api) => __awaiter(void 0, void 0, void 0, function* () {
+    return yield (0, auto_consensus_1.query)(api, 'transporter.unconfirmedTransfers', []);
+});
+exports.allUnconfirmedTransfers = allUnconfirmedTransfers;

package/dist/transfer.d.ts

@@ -0,0 +1,7 @@
+import type { StringNumberOrBigInt } from '@autonomys/auto-consensus';
+import type { ApiPromise, Codec } from '@autonomys/auto-utils';
+export declare const transfer: (api: ApiPromise, destination: Codec, amount: StringNumberOrBigInt) => Promise<import("@autonomys/auto-utils").SubmittableExtrinsic<"promise", import("@autonomys/auto-utils").ISubmittableResult>>;
+export declare const transferToConsensus: (api: ApiPromise, accountId32: string, amount: StringNumberOrBigInt) => Promise<import("@autonomys/auto-utils").SubmittableExtrinsic<"promise", import("@autonomys/auto-utils").ISubmittableResult>>;
+export declare const transferToDomainAccount20Type: (api: ApiPromise, destinationDomainId: string | number, accountId20: string, amount: StringNumberOrBigInt) => Promise<import("@autonomys/auto-utils").SubmittableExtrinsic<"promise", import("@autonomys/auto-utils").ISubmittableResult>>;
+export declare const transferToDomainAccount32Type: (api: ApiPromise, destinationDomainId: string | number, accountId32: string, amount: StringNumberOrBigInt) => Promise<import("@autonomys/auto-utils").SubmittableExtrinsic<"promise", import("@autonomys/auto-utils").ISubmittableResult>>;
+//# sourceMappingURL=transfer.d.ts.map

package/dist/transfer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transfer.d.ts","sourceRoot":"","sources":["../src/transfer.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AACrE,OAAO,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAA;AAO9D,eAAO,MAAM,QAAQ,QACd,UAAU,eACF,KAAK,UACV,oBAAoB,iIAG7B,CAAA;AAED,eAAO,MAAM,mBAAmB,QACzB,UAAU,eACF,MAAM,UACX,oBAAoB,iIAI7B,CAAA;AAED,eAAO,MAAM,6BAA6B,QACnC,UAAU,uBACM,MAAM,GAAG,MAAM,eACvB,MAAM,UACX,oBAAoB,iIAI7B,CAAA;AAED,eAAO,MAAM,6BAA6B,QACnC,UAAU,uBACM,MAAM,GAAG,MAAM,eACvB,MAAM,UACX,oBAAoB,iIAI7B,CAAA"}

package/dist/transfer.js

@@ -0,0 +1,33 @@
+"use strict";
+// file: src/transfer.ts
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transferToDomainAccount32Type = exports.transferToDomainAccount20Type = exports.transferToConsensus = exports.transfer = void 0;
+const auto_utils_1 = require("@autonomys/auto-utils");
+const transfer = (api, destination, amount) => __awaiter(void 0, void 0, void 0, function* () {
+    return yield api.tx.transporter.transfer(destination, amount);
+});
+exports.transfer = transfer;
+const transferToConsensus = (api, accountId32, amount) => __awaiter(void 0, void 0, void 0, function* () {
+    const destination = (0, auto_utils_1.createTransporterToConsensusType)(api, accountId32);
+    return yield (0, exports.transfer)(api, destination, amount);
+});
+exports.transferToConsensus = transferToConsensus;
+const transferToDomainAccount20Type = (api, destinationDomainId, accountId20, amount) => __awaiter(void 0, void 0, void 0, function* () {
+    const destination = (0, auto_utils_1.createTransporterToDomainAccount20Type)(api, destinationDomainId, accountId20);
+    return yield (0, exports.transfer)(api, destination, amount);
+});
+exports.transferToDomainAccount20Type = transferToDomainAccount20Type;
+const transferToDomainAccount32Type = (api, destinationDomainId, accountId32, amount) => __awaiter(void 0, void 0, void 0, function* () {
+    const destination = (0, auto_utils_1.createTransporterToDomainAccount32Type)(api, destinationDomainId, accountId32);
+    return yield (0, exports.transfer)(api, destination, amount);
+});
+exports.transferToDomainAccount32Type = transferToDomainAccount32Type;

package/dist/types/index.d.ts

@@ -0,0 +1,16 @@
+export type Consensus = {
+    type: 'consensus';
+};
+export type Domain = {
+    type: 'domain';
+    domainId: number;
+};
+export type ChainOrDomain = Consensus | Domain;
+export type AccountId20 = {
+    accountId20: string;
+};
+export type AccountId32 = {
+    accountId32: string;
+};
+export type Account = AccountId20 | AccountId32;
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,WAAW,CAAA;CAClB,CAAA;AACD,MAAM,MAAM,MAAM,GAAG;IACnB,IAAI,EAAE,QAAQ,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AACD,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,MAAM,CAAA;AAC9C,MAAM,MAAM,WAAW,GAAG;IACxB,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AACD,MAAM,MAAM,WAAW,GAAG;IACxB,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AACD,MAAM,MAAM,OAAO,GAAG,WAAW,GAAG,WAAW,CAAA"}

package/dist/types/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@autonomys/auto-xdm",
+  "version": "1.2.3",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/autonomys/auto-sdk"
+  },
+  "author": {
+    "name": "Autonomys",
+    "url": "https://www.autonomys.xyz"
+  },
+  "bugs": {
+    "url": "https://github.com/autonomys/auto-sdk/issues"
+  },
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf dist",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "test-local": "jest -i"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "dependencies": {
+    "@autonomys/auto-consensus": "^1.2.3",
+    "@autonomys/auto-utils": "^1.2.3"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.12",
+    "eslint": "^8.57.0",
+    "jest": "^29.7.0",
+    "prettier": "^3.2.5",
+    "ts-jest": "^29.1.4",
+    "typescript": "^5.4.5"
+  },
+  "gitHead": "53cf74430ba08ed3b8f38ccc2fcee7b373a7934c"
+}