@taquito/signer
    TypeScript icon, indicating that this package has built-in type declarations

    10.2.1 • Public • Published

    Taquito Signer package

    Storing private keys in memory is suitable for development workflows but risky for production use-cases! Use the InMemorySigner appropriately given your risk profile

    @taquito/signer is an npm package that provides developers with signing functionality for Taquito. It can be injected as follows:

    Loading an unencrypted private key

    If you configure Taquito this way, you will now be able to use every function that needs signing support.

    import { InMemorySigner } from '@taquito/signer';
    import { TezosToolkit } from '@taquito/taquito';
    
    const Tezos = new TezosToolkit('https://YOUR_PREFERRED_RPC_URL');
    
    Tezos.setProvider({ signer: await InMemorySigner.fromSecretKey('your_private_key') });

    Loading an encrypted private key with a passphrase

    If your private key is encrypted, you can specify a passphrase to decrypt it. Doing so will automatically decrypt the key and allow you to use the signer to sign transactions.

    import { InMemorySigner } from '@taquito/signer';
    import { TezosToolkit } from '@taquito/taquito';
    
    const Tezos = new TezosToolkit('https://YOUR_PREFERRED_RPC_URL');
    Tezos.setProvider({
      signer: await InMemorySigner.fromSecretKey('your_private_key', 'your_passphrase'),
    });

    Using a testnet faucet key

    To load a faucet key (available from https://faucet.tzalpha.net/) for working a public testnet use the importKey function. You can do so as follows:

    import { TezosToolkit } from '@taquito/taquito';
    import { importKey } from '@taquito/taquito-signer';
    
    const Tezos = new TezosToolkit('https://YOUR_PREFERRED_TESTNET_RPC_URL');
    
    // A key faucet, similar to what is available from https://faucet.tzalpha.net/
    const FAUCET_KEY = {
      mnemonic: [
        'cart',
        'will',
        'page',
        'bench',
        'notice',
        'leisure',
        'penalty',
        'medal',
        'define',
        'odor',
        'ride',
        'devote',
        'cannon',
        'setup',
        'rescue',
      ],
      secret: '35f266fbf0fca752da1342fdfc745a9c608e7b20',
      amount: '4219352756',
      pkh: 'tz1YBMFg1nLAPxBE6djnCPbMRH5PLXQWt8Mg',
      password: 'Fa26j580dQ',
      email: 'jxmjvauo.guddusns@tezos.example.org',
    };
    
    importKey(
      Tezos,
      FAUCET_KEY.email,
      FAUCET_KEY.password,
      FAUCET_KEY.mnemonic.join(' '),
      FAUCET_KEY.secret
    );
    // Your Tezos instance is now operably configured for signing with the faucet key.

    If you configure Taquito this way, you will now be able to use every function that needs signing support. The operation will be signed automatically using the signer (no prompt)

    See the top-level https://github.com/ecadlabs/taquito file for details on reporting issues, contributing and versioning.

    API Documentation

    TypeDoc style documentation is available on-line here

    Disclaimer

    THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

    Install

    npm i @taquito/signer

    DownloadsWeekly Downloads

    10,566

    Version

    10.2.1

    License

    MIT

    Unpacked Size

    144 kB

    Total Files

    23

    Last publish

    Collaborators

    • jevonearth
    • carte7000
    • roxaneletourneau