Skip to main content

@taqueria/plugin-taquito

The Taquito plugin provides stateful tasks to originate and interact with smart contracts in Tezos sandboxes or testnets

Requirements​

  • Taqueria v0.42.0 or later
  • Node.js v18.18 or later. (v17.x.x or later is not supported)

Installation​

To install the Taquito plugin on a Taqueria project, navigate to the project folder and run:

taq install @taqueria/plugin-taquito

Configuration​

The target networks, sandboxes, and environments are configured in the Taqueria project's config.json file. For additional information on configuring network, documentation can be found here

note

Network environments have the notion of Taqueria Operator Account. This account is meant to be used internally and it is generated for you if it doesn't already exist. Instructions on how to fund the account is provided by the taq binary when the account is first generated

The taq deploy task​

Basic usage is:

taq deploy <contractName>

Basic description​

The Taquito plugin exposes a taq deploy (or taq originate) task in Taqueria which will originate the specified Michelson contract to a Taqueria environment

This will originate a Michelson .tz file in the artifacts directory to the default development environment (the sandbox named local)

By default, the storage value used for origination will live in a file named CONTRACT.default_storage.tz, in artifacts, where CONTRACT is the name of the contract to originate. If it can't find it, it will not originate the contract. Alternatively, you can explicitly specify a storage file with the --storage option described below

After origination, an alias will be created to refer to the originated contract's address in .taq/config.json, in the targeted environment. By default, the name of the alias will be the name of the contract, without the .tz extension. If this alias already exists in the environment you're originating the contract to, then the address will be overriden with the new address. As such, the alias will always refer to the address of the latest origination of the contract. This facilitates hot reloading when doing dApp development

Options​

  • To target a different environment, use the --env flag with the named Taqueria environment you want to target. E.g. taq originate filename -env kathmandunetEnv

  • By default, the amount of mutez sent is 0. Use the --mutez flag to specify an amount you want

  • To originate a contract with a specific storage value, use the --storage flag and supply the name of the storage file that contains the storage value. E.g. taq originate contractName --storage someStorage.tz

  • To provide an alias for the originated contract explicitly, use the --alias flag and supply a name

  • By default, it uses the Taqueria Operator Account to do the operation, but you may override it with an account of your choice by providing the --sender flag. E.g. --sender alice

The taq transfer task​

Basic usage is:

taq transfer <contract alias or PKH>

Basic description​

The Taquito plugin exposes a taq transfer (or taq call) task in Taqueria which will call the specified Michelson contract deployed to a Taqueria environment (default environment is one with sandbox named local)

This allows interactions from implicit accounts to implicit or smart contract accounts

Options​

  • To target a different environment, use the --env flag with the named Taqueria environment you want to target

  • By default, the amount of mutez sent is 0. Use the --mutez flag to specify an amount you want

  • By default, the parameter is Unit. Use the --param flag to specify a filename, in artifacts, that contains the content of the parameter for the transfer/call

  • By default, the entrypoint is default, which points to no specific annotated entrypoint. Use --entrypoint to specify an annotated entrypoint to call. E.g. if the parameter type of a Michelson contract is (or (or (int %decrement) (int %increment)) (unit %reset)), then there are two ways to call the increment entrypoint, with parameter (Left (Right 14)) or with parameter 14 if your command contains --entrypoint increment

  • By default, it uses the Taqueria Operator Account to do the operation, but you may override it with an account of your choice by providing the --sender flag. E.g. --sender alice

Examples​

taq transfer counter --param counter.parameter.param1.tz will call a smart contract aliased as counter in the default environment with the parameter contained in that .tz file, transferring 0 mutez

taq transfer tz1VSUr8wwNhLAzempoch5d6hLRiTh8Cjcjb --mutez 20 will transfer 20 mutez to that address, which is some implicit account

note

transfer and call are exactly the same task. They are synonyms

The taq instantiate-account task​

Basic usage is:

taq instantiate-account

Basic description​

It instantiates all accounts in the accounts field at the root level of .taq/config.json (referred as "declared accounts") to a target environment. The accounts instantiated are referred as "instantiated accounts". E.g. taq instantiate-account --env testing

The taq fund task​

Basic usage is:

taq fund

Basic description​

It funds all the instantiated accounts in a target environment up to the amount declared in the accounts field at the root level of .taq/config.json where the funder is the Taqueria Operator Account in that environment. E.g. taq fund --env testing

Plugin Architecture​

This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK and distributed via NPM