/
actions.ts
382 lines (345 loc) · 12.8 KB
/
actions.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
import type { ConfirmOptions, Connection, PublicKey, Signer, TransactionSignature } from '@solana/web3.js';
import { sendAndConfirmTransaction, SystemProgram, Transaction } from '@solana/web3.js';
import type { Field, TokenMetadata } from '@solana/spl-token-metadata';
import {
createInitializeInstruction,
createRemoveKeyInstruction,
createUpdateAuthorityInstruction,
createUpdateFieldInstruction,
pack,
unpack,
} from '@solana/spl-token-metadata';
import { TOKEN_2022_PROGRAM_ID } from '../../constants.js';
import { getSigners } from '../../actions/internal.js';
import { ExtensionType, getExtensionData, getNewAccountLenForExtensionLen } from '../extensionType.js';
import { updateTokenMetadata } from './state.js';
import { TokenAccountNotFoundError } from '../../errors.js';
import { unpackMint } from '../../state/index.js';
async function getAdditionalRentForNewMetadata(
connection: Connection,
address: PublicKey,
tokenMetadata: TokenMetadata,
programId = TOKEN_2022_PROGRAM_ID
): Promise<number> {
const info = await connection.getAccountInfo(address);
if (!info) {
throw new TokenAccountNotFoundError();
}
const extensionLen = pack(tokenMetadata).length;
const newAccountLen = getNewAccountLenForExtensionLen(
info,
address,
ExtensionType.TokenMetadata,
extensionLen,
programId
);
if (newAccountLen <= info.data.length) {
return 0;
}
const newRentExemptMinimum = await connection.getMinimumBalanceForRentExemption(newAccountLen);
return newRentExemptMinimum - info.lamports;
}
async function getAdditionalRentForUpdatedMetadata(
connection: Connection,
address: PublicKey,
field: string | Field,
value: string,
programId = TOKEN_2022_PROGRAM_ID
): Promise<number> {
const info = await connection.getAccountInfo(address);
if (!info) {
throw new TokenAccountNotFoundError();
}
const mint = unpackMint(address, info, programId);
const extensionData = getExtensionData(ExtensionType.TokenMetadata, mint.tlvData);
if (extensionData === null) {
throw new Error('TokenMetadata extension not initialized');
}
const updatedTokenMetadata = updateTokenMetadata(unpack(extensionData), field, value);
const extensionLen = pack(updatedTokenMetadata).length;
const newAccountLen = getNewAccountLenForExtensionLen(
info,
address,
ExtensionType.TokenMetadata,
extensionLen,
programId
);
if (newAccountLen <= info.data.length) {
return 0;
}
const newRentExemptMinimum = await connection.getMinimumBalanceForRentExemption(newAccountLen);
return newRentExemptMinimum - info.lamports;
}
/**
* Initializes a TLV entry with the basic token-metadata fields.
*
* @param connection Connection to use
* @param payer Payer of the transaction fees
* @param mint Mint Account
* @param updateAuthority Update Authority
* @param mintAuthority Mint Authority
* @param name Longer name of token
* @param symbol Shortened symbol of token
* @param uri URI pointing to more metadata (image, video, etc)
* @param multiSigners Signing accounts if `authority` is a multisig
* @param confirmOptions Options for confirming the transaction
* @param programId SPL Token program account
*
* @return Signature of the confirmed transaction
*/
export async function tokenMetadataInitialize(
connection: Connection,
payer: Signer,
mint: PublicKey,
updateAuthority: PublicKey,
mintAuthority: PublicKey | Signer,
name: string,
symbol: string,
uri: string,
multiSigners: Signer[] = [],
confirmOptions?: ConfirmOptions,
programId = TOKEN_2022_PROGRAM_ID
): Promise<TransactionSignature> {
const [mintAuthorityPublicKey, signers] = getSigners(mintAuthority, multiSigners);
const transaction = new Transaction().add(
createInitializeInstruction({
programId,
metadata: mint,
updateAuthority,
mint,
mintAuthority: mintAuthorityPublicKey,
name,
symbol,
uri,
})
);
return await sendAndConfirmTransaction(connection, transaction, [payer, ...signers], confirmOptions);
}
/**
* Initializes a TLV entry with the basic token-metadata fields,
* Includes a transfer for any additional rent-exempt SOL if required.
*
* @param connection Connection to use
* @param payer Payer of the transaction fees
* @param mint Mint Account
* @param updateAuthority Update Authority
* @param mintAuthority Mint Authority
* @param name Longer name of token
* @param symbol Shortened symbol of token
* @param uri URI pointing to more metadata (image, video, etc)
* @param multiSigners Signing accounts if `authority` is a multisig
* @param confirmOptions Options for confirming the transaction
* @param programId SPL Token program account
*
* @return Signature of the confirmed transaction
*/
export async function tokenMetadataInitializeWithRentTransfer(
connection: Connection,
payer: Signer,
mint: PublicKey,
updateAuthority: PublicKey,
mintAuthority: PublicKey | Signer,
name: string,
symbol: string,
uri: string,
multiSigners: Signer[] = [],
confirmOptions?: ConfirmOptions,
programId = TOKEN_2022_PROGRAM_ID
): Promise<TransactionSignature> {
const [mintAuthorityPublicKey, signers] = getSigners(mintAuthority, multiSigners);
const transaction = new Transaction();
const lamports = await getAdditionalRentForNewMetadata(
connection,
mint,
{
updateAuthority,
mint,
name,
symbol,
uri,
additionalMetadata: [],
},
programId
);
if (lamports > 0) {
transaction.add(SystemProgram.transfer({ fromPubkey: payer.publicKey, toPubkey: mint, lamports: lamports }));
}
transaction.add(
createInitializeInstruction({
programId,
metadata: mint,
updateAuthority,
mint,
mintAuthority: mintAuthorityPublicKey,
name,
symbol,
uri,
})
);
return await sendAndConfirmTransaction(connection, transaction, [payer, ...signers], confirmOptions);
}
/**
* Updates a field in a token-metadata account.
* If the field does not exist on the account, it will be created.
* If the field does exist, it will be overwritten.
*
* The field can be one of the required fields (name, symbol, URI), or a
* totally new field denoted by a "key" string.
* @param connection Connection to use
* @param payer Payer of the transaction fees
* @param mint Mint Account
* @param updateAuthority Update Authority
* @param field Field to update in the metadata
* @param value Value to write for the field
* @param multiSigners Signing accounts if `authority` is a multisig
* @param confirmOptions Options for confirming the transaction
* @param programId SPL Token program account
*
* @return Signature of the confirmed transaction
*/
export async function tokenMetadataUpdateField(
connection: Connection,
payer: Signer,
mint: PublicKey,
updateAuthority: PublicKey | Signer,
field: string | Field,
value: string,
multiSigners: Signer[] = [],
confirmOptions?: ConfirmOptions,
programId = TOKEN_2022_PROGRAM_ID
): Promise<TransactionSignature> {
const [updateAuthorityPublicKey, signers] = getSigners(updateAuthority, multiSigners);
const transaction = new Transaction().add(
createUpdateFieldInstruction({
programId,
metadata: mint,
updateAuthority: updateAuthorityPublicKey,
field,
value,
})
);
return await sendAndConfirmTransaction(connection, transaction, [payer, ...signers], confirmOptions);
}
/**
* Updates a field in a token-metadata account.
* If the field does not exist on the account, it will be created.
* If the field does exist, it will be overwritten.
* Includes a transfer for any additional rent-exempt SOL if required.
*
* The field can be one of the required fields (name, symbol, URI), or a
* totally new field denoted by a "key" string.
* @param connection Connection to use
* @param payer Payer of the transaction fees
* @param mint Mint Account
* @param updateAuthority Update Authority
* @param field Field to update in the metadata
* @param value Value to write for the field
* @param multiSigners Signing accounts if `authority` is a multisig
* @param confirmOptions Options for confirming the transaction
* @param programId SPL Token program account
*
* @return Signature of the confirmed transaction
*/
export async function tokenMetadataUpdateFieldWithRentTransfer(
connection: Connection,
payer: Signer,
mint: PublicKey,
updateAuthority: PublicKey | Signer,
field: string | Field,
value: string,
multiSigners: Signer[] = [],
confirmOptions?: ConfirmOptions,
programId = TOKEN_2022_PROGRAM_ID
): Promise<TransactionSignature> {
const [updateAuthorityPublicKey, signers] = getSigners(updateAuthority, multiSigners);
const transaction = new Transaction();
const lamports = await getAdditionalRentForUpdatedMetadata(connection, mint, field, value, programId);
if (lamports > 0) {
transaction.add(SystemProgram.transfer({ fromPubkey: payer.publicKey, toPubkey: mint, lamports: lamports }));
}
transaction.add(
createUpdateFieldInstruction({
programId,
metadata: mint,
updateAuthority: updateAuthorityPublicKey,
field,
value,
})
);
return await sendAndConfirmTransaction(connection, transaction, [payer, ...signers], confirmOptions);
}
/**
* Remove a field in a token-metadata account.
*
* The field can be one of the required fields (name, symbol, URI), or a
* totally new field denoted by a "key" string.
* @param connection Connection to use
* @param payer Payer of the transaction fees
* @param mint Mint Account
* @param updateAuthority Update Authority
* @param key Key to remove in the additional metadata portion
* @param idempotent When true, instruction will not error if the key does not exist
* @param multiSigners Signing accounts if `authority` is a multisig
* @param confirmOptions Options for confirming the transaction
* @param programId SPL Token program account
*
* @return Signature of the confirmed transaction
*/
export async function tokenMetadataRemoveKey(
connection: Connection,
payer: Signer,
mint: PublicKey,
updateAuthority: PublicKey | Signer,
key: string,
idempotent: boolean,
multiSigners: Signer[] = [],
confirmOptions?: ConfirmOptions,
programId = TOKEN_2022_PROGRAM_ID
): Promise<TransactionSignature> {
const [updateAuthorityPublicKey, signers] = getSigners(updateAuthority, multiSigners);
const transaction = new Transaction().add(
createRemoveKeyInstruction({
programId,
metadata: mint,
updateAuthority: updateAuthorityPublicKey,
key,
idempotent,
})
);
return await sendAndConfirmTransaction(connection, transaction, [payer, ...signers], confirmOptions);
}
/**
* Update authority
*
* @param connection Connection to use
* @param payer Payer of the transaction fees
* @param mint Mint Account
* @param updateAuthority Update Authority
* @param newAuthority New authority for the token metadata, or unset
* @param multiSigners Signing accounts if `authority` is a multisig
* @param confirmOptions Options for confirming the transaction
* @param programId SPL Token program account
*
* @return Signature of the confirmed transaction
*/
export async function tokenMetadataUpdateAuthority(
connection: Connection,
payer: Signer,
mint: PublicKey,
updateAuthority: PublicKey | Signer,
newAuthority: PublicKey | null,
multiSigners: Signer[] = [],
confirmOptions?: ConfirmOptions,
programId = TOKEN_2022_PROGRAM_ID
): Promise<TransactionSignature> {
const [updateAuthorityPublicKey, signers] = getSigners(updateAuthority, multiSigners);
const transaction = new Transaction().add(
createUpdateAuthorityInstruction({
programId,
metadata: mint,
oldAuthority: updateAuthorityPublicKey,
newAuthority,
})
);
return await sendAndConfirmTransaction(connection, transaction, [payer, ...signers], confirmOptions);
}