/
nft.test.ts
397 lines (348 loc) · 12.8 KB
/
nft.test.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
/* eslint-disable sonarjs/no-duplicate-string */
import { Cardano, metadatum, nativeScriptPolicyId } from '@cardano-sdk/core';
import { FinalizeTxProps, InitializeTxProps, SingleAddressWallet } from '@cardano-sdk/wallet';
import { KeyRole, TransactionSigner, util } from '@cardano-sdk/key-management';
import { burnTokens, createStandaloneKeyAgent, submitAndConfirm, walletReady } from '../../util';
import { combineLatest, filter, firstValueFrom, map } from 'rxjs';
import { createLogger } from '@cardano-sdk/util-dev';
import { getEnv, getWallet, walletVariables } from '../../../src';
const env = getEnv(walletVariables);
const logger = createLogger();
describe('SingleAddressWallet.assets/nft', () => {
const TOKEN_METADATA_1_INDEX = 0;
const TOKEN_METADATA_2_INDEX = 1;
const TOKEN_BURN_INDEX = 2;
let wallet: SingleAddressWallet;
let policySigner: TransactionSigner;
let policyId: Cardano.PolicyId;
let policyScript: Cardano.NativeScript;
let assetIds: Cardano.AssetId[];
let fingerprints: Cardano.AssetFingerprint[];
const assetNames = ['4e46542d66696c6573', '4e46542d303031', '4e46542d303032'];
let walletAddress: Cardano.PaymentAddress;
let allMintedTokens: Cardano.TokenMap = new Map();
const coins = 10_000_000n; // number of coins to use in each transaction
beforeAll(async () => {
wallet = (await getWallet({ env, logger, name: 'Minting Wallet', polling: { interval: 50 } })).wallet;
await walletReady(wallet, coins);
const genesis = await firstValueFrom(wallet.genesisParameters$);
const keyAgent = await createStandaloneKeyAgent(
env.KEY_MANAGEMENT_PARAMS.mnemonic.split(' '),
genesis,
await wallet.keyAgent.getBip32Ed25519()
);
const derivationPath = {
index: 2,
role: KeyRole.External
};
const pubKey = await keyAgent.derivePublicKey(derivationPath);
const keyHash = await keyAgent.bip32Ed25519.getPubKeyHash(pubKey);
policySigner = new util.KeyAgentTransactionSigner(keyAgent, derivationPath);
policyScript = {
__type: Cardano.ScriptType.Native,
kind: Cardano.NativeScriptKind.RequireAllOf,
scripts: [
{
__type: Cardano.ScriptType.Native,
keyHash,
kind: Cardano.NativeScriptKind.RequireSignature
}
]
};
policyId = nativeScriptPolicyId(policyScript);
assetIds = [
Cardano.AssetId(`${policyId}${assetNames[TOKEN_METADATA_1_INDEX]}`),
Cardano.AssetId(`${policyId}${assetNames[TOKEN_METADATA_2_INDEX]}`),
Cardano.AssetId(`${policyId}${assetNames[TOKEN_BURN_INDEX]}`)
];
const tokens = new Map([
[assetIds[TOKEN_METADATA_1_INDEX], 1n],
[assetIds[TOKEN_METADATA_2_INDEX], 1n],
[assetIds[TOKEN_BURN_INDEX], 1n]
]);
fingerprints = [
Cardano.AssetFingerprint.fromParts(policyId, Cardano.AssetName(assetNames[TOKEN_METADATA_1_INDEX])),
Cardano.AssetFingerprint.fromParts(policyId, Cardano.AssetName(assetNames[TOKEN_METADATA_2_INDEX])),
Cardano.AssetFingerprint.fromParts(policyId, Cardano.AssetName(assetNames[TOKEN_BURN_INDEX]))
];
walletAddress = (await firstValueFrom(wallet.addresses$))[0].address;
const txMetadatum = metadatum.jsonToMetadatum({
[policyId]: {
'NFT-001': {
image: ['ipfs://some_hash1'],
name: 'One',
version: '1.0'
},
'NFT-002': {
image: ['ipfs://some_hash2'],
name: 'Two',
version: '1.0'
},
'NFT-files': {
description: ['NFT with different types of files'],
files: [
{
mediaType: 'video/mp4',
name: 'some name',
src: ['file://some_video_file']
},
{
mediaType: 'audio/mpeg',
name: 'some name',
src: ['file://some_audio_file', 'file://another_audio_file']
}
],
id: '1',
image: ['ipfs://somehash'],
mediaType: 'image/png',
name: 'NFT with files',
version: '1.0'
}
}
});
const auxiliaryData = {
body: {
blob: new Map([[721n, txMetadatum]])
}
};
const txProps: InitializeTxProps = {
auxiliaryData,
mint: tokens,
outputs: new Set([
{
address: walletAddress,
value: {
assets: tokens,
coins
}
}
]),
scripts: [policyScript],
witness: { extraSigners: [policySigner] }
};
const unsignedTx = await wallet.initializeTx(txProps);
const finalizeProps: FinalizeTxProps = {
auxiliaryData,
scripts: [policyScript],
tx: unsignedTx,
witness: { extraSigners: [policySigner] }
};
const signedTx = await wallet.finalizeTx(finalizeProps);
await submitAndConfirm(wallet, signedTx);
// assetIds[TOKEN_BURN_INDEX] is already burned as part of a test
allMintedTokens = new Map([
...allMintedTokens,
[assetIds[TOKEN_METADATA_1_INDEX], 1n],
[assetIds[TOKEN_METADATA_2_INDEX], 1n]
]);
// Wait until wallet is aware of the minted tokens.
await firstValueFrom(
combineLatest([wallet.assets$, wallet.balance.utxo.total$]).pipe(
filter(
([assets, balance]) =>
assets &&
assets.size === balance.assets?.size &&
assetIds.every((element) => {
const asset = assets.get(element);
// asset info with metadata has loaded
if (asset?.tokenMetadata === undefined || asset?.nftMetadata === undefined) return false;
return true;
})
)
)
);
});
afterAll(async () => {
await burnTokens({
policySigners: [policySigner],
scripts: [policyScript],
tokens: allMintedTokens,
wallet
});
wallet.shutdown();
});
it('supports multiple CIP-25 NFT metadata in one tx', async () => {
const nfts = await firstValueFrom(
combineLatest([wallet.assets$, wallet.balance.utxo.total$]).pipe(
filter(([assets, balance]) => assets.size === balance.assets?.size),
map(([assets]) => [...assets.values()].filter((asset) => !!asset.nftMetadata))
)
);
expect(nfts.find((nft) => nft.assetId === assetIds[TOKEN_METADATA_2_INDEX])).toMatchObject({
assetId: assetIds[TOKEN_METADATA_2_INDEX],
fingerprint: fingerprints[TOKEN_METADATA_2_INDEX],
mintOrBurnCount: 1,
name: assetNames[TOKEN_METADATA_2_INDEX],
nftMetadata: {
image: ['ipfs://some_hash1'],
name: 'One',
otherProperties: new Map([['version', '1.0']]),
version: '1.0'
},
policyId,
quantity: 1n,
tokenMetadata: null
});
expect(nfts.find((nft) => nft.assetId === assetIds[TOKEN_METADATA_1_INDEX])).toBeDefined();
});
it('parses CIP-25 NFT metadata with files', async () => {
const nfts = await firstValueFrom(
combineLatest([wallet.assets$, wallet.balance.utxo.total$]).pipe(
filter(([assets, balance]) => assets.size === balance.assets?.size),
map(([assets]) => [...assets.values()].filter((asset) => !!asset.nftMetadata))
)
);
expect(nfts.find((nft) => nft.assetId === assetIds[TOKEN_METADATA_1_INDEX])).toMatchObject({
assetId: assetIds[TOKEN_METADATA_1_INDEX],
fingerprint: fingerprints[TOKEN_METADATA_1_INDEX],
mintOrBurnCount: 1,
name: assetNames[TOKEN_METADATA_1_INDEX],
nftMetadata: {
description: ['NFT with different types of files'],
files: [
{
mediaType: 'video/mp4',
name: 'some name',
src: ['file://some_video_file']
},
{
mediaType: 'audio/mpeg',
name: 'some name',
src: ['file://some_audio_file', 'file://another_audio_file']
}
],
image: ['ipfs://somehash'],
mediaType: 'image/png',
name: 'NFT with files',
otherProperties: new Map([
['id', '1'],
['version', '1.0']
]),
version: '1.0'
},
policyId,
quantity: 1n,
tokenMetadata: null
});
});
it('supports burning tokens', async () => {
// Make sure the wallet has sufficient funds to run this test
walletReady(wallet, coins);
// spend entire balance of test asset
const availableBalance = await firstValueFrom(wallet.balance.utxo.available$);
const assetBalance = availableBalance.assets!.get(assetIds[TOKEN_BURN_INDEX])!;
expect(assetBalance).toBeGreaterThan(0n);
const txProps: InitializeTxProps = {
mint: new Map([[assetIds[TOKEN_BURN_INDEX], -assetBalance]]),
outputs: new Set([
{
address: walletAddress,
value: {
coins
}
}
]),
scripts: [policyScript],
witness: { extraSigners: [policySigner] }
};
const unsignedTx = await wallet.initializeTx(txProps);
const finalizeProps: FinalizeTxProps = {
scripts: [policyScript],
tx: unsignedTx,
witness: { extraSigners: [policySigner] }
};
const signedTx = await wallet.finalizeTx(finalizeProps);
await submitAndConfirm(wallet, signedTx);
// Wait until wallet is aware of the burned token.
await firstValueFrom(
wallet.balance.utxo.total$.pipe(
filter(({ assets }) => (assets ? !assets.has(assetIds[TOKEN_BURN_INDEX]) : false))
)
);
const nfts = await firstValueFrom(
combineLatest([wallet.assets$, wallet.balance.utxo.total$]).pipe(
filter(([assets, balance]) => assets.size === balance.assets?.size),
map(([assets]) => [...assets.values()].filter((asset) => !!asset.nftMetadata))
)
);
expect(nfts.find((nft) => nft.assetId === assetIds[TOKEN_BURN_INDEX])).toBeUndefined();
});
describe('CIP-0025 v1 and v2', () => {
// eslint-disable-next-line unicorn/consistent-function-scoping
const CIP0025Test = (testName: string, assetName: string, version: 1 | 2, encoding?: 'hex' | 'utf8') =>
it(testName, async () => {
// Make sure the wallet has sufficient funds to run this test
walletReady(wallet, coins);
const assetNameHex = Buffer.from(assetName).toString('hex');
const assetId = Cardano.AssetId(`${policyId}${assetNameHex}`);
const fingerprint = Cardano.AssetFingerprint.fromParts(policyId, Cardano.AssetName(assetNameHex));
const tokens = new Map([[assetId, 1n]]);
const txDataMetadatum = new Map([
[
version === 1 ? policyId : Buffer.from(policyId, 'hex'),
new Map([
[
version === 1 ? (encoding === 'hex' ? assetNameHex : assetName) : Buffer.from(assetName),
metadatum.jsonToMetadatum({
image: ['ipfs://some_hash1'],
name: assetName,
version: '1.0'
})
]
])
]
]);
const auxiliaryData = { body: { blob: new Map([[721n, txDataMetadatum]]) } };
const txProps: InitializeTxProps = {
auxiliaryData,
mint: tokens,
outputs: new Set([
{
address: walletAddress,
value: {
assets: tokens,
coins
}
}
]),
scripts: [policyScript],
witness: { extraSigners: [policySigner] }
};
const unsignedTx = await wallet.initializeTx(txProps);
const finalizeProps: FinalizeTxProps = {
auxiliaryData,
scripts: [policyScript],
tx: unsignedTx,
witness: { extraSigners: [policySigner] }
};
const signedTx = await wallet.finalizeTx(finalizeProps);
await submitAndConfirm(wallet, signedTx);
allMintedTokens = new Map([...allMintedTokens, ...tokens]);
// try remove the asset.nftMetadata filter
const nfts = await firstValueFrom(
combineLatest([wallet.assets$, wallet.balance.utxo.total$]).pipe(
filter(([assets, balance]) => assets.size === balance.assets?.size),
map(([assets]) => [...assets.values()].filter((asset) => !!asset.nftMetadata))
)
);
expect(nfts.find((nft) => nft.assetId === assetId)).toMatchObject({
assetId,
fingerprint,
mintOrBurnCount: 1,
name: assetNameHex,
nftMetadata: {
image: ['ipfs://some_hash1'],
name: assetName,
otherProperties: new Map([['version', '1.0']]),
version: '1.0'
},
policyId,
quantity: 1n,
tokenMetadata: null
});
});
CIP0025Test('supports CIP-25 v1, assetName hex encoded', 'CIP-0025-v1-hex', 1, 'hex');
CIP0025Test('supports CIP-25 v1, assetName utf8 encoded', 'CIP-0025-v1-utf8', 1, 'utf8');
CIP0025Test('supports CIP-25 v2', 'CIP-0025-v2', 2);
});
});