@dydxprotocol/v4-client-js 2.3.0 → 2.4.0

package/build/cjs/src/clients/modules/tendermintClient.js

@@ -0,0 +1,137 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TendermintClient = void 0;
+const encoding_1 = require("@cosmjs/encoding");
+const math_1 = require("@cosmjs/math");
+const stargate_1 = require("@cosmjs/stargate");
+const tendermint_rpc_1 = require("@cosmjs/tendermint-rpc");
+const utils_1 = require("@cosmjs/utils");
+const errors_1 = require("../lib/errors");
+class TendermintClient {
+    constructor(baseClient, broadcastOptions) {
+        this.baseClient = baseClient;
+        this.broadcastOptions = broadcastOptions;
+    }
+    /**
+     * @description Get a specific block if height is specified. Otherwise, get the most recent block.
+     *
+     * @returns Information about the block queried.
+     */
+    async getBlock(height) {
+        const response = await this.baseClient.block(height);
+        return {
+            id: (0, encoding_1.toHex)(response.blockId.hash).toUpperCase(),
+            header: {
+                version: {
+                    block: new math_1.Uint53(response.block.header.version.block).toString(),
+                    app: new math_1.Uint53(response.block.header.version.app).toString(),
+                },
+                height: response.block.header.height,
+                chainId: response.block.header.chainId,
+                time: (0, tendermint_rpc_1.toRfc3339WithNanoseconds)(response.block.header.time),
+            },
+            txs: response.block.txs,
+        };
+    }
+    /**
+     * @description Broadcast a signed transaction with a specific mode.
+     * @throws BroadcastErrorObject when result code is not zero. TypeError when mode is invalid.
+     * @returns Differs depending on the BroadcastMode used.
+     * See https://docs.cosmos.network/master/run-node/txs.html for more information.
+     */
+    async broadcastTransaction(tx, mode) {
+        switch (mode) {
+            case tendermint_rpc_1.Method.BroadcastTxAsync:
+                return this.broadcastTransactionAsync(tx);
+            case tendermint_rpc_1.Method.BroadcastTxSync:
+                return this.broadcastTransactionSync(tx);
+            case tendermint_rpc_1.Method.BroadcastTxCommit:
+                return this.broadcastTransactionCommit(tx);
+            default:
+                throw new TypeError('broadcastTransaction: invalid BroadcastMode');
+        }
+    }
+    /**
+     * @description Broadcast a signed transaction.
+     * @returns The transaction hash.
+     */
+    broadcastTransactionAsync(tx) {
+        return this.baseClient.broadcastTxAsync({ tx });
+    }
+    /**
+     * @description Broadcast a signed transaction and await the response.
+     * @throws BroadcastErrorObject when result code is not zero.
+     * @returns The response from the node once the transaction is processed by `CheckTx`.
+     */
+    async broadcastTransactionSync(tx) {
+        const result = await this.baseClient.broadcastTxSync({ tx });
+        if (result.code !== 0) {
+            throw new errors_1.BroadcastErrorObject(`Broadcasting transaction failed: ${result.log}`, result);
+        }
+        return result;
+    }
+    /**
+     * @description Broadcast a signed transaction and await for it to be included in the blockchain.
+     * @throws BroadcastErrorObject when result code is not zero.
+     * @returns The result of the transaction once included in the blockchain.
+     */
+    async broadcastTransactionCommit(tx) {
+        const result = await this.broadcastTransactionSync(tx);
+        return this.queryHash(result.hash);
+    }
+    /**
+     * @description Using tx method, query for a transaction on-chain with retries specified by
+     * the client BroadcastOptions.
+     *
+     * @throws TimeoutError if the transaction is not committed on-chain within the timeout limit.
+     * @returns An indexed transaction containing information about the transaction when committed.
+     */
+    async queryHash(hash, time = 0) {
+        const now = Date.now();
+        const transactionId = (0, encoding_1.toHex)(hash).toUpperCase();
+        if (time >= this.broadcastOptions.broadcastTimeoutMs) {
+            throw new stargate_1.TimeoutError(`Transaction with hash [${hash}] was submitted but was not yet found on the chain. You might want to check later. Query timed out after ${this.broadcastOptions.broadcastTimeoutMs / 1000} seconds.`, transactionId);
+        }
+        await (0, utils_1.sleep)(this.broadcastOptions.broadcastPollIntervalMs);
+        // If the transaction is not found, the tx method will throw an Internal Error.
+        try {
+            const tx = await this.baseClient.tx({ hash });
+            return {
+                height: tx.height,
+                hash: (0, encoding_1.toHex)(tx.hash).toUpperCase(),
+                code: tx.result.code,
+                rawLog: tx.result.log !== undefined ? tx.result.log : '',
+                tx: tx.tx,
+                txIndex: tx.index,
+                gasUsed: tx.result.gasUsed,
+                gasWanted: tx.result.gasWanted,
+                // Convert stargate events to tendermint events.
+                events: tx.result.events.map((event) => {
+                    return {
+                        ...event,
+                        attributes: event.attributes.map((attr) => {
+                            return {
+                                ...attr,
+                                key: Buffer.from(attr.key).toString(),
+                                value: Buffer.from(attr.value).toString(),
+                            };
+                        }),
+                    };
+                }),
+                // @ts-ignore
+                msgResponses: [],
+            };
+        }
+        catch (error) {
+            return this.queryHash(hash, time + Date.now() - now);
+        }
+    }
+    /**
+     * @description Set the broadcast options for this module.
+     */
+    setBroadcastOptions(broadcastOptions) {
+        this.broadcastOptions = broadcastOptions;
+    }
+}
+exports.TendermintClient = TendermintClient;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVuZGVybWludENsaWVudC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uL3NyYy9jbGllbnRzL21vZHVsZXMvdGVuZGVybWludENsaWVudC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSwrQ0FBeUM7QUFDekMsdUNBQXNDO0FBQ3RDLCtDQUFrRTtBQUNsRSwyREFBOEY7QUFTOUYseUNBQXNDO0FBRXRDLDBDQUFxRDtBQUdyRCxNQUFhLGdCQUFnQjtJQUkzQixZQUFZLFVBQThCLEVBQUUsZ0JBQWtDO1FBQzVFLElBQUksQ0FBQyxVQUFVLEdBQUcsVUFBVSxDQUFDO1FBQzdCLElBQUksQ0FBQyxnQkFBZ0IsR0FBRyxnQkFBZ0IsQ0FBQztJQUMzQyxDQUFDO0lBRUQ7Ozs7T0FJRztJQUNILEtBQUssQ0FBQyxRQUFRLENBQUMsTUFBZTtRQUM1QixNQUFNLFFBQVEsR0FBa0IsTUFBTSxJQUFJLENBQUMsVUFBVSxDQUFDLEtBQUssQ0FBQyxNQUFNLENBQUMsQ0FBQztRQUNwRSxPQUFPO1lBQ0wsRUFBRSxFQUFFLElBQUEsZ0JBQUssRUFBQyxRQUFRLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDLFdBQVcsRUFBRTtZQUM5QyxNQUFNLEVBQUU7Z0JBQ04sT0FBTyxFQUFFO29CQUNQLEtBQUssRUFBRSxJQUFJLGFBQU0sQ0FBQyxRQUFRLENBQUMsS0FBSyxDQUFDLE1BQU0sQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFDLENBQUMsUUFBUSxFQUFFO29CQUNqRSxHQUFHLEVBQUUsSUFBSSxhQUFNLENBQUMsUUFBUSxDQUFDLEtBQUssQ0FBQyxNQUFNLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxDQUFDLFFBQVEsRUFBRTtpQkFDOUQ7Z0JBQ0QsTUFBTSxFQUFFLFFBQVEsQ0FBQyxLQUFLLENBQUMsTUFBTSxDQUFDLE1BQU07Z0JBQ3BDLE9BQU8sRUFBRSxRQUFRLENBQUMsS0FBSyxDQUFDLE1BQU0sQ0FBQyxPQUFPO2dCQUN0QyxJQUFJLEVBQUUsSUFBQSx5Q0FBd0IsRUFBQyxRQUFRLENBQUMsS0FBSyxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUM7YUFDM0Q7WUFDRCxHQUFHLEVBQUUsUUFBUSxDQUFDLEtBQUssQ0FBQyxHQUFHO1NBQ3hCLENBQUM7SUFDSixDQUFDO0lBRUQ7Ozs7O09BS0c7SUFDSCxLQUFLLENBQUMsb0JBQW9CLENBQ3hCLEVBQWMsRUFDZCxJQUFtQjtRQUVuQixRQUFRLElBQUksRUFBRSxDQUFDO1lBQ2IsS0FBSyx1QkFBTSxDQUFDLGdCQUFnQjtnQkFDMUIsT0FBTyxJQUFJLENBQUMseUJBQXlCLENBQUMsRUFBRSxDQUFDLENBQUM7WUFDNUMsS0FBSyx1QkFBTSxDQUFDLGVBQWU7Z0JBQ3pCLE9BQU8sSUFBSSxDQUFDLHdCQUF3QixDQUFDLEVBQUUsQ0FBQyxDQUFDO1lBQzNDLEtBQUssdUJBQU0sQ0FBQyxpQkFBaUI7Z0JBQzNCLE9BQU8sSUFBSSxDQUFDLDBCQUEwQixDQUFDLEVBQUUsQ0FBQyxDQUFDO1lBQzdDO2dCQUNFLE1BQU0sSUFBSSxTQUFTLENBQUMsNkNBQTZDLENBQUMsQ0FBQztRQUN2RSxDQUFDO0lBQ0gsQ0FBQztJQUVEOzs7T0FHRztJQUNILHlCQUF5QixDQUFDLEVBQWM7UUFDdEMsT0FBTyxJQUFJLENBQUMsVUFBVSxDQUFDLGdCQUFnQixDQUFDLEVBQUUsRUFBRSxFQUFFLENBQUMsQ0FBQztJQUNsRCxDQUFDO0lBRUQ7Ozs7T0FJRztJQUNILEtBQUssQ0FBQyx3QkFBd0IsQ0FBQyxFQUFjO1FBQzNDLE1BQU0sTUFBTSxHQUE0QixNQUFNLElBQUksQ0FBQyxVQUFVLENBQUMsZUFBZSxDQUFDLEVBQUUsRUFBRSxFQUFFLENBQUMsQ0FBQztRQUN0RixJQUFJLE1BQU0sQ0FBQyxJQUFJLEtBQUssQ0FBQyxFQUFFLENBQUM7WUFDdEIsTUFBTSxJQUFJLDZCQUFvQixDQUFDLG9DQUFvQyxNQUFNLENBQUMsR0FBRyxFQUFFLEVBQUUsTUFBTSxDQUFDLENBQUM7UUFDM0YsQ0FBQztRQUNELE9BQU8sTUFBTSxDQUFDO0lBQ2hCLENBQUM7SUFFRDs7OztPQUlHO0lBQ0gsS0FBSyxDQUFDLDBCQUEwQixDQUFDLEVBQWM7UUFDN0MsTUFBTSxNQUFNLEdBQTRCLE1BQU0sSUFBSSxDQUFDLHdCQUF3QixDQUFDLEVBQUUsQ0FBQyxDQUFDO1FBQ2hGLE9BQU8sSUFBSSxDQUFDLFNBQVMsQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDckMsQ0FBQztJQUVEOzs7Ozs7T0FNRztJQUNILEtBQUssQ0FBQyxTQUFTLENBQUMsSUFBZ0IsRUFBRSxPQUFlLENBQUM7UUFDaEQsTUFBTSxHQUFHLEdBQVcsSUFBSSxDQUFDLEdBQUcsRUFBRSxDQUFDO1FBQy9CLE1BQU0sYUFBYSxHQUFXLElBQUEsZ0JBQUssRUFBQyxJQUFJLENBQUMsQ0FBQyxXQUFXLEVBQUUsQ0FBQztRQUV4RCxJQUFJLElBQUksSUFBSSxJQUFJLENBQUMsZ0JBQWdCLENBQUMsa0JBQWtCLEVBQUUsQ0FBQztZQUNyRCxNQUFNLElBQUksdUJBQVksQ0FDcEIsMEJBQTBCLElBQUksNEdBQzVCLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxrQkFBa0IsR0FBRyxJQUM3QyxXQUFXLEVBQ1gsYUFBYSxDQUNkLENBQUM7UUFDSixDQUFDO1FBRUQsTUFBTSxJQUFBLGFBQUssRUFBQyxJQUFJLENBQUMsZ0JBQWdCLENBQUMsdUJBQXVCLENBQUMsQ0FBQztRQUUzRCwrRUFBK0U7UUFDL0UsSUFBSSxDQUFDO1lBQ0gsTUFBTSxFQUFFLEdBQWUsTUFBTSxJQUFJLENBQUMsVUFBVSxDQUFDLEVBQUUsQ0FBQyxFQUFFLElBQUksRUFBRSxDQUFDLENBQUM7WUFFMUQsT0FBTztnQkFDTCxNQUFNLEVBQUUsRUFBRSxDQUFDLE1BQU07Z0JBQ2pCLElBQUksRUFBRSxJQUFBLGdCQUFLLEVBQUMsRUFBRSxDQUFDLElBQUksQ0FBQyxDQUFDLFdBQVcsRUFBRTtnQkFDbEMsSUFBSSxFQUFFLEVBQUUsQ0FBQyxNQUFNLENBQUMsSUFBSTtnQkFDcEIsTUFBTSxFQUFFLEVBQUUsQ0FBQyxNQUFNLENBQUMsR0FBRyxLQUFLLFNBQVMsQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLEVBQUU7Z0JBQ3hELEVBQUUsRUFBRSxFQUFFLENBQUMsRUFBRTtnQkFDVCxPQUFPLEVBQUUsRUFBRSxDQUFDLEtBQUs7Z0JBQ2pCLE9BQU8sRUFBRSxFQUFFLENBQUMsTUFBTSxDQUFDLE9BQU87Z0JBQzFCLFNBQVMsRUFBRSxFQUFFLENBQUMsTUFBTSxDQUFDLFNBQVM7Z0JBQzlCLGdEQUFnRDtnQkFDaEQsTUFBTSxFQUFFLEVBQUUsQ0FBQyxNQUFNLENBQUMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxDQUFDLEtBQVksRUFBRSxFQUFFO29CQUM1QyxPQUFPO3dCQUNMLEdBQUcsS0FBSzt3QkFDUixVQUFVLEVBQUUsS0FBSyxDQUFDLFVBQVUsQ0FBQyxHQUFHLENBQUMsQ0FBQyxJQUFlLEVBQUUsRUFBRTs0QkFDbkQsT0FBTztnQ0FDTCxHQUFHLElBQUk7Z0NBQ1AsR0FBRyxFQUFFLE1BQU0sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxDQUFDLFFBQVEsRUFBRTtnQ0FDckMsS0FBSyxFQUFFLE1BQU0sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxDQUFDLFFBQVEsRUFBRTs2QkFDMUMsQ0FBQzt3QkFDSixDQUFDLENBQUM7cUJBQ0gsQ0FBQztnQkFDSixDQUFDLENBQUM7Z0JBQ0YsYUFBYTtnQkFDYixZQUFZLEVBQUUsRUFBRTthQUNqQixDQUFDO1FBQ0osQ0FBQztRQUFDLE9BQU8sS0FBSyxFQUFFLENBQUM7WUFDZixPQUFPLElBQUksQ0FBQyxTQUFTLENBQUMsSUFBSSxFQUFFLElBQUksR0FBRyxJQUFJLENBQUMsR0FBRyxFQUFFLEdBQUcsR0FBRyxDQUFDLENBQUM7UUFDdkQsQ0FBQztJQUNILENBQUM7SUFFRDs7T0FFRztJQUNILG1CQUFtQixDQUFDLGdCQUFrQztRQUNwRCxJQUFJLENBQUMsZ0JBQWdCLEdBQUcsZ0JBQWdCLENBQUM7SUFDM0MsQ0FBQztDQUNGO0FBbEpELDRDQWtKQyJ9

package/build/cjs/src/clients/modules/utility.js

@@ -0,0 +1,44 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const rest_1 = __importDefault(require("./rest"));
+class UtilityClient extends rest_1.default {
+    /**
+     * @description Get the current time of the Indexer
+     * @returns {TimeResponse} isoString and epoch
+     */
+    async getTime() {
+        const uri = '/v4/time';
+        return this.get(uri);
+    }
+    /**
+     * @description Get the block height of the most recent block processed by the Indexer
+     * @returns {HeightResponse} block height and time
+     */
+    async getHeight() {
+        const uri = '/v4/height';
+        return this.get(uri);
+    }
+    /**
+     * @description Screen an address to see if it is restricted
+     * @param {string} address evm or dydx address
+     * @returns {ComplianceResponse} whether the specified address is restricted
+     */
+    async screen(address) {
+        const uri = '/v4/screen';
+        return this.get(uri, { address });
+    }
+    /**
+     * @description Screen an address to see if it is restricted
+     * @param {string} address evm or dydx address
+     * @returns {ComplianceResponse} whether the specified address is restricted
+     */
+    async complianceScreen(address) {
+        const uri = `/v4/compliance/screen/${address}`;
+        return this.get(uri);
+    }
+}
+exports.default = UtilityClient;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbGl0eS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uL3NyYy9jbGllbnRzL21vZHVsZXMvdXRpbGl0eS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQU1BLGtEQUFnQztBQUVoQyxNQUFxQixhQUFjLFNBQVEsY0FBVTtJQUNuRDs7O09BR0c7SUFDSCxLQUFLLENBQUMsT0FBTztRQUNYLE1BQU0sR0FBRyxHQUFHLFVBQVUsQ0FBQztRQUN2QixPQUFPLElBQUksQ0FBQyxHQUFHLENBQUMsR0FBRyxDQUFDLENBQUM7SUFDdkIsQ0FBQztJQUVEOzs7T0FHRztJQUNILEtBQUssQ0FBQyxTQUFTO1FBQ2IsTUFBTSxHQUFHLEdBQUcsWUFBWSxDQUFDO1FBQ3pCLE9BQU8sSUFBSSxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsQ0FBQztJQUN2QixDQUFDO0lBRUQ7Ozs7T0FJRztJQUNILEtBQUssQ0FBQyxNQUFNLENBQUMsT0FBZTtRQUMxQixNQUFNLEdBQUcsR0FBRyxZQUFZLENBQUM7UUFDekIsT0FBTyxJQUFJLENBQUMsR0FBRyxDQUFDLEdBQUcsRUFBRSxFQUFFLE9BQU8sRUFBRSxDQUFDLENBQUM7SUFDcEMsQ0FBQztJQUVEOzs7O09BSUc7SUFDSCxLQUFLLENBQUMsZ0JBQWdCLENBQUMsT0FBZTtRQUNwQyxNQUFNLEdBQUcsR0FBRyx5QkFBeUIsT0FBTyxFQUFFLENBQUM7UUFDL0MsT0FBTyxJQUFJLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQyxDQUFDO0lBQ3ZCLENBQUM7Q0FDRjtBQXRDRCxnQ0FzQ0MifQ==

package/build/cjs/src/clients/modules/vault.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const rest_1 = __importDefault(require("./rest"));
+/**
+ * @description REST endpoints for data unrelated to a particular address.
+ */
+class VaultClient extends rest_1.default {
+    async getMegavaultHistoricalPnl(resolution) {
+        const uri = '/v4/vault/v1/megavault/historicalPnl';
+        return this.get(uri, { resolution });
+    }
+    async getVaultsHistoricalPnl(resolution) {
+        const uri = '/v4/vault/v1/vaults/historicalPnl';
+        return this.get(uri, { resolution });
+    }
+    async getMegavaultPositions() {
+        const uri = '/v4/vault/v1/megavault/positions';
+        return this.get(uri);
+    }
+}
+exports.default = VaultClient;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidmF1bHQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi8uLi9zcmMvY2xpZW50cy9tb2R1bGVzL3ZhdWx0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBRUEsa0RBQWdDO0FBRWhDOztHQUVHO0FBQ0gsTUFBcUIsV0FBWSxTQUFRLGNBQVU7SUFDakQsS0FBSyxDQUFDLHlCQUF5QixDQUFDLFVBQW1DO1FBQ2pFLE1BQU0sR0FBRyxHQUFHLHNDQUFzQyxDQUFDO1FBQ25ELE9BQU8sSUFBSSxDQUFDLEdBQUcsQ0FBQyxHQUFHLEVBQUUsRUFBRSxVQUFVLEVBQUUsQ0FBQyxDQUFDO0lBQ3ZDLENBQUM7SUFFRCxLQUFLLENBQUMsc0JBQXNCLENBQUMsVUFBbUM7UUFDOUQsTUFBTSxHQUFHLEdBQUcsbUNBQW1DLENBQUM7UUFDaEQsT0FBTyxJQUFJLENBQUMsR0FBRyxDQUFDLEdBQUcsRUFBRSxFQUFFLFVBQVUsRUFBRSxDQUFDLENBQUM7SUFDdkMsQ0FBQztJQUVELEtBQUssQ0FBQyxxQkFBcUI7UUFDekIsTUFBTSxHQUFHLEdBQUcsa0NBQWtDLENBQUM7UUFDL0MsT0FBTyxJQUFJLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQyxDQUFDO0lBQ3ZCLENBQUM7Q0FDRjtBQWZELDhCQWVDIn0=