@taqueria/plugin-taquito 0.14.2 → 0.16.0

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 +16 -19
  2. package/_readme.eta +16 -19
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -13,35 +13,32 @@ taq install @taqueria/plugin-taquito
13
13
 
14
14
  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/)
15
15
 
16
- ## Usage
17
-
18
- ### The `taq originate` task
19
-
20
- The Taquito plugin exposes an `taq originate` task in Taqueria which will originate the specified Michelson contract to a Taqueria environment
16
+ ## The `taq originate` task
21
17
 
22
18
  Basic usage is:
23
19
 
24
20
  ```shell
25
- taq originate
21
+ taq originate <filename>
26
22
  ```
27
23
 
28
- This will originate all '.tz' files in the `/artifacts` directory to the default environment (the sandbox named `local`)
24
+ ### Basic description
29
25
 
30
- To target a different environment, use the `--environment` flag with the named Taqueria environment you want to target :
26
+ The Taquito plugin exposes an `taq originate` task in Taqueria which will originate the specified Michelson contract to a Taqueria environment.
31
27
 
32
- ```shell
33
- taq originate -e jakartanetEnv
34
- ```
28
+ This will originate a Michelson `.tz` file in the `/artifacts` directory to the default environment (the sandbox named `local`).
35
29
 
36
- ## Plugin Architecture
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.
37
31
 
38
- This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK
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.
39
33
 
40
- The plugin provides a single task `originate`, used for originating Michelson contracts to a Tezos network:
34
+ ### Options
41
35
 
42
- | attribute | value |
43
- |------------|:-------------------------|
44
- | task | 'deploy' |
45
- | command | 'deploy [contract]` |
46
- | aliases | ['originate'] |
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`.
47
37
 
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`
39
+
40
+ - To provide an alias for the originated contract explicitly, use the `--alias` flag and supply a name.
41
+
42
+ ## Plugin Architecture
43
+
44
+ This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK
package/_readme.eta CHANGED
@@ -15,35 +15,32 @@ taq install @taqueria/plugin-taquito
15
15
 
16
16
  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/)
17
17
 
18
- ## Usage
19
-
20
- ### The `taq originate` task
21
-
22
- The Taquito plugin exposes an `taq originate` task in Taqueria which will originate the specified Michelson contract to a Taqueria environment
18
+ ## The `taq originate` task
23
19
 
24
20
  Basic usage is:
25
21
 
26
22
  ```shell
27
- taq originate
23
+ taq originate <filename>
28
24
  ```
29
25
 
30
- This will originate all '.tz' files in the `/artifacts` directory to the default environment (the sandbox named `local`)
26
+ ### Basic description
31
27
 
32
- To target a different environment, use the `--environment` flag with the named Taqueria environment you want to target :
28
+ The Taquito plugin exposes an `taq originate` task in Taqueria which will originate the specified Michelson contract to a Taqueria environment.
33
29
 
34
- ```shell
35
- taq originate -e jakartanetEnv
36
- ```
30
+ This will originate a Michelson `.tz` file in the `/artifacts` directory to the default environment (the sandbox named `local`).
37
31
 
38
- ## Plugin Architecture
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.
39
33
 
40
- This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK
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.
41
35
 
42
- The plugin provides a single task `originate`, used for originating Michelson contracts to a Tezos network:
36
+ ### Options
43
37
 
44
- | attribute | value |
45
- |------------|:-------------------------|
46
- | task | 'deploy' |
47
- | command | 'deploy [contract]` |
48
- | aliases | ['originate'] |
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`.
49
39
 
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`
41
+
42
+ - To provide an alias for the originated contract explicitly, use the `--alias` flag and supply a name.
43
+
44
+ ## Plugin Architecture
45
+
46
+ This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@taqueria/plugin-taquito",
3
- "version": "0.14.2",
3
+ "version": "0.16.0",
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.14.2",
49
+ "@taqueria/node-sdk": "^0.16.0",
50
50
  "@taquito/signer": "^13.0.1",
51
51
  "@taquito/taquito": "^13.0.1",
52
52
  "fast-glob": "^3.2.11"