@taqueria/plugin-taquito 0.22.2 → 0.23.0-rc.2

package/README.md

@@ -18,6 +18,9 @@ taq install @taqueria/plugin-taquito
 
 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](/docs/config/networks/)
 
+> ### :page_with_curl: 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 originate` task
 
 Basic usage is:
@@ -40,10 +43,14 @@ After origination, an alias will be created to refer to the originated contract'
 
 - 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:
@@ -62,21 +69,47 @@ This allows interactions from implicit accounts to implicit or smart contract ac
 
 - To target a different environment, use the `--env` flag with the named Taqueria environment you want to target
 
-- By default, the amount of tez sent is `0`. Use the `--tez` flag to specify an amount you want
+- 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` tez
+`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 --tez 20` will transfer `20` tez to that address, which is some implicit account
+`taq transfer tz1VSUr8wwNhLAzempoch5d6hLRiTh8Cjcjb --mutez 20` will transfer `20` mutez to that address, which is some implicit account
 
 > ### :page_with_curl: Note
 > `transfer` and `call` are exactly the same task. They are synonyms
 
+##  The `taq instantiate-account` task
+
+Basic usage is:
+
+```shell
+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:
+
+```shell
+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

package/_readme.eta

@@ -20,6 +20,10 @@ taq install @taqueria/plugin-taquito
 
 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](/docs/config/networks/)
 
+<%~ it.noteOpenAdmonition %>
+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
+<%= it.closeAdmonition %>
+
 ##  The `taq originate` task
 
 Basic usage is:
@@ -42,10 +46,14 @@ After origination, an alias will be created to refer to the originated contract'
 
 - 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:
@@ -64,22 +72,48 @@ This allows interactions from implicit accounts to implicit or smart contract ac
 
 - To target a different environment, use the `--env` flag with the named Taqueria environment you want to target
 
-- By default, the amount of tez sent is `0`. Use the `--tez` flag to specify an amount you want
+- 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` tez
+`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 --tez 20` will transfer `20` tez to that address, which is some implicit account
+`taq transfer tz1VSUr8wwNhLAzempoch5d6hLRiTh8Cjcjb --mutez 20` will transfer `20` mutez to that address, which is some implicit account
 
 <%~ it.noteOpenAdmonition %>
 `transfer` and `call` are exactly the same task. They are synonyms
 <%= it.closeAdmonition %>
 
+##  The `taq instantiate-account` task
+
+Basic usage is:
+
+```shell
+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:
+
+```shell
+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

package/common.ts

@@ -0,0 +1,194 @@
+import {
+	getAccountPrivateKey,
+	getDefaultSandboxAccount,
+	getNetworkConfig,
+	getSandboxConfig,
+	sendAsyncErr,
+	TAQ_OPERATOR_ACCOUNT,
+} from '@taqueria/node-sdk';
+import { Environment, NetworkConfig, RequestArgs, SandboxAccountConfig, SandboxConfig } from '@taqueria/node-sdk/types';
+import { importKey, InMemorySigner } from '@taquito/signer';
+import { TezosToolkit } from '@taquito/taquito';
+
+export interface OriginateOpts extends RequestArgs.ProxyRequestArgs {
+	contract: string;
+	storage: string;
+	alias?: string;
+	sender?: string;
+	mutez?: string;
+}
+
+export interface TransferOpts extends RequestArgs.ProxyRequestArgs {
+	contract: string;
+	mutez?: string;
+	param?: string;
+	entrypoint?: string;
+	sender?: string;
+}
+
+export interface InstantiateAccountOpts extends RequestArgs.ProxyRequestArgs {
+}
+
+export interface FundOpts extends RequestArgs.ProxyRequestArgs {
+}
+
+// To be used for the main entrypoint of the plugin
+export type IntersectionOpts = OriginateOpts & TransferOpts & InstantiateAccountOpts & FundOpts;
+
+// To be used for common functions in this file
+type UnionOpts = OriginateOpts | TransferOpts | InstantiateAccountOpts | FundOpts;
+
+export const getEnvTypeAndNodeConfig = (
+	parsedArgs: UnionOpts,
+	env: Environment.t,
+): Promise<['Network', NetworkConfig.t] | ['Sandbox', SandboxConfig.t]> => {
+	const targetConstraintErrMsg = 'Each environment can only have one target, be it a network or a sandbox';
+	if (env.networks?.length === 1 && env.sandboxes?.length === 1) return sendAsyncErr(targetConstraintErrMsg);
+	if (env.networks?.length === 1) {
+		const networkName = env.networks[0];
+		const network = getNetworkConfig(parsedArgs)(networkName);
+		if (!network) {
+			return sendAsyncErr(
+				`The current environment is configured to use a network called '${networkName}'; however, no network of this name has been configured in .taq/config.json`,
+			);
+		}
+		return Promise.resolve(['Network', network]);
+	}
+	if (env.sandboxes?.length === 1) {
+		const sandboxName = env.sandboxes[0];
+		const sandbox = getSandboxConfig(parsedArgs)(sandboxName);
+		if (!sandbox) {
+			return sendAsyncErr(
+				`The current environment is configured to use a sandbox called '${sandboxName}'; however, no sandbox of this name has been configured in .taq/config.json`,
+			);
+		}
+		return Promise.resolve(['Sandbox', sandbox]);
+	}
+	return sendAsyncErr(targetConstraintErrMsg);
+};
+
+export const configureToolKitForSandbox = async (sandbox: SandboxConfig.t, sender?: string): Promise<TezosToolkit> => {
+	let accountKey: string;
+	if (sender && sender !== 'default') {
+		const accounts = getSandboxInstantiatedAccounts(sandbox);
+		if (accounts.hasOwnProperty(sender)) {
+			accountKey = accounts[sender].secretKey;
+		} else {
+			return sendAsyncErr(
+				`${sender} is not an account instantiated in the current environment. Check .taq/config.json`,
+			);
+		}
+	} else {
+		const defaultAccount = getDefaultSandboxAccount(sandbox);
+		if (!defaultAccount) {
+			return sendAsyncErr(
+				`No default account is specified in the sandbox to perform the operation. Please use the --sender flag to explicitly specify the account to use as the sender of the operation`,
+			);
+		}
+		accountKey = defaultAccount.secretKey;
+	}
+
+	const tezos = new TezosToolkit(sandbox.rpcUrl as string);
+	tezos.setProvider({ signer: new InMemorySigner(accountKey.replace(/^unencrypted:/, '')) });
+	return tezos;
+};
+
+export const configureToolKitForNetwork = async (
+	parsedArgs: UnionOpts,
+	network: NetworkConfig.t,
+	sender?: string,
+): Promise<TezosToolkit> => {
+	let account: string;
+	if (sender && sender !== TAQ_OPERATOR_ACCOUNT) {
+		const accounts = getNetworkInstantiatedAccounts(network);
+		if (accounts.hasOwnProperty(sender)) {
+			account = sender;
+		} else {
+			return sendAsyncErr(
+				`${sender} is not an account instantiated in the current environment. Check .taq/config.json`,
+			);
+		}
+	} else {
+		account = TAQ_OPERATOR_ACCOUNT;
+	}
+
+	const tezos = new TezosToolkit(network.rpcUrl as string);
+	const key = await getAccountPrivateKey(parsedArgs, network, account);
+	await importKey(tezos, key);
+	return tezos;
+};
+
+export const getDeclaredAccounts = (parsedArgs: UnionOpts): Record<string, number> =>
+	Object.entries(parsedArgs.config.accounts).reduce(
+		(acc, declaredAccount) => {
+			const alias: string = declaredAccount[0];
+			const mutez: string | number = declaredAccount[1];
+			return {
+				...acc,
+				[alias]: typeof mutez === 'string' ? parseFloat(mutez) : mutez,
+			};
+		},
+		{} as Record<string, number>,
+	);
+
+export const getSandboxInstantiatedAccounts = (sandbox: SandboxConfig.t): Record<string, SandboxAccountConfig.t> =>
+	(sandbox?.accounts)
+		? Object.entries(sandbox.accounts).reduce(
+			(acc, instantiatedAccount) => {
+				const alias: string = instantiatedAccount[0];
+				const keys = instantiatedAccount[1];
+				return alias !== 'default'
+					? {
+						...acc,
+						[alias]: keys,
+					}
+					: acc;
+			},
+			{},
+		)
+		: {};
+
+export const getNetworkInstantiatedAccounts = (network: NetworkConfig.t): Record<string, any> =>
+	network.accounts
+		? Object.entries(network.accounts).reduce(
+			(acc, instantiatedAccount) => {
+				const alias: string = instantiatedAccount[0];
+				const keys = instantiatedAccount[1];
+				return alias !== TAQ_OPERATOR_ACCOUNT
+					? {
+						...acc,
+						[alias]: keys,
+					}
+					: acc;
+			},
+			{},
+		)
+		: {};
+
+export const generateAccountKeys = async (
+	parsedArgs: UnionOpts,
+	network: NetworkConfig.t,
+	account: string,
+): Promise<void> => {
+	const tezos = new TezosToolkit(network.rpcUrl as string);
+	const key = await getAccountPrivateKey(parsedArgs, network, account);
+	await importKey(tezos, key);
+};
+
+export const handleOpsError = (err: unknown, env: string): Promise<never> => {
+	if (err instanceof Error) {
+		const msg = err.message;
+		if (/ENOTFOUND/.test(msg)) return sendAsyncErr('The RPC URL may be invalid. Check ./.taq/config.json');
+		if (/ECONNREFUSED/.test(msg)) return sendAsyncErr('The RPC URL may be down or the sandbox is not running');
+		if (/empty_implicit_contract/.test(msg)) {
+			const result = msg.match(/(?<="implicit":")tz[^"]+(?=")/);
+			const publicKeyHash = result ? result[0] : undefined;
+			if (publicKeyHash) {
+				return sendAsyncErr(
+					`The account ${publicKeyHash} for the target environment, "${env}", may not be funded\nTo fund this account:\n1. Go to https://teztnets.xyz and click "Faucet" of the target testnet\n2. Copy and paste the above key into the wallet address field\n3. Request some Tez (Note that you might need to wait for a few seconds for the network to register the funds)`,
+				);
+			}
+		}
+	}
+	return sendAsyncErr(`Error while performing operation:\n${err} ${JSON.stringify(err, null, 2)}`);
+};

package/fund.ts

@@ -0,0 +1,92 @@
+import {
+	getCurrentEnvironment,
+	getCurrentEnvironmentConfig,
+	sendAsyncErr,
+	sendJsonRes,
+	sendWarn,
+} from '@taqueria/node-sdk';
+import { TezosToolkit } from '@taquito/taquito';
+import {
+	configureToolKitForNetwork,
+	FundOpts as Opts,
+	getDeclaredAccounts,
+	getEnvTypeAndNodeConfig,
+	getNetworkInstantiatedAccounts,
+} from './common';
+import { ContractInfo, performTransferOps } from './transfer';
+
+type TableRow = {
+	accountAlias: string;
+	accountAddress: string;
+	mutezFunded: string;
+};
+
+const getAccountsInfo = (
+	parsedArgs: Opts,
+	tezos: TezosToolkit,
+	instantiatedAccounts: Record<string, any>,
+): Promise<ContractInfo[]> =>
+	Promise.all(
+		Object.entries(instantiatedAccounts)
+			.map(async (instantiatedAccount: [string, any]) => {
+				const alias = instantiatedAccount[0];
+				const aliasInfo = instantiatedAccount[1];
+
+				const declaredMutez: number | undefined = getDeclaredAccounts(parsedArgs)[alias];
+				const currentBalanceInMutez = (await tezos.tz.getBalance(aliasInfo.publicKeyHash)).toNumber();
+				const amountToFillInMutez = declaredMutez ? Math.max(declaredMutez - currentBalanceInMutez, 0) : 0;
+
+				if (!declaredMutez) {
+					sendWarn(
+						`Warning: ${alias} is instantiated in the target environment but not declared in the root level "accounts" field of ./.taq/config.json so ${alias} will not be funded as you don't have a declared tez amount set there for ${alias}\n`,
+					);
+				}
+
+				return {
+					contractAlias: alias,
+					contractAddress: aliasInfo.publicKeyHash,
+					parameter: 'Unit',
+					entrypoint: 'default',
+					mutezTransfer: parseInt(amountToFillInMutez.toString()),
+				};
+			}),
+	)
+		.then(accountsInfo => accountsInfo.filter(accountInfo => accountInfo.mutezTransfer !== 0))
+		.catch(err => sendAsyncErr(`Something went wrong while extracting account information - ${err}`));
+
+const prepAccountsInfoForDisplay = (accountsInfo: ContractInfo[]): TableRow[] =>
+	accountsInfo.map(accountInfo => {
+		return {
+			accountAlias: accountInfo.contractAlias,
+			accountAddress: accountInfo.contractAddress,
+			mutezFunded: accountInfo.mutezTransfer.toString(),
+		};
+	});
+
+const fund = async (parsedArgs: Opts): Promise<void> => {
+	const env = getCurrentEnvironmentConfig(parsedArgs);
+	if (!env) return sendAsyncErr(`There is no environment called ${parsedArgs.env} in your config.json`);
+	try {
+		const [envType, nodeConfig] = await getEnvTypeAndNodeConfig(parsedArgs, env);
+		if (envType !== 'Network') return sendAsyncErr('taq fund can only be executed in a network environment');
+		const tezos = await configureToolKitForNetwork(parsedArgs, nodeConfig);
+
+		const instantiatedAccounts = getNetworkInstantiatedAccounts(nodeConfig);
+
+		const accountsInfo = await getAccountsInfo(parsedArgs, tezos, instantiatedAccounts);
+		if (accountsInfo.length === 0) {
+			return sendJsonRes(
+				`All instantiated accounts in the current environment, "${parsedArgs.env}", are funded up to or beyond the declared amount`,
+			);
+		}
+
+		await performTransferOps(tezos, getCurrentEnvironment(parsedArgs), accountsInfo);
+
+		const accountsInfoForDisplay = prepAccountsInfoForDisplay(accountsInfo);
+		return sendJsonRes(accountsInfoForDisplay);
+	} catch {
+		return sendAsyncErr('No operations performed');
+	}
+};
+
+export default fund;