@d8x/perpetuals-sdk 0.1.12 → 0.2.0

package/dist/esm/brokerTool.js

@@ -0,0 +1,572 @@
+import { __awaiter, __extends, __generator } from "tslib";
+import WriteAccessHandler from "./writeAccessHandler";
+import PerpetualDataHandler from "./perpetualDataHandler";
+import { ABK64x64ToFloat } from "./d8XMath";
+import { BigNumber, ethers } from "ethers";
+import AccountTrade from "./accountTrade";
+import { Buffer } from "buffer";
+/**
+ * Functions for brokers to determine fees, deposit lots, and sign-up traders.
+ * This class requires a private key and executes smart-contract interactions that
+ * require gas-payments.
+ * @extends WriteAccessHandler
+ */
+var BrokerTool = /** @class */ (function (_super) {
+    __extends(BrokerTool, _super);
+    /**
+     * Constructor
+     * @param {NodeSDKConfig} config Configuration object, see PerpetualDataHandler.
+     * readSDKConfig.
+     * @param {string} privateKey Private key of a broker.
+     * @example
+     * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(BrokerTool);
+     *   // load configuration for testnet
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   // BrokerTool (authentication required, PK is an environment variable with a private key)
+     *   const pk: string = <string>process.env.PK;
+     *   let brokTool = new BrokerTool(config, pk);
+     *   // Create a proxy instance to access the blockchain
+     *   await brokTool.createProxyInstance();
+     * }
+     * main();
+     *
+     */
+    function BrokerTool(config, privateKey) {
+        return _super.call(this, config, privateKey) || this;
+    }
+    // Fee getters
+    /**
+     * Determine the exchange fee based on lots, traded volume, and D8X balance of this broker.
+     * This is the final exchange fee that this broker can offer to traders that trade through him.
+     * @param {string} poolSymbolName Pool symbol name (e.g. MATIC, USDC, etc).
+     * @example
+     * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(BrokerTool);
+     *   // setup (authentication required, PK is an environment variable with a private key)
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   const pk: string = <string>process.env.PK;
+     *   let brokTool = new BrokerTool(config, pk);
+     *   await brokTool.createProxyInstance();
+     *   // get broker induced fee
+     *   let brokFee = await brokTool.getBrokerInducedFee("MATIC");
+     *   console.log(brokFee);
+     * }
+     * main();
+     *
+     * @returns {number} Exchange fee for this broker, in decimals (i.e. 0.1% is 0.001)
+     */
+    BrokerTool.prototype.getBrokerInducedFee = function (poolSymbolName) {
+        return __awaiter(this, void 0, void 0, function () {
+            var poolId, feeTbps, fee;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (this.proxyContract == null || this.signer == null) {
+                            throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
+                        }
+                        poolId = PerpetualDataHandler._getPoolIdFromSymbol(poolSymbolName, this.poolStaticInfos);
+                        return [4 /*yield*/, this.proxyContract.getBrokerInducedFee(poolId, this.traderAddr)];
+                    case 1:
+                        feeTbps = _a.sent();
+                        fee = feeTbps / 100000;
+                        if (fee == 0.65535) {
+                            return [2 /*return*/, undefined];
+                        }
+                        return [2 /*return*/, fee];
+                }
+            });
+        });
+    };
+    /**
+     * Determine the exchange fee based on lots purchased by this broker.
+     * The final exchange fee that this broker can offer to traders that trade through him is equal to
+     * maximum(brokerTool.getFeeForBrokerDesignation(poolSymbolName),  brokerTool.getFeeForBrokerVolume(poolSymbolName), brokerTool.getFeeForBrokerStake())
+     * @param {string} poolSymbolName Pool symbol name (e.g. MATIC, USDC, etc).
+     * @param {number=} lots Optional, designation to use if different from this broker's.
+     * @example
+     * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(BrokerTool);
+     *   // setup (authentication required, PK is an environment variable with a private key)
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   const pk: string = <string>process.env.PK;
+     *   let brokTool = new BrokerTool(config, pk);
+     *   await brokTool.createProxyInstance();
+     *   // get broker fee induced by lots
+     *   let brokFeeLots = await brokTool.getFeeForBrokerDesignation("MATIC");
+     *   console.log(brokFeeLots);
+     * }
+     * main();
+     *
+     * @returns {number} Fee based solely on this broker's designation, in decimals (i.e. 0.1% is 0.001).
+     */
+    BrokerTool.prototype.getFeeForBrokerDesignation = function (poolSymbolName, lots) {
+        return __awaiter(this, void 0, void 0, function () {
+            var brokerDesignation, feeTbps;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (this.proxyContract == null || this.signer == null) {
+                            throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
+                        }
+                        if (!(typeof lots == "undefined")) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this.getBrokerDesignation(poolSymbolName)];
+                    case 1:
+                        brokerDesignation = _a.sent();
+                        brokerDesignation = brokerDesignation > 0 ? brokerDesignation : 0;
+                        return [3 /*break*/, 3];
+                    case 2:
+                        brokerDesignation = lots;
+                        _a.label = 3;
+                    case 3: return [4 /*yield*/, this.proxyContract.getFeeForBrokerDesignation(brokerDesignation)];
+                    case 4:
+                        feeTbps = _a.sent();
+                        return [2 /*return*/, feeTbps / 100000];
+                }
+            });
+        });
+    };
+    /**
+     * Determine the exchange fee based on volume traded under this broker.
+     * The final exchange fee that this broker can offer to traders that trade through him is equal to
+     * maximum(brokerTool.getFeeForBrokerDesignation(poolSymbolName),  brokerTool.getFeeForBrokerVolume(poolSymbolName), brokerTool.getFeeForBrokerStake())
+     * @param {string} poolSymbolName Pool symbol name (e.g. MATIC, USDC, etc).
+     * @example
+     * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(BrokerTool);
+     *   // setup (authentication required, PK is an environment variable with a private key)
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   const pk: string = <string>process.env.PK;
+     *   let brokTool = new BrokerTool(config, pk);
+     *   await brokTool.createProxyInstance();
+     *   // get broker fee induced by volume
+     *   let brokFeeVol = await brokTool.getFeeForBrokerVolume("MATIC");
+     *   console.log(brokFeeVol);
+     * }
+     * main();
+     *
+     * @returns {number} Fee based solely on a broker's traded volume in the corresponding pool, in decimals (i.e. 0.1% is 0.001).
+     */
+    BrokerTool.prototype.getFeeForBrokerVolume = function (poolSymbolName) {
+        return __awaiter(this, void 0, void 0, function () {
+            var poolId, feeTbps;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (this.proxyContract == null || this.signer == null) {
+                            throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
+                        }
+                        poolId = PerpetualDataHandler._getPoolIdFromSymbol(poolSymbolName, this.poolStaticInfos);
+                        return [4 /*yield*/, this.proxyContract.getFeeForBrokerVolume(poolId, this.traderAddr)];
+                    case 1:
+                        feeTbps = _a.sent();
+                        return [2 /*return*/, feeTbps / 100000];
+                }
+            });
+        });
+    };
+    /**
+     * Determine the exchange fee based on the current D8X balance in a broker's wallet.
+     * The final exchange fee that this broker can offer to traders that trade through him is equal to
+     * maximum(brokerTool.getFeeForBrokerDesignation(symbol, lots),  brokerTool.getFeeForBrokerVolume(symbol), brokerTool.getFeeForBrokerStake)
+     * @param {string=} brokerAddr Address of the broker in question, if different from the one calling this function.
+     * @example
+     * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(BrokerTool);
+     *   // setup (authentication required, PK is an environment variable with a private key)
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   const pk: string = <string>process.env.PK;
+     *   let brokTool = new BrokerTool(config, pk);
+     *   await brokTool.createProxyInstance();
+     *   // get broker fee induced by staked d8x
+     *   let brokFeeStake = await brokTool.getFeeForBrokerStake("0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B");
+     *   console.log(brokFeeStake);
+     * }
+     * main();
+     *
+     * @returns {number} Fee based solely on a broker's D8X balance, in decimals (i.e. 0.1% is 0.001).
+     */
+    BrokerTool.prototype.getFeeForBrokerStake = function (brokerAddr) {
+        return __awaiter(this, void 0, void 0, function () {
+            var feeTbps;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (this.proxyContract == null || this.signer == null) {
+                            throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
+                        }
+                        if (typeof brokerAddr == "undefined") {
+                            brokerAddr = this.traderAddr;
+                        }
+                        return [4 /*yield*/, this.proxyContract.getFeeForBrokerStake(brokerAddr)];
+                    case 1:
+                        feeTbps = _a.sent();
+                        return [2 /*return*/, feeTbps / 100000];
+                }
+            });
+        });
+    };
+    /**
+     * Determine exchange fee based on an order and a trader.
+     * This is the fee charged by the exchange only, excluding the broker fee,
+     * and it takes into account whether the order given here has been signed by a broker or not.
+     * Use this, for instance, to verify that the fee to be charged for a given order is as expected,
+     * before and after signing it with brokerTool.signOrder.
+     * This fee is equal or lower than the broker induced fee, provided the order is properly signed.
+     * @param {Order} order Order structure. As a minimum the structure needs to
+     * specify symbol, side, type and quantity.
+     * @param {string} traderAddr Address of the trader for whom to determine the fee.
+     * @example
+     * import { BrokerTool, PerpetualDataHandler, Order } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(BrokerTool);
+     *   // setup (authentication required, PK is an environment variable with a private key)
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   const pk: string = <string>process.env.PK;
+     *   let brokTool = new BrokerTool(config, pk);
+     *   await brokTool.createProxyInstance();
+     *   // get exchange fee based on an order and trader
+     *   let order: Order = {
+     *       symbol: "MATIC-USD-MATIC",
+     *       side: "BUY",
+     *       type: "MARKET",
+     *       quantity: 100,
+     *       timestamp: Date.now()
+     *   };
+     *    let exchFee = await brokTool.determineExchangeFee(order,
+     *        "0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B");
+     *   console.log(exchFee);
+     * }
+     * main();
+     *
+     * @returns {number} Fee in decimals (i.e. 0.1% is 0.001).
+     */
+    BrokerTool.prototype.determineExchangeFee = function (order, traderAddr) {
+        return __awaiter(this, void 0, void 0, function () {
+            var scOrder, feeTbps;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (this.proxyContract == null || this.signer == null) {
+                            throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
+                        }
+                        scOrder = AccountTrade.toSmartContractOrder(order, traderAddr, this.symbolToPerpStaticInfo);
+                        return [4 /*yield*/, this.proxyContract.determineExchangeFee(scOrder)];
+                    case 1:
+                        feeTbps = _a.sent();
+                        return [2 /*return*/, feeTbps / 100000];
+                }
+            });
+        });
+    };
+    // Volume
+    /**
+     * Exponentially weighted EMA of the total trading volume of all trades performed under this broker.
+     * The weights are chosen so that in average this coincides with the 30 day volume.
+     * @param {string} poolSymbolName Pool symbol name (e.g. MATIC, USDC, etc).
+     * @example
+     * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(BrokerTool);
+     *   // setup (authentication required, PK is an environment variable with a private key)
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   const pk: string = <string>process.env.PK;
+     *   let brokTool = new BrokerTool(config, pk);
+     *   await brokTool.createProxyInstance();
+     *   // get 30 day volume for broker
+     *   let brokVolume = await brokTool.getCurrentBrokerVolume("MATIC");
+     *   console.log(brokVolume);
+     * }
+     * main();
+     *
+     * @returns {number} Current trading volume for this broker, in USD.
+     */
+    BrokerTool.prototype.getCurrentBrokerVolume = function (poolSymbolName) {
+        return __awaiter(this, void 0, void 0, function () {
+            var poolId, volume;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (this.proxyContract == null || this.signer == null) {
+                            throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
+                        }
+                        poolId = PerpetualDataHandler._getPoolIdFromSymbol(poolSymbolName, this.poolStaticInfos);
+                        return [4 /*yield*/, this.proxyContract.getCurrentBrokerVolume(poolId, this.traderAddr)];
+                    case 1:
+                        volume = _a.sent();
+                        return [2 /*return*/, ABK64x64ToFloat(volume)];
+                }
+            });
+        });
+    };
+    // Lots
+    /**
+     * Total amount of collateral currency a broker has to deposit into the default fund to purchase one lot.
+     * This is equivalent to the price of a lot expressed in a given pool's currency (e.g. MATIC, USDC, etc).
+     * @param {string} poolSymbolName Pool symbol name (e.g. MATIC, USDC, etc).
+     * @example
+     * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(BrokerTool);
+     *   // setup (authentication required, PK is an environment variable with a private key)
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   const pk: string = <string>process.env.PK;
+     *   let brokTool = new BrokerTool(config, pk);
+     *   await brokTool.createProxyInstance();
+     *   // get lot price
+     *   let brokLotSize = await brokTool.getLotSize("MATIC");
+     *   console.log(brokLotSize);
+     * }
+     * main();
+     *
+     * @returns {number} Broker lot size in a given pool's currency, e.g. in MATIC for poolSymbolName MATIC.
+     */
+    BrokerTool.prototype.getLotSize = function (poolSymbolName) {
+        return __awaiter(this, void 0, void 0, function () {
+            var poolId, pool, lot;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (this.proxyContract == null) {
+                            throw Error("no proxy contract initialized. Use createProxyInstance().");
+                        }
+                        poolId = PerpetualDataHandler._getPoolIdFromSymbol(poolSymbolName, this.poolStaticInfos);
+                        return [4 /*yield*/, this.proxyContract.getLiquidityPool(poolId)];
+                    case 1:
+                        pool = _a.sent();
+                        lot = ABK64x64ToFloat(pool.fBrokerCollateralLotSize);
+                        return [2 /*return*/, lot];
+                }
+            });
+        });
+    };
+    /**
+     * Provides information on how many lots a broker purchased for a given pool.
+     * This is relevant to determine the broker's fee tier.
+     * @param {string} poolSymbolName Pool symbol name (e.g. MATIC, USDC, etc).
+     * @example
+     * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(BrokerTool);
+     *   // setup (authentication required, PK is an environment variable with a private key)
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   const pk: string = <string>process.env.PK;
+     *   let brokTool = new BrokerTool(config, pk);
+     *   await brokTool.createProxyInstance();
+     *   // get broker designation
+     *   let brokDesignation = await brokTool.getBrokerDesignation("MATIC");
+     *   console.log(brokDesignation);
+     * }
+     * main();
+     *
+     * @returns {number} Number of lots purchased by this broker.
+     */
+    BrokerTool.prototype.getBrokerDesignation = function (poolSymbolName) {
+        return __awaiter(this, void 0, void 0, function () {
+            var poolId, designation;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (this.proxyContract == null || this.signer == null) {
+                            throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
+                        }
+                        poolId = PerpetualDataHandler._getPoolIdFromSymbol(poolSymbolName, this.poolStaticInfos);
+                        return [4 /*yield*/, this.proxyContract.getBrokerDesignation(poolId, this.traderAddr)];
+                    case 1:
+                        designation = _a.sent();
+                        return [2 /*return*/, designation];
+                }
+            });
+        });
+    };
+    /**
+     * Deposit lots to the default fund of a given pool.
+     * @param {string} poolSymbolName Pool symbol name (e.g. MATIC, USDC, etc).
+     * @param {number} lots Number of lots to deposit into this pool.
+     * @example
+     * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(BrokerTool);
+     *   // setup (authentication required, PK is an environment variable with a private key)
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   const pk: string = <string>process.env.PK;
+     *   let brokTool = new BrokerTool(config, pk);
+     *   await brokTool.createProxyInstance();
+     *   // deposit to default fund
+     *   await brokTool.setAllowance("MATIC");
+     *   let respDeposit = await brokTool.brokerDepositToDefaultFund("MATIC",1);
+     *   console.log(respDeposit);
+     * }
+     * main();
+     *
+     * @returns {ethers.ContractTransaction} ContractTransaction object.
+     */
+    BrokerTool.prototype.brokerDepositToDefaultFund = function (poolSymbolName, lots) {
+        return __awaiter(this, void 0, void 0, function () {
+            var poolId, tx;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (this.proxyContract == null || this.signer == null) {
+                            throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
+                        }
+                        poolId = PerpetualDataHandler._getPoolIdFromSymbol(poolSymbolName, this.poolStaticInfos);
+                        return [4 /*yield*/, this.proxyContract.brokerDepositToDefaultFund(poolId, lots, { gasLimit: this.gasLimit })];
+                    case 1:
+                        tx = _a.sent();
+                        return [2 /*return*/, tx];
+                }
+            });
+        });
+    };
+    // Signatures
+    /**
+     * Adds this broker's signature to an order. An order signed by a broker is considered
+     * to be routed through this broker and benefits from the broker's fee conditions.
+     * @param {Order} order Order to sign. It must contain valid broker fee, broker address, and order deadline.
+     * @param {string} traderAddr Address of trader submitting the order.
+     * @example
+     * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(BrokerTool);
+     *   // setup (authentication required, PK is an environment variable with a private key)
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   const pk: string = <string>process.env.PK;
+     *   let brokTool = new BrokerTool(config, pk);
+     *   await brokTool.createProxyInstance();
+     *   // sign order
+     *   let order = {symbol: "ETH-USD-MATIC",
+     *       side: "BUY",
+     *       type: "MARKET",
+     *       quantity: 1,
+     *       timestamp: Date.now()
+     *    };
+     *    let signedOrder = await brokTool.signOrder(order, "0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B",
+     *        0.0001, 1669723339);
+     *   console.log(signedOrder);
+     *   // execute order
+     *   let orderTransaction = await accTrade.order(signedOrder);
+     *   console.log(orderTransaction.hash);
+     * }
+     * main();
+     *
+     * @returns {Order} An order signed by this broker, which can be submitted directly with AccountTrade.order.
+     */
+    BrokerTool.prototype.signOrder = function (order, traderAddr) {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        if (this.proxyContract == null || this.signer == null) {
+                            throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
+                        }
+                        order.brokerAddr = this.traderAddr;
+                        _a = order;
+                        return [4 /*yield*/, BrokerTool._signOrder(order.symbol, order.brokerFeeTbps, traderAddr, BigNumber.from(order.deadline), this.signer, this.chainId, this.proxyAddr, this.symbolToPerpStaticInfo)];
+                    case 1:
+                        _a.brokerSignature = _b.sent();
+                        return [2 /*return*/, order];
+                }
+            });
+        });
+    };
+    /**
+     * Creates a signature that a trader can use to place orders with this broker.
+     * This signature can be used to pass on to a trader who wishes to trade via this SDK or directly on the blockchain.
+     * @param {string} traderAddr Address of the trader signing up with this broker.
+     * @param {string} symbol Perpetual that this trader will be trading, of the form ETH-USD-MATIC.
+     * @param {number} brokerFee Broker fee for this trader, in decimals (i.e. 0.1% is 0.001).
+     * @param {number} deadline Deadline for the order to be executed.
+     * @returns {string} Broker signature approving this trader's fee, symbol, and deadline.
+     * @ignore
+     */
+    BrokerTool.prototype.createSignatureForTrader = function (traderAddr, symbol, brokerFee, deadline) {
+        return __awaiter(this, void 0, void 0, function () {
+            var iDeadline, brokerFeeTbps;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (this.proxyContract == null || this.signer == null) {
+                            throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
+                        }
+                        iDeadline = BigNumber.from(deadline);
+                        brokerFeeTbps = 100000 * brokerFee;
+                        return [4 /*yield*/, BrokerTool._signOrder(symbol, brokerFeeTbps, traderAddr, iDeadline, this.signer, this.chainId, this.proxyAddr, this.symbolToPerpStaticInfo)];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    BrokerTool._signOrder = function (symbol, brokerFeeTbps, traderAddr, iDeadline, signer, chainId, proxyAddress, symbolToPerpStaticInfo) {
+        return __awaiter(this, void 0, void 0, function () {
+            var NAME, DOMAIN_TYPEHASH, abiCoder, domainSeparator, TRADE_BROKER_TYPEHASH, iPerpetualId, structHash, digest, digestBuffer;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        NAME = "Perpetual Trade Manager";
+                        DOMAIN_TYPEHASH = ethers.utils.keccak256(Buffer.from("EIP712Domain(string name,uint256 chainId,address verifyingContract)"));
+                        abiCoder = ethers.utils.defaultAbiCoder;
+                        domainSeparator = ethers.utils.keccak256(abiCoder.encode(["bytes32", "bytes32", "uint256", "address"], [DOMAIN_TYPEHASH, ethers.utils.keccak256(Buffer.from(NAME)), chainId, proxyAddress]));
+                        TRADE_BROKER_TYPEHASH = ethers.utils.keccak256(Buffer.from("Order(uint24 iPerpetualId,uint16 brokerFeeTbps,address traderAddr,uint64 iDeadline)"));
+                        iPerpetualId = PerpetualDataHandler.symbolToPerpetualId(symbol, symbolToPerpStaticInfo);
+                        structHash = ethers.utils.keccak256(abiCoder.encode(["bytes32", "uint24", "uint16", "address", "uint64"], [TRADE_BROKER_TYPEHASH, iPerpetualId, brokerFeeTbps, traderAddr, iDeadline]));
+                        digest = ethers.utils.keccak256(abiCoder.encode(["bytes32", "bytes32"], [domainSeparator, structHash]));
+                        digestBuffer = Buffer.from(digest.substring(2, digest.length), "hex");
+                        return [4 /*yield*/, signer.signMessage(digestBuffer)];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    // Transfer ownership
+    /**
+     * Transfer ownership of a broker's status to a new wallet. This function transfers the values related to
+     * (i) trading volume and (ii) deposited lots to newAddress. The broker needs in addition to manually transfer
+     * his D8X holdings to newAddress. Until this transfer is completed, the broker will not have his current designation reflected at newAddress.
+     * @param {string} poolSymbolName Pool symbol name (e.g. MATIC, USDC, etc).
+     * @param {string} newAddress The address this broker wants to use from now on.
+     * @example
+     * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(BrokerTool);
+     *   // setup (authentication required, PK is an environment variable with a private key)
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   const pk: string = <string>process.env.PK;
+     *   let brokTool = new BrokerTool(config, pk);
+     *   await brokTool.createProxyInstance();
+     *   // transfer ownership
+     *   let respTransferOwnership = await brokTool.transferOwnership("MATIC", "0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B");
+     *   console.log(respTransferOwnership);
+     * }
+     * main();
+     *
+     * @returns {ethers.providers.TransactionResponse} ethers transaction object
+     */
+    BrokerTool.prototype.transferOwnership = function (poolSymbolName, newAddress) {
+        return __awaiter(this, void 0, void 0, function () {
+            var poolId, tx;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (this.proxyContract == null) {
+                            throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
+                        }
+                        poolId = PerpetualDataHandler._getPoolIdFromSymbol(poolSymbolName, this.poolStaticInfos);
+                        return [4 /*yield*/, this.proxyContract.transferBrokerOwnership(poolId, newAddress, { gasLimit: this.gasLimit })];
+                    case 1:
+                        tx = _a.sent();
+                        return [2 /*return*/, tx];
+                }
+            });
+        });
+    };
+    return BrokerTool;
+}(WriteAccessHandler));
+export default BrokerTool;
+//# sourceMappingURL=brokerTool.js.map

package/dist/esm/brokerTool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"brokerTool.js","sourceRoot":"","sources":["../../src/brokerTool.ts"],"names":[],"mappings":";AAAA,OAAO,kBAAkB,MAAM,sBAAsB,CAAC;AAEtD,OAAO,oBAAoB,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC3C,OAAO,YAAY,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC;;;;;GAKG;AACH;IAAwC,8BAAkB;IACxD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,oBAAmB,MAAqB,EAAE,UAAkB;eAC1D,kBAAM,MAAM,EAAE,UAAU,CAAC;IAC3B,CAAC;IAED,cAAc;IAEd;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,wCAAmB,GAAhC,UAAiC,cAAsB;;;;;;wBACrD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;4BACrD,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;yBACpF;wBACG,MAAM,GAAG,oBAAoB,CAAC,oBAAoB,CAAC,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;wBAC/E,qBAAM,IAAI,CAAC,aAAa,CAAC,mBAAmB,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,EAAA;;wBAA/E,OAAO,GAAG,SAAqE;wBAC/E,GAAG,GAAG,OAAO,GAAG,MAAO,CAAC;wBAC5B,IAAI,GAAG,IAAI,OAAO,EAAE;4BAClB,sBAAO,SAAS,EAAC;yBAClB;wBACD,sBAAO,GAAG,EAAC;;;;KACZ;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACU,+CAA0B,GAAvC,UAAwC,cAAsB,EAAE,IAAa;;;;;;wBAC3E,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;4BACrD,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;yBACpF;6BAGG,CAAA,OAAO,IAAI,IAAI,WAAW,CAAA,EAA1B,wBAA0B;wBACR,qBAAM,IAAI,CAAC,oBAAoB,CAAC,cAAc,CAAC,EAAA;;wBAAnE,iBAAiB,GAAG,SAA+C,CAAC;wBACpE,iBAAiB,GAAG,iBAAiB,GAAG,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;;;wBAElE,iBAAiB,GAAG,IAAI,CAAC;;4BAEb,qBAAM,IAAI,CAAC,aAAa,CAAC,0BAA0B,CAAC,iBAAiB,CAAC,EAAA;;wBAAhF,OAAO,GAAG,SAAsE;wBACpF,sBAAO,OAAO,GAAG,MAAO,EAAC;;;;KAC1B;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACU,0CAAqB,GAAlC,UAAmC,cAAsB;;;;;;wBACvD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;4BACrD,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;yBACpF;wBACG,MAAM,GAAG,oBAAoB,CAAC,oBAAoB,CAAC,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;wBAC/E,qBAAM,IAAI,CAAC,aAAa,CAAC,qBAAqB,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,EAAA;;wBAAjF,OAAO,GAAG,SAAuE;wBACrF,sBAAO,OAAO,GAAG,MAAO,EAAC;;;;KAC1B;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACU,yCAAoB,GAAjC,UAAkC,UAAmB;;;;;;wBACnD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;4BACrD,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;yBACpF;wBACD,IAAI,OAAO,UAAU,IAAI,WAAW,EAAE;4BACpC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;yBAC9B;wBACa,qBAAM,IAAI,CAAC,aAAa,CAAC,oBAAoB,CAAC,UAAU,CAAC,EAAA;;wBAAnE,OAAO,GAAG,SAAyD;wBACvE,sBAAO,OAAO,GAAG,MAAO,EAAC;;;;KAC1B;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACU,yCAAoB,GAAjC,UAAkC,KAAY,EAAE,UAAkB;;;;;;wBAChE,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;4BACrD,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;yBACpF;wBACG,OAAO,GAAG,YAAY,CAAC,oBAAoB,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,CAAC,sBAAsB,CAAC,CAAC;wBAClF,qBAAM,IAAI,CAAC,aAAa,CAAC,oBAAoB,CAAC,OAAO,CAAC,EAAA;;wBAAhE,OAAO,GAAG,SAAsD;wBACpE,sBAAO,OAAO,GAAG,MAAO,EAAC;;;;KAC1B;IAED,SAAS;IAET;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,2CAAsB,GAAnC,UAAoC,cAAsB;;;;;;wBACxD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;4BACrD,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;yBACpF;wBACG,MAAM,GAAG,oBAAoB,CAAC,oBAAoB,CAAC,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;wBAChF,qBAAM,IAAI,CAAC,aAAa,CAAC,sBAAsB,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,EAAA;;wBAAjF,MAAM,GAAG,SAAwE;wBACrF,sBAAO,eAAe,CAAC,MAAM,CAAC,EAAC;;;;KAChC;IAED,OAAO;IAEP;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,+BAAU,GAAvB,UAAwB,cAAsB;;;;;;wBAC5C,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,EAAE;4BAC9B,MAAM,KAAK,CAAC,2DAA2D,CAAC,CAAC;yBAC1E;wBACG,MAAM,GAAG,oBAAoB,CAAC,oBAAoB,CAAC,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;wBAClF,qBAAM,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAA;;wBAAxD,IAAI,GAAG,SAAiD;wBACxD,GAAG,GAAG,eAAe,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;wBACzD,sBAAO,GAAG,EAAC;;;;KACZ;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,yCAAoB,GAAjC,UAAkC,cAAsB;;;;;;wBACtD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;4BACrD,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;yBACpF;wBACG,MAAM,GAAG,oBAAoB,CAAC,oBAAoB,CAAC,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;wBAC3E,qBAAM,IAAI,CAAC,aAAa,CAAC,oBAAoB,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,EAAA;;wBAApF,WAAW,GAAG,SAAsE;wBACxF,sBAAO,WAAW,EAAC;;;;KACpB;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACU,+CAA0B,GAAvC,UAAwC,cAAsB,EAAE,IAAY;;;;;;wBAC1E,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;4BACrD,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;yBACpF;wBACG,MAAM,GAAG,oBAAoB,CAAC,oBAAoB,CAAC,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;wBACpF,qBAAM,IAAI,CAAC,aAAa,CAAC,0BAA0B,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,EAAA;;wBAAnG,EAAE,GAAG,SAA8F;wBACvG,sBAAO,EAAE,EAAC;;;;KACX;IAED,aAAa;IAEb;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACU,8BAAS,GAAtB,UAAuB,KAAY,EAAE,UAAkB;;;;;;wBACrD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;4BACrD,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;yBACpF;wBACD,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;wBACnC,KAAA,KAAK,CAAA;wBAAmB,qBAAM,UAAU,CAAC,UAAU,CACjD,KAAK,CAAC,MAAM,EACZ,KAAK,CAAC,aAAc,EACpB,UAAU,EACV,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAC9B,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,sBAAsB,CAC5B,EAAA;;wBATD,GAAM,eAAe,GAAG,SASvB,CAAC;wBACF,sBAAO,KAAK,EAAC;;;;KACd;IAED;;;;;;;;;OASG;IACU,6CAAwB,GAArC,UACE,UAAkB,EAClB,MAAc,EACd,SAAiB,EACjB,QAAgB;;;;;;wBAEhB,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;4BACrD,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;yBACpF;wBACG,SAAS,GAAG,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;wBACrC,aAAa,GAAG,MAAO,GAAG,SAAS,CAAC;wBACjC,qBAAM,UAAU,CAAC,UAAU,CAChC,MAAM,EACN,aAAa,EACb,UAAU,EACV,SAAS,EACT,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,sBAAsB,CAC5B,EAAA;4BATD,sBAAO,SASN,EAAC;;;;KACH;IAEoB,qBAAU,GAA/B,UACE,MAAc,EACd,aAAqB,EACrB,UAAkB,EAClB,SAAoB,EACpB,MAAqB,EACrB,OAAe,EACf,YAAoB,EACpB,sBAAwD;;;;;;wBAElD,IAAI,GAAG,yBAAyB,CAAC;wBACjC,eAAe,GAAG,MAAM,CAAC,KAAK,CAAC,SAAS,CAC5C,MAAM,CAAC,IAAI,CAAC,qEAAqE,CAAC,CACnF,CAAC;wBACE,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC;wBACxC,eAAe,GAAG,MAAM,CAAC,KAAK,CAAC,SAAS,CAC1C,QAAQ,CAAC,MAAM,CACb,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,CAAC,EAC5C,CAAC,eAAe,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,EAAE,YAAY,CAAC,CACpF,CACF,CAAC;wBAEI,qBAAqB,GAAG,MAAM,CAAC,KAAK,CAAC,SAAS,CAClD,MAAM,CAAC,IAAI,CAAC,qFAAqF,CAAC,CACnG,CAAC;wBACE,YAAY,GAAG,oBAAoB,CAAC,mBAAmB,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;wBACxF,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC,SAAS,CACrC,QAAQ,CAAC,MAAM,CACb,CAAC,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC,EACpD,CAAC,qBAAqB,EAAE,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,SAAS,CAAC,CAC5E,CACF,CAAC;wBAEE,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;wBACxG,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,CAAC;wBACnE,qBAAM,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,EAAA;4BAA7C,sBAAO,SAAsC,EAAC;;;;KAC/C;IAED,qBAAqB;IAErB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACU,sCAAiB,GAA9B,UACE,cAAsB,EACtB,UAAkB;;;;;;wBAElB,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,EAAE;4BAC9B,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;yBACpF;wBACG,MAAM,GAAG,oBAAoB,CAAC,oBAAoB,CAAC,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;wBACpF,qBAAM,IAAI,CAAC,aAAa,CAAC,uBAAuB,CAAC,MAAM,EAAE,UAAU,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,EAAA;;wBAAtG,EAAE,GAAG,SAAiG;wBAC1G,sBAAO,EAAE,EAAC;;;;KACX;IACH,iBAAC;AAAD,CAAC,AA7eD,CAAwC,kBAAkB,GA6ezD"}

package/dist/esm/config/defaultConfig.json

@@ -0,0 +1,47 @@
+[
+    {
+        "name": "testnet",
+        "chainId": 80001,
+        "version": 6,
+        "proxyAddr": "0xDEDf0dd46757cE93E0D9439F78382c0c68cF76C2",
+        "nodeURL": "https://polygon-mumbai.blockpi.network/v1/rpc/public",
+        "priceFeedConfigNetwork": "testnet",
+        "proxyABILocation": "testnet/IPerpetualManager.json",
+        "limitOrderBookFactoryABILocation": "testnet/LimitOrderBookFactory.json",
+        "limitOrderBookABILocation": "testnet/LimitOrderBook.json"
+    },
+    {
+        "name": "mainnet",
+        "chainId": 137,
+        "version": 0,
+        "proxyAddr": "",
+        "nodeURL": "",
+        "priceFeedConfigNetwork": "mainnet",
+        "proxyABILocation": "",
+        "limitOrderBookFactoryAddr": "",
+        "limitOrderBookFactoryABILocation": "",
+        "limitOrderBookABILocation": ""
+    },
+    {
+        "name": "testnet",
+        "chainId": 80001,
+        "version": 5,
+        "proxyAddr": "0x4F1C7EE9E881Cc735f39Ca36c649ba9E930B4E4e",
+        "nodeURL": "https://polygon-mumbai.blockpi.network/v1/rpc/public",
+        "priceFeedConfigNetwork": "testnet",
+        "proxyABILocation": "central-park/IPerpetualManager.json",
+        "limitOrderBookFactoryABILocation": "central-park/LimitOrderBookFactory.json",
+        "limitOrderBookABILocation": "central-park/LimitOrderBook.json"
+    },
+    {
+        "name": "zkevmTestnet",
+        "chainId": 1442,
+        "version": 0,
+        "proxyAddr": "0xb56b81e40e1cDB77bb5Db6C0283e25C27DAE1Be6",
+        "nodeURL": "https://rpc.public.zkevm-test.net ",
+        "priceFeedConfigNetwork": "testnet",
+        "proxyABILocation": "zkevmTestnet/IPerpetualManager.json",
+        "limitOrderBookFactoryABILocation": "zkevmTestnet/LimitOrderBookFactory.json",
+        "limitOrderBookABILocation": "zkevmTestnet/LimitOrderBook.json"
+    }
+]

package/dist/esm/config/mockSwap.json

@@ -0,0 +1,4 @@
+{
+    "0xeB4E22B2AD4D9d07C25A32f57d85a4F41ca6b8FF": "0xe5AD14bFb9D3dEc4dB97f89A782f3578eEE07C38",
+    "0x215975839684a365df2387b1f0FcEaBf4F0B77eb": "0xeb4cd22d2b7451c17Dd03fB34977abF1Becb9053"
+}