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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,537 @@
1
+ {
2
+ "commands": {
3
+ "nft-mint": {
4
+ "summary": "Mint an NFT.",
5
+ "description": "Mint an NFT.",
6
+ "options": {
7
+ "seed": {
8
+ "param": "--seed '<'seed'>'",
9
+ "description": "The seed for the issuer address in hex or base64 used to fund the minting, or start with ! to read environment variable."
10
+ },
11
+ "issuer": {
12
+ "param": "--issuer '<'issuer'>'",
13
+ "description": "The bech32 address of the NFT issuer, or start with ! to read environment variable."
14
+ },
15
+ "tag": {
16
+ "param": "--tag '<'tag'>'",
17
+ "description": "The tag for the NFT."
18
+ },
19
+ "immutable-json": {
20
+ "param": "--immutable-json '<'immutable-json'>'",
21
+ "description": "A JSON file to read which includes the immutable data for the NFT."
22
+ },
23
+ "mutable-json": {
24
+ "param": "--mutable-json '<'mutable-json'>'",
25
+ "description": "A JSON file to read which includes the mutable data for the NFT."
26
+ }
27
+ },
28
+ "progress": {
29
+ "mintingNft": "Minting NFT"
30
+ },
31
+ "labels": {
32
+ "issuer": "Issuer",
33
+ "tag": "Tag",
34
+ "immutableJsonFilename": "Immutable JSON Filename",
35
+ "mutableJsonFilename": "Mutable JSON Filename",
36
+ "immutableJson": "Immutable JSON",
37
+ "mutableJson": "Mutable JSON",
38
+ "nftId": "NFT Id"
39
+ }
40
+ },
41
+ "nft-resolve": {
42
+ "summary": "Resolve an NFT.",
43
+ "description": "Resolve an NFT.",
44
+ "options": {
45
+ "id": {
46
+ "param": "--id '<'id'>'",
47
+ "description": "The id for the NFT in urn format."
48
+ }
49
+ },
50
+ "progress": {
51
+ "resolvingNft": "Resolving NFT"
52
+ },
53
+ "labels": {
54
+ "nft": "NFT",
55
+ "nftId": "NFT Id"
56
+ }
57
+ },
58
+ "nft-burn": {
59
+ "summary": "Burn an NFT.",
60
+ "description": "Burn an NFT.",
61
+ "options": {
62
+ "seed": {
63
+ "param": "--seed '<'seed'>'",
64
+ "description": "The seed for the issuer address in hex or base64 used to fund the burning, or start with ! to read environment variable."
65
+ },
66
+ "issuer": {
67
+ "param": "--issuer '<'issuer'>'",
68
+ "description": "The bech32 address of the NFT issuer, or start with ! to read environment variable."
69
+ },
70
+ "id": {
71
+ "param": "--id '<'id'>'",
72
+ "description": "The id for the NFT in urn format."
73
+ }
74
+ },
75
+ "progress": {
76
+ "burningNft": "Burning NFT"
77
+ },
78
+ "labels": {
79
+ "issuer": "Issuer",
80
+ "nftId": "NFT Id"
81
+ }
82
+ },
83
+ "nft-transfer": {
84
+ "summary": "Transfer an NFT.",
85
+ "description": "Transfer an NFT.",
86
+ "options": {
87
+ "seed": {
88
+ "param": "--seed '<'seed'>'",
89
+ "description": "The seed for the issuer address in hex or base64 used to fund the transfer, or start with ! to read environment variable."
90
+ },
91
+ "id": {
92
+ "param": "--id '<'id'>'",
93
+ "description": "The id for the NFT in urn format."
94
+ },
95
+ "recipient": {
96
+ "param": "--recipient '<'recipient'>'",
97
+ "description": "The bech32 address of the NFT recipient, or start with ! to read environment variable."
98
+ }
99
+ },
100
+ "progress": {
101
+ "transferringNft": "Transferring NFT"
102
+ },
103
+ "labels": {
104
+ "recipient": "Recipient",
105
+ "nftId": "NFT Id"
106
+ }
107
+ },
108
+ "common": {
109
+ "options": {
110
+ "node": {
111
+ "param": "--node '<'url'>'",
112
+ "description": "The url for the node endpoint, or an environment variable name containing the url."
113
+ },
114
+ "explorer": {
115
+ "param": "--explorer '<'url'>'",
116
+ "description": "The url for the explorer endpoint, or an environment variable name containing the url."
117
+ }
118
+ },
119
+ "labels": {
120
+ "did": "DID",
121
+ "node": "Node",
122
+ "explorer": "Explorer",
123
+ "explore": "Explore",
124
+ "address": "Address",
125
+ "balance": "Balance"
126
+ }
127
+ },
128
+ "mnemonic": {
129
+ "summary": "Create a mnemonic.",
130
+ "description": "Create a mnemonic, will also generate the equivalent seed in hex and base64 format.",
131
+ "options": {
132
+ "strength": {
133
+ "param": "--strength '<'number'>'",
134
+ "description": "The number of words in the mnemonic, defaults to 256 which produces 24 words."
135
+ },
136
+ "seed-format": {
137
+ "param": "--seed-format '<'format'>'",
138
+ "description": "The format to output the seed."
139
+ },
140
+ "no-console": {
141
+ "param": "--no-console",
142
+ "description": "Hides the mnemonic and seed in the console."
143
+ },
144
+ "json": {
145
+ "param": "--json '<'filename'>'",
146
+ "description": "Creates a JSON file containing the mnemonic and seed."
147
+ },
148
+ "env": {
149
+ "param": "--env '<'filename'>'",
150
+ "description": "Creates an env file containing the mnemonic and seed."
151
+ }
152
+ },
153
+ "progress": {
154
+ "writingJsonFile": "Writing JSON file",
155
+ "writingEnvFile": "Writing env file"
156
+ },
157
+ "labels": {
158
+ "mnemonic": "Mnemonic",
159
+ "seed": "Seed"
160
+ }
161
+ },
162
+ "address": {
163
+ "summary": "Create bech32 addresses and keys from the seed.",
164
+ "description": "Create a number of bech32 addresses and their associated key pairs from the seed.",
165
+ "options": {
166
+ "seed": {
167
+ "param": "--seed '<'seed'>'",
168
+ "description": "The seed to use for generating the addresses, this can be either hex, base64 or an environment variable name. For an environment variable start the value with a !"
169
+ },
170
+ "start": {
171
+ "param": "--start '<'number'>'",
172
+ "description": "The index of the first address to create."
173
+ },
174
+ "count": {
175
+ "param": "--count '<'number'>'",
176
+ "description": "The number of addresses to create, max 100."
177
+ },
178
+ "account": {
179
+ "param": "--account '<'number'>'",
180
+ "description": "The account used to generate the bech32 addresses."
181
+ },
182
+ "hrp": {
183
+ "param": "--hrp '<'hrp'>'",
184
+ "description": "The human readable part of the bech32 addresses."
185
+ },
186
+ "coin": {
187
+ "param": "--coin '<'coin'>'",
188
+ "description": "The coin type used to generate the bech32 addresses."
189
+ },
190
+ "key-type": {
191
+ "param": "--key-type '<'type'>'",
192
+ "description": "The type of key to generate."
193
+ },
194
+ "key-format": {
195
+ "param": "--key-format '<'format'>'",
196
+ "description": "The format to output the keys."
197
+ }
198
+ },
199
+ "progress": {
200
+ "generatingAddresses": "Generating addresses"
201
+ },
202
+ "labels": {
203
+ "seed": "Seed",
204
+ "start": "Start",
205
+ "count": "Count",
206
+ "account": "Account",
207
+ "hrp": "HRP",
208
+ "coin": "Coin",
209
+ "key-type": "Key Type",
210
+ "key-format": "Key Format",
211
+ "index": "Index",
212
+ "address": "Address",
213
+ "public-key": "Public Key",
214
+ "private-key": "Private Key"
215
+ }
216
+ },
217
+ "faucet": {
218
+ "summary": "Request funds from the faucet.",
219
+ "description": "Request funds from the faucet for the supplied address.",
220
+ "options": {
221
+ "address": {
222
+ "param": "--address '<'address'>'",
223
+ "description": "The address to fill from the faucet either in bech32 format, or start with ! to read environment variable."
224
+ },
225
+ "faucet": {
226
+ "param": "--faucet '<'url'>'",
227
+ "description": "The url for the faucet endpoint, or an environment variable name containing the url."
228
+ }
229
+ },
230
+ "progress": {
231
+ "requestingFunds": "Requesting Funds",
232
+ "requestingBalance": "Requesting Balance"
233
+ },
234
+ "labels": {
235
+ "faucet": "Faucet",
236
+ "fundsAdded": "Funds Added"
237
+ },
238
+ "messages": {
239
+ "noFundsAdded": "No funds were added to the address."
240
+ }
241
+ },
242
+ "transfer": {
243
+ "summary": "Transfer funds from one address to another.",
244
+ "description": "Transfer funds from one address to another.",
245
+ "options": {
246
+ "address": {
247
+ "param": "--address '<'address'>'",
248
+ "description": "The address to send the funds from either in bech32 format, or start with ! to read environment variable."
249
+ },
250
+ "dest-address": {
251
+ "param": "--dest-address '<'address'>'",
252
+ "description": "The address to send the funds to either in bech32 format, or start with ! to read environment variable."
253
+ },
254
+ "amount": {
255
+ "param": "--amount '<'amount'>'",
256
+ "description": "The amount of funds to send."
257
+ },
258
+ "seed": {
259
+ "param": "--seed '<'seed'>'",
260
+ "description": "The seed for the source address in hex or base64 used to sign the transfer, or start with ! to read environment variable."
261
+ }
262
+ },
263
+ "progress": {
264
+ "transferringFunds": "Transferring"
265
+ },
266
+ "labels": {
267
+ "destAddress": "Destination Address"
268
+ }
269
+ }
270
+ },
271
+ "error": {
272
+ "validation": {
273
+ "beEmpty": "{fieldName} must be empty",
274
+ "beNotEmpty": "{fieldName} must not be empty",
275
+ "beText": "{fieldName} must be text",
276
+ "beTextValue": "{fieldName} must contain some text",
277
+ "beTextMinMax": "{fieldName} must be longer than {minLength} and shorter than {maxLength} characters",
278
+ "beTextMin": "{fieldName} must be longer than {minLength} characters",
279
+ "beTextMax": "{fieldName} must be shorter than {maxLength} characters",
280
+ "beNumber": "{fieldName} must be a number",
281
+ "beNumberMinMax": "{fieldName} must be >= {minValue} and <= {maxValue}",
282
+ "beNumberMin": "{fieldName} must be >= {minValue}",
283
+ "beNumberMax": "{fieldName} must be <= {maxValue}",
284
+ "beWholeNumber": "{fieldName} must be a whole number",
285
+ "beWholeNumberMinMax": "{fieldName} must be a whole number >= {minValue} and <= {maxValue}",
286
+ "beWholeNumberMin": "{fieldName} must be a whole number >= {minValue}",
287
+ "beWholeNumberMax": "{fieldName} must be a whole number <= {maxValue}",
288
+ "beBigInteger": "{fieldName} must be a bigint",
289
+ "beBigIntegerMinMax": "{fieldName} must be a bigint >= {minValue} and <= {maxValue}",
290
+ "beBigIntegerMin": "{fieldName} must be a bigint >= {minValue}",
291
+ "beBigIntegerMax": "{fieldName} must be a bigint <= {maxValue}",
292
+ "beBoolean": "{fieldName} must be true or false",
293
+ "beDate": "{fieldName} must be a date",
294
+ "beDateTime": "{fieldName} must be a date/time",
295
+ "beTime": "{fieldName} must be a time",
296
+ "beTimestampMilliseconds": "{fieldName} must be a timestamp in milliseconds",
297
+ "beTimestampSeconds": "{fieldName} must be a timestamp in seconds",
298
+ "beObject": "{fieldName} must be an object",
299
+ "beArray": "{fieldName} must be an array",
300
+ "beArrayValue": "{fieldName} must be an array with at least one item",
301
+ "beIncluded": "{fieldName} is unrecognised",
302
+ "beByteArray": "{fieldName} must be a byte array",
303
+ "beUrn": "{fieldName} must be a correctly formatted urn",
304
+ "beUrl": "{fieldName} must be a correctly formatted url",
305
+ "beJSON": "{fieldName} must be correctly formatted JSON",
306
+ "beEmail": "{fieldName} must be a correctly formatted e-mail address",
307
+ "failed": "Validation failed",
308
+ "failedObject": "Validation of \"{objectName}\" failed"
309
+ },
310
+ "guard": {
311
+ "undefined": "Property \"{property}\" must be defined, it is \"{value}\"",
312
+ "string": "Property \"{property}\" must be a string, it is \"{value}\"",
313
+ "stringEmpty": "Property \"{property}\" must have a value, it is empty",
314
+ "stringBase64": "Property \"{property}\" must be a base64 encoded string, it is \"{value}\"",
315
+ "stringBase64Url": "Property \"{property}\" must be a base64 url encoded string, it is \"{value}\"",
316
+ "stringHex": "Property \"{property}\" must be a hex string, it is \"{value}\"",
317
+ "stringHexLength": "Property \"{property}\" must be a hex string of length \"{options}\", it is \"{value}\"",
318
+ "number": "Property \"{property}\" must be a number, it is \"{value}\"",
319
+ "integer": "Property \"{property}\" must be an integer, it is \"{value}\"",
320
+ "bigint": "Property \"{property}\" must be a bigint, it is \"{value}\"",
321
+ "boolean": "Property \"{property}\" must be a boolean, it is \"{value}\"",
322
+ "date": "Property \"{property}\" must be a date, it is \"{value}\"",
323
+ "timestampMilliseconds": "Property \"{property}\" must be a timestamp in milliseconds, it is \"{value}\"",
324
+ "timestampSeconds": "Property \"{property}\" must be a timestamp in seconds, it is \"{value}\"",
325
+ "objectUndefined": "Property \"{property}\" must be an object, it is \"undefined\"",
326
+ "object": "Property \"{property}\" must be an object, it is \"{value}\"",
327
+ "objectValue": "Property \"{property}\" must be an object, with at least one property, it is \"{value}\"",
328
+ "array": "Property \"{property}\" must be an array, it is \"{value}\"",
329
+ "arrayValue": "Property \"{property}\" must be an array with at least one item",
330
+ "arrayOneOf": "Property \"{property}\" must be one of [{options}], it is \"{value}\"",
331
+ "uint8Array": "Property \"{property}\" must be a Uint8Array, it is \"{value}\"",
332
+ "function": "Property \"{property}\" must be a function, it is \"{value}\"",
333
+ "urn": "Property \"{property}\" must be a Urn formatted string, it is \"{value}\"",
334
+ "url": "Property \"{property}\" must be a Url formatted string, it is \"{value}\"",
335
+ "email": "Property \"{property}\" must be string in e-mail format, it is \"{value}\"",
336
+ "length32Multiple": "Property \"{property}\" should be a multiple of 32, it is {value}",
337
+ "lengthEntropy": "Property \"{property}\" should be a multiple of 4, >=16 and <= 32, it is {value}",
338
+ "length3Multiple": "Property \"{property}\" should be a multiple of 3, it is {value}",
339
+ "greaterThan0": "Property \"{property}\" must be greater than zero, it is {value}"
340
+ },
341
+ "objectHelper": {
342
+ "failedBytesToJSON": "Failed converting bytes to JSON"
343
+ },
344
+ "common": {
345
+ "notImplementedMethod": "The method \"{method}\" has not been implemented",
346
+ "validation": "Validation failed"
347
+ },
348
+ "factory": {
349
+ "noUnregister": "There is no {typeName} registered with the name \"{name}\"",
350
+ "noGet": "The requested {typeName} \"{name}\" does not exist in the factory"
351
+ },
352
+ "bitString": {
353
+ "outOfRange": "The index should be >= 0 and less than the length of the bit string"
354
+ },
355
+ "bip39": {
356
+ "missingMnemonicWord": "The mnemonic contains a word not in the wordlist, \"{value}\"",
357
+ "checksumMismatch": "The checksum does not match \"{newChecksum}\" != \"{checksumBits}\""
358
+ },
359
+ "ed25519": {
360
+ "privateKeyLength": "The private key length is incorrect, it should be \"{requiredSize}\" but is \"{actualSize}\"",
361
+ "publicKeyLength": "The public key length is incorrect, it should be \"{requiredSize}\" but is \"{actualSize}\""
362
+ },
363
+ "secp256k1": {
364
+ "privateKeyLength": "The private key length is incorrect, it should be \"{requiredSize}\" but is \"{actualSize}\"",
365
+ "publicKeyLength": "The public key length is incorrect, it should be \"{requiredSize}\" but is \"{actualSize}\""
366
+ },
367
+ "x25519": {
368
+ "invalidPublicKey": "Invalid Ed25519 Public Key"
369
+ },
370
+ "blake2b": {
371
+ "outputLength64": "The output length should be between 1 and 64, it is \"{outputLength}\"",
372
+ "keyLength64": "The key length should be between 1 and 64, it is \"{keyLength}\""
373
+ },
374
+ "sha512": {
375
+ "bitSize": "Only 224, 256, 384 or 512 bits are supported, it is \"{bitSize}\""
376
+ },
377
+ "sha256": {
378
+ "bitSize": "Only 224 or 256 bits are supported, it is \"{bitSize}\""
379
+ },
380
+ "hmacSha256": {
381
+ "bitSize": "Only 224 or 256 bits are supported, it is \"{bitSize}\""
382
+ },
383
+ "hmacSha512": {
384
+ "bitSize": "Only 224, 256, 384 or 512 bits are supported, it is \"{bitSize}\""
385
+ },
386
+ "base32": {
387
+ "invalidCharacter": "Data contains a character \"{invalidCharacter}\" which is not in the charset"
388
+ },
389
+ "base64": {
390
+ "length4Multiple": "Invalid length should be a multiple of 4, it is \"{value}\""
391
+ },
392
+ "bech32": {
393
+ "decodeFailed": "The address contains decoding failed for address \"{bech32}\"",
394
+ "invalidChecksum": "The address contains an invalid checksum in address, \"{bech32}\"",
395
+ "separatorMisused": "The separator character '1' should only be used between hrp and data, \"{bech32}\"",
396
+ "lowerUpper": "The address my use either lowercase or uppercase, \"{bech32}\"",
397
+ "dataTooShort": "The address does not contain enough data to decode, \"{bech32}\""
398
+ },
399
+ "pbkdf2": {
400
+ "keyTooLong": "The requested key length \"{keyLength}\" is too long, based on the \"{macLength}\""
401
+ },
402
+ "chaCha20Poly1305": {
403
+ "noAadWithData": "You can not set the aad when there is already data",
404
+ "noAuthTag": "Can not finalise when the auth tag is not set",
405
+ "authenticationFailed": "The data could not be authenticated",
406
+ "authTagDecrypting": "Can not get the auth tag when decrypting",
407
+ "authTagEncrypting": "Can not set the auth tag when encrypting",
408
+ "noAuthTagSet": "The auth tag has not been set"
409
+ },
410
+ "bip44": {
411
+ "unsupportedKeyType": "The key type \"{keyType}\" is not supported"
412
+ },
413
+ "slip0010": {
414
+ "invalidSeed": "The seed is invalid \"{seed}\""
415
+ },
416
+ "commands": {
417
+ "common": {
418
+ "missingEnv": "The \"{option}\" option is configured as an environment variable, but there is no environment variable with the name \"{value}\" set.",
419
+ "optionInvalidHex": "The \"{option}\" does not appear to be hex. \"{value}\"",
420
+ "optionInvalidBase64": "The \"{option}\" does not appear to be base64. \"{value}\"",
421
+ "optionInvalidHexBase64": "The \"{option}\" does not appear to be hex or base64. \"{value}\"",
422
+ "optionInvalidBech32": "The \"{option}\" does not appear to be bech32. \"{value}\"",
423
+ "optionMinValue": "The \"{option}\" option must be greater than or equal to {minValue}, it is {value}.",
424
+ "optionMaxValue": "The \"{option}\" option must be less than or equal to {maxValue}, it is {value}."
425
+ },
426
+ "address": {
427
+ "seedMissingEnv": "The seed does not appear to be hex or base64, assuming it is an environment variable, but there is no environment variable with the name \"{env}\" set.",
428
+ "seedInvalidEnv": "The seed does not appear to be hex or base64, assuming it is an environment variable, but there the environment variable is neither hex or base64. \"{envValue}\"",
429
+ "seedInvalidFormat": "The seed does not appear to be hex, base64 or an environment variable. \"{seed}\""
430
+ }
431
+ },
432
+ "entitySchemaHelper": {
433
+ "noIsPrimary": "Property \"entitySchema.properties\" must contain a value with isPrimary set",
434
+ "multipleIsPrimary": "Property \"entitySchema.properties\" contains more than one property with isPrimary set"
435
+ },
436
+ "iotaNftConnector": {
437
+ "inclusionFailed": "The transaction generated for the NFT was not included in a reasonable amount of time",
438
+ "mintingFailed": "Minting the NFT failed",
439
+ "resolvingFailed": "Resolving the NFT failed",
440
+ "burningFailed": "Burning the NFT failed",
441
+ "transferFailed": "Transferring the NFT failed",
442
+ "updateFailed": "Updating the NFT failed",
443
+ "namespaceMismatch": "The namespace in the urn \"{id}\" does not match the namespace of the IOTA NFT connector \"{namespace}\"",
444
+ "insufficientFunds": "There were insufficient funds to complete the operation",
445
+ "walletConnectorMissing": "The wallet connector must be available to perform this operation"
446
+ },
447
+ "iota": {
448
+ "inclusionFailed": "The transaction generated was not included in a reasonable amount of time",
449
+ "insufficientFunds": "There were insufficient funds to complete the operation"
450
+ },
451
+ "fetchHelper": {
452
+ "decodingJSON": "Decoding JSON failed for route \"{route}\"",
453
+ "failureStatusText": "The request to the API failed: \"{statusText}\"",
454
+ "connectivity": "The request failed, the API could be offline, or there are other connectivity issues",
455
+ "timeout": "The request timed out",
456
+ "general": "A general failure occurred during the request"
457
+ },
458
+ "jwt": {
459
+ "noKeyOrSigner": "No key or signer was provided for JWT creation",
460
+ "noKeyOrVerifier": "No key or verifier was provided for JWT creation"
461
+ },
462
+ "entityStorageVaultConnector": {
463
+ "keyAlreadyExists": "The key \"{existingId}\" already exists in the vault",
464
+ "keyNotFound": "The key \"{notFoundId}\" was not found in the vault",
465
+ "secretNotFound": "The secret \"{notFoundId}\" was not found in the vault"
466
+ },
467
+ "iotaWalletConnector": {
468
+ "transferFailed": "The wallet transfer failed.",
469
+ "inclusionFailed": "The transaction generated was not included in a reasonable amount of time",
470
+ "insufficientFunds": "There were insufficient funds to complete the operation"
471
+ },
472
+ "iotaFaucetConnector": {
473
+ "fundingFailed": "Fund the address from faucet failed",
474
+ "insufficientFunds": "There were insufficient funds to complete the operation"
475
+ }
476
+ },
477
+ "errorNames": {
478
+ "error": "Error",
479
+ "generalError": "General",
480
+ "guardError": "Guard",
481
+ "conflictError": "Conflict",
482
+ "notFoundError": "Not Found",
483
+ "notSupportedError": "Not Supported",
484
+ "alreadyExistsError": "Already Exists",
485
+ "notImplementedError": "Not Implemented",
486
+ "validationError": "Validation",
487
+ "unprocessableError": "Unprocessable"
488
+ },
489
+ "validation": {
490
+ "defaultFieldName": "The field"
491
+ },
492
+ "cli": {
493
+ "progress": {
494
+ "done": "Done.",
495
+ "error": "Error",
496
+ "loadingEnvFiles": "Loading env files",
497
+ "pleaseWait": "Please wait...",
498
+ "writingJsonFile": "Writing JSON file",
499
+ "writingEnvFile": "Writing env file",
500
+ "readingJsonFile": "Reading JSON file",
501
+ "readingEnvFile": "Reading env file"
502
+ },
503
+ "options": {
504
+ "lang": {
505
+ "param": "--lang '<'lang'>'",
506
+ "description": "The language to display the output in."
507
+ },
508
+ "load-env": {
509
+ "param": "--load-env [env...]",
510
+ "description": "Load the env files to initialise any environment variables."
511
+ },
512
+ "no-console": {
513
+ "param": "--no-console",
514
+ "description": "Hides the output in the console."
515
+ },
516
+ "json": {
517
+ "param": "--json '<'filename'>'",
518
+ "description": "Creates a JSON file containing the output."
519
+ },
520
+ "env": {
521
+ "param": "--env '<'filename'>'",
522
+ "description": "Creates an env file containing the output."
523
+ },
524
+ "merge-json": {
525
+ "param": "--merge-json",
526
+ "description": "If the JSON file already exists merge the data instead of overwriting."
527
+ },
528
+ "merge-env": {
529
+ "param": "--merge-env",
530
+ "description": "If the env file already exists merge the data instead of overwriting."
531
+ }
532
+ }
533
+ },
534
+ "errorMessages": {
535
+ "fetch": "Fetch"
536
+ }
537
+ }
@@ -0,0 +1,13 @@
1
+ import { CLIBase } from "@twin.org/cli-core";
2
+ /**
3
+ * The main entry point for the CLI.
4
+ */
5
+ export declare class CLI extends CLIBase {
6
+ /**
7
+ * Run the app.
8
+ * @param argv The process arguments.
9
+ * @param localesDirectory The directory for the locales, default to relative to the script.
10
+ * @returns The exit code.
11
+ */
12
+ run(argv: string[], localesDirectory?: string): Promise<number>;
13
+ }
@@ -0,0 +1,22 @@
1
+ import { Command } from "commander";
2
+ /**
3
+ * Build the nft burn command for the CLI.
4
+ * @returns The command.
5
+ */
6
+ export declare function buildCommandNftBurn(): Command;
7
+ /**
8
+ * Action the nft burn command.
9
+ * @param opts The options for the command.
10
+ * @param opts.seed The seed required for signing by the issuer.
11
+ * @param opts.issuer The issuer address of the NFT.
12
+ * @param opts.id The id of the NFT to burn in urn format.
13
+ * @param opts.node The node URL.
14
+ * @param opts.explorer The explorer URL.
15
+ */
16
+ export declare function actionCommandNftBurn(opts: {
17
+ seed: string;
18
+ issuer: string;
19
+ id: string;
20
+ node: string;
21
+ explorer: string;
22
+ }): Promise<void>;
@@ -0,0 +1,27 @@
1
+ import { type CliOutputOptions } from "@twin.org/cli-core";
2
+ import { Command } from "commander";
3
+ /**
4
+ * Build the nft mint command for the CLI.
5
+ * @returns The command.
6
+ */
7
+ export declare function buildCommandNftMint(): Command;
8
+ /**
9
+ * Action the nft mint command.
10
+ * @param opts The options for the command.
11
+ * @param opts.seed The seed required for signing by the issuer.
12
+ * @param opts.issuer The issuer address of the NFT.
13
+ * @param opts.tag The tag for the NFT.
14
+ * @param opts.immutableJson Filename of the immutable JSON data.
15
+ * @param opts.mutableJson Filename of the mutable JSON data.
16
+ * @param opts.node The node URL.
17
+ * @param opts.explorer The explorer URL.
18
+ */
19
+ export declare function actionCommandNftMint(opts: {
20
+ seed: string;
21
+ issuer: string;
22
+ tag: string;
23
+ immutableJson?: string;
24
+ mutableJson?: string;
25
+ node: string;
26
+ explorer: string;
27
+ } & CliOutputOptions): Promise<void>;
@@ -0,0 +1,19 @@
1
+ import { type CliOutputOptions } from "@twin.org/cli-core";
2
+ import { Command } from "commander";
3
+ /**
4
+ * Build the nft resolve command for the CLI.
5
+ * @returns The command.
6
+ */
7
+ export declare function buildCommandNftResolve(): Command;
8
+ /**
9
+ * Action the nft resolve command.
10
+ * @param opts The options for the command.
11
+ * @param opts.id The id of the NFT to resolve in urn format.
12
+ * @param opts.node The node URL.
13
+ * @param opts.explorer The explorer URL.
14
+ */
15
+ export declare function actionCommandNftResolve(opts: {
16
+ id: string;
17
+ node: string;
18
+ explorer: string;
19
+ } & CliOutputOptions): Promise<void>;
@@ -0,0 +1,22 @@
1
+ import { Command } from "commander";
2
+ /**
3
+ * Build the nft transfer command for the CLI.
4
+ * @returns The command.
5
+ */
6
+ export declare function buildCommandNftTransfer(): Command;
7
+ /**
8
+ * Action the nft transfer command.
9
+ * @param opts The options for the command.
10
+ * @param opts.seed The seed required for signing by the issuer.
11
+ * @param opts.id The id of the NFT to transfer in urn format.
12
+ * @param opts.recipient The recipient address of the NFT.
13
+ * @param opts.node The node URL.
14
+ * @param opts.explorer The explorer URL.
15
+ */
16
+ export declare function actionCommandNftTransfer(opts: {
17
+ seed: string;
18
+ id: string;
19
+ recipient: string;
20
+ node: string;
21
+ explorer: string;
22
+ }): Promise<void>;
@@ -0,0 +1,4 @@
1
+ /**
2
+ * Setup the vault for use in the CLI commands.
3
+ */
4
+ export declare function setupVault(): void;
@@ -0,0 +1,5 @@
1
+ export * from "./cli";
2
+ export * from "./commands/nftBurn";
3
+ export * from "./commands/nftMint";
4
+ export * from "./commands/nftResolve";
5
+ export * from "./commands/nftTransfer";
@@ -0,0 +1,5 @@
1
+ # @twin.org/nft-cli - Changelog
2
+
3
+ ## v0.0.1-next.3
4
+
5
+ - Initial Release