@taqueria/plugin-octez-client 0.42.3 → 0.42.5

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 +3 -70
  2. package/package.json +2 -2
  3. package/_readme.eta +0 -78
package/README.md CHANGED
@@ -1,74 +1,7 @@
1
- # Taqueria Tezos Client Plugin
1
+ # Taqueria Octez Client Plugin
2
2
 
3
3
  The Tezos Client plugin provides tasks to analyze contracts including type checking and simulating of Michelson (`.tz`) smart contracts. They both execute against a protocol (currently kathmandu). We'll enable a `--protocol` flag in the future to allow users to specify a protocol to use
4
4
 
5
- ## Requirements
5
+ This plugin was formally caleld the Tezos Client Plugin.
6
6
 
7
- - Taqueria v0.26.0 or later
8
- - Node.js v16.16 or later. (v17.x.x or later is not supported)
9
- - Docker v20.10.12 or later
10
-
11
- ## Installation
12
-
13
- To install the Tezos Client plugin on a Taqueria project, navigate to the project folder and run:
14
- ```shell
15
- taq install @taqueria/plugin-tezos-client
16
- ```
17
-
18
- > ### :page_with_curl: Note
19
- > You can override the Tezos-Client version used by the plugin by creating the environment variable `TAQ_TEZOS_CLIENT_IMAGE` and setting it to your desired Tezos-Client Docker image
20
-
21
- ## The `taq typecheck` task
22
-
23
- Basic usage is:
24
- ```shell
25
- taq typecheck <contractName>
26
- ```
27
-
28
- ### Basic description
29
- This task typechecks a Michelson file in `artifacts` and reports a failure or success
30
-
31
- ## The `taq typecheck-all` task
32
-
33
- Basic usage is:
34
- ```shell
35
- taq typecheck-all
36
- ```
37
-
38
- ### Basic description
39
- Performs the same function as `taq typecheck`, but performs type-checking for all contracts in the `artifacts` directory.
40
-
41
- ## The `taq simulate` task
42
-
43
- Basic usage is:
44
- ```shell
45
- taq simulate <contractName> <--param paramFileName>
46
- ```
47
-
48
- ### Basic description
49
- This task runs a Michelson file in `artifacts` as a simulation and ouputs a result suggesting a failure or success. If it's a success, it shows the updated storage value, emitted operations, and big map differences
50
-
51
- ### Options
52
-
53
- - By default, the storage file it will use to simulate the contract is CONTRACT.default_storage.tz where CONTRACT is the name of the contract. If you wish to specify another storage file in `artifacts`, use the `--storage` flag
54
-
55
- - The `--param` flag is mandatory and you must supply the filename, in `artifacts`, that contains the actual parameter value
56
-
57
- - 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`
58
-
59
- ## The `taq client` task
60
-
61
- Basic usage is:
62
-
63
- ```shell
64
- taq client --command <command to pass to the underlying octez-client binary>
65
- ```
66
-
67
- Wrap the value for the `--command` flag with quotes.
68
-
69
- > ### :page_with_curl: Note
70
- > This task allows you to run arbitrary octez-client native commands, but they might not benefit from the abstractions provided by Taqueria
71
-
72
- ## Plugin Architecture
73
-
74
- This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK and distributed via NPM
7
+ For more information, please see our documentation for the [Octez Client plugin](https://taqueria.io/docs/plugins/plugin-octez-client/)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@taqueria/plugin-octez-client",
3
- "version": "0.42.3",
3
+ "version": "0.42.5",
4
4
  "description": "A taqueria plugin for utilizing octez-client",
5
5
  "targets": {
6
6
  "default": {
@@ -41,7 +41,7 @@
41
41
  },
42
42
  "homepage": "https://github.com/pinnacle-labs/taqueria#readme",
43
43
  "dependencies": {
44
- "@taqueria/node-sdk": "^0.42.3",
44
+ "@taqueria/node-sdk": "^0.42.5",
45
45
  "fast-glob": "^3.3.1"
46
46
  },
47
47
  "devDependencies": {
package/_readme.eta DELETED
@@ -1,78 +0,0 @@
1
- <% if (it.output == "github") { %>
2
- # Taqueria Tezos Client Plugin
3
- <% } %>
4
-
5
- The Tezos Client plugin provides tasks to analyze contracts including type checking and simulating of Michelson (`.tz`) smart contracts. They both execute against a protocol (currently kathmandu). We'll enable a `--protocol` flag in the future to allow users to specify a protocol to use
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
- - Docker v20.10.12 or later
12
-
13
- ## Installation
14
-
15
- To install the Tezos Client plugin on a Taqueria project, navigate to the project folder and run:
16
- ```shell
17
- taq install @taqueria/plugin-tezos-client
18
- ```
19
-
20
- <%~ it.noteOpenAdmonition %>
21
- You can override the Tezos-Client version used by the plugin by creating the environment variable `TAQ_TEZOS_CLIENT_IMAGE` and setting it to your desired Tezos-Client Docker image
22
- <%= it.closeAdmonition %>
23
-
24
- ## The `taq typecheck` task
25
-
26
- Basic usage is:
27
- ```shell
28
- taq typecheck <contractName>
29
- ```
30
-
31
- ### Basic description
32
- This task typechecks a Michelson file in `artifacts` and reports a failure or success
33
-
34
- ## The `taq typecheck-all` task
35
-
36
- Basic usage is:
37
- ```shell
38
- taq typecheck-all
39
- ```
40
-
41
- ### Basic description
42
- Performs the same function as `taq typecheck`, but performs type-checking for all contracts in the `artifacts` directory.
43
-
44
- ## The `taq simulate` task
45
-
46
- Basic usage is:
47
- ```shell
48
- taq simulate <contractName> <--param paramFileName>
49
- ```
50
-
51
- ### Basic description
52
- This task runs a Michelson file in `artifacts` as a simulation and ouputs a result suggesting a failure or success. If it's a success, it shows the updated storage value, emitted operations, and big map differences
53
-
54
- ### Options
55
-
56
- - By default, the storage file it will use to simulate the contract is CONTRACT.default_storage.tz where CONTRACT is the name of the contract. If you wish to specify another storage file in `artifacts`, use the `--storage` flag
57
-
58
- - The `--param` flag is mandatory and you must supply the filename, in `artifacts`, that contains the actual parameter value
59
-
60
- - 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`
61
-
62
- ## The `taq client` task
63
-
64
- Basic usage is:
65
-
66
- ```shell
67
- taq client --command <command to pass to the underlying octez-client binary>
68
- ```
69
-
70
- Wrap the value for the `--command` flag with quotes.
71
-
72
- <%~ it.noteOpenAdmonition %>
73
- This task allows you to run arbitrary octez-client native commands, but they might not benefit from the abstractions provided by Taqueria
74
- <%= it.closeAdmonition %>
75
-
76
- ## Plugin Architecture
77
-
78
- This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK and distributed via NPM