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

    12.1.1 • Public • Published

    Taquito Signer package

    Documentation can be found here
    TypeDoc style documentation is available on-line here

    @taquito/signer is an npm package that provides developers with signing functionality for Taquito.

    General Information

    The Inmemory signer is a local signer implementation that allows you to directly use a private key in your browser or your nodejs app. When the InMemorySigner is configured, all Taquito functionalities that need signing support can be used. The operation will be signed automatically using the signer (no prompt).

    This signer implementation is for development workflows.

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

    Install

    npm i --save @taquito/taquito
    npm i --save @taquito/signer
    

    Usage

    Loading an unencrypted private key

    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('edsk...') });

    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://teztnets.xyz/) for working with a public testnet, use the importKey function.

    import { TezosToolkit } from '@taquito/taquito';
    import { importKey } from '@taquito/signer';
    
    const Tezos = new TezosToolkit('https://YOUR_PREFERRED_TESTNET_RPC_URL');
    
    // A key faucet, similar to what is available from https://teztnets.xyz/
    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.

    Additional info

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

    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

    34,651

    Version

    12.1.1

    License

    MIT

    Unpacked Size

    121 kB

    Total Files

    26

    Last publish

    Collaborators

    • jevonearth
    • carte7000
    • roxaneletourneau