@paraspell/sdk 0.0.19 → 0.0.20

package/README.md

@@ -43,6 +43,11 @@ pnpm install @paraspell/sdk
 
  
 ```js
+/////////NEW BUILDER STYLE IMPORT///////////
+
+import { Builder } from '@paraspell/sdk'
+
+/////////OLD STYLE IMPORT & IMPORT FOR ASSET PALLET//////////
 
 // ESM
 import  *  as  paraspell  from  '@paraspell/sdk'
@@ -60,6 +65,25 @@ const paraspell = require('@paraspell/sdk')
 
 //XCM pallet (Combined xTokens, polkadotXCM, ormlXTokens, XcmPallet & relayerXCM):
 
+//////////NEW BUILDER PATTERN XCM & HRMP CONSTRUCTION//////////
+
+//Transfer tokens from Parachain to Parachain
+Builder(api).from(NODE).to(NODE).currency(CurrencyString).currencyId(currencyId).amount(amount).address(address).build()
+
+//Transfer tokens from Relay chain to Parachain
+Builder(api).to(NODE).amount(amount).address(address).build()
+      
+//Transfer tokens from Parachain to Relay chain
+Builder(api).from(NODE).currency(CurrencyString).currencyId(currencyId).amount(amount).address(address).build()
+
+//Close HRMP channels
+Builder(api).from(NODE).closeChannel().inbound(inbound).outbound(outbound).build()
+
+//Open HRMP channels
+Builder(api).from(NODE).to(NODE).openChannel().maxSize(maxSize).maxMessageSize(maxMsgSize).build()
+
+///////////OLD STYLE XCM & HRMP CONSTRUCTION////////////// 
+
 //Transfer tokens from Parachain to Parachain
 paraspell.xcmPallet.send(api: ApiPromise, origin: origin  Parachain  name  string, currency: currency  symbol  string, currencyID: number (If applicable), amount: any, to: destination  address  string, destination: destination  Parachain  ID)
 
@@ -70,16 +94,14 @@ paraspell.xcmPallet.send(api: ApiPromise, origin: origin  Parachain  name  strin
 paraspell.xcmPallet.transferRelayToPara(api: ApiPromise, destination: destination  Parachain  ID, amount: any, to: destination  address  string)
 
 //hrmp pallet:
-
 //Close HRMP channels
 paraspell.closeChannels.closeChannel(api: ApiPromise, origin: origin  Parachain  ID, inbound: number, outbound: number)
 
-
 //parasSudoWrapper pallet:
-
 //Open HRMP channels
 paraspell.openChannels.openChannel(api: ApiPromise, origin: origin  Parachain  ID, destination: destination  Parachain  ID, maxSize: number, maxMessageSize: number)
 
+////////ASSET PALLET CONSTRUCTION UNCHANGED////////
 
 //Asset pallet
 
@@ -139,8 +161,11 @@ paraspell.NODE_NAMES
 
 
 ## Founded by
+[<img width="245" alt="web3 foundation_grants_badge_black" src="https://user-images.githubusercontent.com/55763425/211145923-f7ee2a57-3e63-4b7d-9674-2da9db46b2ee.png">](https://github.com/w3f/Grants-Program/pull/1245)
+[<img width="245" alt="web3 foundation_grants_badge_white (1)" src="https://user-images.githubusercontent.com/55763425/211069914-bbec9e28-7a0d-417b-8149-087b7f04e57e.png">](https://github.com/w3f/Grants-Program/pull/1245)
+
 [![logo-v1](https://user-images.githubusercontent.com/55763425/204865221-90d2b3cd-f2ac-48a2-a367-08722aa8e923.svg)](https://bsx.fi/)
-  
+
 
 
 ## License

package/dist/index.cjs

@@ -3733,6 +3733,148 @@ const index = {
   closeChannel: closeChannel
 };
 
+class CloseChannelBuilder {
+  constructor(api, from) {
+    this.api = api;
+    this.from = from;
+  }
+  static create(api, from) {
+    return new CloseChannelBuilder(api, from);
+  }
+  inbound(inbound) {
+    this._inbound = inbound;
+    return this;
+  }
+  outbound(outbound) {
+    this._outbound = outbound;
+    return this;
+  }
+  build() {
+    return closeChannel(this.api, this.from, this._inbound, this._outbound);
+  }
+}
+const CloseChannelBuilder$1 = CloseChannelBuilder;
+
+class OpenChannelBuilder {
+  constructor(api, from, to) {
+    this.api = api;
+    this.from = from;
+    this.to = to;
+  }
+  static create(api, from, to) {
+    return new OpenChannelBuilder(api, from, to);
+  }
+  maxSize(size) {
+    this._maxSize = size;
+    return this;
+  }
+  maxMessageSize(size) {
+    this._maxMessageSize = size;
+    return this;
+  }
+  build() {
+    return openChannel(this.api, this.from, this.to, this._maxSize, this._maxMessageSize);
+  }
+}
+const OpenChannelBuilder$1 = OpenChannelBuilder;
+
+class RelayToParaBuilder {
+  constructor(api, to) {
+    this.api = api;
+    this.to = to;
+  }
+  static create(api, to) {
+    return new RelayToParaBuilder(api, to);
+  }
+  amount(amount) {
+    this._amount = amount;
+    return this;
+  }
+  address(address) {
+    this._address = address;
+    return this;
+  }
+  build() {
+    return transferRelayToPara(this.api, this.to, this._amount, this._address);
+  }
+}
+const RelayToParaBuilder$1 = RelayToParaBuilder;
+
+class SendBuilder {
+  constructor(api, from, to, currency) {
+    this.api = api;
+    this.from = from;
+    this.to = to;
+    this.currency = currency;
+  }
+  static createParaToRelay(api, from, currency) {
+    return new SendBuilder(api, from, void 0, currency);
+  }
+  static createParaToPara(api, from, to, currency) {
+    return new SendBuilder(api, from, to, currency);
+  }
+  currencyId(currencyId) {
+    this._currencyId = currencyId;
+    return this;
+  }
+  amount(amount) {
+    this._amount = amount;
+    return this;
+  }
+  address(address) {
+    this._address = address;
+    return this;
+  }
+  build() {
+    return send(this.api, this.from, this.currency, this._currencyId, this._amount, this._address, this.to);
+  }
+}
+const SendBuilder$1 = SendBuilder;
+
+class ToGeneralBuilder {
+  constructor(api, from, to) {
+    this.api = api;
+    this.from = from;
+    this.to = to;
+  }
+  currency(currency) {
+    return SendBuilder$1.createParaToPara(this.api, this.from, this.to, currency);
+  }
+  openChannel() {
+    return OpenChannelBuilder$1.create(this.api, this.from, this.to);
+  }
+}
+class FromGeneralBuilder {
+  constructor(api, from) {
+    this.api = api;
+    this.from = from;
+  }
+  to(node) {
+    return new ToGeneralBuilder(this.api, this.from, node);
+  }
+  currency(currency) {
+    return SendBuilder$1.createParaToRelay(this.api, this.from, currency);
+  }
+  closeChannel() {
+    return CloseChannelBuilder$1.create(this.api, this.from);
+  }
+}
+class GeneralBuilder {
+  constructor(api) {
+    this.api = api;
+  }
+  from(node) {
+    return new FromGeneralBuilder(this.api, node);
+  }
+  to(node) {
+    return RelayToParaBuilder$1.create(this.api, node);
+  }
+}
+function Builder(api) {
+  return new GeneralBuilder(api);
+}
+
+exports.Builder = Builder;
 exports.NODE_NAMES = NODE_NAMES;
 exports.assets = index$3;
 exports.closeChannels = index;

package/dist/index.d.ts

@@ -91,4 +91,71 @@ declare namespace index {
   };
 }
 
-export { Extrinsic, ExtrinsicFunction, NODE_NAMES, TAssetDetails, TAssetJsonMap, TNativeAssetDetails, TNode, TNodeAssets, TNodeDetails, TPalletType, TRelayChainType, TScenario, UpdateFunction, index as assets, index$1 as closeChannels, index$2 as openChannels, index$3 as xcmPallet };
+interface FinalRelayToParaBuilder$1 {
+    build(): Extrinsic | never;
+}
+interface AddressRelayToParaBuilder {
+    address(address: string): FinalRelayToParaBuilder$1;
+}
+interface AmountRelayToParaBuilder {
+    amount(amount: number): AddressRelayToParaBuilder;
+}
+
+interface FinalCloseChannelBuilder {
+    build(): Extrinsic;
+}
+interface OutboundCloseChannelBuilder {
+    outbound(inbound: number): FinalCloseChannelBuilder;
+}
+interface InboundCloseChannelBuilder {
+    inbound(inbound: number): OutboundCloseChannelBuilder;
+}
+
+interface FinalOpenChannelBuilder {
+    build(): Extrinsic;
+}
+interface MaxMessageSizeOpenChannelBuilder {
+    maxMessageSize(size: number): FinalOpenChannelBuilder;
+}
+interface MaxSizeOpenChannelBuilder {
+    maxSize(size: number): MaxMessageSizeOpenChannelBuilder;
+}
+
+interface FinalRelayToParaBuilder {
+    build(): Extrinsic | never;
+}
+interface AddressSendBuilder {
+    address(address: string): FinalRelayToParaBuilder;
+}
+interface AmountSendBuilder {
+    amount(amount: any): AddressSendBuilder;
+}
+interface CurrencyIdSendBuilder {
+    currencyId(currencyId: number): AmountSendBuilder;
+}
+
+declare class ToGeneralBuilder {
+    private api;
+    private from;
+    private to;
+    constructor(api: ApiPromise, from: TNode, to: TNode);
+    currency(currency: string): CurrencyIdSendBuilder;
+    openChannel(): MaxSizeOpenChannelBuilder;
+}
+declare class FromGeneralBuilder {
+    private api;
+    private from;
+    constructor(api: ApiPromise, from: TNode);
+    to(node: TNode): ToGeneralBuilder;
+    currency(currency: string): CurrencyIdSendBuilder;
+    closeChannel(): InboundCloseChannelBuilder;
+}
+declare class GeneralBuilder {
+    private api;
+    constructor(api: ApiPromise);
+    from(node: TNode): FromGeneralBuilder;
+    to(node: TNode): AmountRelayToParaBuilder;
+}
+declare function Builder(api: ApiPromise): GeneralBuilder;
+
+export { Builder, Extrinsic, ExtrinsicFunction, NODE_NAMES, TAssetDetails, TAssetJsonMap, TNativeAssetDetails, TNode, TNodeAssets, TNodeDetails, TPalletType, TRelayChainType, TScenario, UpdateFunction, index as assets, index$1 as closeChannels, index$2 as openChannels, index$3 as xcmPallet };

package/dist/index.mjs

@@ -3731,4 +3731,145 @@ const index = {
   closeChannel: closeChannel
 };
 
-export { NODE_NAMES, index$3 as assets, index as closeChannels, index$1 as openChannels, index$2 as xcmPallet };
+class CloseChannelBuilder {
+  constructor(api, from) {
+    this.api = api;
+    this.from = from;
+  }
+  static create(api, from) {
+    return new CloseChannelBuilder(api, from);
+  }
+  inbound(inbound) {
+    this._inbound = inbound;
+    return this;
+  }
+  outbound(outbound) {
+    this._outbound = outbound;
+    return this;
+  }
+  build() {
+    return closeChannel(this.api, this.from, this._inbound, this._outbound);
+  }
+}
+const CloseChannelBuilder$1 = CloseChannelBuilder;
+
+class OpenChannelBuilder {
+  constructor(api, from, to) {
+    this.api = api;
+    this.from = from;
+    this.to = to;
+  }
+  static create(api, from, to) {
+    return new OpenChannelBuilder(api, from, to);
+  }
+  maxSize(size) {
+    this._maxSize = size;
+    return this;
+  }
+  maxMessageSize(size) {
+    this._maxMessageSize = size;
+    return this;
+  }
+  build() {
+    return openChannel(this.api, this.from, this.to, this._maxSize, this._maxMessageSize);
+  }
+}
+const OpenChannelBuilder$1 = OpenChannelBuilder;
+
+class RelayToParaBuilder {
+  constructor(api, to) {
+    this.api = api;
+    this.to = to;
+  }
+  static create(api, to) {
+    return new RelayToParaBuilder(api, to);
+  }
+  amount(amount) {
+    this._amount = amount;
+    return this;
+  }
+  address(address) {
+    this._address = address;
+    return this;
+  }
+  build() {
+    return transferRelayToPara(this.api, this.to, this._amount, this._address);
+  }
+}
+const RelayToParaBuilder$1 = RelayToParaBuilder;
+
+class SendBuilder {
+  constructor(api, from, to, currency) {
+    this.api = api;
+    this.from = from;
+    this.to = to;
+    this.currency = currency;
+  }
+  static createParaToRelay(api, from, currency) {
+    return new SendBuilder(api, from, void 0, currency);
+  }
+  static createParaToPara(api, from, to, currency) {
+    return new SendBuilder(api, from, to, currency);
+  }
+  currencyId(currencyId) {
+    this._currencyId = currencyId;
+    return this;
+  }
+  amount(amount) {
+    this._amount = amount;
+    return this;
+  }
+  address(address) {
+    this._address = address;
+    return this;
+  }
+  build() {
+    return send(this.api, this.from, this.currency, this._currencyId, this._amount, this._address, this.to);
+  }
+}
+const SendBuilder$1 = SendBuilder;
+
+class ToGeneralBuilder {
+  constructor(api, from, to) {
+    this.api = api;
+    this.from = from;
+    this.to = to;
+  }
+  currency(currency) {
+    return SendBuilder$1.createParaToPara(this.api, this.from, this.to, currency);
+  }
+  openChannel() {
+    return OpenChannelBuilder$1.create(this.api, this.from, this.to);
+  }
+}
+class FromGeneralBuilder {
+  constructor(api, from) {
+    this.api = api;
+    this.from = from;
+  }
+  to(node) {
+    return new ToGeneralBuilder(this.api, this.from, node);
+  }
+  currency(currency) {
+    return SendBuilder$1.createParaToRelay(this.api, this.from, currency);
+  }
+  closeChannel() {
+    return CloseChannelBuilder$1.create(this.api, this.from);
+  }
+}
+class GeneralBuilder {
+  constructor(api) {
+    this.api = api;
+  }
+  from(node) {
+    return new FromGeneralBuilder(this.api, node);
+  }
+  to(node) {
+    return RelayToParaBuilder$1.create(this.api, node);
+  }
+}
+function Builder(api) {
+  return new GeneralBuilder(api);
+}
+
+export { Builder, NODE_NAMES, index$3 as assets, index as closeChannels, index$1 as openChannels, index$2 as xcmPallet };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paraspell/sdk",
-  "version": "0.0.19",
+  "version": "0.0.20",
   "description": "SDK for ParaSpell XCM/XCMP tool for developers",
   "repository": "@paraspell/sdk",
   "license": "MIT",