@twin.org/nft-cli 0.0.2-next.8 → 0.0.3-next.1

package/dist/esm/index.mjs

@@ -1,427 +0,0 @@
-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 { setupWalletConnector, WalletConnectorTypes, buildCommandFaucet } from '@twin.org/wallet-cli';
-import { I18n, Is, Converter, StringHelper } from '@twin.org/core';
-import { IotaNftConnector, IotaNftUtils } from '@twin.org/nft-connector-iota';
-import { VaultConnectorFactory } from '@twin.org/vault-models';
-import { WalletConnectorFactory } from '@twin.org/wallet-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);
-}
-/**
- * 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.
- * @returns The NFT connector.
- */
-function setupNftConnector(options) {
-    return new IotaNftConnector({
-        config: {
-            clientOptions: {
-                url: options.nodeEndpoint
-            },
-            network: options.network ?? "",
-            vaultSeedId: options.vaultSeedId,
-            walletAddressIndex: options.walletAddressIndex ?? 0
-        }
-    });
-}
-
-// 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.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.network.param"), I18n.formatMessage("commands.common.options.network.description"), "!NETWORK")
-        .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.id The id of the NFT to burn in urn format.
- * @param opts.node The node URL.
- * @param opts.network The network to use for connector.
- * @param opts.explorer The explorer URL.
- */
-async function actionCommandNftBurn(opts) {
-    const seed = CLIParam.hexBase64("seed", opts.seed);
-    const id = CLIParam.stringValue("id", opts.id);
-    const nodeEndpoint = CLIParam.url("node", opts.node);
-    const network = CLIParam.stringValue("network", opts.network);
-    const explorerEndpoint = CLIParam.url("explorer", opts.explorer);
-    CLIDisplay.value(I18n.formatMessage("commands.nft-burn.labels.nftId"), id);
-    CLIDisplay.value(I18n.formatMessage("commands.common.labels.node"), nodeEndpoint);
-    if (Is.stringValue(network)) {
-        CLIDisplay.value(I18n.formatMessage("commands.common.labels.network"), network);
-    }
-    CLIDisplay.break();
-    setupVault();
-    const localIdentity = "local";
-    const vaultSeedId = "local-seed";
-    const vaultConnector = VaultConnectorFactory.get("vault");
-    await vaultConnector.setSecret(`${localIdentity}/${vaultSeedId}`, Converter.bytesToBase64(seed));
-    const walletConnector = setupWalletConnector({ nodeEndpoint, network, vaultSeedId }, WalletConnectorTypes.Iota);
-    WalletConnectorFactory.register("wallet", () => walletConnector);
-    const nftConnector = setupNftConnector({ nodeEndpoint, network, vaultSeedId });
-    if (Is.function(nftConnector.start)) {
-        await nftConnector.start(localIdentity);
-    }
-    CLIDisplay.task(I18n.formatMessage("commands.nft-burn.progress.burningNft"));
-    CLIDisplay.break();
-    CLIDisplay.spinnerStart();
-    await nftConnector.burn(localIdentity, id);
-    CLIDisplay.spinnerStop();
-    CLIDisplay.value(I18n.formatMessage("commands.common.labels.explore"), `${StringHelper.trimTrailingSlashes(explorerEndpoint)}/object/${IotaNftUtils.nftIdToObjectId(id)}?network=${network}`);
-    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"))
-        .option(I18n.formatMessage("commands.nft-mint.options.wallet-address-index.param"), I18n.formatMessage("commands.nft-mint.options.wallet-address-index.description"), "0")
-        .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.network.param"), I18n.formatMessage("commands.common.options.network.description"), "!NETWORK")
-        .option(I18n.formatMessage("commands.common.options.explorer.param"), I18n.formatMessage("commands.common.options.explorer.description"), "!EXPLORER_URL")
-        .option(I18n.formatMessage("commands.common.options.node.param"), I18n.formatMessage("commands.common.options.node.description"), "!NODE_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 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.node The node URL.
- * @param opts.network The network to use for connector.
- * @param opts.explorer The explorer URL.
- */
-async function actionCommandNftMint(opts) {
-    const seed = CLIParam.hexBase64("seed", opts.seed);
-    const issuer = CLIParam.stringValue("issuer", opts.issuer);
-    const walletAddressIndex = Is.empty(opts.walletAddressIndex)
-        ? undefined
-        : CLIParam.integer("wallet-address-index", opts.walletAddressIndex);
-    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 network = CLIParam.stringValue("network", opts.network);
-    const explorerEndpoint = CLIParam.url("explorer", opts.explorer);
-    CLIDisplay.value(I18n.formatMessage("commands.nft-mint.labels.issuer"), issuer);
-    if (Is.integer(walletAddressIndex)) {
-        CLIDisplay.value(I18n.formatMessage("commands.nft-mint.labels.walletAddressIndex"), walletAddressIndex);
-    }
-    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);
-    if (Is.stringValue(network)) {
-        CLIDisplay.value(I18n.formatMessage("commands.common.labels.network"), network);
-    }
-    CLIDisplay.break();
-    setupVault();
-    const localIdentity = issuer;
-    const vaultSeedId = "local-seed";
-    const vaultConnector = VaultConnectorFactory.get("vault");
-    await vaultConnector.setSecret(`${localIdentity}/${vaultSeedId}`, Converter.bytesToBase64(seed));
-    const walletConnector = setupWalletConnector({ nodeEndpoint, network, vaultSeedId }, WalletConnectorTypes.Iota);
-    WalletConnectorFactory.register("wallet", () => walletConnector);
-    const nftConnector = setupNftConnector({
-        nodeEndpoint,
-        network,
-        vaultSeedId,
-        walletAddressIndex
-    });
-    if (Is.function(nftConnector.start)) {
-        await nftConnector.start(localIdentity);
-    }
-    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 nftConnector.mint(localIdentity, 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)}/object/${IotaNftUtils.nftIdToObjectId(nftId)}?network=${network}`);
-    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.network.param"), I18n.formatMessage("commands.common.options.network.description"), "!NETWORK")
-        .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.network The network to use for connector.
- * @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 network = CLIParam.stringValue("network", opts.network);
-    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);
-    if (Is.stringValue(network)) {
-        CLIDisplay.value(I18n.formatMessage("commands.common.labels.network"), network);
-    }
-    CLIDisplay.break();
-    setupVault();
-    const walletConnector = setupWalletConnector({ nodeEndpoint, network }, WalletConnectorTypes.Iota);
-    WalletConnectorFactory.register("wallet", () => walletConnector);
-    const nftConnector = setupNftConnector({ nodeEndpoint, network });
-    CLIDisplay.task(I18n.formatMessage("commands.nft-resolve.progress.resolvingNft"));
-    CLIDisplay.break();
-    CLIDisplay.spinnerStart();
-    const nft = await nftConnector.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)}/object/${IotaNftUtils.nftIdToObjectId(id)}?network=${network}`);
-    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-identity.param"), I18n.formatMessage("commands.nft-transfer.options.recipient-identity.description"))
-        .requiredOption(I18n.formatMessage("commands.nft-transfer.options.recipient-address.param"), I18n.formatMessage("commands.nft-transfer.options.recipient-address.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.network.param"), I18n.formatMessage("commands.common.options.network.description"), "!NETWORK")
-        .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.recipientIdentity The recipient address of the NFT.
- * @param opts.recipientAddress The recipient address of the NFT.
- * @param opts.node The node URL.
- * @param opts.network The network to use for connector.
- * @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 recipientIdentity = CLIParam.stringValue("recipientIdentity", opts.recipientIdentity);
-    const recipientAddress = Converter.bytesToHex(CLIParam.hex("recipientAddress", opts.recipientAddress), true);
-    const nodeEndpoint = CLIParam.url("node", opts.node);
-    const network = CLIParam.stringValue("network", opts.network);
-    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.recipientIdentity"), recipientIdentity);
-    CLIDisplay.value(I18n.formatMessage("commands.nft-transfer.labels.recipientAddress"), recipientAddress);
-    CLIDisplay.value(I18n.formatMessage("commands.common.labels.node"), nodeEndpoint);
-    if (Is.stringValue(network)) {
-        CLIDisplay.value(I18n.formatMessage("commands.common.labels.network"), network);
-    }
-    CLIDisplay.break();
-    setupVault();
-    const walletConnector = setupWalletConnector({ nodeEndpoint, network }, WalletConnectorTypes.Iota);
-    WalletConnectorFactory.register("wallet", () => walletConnector);
-    const localIdentity = "local";
-    const vaultSeedId = "local-seed";
-    const vaultConnector = VaultConnectorFactory.get("vault");
-    await vaultConnector.setSecret(`${localIdentity}/${vaultSeedId}`, Converter.bytesToBase64(seed));
-    const nftConnector = setupNftConnector({ nodeEndpoint, network, vaultSeedId });
-    if (Is.function(nftConnector.start)) {
-        await nftConnector.start(localIdentity);
-    }
-    CLIDisplay.task(I18n.formatMessage("commands.nft-transfer.progress.transferringNft"));
-    CLIDisplay.break();
-    CLIDisplay.spinnerStart();
-    await nftConnector.transfer(localIdentity, id, recipientIdentity, recipientAddress);
-    CLIDisplay.spinnerStop();
-    CLIDisplay.value(I18n.formatMessage("commands.common.labels.explore"), `${StringHelper.trimTrailingSlashes(explorerEndpoint)}/object/${IotaNftUtils.nftIdToObjectId(id)}?network=${network}`);
-    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.
-     * @param options Additional options for the CLI.
-     * @param options.overrideOutputWidth Override the output width.
-     * @returns The exit code.
-     */
-    async run(argv, localesDirectory, options) {
-        return this.execute({
-            title: "TWIN NFT",
-            appName: "twin-nft",
-            version: "0.0.2-next.8", // x-release-please-version
-            icon: "🌍",
-            supportsEnvFiles: true,
-            overrideOutputWidth: options?.overrideOutputWidth,
-            showDevToolWarning: 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, setupNftConnector, setupVault };