@taqueria/plugin-taquito 0.21.13 → 0.21.23

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 +24 -19
  2. package/_readme.eta +24 -19
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -2,6 +2,11 @@
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.20.2 or later
8
+ - Node.js v16.17.1 or later
9
+
5
10
  ## Installation
6
11
 
7
12
  To install the Taquito plugin on a Taqueria project, navigate to the project folder and run:
@@ -18,60 +23,60 @@ The target networks, sandboxes, and environments are configured in the Taqueria
18
23
  Basic usage is:
19
24
 
20
25
  ```shell
21
- taq originate <filename>
26
+ taq originate <contractName>
22
27
  ```
23
28
 
24
29
  ### Basic description
25
30
 
26
- The Taquito plugin exposes a `taq originate` (or `taq deploy`) task in Taqueria which will originate the specified Michelson contract to a Taqueria environment.
31
+ The Taquito plugin exposes a `taq originate` (or `taq deploy`) task in Taqueria which will originate the specified Michelson contract to a Taqueria environment
27
32
 
28
- This will originate a Michelson `.tz` file in the `/artifacts` directory to the default environment (the sandbox named `local`).
33
+ This will originate a Michelson `.tz` file in the `artifacts` directory to the default development environment (the sandbox named `local`)
29
34
 
30
- 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'll not originate the contract. Alternatively, you can explicitly specify a storage file with the `--storage` option described below.
35
+ 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
31
36
 
32
- After origination, an alias will be created to refer to the originated contract's address in `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.
37
+ 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
33
38
 
34
39
  ### Options
35
40
 
36
- - To target a different environment, use the `--env` flag with the named Taqueria environment you want to target. E.g. `taq originate filename -e jakartanetEnv`.
41
+ - 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`
37
42
 
38
- - 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 filename --storage someStorage.tz`
43
+ - 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`
39
44
 
40
- - To provide an alias for the originated contract explicitly, use the `--alias` flag and supply a name.
45
+ - To provide an alias for the originated contract explicitly, use the `--alias` flag and supply a name
41
46
 
42
47
  ## The `taq transfer` task
43
48
 
44
49
  Basic usage is:
45
50
 
46
51
  ```shell
47
- taq transfer <contract alias or address>
52
+ taq transfer <contract alias or PKH>
48
53
  ```
49
54
 
50
55
  ### Basic description
51
56
 
52
- 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`).
57
+ 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`)
53
58
 
54
- This allows interactions from implicit accounts to implicit or smart contract accounts.
59
+ This allows interactions from implicit accounts to implicit or smart contract accounts
55
60
 
56
61
  ### Options
57
62
 
58
- - To target a different environment, use the `--env` flag with the named Taqueria environment you want to target.
63
+ - To target a different environment, use the `--env` flag with the named Taqueria environment you want to target
59
64
 
60
- - By default, the amount of tez sent is `0`. Use the `--tez` flag to specify an amount you want.
65
+ - By default, the amount of tez sent is `0`. Use the `--tez` flag to specify an amount you want
61
66
 
62
- - 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.
67
+ - 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
63
68
 
64
- - 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`.
69
+ - 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`
65
70
 
66
71
  ### Examples
67
72
 
68
- `taq call 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.
73
+ `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
69
74
 
70
- `taq transfer tz1VSUr8wwNhLAzempoch5d6hLRiTh8Cjcjb --tez 20` will transfer `20` tez to that address, which is some implicit account.
75
+ `taq transfer tz1VSUr8wwNhLAzempoch5d6hLRiTh8Cjcjb --tez 20` will transfer `20` tez to that address, which is some implicit account
71
76
 
72
77
  > ### :page_with_curl: Note
73
- > `transfer` and `call` are exactly the same task. They are synonyms.
78
+ > `transfer` and `call` are exactly the same task. They are synonyms
74
79
 
75
80
  ## Plugin Architecture
76
81
 
77
- This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK
82
+ This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK and distributed via NPM
package/_readme.eta CHANGED
@@ -4,6 +4,11 @@
4
4
 
5
5
  The Taquito plugin provides stateful tasks to originate and interact with smart contracts in Tezos sandboxes or testnets
6
6
 
7
+ ## Requirements
8
+
9
+ - Taqueria v0.20.2 or later
10
+ - Node.js v16.17.1 or later
11
+
7
12
  ## Installation
8
13
 
9
14
  To install the Taquito plugin on a Taqueria project, navigate to the project folder and run:
@@ -20,61 +25,61 @@ The target networks, sandboxes, and environments are configured in the Taqueria
20
25
  Basic usage is:
21
26
 
22
27
  ```shell
23
- taq originate <filename>
28
+ taq originate <contractName>
24
29
  ```
25
30
 
26
31
  ### Basic description
27
32
 
28
- The Taquito plugin exposes a `taq originate` (or `taq deploy`) task in Taqueria which will originate the specified Michelson contract to a Taqueria environment.
33
+ The Taquito plugin exposes a `taq originate` (or `taq deploy`) task in Taqueria which will originate the specified Michelson contract to a Taqueria environment
29
34
 
30
- This will originate a Michelson `.tz` file in the `/artifacts` directory to the default environment (the sandbox named `local`).
35
+ This will originate a Michelson `.tz` file in the `artifacts` directory to the default development environment (the sandbox named `local`)
31
36
 
32
- 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'll not originate the contract. Alternatively, you can explicitly specify a storage file with the `--storage` option described below.
37
+ 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
33
38
 
34
- After origination, an alias will be created to refer to the originated contract's address in `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.
39
+ 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
35
40
 
36
41
  ### Options
37
42
 
38
- - To target a different environment, use the `--env` flag with the named Taqueria environment you want to target. E.g. `taq originate filename -e jakartanetEnv`.
43
+ - 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`
39
44
 
40
- - 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 filename --storage someStorage.tz`
45
+ - 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`
41
46
 
42
- - To provide an alias for the originated contract explicitly, use the `--alias` flag and supply a name.
47
+ - To provide an alias for the originated contract explicitly, use the `--alias` flag and supply a name
43
48
 
44
49
  ## The `taq transfer` task
45
50
 
46
51
  Basic usage is:
47
52
 
48
53
  ```shell
49
- taq transfer <contract alias or address>
54
+ taq transfer <contract alias or PKH>
50
55
  ```
51
56
 
52
57
  ### Basic description
53
58
 
54
- 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`).
59
+ 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`)
55
60
 
56
- This allows interactions from implicit accounts to implicit or smart contract accounts.
61
+ This allows interactions from implicit accounts to implicit or smart contract accounts
57
62
 
58
63
  ### Options
59
64
 
60
- - To target a different environment, use the `--env` flag with the named Taqueria environment you want to target.
65
+ - To target a different environment, use the `--env` flag with the named Taqueria environment you want to target
61
66
 
62
- - By default, the amount of tez sent is `0`. Use the `--tez` flag to specify an amount you want.
67
+ - By default, the amount of tez sent is `0`. Use the `--tez` flag to specify an amount you want
63
68
 
64
- - 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.
69
+ - 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
65
70
 
66
- - 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`.
71
+ - 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`
67
72
 
68
73
  ### Examples
69
74
 
70
- `taq call 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.
75
+ `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
71
76
 
72
- `taq transfer tz1VSUr8wwNhLAzempoch5d6hLRiTh8Cjcjb --tez 20` will transfer `20` tez to that address, which is some implicit account.
77
+ `taq transfer tz1VSUr8wwNhLAzempoch5d6hLRiTh8Cjcjb --tez 20` will transfer `20` tez to that address, which is some implicit account
73
78
 
74
79
  <%~ it.noteOpenAdmonition %>
75
- `transfer` and `call` are exactly the same task. They are synonyms.
80
+ `transfer` and `call` are exactly the same task. They are synonyms
76
81
  <%= it.closeAdmonition %>
77
82
 
78
83
  ## Plugin Architecture
79
84
 
80
- This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK
85
+ This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK and distributed via NPM
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@taqueria/plugin-taquito",
3
- "version": "0.21.13",
3
+ "version": "0.21.23",
4
4
  "description": "A taqueria plugin for originating smart contracts using Taquito",
5
5
  "targets": {
6
6
  "default": {
@@ -46,7 +46,7 @@
46
46
  "typescript": "^4.7.2"
47
47
  },
48
48
  "dependencies": {
49
- "@taqueria/node-sdk": "^0.21.13",
49
+ "@taqueria/node-sdk": "^0.21.23",
50
50
  "@taquito/michel-codec": "^13.0.1",
51
51
  "@taquito/signer": "^13.0.1",
52
52
  "@taquito/taquito": "^13.0.1",