@paraspell/sdk 0.0.6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 - UnJS
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,59 @@
+# @paraspell/sdk
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![Github Actions][github-actions-src]][github-actions-href]
+[![Codecov][codecov-src]][codecov-href]
+
+> Package description
+
+## Usage
+
+Install package:
+
+```sh
+# npm
+npm install @paraspell/sdk
+
+# yarn
+yarn install @paraspell/sdk
+
+# pnpm
+pnpm install @paraspell/sdk
+```
+
+Import:
+
+```js
+// ESM
+import { } from '@paraspell/sdk'
+
+// CommonJS
+const { } = require('@paraspell/sdk')
+```
+
+## 💻 Development
+
+- Clone this repository
+- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable` (use `npm i -g corepack` for Node.js < 16.10)
+- Install dependencies using `pnpm install`
+- Run interactive tests using `pnpm dev`
+
+## License
+
+Made with 💛
+
+Published under [MIT License](./LICENSE).
+
+<!-- Badges -->
+[npm-version-src]: https://img.shields.io/npm/v/@paraspell/sdk?style=flat-square
+[npm-version-href]: https://npmjs.com/package/@paraspell/sdk
+
+[npm-downloads-src]: https://img.shields.io/npm/dm/@paraspell/sdk?style=flat-square
+[npm-downloads-href]: https://npmjs.com/package/@paraspell/sdk
+
+[github-actions-src]: https://img.shields.io/github/workflow/status/unjs/@paraspell/sdk/ci/main?style=flat-square
+[github-actions-href]: https://github.com/unjs/@paraspell/sdk/actions?query=workflow%3Aci
+
+[codecov-src]: https://img.shields.io/codecov/c/gh/unjs/@paraspell/sdk/main?style=flat-square
+[codecov-href]: https://codecov.io/gh/unjs/@paraspell/sdk

package/dist/index.cjs

@@ -0,0 +1,176 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+function createAccID(api, account) {
+  return api.createType("AccountId32", account).toHex();
+}
+
+function transferParaToRelay(api, origin, currency, amount, to) {
+  if (origin == "Karura" || origin == "Bifrost") {
+    return api.tx.xTokens.transfer(
+      {
+        Token: currency
+      },
+      amount,
+      {
+        V1: {
+          parents: 1,
+          interior: {
+            X1: {
+              AccountId32: {
+                network: "any",
+                id: createAccID(api, to)
+              }
+            }
+          }
+        }
+      },
+      46e8
+    );
+  } else if (origin == "Pichiu") {
+    return api.tx.ormlXTokens.transfer(
+      currency,
+      amount,
+      {
+        V1: {
+          parents: 1,
+          interior: {
+            X1: {
+              AccountId32: {
+                network: "any",
+                id: createAccID(api, to)
+              }
+            }
+          }
+        }
+      },
+      46e8
+    );
+  }
+}
+function transferRelayToPara(api, destination, amount, to) {
+  return api.tx.xcmPallet.reserveTransferAssets(
+    {
+      V1: {
+        parents: 0,
+        interior: {
+          X1: {
+            Parachain: destination
+          }
+        }
+      }
+    },
+    {
+      V1: {
+        parents: 0,
+        interior: {
+          X1: {
+            AccountId32: {
+              network: "Any",
+              id: createAccID(api, to)
+            }
+          }
+        }
+      }
+    },
+    {
+      V1: [
+        {
+          id: {
+            Concrete: {
+              parents: 0,
+              interior: "Here"
+            }
+          },
+          fun: {
+            Fungible: amount
+          }
+        }
+      ]
+    },
+    0
+  );
+}
+function transferParaToPara(api, origin, destination, currency, amount, to) {
+  if (origin == "Karura" || origin == "Bifrost") {
+    return api.tx.xTokens.transfer(
+      {
+        Token: currency
+      },
+      amount,
+      {
+        V1: {
+          parents: 1,
+          interior: {
+            X2: [
+              {
+                Parachain: destination
+              },
+              {
+                AccountId32: {
+                  network: "Any",
+                  id: createAccID(api, to)
+                }
+              }
+            ]
+          }
+        }
+      },
+      3996e8
+    );
+  } else if (origin == "Pichiu") {
+    return api.tx.ormlXTokens.transfer(
+      currency,
+      amount,
+      {
+        V1: {
+          parents: 1,
+          interior: {
+            X2: [
+              {
+                Parachain: destination
+              },
+              {
+                AccountId32: {
+                  network: "Any",
+                  id: createAccID(api, to)
+                }
+              }
+            ]
+          }
+        }
+      },
+      3996e8
+    );
+  }
+}
+
+const index$2 = {
+    __proto__: null,
+    transferParaToPara: transferParaToPara,
+    transferParaToRelay: transferParaToRelay,
+    transferRelayToPara: transferRelayToPara
+};
+
+function openChannel(api, origin, destination, maxSize, maxMessageSize) {
+  return api.tx.sudo.sudo(api.tx.parasSudoWrapper.sudoEstablishHrmpChannel(origin, destination, maxSize, maxMessageSize));
+}
+
+const index$1 = {
+    __proto__: null,
+    openChannel: openChannel
+};
+
+function closeChannel(api, origin, inbound, outbound) {
+  return api.tx.sudo.sudo(api.tx.hrmp.forceCleanHrmp(origin, inbound, outbound));
+}
+
+const index = {
+    __proto__: null,
+    closeChannel: closeChannel
+};
+
+exports.closeChannels = index;
+exports.openChannels = index$1;
+exports.xTokens = index$2;

package/dist/index.d.ts

@@ -0,0 +1,39 @@
+import { ApiPromise } from '@polkadot/api';
+import { SubmittableExtrinsic } from '@polkadot/api/types';
+
+declare type Extrinsic = SubmittableExtrinsic<'promise'>;
+
+declare function transferParaToRelay(api: ApiPromise, origin: string, currency: string, amount: any, to: string): Extrinsic;
+declare function transferRelayToPara(api: ApiPromise, destination: number, amount: any, to: string): Extrinsic;
+declare function transferParaToPara(api: ApiPromise, origin: string, destination: number, currency: string, amount: any, to: string): Extrinsic;
+
+declare const index$2_transferParaToPara: typeof transferParaToPara;
+declare const index$2_transferParaToRelay: typeof transferParaToRelay;
+declare const index$2_transferRelayToPara: typeof transferRelayToPara;
+declare namespace index$2 {
+  export {
+    index$2_transferParaToPara as transferParaToPara,
+    index$2_transferParaToRelay as transferParaToRelay,
+    index$2_transferRelayToPara as transferRelayToPara,
+  };
+}
+
+declare function openChannel(api: ApiPromise, origin: number, destination: number, maxSize: number, maxMessageSize: number): Extrinsic;
+
+declare const index$1_openChannel: typeof openChannel;
+declare namespace index$1 {
+  export {
+    index$1_openChannel as openChannel,
+  };
+}
+
+declare function closeChannel(api: ApiPromise, origin: number, inbound: number, outbound: number): Extrinsic;
+
+declare const index_closeChannel: typeof closeChannel;
+declare namespace index {
+  export {
+    index_closeChannel as closeChannel,
+  };
+}
+
+export { index as closeChannels, index$1 as openChannels, index$2 as xTokens };

package/dist/index.mjs

@@ -0,0 +1,170 @@
+function createAccID(api, account) {
+  return api.createType("AccountId32", account).toHex();
+}
+
+function transferParaToRelay(api, origin, currency, amount, to) {
+  if (origin == "Karura" || origin == "Bifrost") {
+    return api.tx.xTokens.transfer(
+      {
+        Token: currency
+      },
+      amount,
+      {
+        V1: {
+          parents: 1,
+          interior: {
+            X1: {
+              AccountId32: {
+                network: "any",
+                id: createAccID(api, to)
+              }
+            }
+          }
+        }
+      },
+      46e8
+    );
+  } else if (origin == "Pichiu") {
+    return api.tx.ormlXTokens.transfer(
+      currency,
+      amount,
+      {
+        V1: {
+          parents: 1,
+          interior: {
+            X1: {
+              AccountId32: {
+                network: "any",
+                id: createAccID(api, to)
+              }
+            }
+          }
+        }
+      },
+      46e8
+    );
+  }
+}
+function transferRelayToPara(api, destination, amount, to) {
+  return api.tx.xcmPallet.reserveTransferAssets(
+    {
+      V1: {
+        parents: 0,
+        interior: {
+          X1: {
+            Parachain: destination
+          }
+        }
+      }
+    },
+    {
+      V1: {
+        parents: 0,
+        interior: {
+          X1: {
+            AccountId32: {
+              network: "Any",
+              id: createAccID(api, to)
+            }
+          }
+        }
+      }
+    },
+    {
+      V1: [
+        {
+          id: {
+            Concrete: {
+              parents: 0,
+              interior: "Here"
+            }
+          },
+          fun: {
+            Fungible: amount
+          }
+        }
+      ]
+    },
+    0
+  );
+}
+function transferParaToPara(api, origin, destination, currency, amount, to) {
+  if (origin == "Karura" || origin == "Bifrost") {
+    return api.tx.xTokens.transfer(
+      {
+        Token: currency
+      },
+      amount,
+      {
+        V1: {
+          parents: 1,
+          interior: {
+            X2: [
+              {
+                Parachain: destination
+              },
+              {
+                AccountId32: {
+                  network: "Any",
+                  id: createAccID(api, to)
+                }
+              }
+            ]
+          }
+        }
+      },
+      3996e8
+    );
+  } else if (origin == "Pichiu") {
+    return api.tx.ormlXTokens.transfer(
+      currency,
+      amount,
+      {
+        V1: {
+          parents: 1,
+          interior: {
+            X2: [
+              {
+                Parachain: destination
+              },
+              {
+                AccountId32: {
+                  network: "Any",
+                  id: createAccID(api, to)
+                }
+              }
+            ]
+          }
+        }
+      },
+      3996e8
+    );
+  }
+}
+
+const index$2 = {
+    __proto__: null,
+    transferParaToPara: transferParaToPara,
+    transferParaToRelay: transferParaToRelay,
+    transferRelayToPara: transferRelayToPara
+};
+
+function openChannel(api, origin, destination, maxSize, maxMessageSize) {
+  return api.tx.sudo.sudo(api.tx.parasSudoWrapper.sudoEstablishHrmpChannel(origin, destination, maxSize, maxMessageSize));
+}
+
+const index$1 = {
+    __proto__: null,
+    openChannel: openChannel
+};
+
+function closeChannel(api, origin, inbound, outbound) {
+  return api.tx.sudo.sudo(api.tx.hrmp.forceCleanHrmp(origin, inbound, outbound));
+}
+
+const index = {
+    __proto__: null,
+    closeChannel: closeChannel
+};
+
+export { index as closeChannels, index$1 as openChannels, index$2 as xTokens };

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@paraspell/sdk",
+  "version": "0.0.6",
+  "description": "SDK for ParaSpell XCM/XCMP tool for developers",
+  "repository": "@paraspell/sdk",
+  "license": "MIT",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@polkadot/api": "^8.0.2",
+    "@polkadot/types": "^8.0.2"
+  },
+  "devDependencies": {
+    "@nuxtjs/eslint-config-typescript": "latest",
+    "@vitest/coverage-c8": "latest",
+    "eslint": "latest",
+    "standard-version": "latest",
+    "typescript": "latest",
+    "unbuild": "latest",
+    "vitest": "latest"
+  },
+  "packageManager": "pnpm@7.9.5",
+  "scripts": {
+    "build": "unbuild",
+    "dev": "vitest dev",
+    "lint": "eslint --ext .ts,.js,.mjs,.cjs .",
+    "release": "pnpm test && standard-version && git push --follow-tags && pnpm publish --no-git-checks --access=public",
+    "test": "pnpm lint && vitest run --coverage"
+  }
+}