@meshtrade/api-node 1.30.0

package/dist/meshtrade/trading/market_order/v1/market_order_pb.d.ts

@@ -0,0 +1,20 @@
+import type { GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
+import type { Message } from "@bufbuild/protobuf";
+/**
+ * Describes the file meshtrade/trading/market_order/v1/market_order.proto.
+ */
+export declare const file_meshtrade_trading_market_order_v1_market_order: GenFile;
+/**
+ * @generated from message meshtrade.trading.market_order.v1.MarketOrder
+ */
+export type MarketOrder = Message<"meshtrade.trading.market_order.v1.MarketOrder"> & {
+    /**
+     * @generated from field: string number = 1;
+     */
+    number: string;
+};
+/**
+ * Describes the message meshtrade.trading.market_order.v1.MarketOrder.
+ * Use `create(MarketOrderSchema)` to create a new message.
+ */
+export declare const MarketOrderSchema: GenMessage<MarketOrder>;

package/dist/meshtrade/trading/market_order/v1/market_order_pb.js

@@ -0,0 +1,16 @@
+"use strict";
+// @generated by protoc-gen-es v2.10.1 with parameter "target=ts"
+// @generated from file meshtrade/trading/market_order/v1/market_order.proto (package meshtrade.trading.market_order.v1, syntax proto3)
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MarketOrderSchema = exports.file_meshtrade_trading_market_order_v1_market_order = void 0;
+const codegenv2_1 = require("@bufbuild/protobuf/codegenv2");
+/**
+ * Describes the file meshtrade/trading/market_order/v1/market_order.proto.
+ */
+exports.file_meshtrade_trading_market_order_v1_market_order = (0, codegenv2_1.fileDesc)("CjRtZXNodHJhZGUvdHJhZGluZy9tYXJrZXRfb3JkZXIvdjEvbWFya2V0X29yZGVyLnByb3RvEiFtZXNodHJhZGUudHJhZGluZy5tYXJrZXRfb3JkZXIudjEiHQoLTWFya2V0T3JkZXISDgoGbnVtYmVyGAEgASgJQm8KKGNvLm1lc2h0cmFkZS5hcGkudHJhZGluZy5tYXJrZXRfb3JkZXIudjFaQ2dpdGh1Yi5jb20vbWVzaHRyYWRlL2FwaS9nby90cmFkaW5nL21hcmtldF9vcmRlci92MTttYXJrZXRfb3JkZXJfdjFiBnByb3RvMw");
+/**
+ * Describes the message meshtrade.trading.market_order.v1.MarketOrder.
+ * Use `create(MarketOrderSchema)` to create a new message.
+ */
+exports.MarketOrderSchema = (0, codegenv2_1.messageDesc)(exports.file_meshtrade_trading_market_order_v1_market_order, 0);

package/dist/meshtrade/trading/market_order/v1/service_node_meshts.d.ts

@@ -0,0 +1,66 @@
+import { Interceptor } from "@connectrpc/connect";
+import { GetMarketOrderRequest } from "./service_pb";
+import { MarketOrder } from "./market_order_pb";
+import { ConfigOpts } from "../../../common/config";
+/**
+ * Node.js client for interacting with the meshtrade.trading.market_order.v1 market order v1 API resource service.
+ * Uses Connect-ES with gRPC transport for Node.js gRPC communication.
+ *
+ * Supports three authentication modes:
+ *
+ * 1. **No Authentication** (public APIs):
+ *    ```typescript
+ *    const client = new MarketOrderServiceNode({ apiServerURL: "http://localhost:10000" });
+ *    ```
+ *
+ * 2. **API Key Authentication** (backend services):
+ *    ```typescript
+ *    const client = new MarketOrderServiceNode({
+ *      apiServerURL: "https://api.example.com",
+ *      apiKey: "your-api-key",
+ *      group: "groups/01ARZ3NDEKTSV4YWVF8F5BH32"
+ *    });
+ *    ```
+ *
+ * 3. **JWT Token Authentication** (Next.js backend with user session):
+ *    ```typescript
+ *    const client = new MarketOrderServiceNode({
+ *      apiServerURL: "https://api.example.com",
+ *      jwtToken: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
+ *    });
+ *    ```
+ */
+export declare class MarketOrderServiceNode {
+    private _client;
+    private readonly _config;
+    private readonly _interceptors;
+    /**
+     * Constructs an instance of MarketOrderServiceNode.
+     * @param {ConfigOpts} [config] - Optional configuration for the client.
+     * @param {Interceptor[]} [interceptors] - For internal use by `withGroup`.
+     */
+    constructor(config?: ConfigOpts, interceptors?: Interceptor[]);
+    /**
+     * Returns a new client instance configured to send the specified group
+     * resource name in the request headers for subsequent API calls.
+     *
+     * **Important**: This method only works with API key authentication.
+     * - For **API key auth**: Creates a new client with updated group context
+     * - For **JWT auth**: Throws error (group comes from JWT token claims)
+     * - For **no auth**: Throws error (group requires authentication)
+     *
+     * @param {string} group - The operating group context to inject into the request
+     *                         in the format `groups/{ulid}` where {ulid} is a 26-character ULID.
+     *                         Example: 'groups/01ARZ3NDEKTSV4YWVF8F5BH32'
+     * @returns {MarketOrderServiceNode} A new, configured instance of the client.
+     * @throws {Error} If used with JWT authentication or no authentication
+     * @throws {Error} If the group format is invalid
+     */
+    withGroup(group: string): MarketOrderServiceNode;
+    /**
+     * Retrieves a market order.
+     * @param {GetMarketOrderRequest} request - The request object for getmarketorder.
+     * @returns {Promise<MarketOrder>} A promise that resolves with the market order.
+     */
+    getMarketOrder(request: GetMarketOrderRequest): Promise<MarketOrder>;
+}

package/dist/meshtrade/trading/market_order/v1/service_node_meshts.js

@@ -0,0 +1,121 @@
+"use strict";
+// @generated by protoc-gen-meshts v1
+// @generated from file meshtrade/trading/market_order/v1/service.proto (package meshtrade.trading.market_order.v1, syntax proto3)
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MarketOrderServiceNode = void 0;
+const connect_1 = require("@connectrpc/connect");
+const connect_node_1 = require("@connectrpc/connect-node");
+const service_pb_1 = require("./service_pb");
+const config_1 = require("../../../common/config");
+const validation_1 = require("../../../common/validation");
+const connectInterceptors_1 = require("../../../common/connectInterceptors");
+/**
+ * Node.js client for interacting with the meshtrade.trading.market_order.v1 market order v1 API resource service.
+ * Uses Connect-ES with gRPC transport for Node.js gRPC communication.
+ *
+ * Supports three authentication modes:
+ *
+ * 1. **No Authentication** (public APIs):
+ *    ```typescript
+ *    const client = new MarketOrderServiceNode({ apiServerURL: "http://localhost:10000" });
+ *    ```
+ *
+ * 2. **API Key Authentication** (backend services):
+ *    ```typescript
+ *    const client = new MarketOrderServiceNode({
+ *      apiServerURL: "https://api.example.com",
+ *      apiKey: "your-api-key",
+ *      group: "groups/01ARZ3NDEKTSV4YWVF8F5BH32"
+ *    });
+ *    ```
+ *
+ * 3. **JWT Token Authentication** (Next.js backend with user session):
+ *    ```typescript
+ *    const client = new MarketOrderServiceNode({
+ *      apiServerURL: "https://api.example.com",
+ *      jwtToken: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
+ *    });
+ *    ```
+ */
+class MarketOrderServiceNode {
+    /**
+     * Constructs an instance of MarketOrderServiceNode.
+     * @param {ConfigOpts} [config] - Optional configuration for the client.
+     * @param {Interceptor[]} [interceptors] - For internal use by `withGroup`.
+     */
+    constructor(config, interceptors) {
+        this._config = (0, config_1.getConfigFromOpts)(config);
+        // If interceptors are provided (from withGroup), use them
+        // Otherwise, create auth interceptors based on config
+        if (interceptors) {
+            this._interceptors = interceptors;
+        }
+        else {
+            this._interceptors = [];
+            // Add authentication interceptor based on configuration
+            if (this._config.apiKey && this._config.group) {
+                // API Key authentication mode
+                this._interceptors.push((0, connectInterceptors_1.createApiKeyInterceptor)(this._config.apiKey, this._config.group));
+            }
+            else if (this._config.jwtToken) {
+                // JWT authentication mode
+                this._interceptors.push((0, connectInterceptors_1.createJwtInterceptor)(this._config.jwtToken));
+            }
+            // If neither is configured, no authentication (public API mode)
+        }
+        // Create the gRPC transport for Node.js with interceptors
+        // Note: gRPC transport uses HTTP/2 by default
+        const transport = (0, connect_node_1.createGrpcTransport)({
+            baseUrl: this._config.apiServerURL,
+            interceptors: this._interceptors,
+        });
+        // Construct the Connect-ES client
+        this._client = (0, connect_1.createClient)(service_pb_1.MarketOrderService, transport);
+    }
+    /**
+     * Returns a new client instance configured to send the specified group
+     * resource name in the request headers for subsequent API calls.
+     *
+     * **Important**: This method only works with API key authentication.
+     * - For **API key auth**: Creates a new client with updated group context
+     * - For **JWT auth**: Throws error (group comes from JWT token claims)
+     * - For **no auth**: Throws error (group requires authentication)
+     *
+     * @param {string} group - The operating group context to inject into the request
+     *                         in the format `groups/{ulid}` where {ulid} is a 26-character ULID.
+     *                         Example: 'groups/01ARZ3NDEKTSV4YWVF8F5BH32'
+     * @returns {MarketOrderServiceNode} A new, configured instance of the client.
+     * @throws {Error} If used with JWT authentication or no authentication
+     * @throws {Error} If the group format is invalid
+     */
+    withGroup(group) {
+        // Check authentication mode
+        if (this._config.jwtToken) {
+            throw new Error("Cannot use withGroup() with JWT authentication. " +
+                "The group context is determined by the JWT token claims.");
+        }
+        if (!this._config.apiKey) {
+            throw new Error("Cannot use withGroup() without authentication. " +
+                "Please configure API key authentication to use group context.");
+        }
+        // For API key authentication, create new client with updated group
+        // Replace the existing API key interceptor with one that has the new group
+        const newInterceptors = [
+            (0, connectInterceptors_1.createApiKeyInterceptor)(this._config.apiKey, group)
+        ];
+        // Return a new client instance with updated group context
+        return new MarketOrderServiceNode(this._config, newInterceptors);
+    }
+    /**
+     * Retrieves a market order.
+     * @param {GetMarketOrderRequest} request - The request object for getmarketorder.
+     * @returns {Promise<MarketOrder>} A promise that resolves with the market order.
+     */
+    getMarketOrder(request) {
+        // Validate request
+        (0, validation_1.validateRequest)(request);
+        return this._client.getMarketOrder(request);
+    }
+}
+exports.MarketOrderServiceNode = MarketOrderServiceNode;

package/dist/meshtrade/trading/market_order/v1/service_pb.d.ts

@@ -0,0 +1,34 @@
+import type { GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
+import type { MarketOrderSchema } from "./market_order_pb";
+import type { Message } from "@bufbuild/protobuf";
+/**
+ * Describes the file meshtrade/trading/market_order/v1/service.proto.
+ */
+export declare const file_meshtrade_trading_market_order_v1_service: GenFile;
+/**
+ * @generated from message meshtrade.trading.market_order.v1.GetMarketOrderRequest
+ */
+export type GetMarketOrderRequest = Message<"meshtrade.trading.market_order.v1.GetMarketOrderRequest"> & {
+    /**
+     * @generated from field: string number = 1;
+     */
+    number: string;
+};
+/**
+ * Describes the message meshtrade.trading.market_order.v1.GetMarketOrderRequest.
+ * Use `create(GetMarketOrderRequestSchema)` to create a new message.
+ */
+export declare const GetMarketOrderRequestSchema: GenMessage<GetMarketOrderRequest>;
+/**
+ * @generated from service meshtrade.trading.market_order.v1.MarketOrderService
+ */
+export declare const MarketOrderService: GenService<{
+    /**
+     * @generated from rpc meshtrade.trading.market_order.v1.MarketOrderService.GetMarketOrder
+     */
+    getMarketOrder: {
+        methodKind: "unary";
+        input: typeof GetMarketOrderRequestSchema;
+        output: typeof MarketOrderSchema;
+    };
+}>;

package/dist/meshtrade/trading/market_order/v1/service_pb.js

@@ -0,0 +1,22 @@
+"use strict";
+// @generated by protoc-gen-es v2.10.1 with parameter "target=ts"
+// @generated from file meshtrade/trading/market_order/v1/service.proto (package meshtrade.trading.market_order.v1, syntax proto3)
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MarketOrderService = exports.GetMarketOrderRequestSchema = exports.file_meshtrade_trading_market_order_v1_service = void 0;
+const codegenv2_1 = require("@bufbuild/protobuf/codegenv2");
+const method_options_pb_1 = require("../../../option/method_options/v1/method_options_pb");
+const market_order_pb_1 = require("./market_order_pb");
+/**
+ * Describes the file meshtrade/trading/market_order/v1/service.proto.
+ */
+exports.file_meshtrade_trading_market_order_v1_service = (0, codegenv2_1.fileDesc)("Ci9tZXNodHJhZGUvdHJhZGluZy9tYXJrZXRfb3JkZXIvdjEvc2VydmljZS5wcm90bxIhbWVzaHRyYWRlLnRyYWRpbmcubWFya2V0X29yZGVyLnYxIicKFUdldE1hcmtldE9yZGVyUmVxdWVzdBIOCgZudW1iZXIYASABKAkypQEKEk1hcmtldE9yZGVyU2VydmljZRKOAQoOR2V0TWFya2V0T3JkZXISOC5tZXNodHJhZGUudHJhZGluZy5tYXJrZXRfb3JkZXIudjEuR2V0TWFya2V0T3JkZXJSZXF1ZXN0Gi4ubWVzaHRyYWRlLnRyYWRpbmcubWFya2V0X29yZGVyLnYxLk1hcmtldE9yZGVyIhKytRgOCAEQAhoIwJaxAsGWsQJCbwooY28ubWVzaHRyYWRlLmFwaS50cmFkaW5nLm1hcmtldF9vcmRlci52MVpDZ2l0aHViLmNvbS9tZXNodHJhZGUvYXBpL2dvL3RyYWRpbmcvbWFya2V0X29yZGVyL3YxO21hcmtldF9vcmRlcl92MWIGcHJvdG8z", [method_options_pb_1.file_meshtrade_option_method_options_v1_method_options, market_order_pb_1.file_meshtrade_trading_market_order_v1_market_order]);
+/**
+ * Describes the message meshtrade.trading.market_order.v1.GetMarketOrderRequest.
+ * Use `create(GetMarketOrderRequestSchema)` to create a new message.
+ */
+exports.GetMarketOrderRequestSchema = (0, codegenv2_1.messageDesc)(exports.file_meshtrade_trading_market_order_v1_service, 0);
+/**
+ * @generated from service meshtrade.trading.market_order.v1.MarketOrderService
+ */
+exports.MarketOrderService = (0, codegenv2_1.serviceDesc)(exports.file_meshtrade_trading_market_order_v1_service, 0);

package/dist/meshtrade/type/v1/address_pb.d.ts

@@ -0,0 +1,82 @@
+import type { GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
+import type { Message } from "@bufbuild/protobuf";
+/**
+ * Describes the file meshtrade/type/v1/address.proto.
+ */
+export declare const file_meshtrade_type_v1_address: GenFile;
+/**
+ *
+ * Address is a physical postal address. It is designed to be flexible enough
+ * to accommodate various international address formats.
+ * Validation rules given are a guideline.
+ * A conclusive set of validation rules for an address can be found with the service/type using
+ * this entity.
+ *
+ * @generated from message meshtrade.type.v1.Address
+ */
+export type Address = Message<"meshtrade.type.v1.Address"> & {
+    /**
+     *
+     * The unstructured lines of the address. This typically includes the street name,
+     * house number, apartment or suite number, and building name.
+     * It is recommended to have the most specific details (e.g., apartment number)
+     * in the first lines and the more general ones (e.g., street address) in the
+     * subsequent lines.
+     * Example: address_lines: 456 Oak Avenue, Apartment 3B, 123 Main Street.
+     * Required
+     *
+     * @generated from field: repeated string address_lines = 1;
+     */
+    addressLines: string[];
+    /**
+     *
+     * An optional field for a neighborhood, district, or suburb within a city.
+     * The usage of this field can vary by country.
+     * Optional
+     *
+     * @generated from field: string suburb = 2;
+     */
+    suburb: string;
+    /**
+     *
+     * The city, town, or village of the address.
+     * Required
+     *
+     * @generated from field: string city = 3;
+     */
+    city: string;
+    /**
+     *
+     * The top-level administrative subdivision of a country, such as a state,
+     * province, region, or prefecture.
+     * Required
+     *
+     * @generated from field: string province = 4;
+     */
+    province: string;
+    /**
+     *
+     * The ISO 3166-1 alpha-2 country code.
+     * This is the two-letter country code (e.g. "ZA" for South Africa,
+     * "NL" for the Netherlands). The value should be in uppercase.
+     * See https://www.iso.org/iso-3166-country-codes.html for a full list.
+     * Required
+     *
+     * @generated from field: string country_code = 5;
+     */
+    countryCode: string;
+    /**
+     *
+     * The postal code or ZIP code of the address.
+     * Although optional, strongly recommended where applicable.
+     * Optional
+     *
+     * @generated from field: string postal_code = 6;
+     */
+    postalCode: string;
+};
+/**
+ * Describes the message meshtrade.type.v1.Address.
+ * Use `create(AddressSchema)` to create a new message.
+ */
+export declare const AddressSchema: GenMessage<Address>;

package/dist/meshtrade/type/v1/address_pb.js

@@ -0,0 +1,16 @@
+"use strict";
+// @generated by protoc-gen-es v2.10.1 with parameter "target=ts"
+// @generated from file meshtrade/type/v1/address.proto (package meshtrade.type.v1, syntax proto3)
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AddressSchema = exports.file_meshtrade_type_v1_address = void 0;
+const codegenv2_1 = require("@bufbuild/protobuf/codegenv2");
+/**
+ * Describes the file meshtrade/type/v1/address.proto.
+ */
+exports.file_meshtrade_type_v1_address = (0, codegenv2_1.fileDesc)("Ch9tZXNodHJhZGUvdHlwZS92MS9hZGRyZXNzLnByb3RvEhFtZXNodHJhZGUudHlwZS52MSJ7CgdBZGRyZXNzEhUKDWFkZHJlc3NfbGluZXMYASADKAkSDgoGc3VidXJiGAIgASgJEgwKBGNpdHkYAyABKAkSEAoIcHJvdmluY2UYBCABKAkSFAoMY291bnRyeV9jb2RlGAUgASgJEhMKC3Bvc3RhbF9jb2RlGAYgASgJQkcKGGNvLm1lc2h0cmFkZS5hcGkudHlwZS52MVorZ2l0aHViLmNvbS9tZXNodHJhZGUvYXBpL2dvL3R5cGUvdjE7dHlwZV92MWIGcHJvdG8z");
+/**
+ * Describes the message meshtrade.type.v1.Address.
+ * Use `create(AddressSchema)` to create a new message.
+ */
+exports.AddressSchema = (0, codegenv2_1.messageDesc)(exports.file_meshtrade_type_v1_address, 0);

package/dist/meshtrade/type/v1/amount.d.ts

@@ -0,0 +1,13 @@
+import { Amount } from "./amount_pb";
+import { Token } from "./token_pb";
+import BigNumber from "bignumber.js";
+import { Decimal } from "./decimal_pb";
+/**
+ * Creates a new Amount of the given Token.
+ *
+ * @param {BigNumber | Decimal | string | undefined} amount - The amount in BigNumber, num.Decimal or string format.
+ * @param {Token} token - The token type that the amount is denominated in.
+ * @returns {Amount} Returns an Amount object that contains the value in Decimal format and the type of token.
+ */
+export declare function newAmountOfToken(amount: BigNumber | Decimal | string | undefined, token?: Token): Amount;
+export declare function amountIsUndefined(amount?: Amount): boolean;

package/dist/meshtrade/type/v1/amount.js

@@ -0,0 +1,68 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.newAmountOfToken = newAmountOfToken;
+exports.amountIsUndefined = amountIsUndefined;
+const protobuf_1 = require("@bufbuild/protobuf");
+const amount_pb_1 = require("./amount_pb");
+const decimalConversions_1 = require("./decimalConversions");
+const ledger_1 = require("./ledger");
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const ledger_pb_1 = require("./ledger_pb");
+const token_1 = require("./token");
+/**
+ * Creates a new Amount object using a BigNumber and a Token.
+ *
+ * @param {BigNumber} amount - The amount in BigNumber format to be converted to Decimal.
+ * @param {Token} token - The token type that the amount is denominated in.
+ * @returns {Amount} Returns an Amount object that contains the value in Decimal format and the type of token.
+ *
+ * @remarks
+ * This function leverages the bigNumberToDecimal function to convert the BigNumber amount into a Decimal object.
+ * The resulting Decimal object and the provided Token are then used to construct and return a new Amount object.
+ * NOTE: this performs the necessary truncation so that the resultant amount contains a valid number of
+ * decimal places for the target ledger.
+ */
+function newAmountFromBigNumber(amount, token) {
+    return (0, protobuf_1.create)(amount_pb_1.AmountSchema, {
+        value: (0, decimalConversions_1.bigNumberToDecimal)(amount.decimalPlaces((0, ledger_1.getLedgerNoDecimalPlaces)(token?.ledger ?? ledger_pb_1.Ledger.UNSPECIFIED), bignumber_js_1.default.ROUND_HALF_DOWN)),
+        token: token,
+    });
+}
+/**
+ * Creates a new Amount of the given Token.
+ *
+ * @param {BigNumber | Decimal | string | undefined} amount - The amount in BigNumber, num.Decimal or string format.
+ * @param {Token} token - The token type that the amount is denominated in.
+ * @returns {Amount} Returns an Amount object that contains the value in Decimal format and the type of token.
+ */
+function newAmountOfToken(amount, token) {
+    let value = new bignumber_js_1.default("0");
+    if (!amount) {
+        value = new bignumber_js_1.default("0");
+    }
+    else if (amount instanceof bignumber_js_1.default) {
+        value = amount;
+    }
+    else if (typeof amount === "object" && "value" in amount) {
+        // Check if it's a Decimal-like object
+        value = (0, decimalConversions_1.decimalToBigNumber)(amount);
+    }
+    else {
+        if (isNaN(Number(amount))) {
+            value = new bignumber_js_1.default("0");
+        }
+        else {
+            value = new bignumber_js_1.default(amount);
+        }
+    }
+    return newAmountFromBigNumber(value, token);
+}
+function amountIsUndefined(amount) {
+    if (!amount) {
+        return true;
+    }
+    return (0, token_1.tokenIsUndefined)(amount.token);
+}

package/dist/meshtrade/type/v1/amountWrapper.d.ts

@@ -0,0 +1,74 @@
+import { Amount } from "./amount_pb";
+import { Token } from "./token_pb";
+import { Decimal } from "./decimal_pb";
+/**
+ * Wrapper class around a Amount.
+ *
+ * The AmountWrapper class provides convenience methods to manipulate and retrieve the
+ * Amount instance it wraps, along with its associated Token and value.
+ */
+export declare class AmountWrapper {
+    private _amount;
+    /**
+     * Constructs an instance of the AmountWrapper class.
+     *
+     * This constructor initializes the AmountWrapper with a given Amount.
+     * If the amount is not provided or is undefined, a TypeError will be thrown.
+     * The amount argument is set to option (i.e. could be undefined) as objects
+     * returned by protobuf types are typically optionally undefined.
+     *
+     * @param {Amount} [amount] - The Amount to be wrapped. Must be defined.
+     *
+     * @throws {TypeError} If the amount is undefined.
+     */
+    constructor(amount?: Amount);
+    /**
+     * Retrieves the wrapped Amount.
+     *
+     * This getter provides access to the Amount instance that is wrapped by this class.
+     *
+     * @returns {Amount} The wrapped Amount.
+     */
+    get amount(): Amount;
+    /**
+     * Retrieves the token associated with the wrapped Amount.
+     *
+     * This getter returns the Token instance associated with the wrapped Amount.
+     * If the token is undefined, a TypeError will be thrown.
+     *
+     * @returns {Token} The token associated with the wrapped Amount.
+     * @throws {TypeError} If the token is undefined in the wrapped amount.
+     */
+    get token(): Token;
+    /**
+     * Retrieves the value associated with the wrapped Amount.
+     *
+     * This getter returns the Decimal value associated with the wrapped Amount.
+     * If the value is undefined, a TypeError will be thrown.
+     *
+     * @returns {Decimal} The value associated with the wrapped Amount.
+     * @throws {TypeError} If the value is undefined in the wrapped amount.
+     */
+    get value(): Decimal;
+    /**
+     * Sets a new value for the wrapped Amount.
+     *
+     * This method creates a new AmountWrapper instance with the provided value,
+     * which can be either a BigNumber or a Decimal. The new value is converted
+     * into a Amount using the associated token.
+     *
+     * @param {BigNumber | Decimal} value - The value to set for the wrapped Amount.
+     * @returns {AmountWrapper} A new AmountWrapper instance with the updated value.
+     */
+    setValue(value: BigNumber | Decimal): AmountWrapper;
+    /**
+     * Sets a new token for the wrapped Amount.
+     *
+     * This method creates a new AmountWrapper instance with the provided token.
+     * The current value of the wrapped Amount is associated with the new token.
+     *
+     * @param {Token} token - The new token to set for the wrapped Amount.
+     * @returns {AmountWrapper} A new AmountWrapper instance with the updated token.
+     */
+    setToken(token: Token): AmountWrapper;
+}

package/dist/meshtrade/type/v1/amountWrapper.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AmountWrapper = void 0;
+const tokenWrapper_1 = require("./tokenWrapper");
+/**
+ * Wrapper class around a Amount.
+ *
+ * The AmountWrapper class provides convenience methods to manipulate and retrieve the
+ * Amount instance it wraps, along with its associated Token and value.
+ */
+class AmountWrapper {
+    /**
+     * Constructs an instance of the AmountWrapper class.
+     *
+     * This constructor initializes the AmountWrapper with a given Amount.
+     * If the amount is not provided or is undefined, a TypeError will be thrown.
+     * The amount argument is set to option (i.e. could be undefined) as objects
+     * returned by protobuf types are typically optionally undefined.
+     *
+     * @param {Amount} [amount] - The Amount to be wrapped. Must be defined.
+     *
+     * @throws {TypeError} If the amount is undefined.
+     */
+    constructor(amount) {
+        if (!amount) {
+            throw new TypeError("constructing amount wrapper with an undefined amount");
+        }
+        this._amount = amount;
+    }
+    /**
+     * Retrieves the wrapped Amount.
+     *
+     * This getter provides access to the Amount instance that is wrapped by this class.
+     *
+     * @returns {Amount} The wrapped Amount.
+     */
+    get amount() {
+        return this._amount;
+    }
+    /**
+     * Retrieves the token associated with the wrapped Amount.
+     *
+     * This getter returns the Token instance associated with the wrapped Amount.
+     * If the token is undefined, a TypeError will be thrown.
+     *
+     * @returns {Token} The token associated with the wrapped Amount.
+     * @throws {TypeError} If the token is undefined in the wrapped amount.
+     */
+    get token() {
+        const token = this._amount.token;
+        if (!token) {
+            throw new TypeError("token is undefined in wrapped amount");
+        }
+        return token;
+    }
+    /**
+     * Retrieves the value associated with the wrapped Amount.
+     *
+     * This getter returns the Decimal value associated with the wrapped Amount.
+     * If the value is undefined, a TypeError will be thrown.
+     *
+     * @returns {Decimal} The value associated with the wrapped Amount.
+     * @throws {TypeError} If the value is undefined in the wrapped amount.
+     */
+    get value() {
+        const value = this._amount.value;
+        if (!value) {
+            throw new TypeError("value is undefined in wrapped amount");
+        }
+        return value;
+    }
+    /**
+     * Sets a new value for the wrapped Amount.
+     *
+     * This method creates a new AmountWrapper instance with the provided value,
+     * which can be either a BigNumber or a Decimal. The new value is converted
+     * into a Amount using the associated token.
+     *
+     * @param {BigNumber | Decimal} value - The value to set for the wrapped Amount.
+     * @returns {AmountWrapper} A new AmountWrapper instance with the updated value.
+     */
+    setValue(value) {
+        return new AmountWrapper(new tokenWrapper_1.TokenWrapper(this.token).newAmountOf(value));
+    }
+    /**
+     * Sets a new token for the wrapped Amount.
+     *
+     * This method creates a new AmountWrapper instance with the provided token.
+     * The current value of the wrapped Amount is associated with the new token.
+     *
+     * @param {Token} token - The new token to set for the wrapped Amount.
+     * @returns {AmountWrapper} A new AmountWrapper instance with the updated token.
+     */
+    setToken(token) {
+        return new AmountWrapper(new tokenWrapper_1.TokenWrapper(token).newAmountOf(this.value));
+    }
+}
+exports.AmountWrapper = AmountWrapper;