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

package/dist/esm/index.mjs

@@ -0,0 +1,378 @@
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { CLIParam, CLIDisplay, CLIOptions, CLIUtils, CLIBase } from '@twin.org/cli-core';
+import { buildCommandMnemonic, buildCommandAddress } from '@twin.org/crypto-cli';
+import { buildCommandFaucet } from '@twin.org/wallet-cli';
+import { I18n, Converter, StringHelper, Is } from '@twin.org/core';
+import { IotaNftConnector, IotaNftUtils } from '@twin.org/nft-connector-iota';
+import { VaultConnectorFactory } from '@twin.org/vault-models';
+import { Command } from 'commander';
+import { MemoryEntityStorageConnector } from '@twin.org/entity-storage-connector-memory';
+import { EntityStorageConnectorFactory } from '@twin.org/entity-storage-models';
+import { initSchema, EntityStorageVaultConnector } from '@twin.org/vault-connector-entity-storage';
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Setup the vault for use in the CLI commands.
+ */
+function setupVault() {
+    initSchema();
+    EntityStorageConnectorFactory.register("vault-key", () => new MemoryEntityStorageConnector({
+        entitySchema: "VaultKey"
+    }));
+    EntityStorageConnectorFactory.register("vault-secret", () => new MemoryEntityStorageConnector({
+        entitySchema: "VaultSecret"
+    }));
+    const vaultConnector = new EntityStorageVaultConnector();
+    VaultConnectorFactory.register("vault", () => vaultConnector);
+}
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Build the nft burn command for the CLI.
+ * @returns The command.
+ */
+function buildCommandNftBurn() {
+    const command = new Command();
+    command
+        .name("nft-burn")
+        .summary(I18n.formatMessage("commands.nft-burn.summary"))
+        .description(I18n.formatMessage("commands.nft-burn.description"))
+        .requiredOption(I18n.formatMessage("commands.nft-burn.options.seed.param"), I18n.formatMessage("commands.nft-burn.options.seed.description"))
+        .requiredOption(I18n.formatMessage("commands.nft-burn.options.issuer.param"), I18n.formatMessage("commands.nft-burn.options.issuer.description"))
+        .requiredOption(I18n.formatMessage("commands.nft-burn.options.id.param"), I18n.formatMessage("commands.nft-burn.options.id.description"));
+    command
+        .option(I18n.formatMessage("commands.common.options.node.param"), I18n.formatMessage("commands.common.options.node.description"), "!NODE_URL")
+        .option(I18n.formatMessage("commands.common.options.explorer.param"), I18n.formatMessage("commands.common.options.explorer.description"), "!EXPLORER_URL")
+        .action(actionCommandNftBurn);
+    return 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.node The node URL.
+ * @param opts.explorer The explorer URL.
+ */
+async function actionCommandNftBurn(opts) {
+    const seed = CLIParam.hexBase64("seed", opts.seed);
+    const issuer = CLIParam.bech32("issuer", opts.issuer);
+    const id = CLIParam.stringValue("id", opts.id);
+    const nodeEndpoint = CLIParam.url("node", opts.node);
+    const explorerEndpoint = CLIParam.url("explorer", opts.explorer);
+    CLIDisplay.value(I18n.formatMessage("commands.nft-burn.labels.issuer"), issuer);
+    CLIDisplay.value(I18n.formatMessage("commands.nft-burn.labels.nftId"), id);
+    CLIDisplay.value(I18n.formatMessage("commands.common.labels.node"), nodeEndpoint);
+    CLIDisplay.break();
+    setupVault();
+    const localIdentity = "local";
+    const vaultSeedId = "local-seed";
+    const vaultConnector = VaultConnectorFactory.get("vault");
+    await vaultConnector.setSecret(`${localIdentity}/${vaultSeedId}`, Converter.bytesToBase64(seed));
+    const iotaNftConnector = new IotaNftConnector({
+        config: {
+            clientOptions: {
+                nodes: [nodeEndpoint],
+                localPow: true
+            },
+            vaultSeedId
+        }
+    });
+    CLIDisplay.task(I18n.formatMessage("commands.nft-burn.progress.burningNft"));
+    CLIDisplay.break();
+    CLIDisplay.spinnerStart();
+    await iotaNftConnector.burn(localIdentity, id);
+    CLIDisplay.spinnerStop();
+    CLIDisplay.value(I18n.formatMessage("commands.common.labels.explore"), `${StringHelper.trimTrailingSlashes(explorerEndpoint)}/addr/${IotaNftUtils.nftIdToAddress(id)}`);
+    CLIDisplay.break();
+    CLIDisplay.done();
+}
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Build the nft mint command for the CLI.
+ * @returns The command.
+ */
+function buildCommandNftMint() {
+    const command = new Command();
+    command
+        .name("nft-mint")
+        .summary(I18n.formatMessage("commands.nft-mint.summary"))
+        .description(I18n.formatMessage("commands.nft-mint.description"))
+        .requiredOption(I18n.formatMessage("commands.nft-mint.options.seed.param"), I18n.formatMessage("commands.nft-mint.options.seed.description"))
+        .requiredOption(I18n.formatMessage("commands.nft-mint.options.issuer.param"), I18n.formatMessage("commands.nft-mint.options.issuer.description"))
+        .requiredOption(I18n.formatMessage("commands.nft-mint.options.tag.param"), I18n.formatMessage("commands.nft-mint.options.tag.description"))
+        .option(I18n.formatMessage("commands.nft-mint.options.immutable-json.param"), I18n.formatMessage("commands.nft-mint.options.immutable-json.description"))
+        .option(I18n.formatMessage("commands.nft-mint.options.mutable-json.param"), I18n.formatMessage("commands.nft-mint.options.mutable-json.description"));
+    CLIOptions.output(command, {
+        noConsole: true,
+        json: true,
+        env: true,
+        mergeJson: true,
+        mergeEnv: true
+    });
+    command
+        .option(I18n.formatMessage("commands.common.options.node.param"), I18n.formatMessage("commands.common.options.node.description"), "!NODE_URL")
+        .option(I18n.formatMessage("commands.common.options.explorer.param"), I18n.formatMessage("commands.common.options.explorer.description"), "!EXPLORER_URL")
+        .action(actionCommandNftMint);
+    return 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.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.node The node URL.
+ * @param opts.explorer The explorer URL.
+ */
+async function actionCommandNftMint(opts) {
+    const seed = CLIParam.hexBase64("seed", opts.seed);
+    const issuer = CLIParam.bech32("issuer", opts.issuer);
+    const tag = CLIParam.stringValue("tag", opts.tag);
+    const immutableJson = opts.immutableJson
+        ? path.resolve(opts.immutableJson)
+        : undefined;
+    const mutableJson = opts.mutableJson
+        ? path.resolve(opts.mutableJson)
+        : undefined;
+    const nodeEndpoint = CLIParam.url("node", opts.node);
+    const explorerEndpoint = CLIParam.url("explorer", opts.explorer);
+    CLIDisplay.value(I18n.formatMessage("commands.nft-mint.labels.issuer"), issuer);
+    CLIDisplay.value(I18n.formatMessage("commands.nft-mint.labels.tag"), tag);
+    if (Is.stringValue(immutableJson)) {
+        CLIDisplay.value(I18n.formatMessage("commands.nft-mint.labels.immutableJsonFilename"), immutableJson);
+    }
+    if (Is.stringValue(mutableJson)) {
+        CLIDisplay.value(I18n.formatMessage("commands.nft-mint.labels.mutableJsonFilename"), mutableJson);
+    }
+    CLIDisplay.value(I18n.formatMessage("commands.common.labels.node"), nodeEndpoint);
+    CLIDisplay.break();
+    setupVault();
+    const localIdentity = "local";
+    const vaultSeedId = "local-seed";
+    const vaultConnector = VaultConnectorFactory.get("vault");
+    await vaultConnector.setSecret(`${localIdentity}/${vaultSeedId}`, Converter.bytesToBase64(seed));
+    const iotaNftConnector = new IotaNftConnector({
+        config: {
+            clientOptions: {
+                nodes: [nodeEndpoint],
+                localPow: true
+            },
+            vaultSeedId
+        }
+    });
+    const immutableJsonData = Is.stringValue(immutableJson)
+        ? await CLIUtils.readJsonFile(immutableJson)
+        : undefined;
+    const mutableJsonData = Is.stringValue(mutableJson)
+        ? await CLIUtils.readJsonFile(mutableJson)
+        : undefined;
+    if (Is.object(immutableJsonData)) {
+        CLIDisplay.section(I18n.formatMessage("commands.nft-mint.labels.immutableJson"));
+        CLIDisplay.json(immutableJsonData);
+        CLIDisplay.break();
+    }
+    if (Is.object(mutableJsonData)) {
+        CLIDisplay.section(I18n.formatMessage("commands.nft-mint.labels.mutableJson"));
+        CLIDisplay.json(mutableJsonData);
+        CLIDisplay.break();
+    }
+    CLIDisplay.task(I18n.formatMessage("commands.nft-mint.progress.mintingNft"));
+    CLIDisplay.break();
+    CLIDisplay.spinnerStart();
+    const nftId = await iotaNftConnector.mint(localIdentity, issuer, tag, immutableJsonData, mutableJsonData);
+    CLIDisplay.spinnerStop();
+    if (opts.console) {
+        CLIDisplay.value(I18n.formatMessage("commands.nft-mint.labels.nftId"), nftId);
+        CLIDisplay.break();
+    }
+    if (Is.stringValue(opts?.json)) {
+        await CLIUtils.writeJsonFile(opts.json, { nftId }, opts.mergeJson);
+    }
+    if (Is.stringValue(opts?.env)) {
+        await CLIUtils.writeEnvFile(opts.env, [`NFT_ID="${nftId}"`], opts.mergeEnv);
+    }
+    CLIDisplay.value(I18n.formatMessage("commands.common.labels.explore"), `${StringHelper.trimTrailingSlashes(explorerEndpoint)}/addr/${IotaNftUtils.nftIdToAddress(nftId)}`);
+    CLIDisplay.break();
+    CLIDisplay.done();
+}
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Build the nft resolve command for the CLI.
+ * @returns The command.
+ */
+function buildCommandNftResolve() {
+    const command = new Command();
+    command
+        .name("nft-resolve")
+        .summary(I18n.formatMessage("commands.nft-resolve.summary"))
+        .description(I18n.formatMessage("commands.nft-resolve.description"))
+        .requiredOption(I18n.formatMessage("commands.nft-resolve.options.id.param"), I18n.formatMessage("commands.nft-resolve.options.id.description"));
+    CLIOptions.output(command, {
+        noConsole: true,
+        json: true,
+        env: false,
+        mergeJson: true,
+        mergeEnv: false
+    });
+    command
+        .option(I18n.formatMessage("commands.common.options.node.param"), I18n.formatMessage("commands.common.options.node.description"), "!NODE_URL")
+        .option(I18n.formatMessage("commands.common.options.explorer.param"), I18n.formatMessage("commands.common.options.explorer.description"), "!EXPLORER_URL")
+        .action(actionCommandNftResolve);
+    return 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.node The node URL.
+ * @param opts.explorer The explorer URL.
+ */
+async function actionCommandNftResolve(opts) {
+    const id = CLIParam.stringValue("id", opts.id);
+    const nodeEndpoint = CLIParam.url("node", opts.node);
+    const explorerEndpoint = CLIParam.url("explorer", opts.explorer);
+    CLIDisplay.value(I18n.formatMessage("commands.nft-resolve.labels.nftId"), id);
+    CLIDisplay.value(I18n.formatMessage("commands.common.labels.node"), nodeEndpoint);
+    CLIDisplay.break();
+    setupVault();
+    const iotaNftConnector = new IotaNftConnector({
+        config: {
+            clientOptions: {
+                nodes: [nodeEndpoint],
+                localPow: true
+            }
+        }
+    });
+    CLIDisplay.task(I18n.formatMessage("commands.nft-resolve.progress.resolvingNft"));
+    CLIDisplay.break();
+    CLIDisplay.spinnerStart();
+    const nft = await iotaNftConnector.resolve(id);
+    CLIDisplay.spinnerStop();
+    if (opts.console) {
+        CLIDisplay.section(I18n.formatMessage("commands.nft-resolve.labels.nft"));
+        CLIDisplay.json(nft);
+        CLIDisplay.break();
+    }
+    if (Is.stringValue(opts?.json)) {
+        await CLIUtils.writeJsonFile(opts.json, nft, opts.mergeJson);
+    }
+    CLIDisplay.value(I18n.formatMessage("commands.common.labels.explore"), `${StringHelper.trimTrailingSlashes(explorerEndpoint)}/addr/${IotaNftUtils.nftIdToAddress(id)}`);
+    CLIDisplay.break();
+    CLIDisplay.done();
+}
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Build the nft transfer command for the CLI.
+ * @returns The command.
+ */
+function buildCommandNftTransfer() {
+    const command = new Command();
+    command
+        .name("nft-transfer")
+        .summary(I18n.formatMessage("commands.nft-transfer.summary"))
+        .description(I18n.formatMessage("commands.nft-transfer.description"))
+        .requiredOption(I18n.formatMessage("commands.nft-transfer.options.seed.param"), I18n.formatMessage("commands.nft-transfer.options.seed.description"))
+        .requiredOption(I18n.formatMessage("commands.nft-transfer.options.id.param"), I18n.formatMessage("commands.nft-transfer.options.id.description"))
+        .requiredOption(I18n.formatMessage("commands.nft-transfer.options.recipient.param"), I18n.formatMessage("commands.nft-transfer.options.recipient.description"));
+    command
+        .option(I18n.formatMessage("commands.common.options.node.param"), I18n.formatMessage("commands.common.options.node.description"), "!NODE_URL")
+        .option(I18n.formatMessage("commands.common.options.explorer.param"), I18n.formatMessage("commands.common.options.explorer.description"), "!EXPLORER_URL")
+        .action(actionCommandNftTransfer);
+    return command;
+}
+/**
+ * Action the nft transfer 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.node The node URL.
+ * @param opts.explorer The explorer URL.
+ */
+async function actionCommandNftTransfer(opts) {
+    const seed = CLIParam.hexBase64("seed", opts.seed);
+    const id = CLIParam.stringValue("id", opts.id);
+    const recipient = CLIParam.bech32("recipient", opts.recipient);
+    const nodeEndpoint = CLIParam.url("node", opts.node);
+    const explorerEndpoint = CLIParam.url("explorer", opts.explorer);
+    CLIDisplay.value(I18n.formatMessage("commands.nft-transfer.labels.nftId"), id);
+    CLIDisplay.value(I18n.formatMessage("commands.nft-transfer.labels.recipient"), recipient);
+    CLIDisplay.value(I18n.formatMessage("commands.common.labels.node"), nodeEndpoint);
+    CLIDisplay.break();
+    setupVault();
+    const localIdentity = "local";
+    const vaultSeedId = "local-seed";
+    const vaultConnector = VaultConnectorFactory.get("vault");
+    await vaultConnector.setSecret(`${localIdentity}/${vaultSeedId}`, Converter.bytesToBase64(seed));
+    const iotaNftConnector = new IotaNftConnector({
+        config: {
+            clientOptions: {
+                nodes: [nodeEndpoint],
+                localPow: true
+            },
+            vaultSeedId
+        }
+    });
+    CLIDisplay.task(I18n.formatMessage("commands.nft-transfer.progress.transferringNft"));
+    CLIDisplay.break();
+    CLIDisplay.spinnerStart();
+    await iotaNftConnector.transfer(localIdentity, id, recipient);
+    CLIDisplay.spinnerStop();
+    CLIDisplay.value(I18n.formatMessage("commands.common.labels.explore"), `${StringHelper.trimTrailingSlashes(explorerEndpoint)}/addr/${IotaNftUtils.nftIdToAddress(id)}`);
+    CLIDisplay.break();
+    CLIDisplay.done();
+}
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The main entry point for the CLI.
+ */
+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.
+     * @returns The exit code.
+     */
+    async run(argv, localesDirectory) {
+        return this.execute({
+            title: "TWIN NFT",
+            appName: "twin-nft",
+            version: "0.0.1-next.3",
+            icon: "🌍",
+            supportsEnvFiles: true
+        }, localesDirectory ?? path.join(path.dirname(fileURLToPath(import.meta.url)), "../locales"), argv);
+    }
+    /**
+     * Get the commands for the CLI.
+     * @param program The main program to add the commands to.
+     * @internal
+     */
+    getCommands(program) {
+        return [
+            buildCommandMnemonic(),
+            buildCommandAddress(),
+            buildCommandFaucet(),
+            buildCommandNftMint(),
+            buildCommandNftResolve(),
+            buildCommandNftBurn(),
+            buildCommandNftTransfer()
+        ];
+    }
+}
+
+export { CLI, actionCommandNftBurn, actionCommandNftMint, actionCommandNftResolve, actionCommandNftTransfer, buildCommandNftBurn, buildCommandNftMint, buildCommandNftResolve, buildCommandNftTransfer };