@twin.org/nft-cli 0.0.1-next.12 → 0.0.1-next.15

package/dist/types/index.d.ts

@@ -3,3 +3,5 @@ export * from "./commands/nftBurn";
 export * from "./commands/nftMint";
 export * from "./commands/nftResolve";
 export * from "./commands/nftTransfer";
+export * from "./commands/setupCommands";
+export * from "./models/nftConnectorTypes";

package/dist/types/models/nftConnectorTypes.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The NFT connector types.
+ */
+export declare const NftConnectorTypes: {
+    /**
+     * IOTA.
+     */
+    readonly Iota: "iota";
+    /**
+     * IOTA Rebased.
+     */
+    readonly IotaRebased: "iota-rebased";
+};
+/**
+ * The NFT connector types.
+ */
+export type NftConnectorTypes = (typeof NftConnectorTypes)[keyof typeof NftConnectorTypes];

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/nft-cli - Changelog
 
-## v0.0.1-next.12
+## v0.0.1-next.15
 
 - Initial Release

package/docs/examples.md

@@ -30,7 +30,7 @@ Options:
 
 Commands:
   mnemonic [options]      Create a mnemonic.
-  address [options]       Create bech32 addresses and keys from the seed.
+  address [options]       Create addresses and keys from the seed.
   faucet [options]        Request funds from the faucet.
   nft-mint [options]      Mint an NFT.
   nft-resolve [options]   Resolve an NFT.
@@ -55,7 +55,7 @@ Mint an NFT.
 
 Options:
   --seed <seed>                      The seed for the issuer address in hex or base64 used to fund the minting, or start with ! to read environment variable.
-  --issuer <issuer>                  The bech32 address of the NFT issuer, or start with ! to read environment variable.
+  --issuer <issuer>                  The address of the NFT issuer, or start with ! to read environment variable.
   --tag <tag>                        The tag for the NFT.
   --immutable-json <immutable-json>  A JSON file to read which includes the immutable data for the NFT.
   --mutable-json <mutable-json>      A JSON file to read which includes the mutable data for the NFT.
@@ -111,10 +111,10 @@ To request some funds and mint the NFT you can issue the following commands:
 
 ```shell
 # Fund the controller address from the faucet loading the config and wallet env files
-twin-nft faucet --load-env config.env wallet.env --address !ADDRESS_0_BECH32
+twin-nft faucet --load-env config.env wallet.env --address !ADDRESS_0
 
 # Mint the NFT and store the id in the nft.env file
-twin-nft nft-mint --load-env config.env wallet.env --seed !SEED --issuer !ADDRESS_0_BECH32 --tag MY-NFT --immutable-json immutable.json --env nft.env
+twin-nft nft-mint --load-env config.env wallet.env --seed !SEED --issuer !ADDRESS_0 --tag MY-NFT --immutable-json immutable.json --env nft.env
 ```
 
 ### nft-resolve
@@ -130,7 +130,7 @@ twin-nft nft-resolve --load-env config.env nft.env --id !NFT_ID
 You can transfer the NFT to another address using the following command. You must provide the seed from the current issuer/owner so that it can be unlocked and transferred. In this example we read the nft id from the env file and transfer to the second address we created earlier.
 
 ```shell
-twin-nft nft-transfer --load-env config.env wallet.env nft.env --seed !SEED --id !NFT_ID --recipient !ADDRESS_1_BECH32
+twin-nft nft-transfer --load-env config.env wallet.env nft.env --seed !SEED --id !NFT_ID --recipient !ADDRESS_1
 ```
 
 ### nft-burn
@@ -138,5 +138,5 @@ twin-nft nft-transfer --load-env config.env wallet.env nft.env --seed !SEED --id
 To burn the NFT and reclaim the funds we issue the following command. We still require the seed as we need to transfer the deposit funds back to the issuer/owner.
 
 ```shell
-twin-nft nft-burn --load-env config.env wallet.env nft.env --seed !SEED --issuer !ADDRESS_1_BECH32 --id !NFT_ID
+twin-nft nft-burn --load-env config.env wallet.env nft.env --seed !SEED --issuer !ADDRESS_1 --id !NFT_ID
 ```

package/docs/reference/functions/actionCommandNftBurn.md

@@ -28,12 +28,24 @@ The issuer address of the NFT.
 
 The id of the NFT to burn in urn format.
 
+#### connector
+
+[`NftConnectorTypes`](../type-aliases/NftConnectorTypes.md)
+
+The connector to perform the operations with.
+
 #### node
 
 `string`
 
 The node URL.
 
+#### network
+
+`string`
+
+The network to use for rebased connector.
+
 #### explorer
 
 `string`

package/docs/reference/functions/actionCommandNftTransfer.md

@@ -28,12 +28,24 @@ The id of the NFT to transfer in urn format.
 
 The recipient address of the NFT.
 
+#### connector
+
+[`NftConnectorTypes`](../type-aliases/NftConnectorTypes.md)
+
+The connector to perform the operations with.
+
 #### node
 
 `string`
 
 The node URL.
 
+#### network
+
+`string`
+
+The network to use for rebased connector.
+
 #### explorer
 
 `string`

package/docs/reference/functions/setupNftConnector.md

@@ -0,0 +1,41 @@
+# Function: setupNftConnector()
+
+> **setupNftConnector**(`options`, `connector`?): `INftConnector`
+
+Setup the NFT connector for use in the CLI commands.
+
+## Parameters
+
+### options
+
+The options for the NFT connector.
+
+#### nodeEndpoint
+
+`string`
+
+The node endpoint.
+
+#### network
+
+`string`
+
+The network.
+
+#### vaultSeedId
+
+`string`
+
+The vault seed ID.
+
+### connector?
+
+[`NftConnectorTypes`](../type-aliases/NftConnectorTypes.md)
+
+The connector to use.
+
+## Returns
+
+`INftConnector`
+
+The NFT connector.

package/docs/reference/functions/setupVault.md

@@ -0,0 +1,9 @@
+# Function: setupVault()
+
+> **setupVault**(): `void`
+
+Setup the vault for use in the CLI commands.
+
+## Returns
+
+`void`

package/docs/reference/index.md

@@ -4,6 +4,14 @@
 
 - [CLI](classes/CLI.md)
 
+## Type Aliases
+
+- [NftConnectorTypes](type-aliases/NftConnectorTypes.md)
+
+## Variables
+
+- [NftConnectorTypes](variables/NftConnectorTypes.md)
+
 ## Functions
 
 - [buildCommandNftBurn](functions/buildCommandNftBurn.md)
@@ -14,3 +22,5 @@
 - [actionCommandNftResolve](functions/actionCommandNftResolve.md)
 - [buildCommandNftTransfer](functions/buildCommandNftTransfer.md)
 - [actionCommandNftTransfer](functions/actionCommandNftTransfer.md)
+- [setupVault](functions/setupVault.md)
+- [setupNftConnector](functions/setupNftConnector.md)

package/docs/reference/type-aliases/NftConnectorTypes.md

@@ -0,0 +1,5 @@
+# Type Alias: NftConnectorTypes
+
+> **NftConnectorTypes**: *typeof* [`NftConnectorTypes`](../variables/NftConnectorTypes.md)\[keyof *typeof* [`NftConnectorTypes`](../variables/NftConnectorTypes.md)\]
+
+The NFT connector types.

package/docs/reference/variables/NftConnectorTypes.md

@@ -0,0 +1,19 @@
+# Variable: NftConnectorTypes
+
+> `const` **NftConnectorTypes**: `object`
+
+The NFT connector types.
+
+## Type declaration
+
+### Iota
+
+> `readonly` **Iota**: `"iota"` = `"iota"`
+
+IOTA.
+
+### IotaRebased
+
+> `readonly` **IotaRebased**: `"iota-rebased"` = `"iota-rebased"`
+
+IOTA Rebased.

package/locales/en.json

@@ -10,7 +10,7 @@
 				},
 				"issuer": {
 					"param": "--issuer '<'issuer'>'",
-					"description": "The bech32 address of the NFT issuer, or start with ! to read environment variable."
+					"description": "The address of the NFT issuer, or start with ! to read environment variable."
 				},
 				"tag": {
 					"param": "--tag '<'tag'>'",
@@ -65,7 +65,7 @@
 				},
 				"issuer": {
 					"param": "--issuer '<'issuer'>'",
-					"description": "The bech32 address of the NFT issuer, or start with ! to read environment variable."
+					"description": "The address of the NFT issuer, or start with ! to read environment variable."
 				},
 				"id": {
 					"param": "--id '<'id'>'",
@@ -94,7 +94,7 @@
 				},
 				"recipient": {
 					"param": "--recipient '<'recipient'>'",
-					"description": "The bech32 address of the NFT recipient, or start with ! to read environment variable."
+					"description": "The address of the NFT recipient, or start with ! to read environment variable."
 				}
 			},
 			"progress": {
@@ -107,6 +107,14 @@
 		},
 		"common": {
 			"options": {
+				"connector": {
+					"param": "--connector '<'connector'>'",
+					"description": "The connector to use for the NFT operation."
+				},
+				"network": {
+					"param": "--network '<'network'>'",
+					"description": "The network to use for the NFT operation."
+				},
 				"node": {
 					"param": "--node '<'url'>'",
 					"description": "The url for the node endpoint, or an environment variable name containing the url."
@@ -116,7 +124,9 @@
 				"did": "DID",
 				"node": "Node",
 				"explorer": "Explorer",
-				"explore": "Explore"
+				"explore": "Explore",
+				"connector": "Connector",
+				"network": "Network"
 			}
 		}
 	}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/nft-cli",
-	"version": "0.0.1-next.12",
+	"version": "0.0.1-next.15",
 	"description": "A command line interface for interacting with the nft connectors",
 	"repository": {
 		"type": "git",
@@ -21,20 +21,21 @@
 		"@twin.org/entity": "next",
 		"@twin.org/entity-storage-connector-memory": "next",
 		"@twin.org/nameof": "next",
-		"@twin.org/nft-connector-iota": "0.0.1-next.12",
+		"@twin.org/nft-connector-iota": "0.0.1-next.15",
+		"@twin.org/nft-connector-iota-rebased": "0.0.1-next.15",
 		"@twin.org/vault-connector-entity-storage": "next",
 		"@twin.org/vault-models": "next",
 		"@twin.org/wallet-cli": "next",
-		"commander": "13.0.0"
+		"commander": "13.1.0"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		}
 	},
 	"files": [