@dydxprotocol/v4-client-js 3.0.2 → 3.0.3

package/CHANGELOG.md

@@ -1,6 +1,6 @@
-## [3.0.2](https://github.com/dydxprotocol/v4-clients/compare/v4-client-js@3.0.1...v4-client-js@3.0.2) (2025-09-12)
+## [3.0.3](https://github.com/dydxprotocol/v4-clients/compare/v4-client-js@3.0.2...v4-client-js@3.0.3) (2025-09-12)
 
 
 ### Bug Fixes
 
-* gas for remove auth for some reason ([#425](https://github.com/dydxprotocol/v4-clients/issues/425)) ([a2ecc24](https://github.com/dydxprotocol/v4-clients/commit/a2ecc247bd9f7dab65f23186a9bec79945381760))
+* trading key helpers ([#426](https://github.com/dydxprotocol/v4-clients/issues/426)) ([9a2f312](https://github.com/dydxprotocol/v4-clients/commit/9a2f3120bc3f4ebeb541078ed992c616993b7921))

package/build/cjs/src/index.js

@@ -39,12 +39,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NetworkOptimizer = exports.ByteArrayEncoding = exports.encodeJson = exports.ValidatorClient = exports.SubaccountInfo = exports.SubaccountClient = exports.SocketClient = exports.NobleClient = exports.LocalWallet = exports.IndexerClient = exports.FaucetClient = exports.CompositeClient = exports.validation = exports.utils = exports.onboarding = exports.helpers = void 0;
+exports.NetworkOptimizer = exports.ByteArrayEncoding = exports.encodeJson = exports.ValidatorClient = exports.SubaccountInfo = exports.SubaccountClient = exports.SocketClient = exports.NobleClient = exports.LocalWallet = exports.IndexerClient = exports.FaucetClient = exports.CompositeClient = exports.validation = exports.utils = exports.tradingKeyUtils = exports.onboarding = exports.helpers = void 0;
 // Types.
 __exportStar(require("./types"), exports);
 // Utility functions.
 exports.helpers = __importStar(require("./lib/helpers"));
 exports.onboarding = __importStar(require("./lib/onboarding"));
+exports.tradingKeyUtils = __importStar(require("./lib/trading-key-utils"));
 exports.utils = __importStar(require("./lib/utils"));
 exports.validation = __importStar(require("./lib/validation"));
 var composite_client_1 = require("./clients/composite-client");
@@ -69,4 +70,4 @@ Object.defineProperty(exports, "encodeJson", { enumerable: true, get: function (
 Object.defineProperty(exports, "ByteArrayEncoding", { enumerable: true, get: function () { return helpers_1.ByteArrayEncoding; } });
 var network_optimizer_1 = require("./network_optimizer");
 Object.defineProperty(exports, "NetworkOptimizer", { enumerable: true, get: function () { return network_optimizer_1.NetworkOptimizer; } });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBQUEsU0FBUztBQUNULDBDQUF3QjtBQUV4QixxQkFBcUI7QUFDckIseURBQXlDO0FBQ3pDLCtEQUErQztBQUMvQyxxREFBcUM7QUFDckMsK0RBQStDO0FBRS9DLCtEQUE2RDtBQUFwRCxtSEFBQSxlQUFlLE9BQUE7QUFDeEIseURBQXVEO0FBQTlDLDZHQUFBLFlBQVksT0FBQTtBQUNyQiwyREFBeUQ7QUFBaEQsK0dBQUEsYUFBYSxPQUFBO0FBQ3RCLCtEQUF3RTtBQUEvRCw0SEFBQSxPQUFPLE9BQWU7QUFDL0IsdURBQXFEO0FBQTVDLDJHQUFBLFdBQVcsT0FBQTtBQUNwQix5REFBdUQ7QUFBOUMsNkdBQUEsWUFBWSxPQUFBO0FBQ3JCLG1EQUEwRjtBQUFqRiw4R0FBQSxjQUFjLE9BQW9CO0FBQUUsNEdBQUEsY0FBYyxPQUFBO0FBQzNELCtEQUE2RDtBQUFwRCxtSEFBQSxlQUFlLE9BQUE7QUFDeEIseUNBQThEO0FBQXJELHFHQUFBLFVBQVUsT0FBQTtBQUFFLDRHQUFBLGlCQUFpQixPQUFBO0FBQ3RDLHlEQUF1RDtBQUE5QyxxSEFBQSxnQkFBZ0IsT0FBQSJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBQUEsU0FBUztBQUNULDBDQUF3QjtBQUV4QixxQkFBcUI7QUFDckIseURBQXlDO0FBQ3pDLCtEQUErQztBQUMvQywyRUFBMkQ7QUFDM0QscURBQXFDO0FBQ3JDLCtEQUErQztBQUUvQywrREFBNkQ7QUFBcEQsbUhBQUEsZUFBZSxPQUFBO0FBQ3hCLHlEQUF1RDtBQUE5Qyw2R0FBQSxZQUFZLE9BQUE7QUFDckIsMkRBQXlEO0FBQWhELCtHQUFBLGFBQWEsT0FBQTtBQUN0QiwrREFBd0U7QUFBL0QsNEhBQUEsT0FBTyxPQUFlO0FBQy9CLHVEQUFxRDtBQUE1QywyR0FBQSxXQUFXLE9BQUE7QUFDcEIseURBQXVEO0FBQTlDLDZHQUFBLFlBQVksT0FBQTtBQUNyQixtREFBMEY7QUFBakYsOEdBQUEsY0FBYyxPQUFvQjtBQUFFLDRHQUFBLGNBQWMsT0FBQTtBQUMzRCwrREFBNkQ7QUFBcEQsbUhBQUEsZUFBZSxPQUFBO0FBQ3hCLHlDQUE4RDtBQUFyRCxxR0FBQSxVQUFVLE9BQUE7QUFBRSw0R0FBQSxpQkFBaUIsT0FBQTtBQUN0Qyx5REFBdUQ7QUFBOUMscUhBQUEsZ0JBQWdCLE9BQUEifQ==

package/build/cjs/src/lib/trading-key-utils.js

@@ -0,0 +1,108 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAuthorizedTradingKeysMetadata = exports.getAuthorizeNewTradingKeyArguments = exports.createNewRandomDydxWallet = void 0;
+const encoding_1 = require("@cosmjs/encoding");
+const tendermint_rpc_1 = require("@cosmjs/tendermint-rpc");
+const bip39_1 = require("@scure/bip39");
+const english_1 = require("@scure/bip39/wordlists/english");
+const constants_1 = require("../clients/constants");
+const local_wallet_1 = __importDefault(require("../clients/modules/local-wallet"));
+const constants_2 = require("./constants");
+const onboarding_1 = require("./onboarding");
+const createNewRandomDydxWallet = async () => {
+    const mnemonic = (0, bip39_1.generateMnemonic)(english_1.wordlist, 128);
+    const { privateKey: privateKeyRaw } = (0, onboarding_1.deriveHDKeyFromMnemonic)(mnemonic);
+    const wallet = await local_wallet_1.default.fromMnemonic(mnemonic, constants_2.BECH32_PREFIX);
+    const privateKeyHex = privateKeyRaw != null ? `0x${(0, encoding_1.toHex)(privateKeyRaw)}` : undefined;
+    const publicKey = wallet.pubKey;
+    const address = wallet.address;
+    if (privateKeyHex == null || publicKey == null || address == null) {
+        return undefined;
+    }
+    return {
+        // 12 english words
+        mnemonic,
+        // toHex of the raw private key bits
+        privateKeyHex,
+        // base64, not hex
+        publicKey: publicKey.value,
+        // valid dydx address corresponding to the key pair
+        address,
+    };
+};
+exports.createNewRandomDydxWallet = createNewRandomDydxWallet;
+// arguments to authorize a given wallet public key to trade on behalf of the user.
+// allows place order, cancel order, batch cancel on subaccount 0 only.
+const getAuthorizeNewTradingKeyArguments = ({ generatedWalletPubKey, }) => {
+    const wrapAndEncode64 = (s) => (0, encoding_1.toBase64)(new TextEncoder().encode(s));
+    const messageFilterSubAuth = [
+        {
+            type: constants_1.AuthenticatorType.MESSAGE_FILTER,
+            config: wrapAndEncode64(constants_1.TYPE_URL_MSG_PLACE_ORDER),
+        },
+        {
+            type: constants_1.AuthenticatorType.MESSAGE_FILTER,
+            config: wrapAndEncode64(constants_1.TYPE_URL_MSG_CANCEL_ORDER),
+        },
+        {
+            type: constants_1.AuthenticatorType.MESSAGE_FILTER,
+            config: wrapAndEncode64(constants_1.TYPE_URL_BATCH_CANCEL),
+        },
+    ];
+    const anyOfMessageFilterConfigB64 = wrapAndEncode64(JSON.stringify(messageFilterSubAuth));
+    const subAuth = [
+        {
+            type: constants_1.AuthenticatorType.SIGNATURE_VERIFICATION,
+            config: generatedWalletPubKey,
+        },
+        {
+            type: constants_1.AuthenticatorType.ANY_OF,
+            config: anyOfMessageFilterConfigB64,
+        },
+        // we limit to cross markets to make it slightly harder to drain user funds on low liquidity markets with trading keys
+        // could undo this in the future if people are angry about it
+        {
+            type: constants_1.AuthenticatorType.SUBACCOUNT_FILTER,
+            config: wrapAndEncode64('0'),
+        },
+    ];
+    const jsonString = JSON.stringify(subAuth);
+    const encodedData = new TextEncoder().encode(jsonString);
+    const topLevelType = constants_1.AuthenticatorType.ALL_OF;
+    return {
+        type: topLevelType,
+        data: encodedData,
+    };
+};
+exports.getAuthorizeNewTradingKeyArguments = getAuthorizeNewTradingKeyArguments;
+const isTruthy = (n) => Boolean(n);
+// just parses out keys that match the format created in getAuthorizeNewTradingKeyArguments
+const getAuthorizedTradingKeysMetadata = (authorizedKeys) => {
+    return authorizedKeys
+        .map(({ config, id, type }) => {
+        var _a;
+        if (type !== constants_1.AuthenticatorType.ALL_OF) {
+            return null;
+        }
+        const parsedConfig = JSON.parse(new TextDecoder().decode(config));
+        if (parsedConfig == null) {
+            return null;
+        }
+        const publicKey = (_a = parsedConfig.find((t) => t.type === constants_1.AuthenticatorType.SIGNATURE_VERIFICATION)) === null || _a === void 0 ? void 0 : _a.config;
+        if (publicKey == null || typeof publicKey !== 'string') {
+            return null;
+        }
+        const address = (0, encoding_1.toBech32)(constants_2.BECH32_PREFIX, (0, tendermint_rpc_1.rawSecp256k1PubkeyToRawAddress)((0, encoding_1.fromBase64)(publicKey)));
+        return {
+            id: id.toString(),
+            publicKey,
+            address,
+        };
+    })
+        .filter(isTruthy);
+};
+exports.getAuthorizedTradingKeysMetadata = getAuthorizedTradingKeysMetadata;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHJhZGluZy1rZXktdXRpbHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvbGliL3RyYWRpbmcta2V5LXV0aWxzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7OztBQUFBLCtDQUF5RTtBQUN6RSwyREFBd0U7QUFDeEUsd0NBQWdEO0FBQ2hELDREQUEwRDtBQUUxRCxvREFNOEI7QUFFOUIsbUZBQTBEO0FBQzFELDJDQUE0QztBQUM1Qyw2Q0FBdUQ7QUFFaEQsTUFBTSx5QkFBeUIsR0FBRyxLQUFLLElBRTVDLEVBQUU7SUFDRixNQUFNLFFBQVEsR0FBRyxJQUFBLHdCQUFnQixFQUFDLGtCQUFRLEVBQUUsR0FBRyxDQUFDLENBQUM7SUFDakQsTUFBTSxFQUFFLFVBQVUsRUFBRSxhQUFhLEVBQUUsR0FBRyxJQUFBLG9DQUF1QixFQUFDLFFBQVEsQ0FBQyxDQUFDO0lBQ3hFLE1BQU0sTUFBTSxHQUFHLE1BQU0sc0JBQVcsQ0FBQyxZQUFZLENBQUMsUUFBUSxFQUFFLHlCQUFhLENBQUMsQ0FBQztJQUV2RSxNQUFNLGFBQWEsR0FBRyxhQUFhLElBQUksSUFBSSxDQUFDLENBQUMsQ0FBQyxLQUFLLElBQUEsZ0JBQUssRUFBQyxhQUFhLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUM7SUFDdEYsTUFBTSxTQUFTLEdBQUcsTUFBTSxDQUFDLE1BQU0sQ0FBQztJQUNoQyxNQUFNLE9BQU8sR0FBRyxNQUFNLENBQUMsT0FBTyxDQUFDO0lBRS9CLElBQUksYUFBYSxJQUFJLElBQUksSUFBSSxTQUFTLElBQUksSUFBSSxJQUFJLE9BQU8sSUFBSSxJQUFJLEVBQUUsQ0FBQztRQUNsRSxPQUFPLFNBQVMsQ0FBQztJQUNuQixDQUFDO0lBRUQsT0FBTztRQUNMLG1CQUFtQjtRQUNuQixRQUFRO1FBQ1Isb0NBQW9DO1FBQ3BDLGFBQWE7UUFDYixrQkFBa0I7UUFDbEIsU0FBUyxFQUFFLFNBQVMsQ0FBQyxLQUFLO1FBQzFCLG1EQUFtRDtRQUNuRCxPQUFPO0tBQ1IsQ0FBQztBQUNKLENBQUMsQ0FBQztBQXpCVyxRQUFBLHlCQUF5Qiw2QkF5QnBDO0FBRUYsbUZBQW1GO0FBQ25GLHVFQUF1RTtBQUNoRSxNQUFNLGtDQUFrQyxHQUFHLENBQUMsRUFDakQscUJBQXFCLEdBR3RCLEVBQWlELEVBQUU7SUFDbEQsTUFBTSxlQUFlLEdBQUcsQ0FBQyxDQUFTLEVBQVUsRUFBRSxDQUFDLElBQUEsbUJBQVEsRUFBQyxJQUFJLFdBQVcsRUFBRSxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBRXJGLE1BQU0sb0JBQW9CLEdBQUc7UUFDM0I7WUFDRSxJQUFJLEVBQUUsNkJBQWlCLENBQUMsY0FBYztZQUN0QyxNQUFNLEVBQUUsZUFBZSxDQUFDLG9DQUF3QixDQUFDO1NBQ2xEO1FBQ0Q7WUFDRSxJQUFJLEVBQUUsNkJBQWlCLENBQUMsY0FBYztZQUN0QyxNQUFNLEVBQUUsZUFBZSxDQUFDLHFDQUF5QixDQUFDO1NBQ25EO1FBQ0Q7WUFDRSxJQUFJLEVBQUUsNkJBQWlCLENBQUMsY0FBYztZQUN0QyxNQUFNLEVBQUUsZUFBZSxDQUFDLGlDQUFxQixDQUFDO1NBQy9DO0tBQ0YsQ0FBQztJQUVGLE1BQU0sMkJBQTJCLEdBQUcsZUFBZSxDQUFDLElBQUksQ0FBQyxTQUFTLENBQUMsb0JBQW9CLENBQUMsQ0FBQyxDQUFDO0lBRTFGLE1BQU0sT0FBTyxHQUFHO1FBQ2Q7WUFDRSxJQUFJLEVBQUUsNkJBQWlCLENBQUMsc0JBQXNCO1lBQzlDLE1BQU0sRUFBRSxxQkFBcUI7U0FDOUI7UUFDRDtZQUNFLElBQUksRUFBRSw2QkFBaUIsQ0FBQyxNQUFNO1lBQzlCLE1BQU0sRUFBRSwyQkFBMkI7U0FDcEM7UUFDRCxzSEFBc0g7UUFDdEgsNkRBQTZEO1FBQzdEO1lBQ0UsSUFBSSxFQUFFLDZCQUFpQixDQUFDLGlCQUFpQjtZQUN6QyxNQUFNLEVBQUUsZUFBZSxDQUFDLEdBQUcsQ0FBQztTQUM3QjtLQUNGLENBQUM7SUFFRixNQUFNLFVBQVUsR0FBRyxJQUFJLENBQUMsU0FBUyxDQUFDLE9BQU8sQ0FBQyxDQUFDO0lBQzNDLE1BQU0sV0FBVyxHQUFHLElBQUksV0FBVyxFQUFFLENBQUMsTUFBTSxDQUFDLFVBQVUsQ0FBQyxDQUFDO0lBQ3pELE1BQU0sWUFBWSxHQUFHLDZCQUFpQixDQUFDLE1BQU0sQ0FBQztJQUU5QyxPQUFPO1FBQ0wsSUFBSSxFQUFFLFlBQVk7UUFDbEIsSUFBSSxFQUFFLFdBQVc7S0FDbEIsQ0FBQztBQUNKLENBQUMsQ0FBQztBQWpEVyxRQUFBLGtDQUFrQyxzQ0FpRDdDO0FBSUYsTUFBTSxRQUFRLEdBQUcsQ0FBSSxDQUFvQyxFQUFVLEVBQUUsQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFDLENBQUM7QUFFakYsMkZBQTJGO0FBQ3BGLE1BQU0sZ0NBQWdDLEdBQUcsQ0FDOUMsY0FBc0YsRUFDM0IsRUFBRTtJQUM3RCxPQUFPLGNBQWM7U0FDbEIsR0FBRyxDQUFDLENBQUMsRUFBRSxNQUFNLEVBQUUsRUFBRSxFQUFFLElBQUksRUFBRSxFQUFFLEVBQUU7O1FBQzVCLElBQUksSUFBSSxLQUFLLDZCQUFpQixDQUFDLE1BQU0sRUFBRSxDQUFDO1lBQ3RDLE9BQU8sSUFBSSxDQUFDO1FBQ2QsQ0FBQztRQUNELE1BQU0sWUFBWSxHQUFHLElBQUksQ0FBQyxLQUFLLENBQUMsSUFBSSxXQUFXLEVBQUUsQ0FBQyxNQUFNLENBQUMsTUFBTSxDQUFDLENBRW5ELENBQUM7UUFDZCxJQUFJLFlBQVksSUFBSSxJQUFJLEVBQUUsQ0FBQztZQUN6QixPQUFPLElBQUksQ0FBQztRQUNkLENBQUM7UUFFRCxNQUFNLFNBQVMsR0FBRyxNQUFBLFlBQVksQ0FBQyxJQUFJLENBQ2pDLENBQUMsQ0FBQyxFQUFFLEVBQUUsQ0FBQyxDQUFDLENBQUMsSUFBSSxLQUFLLDZCQUFpQixDQUFDLHNCQUFzQixDQUMzRCwwQ0FBRSxNQUFNLENBQUM7UUFDVixJQUFJLFNBQVMsSUFBSSxJQUFJLElBQUksT0FBTyxTQUFTLEtBQUssUUFBUSxFQUFFLENBQUM7WUFDdkQsT0FBTyxJQUFJLENBQUM7UUFDZCxDQUFDO1FBRUQsTUFBTSxPQUFPLEdBQUcsSUFBQSxtQkFBUSxFQUN0Qix5QkFBYSxFQUNiLElBQUEsK0NBQThCLEVBQUMsSUFBQSxxQkFBVSxFQUFDLFNBQVMsQ0FBQyxDQUFDLENBQ3RELENBQUM7UUFDRixPQUFPO1lBQ0wsRUFBRSxFQUFFLEVBQUUsQ0FBQyxRQUFRLEVBQUU7WUFDakIsU0FBUztZQUNULE9BQU87U0FDUixDQUFDO0lBQ0osQ0FBQyxDQUFDO1NBQ0QsTUFBTSxDQUFDLFFBQVEsQ0FBQyxDQUFDO0FBQ3RCLENBQUMsQ0FBQztBQWpDVyxRQUFBLGdDQUFnQyxvQ0FpQzNDIn0=