@twin.org/nft-cli 0.0.1-next.3 → 0.0.1-next.31

package/dist/types/cli.d.ts

@@ -7,7 +7,11 @@ export declare class CLI extends CLIBase {
      * Run the app.
      * @param argv The process arguments.
      * @param localesDirectory The directory for the locales, default to relative to the script.
+     * @param options Additional options for the CLI.
+     * @param options.overrideOutputWidth Override the output width.
      * @returns The exit code.
      */
-    run(argv: string[], localesDirectory?: string): Promise<number>;
+    run(argv: string[], localesDirectory?: string, options?: {
+        overrideOutputWidth?: number;
+    }): Promise<number>;
 }

package/dist/types/commands/nftBurn.d.ts

@@ -1,4 +1,5 @@
 import { Command } from "commander";
+import { NftConnectorTypes } from "../models/nftConnectorTypes";
 /**
  * Build the nft burn command for the CLI.
  * @returns The command.
@@ -8,15 +9,17 @@ export declare function buildCommandNftBurn(): Command;
  * Action the nft burn command.
  * @param opts The options for the command.
  * @param opts.seed The seed required for signing by the issuer.
- * @param opts.issuer The issuer address of the NFT.
  * @param opts.id The id of the NFT to burn in urn format.
+ * @param opts.connector The connector to perform the operations with.
  * @param opts.node The node URL.
+ * @param opts.network The network to use for connector.
  * @param opts.explorer The explorer URL.
  */
 export declare function actionCommandNftBurn(opts: {
     seed: string;
-    issuer: string;
     id: string;
+    connector?: NftConnectorTypes;
     node: string;
+    network?: string;
     explorer: string;
 }): Promise<void>;

package/dist/types/commands/nftMint.d.ts

@@ -1,5 +1,6 @@
 import { type CliOutputOptions } from "@twin.org/cli-core";
 import { Command } from "commander";
+import { NftConnectorTypes } from "../models/nftConnectorTypes";
 /**
  * Build the nft mint command for the CLI.
  * @returns The command.
@@ -9,19 +10,25 @@ export declare function buildCommandNftMint(): Command;
  * Action the nft mint command.
  * @param opts The options for the command.
  * @param opts.seed The seed required for signing by the issuer.
- * @param opts.issuer The issuer address of the NFT.
+ * @param opts.issuer The identity of the issuer.
+ * @param opts.walletAddressIndex The wallet address index.
  * @param opts.tag The tag for the NFT.
  * @param opts.immutableJson Filename of the immutable JSON data.
  * @param opts.mutableJson Filename of the mutable JSON data.
+ * @param opts.connector The connector to perform the operations with.
  * @param opts.node The node URL.
+ * @param opts.network The network to use for connector.
  * @param opts.explorer The explorer URL.
  */
 export declare function actionCommandNftMint(opts: {
     seed: string;
     issuer: string;
+    walletAddressIndex?: string;
     tag: string;
     immutableJson?: string;
     mutableJson?: string;
+    connector?: NftConnectorTypes;
     node: string;
+    network?: string;
     explorer: string;
 } & CliOutputOptions): Promise<void>;

package/dist/types/commands/nftResolve.d.ts

@@ -1,5 +1,6 @@
 import { type CliOutputOptions } from "@twin.org/cli-core";
 import { Command } from "commander";
+import { NftConnectorTypes } from "../models/nftConnectorTypes";
 /**
  * Build the nft resolve command for the CLI.
  * @returns The command.
@@ -9,11 +10,15 @@ export declare function buildCommandNftResolve(): Command;
  * Action the nft resolve command.
  * @param opts The options for the command.
  * @param opts.id The id of the NFT to resolve in urn format.
+ * @param opts.connector The connector to perform the operations with.
  * @param opts.node The node URL.
+ * @param opts.network The network to use for connector.
  * @param opts.explorer The explorer URL.
  */
 export declare function actionCommandNftResolve(opts: {
     id: string;
+    connector?: NftConnectorTypes;
     node: string;
+    network?: string;
     explorer: string;
 } & CliOutputOptions): Promise<void>;

package/dist/types/commands/nftTransfer.d.ts

@@ -1,4 +1,5 @@
 import { Command } from "commander";
+import { NftConnectorTypes } from "../models/nftConnectorTypes";
 /**
  * Build the nft transfer command for the CLI.
  * @returns The command.
@@ -9,14 +10,20 @@ export declare function buildCommandNftTransfer(): Command;
  * @param opts The options for the command.
  * @param opts.seed The seed required for signing by the issuer.
  * @param opts.id The id of the NFT to transfer in urn format.
- * @param opts.recipient The recipient address of the NFT.
+ * @param opts.recipientIdentity The recipient address of the NFT.
+ * @param opts.recipientAddress The recipient address of the NFT.
+ * @param opts.connector The connector to perform the operations with.
  * @param opts.node The node URL.
+ * @param opts.network The network to use for connector.
  * @param opts.explorer The explorer URL.
  */
 export declare function actionCommandNftTransfer(opts: {
     seed: string;
     id: string;
-    recipient: string;
+    recipientIdentity: string;
+    recipientAddress: string;
+    connector?: NftConnectorTypes;
     node: string;
+    network?: string;
     explorer: string;
 }): Promise<void>;

package/dist/types/commands/setupCommands.d.ts

@@ -1,4 +1,22 @@
+import type { INftConnector } from "@twin.org/nft-models";
+import { NftConnectorTypes } from "../models/nftConnectorTypes";
 /**
  * Setup the vault for use in the CLI commands.
  */
 export declare function setupVault(): void;
+/**
+ * Setup the NFT connector for use in the CLI commands.
+ * @param options The options for the NFT connector.
+ * @param options.nodeEndpoint The node endpoint.
+ * @param options.network The network.
+ * @param options.vaultSeedId The vault seed ID.
+ * @param options.walletAddressIndex The wallet address index.
+ * @param connector The connector to use.
+ * @returns The NFT connector.
+ */
+export declare function setupNftConnector(options: {
+    nodeEndpoint: string;
+    network?: string;
+    vaultSeedId?: string;
+    walletAddressIndex?: number;
+}, connector?: NftConnectorTypes): INftConnector;

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,13 @@
+/**
+ * The NFT connector types.
+ */
+export declare const NftConnectorTypes: {
+    /**
+     * IOTA.
+     */
+    readonly Iota: "iota";
+};
+/**
+ * The NFT connector types.
+ */
+export type NftConnectorTypes = (typeof NftConnectorTypes)[keyof typeof NftConnectorTypes];

package/docs/changelog.md

@@ -1,5 +1,117 @@
 # @twin.org/nft-cli - Changelog
 
-## v0.0.1-next.3
+## [0.0.1-next.31](https://github.com/twinfoundation/nft/compare/nft-cli-v0.0.1-next.30...nft-cli-v0.0.1-next.31) (2025-06-12)
+
+
+### Features
+
+* update dependencies ([8660f76](https://github.com/twinfoundation/nft/commit/8660f76ca324b0f476e45544cac6bee4b3146c3b))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nft-connector-iota bumped from 0.0.1-next.30 to 0.0.1-next.31
+
+## [0.0.1-next.30](https://github.com/twinfoundation/nft/compare/nft-cli-v0.0.1-next.29...nft-cli-v0.0.1-next.30) (2025-05-22)
+
+
+### Miscellaneous Chores
+
+* **nft-cli:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nft-connector-iota bumped from 0.0.1-next.29 to 0.0.1-next.30
+
+## [0.0.1-next.29](https://github.com/twinfoundation/nft/compare/nft-cli-v0.0.1-next.28...nft-cli-v0.0.1-next.29) (2025-05-21)
+
+
+### Features
+
+* update dlt packages ([12c4966](https://github.com/twinfoundation/nft/commit/12c4966bceb926b7cdcf1449165bee09187a426c))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nft-connector-iota bumped from 0.0.1-next.28 to 0.0.1-next.29
+
+## [0.0.1-next.28](https://github.com/twinfoundation/nft/compare/nft-cli-v0.0.1-next.27...nft-cli-v0.0.1-next.28) (2025-05-06)
+
+
+### Features
+
+* iota rebased release ([8d05d1f](https://github.com/twinfoundation/nft/commit/8d05d1f58c1aacac983c100697ab40a314ad34ea))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nft-connector-iota bumped from 0.0.1-next.27 to 0.0.1-next.28
+
+## [0.0.1-next.27](https://github.com/twinfoundation/nft/compare/nft-cli-v0.0.1-next.26...nft-cli-v0.0.1-next.27) (2025-04-24)
+
+
+### Miscellaneous Chores
+
+* **nft-cli:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nft-connector-iota bumped from 0.0.1-next.26 to 0.0.1-next.27
+
+## [0.0.1-next.26](https://github.com/twinfoundation/nft/compare/nft-cli-v0.0.1-next.25...nft-cli-v0.0.1-next.26) (2025-04-17)
+
+
+### Features
+
+* use shared store mechanism ([#16](https://github.com/twinfoundation/nft/issues/16)) ([897bc78](https://github.com/twinfoundation/nft/commit/897bc7805248ba1388b2dd03df24c33f1633f344))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nft-connector-iota bumped from 0.0.1-next.25 to 0.0.1-next.26
+
+## [0.0.1-next.25](https://github.com/twinfoundation/nft/compare/nft-cli-v0.0.1-next.24...nft-cli-v0.0.1-next.25) (2025-04-17)
+
+
+### Miscellaneous Chores
+
+* **nft-cli:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nft-connector-iota bumped from 0.0.1-next.24 to 0.0.1-next.25
+
+## [0.0.1-next.24](https://github.com/twinfoundation/nft/compare/nft-cli-v0.0.1-next.23...nft-cli-v0.0.1-next.24) (2025-03-28)
+
+
+### Features
+
+* add publish workflows ([3f2ae6b](https://github.com/twinfoundation/nft/commit/3f2ae6b5c29da8012e01ef719c2d91a6aa80c2ad))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nft-connector-iota bumped from 0.0.1-next.23 to 0.0.1-next.24
+
+## v0.0.1-next.23
 
 - Initial Release

package/docs/examples.md

@@ -1,20 +1,21 @@
 # @twin.org/nft-cli - Examples
 
-## Command Line Tool
+## Running
 
-First install the tool with the following script.
+To install and run the CLI locally use the following commands:
 
 ```shell
-npm install @twin.org/nft-cli
+npm install @twin.org/nft-cli -g
+twin-nft
 ```
 
-Running the tool with no commands will provide help for all the commands. By issuing the following command you should see the result.
+or run directly using NPX:
 
 ```shell
-twin-nft
+npx "@twin.org/nft-cli"
 ```
 
-Output
+You should see output similar to the following:
 
 ```shell
 🌍 TWIN NFT v1.0.0
@@ -29,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.
@@ -54,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.
@@ -83,12 +84,12 @@ twin-nft mnemonic --env wallet.env
 twin-nft address --load-env wallet.env --hrp tst --seed !SEED --count 4 --env wallet.env --merge-env
 ```
 
-To run this on the IOTA testnet you will need an env file with the following settings. Store the following config as config.env
+To run this on the IOTA devnet you will need an env file with the following settings. Store the following config as config.env
 
 ```shell
-NODE_URL="https://api.testnet.iotaledger.net"
-FAUCET_URL="https://faucet.testnet.iotaledger.net/api/enqueue"
-EXPLORER_URL="https://explorer.iota.org/iota-testnet/"
+NODE_URL="https://api.devnet.iota.cafe"
+FAUCET_URL="https://faucet.devnet.iota.cafe"
+EXPLORER_URL="https://explorer.iota.org/?network=devnet"
 ```
 
 We also need to create a JSON file containing the immutable metadata for the NFT. The following JSON file follows the IRC27 standard for NFT data. Save this file as `immutable.json` to use in the following scripts.
@@ -110,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
@@ -129,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
@@ -137,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/classes/CLI.md

@@ -8,13 +8,13 @@ The main entry point for the CLI.
 
 ## Constructors
 
-### new CLI()
+### Constructor
 
-> **new CLI**(): [`CLI`](CLI.md)
+> **new CLI**(): `CLI`
 
 #### Returns
 
-[`CLI`](CLI.md)
+`CLI`
 
 #### Inherited from
 
@@ -24,20 +24,34 @@ The main entry point for the CLI.
 
 ### run()
 
-> **run**(`argv`, `localesDirectory`?): `Promise`\<`number`\>
+> **run**(`argv`, `localesDirectory?`, `options?`): `Promise`\<`number`\>
 
 Run the app.
 
 #### Parameters
 
-• **argv**: `string`[]
+##### argv
+
+`string`[]
 
 The process arguments.
 
-• **localesDirectory?**: `string`
+##### localesDirectory?
+
+`string`
 
 The directory for the locales, default to relative to the script.
 
+##### options?
+
+Additional options for the CLI.
+
+###### overrideOutputWidth?
+
+`number`
+
+Override the output width.
+
 #### Returns
 
 `Promise`\<`number`\>

package/docs/reference/functions/actionCommandNftBurn.md

@@ -6,27 +6,43 @@ Action the nft burn command.
 
 ## Parameters
 
-• **opts**
+### opts
 
 The options for the command.
 
-• **opts.seed**: `string`
+#### seed
 
-The seed required for signing by the issuer.
+`string`
 
-• **opts.issuer**: `string`
+The seed required for signing by the issuer.
 
-The issuer address of the NFT.
+#### id
 
-• **opts.id**: `string`
+`string`
 
 The id of the NFT to burn in urn format.
 
-• **opts.node**: `string`
+#### connector?
+
+`"iota"`
+
+The connector to perform the operations with.
+
+#### node
+
+`string`
 
 The node URL.
 
-• **opts.explorer**: `string`
+#### network?
+
+`string`
+
+The network to use for connector.
+
+#### explorer
+
+`string`
 
 The explorer URL.
 

package/docs/reference/functions/actionCommandNftMint.md

@@ -6,7 +6,9 @@ Action the nft mint command.
 
 ## Parameters
 
-• **opts**: `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
+### opts
+
+`object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
 
 The options for the command.
 

package/docs/reference/functions/actionCommandNftResolve.md

@@ -6,7 +6,9 @@ Action the nft resolve command.
 
 ## Parameters
 
-• **opts**: `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
+### opts
+
+`object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
 
 The options for the command.
 

package/docs/reference/functions/actionCommandNftTransfer.md

@@ -6,27 +6,55 @@ Action the nft transfer command.
 
 ## Parameters
 
-• **opts**
+### opts
 
 The options for the command.
 
-• **opts.seed**: `string`
+#### seed
+
+`string`
 
 The seed required for signing by the issuer.
 
-• **opts.id**: `string`
+#### id
+
+`string`
 
 The id of the NFT to transfer in urn format.
 
-• **opts.recipient**: `string`
+#### recipientIdentity
+
+`string`
+
+The recipient address of the NFT.
+
+#### recipientAddress
+
+`string`
 
 The recipient address of the NFT.
 
-• **opts.node**: `string`
+#### connector?
+
+`"iota"`
+
+The connector to perform the operations with.
+
+#### node
+
+`string`
 
 The node URL.
 
-• **opts.explorer**: `string`
+#### network?
+
+`string`
+
+The network to use for connector.
+
+#### explorer
+
+`string`
 
 The explorer URL.
 

package/docs/reference/functions/setupNftConnector.md

@@ -0,0 +1,47 @@
+# 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.
+
+#### walletAddressIndex?
+
+`number`
+
+The wallet address index.
+
+### connector?
+
+`"iota"`
+
+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,13 @@
+# Variable: NftConnectorTypes
+
+> `const` **NftConnectorTypes**: `object`
+
+The NFT connector types.
+
+## Type declaration
+
+### Iota
+
+> `readonly` **Iota**: `"iota"` = `"iota"`
+
+IOTA.