@massalabs/wallet-provider 1.2.1-dev.20230801093549 → 1.2.1-dev.20230803141012

package/dist/cmd/index.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MassaStationAccount = exports.Provider = exports.EAccountImportResponse = exports.EAccountDeletionResponse = exports.Account = exports.registerProvider = exports.providers = exports.AvailableCommands = void 0;
+/** Polyfills */
+const buffer_1 = require("buffer");
+// Check if we are on browser
+if (typeof window !== 'undefined') {
+    window.Buffer = buffer_1.Buffer;
+}
+const Connector_1 = require("./connector/Connector");
+const Provider_1 = require("./provider/Provider");
+const MassaStationProvider_1 = require("./massaStation/MassaStationProvider");
+var AvailableCommands;
+(function (AvailableCommands) {
+    AvailableCommands["ProviderListAccounts"] = "LIST_ACCOUNTS";
+    AvailableCommands["ProviderDeleteAccount"] = "DELETE_ACCOUNT";
+    AvailableCommands["ProviderImportAccount"] = "IMPORT_ACCOUNT";
+    AvailableCommands["ProviderGetNodesUrls"] = "GET_NODES_URLS";
+    AvailableCommands["AccountBalance"] = "ACCOUNT_BALANCE";
+    AvailableCommands["AccountSign"] = "ACCOUNT_SIGN";
+    AvailableCommands["ProviderGenerateNewAccount"] = "GENERATE_NEW_ACCOUNT";
+    AvailableCommands["AccountSellRolls"] = "ACCOUNT_SELL_ROLLS";
+    AvailableCommands["AccountBuyRolls"] = "ACCOUNT_BUY_ROLLS";
+    AvailableCommands["AccountSendTransaction"] = "ACCOUNT_SEND_TRANSACTION";
+    AvailableCommands["AccountCallSC"] = "ACCOUNT_CALL_SC";
+})(AvailableCommands = exports.AvailableCommands || (exports.AvailableCommands = {}));
+/**
+ * Get the list of providers that are available to interact with.
+ *
+ * @param retry - If true, will retry to get the list of providers if none are available.
+ * @param pollInterval - The timeout in milliseconds to wait between retries. default is 2000ms.
+ * @param timeout - The timeout in milliseconds to wait before giving up. default is 3000ms.
+ *
+ * @returns An array of providers.
+ */
+async function providers(retry = true, timeout = 3000, pollInterval = 500) {
+    if (timeout <= 0) {
+        return [];
+    }
+    await Connector_1.connector.startMassaStationDiscovery();
+    return new Promise((resolve) => {
+        let provider = [];
+        for (const providerName of Object.keys(Connector_1.connector.getWalletProviders())) {
+            if (providerName === MassaStationProvider_1.MASSA_STATION_PROVIDER_NAME) {
+                const p = new MassaStationProvider_1.MassaStationProvider();
+                provider.push(p);
+            }
+            else {
+                const p = new Provider_1.Provider(providerName);
+                provider.push(p);
+            }
+        }
+        // If no providers are available, wait and try again
+        if (retry && provider.length === 0) {
+            setTimeout(() => {
+                providers(retry, timeout - pollInterval, pollInterval).then(resolve);
+            }, pollInterval);
+        }
+        else {
+            resolve(provider);
+        }
+    });
+}
+exports.providers = providers;
+/**
+ * Manually register a provider to interact with.
+ *
+ * @param name - The name of the provider.
+ * @param id - The id of the HTML element that is used to communicate with the provider.
+ */
+function registerProvider(name, id = Connector_1.MASSA_WINDOW_OBJECT) {
+    const registerEvent = new CustomEvent('register', {
+        detail: { providerName: name },
+    });
+    const element = document.getElementById(id);
+    if (element) {
+        element.dispatchEvent(registerEvent);
+    }
+}
+exports.registerProvider = registerProvider;
+var account_1 = require("./account");
+Object.defineProperty(exports, "Account", { enumerable: true, get: function () { return account_1.Account; } });
+var provider_1 = require("./provider");
+Object.defineProperty(exports, "EAccountDeletionResponse", { enumerable: true, get: function () { return provider_1.EAccountDeletionResponse; } });
+Object.defineProperty(exports, "EAccountImportResponse", { enumerable: true, get: function () { return provider_1.EAccountImportResponse; } });
+Object.defineProperty(exports, "Provider", { enumerable: true, get: function () { return provider_1.Provider; } });
+var MassaStationAccount_1 = require("./massaStation/MassaStationAccount");
+Object.defineProperty(exports, "MassaStationAccount", { enumerable: true, get: function () { return MassaStationAccount_1.MassaStationAccount; } });
+//# sourceMappingURL=index.js.map

package/dist/cmd/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,gBAAgB;AAChB,mCAAgC;AAQhC,6BAA6B;AAC7B,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;IACjC,MAAM,CAAC,MAAM,GAAG,eAAM,CAAC;CACxB;AAED,qDAAuE;AAEvE,kDAA+C;AAC/C,8EAG6C;AAE7C,IAAY,iBAYX;AAZD,WAAY,iBAAiB;IAC3B,2DAAsC,CAAA;IACtC,6DAAwC,CAAA;IACxC,6DAAwC,CAAA;IACxC,4DAAuC,CAAA;IACvC,uDAAkC,CAAA;IAClC,iDAA4B,CAAA;IAC5B,wEAAmD,CAAA;IACnD,4DAAuC,CAAA;IACvC,0DAAqC,CAAA;IACrC,wEAAmD,CAAA;IACnD,sDAAiC,CAAA;AACnC,CAAC,EAZW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAY5B;AAMD;;;;;;;;GAQG;AACI,KAAK,UAAU,SAAS,CAC7B,KAAK,GAAG,IAAI,EACZ,OAAO,GAAG,IAAI,EACd,YAAY,GAAG,GAAG;IAElB,IAAI,OAAO,IAAI,CAAC,EAAE;QAChB,OAAO,EAAE,CAAC;KACX;IAED,MAAM,qBAAS,CAAC,0BAA0B,EAAE,CAAC;IAE7C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,IAAI,QAAQ,GAAgB,EAAE,CAAC;QAE/B,KAAK,MAAM,YAAY,IAAI,MAAM,CAAC,IAAI,CAAC,qBAAS,CAAC,kBAAkB,EAAE,CAAC,EAAE;YACtE,IAAI,YAAY,KAAK,kDAA2B,EAAE;gBAChD,MAAM,CAAC,GAAG,IAAI,2CAAoB,EAAE,CAAC;gBACrC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;aAClB;iBAAM;gBACL,MAAM,CAAC,GAAG,IAAI,mBAAQ,CAAC,YAAY,CAAC,CAAC;gBACrC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;aAClB;SACF;QAED,oDAAoD;QACpD,IAAI,KAAK,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;YAClC,UAAU,CAAC,GAAG,EAAE;gBACd,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,YAAY,EAAE,YAAY,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACvE,CAAC,EAAE,YAAY,CAAC,CAAC;SAClB;aAAM;YACL,OAAO,CAAC,QAAQ,CAAC,CAAC;SACnB;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAjCD,8BAiCC;AAED;;;;;GAKG;AACH,SAAgB,gBAAgB,CAAC,IAAY,EAAE,EAAE,GAAG,+BAAmB;IACrE,MAAM,aAAa,GAAG,IAAI,WAAW,CAAC,UAAU,EAAE;QAChD,MAAM,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE;KAC/B,CAAC,CAAC;IACH,MAAM,OAAO,GAAG,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;IAC5C,IAAI,OAAO,EAAE;QACX,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;KACtC;AACH,CAAC;AARD,4CAQC;AAID,qCAWmB;AAJjB,kGAAA,OAAO,OAAA;AAMT,uCASoB;AARlB,oHAAA,wBAAwB,OAAA;AACxB,kHAAA,sBAAsB,OAAA;AAMtB,oGAAA,QAAQ,OAAA;AAKV,0EAAyE;AAAhE,0HAAA,mBAAmB,OAAA","sourcesContent":["/** Polyfills */\nimport { Buffer } from 'buffer';\n\ndeclare global {\n  interface Window {\n    Buffer: typeof Buffer;\n  }\n}\n\n// Check if we are on browser\nif (typeof window !== 'undefined') {\n  window.Buffer = Buffer;\n}\n\nimport { MASSA_WINDOW_OBJECT, connector } from './connector/Connector';\nimport { IProvider } from './provider/IProvider';\nimport { Provider } from './provider/Provider';\nimport {\n  MASSA_STATION_PROVIDER_NAME,\n  MassaStationProvider,\n} from './massaStation/MassaStationProvider';\n\nexport enum AvailableCommands {\n  ProviderListAccounts = 'LIST_ACCOUNTS',\n  ProviderDeleteAccount = 'DELETE_ACCOUNT',\n  ProviderImportAccount = 'IMPORT_ACCOUNT',\n  ProviderGetNodesUrls = 'GET_NODES_URLS',\n  AccountBalance = 'ACCOUNT_BALANCE',\n  AccountSign = 'ACCOUNT_SIGN',\n  ProviderGenerateNewAccount = 'GENERATE_NEW_ACCOUNT',\n  AccountSellRolls = 'ACCOUNT_SELL_ROLLS',\n  AccountBuyRolls = 'ACCOUNT_BUY_ROLLS',\n  AccountSendTransaction = 'ACCOUNT_SEND_TRANSACTION',\n  AccountCallSC = 'ACCOUNT_CALL_SC',\n}\n\nexport interface ITransactionDetails {\n  operationId: string;\n}\n\n/**\n * Get the list of providers that are available to interact with.\n *\n * @param retry - If true, will retry to get the list of providers if none are available.\n * @param pollInterval - The timeout in milliseconds to wait between retries. default is 2000ms.\n * @param timeout - The timeout in milliseconds to wait before giving up. default is 3000ms.\n *\n * @returns An array of providers.\n */\nexport async function providers(\n  retry = true,\n  timeout = 3000,\n  pollInterval = 500,\n): Promise<IProvider[]> {\n  if (timeout <= 0) {\n    return [];\n  }\n\n  await connector.startMassaStationDiscovery();\n\n  return new Promise((resolve) => {\n    let provider: IProvider[] = [];\n\n    for (const providerName of Object.keys(connector.getWalletProviders())) {\n      if (providerName === MASSA_STATION_PROVIDER_NAME) {\n        const p = new MassaStationProvider();\n        provider.push(p);\n      } else {\n        const p = new Provider(providerName);\n        provider.push(p);\n      }\n    }\n\n    // If no providers are available, wait and try again\n    if (retry && provider.length === 0) {\n      setTimeout(() => {\n        providers(retry, timeout - pollInterval, pollInterval).then(resolve);\n      }, pollInterval);\n    } else {\n      resolve(provider);\n    }\n  });\n}\n\n/**\n * Manually register a provider to interact with.\n *\n * @param name - The name of the provider.\n * @param id - The id of the HTML element that is used to communicate with the provider.\n */\nexport function registerProvider(name: string, id = MASSA_WINDOW_OBJECT): void {\n  const registerEvent = new CustomEvent('register', {\n    detail: { providerName: name },\n  });\n  const element = document.getElementById(id);\n  if (element) {\n    element.dispatchEvent(registerEvent);\n  }\n}\n\nexport { AllowedRequests, AllowedResponses } from './connector';\n\nexport {\n  IAccountDetails,\n  IAccountBalanceRequest,\n  IAccountBalanceResponse,\n  IAccountSignRequest,\n  IAccountSignResponse,\n  IAccount,\n  Account,\n  IAccountRollsRequest,\n  IAccountSendTransactionRequest,\n  IAccountCallSCRequest,\n} from './account';\n\nexport {\n  EAccountDeletionResponse,\n  EAccountImportResponse,\n  IAccountDeletionRequest,\n  IAccountDeletionResponse,\n  IAccountImportRequest,\n  IAccountImportResponse,\n  IProvider,\n  Provider,\n} from './provider';\n\nexport { IMassaStationWallet } from './massaStation/MassaStationProvider';\n\nexport { MassaStationAccount } from './massaStation/MassaStationAccount';\n"]}

package/dist/cmd/massaStation/MassaStationAccount.d.ts

@@ -0,0 +1,103 @@
+import { IAccountBalanceResponse, IAccountDetails, IAccountSignResponse, ITransactionDetails } from '..';
+import { IAccount } from '../account/IAccount';
+import { Args, IContractReadOperationResponse } from '@massalabs/web3-utils';
+/**
+ * This module contains the MassaStationAccount class. It is responsible for representing an account in
+ * the MassaStation wallet.
+ *
+ * @remarks
+ * This class provides methods to interact with MassaStation account's {@link balance} and to {@link sign} messages.
+ *
+ */
+export declare class MassaStationAccount implements IAccount {
+    private _providerName;
+    private _address;
+    private _name;
+    /**
+     * This constructor takes an object of type IAccountDetails and a providerName string as its arguments.
+     *
+     * @param address - The address of the account.
+     * @param name - The name of the account.
+     * @param providerName - The name of the provider.
+     * @returns An instance of the Account class.
+     *
+     * @remarks
+     * - The Account constructor takes an object of type IAccountDetails and a providerName string as its arguments.
+     * - The IAccountDetails object contains the account's address and name.
+     * - The providerName string identifies the provider that is used to interact with the blockchain.
+     */
+    constructor({ address, name }: IAccountDetails, providerName: string);
+    /**
+     * @returns The address of the account.
+     */
+    address(): string;
+    /**
+     * @returns The name of the account.
+     */
+    name(): string;
+    /**
+     * @returns The name of the provider.
+     */
+    providerName(): string;
+    /**
+     * This method aims to retrieve the account's balance.
+     *
+     * @returns A promise that resolves to an object of type IAccountBalanceResponse. It contains the account's balance.
+     */
+    balance(): Promise<IAccountBalanceResponse>;
+    /**
+     * This method aims to sign a message.
+     *
+     * @param data - The message to be signed.
+     * @returns An IAccountSignResponse object. It contains the signature of the message.
+     */
+    sign(data: Uint8Array | string): Promise<IAccountSignResponse>;
+    /**
+     * This method aims to buy rolls on behalf of the sender.
+     *
+     * @param amount - The amount of rolls to be bought.
+     * @param fee - The fee to be paid for the transaction execution by the node.
+     * @returns An ITransactionDetails object. It contains the operationId on the network.
+     */
+    buyRolls(amount: bigint, fee: bigint): Promise<ITransactionDetails>;
+    /**
+     * This method aims to sell rolls on behalf of the sender.
+     *
+     * @param amount - The amount of rolls to be sold.
+     * @param fee - The fee to be paid for the transaction execution by the node.
+     * @returns An ITransactionDetails object. It contains the operationId on the network.
+     */
+    sellRolls(amount: bigint, fee: bigint): Promise<ITransactionDetails>;
+    /**
+     * This method aims to transfer MAS on behalf of the sender to a recipient.
+     *
+     * @param amount - The amount of MAS (in the smallest unit) to be transferred.
+     * @param fee - The fee to be paid for the transaction execution (in the smallest unit).
+     * @returns An ITransactionDetails object. It contains the operationId on the network.
+     */
+    sendTransaction(amount: bigint, recipientAddress: string, fee: bigint): Promise<ITransactionDetails>;
+    /**
+     * This method aims to interact with a smart contract deployed on the MASSA blockchain.
+     *
+     * @remarks
+     * If dryRun.dryRun is true, the method will dry run the smart contract call and return an
+     * IContractReadOperationResponse object which contains all the information about the dry run
+     * (state changes, gas used, etc.)
+     *
+     * @param contractAddress - The address of the smart contract.
+     * @param functionName - The name of the function to be called.
+     * @param parameter - The parameters as an Args object to be passed to the function.
+     * @param amount - The amount of MASSA coins to be sent to the contract (in the smallest unit).
+     * @param fee - The fee to be paid for the transaction execution (in the smallest unit).
+     * @param maxGas - The maximum amount of gas to be used for the transaction execution.
+     * @param nonPersistentExecution - The dryRun object to be passed to the function.
+     *
+     * @returns if 'nonPersistentExecution' is true, it returns an IContractReadOperationResponse object.
+     * Otherwise, it returns an ITransactionDetails object which contains the operationId on the network.
+     *
+     */
+    callSC(contractAddress: string, functionName: string, parameter: Uint8Array | Args, amount: bigint, fee: bigint, maxGas: bigint, nonPersistentExecution?: boolean): Promise<ITransactionDetails | IContractReadOperationResponse>;
+    getNodeUrlFromMassaStation(): Promise<string>;
+    nonPersistentCallSC(contractAddress: string, functionName: string, parameter: Uint8Array | Args, amount: bigint, fee: bigint, maxGas: bigint): Promise<IContractReadOperationResponse>;
+}
+//# sourceMappingURL=MassaStationAccount.d.ts.map

package/dist/cmd/massaStation/MassaStationAccount.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MassaStationAccount.d.ts","sourceRoot":"","sources":["../../../src/massaStation/MassaStationAccount.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,EACvB,eAAe,EACf,oBAAoB,EACpB,mBAAmB,EACpB,MAAM,IAAI,CAAC;AACZ,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAM/C,OAAO,EACL,IAAI,EAEJ,8BAA8B,EAC/B,MAAM,uBAAuB,CAAC;AAoC/B;;;;;;;GAOG;AACH,qBAAa,mBAAoB,YAAW,QAAQ;IAClD,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,KAAK,CAAS;IAEtB;;;;;;;;;;;;OAYG;gBACgB,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM;IAM3E;;OAEG;IACI,OAAO,IAAI,MAAM;IAIxB;;OAEG;IACI,IAAI,IAAI,MAAM;IAIrB;;OAEG;IACI,YAAY,IAAI,MAAM;IAI7B;;;;OAIG;IACU,OAAO,IAAI,OAAO,CAAC,uBAAuB,CAAC;IAqBxD;;;;;OAKG;IACU,IAAI,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAoB3E;;;;;;OAMG;IACU,QAAQ,CACnB,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,mBAAmB,CAAC;IAoB/B;;;;;;OAMG;IACU,SAAS,CACpB,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,mBAAmB,CAAC;IAoB/B;;;;;;OAMG;IACG,eAAe,CACnB,MAAM,EAAE,MAAM,EACd,gBAAgB,EAAE,MAAM,EACxB,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,mBAAmB,CAAC;IAsB/B;;;;;;;;;;;;;;;;;;;OAmBG;IACU,MAAM,CACjB,eAAe,EAAE,MAAM,EACvB,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,UAAU,GAAG,IAAI,EAC5B,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,EACd,sBAAsB,UAAQ,GAC7B,OAAO,CAAC,mBAAmB,GAAG,8BAA8B,CAAC;IAyCnD,0BAA0B,IAAI,OAAO,CAAC,MAAM,CAAC;IAoB7C,mBAAmB,CAC9B,eAAe,EAAE,MAAM,EACvB,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,UAAU,GAAG,IAAI,EAC5B,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,8BAA8B,CAAC;CAgE3C"}

package/dist/cmd/massaStation/MassaStationAccount.js

@@ -0,0 +1,312 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MassaStationAccount = void 0;
+const RequestHandler_1 = require("./RequestHandler");
+const MassaStationProvider_1 = require("./MassaStationProvider");
+const argsToBase64_1 = require("../utils/argsToBase64");
+/**
+ * The maximum allowed gas for a read operation
+ */
+const MAX_READ_BLOCK_GAS = BigInt(4294967295);
+/**
+ * This module contains the MassaStationAccount class. It is responsible for representing an account in
+ * the MassaStation wallet.
+ *
+ * @remarks
+ * This class provides methods to interact with MassaStation account's {@link balance} and to {@link sign} messages.
+ *
+ */
+class MassaStationAccount {
+    /**
+     * This constructor takes an object of type IAccountDetails and a providerName string as its arguments.
+     *
+     * @param address - The address of the account.
+     * @param name - The name of the account.
+     * @param providerName - The name of the provider.
+     * @returns An instance of the Account class.
+     *
+     * @remarks
+     * - The Account constructor takes an object of type IAccountDetails and a providerName string as its arguments.
+     * - The IAccountDetails object contains the account's address and name.
+     * - The providerName string identifies the provider that is used to interact with the blockchain.
+     */
+    constructor({ address, name }, providerName) {
+        this._address = address;
+        this._name = name;
+        this._providerName = providerName;
+    }
+    /**
+     * @returns The address of the account.
+     */
+    address() {
+        return this._address;
+    }
+    /**
+     * @returns The name of the account.
+     */
+    name() {
+        return this._name;
+    }
+    /**
+     * @returns The name of the provider.
+     */
+    providerName() {
+        return this._providerName;
+    }
+    /**
+     * This method aims to retrieve the account's balance.
+     *
+     * @returns A promise that resolves to an object of type IAccountBalanceResponse. It contains the account's balance.
+     */
+    async balance() {
+        let signOpResponse = null;
+        try {
+            signOpResponse = await (0, RequestHandler_1.getRequest)(`${MassaStationProvider_1.MASSA_STATION_URL}massa/addresses?attributes=balance&addresses=${this._address}`);
+        }
+        catch (ex) {
+            console.error(`MassaStation account balance error`);
+            throw ex;
+        }
+        if (signOpResponse.isError || signOpResponse.error) {
+            throw signOpResponse.error;
+        }
+        const balance = signOpResponse.result.addressesAttributes[this._address].balance;
+        return {
+            finalBalance: balance.final,
+            candidateBalance: balance.pending,
+        };
+    }
+    /**
+     * This method aims to sign a message.
+     *
+     * @param data - The message to be signed.
+     * @returns An IAccountSignResponse object. It contains the signature of the message.
+     */
+    async sign(data) {
+        let signOpResponse = null;
+        try {
+            signOpResponse = await (0, RequestHandler_1.postRequest)(`${MassaStationProvider_1.MASSA_STATION_ACCOUNTS_URL}/${this._name}/sign`, {
+                operation: data,
+                batch: false,
+            });
+        }
+        catch (ex) {
+            console.error(`MassaStation account signing error`);
+            throw ex;
+        }
+        if (signOpResponse.isError || signOpResponse.error) {
+            throw signOpResponse.error;
+        }
+        return signOpResponse.result;
+    }
+    /**
+     * This method aims to buy rolls on behalf of the sender.
+     *
+     * @param amount - The amount of rolls to be bought.
+     * @param fee - The fee to be paid for the transaction execution by the node.
+     * @returns An ITransactionDetails object. It contains the operationId on the network.
+     */
+    async buyRolls(amount, fee) {
+        let buyRollsOpResponse = null;
+        const url = `${MassaStationProvider_1.MASSA_STATION_ACCOUNTS_URL}/${this._name}/rolls`;
+        const body = {
+            fee: fee.toString(),
+            amount: amount.toString(),
+            side: 'buy',
+        };
+        try {
+            buyRollsOpResponse = await (0, RequestHandler_1.postRequest)(url, body);
+        }
+        catch (ex) {
+            console.error(`MassaStation account: error while buying rolls: ${ex}`);
+            throw ex;
+        }
+        if (buyRollsOpResponse.isError || buyRollsOpResponse.error) {
+            throw buyRollsOpResponse.error;
+        }
+        return buyRollsOpResponse.result;
+    }
+    /**
+     * This method aims to sell rolls on behalf of the sender.
+     *
+     * @param amount - The amount of rolls to be sold.
+     * @param fee - The fee to be paid for the transaction execution by the node.
+     * @returns An ITransactionDetails object. It contains the operationId on the network.
+     */
+    async sellRolls(amount, fee) {
+        let sellRollsOpResponse = null;
+        const url = `${MassaStationProvider_1.MASSA_STATION_ACCOUNTS_URL}/${this._name}/rolls`;
+        const body = {
+            fee: fee.toString(),
+            amount: amount.toString(),
+            side: 'sell',
+        };
+        try {
+            sellRollsOpResponse = await (0, RequestHandler_1.postRequest)(url, body);
+        }
+        catch (ex) {
+            console.error(`MassaStation account: error while selling rolls: ${ex}`);
+            throw ex;
+        }
+        if (sellRollsOpResponse.isError || sellRollsOpResponse.error) {
+            throw sellRollsOpResponse.error;
+        }
+        return sellRollsOpResponse.result;
+    }
+    /**
+     * This method aims to transfer MAS on behalf of the sender to a recipient.
+     *
+     * @param amount - The amount of MAS (in the smallest unit) to be transferred.
+     * @param fee - The fee to be paid for the transaction execution (in the smallest unit).
+     * @returns An ITransactionDetails object. It contains the operationId on the network.
+     */
+    async sendTransaction(amount, recipientAddress, fee) {
+        let sendTxOpResponse = null;
+        const url = `${MassaStationProvider_1.MASSA_STATION_ACCOUNTS_URL}/${this._name}/transfer`;
+        const body = {
+            fee: fee.toString(),
+            amount: amount.toString(),
+            recipientAddress: recipientAddress,
+        };
+        try {
+            sendTxOpResponse = await (0, RequestHandler_1.postRequest)(url, body);
+        }
+        catch (ex) {
+            console.error(`MassaStation account: error while sending transaction: ${ex}`);
+            throw ex;
+        }
+        if (sendTxOpResponse.isError || sendTxOpResponse.error) {
+            throw sendTxOpResponse.error;
+        }
+        return sendTxOpResponse.result;
+    }
+    /**
+     * This method aims to interact with a smart contract deployed on the MASSA blockchain.
+     *
+     * @remarks
+     * If dryRun.dryRun is true, the method will dry run the smart contract call and return an
+     * IContractReadOperationResponse object which contains all the information about the dry run
+     * (state changes, gas used, etc.)
+     *
+     * @param contractAddress - The address of the smart contract.
+     * @param functionName - The name of the function to be called.
+     * @param parameter - The parameters as an Args object to be passed to the function.
+     * @param amount - The amount of MASSA coins to be sent to the contract (in the smallest unit).
+     * @param fee - The fee to be paid for the transaction execution (in the smallest unit).
+     * @param maxGas - The maximum amount of gas to be used for the transaction execution.
+     * @param nonPersistentExecution - The dryRun object to be passed to the function.
+     *
+     * @returns if 'nonPersistentExecution' is true, it returns an IContractReadOperationResponse object.
+     * Otherwise, it returns an ITransactionDetails object which contains the operationId on the network.
+     *
+     */
+    async callSC(contractAddress, functionName, parameter, amount, fee, maxGas, nonPersistentExecution = false) {
+        if (nonPersistentExecution) {
+            return this.nonPersistentCallSC(contractAddress, functionName, parameter, amount, fee, maxGas);
+        }
+        // convert parameter to base64
+        let args = '';
+        if (parameter instanceof Uint8Array) {
+            args = (0, argsToBase64_1.uint8ArrayToBase64)(parameter);
+        }
+        else {
+            args = (0, argsToBase64_1.argsToBase64)(parameter);
+        }
+        let CallSCOpResponse = null;
+        const url = `${MassaStationProvider_1.MASSA_STATION_URL}cmd/executeFunction`;
+        const body = {
+            nickname: this._name,
+            name: functionName,
+            at: contractAddress,
+            args: args,
+            coins: Number(amount),
+        };
+        try {
+            CallSCOpResponse = await (0, RequestHandler_1.postRequest)(url, body);
+        }
+        catch (ex) {
+            console.log(`MassaStation account: error while interacting with smart contract: ${ex}`);
+            throw ex;
+        }
+        if (CallSCOpResponse.isError || CallSCOpResponse.error) {
+            throw CallSCOpResponse.error;
+        }
+        return CallSCOpResponse.result;
+    }
+    async getNodeUrlFromMassaStation() {
+        // get the node url from MassaStation
+        let nodesResponse = null;
+        let node = '';
+        try {
+            nodesResponse = await (0, RequestHandler_1.getRequest)(`${MassaStationProvider_1.MASSA_STATION_URL}massa/node`);
+            if (nodesResponse.isError || nodesResponse.error) {
+                throw nodesResponse.error.message;
+            }
+            // transform nodesResponse.result to a json and then get the "url" property
+            const nodes = nodesResponse.result;
+            node = nodes.url;
+        }
+        catch (ex) {
+            throw new Error(`MassaStation nodes retrieval error: ${ex}`);
+        }
+        return node;
+    }
+    async nonPersistentCallSC(contractAddress, functionName, parameter, amount, fee, maxGas) {
+        const node = await this.getNodeUrlFromMassaStation();
+        // Gas amount check
+        if (maxGas > MAX_READ_BLOCK_GAS) {
+            throw new Error(`
+        The gas submitted ${maxGas.toString()} exceeds the max. allowed block gas of 
+        ${MAX_READ_BLOCK_GAS.toString()}
+        `);
+        }
+        // convert parameter to an array of numbers
+        let argumentArray = [];
+        if (parameter instanceof Uint8Array) {
+            argumentArray = Array.from(parameter);
+        }
+        else {
+            argumentArray = Array.from(parameter.serialize());
+        }
+        // setup the request body
+        const data = {
+            max_gas: Number(maxGas),
+            target_address: contractAddress,
+            target_function: functionName,
+            parameter: argumentArray,
+            caller_address: this._address,
+        };
+        const body = [
+            {
+                jsonrpc: '2.0',
+                method: 'execute_read_only_call',
+                params: [[data]],
+                id: 0,
+            },
+        ];
+        // returns operation ids
+        let jsonRpcCallResult = [];
+        try {
+            let resp = await (0, RequestHandler_1.postRequest)(node, body);
+            if (resp.isError || resp.error) {
+                throw resp.error.message;
+            }
+            jsonRpcCallResult = resp.result;
+        }
+        catch (ex) {
+            throw new Error(`MassaStation account: error while interacting with smart contract: ${ex}`);
+        }
+        if (jsonRpcCallResult.length <= 0) {
+            throw new Error(`Read operation bad response. No results array in json rpc response. Inspect smart contract`);
+        }
+        if (jsonRpcCallResult[0].result.Error) {
+            throw new Error(jsonRpcCallResult[0].result.Error);
+        }
+        return {
+            returnValue: new Uint8Array(jsonRpcCallResult[0].result[0].result.Ok),
+            info: jsonRpcCallResult[0],
+        };
+    }
+}
+exports.MassaStationAccount = MassaStationAccount;
+//# sourceMappingURL=MassaStationAccount.js.map

package/dist/cmd/massaStation/MassaStationAccount.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MassaStationAccount.js","sourceRoot":"","sources":["../../../src/massaStation/MassaStationAccount.ts"],"names":[],"mappings":";;;AAOA,qDAAgF;AAChF,iEAGgC;AAOhC,wDAAyE;AAEzE;;GAEG;AACH,MAAM,kBAAkB,GAAG,MAAM,CAAC,UAAa,CAAC,CAAC;AA6BjD;;;;;;;GAOG;AACH,MAAa,mBAAmB;IAK9B;;;;;;;;;;;;OAYG;IACH,YAAmB,EAAE,OAAO,EAAE,IAAI,EAAmB,EAAE,YAAoB;QACzE,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;IACpC,CAAC;IAED;;OAEG;IACI,OAAO;QACZ,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACI,IAAI;QACT,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,YAAY;QACjB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAO;QAClB,IAAI,cAAc,GAA4C,IAAI,CAAC;QACnE,IAAI;YACF,cAAc,GAAG,MAAM,IAAA,2BAAU,EAC/B,GAAG,wCAAiB,gDAAgD,IAAI,CAAC,QAAQ,EAAE,CACpF,CAAC;SACH;QAAC,OAAO,EAAE,EAAE;YACX,OAAO,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAC;YACpD,MAAM,EAAE,CAAC;SACV;QACD,IAAI,cAAc,CAAC,OAAO,IAAI,cAAc,CAAC,KAAK,EAAE;YAClD,MAAM,cAAc,CAAC,KAAK,CAAC;SAC5B;QACD,MAAM,OAAO,GACX,cAAc,CAAC,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC;QACnE,OAAO;YACL,YAAY,EAAE,OAAO,CAAC,KAAK;YAC3B,gBAAgB,EAAE,OAAO,CAAC,OAAO;SAClC,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,IAAI,CAAC,IAAyB;QACzC,IAAI,cAAc,GAA8C,IAAI,CAAC;QACrE,IAAI;YACF,cAAc,GAAG,MAAM,IAAA,4BAAW,EAChC,GAAG,iDAA0B,IAAI,IAAI,CAAC,KAAK,OAAO,EAClD;gBACE,SAAS,EAAE,IAAI;gBACf,KAAK,EAAE,KAAK;aACK,CACpB,CAAC;SACH;QAAC,OAAO,EAAE,EAAE;YACX,OAAO,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAC;YACpD,MAAM,EAAE,CAAC;SACV;QACD,IAAI,cAAc,CAAC,OAAO,IAAI,cAAc,CAAC,KAAK,EAAE;YAClD,MAAM,cAAc,CAAC,KAAK,CAAC;SAC5B;QACD,OAAO,cAAc,CAAC,MAAM,CAAC;IAC/B,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,QAAQ,CACnB,MAAc,EACd,GAAW;QAEX,IAAI,kBAAkB,GAA6C,IAAI,CAAC;QACxE,MAAM,GAAG,GAAG,GAAG,iDAA0B,IAAI,IAAI,CAAC,KAAK,QAAQ,CAAC;QAChE,MAAM,IAAI,GAAG;YACX,GAAG,EAAE,GAAG,CAAC,QAAQ,EAAE;YACnB,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE;YACzB,IAAI,EAAE,KAAK;SACZ,CAAC;QACF,IAAI;YACF,kBAAkB,GAAG,MAAM,IAAA,4BAAW,EAAsB,GAAG,EAAE,IAAI,CAAC,CAAC;SACxE;QAAC,OAAO,EAAE,EAAE;YACX,OAAO,CAAC,KAAK,CAAC,mDAAmD,EAAE,EAAE,CAAC,CAAC;YACvE,MAAM,EAAE,CAAC;SACV;QACD,IAAI,kBAAkB,CAAC,OAAO,IAAI,kBAAkB,CAAC,KAAK,EAAE;YAC1D,MAAM,kBAAkB,CAAC,KAAK,CAAC;SAChC;QACD,OAAO,kBAAkB,CAAC,MAAM,CAAC;IACnC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,SAAS,CACpB,MAAc,EACd,GAAW;QAEX,IAAI,mBAAmB,GAA6C,IAAI,CAAC;QACzE,MAAM,GAAG,GAAG,GAAG,iDAA0B,IAAI,IAAI,CAAC,KAAK,QAAQ,CAAC;QAChE,MAAM,IAAI,GAAG;YACX,GAAG,EAAE,GAAG,CAAC,QAAQ,EAAE;YACnB,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE;YACzB,IAAI,EAAE,MAAM;SACb,CAAC;QACF,IAAI;YACF,mBAAmB,GAAG,MAAM,IAAA,4BAAW,EAAsB,GAAG,EAAE,IAAI,CAAC,CAAC;SACzE;QAAC,OAAO,EAAE,EAAE;YACX,OAAO,CAAC,KAAK,CAAC,oDAAoD,EAAE,EAAE,CAAC,CAAC;YACxE,MAAM,EAAE,CAAC;SACV;QACD,IAAI,mBAAmB,CAAC,OAAO,IAAI,mBAAmB,CAAC,KAAK,EAAE;YAC5D,MAAM,mBAAmB,CAAC,KAAK,CAAC;SACjC;QACD,OAAO,mBAAmB,CAAC,MAAM,CAAC;IACpC,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,eAAe,CACnB,MAAc,EACd,gBAAwB,EACxB,GAAW;QAEX,IAAI,gBAAgB,GAA6C,IAAI,CAAC;QACtE,MAAM,GAAG,GAAG,GAAG,iDAA0B,IAAI,IAAI,CAAC,KAAK,WAAW,CAAC;QACnE,MAAM,IAAI,GAAG;YACX,GAAG,EAAE,GAAG,CAAC,QAAQ,EAAE;YACnB,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE;YACzB,gBAAgB,EAAE,gBAAgB;SACnC,CAAC;QACF,IAAI;YACF,gBAAgB,GAAG,MAAM,IAAA,4BAAW,EAAsB,GAAG,EAAE,IAAI,CAAC,CAAC;SACtE;QAAC,OAAO,EAAE,EAAE;YACX,OAAO,CAAC,KAAK,CACX,0DAA0D,EAAE,EAAE,CAC/D,CAAC;YACF,MAAM,EAAE,CAAC;SACV;QACD,IAAI,gBAAgB,CAAC,OAAO,IAAI,gBAAgB,CAAC,KAAK,EAAE;YACtD,MAAM,gBAAgB,CAAC,KAAK,CAAC;SAC9B;QACD,OAAO,gBAAgB,CAAC,MAAM,CAAC;IACjC,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACI,KAAK,CAAC,MAAM,CACjB,eAAuB,EACvB,YAAoB,EACpB,SAA4B,EAC5B,MAAc,EACd,GAAW,EACX,MAAc,EACd,sBAAsB,GAAG,KAAK;QAE9B,IAAI,sBAAsB,EAAE;YAC1B,OAAO,IAAI,CAAC,mBAAmB,CAC7B,eAAe,EACf,YAAY,EACZ,SAAS,EACT,MAAM,EACN,GAAG,EACH,MAAM,CACP,CAAC;SACH;QACD,8BAA8B;QAC9B,IAAI,IAAI,GAAG,EAAE,CAAC;QACd,IAAI,SAAS,YAAY,UAAU,EAAE;YACnC,IAAI,GAAG,IAAA,iCAAkB,EAAC,SAAS,CAAC,CAAC;SACtC;aAAM;YACL,IAAI,GAAG,IAAA,2BAAY,EAAC,SAAS,CAAC,CAAC;SAChC;QACD,IAAI,gBAAgB,GAA6C,IAAI,CAAC;QACtE,MAAM,GAAG,GAAG,GAAG,wCAAiB,qBAAqB,CAAC;QACtD,MAAM,IAAI,GAAG;YACX,QAAQ,EAAE,IAAI,CAAC,KAAK;YACpB,IAAI,EAAE,YAAY;YAClB,EAAE,EAAE,eAAe;YACnB,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC;SACtB,CAAC;QACF,IAAI;YACF,gBAAgB,GAAG,MAAM,IAAA,4BAAW,EAAsB,GAAG,EAAE,IAAI,CAAC,CAAC;SACtE;QAAC,OAAO,EAAE,EAAE;YACX,OAAO,CAAC,GAAG,CACT,sEAAsE,EAAE,EAAE,CAC3E,CAAC;YACF,MAAM,EAAE,CAAC;SACV;QACD,IAAI,gBAAgB,CAAC,OAAO,IAAI,gBAAgB,CAAC,KAAK,EAAE;YACtD,MAAM,gBAAgB,CAAC,KAAK,CAAC;SAC9B;QACD,OAAO,gBAAgB,CAAC,MAAM,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,0BAA0B;QACrC,qCAAqC;QACrC,IAAI,aAAa,GAAiC,IAAI,CAAC;QACvD,IAAI,IAAI,GAAG,EAAE,CAAC;QACd,IAAI;YACF,aAAa,GAAG,MAAM,IAAA,2BAAU,EAC9B,GAAG,wCAAiB,YAAY,CACjC,CAAC;YACF,IAAI,aAAa,CAAC,OAAO,IAAI,aAAa,CAAC,KAAK,EAAE;gBAChD,MAAM,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC;aACnC;YACD,2EAA2E;YAC3E,MAAM,KAAK,GAAG,aAAa,CAAC,MAAyB,CAAC;YACtD,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC;SAClB;QAAC,OAAO,EAAE,EAAE;YACX,MAAM,IAAI,KAAK,CAAC,uCAAuC,EAAE,EAAE,CAAC,CAAC;SAC9D;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAC9B,eAAuB,EACvB,YAAoB,EACpB,SAA4B,EAC5B,MAAc,EACd,GAAW,EACX,MAAc;QAEd,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,0BAA0B,EAAE,CAAC;QACrD,mBAAmB;QACnB,IAAI,MAAM,GAAG,kBAAkB,EAAE;YAC/B,MAAM,IAAI,KAAK,CACb;4BACoB,MAAM,CAAC,QAAQ,EAAE;UACnC,kBAAkB,CAAC,QAAQ,EAAE;SAC9B,CACF,CAAC;SACH;QAED,2CAA2C;QAC3C,IAAI,aAAa,GAAG,EAAE,CAAC;QACvB,IAAI,SAAS,YAAY,UAAU,EAAE;YACnC,aAAa,GAAG,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SACvC;aAAM;YACL,aAAa,GAAG,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,CAAC;SACnD;QACD,yBAAyB;QACzB,MAAM,IAAI,GAAG;YACX,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC;YACvB,cAAc,EAAE,eAAe;YAC/B,eAAe,EAAE,YAAY;YAC7B,SAAS,EAAE,aAAa;YACxB,cAAc,EAAE,IAAI,CAAC,QAAQ;SAC9B,CAAC;QACF,MAAM,IAAI,GAAG;YACX;gBACE,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,wBAAwB;gBAChC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;gBAChB,EAAE,EAAE,CAAC;aACN;SACF,CAAC;QACF,wBAAwB;QACxB,IAAI,iBAAiB,GAAsC,EAAE,CAAC;QAC9D,IAAI;YACF,IAAI,IAAI,GAAG,MAAM,IAAA,4BAAW,EAC1B,IAAI,EACJ,IAAI,CACL,CAAC;YACF,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,KAAK,EAAE;gBAC9B,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;aAC1B;YACD,iBAAiB,GAAG,IAAI,CAAC,MAAM,CAAC;SACjC;QAAC,OAAO,EAAE,EAAE;YACX,MAAM,IAAI,KAAK,CACb,sEAAsE,EAAE,EAAE,CAC3E,CAAC;SACH;QACD,IAAI,iBAAiB,CAAC,MAAM,IAAI,CAAC,EAAE;YACjC,MAAM,IAAI,KAAK,CACb,4FAA4F,CAC7F,CAAC;SACH;QACD,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE;YACrC,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;SACpD;QACD,OAAO;YACL,WAAW,EAAE,IAAI,UAAU,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC;YACrE,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC;SAC3B,CAAC;IACJ,CAAC;CACF;AA9VD,kDA8VC","sourcesContent":["import {\n  IAccountBalanceResponse,\n  IAccountDetails,\n  IAccountSignResponse,\n  ITransactionDetails,\n} from '..';\nimport { IAccount } from '../account/IAccount';\nimport { JsonRpcResponseData, getRequest, postRequest } from './RequestHandler';\nimport {\n  MASSA_STATION_URL,\n  MASSA_STATION_ACCOUNTS_URL,\n} from './MassaStationProvider';\nimport {\n  Args,\n  IContractReadOperationData,\n  IContractReadOperationResponse,\n} from '@massalabs/web3-utils';\n\nimport { argsToBase64, uint8ArrayToBase64 } from '../utils/argsToBase64';\n\n/**\n * The maximum allowed gas for a read operation\n */\nconst MAX_READ_BLOCK_GAS = BigInt(4_294_967_295);\n\n/**\n * This interface represents the payload returned by making a call to MassaStation's sign\n * operation `/signOperation` url.\n */\ninterface ISignOperation {\n  operation: string;\n  batch?: boolean;\n  correlationId?: string;\n}\n\n/**\n * This interface represents the the individual wallet's final and pending balances returned by MassaStation\n */\ninterface IBalance {\n  final: string;\n  pending: string;\n}\n\n/**\n * This interface represents the payload returned by making a call to MassaStation's get balances url.\n */\ninterface IAddressesBalances {\n  addressesAttributes: {\n    [key: string]: { balance: IBalance };\n  };\n}\n\n/**\n * This module contains the MassaStationAccount class. It is responsible for representing an account in\n * the MassaStation wallet.\n *\n * @remarks\n * This class provides methods to interact with MassaStation account's {@link balance} and to {@link sign} messages.\n *\n */\nexport class MassaStationAccount implements IAccount {\n  private _providerName: string;\n  private _address: string;\n  private _name: string;\n\n  /**\n   * This constructor takes an object of type IAccountDetails and a providerName string as its arguments.\n   *\n   * @param address - The address of the account.\n   * @param name - The name of the account.\n   * @param providerName - The name of the provider.\n   * @returns An instance of the Account class.\n   *\n   * @remarks\n   * - The Account constructor takes an object of type IAccountDetails and a providerName string as its arguments.\n   * - The IAccountDetails object contains the account's address and name.\n   * - The providerName string identifies the provider that is used to interact with the blockchain.\n   */\n  public constructor({ address, name }: IAccountDetails, providerName: string) {\n    this._address = address;\n    this._name = name;\n    this._providerName = providerName;\n  }\n\n  /**\n   * @returns The address of the account.\n   */\n  public address(): string {\n    return this._address;\n  }\n\n  /**\n   * @returns The name of the account.\n   */\n  public name(): string {\n    return this._name;\n  }\n\n  /**\n   * @returns The name of the provider.\n   */\n  public providerName(): string {\n    return this._providerName;\n  }\n\n  /**\n   * This method aims to retrieve the account's balance.\n   *\n   * @returns A promise that resolves to an object of type IAccountBalanceResponse. It contains the account's balance.\n   */\n  public async balance(): Promise<IAccountBalanceResponse> {\n    let signOpResponse: JsonRpcResponseData<IAddressesBalances> = null;\n    try {\n      signOpResponse = await getRequest<IAddressesBalances>(\n        `${MASSA_STATION_URL}massa/addresses?attributes=balance&addresses=${this._address}`,\n      );\n    } catch (ex) {\n      console.error(`MassaStation account balance error`);\n      throw ex;\n    }\n    if (signOpResponse.isError || signOpResponse.error) {\n      throw signOpResponse.error;\n    }\n    const balance: IBalance =\n      signOpResponse.result.addressesAttributes[this._address].balance;\n    return {\n      finalBalance: balance.final,\n      candidateBalance: balance.pending,\n    };\n  }\n\n  /**\n   * This method aims to sign a message.\n   *\n   * @param data - The message to be signed.\n   * @returns An IAccountSignResponse object. It contains the signature of the message.\n   */\n  public async sign(data: Uint8Array | string): Promise<IAccountSignResponse> {\n    let signOpResponse: JsonRpcResponseData<IAccountSignResponse> = null;\n    try {\n      signOpResponse = await postRequest<IAccountSignResponse>(\n        `${MASSA_STATION_ACCOUNTS_URL}/${this._name}/sign`,\n        {\n          operation: data,\n          batch: false,\n        } as ISignOperation,\n      );\n    } catch (ex) {\n      console.error(`MassaStation account signing error`);\n      throw ex;\n    }\n    if (signOpResponse.isError || signOpResponse.error) {\n      throw signOpResponse.error;\n    }\n    return signOpResponse.result;\n  }\n\n  /**\n   * This method aims to buy rolls on behalf of the sender.\n   *\n   * @param amount - The amount of rolls to be bought.\n   * @param fee - The fee to be paid for the transaction execution by the node.\n   * @returns An ITransactionDetails object. It contains the operationId on the network.\n   */\n  public async buyRolls(\n    amount: bigint,\n    fee: bigint,\n  ): Promise<ITransactionDetails> {\n    let buyRollsOpResponse: JsonRpcResponseData<ITransactionDetails> = null;\n    const url = `${MASSA_STATION_ACCOUNTS_URL}/${this._name}/rolls`;\n    const body = {\n      fee: fee.toString(),\n      amount: amount.toString(),\n      side: 'buy',\n    };\n    try {\n      buyRollsOpResponse = await postRequest<ITransactionDetails>(url, body);\n    } catch (ex) {\n      console.error(`MassaStation account: error while buying rolls: ${ex}`);\n      throw ex;\n    }\n    if (buyRollsOpResponse.isError || buyRollsOpResponse.error) {\n      throw buyRollsOpResponse.error;\n    }\n    return buyRollsOpResponse.result;\n  }\n\n  /**\n   * This method aims to sell rolls on behalf of the sender.\n   *\n   * @param amount - The amount of rolls to be sold.\n   * @param fee - The fee to be paid for the transaction execution by the node.\n   * @returns An ITransactionDetails object. It contains the operationId on the network.\n   */\n  public async sellRolls(\n    amount: bigint,\n    fee: bigint,\n  ): Promise<ITransactionDetails> {\n    let sellRollsOpResponse: JsonRpcResponseData<ITransactionDetails> = null;\n    const url = `${MASSA_STATION_ACCOUNTS_URL}/${this._name}/rolls`;\n    const body = {\n      fee: fee.toString(),\n      amount: amount.toString(),\n      side: 'sell',\n    };\n    try {\n      sellRollsOpResponse = await postRequest<ITransactionDetails>(url, body);\n    } catch (ex) {\n      console.error(`MassaStation account: error while selling rolls: ${ex}`);\n      throw ex;\n    }\n    if (sellRollsOpResponse.isError || sellRollsOpResponse.error) {\n      throw sellRollsOpResponse.error;\n    }\n    return sellRollsOpResponse.result;\n  }\n\n  /**\n   * This method aims to transfer MAS on behalf of the sender to a recipient.\n   *\n   * @param amount - The amount of MAS (in the smallest unit) to be transferred.\n   * @param fee - The fee to be paid for the transaction execution (in the smallest unit).\n   * @returns An ITransactionDetails object. It contains the operationId on the network.\n   */\n  async sendTransaction(\n    amount: bigint,\n    recipientAddress: string,\n    fee: bigint,\n  ): Promise<ITransactionDetails> {\n    let sendTxOpResponse: JsonRpcResponseData<ITransactionDetails> = null;\n    const url = `${MASSA_STATION_ACCOUNTS_URL}/${this._name}/transfer`;\n    const body = {\n      fee: fee.toString(),\n      amount: amount.toString(),\n      recipientAddress: recipientAddress,\n    };\n    try {\n      sendTxOpResponse = await postRequest<ITransactionDetails>(url, body);\n    } catch (ex) {\n      console.error(\n        `MassaStation account: error while sending transaction: ${ex}`,\n      );\n      throw ex;\n    }\n    if (sendTxOpResponse.isError || sendTxOpResponse.error) {\n      throw sendTxOpResponse.error;\n    }\n    return sendTxOpResponse.result;\n  }\n\n  /**\n   * This method aims to interact with a smart contract deployed on the MASSA blockchain.\n   *\n   * @remarks\n   * If dryRun.dryRun is true, the method will dry run the smart contract call and return an\n   * IContractReadOperationResponse object which contains all the information about the dry run\n   * (state changes, gas used, etc.)\n   *\n   * @param contractAddress - The address of the smart contract.\n   * @param functionName - The name of the function to be called.\n   * @param parameter - The parameters as an Args object to be passed to the function.\n   * @param amount - The amount of MASSA coins to be sent to the contract (in the smallest unit).\n   * @param fee - The fee to be paid for the transaction execution (in the smallest unit).\n   * @param maxGas - The maximum amount of gas to be used for the transaction execution.\n   * @param nonPersistentExecution - The dryRun object to be passed to the function.\n   *\n   * @returns if 'nonPersistentExecution' is true, it returns an IContractReadOperationResponse object.\n   * Otherwise, it returns an ITransactionDetails object which contains the operationId on the network.\n   *\n   */\n  public async callSC(\n    contractAddress: string,\n    functionName: string,\n    parameter: Uint8Array | Args,\n    amount: bigint,\n    fee: bigint,\n    maxGas: bigint,\n    nonPersistentExecution = false,\n  ): Promise<ITransactionDetails | IContractReadOperationResponse> {\n    if (nonPersistentExecution) {\n      return this.nonPersistentCallSC(\n        contractAddress,\n        functionName,\n        parameter,\n        amount,\n        fee,\n        maxGas,\n      );\n    }\n    // convert parameter to base64\n    let args = '';\n    if (parameter instanceof Uint8Array) {\n      args = uint8ArrayToBase64(parameter);\n    } else {\n      args = argsToBase64(parameter);\n    }\n    let CallSCOpResponse: JsonRpcResponseData<ITransactionDetails> = null;\n    const url = `${MASSA_STATION_URL}cmd/executeFunction`;\n    const body = {\n      nickname: this._name,\n      name: functionName,\n      at: contractAddress,\n      args: args,\n      coins: Number(amount),\n    };\n    try {\n      CallSCOpResponse = await postRequest<ITransactionDetails>(url, body);\n    } catch (ex) {\n      console.log(\n        `MassaStation account: error while interacting with smart contract: ${ex}`,\n      );\n      throw ex;\n    }\n    if (CallSCOpResponse.isError || CallSCOpResponse.error) {\n      throw CallSCOpResponse.error;\n    }\n    return CallSCOpResponse.result;\n  }\n\n  public async getNodeUrlFromMassaStation(): Promise<string> {\n    // get the node url from MassaStation\n    let nodesResponse: JsonRpcResponseData<unknown> = null;\n    let node = '';\n    try {\n      nodesResponse = await getRequest<unknown>(\n        `${MASSA_STATION_URL}massa/node`,\n      );\n      if (nodesResponse.isError || nodesResponse.error) {\n        throw nodesResponse.error.message;\n      }\n      // transform nodesResponse.result to a json and then get the \"url\" property\n      const nodes = nodesResponse.result as { url: string };\n      node = nodes.url;\n    } catch (ex) {\n      throw new Error(`MassaStation nodes retrieval error: ${ex}`);\n    }\n    return node;\n  }\n\n  public async nonPersistentCallSC(\n    contractAddress: string,\n    functionName: string,\n    parameter: Uint8Array | Args,\n    amount: bigint,\n    fee: bigint,\n    maxGas: bigint,\n  ): Promise<IContractReadOperationResponse> {\n    const node = await this.getNodeUrlFromMassaStation();\n    // Gas amount check\n    if (maxGas > MAX_READ_BLOCK_GAS) {\n      throw new Error(\n        `\n        The gas submitted ${maxGas.toString()} exceeds the max. allowed block gas of \n        ${MAX_READ_BLOCK_GAS.toString()}\n        `,\n      );\n    }\n\n    // convert parameter to an array of numbers\n    let argumentArray = [];\n    if (parameter instanceof Uint8Array) {\n      argumentArray = Array.from(parameter);\n    } else {\n      argumentArray = Array.from(parameter.serialize());\n    }\n    // setup the request body\n    const data = {\n      max_gas: Number(maxGas),\n      target_address: contractAddress,\n      target_function: functionName,\n      parameter: argumentArray,\n      caller_address: this._address,\n    };\n    const body = [\n      {\n        jsonrpc: '2.0',\n        method: 'execute_read_only_call',\n        params: [[data]],\n        id: 0,\n      },\n    ];\n    // returns operation ids\n    let jsonRpcCallResult: Array<IContractReadOperationData> = [];\n    try {\n      let resp = await postRequest<Array<IContractReadOperationData>>(\n        node,\n        body,\n      );\n      if (resp.isError || resp.error) {\n        throw resp.error.message;\n      }\n      jsonRpcCallResult = resp.result;\n    } catch (ex) {\n      throw new Error(\n        `MassaStation account: error while interacting with smart contract: ${ex}`,\n      );\n    }\n    if (jsonRpcCallResult.length <= 0) {\n      throw new Error(\n        `Read operation bad response. No results array in json rpc response. Inspect smart contract`,\n      );\n    }\n    if (jsonRpcCallResult[0].result.Error) {\n      throw new Error(jsonRpcCallResult[0].result.Error);\n    }\n    return {\n      returnValue: new Uint8Array(jsonRpcCallResult[0].result[0].result.Ok),\n      info: jsonRpcCallResult[0],\n    };\n  }\n}\n"]}

package/dist/cmd/massaStation/MassaStationDiscovery.d.ts

@@ -0,0 +1,57 @@
+/**
+ * This file defines a TypeScript class named MassaStationDiscovery.
+ * The class is being used to recursively search for a connection to MassaStation's server
+ * and if so report this via emitting messages.
+ *
+ * @remarks
+ * - If you are only looking to use our library, the connector MassaStationDiscovery will not be useful to you.
+ * - If you want to work on this repo, you will probably be interested in this object
+ *
+ */
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+/**
+ * Url used for the MassaStation discovery and pinging the MassaStation server's index.html
+ */
+export declare const MASSA_STATION_DISCOVERY_URL = "https://station.massa/web/index";
+/**
+ * A message emitted on successful MassaStation discovery
+ */
+export declare const ON_MASSA_STATION_DISCOVERED = "ON_MASSA_STATION_DISCOVERED";
+/**
+ * A message emitted on MassaStation disconnect
+ */
+export declare const ON_MASSA_STATION_DISCONNECTED = "ON_MASSA_STATION_DISCONNECTED";
+/**
+ * This file defines a TypeScript class named MassaStation.
+ * The class is being used to recursively ping MassaStation's server
+ * and if a response is received emit a message so MassaStation can be enlisted as
+ * a wallet provider in the `Connector` class.
+ */
+export declare class MassaStationDiscovery extends EventEmitter {
+    private isDiscovered;
+    /**
+     * MassaStation constructor
+     *
+     * @param pollIntervalMillis - Polling interval defined in milliseconds
+     *
+     * @remarks
+     * - It creates a timeout using the given `pollIntervalMillis` argument on every trigger of which
+     *  the MassaStation pinging is triggered and if a successful response is fetched,
+     * a message `ON_MASSA_STATION_DISCOVERED` is emitted that MassaStation has been discovered
+     * as a wallet provider upon which the `Connector` class will enlist MassaStation as a wallet provider
+     * - If once found, but then disconnected the following message `ON_MASSA_STATION_DISCONNECTED` is being emitted
+     *  so that the `Connector` class delists MassaStation as a wallet provider
+     *
+     * @returns An instance of the MassaStation class.
+     *
+     */
+    constructor();
+    /**
+     * A method to start listening for a connection to MassaStation's server.
+     *
+     * @returns void
+     */
+    startListening(): Promise<void>;
+}
+//# sourceMappingURL=MassaStationDiscovery.d.ts.map

package/dist/cmd/massaStation/MassaStationDiscovery.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MassaStationDiscovery.d.ts","sourceRoot":"","sources":["../../../src/massaStation/MassaStationDiscovery.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAGtC;;GAEG;AACH,eAAO,MAAM,2BAA2B,oCAAoC,CAAC;AAE7E;;GAEG;AACH,eAAO,MAAM,2BAA2B,gCAAgC,CAAC;AAEzE;;GAEG;AACH,eAAO,MAAM,6BAA6B,kCAAkC,CAAC;AAE7E;;;;;GAKG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IACrD,OAAO,CAAC,YAAY,CAAS;IAE7B;;;;;;;;;;;;;;;OAeG;;IAOH;;;;OAIG;IACU,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;CAkB7C"}