parameter_declarations.ts

import { Parameter } from './CLICommand/parameter';

export const WalletFileParameter = 'walletFile';
export const SeedPhraseParameter = 'seedPhrase';
export const PrivateParameter = 'private';
export const UnsafeDrivePasswordParameter = 'unsafeDrivePassword';
export const DriveNameParameter = 'driveName';
export const FolderNameParameter = 'folderName';
export const FileNameParameter = 'fileName';
export const DriveKeyParameter = 'driveKey';
export const AddressParameter = 'address';
export const DriveIdParameter = 'driveId';
export const ArAmountParameter = 'arAmount';
export const CryptoAmountParameter = 'cryptoAmount';
export const RewardParameter = 'reward';
export const LastTxParameter = 'lastTx';
export const TxFilePathParameter = 'txFilePath';
export const DestinationAddressParameter = 'destAddress';
export const TransactionIdParameter = 'txId';
export const ConfirmationsParameter = 'confirmations';
export const FolderIdParameter = 'folderId';
export const FileIdParameter = 'fileId';
export const ParentFolderIdParameter = 'parentFolderId';
export const LocalFilePathParameter_DEPRECATED = 'localFilePath';
export const DestinationFileNameParameter = 'destFileName';
export const DestinationManifestNameParameter = 'destManifestName';
export const LocalFilesParameter_DEPRECATED = 'localFiles';
export const GetAllRevisionsParameter = 'getAllRevisions';
export const AllParameter = 'all';
export const MaxDepthParameter = 'maxDepth';
export const BoostParameter = 'boost';
export const DryRunParameter = 'dryRun';
export const SkipParameter = 'skip';
export const ReplaceParameter = 'replace';
export const UpsertParameter = 'upsert';
export const AskParameter = 'ask';
export const NoVerifyParameter = 'verify'; // commander maps --no-x style params to options.x and always includes in options
export const ShouldBundleParameter = 'bundle'; // commander maps --no-x style params to options.x and always includes in options
export const ShouldTurboParameter = 'turbo'; // commander maps --no-x style params to options.x and always includes in options
export const LocalPathParameter = 'localPath';
export const LocalPathsParameter = 'localPaths';
export const LocalCSVParameter = 'localCsv';
export const WithKeysParameter = 'withKeys';
export const GatewayParameter = 'gateway';
export const TurboUrlParameter = 'turboUrl';
export const CustomContentTypeParameter = 'contentType';
export const RemotePathParameter = 'remotePath';
export const IPFSParameter = 'addIpfsTag';
export const DataGqlTagsParameter = 'dataGqlTags';
export const MetaDataFileParameter = 'metadataFile';
export const MetaDataGqlTagsParameter = 'metadataGqlTags';
export const MetadataJsonParameter = 'metadataJson';
export const TokenTypeParameter = 'token';

// Aggregates for convenience
export const CustomMetaDataParameters = [
	DataGqlTagsParameter,
	MetaDataFileParameter,
	MetaDataGqlTagsParameter,
	MetadataJsonParameter
];
export const WalletTypeParameters = [WalletFileParameter, SeedPhraseParameter];
export const DriveCreationPrivacyParameters = [...WalletTypeParameters, PrivateParameter, UnsafeDrivePasswordParameter];
export const DrivePrivacyParameters = [DriveKeyParameter, ...DriveCreationPrivacyParameters];
export const TreeDepthParams = [AllParameter, MaxDepthParameter];
export const AllParameters = [
	AddressParameter,
	AllParameter,
	ArAmountParameter,
	CryptoAmountParameter,
	TurboUrlParameter,
	BoostParameter,
	ConfirmationsParameter,
	CustomContentTypeParameter,
	DataGqlTagsParameter,
	DestinationAddressParameter,
	DestinationFileNameParameter,
	DriveKeyParameter,
	DriveNameParameter,
	DriveIdParameter,
	DryRunParameter,
	FileIdParameter,
	FileNameParameter,
	FolderIdParameter,
	FolderNameParameter,
	GatewayParameter,
	GetAllRevisionsParameter,
	LastTxParameter,
	LocalFilePathParameter_DEPRECATED,
	LocalFilesParameter_DEPRECATED,
	LocalPathParameter,
	LocalPathsParameter,
	MaxDepthParameter,
	MetaDataFileParameter,
	MetaDataGqlTagsParameter,
	MetadataJsonParameter,
	ShouldBundleParameter,
	ShouldTurboParameter,
	NoVerifyParameter,
	ParentFolderIdParameter,
	PrivateParameter,
	RewardParameter,
	SeedPhraseParameter,
	TransactionIdParameter,
	TxFilePathParameter,
	UnsafeDrivePasswordParameter,
	WalletFileParameter,
	WithKeysParameter,
	RemotePathParameter,
	IPFSParameter
] as const;
export type ParameterName = typeof AllParameters[number];

export const ConflictResolutionParams = [SkipParameter, ReplaceParameter, UpsertParameter, AskParameter];

/**
 * Note: importing this file will declare all the above parameters
 */

Parameter.declare({
	name: WalletFileParameter,
	aliases: ['-w', '--wallet-file'],
	description: `the path to a JWK file on the file system representing your Arweave wallet
\t\t\t\t\t\t\t• Can't be used with --seed-phrase`,
	forbiddenConjunctionParameters: [SeedPhraseParameter]
});

Parameter.declare({
	name: SeedPhraseParameter,
	aliases: ['-s', '--seed-phrase'],
	description: `a 12-word seed phrase representing a JWK
\t\t\t\t\t\t\t• Can't be used with --wallet-file`,
	forbiddenConjunctionParameters: [WalletFileParameter]
});

Parameter.declare({
	name: UnsafeDrivePasswordParameter,
	aliases: ['-p', '--unsafe-drive-password'],
	description: `(OPTIONAL - NOT RECOMMENDED) the encryption password for the private drive
\t\t\t\t\t\t\t• When provided, creates/accesses a private drive. Public drive otherwise.
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --private
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --drive-key`,
	forbiddenConjunctionParameters: [DriveKeyParameter, PrivateParameter]
});

Parameter.declare({
	name: PrivateParameter,
	aliases: ['-P', '--private'],
	description: `(OPTIONAL - RECOMMENDED OVER --unsafe-drive-password) specify to create/interact with private entities, i.e. drives, folders, and files
\t\t\t\t\t\t\t• obtains the drive password from the following locations, in precedence order:
\t\t\t\t\t\t\t\t- STDIN
\t\t\t\t\t\t\t\t- Environment variable ARDRIVE_DRIVE_PW
\t\t\t\t\t\t\t\t- Interactive, secure prompt
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --unsafe-drive-password
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --drive-key`,
	forbiddenConjunctionParameters: [DriveKeyParameter, UnsafeDrivePasswordParameter],
	type: 'boolean'
});

Parameter.declare({
	name: DriveKeyParameter,
	aliases: ['-k', '--drive-key'],
	description: `the base64 encoded symmetric encryption key (with '=' characters excised) for the drive (or parent drive in the case of folder operations)
\t\t\t\t\t\t\t• Required only for operations involving private drives or entities within them
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --unsafe-drive-password
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --private`,
	forbiddenConjunctionParameters: [UnsafeDrivePasswordParameter, PrivateParameter]
});

Parameter.declare({
	name: DriveNameParameter,
	aliases: ['-n', '--drive-name'],
	description: `the name for the new drive`,
	required: true
});

Parameter.declare({
	name: FolderNameParameter,
	aliases: ['-n', '--folder-name'],
	description: `the name for the new folder`,
	required: true
});

Parameter.declare({
	name: FileNameParameter,
	aliases: ['-n', '--file-name'],
	description: `the new file name`,
	required: true
});

Parameter.declare({
	name: AddressParameter,
	aliases: ['-a', '--address'],
	description: 'the 43-character Arweave wallet address to use for lookups'
});

Parameter.declare({
	name: DriveIdParameter,
	aliases: ['-d', '--drive-id'],
	description: 'the ArFS entity ID associated with the target drive',
	required: true
});

Parameter.declare({
	name: ArAmountParameter,
	aliases: ['-a', '--ar-amount'],
	description: `amount of AR to send to the --dest-address
\t\t\t\t\t\t\t• does NOT include transaction mining base rewards`
});

Parameter.declare({
	name: CryptoAmountParameter,
	aliases: ['-a', '--crypto-amount'],
	description: `amount of crypto tokens to send in the transaction
\t\t\t\t\t\t\t• does NOT include transaction mining base rewards`
});

Parameter.declare({
	name: RewardParameter,
	aliases: ['-r', '--reward'],
	description: `amount of Winston to set as the transaction reward`,
	required: true
});

Parameter.declare({
	name: LastTxParameter,
	aliases: ['-l', '--last-tx'],
	description: `the transaction ID of the last transaction sent by this wallet`,
	required: true
});

Parameter.declare({
	name: TxFilePathParameter,
	aliases: ['-x', '--tx-file-path'],
	description: `path on the filesystem from which to load the signed transaction data`,
	required: true
});

Parameter.declare({
	name: DestinationAddressParameter,
	aliases: ['-d', '--dest-address'],
	description: 'the 43-character Arweave wallet address to which AR should be sent',
	required: true
});

Parameter.declare({
	name: TransactionIdParameter,
	aliases: ['-t', '--tx-id'],
	description: 'The transaction id to check the status of in the mempool'
});

Parameter.declare({
	name: ConfirmationsParameter,
	aliases: ['-c', '--confirmations'],
	description: 'Number of confirmations to determine if a transaction is mined'
});

Parameter.declare({
	name: ParentFolderIdParameter,
	aliases: ['-F', '--parent-folder-id'],
	description: `the ArFS folder ID for the folder in which this file will reside (i.e. its parent folder)
\t\t\t\t\t\t\t• To upload the file to the root of a drive, use the root folder ID of the drive`,
	required: true
});

Parameter.declare({
	name: FolderIdParameter,
	aliases: ['-f', '--folder-id'],
	description: `the ArFS folder ID for the folder to query`,
	required: true
});

Parameter.declare({
	name: FileIdParameter,
	aliases: ['-f', '--file-id'],
	description: `the ArFS file ID for the file to query`,
	required: true
});

Parameter.declare({
	name: LocalFilePathParameter_DEPRECATED,
	aliases: ['-l', '--local-file-path'],
	description: `(DEPRECATED) the path on the local filesystem for the file that will be uploaded`
});

Parameter.declare({
	name: LocalPathParameter,
	aliases: ['--local-path'],
	description: `the path on the local filesystem for the file that will be uploaded
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --local-file-path
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --local-files
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --local-paths
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --local-csv
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --remote-path`,
	forbiddenConjunctionParameters: [LocalFilePathParameter_DEPRECATED, LocalPathsParameter, LocalCSVParameter]
});

Parameter.declare({
	name: DestinationFileNameParameter,
	aliases: ['-d', '--dest-file-name'],
	description: `a destination file name to use when uploaded to ArDrive
\t\t\t\t\t\t\t• Required for use with --remote-path
\t\t\t\t\t\t\t• Optional when using with --local-path or --local-file-path`
});

Parameter.declare({
	name: DestinationManifestNameParameter,
	aliases: ['-n', '--dest-manifest-name'],
	description: `(OPTIONAL) a destination file name for the manifest to use when uploaded to ArDrive`
});

Parameter.declare({
	name: LocalFilesParameter_DEPRECATED,
	aliases: ['--local-files'],
	description: `(DEPRECATED) a path to a csv (tab delimited) file containing rows of data for the following columns:
\t\t\t\t\t\t\t• CSV Columns:
\t\t\t\t\t\t\t\t• local file path
\t\t\t\t\t\t\t\t• destination file name (optional)
\t\t\t\t\t\t\t\t• parent folder ID (optional)
\t\t\t\t\t\t\t\t\t• --parent-folder-id used, otherwise
\t\t\t\t\t\t\t\t• drive password (optional)
\t\t\t\t\t\t\t\t• drive key (optional)
\t\t\t\t\t\t\t• all parent folder IDs should reside in the same drive
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --local-file-path
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --local-path
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --local-paths
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --local-csv
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --dest-file-name
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --remote-path`,
	forbiddenConjunctionParameters: [
		LocalFilePathParameter_DEPRECATED,
		LocalPathParameter,
		LocalPathsParameter,
		LocalCSVParameter,
		DestinationFileNameParameter
	]
});

Parameter.declare({
	name: GetAllRevisionsParameter,
	aliases: ['--get-all-revisions'],
	description: '(OPTIONAL) gets every revision of the entity',
	type: 'boolean'
});

Parameter.declare({
	name: BoostParameter,
	aliases: ['--boost'],
	description:
		'(OPTIONAL) a multiple of the base transaction mining reward that can be used to accelerate transaction mining. A multiple of 2.5 would boost a 100 Winston transaction reward to 250 Winston.'
});

Parameter.declare({
	name: DryRunParameter,
	aliases: ['--dry-run'],
	description:
		'(OPTIONAL) Print the results of the transactions that would occur, and their potential tips and mining rewards, without sending the transactions.',
	type: 'boolean'
});

Parameter.declare({
	name: SkipParameter,
	aliases: ['--skip'],
	description: '(OPTIONAL) Skip upload if there is a name conflict within destination folder',
	type: 'boolean',
	forbiddenConjunctionParameters: [ReplaceParameter, UpsertParameter, AskParameter]
});

Parameter.declare({
	name: ReplaceParameter,
	aliases: ['--replace'],
	description: '(OPTIONAL) Create new file revisions if there is a name conflict within destination folder',
	type: 'boolean',
	forbiddenConjunctionParameters: [SkipParameter, UpsertParameter, AskParameter]
});

Parameter.declare({
	name: UpsertParameter,
	aliases: ['--upsert'],
	description:
		'(OPTIONAL) When there is a name conflict within the destination folder, only upload file if a modification is detected. Skip otherwise.',
	type: 'boolean',
	forbiddenConjunctionParameters: [SkipParameter, ReplaceParameter, AskParameter]
});

Parameter.declare({
	name: AskParameter,
	aliases: ['--ask'],
	description: '(OPTIONAL) Show an interactive prompt to resolve name conflicts within the destination folder',
	type: 'boolean',
	forbiddenConjunctionParameters: [SkipParameter, ReplaceParameter, UpsertParameter]
});

Parameter.declare({
	name: AllParameter,
	aliases: ['--all'],
	description: `(OPTIONAL) gets all contents within this folder, including child files/folders`,
	type: 'boolean',
	forbiddenConjunctionParameters: [MaxDepthParameter]
});

Parameter.declare({
	name: MaxDepthParameter,
	aliases: ['--max-depth'],
	description: `(OPTIONAL) a non-negative integer value indicating the depth of the folder tree to list. 0 = specified folder's contents OR root folder for drives`
});

Parameter.declare({
	name: NoVerifyParameter,
	aliases: ['--no-verify'],
	description:
		'(OPTIONAL) Derives a drive key for the given drive ID without verifying its correctness against the drive on chain.',
	type: 'boolean'
});

Parameter.declare({
	name: ShouldBundleParameter,
	aliases: ['--no-bundle'],
	description: '(OPTIONAL) Do not pack into a bundle; send as separate v2 transactions. NOT RECOMMENDED.',
	type: 'boolean'
});

Parameter.declare({
	name: ShouldTurboParameter,
	aliases: ['--turbo'],
	description: '(OPTIONAL) Send data items to turbo service. BETA FEATURE.',
	type: 'boolean'
});

Parameter.declare({
	name: LocalPathParameter,
	aliases: ['--local-path'],
	description: `the path on the local filesystem for the file that will be uploaded
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --local-file-path
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --local-files
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --local-paths
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --local-csv
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --remote-path`,
	forbiddenConjunctionParameters: [
		LocalFilePathParameter_DEPRECATED,
		LocalFilesParameter_DEPRECATED,
		LocalPathsParameter,
		LocalCSVParameter
	]
});

Parameter.declare({
	name: LocalPathsParameter,
	aliases: ['--local-paths'],
	type: 'array',
	description: `(BETA) a space-separated list of paths to files or folders to upload
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --local-file-path
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --local-files
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --local-path
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --local-csv
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --dest-file-name
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --remote-path`,
	forbiddenConjunctionParameters: [
		LocalFilePathParameter_DEPRECATED,
		LocalFilesParameter_DEPRECATED,
		LocalPathParameter,
		LocalCSVParameter,
		DestinationFileNameParameter
	]
});

Parameter.declare({
	name: LocalCSVParameter,
	aliases: ['--local-csv'],
	description: `(BETA) a path to a csv (tab delimited) file containing rows of data for the following columns:
\t\t\t\t\t\t\t• CSV Columns:
\t\t\t\t\t\t\t\t• local file path
\t\t\t\t\t\t\t\t• destination file name (optional)
\t\t\t\t\t\t\t\t• parent folder ID (optional)
\t\t\t\t\t\t\t\t\t• --parent-folder-id used, otherwise
\t\t\t\t\t\t\t\t• drive password (optional)
\t\t\t\t\t\t\t\t• drive key (optional)
\t\t\t\t\t\t\t• all parent folder IDs should reside in the same drive
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --local-file-path
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --local-files
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --local-path
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --local-paths
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --dest-file-name
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --remote-path`,
	forbiddenConjunctionParameters: [
		LocalFilePathParameter_DEPRECATED,
		LocalFilesParameter_DEPRECATED,
		LocalPathParameter,
		LocalPathsParameter,
		DestinationFileNameParameter
	]
});

Parameter.declare({
	name: WithKeysParameter,
	aliases: ['-K', '--with-keys'],
	description: `(OPTIONAL) displays the driveKey and fileKey of the listed entities`,
	type: 'boolean'
});

Parameter.declare({
	name: GatewayParameter,
	aliases: ['-g', '--gateway'],
	description: `(OPTIONAL) a 'protocol://host:port' formatted string specifying the connection info for the Arweave gateway server to use`
});

Parameter.declare({
	name: TokenTypeParameter,
	aliases: ['-t', '--token'],
	description: `(OPTIONAL) token type for this command`
});

Parameter.declare({
	name: TurboUrlParameter,
	aliases: ['--turbo-url'],
	description: `(OPTIONAL) a 'protocol://host:port' formatted string specifying the connection info for which turbo service to send data items to`
});

Parameter.declare({
	name: CustomContentTypeParameter,
	aliases: ['--content-type'],
	description:
		'(OPTIONAL) Provide a custom content type to all files within the upload to be used by the gateway to display the content'
});

Parameter.declare({
	name: RemotePathParameter,
	aliases: ['--remote-path'],
	description: `the remote path for the file that will be uploaded
\t\t\t\t\t\t\t• MUST be used in conjunction with --dest-file-name
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --local-file-path
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --local-files
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --local-paths
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --local-path
\t\t\t\t\t\t\t• Can NOT be used in conjunction with --local-csv`,
	requiredConjunctionParameters: [DestinationFileNameParameter],
	forbiddenConjunctionParameters: [
		LocalFilePathParameter_DEPRECATED,
		LocalPathsParameter,
		LocalCSVParameter,
		LocalPathParameter
	]
});
Parameter.declare({
	name: IPFSParameter,
	aliases: ['--add-ipfs-tag'],
	description:
		'(OPTIONAL) Computes the v1 IPFS content identifier (CID) for each file and sets it as the "IPFS-Add" tag value of each\'s respective file data transaction',
	type: 'boolean',
	forbiddenConjunctionParameters: [PrivateParameter, UnsafeDrivePasswordParameter]
});

Parameter.declare({
	name: MetaDataFileParameter,
	aliases: ['--metadata-file'],
	description:
		'(OPTIONAL) Path to JSON file containing a custom metadata schema to add to ArFS transactions within the upload. Input must be a valid JSON object, e.g shape: `{ metaDataJson: { "TAG_NAME": [ "VAL_1", "VAL_2" ] }, metaDataGqlTags: { "IPFS-Add": "MY_PERMANENT_HASH?" } }`. Can NOT be used in conjunction with --metadata-json OR --metadata-gql-tags',
	forbiddenConjunctionParameters: [MetadataJsonParameter, MetaDataGqlTagsParameter, DataGqlTagsParameter]
});

Parameter.declare({
	name: MetadataJsonParameter,
	aliases: ['--metadata-json'],
	description:
		'(OPTIONAL) A stringified JSON input of custom fields in the `\'{"key": "val", "key-2": true, "key-3": 420, "key-4": ["more", 1337]}\'` format to be applied to the Data JSON of all MetaData Transactions created. Can NOT be used in conjunction with --metadata-file',
	forbiddenConjunctionParameters: [MetaDataFileParameter]
});

Parameter.declare({
	name: MetaDataGqlTagsParameter,
	aliases: ['--metadata-gql-tags'],
	type: 'array',
	description:
		'(OPTIONAL) A mapping of custom metadata in the `"TAG_NAME" "TAG_VALUE"` format to be applied to the GQL Tags of all MetaData Transactions created. Must be an even number of string values to determine custom metadata. Can NOT be used in conjunction with --metadata-file',
	forbiddenConjunctionParameters: [MetaDataFileParameter]
});

Parameter.declare({
	name: DataGqlTagsParameter,
	aliases: ['--data-gql-tags'],
	type: 'array',
	description:
		'(OPTIONAL) A list of custom Arweave tag name and value pairs in the format `"TAG_NAME" "TAG_VALUE"` that will be applied to all file data transactions created during an invocation. Must be an even number of string values. Can NOT be used in conjunction with --metadata-file',
	forbiddenConjunctionParameters: [MetaDataFileParameter]
});