@taqueria/plugin-taquito 0.42.3 → 0.42.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +1 -111
  2. package/package.json +2 -2
  3. package/_readme.eta +0 -119
package/README.md CHANGED
@@ -2,114 +2,4 @@
2
2
 
3
3
  The Taquito plugin provides stateful tasks to originate and interact with smart contracts in Tezos sandboxes or testnets
4
4
 
5
- ## Requirements
6
-
7
- - Taqueria v0.26.0 or later
8
- - Node.js v16.16 or later. (v17.x.x or later is not supported)
9
-
10
- ## Installation
11
-
12
- To install the Taquito plugin on a Taqueria project, navigate to the project folder and run:
13
- ```shell
14
- taq install @taqueria/plugin-taquito
15
- ```
16
-
17
- ## Configuration
18
-
19
- 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/config-files/)
20
-
21
- > ### :page_with_curl: Note
22
- > 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
23
-
24
- ## The `taq deploy` task
25
-
26
- Basic usage is:
27
-
28
- ```shell
29
- taq deploy <contractName>
30
- ```
31
-
32
- ### Basic description
33
-
34
- The Taquito plugin exposes a `taq deploy` (or `taq originate`) task in Taqueria which will originate the specified Michelson contract to a Taqueria environment
35
-
36
- This will originate a Michelson `.tz` file in the `artifacts` directory to the default development environment (the sandbox named `local`)
37
-
38
- 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
39
-
40
- 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
41
-
42
- ### Options
43
-
44
- - 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`
45
-
46
- - By default, the amount of mutez sent is `0`. Use the `--mutez` flag to specify an amount you want
47
-
48
- - 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`
49
-
50
- - To provide an alias for the originated contract explicitly, use the `--alias` flag and supply a name
51
-
52
- - 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`
53
-
54
- ## The `taq transfer` task
55
-
56
- Basic usage is:
57
-
58
- ```shell
59
- taq transfer <contract alias or PKH>
60
- ```
61
-
62
- ### Basic description
63
-
64
- 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`)
65
-
66
- This allows interactions from implicit accounts to implicit or smart contract accounts
67
-
68
- ### Options
69
-
70
- - To target a different environment, use the `--env` flag with the named Taqueria environment you want to target
71
-
72
- - By default, the amount of mutez sent is `0`. Use the `--mutez` flag to specify an amount you want
73
-
74
- - 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
75
-
76
- - 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`
77
-
78
- - 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`
79
-
80
- ### Examples
81
-
82
- `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
83
-
84
- `taq transfer tz1VSUr8wwNhLAzempoch5d6hLRiTh8Cjcjb --mutez 20` will transfer `20` mutez to that address, which is some implicit account
85
-
86
- > ### :page_with_curl: Note
87
- > `transfer` and `call` are exactly the same task. They are synonyms
88
-
89
- ## The `taq instantiate-account` task
90
-
91
- Basic usage is:
92
-
93
- ```shell
94
- taq instantiate-account
95
- ```
96
-
97
- ### Basic description
98
-
99
- 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`
100
-
101
- ## The `taq fund` task
102
-
103
- Basic usage is:
104
-
105
- ```shell
106
- taq fund
107
- ```
108
-
109
- ### Basic description
110
-
111
- 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`
112
-
113
- ## Plugin Architecture
114
-
115
- This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK and distributed via NPM
5
+ For more information, please see our documentation for the [Taquito plugin](https://taqueria.io/docs/plugins/plugin-taquito/)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@taqueria/plugin-taquito",
3
- "version": "0.42.3",
3
+ "version": "0.42.6",
4
4
  "description": "A taqueria plugin for originating smart contracts using Taquito",
5
5
  "targets": {
6
6
  "default": {
@@ -42,7 +42,7 @@
42
42
  },
43
43
  "homepage": "https://github.com/pinnacle-labs/taqueria#readme",
44
44
  "dependencies": {
45
- "@taqueria/node-sdk": "^0.42.3",
45
+ "@taqueria/node-sdk": "^0.42.6",
46
46
  "@taquito/michel-codec": "^18.0.0-RC.0",
47
47
  "@taquito/signer": "^18.0.0-RC.0",
48
48
  "@taquito/taquito": "^18.0.0-RC.0",
package/_readme.eta DELETED
@@ -1,119 +0,0 @@
1
- <% if (it.output == "github") { %>
2
- # Taqueria Taquito Plugin
3
- <% } %>
4
-
5
- The Taquito plugin provides stateful tasks to originate and interact with smart contracts in Tezos sandboxes or testnets
6
-
7
- ## Requirements
8
-
9
- - Taqueria v0.26.0 or later
10
- - Node.js v16.16 or later. (v17.x.x or later is not supported)
11
-
12
- ## Installation
13
-
14
- To install the Taquito plugin on a Taqueria project, navigate to the project folder and run:
15
- ```shell
16
- taq install @taqueria/plugin-taquito
17
- ```
18
-
19
- ## Configuration
20
-
21
- 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/config-files/)
22
-
23
- <%~ it.noteOpenAdmonition %>
24
- 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
25
- <%= it.closeAdmonition %>
26
-
27
- ## The `taq deploy` task
28
-
29
- Basic usage is:
30
-
31
- ```shell
32
- taq deploy <contractName>
33
- ```
34
-
35
- ### Basic description
36
-
37
- The Taquito plugin exposes a `taq deploy` (or `taq originate`) task in Taqueria which will originate the specified Michelson contract to a Taqueria environment
38
-
39
- This will originate a Michelson `.tz` file in the `artifacts` directory to the default development environment (the sandbox named `local`)
40
-
41
- 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
42
-
43
- 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
44
-
45
- ### Options
46
-
47
- - 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`
48
-
49
- - By default, the amount of mutez sent is `0`. Use the `--mutez` flag to specify an amount you want
50
-
51
- - 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`
52
-
53
- - To provide an alias for the originated contract explicitly, use the `--alias` flag and supply a name
54
-
55
- - 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`
56
-
57
- ## The `taq transfer` task
58
-
59
- Basic usage is:
60
-
61
- ```shell
62
- taq transfer <contract alias or PKH>
63
- ```
64
-
65
- ### Basic description
66
-
67
- 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`)
68
-
69
- This allows interactions from implicit accounts to implicit or smart contract accounts
70
-
71
- ### Options
72
-
73
- - To target a different environment, use the `--env` flag with the named Taqueria environment you want to target
74
-
75
- - By default, the amount of mutez sent is `0`. Use the `--mutez` flag to specify an amount you want
76
-
77
- - 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
78
-
79
- - 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`
80
-
81
- - 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`
82
-
83
- ### Examples
84
-
85
- `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
86
-
87
- `taq transfer tz1VSUr8wwNhLAzempoch5d6hLRiTh8Cjcjb --mutez 20` will transfer `20` mutez to that address, which is some implicit account
88
-
89
- <%~ it.noteOpenAdmonition %>
90
- `transfer` and `call` are exactly the same task. They are synonyms
91
- <%= it.closeAdmonition %>
92
-
93
- ## The `taq instantiate-account` task
94
-
95
- Basic usage is:
96
-
97
- ```shell
98
- taq instantiate-account
99
- ```
100
-
101
- ### Basic description
102
-
103
- 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`
104
-
105
- ## The `taq fund` task
106
-
107
- Basic usage is:
108
-
109
- ```shell
110
- taq fund
111
- ```
112
-
113
- ### Basic description
114
-
115
- 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`
116
-
117
- ## Plugin Architecture
118
-
119
- This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK and distributed via NPM