@injectivelabs/wallet-core 0.0.2

package/README.md

@@ -0,0 +1,77 @@
+# 🌟 Injective Protocol - Wallet Core
+
+<!-- TODO -->
+
+[![downloads](https://img.shields.io/npm/dm/@injectivelabs/wallet-core.svg)](https://www.npmjs.com/package/@injectivelabs/wallet-core)
+[![npm-version](https://img.shields.io/npm/v/@injectivelabs/wallet-core.svg)](https://www.npmjs.com/package/@injectivelabs/wallet-core)
+[![license](https://img.shields.io/npm/l/express.svg)]()
+
+_Package to use Wallets on Injective via the wallet strategy._
+
+---
+
+## 📚 Installation
+
+```bash
+yarn add @injectivelabs/wallet-core
+```
+
+---
+
+## 📖 Documentation
+
+To instantiate your MsgBroadcaster, you need to pass it an instance of `BaseWalletStrategy`. You can specify any strategy you want in the `BaseWalletStrategy` constructor and pass it to the `MsgBroadcaster`.
+
+```ts
+import { Wallet } from '@injectivelabs/wallet-base'
+import { BaseWalletStrategy } from '@injectivelabs/wallet-core'
+import { PrivateKeyWalletStrategy } from '@injectivelabs/wallet-private-key'
+
+const strategyArgs: WalletStrategyArguments = {} /** define the args */
+const strategyEthArgs: ConcreteEthereumWalletStrategyArgs = {} /** if the wallet is an Ethereum wallet */
+const strategies = {
+  [Wallet.PrivateKey]: new PrivateKeyWalletStrategy(strategyEthArgs)
+}
+
+export const walletStrategy = new BaseWalletStrategy({...strategyArgs, strategies})
+
+const broadcasterArgs: MsgBroadcasterOptions = {} /** define the broadcaster args */
+export const msgBroadcaster = new MsgBroadcaster({...broadcasterArgs, walletStrategy})
+```
+
+Read more and find example usages on our [WalletStrategy Docs](https://docs.ts.injective.network/wallet/wallet-wallet-strategy)
+
+---
+
+## 📜 Contribution
+
+**Contribution guides and practices will be available once there is a stable foundation of the whole package set within the `injective-ts` repo.**
+
+---
+
+## ⛑ Support
+
+Reach out to us at one of the following places!
+
+- Website at <a href="https://injective.com" target="_blank">`injective.com`</a>
+- Twitter at <a href="https://twitter.com/Injective_" target="_blank">`@Injective`</a>
+- Discord at <a href="https://discord.com/invite/NK4qdbv" target="_blank">`Discord`</a>
+- Telegram at <a href="https://t.me/joininjective" target="_blank">`Telegram`</a>
+
+---
+
+## 🔓 License
+
+Copyright © 2021 - 2022 Injective Labs Inc. (https://injectivelabs.org/)
+
+<a href="https://iili.io/mNneZN.md.png"><img src="https://iili.io/mNneZN.md.png" style="width: 300px; max-width: 100%; height: auto" />
+
+Originally released by Injective Labs Inc. under: <br />
+Apache License <br />
+Version 2.0, January 2004 <br />
+http://www.apache.org/licenses/
+
+<p>&nbsp;</p>
+<div align="center">
+  <sub><em>Powering the future of decentralized finance.</em></sub>
+</div>

package/dist/cjs/broadcaster/MsgBroadcaster.d.ts

@@ -0,0 +1,125 @@
+import { TxResponse } from '@injectivelabs/sdk-ts';
+import { NetworkEndpoints } from '@injectivelabs/networks';
+import { ChainId, EthereumChainId } from '@injectivelabs/ts-types';
+import { MsgBroadcasterOptions, MsgBroadcasterTxOptions } from './types';
+import BaseWalletStrategy from '../strategy/BaseWalletStrategy';
+/**
+ * This class is used to broadcast transactions
+ * using the WalletStrategy as a handler
+ * for the sign/broadcast flow of the transactions
+ *
+ * Mainly used for building UI products
+ */
+export declare class MsgBroadcaster {
+    options: MsgBroadcasterOptions;
+    walletStrategy: BaseWalletStrategy;
+    endpoints: NetworkEndpoints;
+    chainId: ChainId;
+    txTimeout: number;
+    simulateTx: boolean;
+    txTimeoutOnFeeDelegation: boolean;
+    ethereumChainId?: EthereumChainId;
+    gasBufferCoefficient: number;
+    constructor(options: MsgBroadcasterOptions);
+    setOptions(options: Partial<MsgBroadcasterOptions>): void;
+    /**
+     * Broadcasting the transaction using the client
+     * side approach for both cosmos and ethereum native wallets
+     *
+     * @param tx
+     * @returns {string} transaction hash
+     */
+    broadcast(tx: MsgBroadcasterTxOptions): Promise<TxResponse>;
+    /**
+     * Broadcasting the transaction using the client
+     * side approach for both cosmos and ethereum native wallets
+     * Note: using EIP712_V2 for Ethereum wallets
+     *
+     * @param tx
+     * @returns {string} transaction hash
+     */
+    broadcastV2(tx: MsgBroadcasterTxOptions): Promise<TxResponse>;
+    /**
+     * Broadcasting the transaction using the feeDelegation
+     * support approach for both cosmos and ethereum native wallets
+     *
+     * @param tx
+     * @returns {string} transaction hash
+     */
+    broadcastWithFeeDelegation(tx: MsgBroadcasterTxOptions): Promise<TxResponse>;
+    /**
+     * Prepare/sign/broadcast transaction using
+     * Ethereum native wallets on the client side.
+     *
+     * Note: Gas estimation not available
+     *
+     * @param tx The transaction that needs to be broadcasted
+     * @returns transaction hash
+     */
+    private broadcastWeb3;
+    /**
+     * Prepare/sign/broadcast transaction using
+     * Ethereum native wallets on the client side.
+     *
+     * Note: Gas estimation not available
+     *
+     * @param tx The transaction that needs to be broadcasted
+     * @returns transaction hash
+     */
+    private broadcastWeb3V2;
+    /**
+     * Prepare/sign/broadcast transaction using
+     * Ethereum native wallets using the Web3Gateway.
+     *
+     * @param tx The transaction that needs to be broadcasted
+     * @returns transaction hash
+     */
+    private broadcastWeb3WithFeeDelegation;
+    /**
+     * Prepare/sign/broadcast transaction using
+     * Cosmos native wallets on the client side.
+     *
+     * @param tx The transaction that needs to be broadcasted
+     * @returns transaction hash
+     */
+    private broadcastCosmos;
+    /**
+     * We use this method only when we want to broadcast a transaction using Ledger on Keplr/Leap for Injective
+     *
+     * Note: Gas estimation not available
+     * @param tx the transaction that needs to be broadcasted
+     */
+    private experimentalBroadcastWalletThroughLedger;
+    /**
+     * Prepare/sign/broadcast transaction using
+     * Cosmos native wallets using the Web3Gateway.
+     *
+     * @param tx The transaction that needs to be broadcasted
+     * @returns transaction hash
+     */
+    private broadcastCosmosWithFeeDelegation;
+    /**
+     * Fetch the fee payer's pub key from the web3 gateway
+     *
+     * Returns a base64 version of it
+     */
+    private fetchFeePayerPubKey;
+    /**
+     * In case we don't want to simulate the transaction
+     * we get the gas limit based on the message type.
+     *
+     * If we want to simulate the transaction we set the
+     * gas limit based on the simulation and add a small multiplier
+     * to be safe (factor of 1.2 as default)
+     */
+    private getTxWithSignersAndStdFee;
+    /**
+     * Create TxRaw and simulate it
+     */
+    private simulateTxRaw;
+    /**
+     * Create TxRaw and simulate it
+     */
+    private simulateTxWithSigners;
+}
+//# sourceMappingURL=MsgBroadcaster.d.ts.map

package/dist/cjs/broadcaster/MsgBroadcaster.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MsgBroadcaster.d.ts","sourceRoot":"","sources":["../../../src/broadcaster/MsgBroadcaster.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,UAAU,EAoBX,MAAM,uBAAuB,CAAA;AAY9B,OAAO,EAEL,gBAAgB,EAEjB,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AAClE,OAAO,EACL,qBAAqB,EACrB,uBAAuB,EAExB,MAAM,SAAS,CAAA;AAYhB,OAAO,kBAAkB,MAAM,gCAAgC,CAAA;AAkB/D;;;;;;GAMG;AACH,qBAAa,cAAc;IAClB,OAAO,EAAE,qBAAqB,CAAA;IAE9B,cAAc,EAAE,kBAAkB,CAAA;IAElC,SAAS,EAAE,gBAAgB,CAAA;IAE3B,OAAO,EAAE,OAAO,CAAA;IAEhB,SAAS,SAA+B;IAExC,UAAU,EAAE,OAAO,CAAO;IAE1B,wBAAwB,EAAE,OAAO,CAAQ;IAEzC,eAAe,CAAC,EAAE,eAAe,CAAA;IAEjC,oBAAoB,EAAE,MAAM,CAAM;gBAE7B,OAAO,EAAE,qBAAqB;IAmB1C,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,qBAAqB,CAAC;IAOlD;;;;;;OAMG;IACG,SAAS,CAAC,EAAE,EAAE,uBAAuB;IAqB3C;;;;;;;OAOG;IACG,WAAW,CAAC,EAAE,EAAE,uBAAuB;IAmB7C;;;;;;OAMG;IACG,0BAA0B,CAAC,EAAE,EAAE,uBAAuB;IAmB5D;;;;;;;;OAQG;YACW,aAAa;IAuG3B;;;;;;;;OAQG;YACW,eAAe;IAsG7B;;;;;;OAMG;YACW,8BAA8B;IA2F5C;;;;;;OAMG;YACW,eAAe;IA8F7B;;;;;OAKG;YACW,wCAAwC;IAoItD;;;;;;OAMG;YACW,gCAAgC;IAqH9C;;;;OAIG;YACW,mBAAmB;IA0BjC;;;;;;;OAOG;YACW,yBAAyB;IAuCvC;;OAEG;YACW,aAAa;IAY3B;;OAEG;YACW,qBAAqB;CAcpC"}