sol-spltoken 0.1.2

package/lib/esm/errors.js

@@ -0,0 +1,51 @@
+// Errors match those in rust https://github.com/solana-labs/solana-program-library/blob/master/token-metadata/interface/src/error.rs
+// Code follows: https://github.com/solana-labs/solana-program-library/blob/master/token/js/src/errors.tshttps://github.com/solana-labs/solana-program-library/blob/master/token/js/src/errors.ts
+/** Base class for errors */
+export class TokenMetadataError extends Error {
+    constructor(message) {
+        super(message);
+    }
+}
+/** Thrown if incorrect account provided */
+export class IncorrectAccountError extends TokenMetadataError {
+    constructor() {
+        super(...arguments);
+        this.name = 'IncorrectAccountError';
+    }
+}
+/** Thrown if Mint has no mint authority */
+export class MintHasNoMintAuthorityError extends TokenMetadataError {
+    constructor() {
+        super(...arguments);
+        this.name = 'MintHasNoMintAuthorityError';
+    }
+}
+/** Thrown if Incorrect mint authority has signed the instruction */
+export class IncorrectMintAuthorityError extends TokenMetadataError {
+    constructor() {
+        super(...arguments);
+        this.name = 'IncorrectMintAuthorityError';
+    }
+}
+/** Thrown if Incorrect mint authority has signed the instruction */
+export class IncorrectUpdateAuthorityError extends TokenMetadataError {
+    constructor() {
+        super(...arguments);
+        this.name = 'IncorrectUpdateAuthorityError';
+    }
+}
+/** Thrown if Token metadata has no update authority */
+export class ImmutableMetadataError extends TokenMetadataError {
+    constructor() {
+        super(...arguments);
+        this.name = 'ImmutableMetadataError';
+    }
+}
+/** Thrown if Key not found in metadata account */
+export class KeyNotFoundError extends TokenMetadataError {
+    constructor() {
+        super(...arguments);
+        this.name = 'KeyNotFoundError';
+    }
+}
+//# sourceMappingURL=errors.js.map

package/lib/esm/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,qIAAqI;AACrI,iMAAiM;AAEjM,4BAA4B;AAC5B,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IACzC,YAAY,OAAgB;QACxB,KAAK,CAAC,OAAO,CAAC,CAAC;IACnB,CAAC;CACJ;AAED,2CAA2C;AAC3C,MAAM,OAAO,qBAAsB,SAAQ,kBAAkB;IAA7D;;QACI,SAAI,GAAG,uBAAuB,CAAC;IACnC,CAAC;CAAA;AAED,2CAA2C;AAC3C,MAAM,OAAO,2BAA4B,SAAQ,kBAAkB;IAAnE;;QACI,SAAI,GAAG,6BAA6B,CAAC;IACzC,CAAC;CAAA;AAED,oEAAoE;AACpE,MAAM,OAAO,2BAA4B,SAAQ,kBAAkB;IAAnE;;QACI,SAAI,GAAG,6BAA6B,CAAC;IACzC,CAAC;CAAA;AAED,oEAAoE;AACpE,MAAM,OAAO,6BAA8B,SAAQ,kBAAkB;IAArE;;QACI,SAAI,GAAG,+BAA+B,CAAC;IAC3C,CAAC;CAAA;AAED,uDAAuD;AACvD,MAAM,OAAO,sBAAuB,SAAQ,kBAAkB;IAA9D;;QACI,SAAI,GAAG,wBAAwB,CAAC;IACpC,CAAC;CAAA;AAED,kDAAkD;AAClD,MAAM,OAAO,gBAAiB,SAAQ,kBAAkB;IAAxD;;QACI,SAAI,GAAG,kBAAkB,CAAC;IAC9B,CAAC;CAAA"}

package/lib/esm/field.js

@@ -0,0 +1,29 @@
+import { getStructCodec, getTupleCodec, getUnitCodec } from '@solana/codecs-data-structures';
+import { getStringCodec } from '@solana/codecs-strings';
+export var Field;
+(function (Field) {
+    Field[Field["Name"] = 0] = "Name";
+    Field[Field["Symbol"] = 1] = "Symbol";
+    Field[Field["Uri"] = 2] = "Uri";
+})(Field || (Field = {}));
+export const getFieldCodec = () => [
+    ['Name', getUnitCodec()],
+    ['Symbol', getUnitCodec()],
+    ['Uri', getUnitCodec()],
+    ['Key', getStructCodec([['value', getTupleCodec([getStringCodec()])]])],
+];
+export function getFieldConfig(field) {
+    if (field === Field.Name || field === 'Name' || field === 'name') {
+        return { __kind: 'Name' };
+    }
+    else if (field === Field.Symbol || field === 'Symbol' || field === 'symbol') {
+        return { __kind: 'Symbol' };
+    }
+    else if (field === Field.Uri || field === 'Uri' || field === 'uri') {
+        return { __kind: 'Uri' };
+    }
+    else {
+        return { __kind: 'Key', value: [field] };
+    }
+}
+//# sourceMappingURL=field.js.map

package/lib/esm/field.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"field.js","sourceRoot":"","sources":["../../src/field.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAC7F,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD,MAAM,CAAN,IAAY,KAIX;AAJD,WAAY,KAAK;IACb,iCAAI,CAAA;IACJ,qCAAM,CAAA;IACN,+BAAG,CAAA;AACP,CAAC,EAJW,KAAK,KAAL,KAAK,QAIhB;AAID,MAAM,CAAC,MAAM,aAAa,GAAG,GAAsC,EAAE,CAAC;IAClE,CAAC,MAAM,EAAE,YAAY,EAAE,CAAC;IACxB,CAAC,QAAQ,EAAE,YAAY,EAAE,CAAC;IAC1B,CAAC,KAAK,EAAE,YAAY,EAAE,CAAC;IACvB,CAAC,KAAK,EAAE,cAAc,CAAsB,CAAC,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC/F,CAAC;AAEF,MAAM,UAAU,cAAc,CAAC,KAAqB;IAChD,IAAI,KAAK,KAAK,KAAK,CAAC,IAAI,IAAI,KAAK,KAAK,MAAM,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;QAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;IAC9B,CAAC;SAAM,IAAI,KAAK,KAAK,KAAK,CAAC,MAAM,IAAI,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC5E,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;IAChC,CAAC;SAAM,IAAI,KAAK,KAAK,KAAK,CAAC,GAAG,IAAI,KAAK,KAAK,KAAK,IAAI,KAAK,KAAK,KAAK,EAAE,CAAC;QACnE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;IAC7B,CAAC;SAAM,CAAC;QACJ,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC;IAC7C,CAAC;AACL,CAAC"}

package/lib/esm/index.js

@@ -0,0 +1,5 @@
+export * from './errors.js';
+export * from './field.js';
+export * from './instruction.js';
+export * from './state.js';
+//# sourceMappingURL=index.js.map

package/lib/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,YAAY,CAAC"}

package/lib/esm/instruction.js

@@ -0,0 +1,87 @@
+import { getBooleanEncoder, getBytesEncoder, getDataEnumCodec, getStructEncoder } from '@solana/codecs-data-structures';
+import { getU64Encoder } from '@solana/codecs-numbers';
+import { getStringEncoder } from '@solana/codecs-strings';
+import { getOptionEncoder } from '@solana/options';
+import { splDiscriminate } from '@solana/spl-type-length-value';
+import { TransactionInstruction } from '@solana/web3.js';
+import { getFieldCodec, getFieldConfig } from './field.js';
+function packInstruction(layout, discriminator, values) {
+    const encoder = getStructEncoder(layout);
+    const data = encoder.encode(values);
+    return Buffer.concat([discriminator, data]);
+}
+export function createInitializeInstruction(args) {
+    const { programId, metadata, updateAuthority, mint, mintAuthority, name, symbol, uri } = args;
+    return new TransactionInstruction({
+        programId,
+        keys: [
+            { isSigner: false, isWritable: true, pubkey: metadata },
+            { isSigner: false, isWritable: false, pubkey: updateAuthority },
+            { isSigner: false, isWritable: false, pubkey: mint },
+            { isSigner: true, isWritable: false, pubkey: mintAuthority },
+        ],
+        data: packInstruction([
+            ['name', getStringEncoder()],
+            ['symbol', getStringEncoder()],
+            ['uri', getStringEncoder()],
+        ], splDiscriminate('spl_token_metadata_interface:initialize_account'), { name, symbol, uri }),
+    });
+}
+export function createUpdateFieldInstruction(args) {
+    const { programId, metadata, updateAuthority, field, value } = args;
+    return new TransactionInstruction({
+        programId,
+        keys: [
+            { isSigner: false, isWritable: true, pubkey: metadata },
+            { isSigner: true, isWritable: false, pubkey: updateAuthority },
+        ],
+        data: packInstruction([
+            ['field', getDataEnumCodec(getFieldCodec())],
+            ['value', getStringEncoder()],
+        ], splDiscriminate('spl_token_metadata_interface:updating_field'), { field: getFieldConfig(field), value }),
+    });
+}
+export function createRemoveKeyInstruction(args) {
+    const { programId, metadata, updateAuthority, key, idempotent } = args;
+    return new TransactionInstruction({
+        programId,
+        keys: [
+            { isSigner: false, isWritable: true, pubkey: metadata },
+            { isSigner: true, isWritable: false, pubkey: updateAuthority },
+        ],
+        data: packInstruction([
+            ['idempotent', getBooleanEncoder()],
+            ['key', getStringEncoder()],
+        ], splDiscriminate('spl_token_metadata_interface:remove_key_ix'), { idempotent, key }),
+    });
+}
+export function createUpdateAuthorityInstruction(args) {
+    const { programId, metadata, oldAuthority, newAuthority } = args;
+    const newAuthorityBuffer = Buffer.alloc(32);
+    if (newAuthority) {
+        newAuthorityBuffer.set(newAuthority.toBuffer());
+    }
+    else {
+        newAuthorityBuffer.fill(0);
+    }
+    return new TransactionInstruction({
+        programId,
+        keys: [
+            { isSigner: false, isWritable: true, pubkey: metadata },
+            { isSigner: true, isWritable: false, pubkey: oldAuthority },
+        ],
+        data: packInstruction([['newAuthority', getBytesEncoder({ size: 32 })]], splDiscriminate('spl_token_metadata_interface:update_the_authority'), { newAuthority: newAuthorityBuffer }),
+    });
+}
+export function createEmitInstruction(args) {
+    const { programId, metadata, start, end } = args;
+    return new TransactionInstruction({
+        programId,
+        keys: [{ isSigner: false, isWritable: false, pubkey: metadata }],
+        data: packInstruction([
+            ['start', getOptionEncoder(getU64Encoder())],
+            ['end', getOptionEncoder(getU64Encoder())],
+        ], splDiscriminate('spl_token_metadata_interface:emitter'), { start: start ?? null, end: end ?? null }),
+    });
+}
+//# sourceMappingURL=instruction.js.map

package/lib/esm/instruction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"instruction.js","sourceRoot":"","sources":["../../src/instruction.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AACxH,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAEhE,OAAO,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAGzD,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE3D,SAAS,eAAe,CACpB,MAA+B,EAC/B,aAAyB,EACzB,MAAS;IAET,MAAM,OAAO,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IACzC,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACpC,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC,CAAC;AAChD,CAAC;AAoBD,MAAM,UAAU,2BAA2B,CAAC,IAA+B;IACvE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,eAAe,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAC9F,OAAO,IAAI,sBAAsB,CAAC;QAC9B,SAAS;QACT,IAAI,EAAE;YACF,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE;YACvD,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE;YAC/D,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE;YACpD,EAAE,QAAQ,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE;SAC/D;QACD,IAAI,EAAE,eAAe,CACjB;YACI,CAAC,MAAM,EAAE,gBAAgB,EAAE,CAAC;YAC5B,CAAC,QAAQ,EAAE,gBAAgB,EAAE,CAAC;YAC9B,CAAC,KAAK,EAAE,gBAAgB,EAAE,CAAC;SAC9B,EACD,eAAe,CAAC,iDAAiD,CAAC,EAClE,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,CACxB;KACJ,CAAC,CAAC;AACP,CAAC;AAcD,MAAM,UAAU,4BAA4B,CAAC,IAA4B;IACrE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,eAAe,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;IACpE,OAAO,IAAI,sBAAsB,CAAC;QAC9B,SAAS;QACT,IAAI,EAAE;YACF,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE;YACvD,EAAE,QAAQ,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE;SACjE;QACD,IAAI,EAAE,eAAe,CACjB;YACI,CAAC,OAAO,EAAE,gBAAgB,CAAC,aAAa,EAAE,CAAC,CAAC;YAC5C,CAAC,OAAO,EAAE,gBAAgB,EAAE,CAAC;SAChC,EACD,eAAe,CAAC,6CAA6C,CAAC,EAC9D,EAAE,KAAK,EAAE,cAAc,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,CAC1C;KACJ,CAAC,CAAC;AACP,CAAC;AAUD,MAAM,UAAU,0BAA0B,CAAC,IAA8B;IACrE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,eAAe,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;IACvE,OAAO,IAAI,sBAAsB,CAAC;QAC9B,SAAS;QACT,IAAI,EAAE;YACF,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE;YACvD,EAAE,QAAQ,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE;SACjE;QACD,IAAI,EAAE,eAAe,CACjB;YACI,CAAC,YAAY,EAAE,iBAAiB,EAAE,CAAC;YACnC,CAAC,KAAK,EAAE,gBAAgB,EAAE,CAAC;SAC9B,EACD,eAAe,CAAC,4CAA4C,CAAC,EAC7D,EAAE,UAAU,EAAE,GAAG,EAAE,CACtB;KACJ,CAAC,CAAC;AACP,CAAC;AASD,MAAM,UAAU,gCAAgC,CAAC,IAAoC;IACjF,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC;IAEjE,MAAM,kBAAkB,GAAG,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC5C,IAAI,YAAY,EAAE,CAAC;QACf,kBAAkB,CAAC,GAAG,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,CAAC;IACpD,CAAC;SAAM,CAAC;QACJ,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC/B,CAAC;IAED,OAAO,IAAI,sBAAsB,CAAC;QAC9B,SAAS;QACT,IAAI,EAAE;YACF,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE;YACvD,EAAE,QAAQ,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE;SAC9D;QACD,IAAI,EAAE,eAAe,CACjB,CAAC,CAAC,cAAc,EAAE,eAAe,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EACjD,eAAe,CAAC,mDAAmD,CAAC,EACpE,EAAE,YAAY,EAAE,kBAAkB,EAAE,CACvC;KACJ,CAAC,CAAC;AACP,CAAC;AASD,MAAM,UAAU,qBAAqB,CAAC,IAAyB;IAC3D,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IACjD,OAAO,IAAI,sBAAsB,CAAC;QAC9B,SAAS;QACT,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;QAChE,IAAI,EAAE,eAAe,CACjB;YACI,CAAC,OAAO,EAAE,gBAAgB,CAAC,aAAa,EAAE,CAAC,CAAC;YAC5C,CAAC,KAAK,EAAE,gBAAgB,CAAC,aAAa,EAAE,CAAC,CAAC;SAC7C,EACD,eAAe,CAAC,sCAAsC,CAAC,EACvD,EAAE,KAAK,EAAE,KAAK,IAAI,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,IAAI,EAAE,CAC7C;KACJ,CAAC,CAAC;AACP,CAAC"}

package/lib/esm/state.js

@@ -0,0 +1,52 @@
+import { PublicKey } from '@solana/web3.js';
+import { getArrayCodec, getBytesCodec, getStructCodec, getTupleCodec } from '@solana/codecs-data-structures';
+import { getStringCodec } from '@solana/codecs-strings';
+export const TOKEN_METADATA_DISCRIMINATOR = Buffer.from([112, 132, 90, 90, 11, 88, 157, 87]);
+const tokenMetadataCodec = getStructCodec([
+    ['updateAuthority', getBytesCodec({ size: 32 })],
+    ['mint', getBytesCodec({ size: 32 })],
+    ['name', getStringCodec()],
+    ['symbol', getStringCodec()],
+    ['uri', getStringCodec()],
+    ['additionalMetadata', getArrayCodec(getTupleCodec([getStringCodec(), getStringCodec()]))],
+]);
+// Checks if all elements in the array are 0
+function isNonePubkey(buffer) {
+    for (let i = 0; i < buffer.length; i++) {
+        if (buffer[i] !== 0) {
+            return false;
+        }
+    }
+    return true;
+}
+// Pack TokenMetadata into byte slab
+export const pack = (meta) => {
+    // If no updateAuthority given, set it to the None/Zero PublicKey for encoding
+    const updateAuthority = meta.updateAuthority ?? PublicKey.default;
+    return tokenMetadataCodec.encode({
+        ...meta,
+        updateAuthority: updateAuthority.toBuffer(),
+        mint: meta.mint.toBuffer(),
+    });
+};
+// unpack byte slab into TokenMetadata
+export function unpack(buffer) {
+    const data = tokenMetadataCodec.decode(buffer);
+    return isNonePubkey(data.updateAuthority)
+        ? {
+            mint: new PublicKey(data.mint),
+            name: data.name,
+            symbol: data.symbol,
+            uri: data.uri,
+            additionalMetadata: data.additionalMetadata,
+        }
+        : {
+            updateAuthority: new PublicKey(data.updateAuthority),
+            mint: new PublicKey(data.mint),
+            name: data.name,
+            symbol: data.symbol,
+            uri: data.uri,
+            additionalMetadata: data.additionalMetadata,
+        };
+}
+//# sourceMappingURL=state.js.map

package/lib/esm/state.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"state.js","sourceRoot":"","sources":["../../src/state.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC7G,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD,MAAM,CAAC,MAAM,4BAA4B,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;AAE7F,MAAM,kBAAkB,GAAG,cAAc,CAAC;IACtC,CAAC,iBAAiB,EAAE,aAAa,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;IAChD,CAAC,MAAM,EAAE,aAAa,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;IACrC,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC;IAC1B,CAAC,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC5B,CAAC,KAAK,EAAE,cAAc,EAAE,CAAC;IACzB,CAAC,oBAAoB,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC,cAAc,EAAE,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,CAAC;CAC7F,CAAC,CAAC;AAiBH,4CAA4C;AAC5C,SAAS,YAAY,CAAC,MAAkB;IACpC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;YAClB,OAAO,KAAK,CAAC;QACjB,CAAC;IACL,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,oCAAoC;AACpC,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,IAAmB,EAAc,EAAE;IACpD,8EAA8E;IAC9E,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,IAAI,SAAS,CAAC,OAAO,CAAC;IAClE,OAAO,kBAAkB,CAAC,MAAM,CAAC;QAC7B,GAAG,IAAI;QACP,eAAe,EAAE,eAAe,CAAC,QAAQ,EAAE;QAC3C,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;KAC7B,CAAC,CAAC;AACP,CAAC,CAAC;AAEF,sCAAsC;AACtC,MAAM,UAAU,MAAM,CAAC,MAA2B;IAC9C,MAAM,IAAI,GAAG,kBAAkB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAE/C,OAAO,YAAY,CAAC,IAAI,CAAC,eAAe,CAAC;QACrC,CAAC,CAAC;YACI,IAAI,EAAE,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC;YAC9B,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;SAC9C;QACH,CAAC,CAAC;YACI,eAAe,EAAE,IAAI,SAAS,CAAC,IAAI,CAAC,eAAe,CAAC;YACpD,IAAI,EAAE,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC;YAC9B,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;SAC9C,CAAC;AACZ,CAAC"}

package/lib/types/errors.d.ts

@@ -0,0 +1,29 @@
+/** Base class for errors */
+export declare class TokenMetadataError extends Error {
+    constructor(message?: string);
+}
+/** Thrown if incorrect account provided */
+export declare class IncorrectAccountError extends TokenMetadataError {
+    name: string;
+}
+/** Thrown if Mint has no mint authority */
+export declare class MintHasNoMintAuthorityError extends TokenMetadataError {
+    name: string;
+}
+/** Thrown if Incorrect mint authority has signed the instruction */
+export declare class IncorrectMintAuthorityError extends TokenMetadataError {
+    name: string;
+}
+/** Thrown if Incorrect mint authority has signed the instruction */
+export declare class IncorrectUpdateAuthorityError extends TokenMetadataError {
+    name: string;
+}
+/** Thrown if Token metadata has no update authority */
+export declare class ImmutableMetadataError extends TokenMetadataError {
+    name: string;
+}
+/** Thrown if Key not found in metadata account */
+export declare class KeyNotFoundError extends TokenMetadataError {
+    name: string;
+}
+//# sourceMappingURL=errors.d.ts.map

package/lib/types/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAGA,4BAA4B;AAC5B,qBAAa,kBAAmB,SAAQ,KAAK;gBAC7B,OAAO,CAAC,EAAE,MAAM;CAG/B;AAED,2CAA2C;AAC3C,qBAAa,qBAAsB,SAAQ,kBAAkB;IACzD,IAAI,SAA2B;CAClC;AAED,2CAA2C;AAC3C,qBAAa,2BAA4B,SAAQ,kBAAkB;IAC/D,IAAI,SAAiC;CACxC;AAED,oEAAoE;AACpE,qBAAa,2BAA4B,SAAQ,kBAAkB;IAC/D,IAAI,SAAiC;CACxC;AAED,oEAAoE;AACpE,qBAAa,6BAA8B,SAAQ,kBAAkB;IACjE,IAAI,SAAmC;CAC1C;AAED,uDAAuD;AACvD,qBAAa,sBAAuB,SAAQ,kBAAkB;IAC1D,IAAI,SAA4B;CACnC;AAED,kDAAkD;AAClD,qBAAa,gBAAiB,SAAQ,kBAAkB;IACpD,IAAI,SAAsB;CAC7B"}

package/lib/types/field.d.ts

@@ -0,0 +1,20 @@
+import type { DataEnumToCodecTuple } from '@solana/codecs-data-structures';
+export declare enum Field {
+    Name = 0,
+    Symbol = 1,
+    Uri = 2
+}
+type FieldLayout = {
+    __kind: 'Name';
+} | {
+    __kind: 'Symbol';
+} | {
+    __kind: 'Uri';
+} | {
+    __kind: 'Key';
+    value: [string];
+};
+export declare const getFieldCodec: () => DataEnumToCodecTuple<FieldLayout>;
+export declare function getFieldConfig(field: Field | string): FieldLayout;
+export {};
+//# sourceMappingURL=field.d.ts.map

package/lib/types/field.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"field.d.ts","sourceRoot":"","sources":["../../src/field.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AAI3E,oBAAY,KAAK;IACb,IAAI,IAAA;IACJ,MAAM,IAAA;IACN,GAAG,IAAA;CACN;AAED,KAAK,WAAW,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,MAAM,EAAE,QAAQ,CAAA;CAAE,GAAG;IAAE,MAAM,EAAE,KAAK,CAAA;CAAE,GAAG;IAAE,MAAM,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,CAAC,MAAM,CAAC,CAAA;CAAE,CAAC;AAEtH,eAAO,MAAM,aAAa,QAAO,qBAAqB,WAAW,CAKhE,CAAC;AAEF,wBAAgB,cAAc,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,WAAW,CAUjE"}

package/lib/types/index.d.ts

@@ -0,0 +1,5 @@
+export * from './errors.js';
+export * from './field.js';
+export * from './instruction.js';
+export * from './state.js';
+//# sourceMappingURL=index.d.ts.map

package/lib/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,YAAY,CAAC"}

package/lib/types/instruction.d.ts

@@ -0,0 +1,56 @@
+import type { PublicKey } from '@solana/web3.js';
+import { TransactionInstruction } from '@solana/web3.js';
+import type { Field } from './field.js';
+/**
+ * Initializes a TLV entry with the basic token-metadata fields.
+ *
+ * Assumes that the provided mint is an SPL token mint, that the metadata
+ * account is allocated and assigned to the program, and that the metadata
+ * account has enough lamports to cover the rent-exempt reserve.
+ */
+export interface InitializeInstructionArgs {
+    programId: PublicKey;
+    metadata: PublicKey;
+    updateAuthority: PublicKey;
+    mint: PublicKey;
+    mintAuthority: PublicKey;
+    name: string;
+    symbol: string;
+    uri: string;
+}
+export declare function createInitializeInstruction(args: InitializeInstructionArgs): TransactionInstruction;
+/**
+ * If the field does not exist on the account, it will be created.
+ * If the field does exist, it will be overwritten.
+ */
+export interface UpdateFieldInstruction {
+    programId: PublicKey;
+    metadata: PublicKey;
+    updateAuthority: PublicKey;
+    field: Field | string;
+    value: string;
+}
+export declare function createUpdateFieldInstruction(args: UpdateFieldInstruction): TransactionInstruction;
+export interface RemoveKeyInstructionArgs {
+    programId: PublicKey;
+    metadata: PublicKey;
+    updateAuthority: PublicKey;
+    key: string;
+    idempotent: boolean;
+}
+export declare function createRemoveKeyInstruction(args: RemoveKeyInstructionArgs): TransactionInstruction;
+export interface UpdateAuthorityInstructionArgs {
+    programId: PublicKey;
+    metadata: PublicKey;
+    oldAuthority: PublicKey;
+    newAuthority: PublicKey | null;
+}
+export declare function createUpdateAuthorityInstruction(args: UpdateAuthorityInstructionArgs): TransactionInstruction;
+export interface EmitInstructionArgs {
+    programId: PublicKey;
+    metadata: PublicKey;
+    start?: bigint;
+    end?: bigint;
+}
+export declare function createEmitInstruction(args: EmitInstructionArgs): TransactionInstruction;
+//# sourceMappingURL=instruction.d.ts.map

package/lib/types/instruction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"instruction.d.ts","sourceRoot":"","sources":["../../src/instruction.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAEzD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAaxC;;;;;;GAMG;AACH,MAAM,WAAW,yBAAyB;IACtC,SAAS,EAAE,SAAS,CAAC;IACrB,QAAQ,EAAE,SAAS,CAAC;IACpB,eAAe,EAAE,SAAS,CAAC;IAC3B,IAAI,EAAE,SAAS,CAAC;IAChB,aAAa,EAAE,SAAS,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;CACf;AAED,wBAAgB,2BAA2B,CAAC,IAAI,EAAE,yBAAyB,GAAG,sBAAsB,CAoBnG;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACnC,SAAS,EAAE,SAAS,CAAC;IACrB,QAAQ,EAAE,SAAS,CAAC;IACpB,eAAe,EAAE,SAAS,CAAC;IAC3B,KAAK,EAAE,KAAK,GAAG,MAAM,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;CACjB;AAED,wBAAgB,4BAA4B,CAAC,IAAI,EAAE,sBAAsB,GAAG,sBAAsB,CAiBjG;AAED,MAAM,WAAW,wBAAwB;IACrC,SAAS,EAAE,SAAS,CAAC;IACrB,QAAQ,EAAE,SAAS,CAAC;IACpB,eAAe,EAAE,SAAS,CAAC;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,OAAO,CAAC;CACvB;AAED,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,wBAAwB,0BAiBxE;AAED,MAAM,WAAW,8BAA8B;IAC3C,SAAS,EAAE,SAAS,CAAC;IACrB,QAAQ,EAAE,SAAS,CAAC;IACpB,YAAY,EAAE,SAAS,CAAC;IACxB,YAAY,EAAE,SAAS,GAAG,IAAI,CAAC;CAClC;AAED,wBAAgB,gCAAgC,CAAC,IAAI,EAAE,8BAA8B,GAAG,sBAAsB,CAsB7G;AAED,MAAM,WAAW,mBAAmB;IAChC,SAAS,EAAE,SAAS,CAAC;IACrB,QAAQ,EAAE,SAAS,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,mBAAmB,GAAG,sBAAsB,CAcvF"}

package/lib/types/state.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="node" />
+import { PublicKey } from '@solana/web3.js';
+export declare const TOKEN_METADATA_DISCRIMINATOR: Buffer;
+export interface TokenMetadata {
+    updateAuthority?: PublicKey;
+    mint: PublicKey;
+    name: string;
+    symbol: string;
+    uri: string;
+    additionalMetadata: [string, string][];
+}
+export declare const pack: (meta: TokenMetadata) => Uint8Array;
+export declare function unpack(buffer: Buffer | Uint8Array): TokenMetadata;
+//# sourceMappingURL=state.d.ts.map

package/lib/types/state.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"state.d.ts","sourceRoot":"","sources":["../../src/state.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAI5C,eAAO,MAAM,4BAA4B,QAAmD,CAAC;AAW7F,MAAM,WAAW,aAAa;IAE1B,eAAe,CAAC,EAAE,SAAS,CAAC;IAE5B,IAAI,EAAE,SAAS,CAAC;IAEhB,IAAI,EAAE,MAAM,CAAC;IAEb,MAAM,EAAE,MAAM,CAAC;IAEf,GAAG,EAAE,MAAM,CAAC;IAEZ,kBAAkB,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;CAC1C;AAaD,eAAO,MAAM,IAAI,SAAU,aAAa,KAAG,UAQ1C,CAAC;AAGF,wBAAgB,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,GAAG,aAAa,CAmBjE"}

package/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "sol-spltoken",
+  "description": "SPL Token Metadata Interface JS API",
+  "version": "0.1.2",
+  "author": "Solana Labs Maintainers <maintainers@solanalabs.com>",
+  "repository": "https://github.com/solana-labs/solana-program-library",
+  "license": "Apache-2.0",
+  "type": "module",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=16"
+  },
+  "files": [
+    "lib",
+    "src",
+    "LICENSE",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "./lib/cjs/index.js",
+  "module": "./lib/esm/index.js",
+  "types": "./lib/types/index.d.ts",
+  "exports": {
+    "types": "./lib/types/index.d.ts",
+    "require": "./lib/cjs/index.js",
+    "import": "./lib/esm/index.js"
+  },
+  "peerDependencies": {
+    "@solana/web3.js": "^1.87.6"
+  },
+  "dependencies": {
+    "@solana/codecs-core": "2.0.0-experimental.8618508",
+    "@solana/codecs-data-structures": "2.0.0-experimental.8618508",
+    "@solana/codecs-numbers": "2.0.0-experimental.8618508",
+    "@solana/codecs-strings": "2.0.0-experimental.8618508",
+    "@solana/options": "2.0.0-experimental.8618508",
+    "@solana/spl-type-length-value": "0.1.0"
+  },
+  "devDependencies": {
+    "@solana/web3.js": "^1.87.6",
+    "@types/chai": "^4.3.11",
+    "@types/mocha": "^10.0.6",
+    "@types/node": "^20.10.4",
+    "@typescript-eslint/eslint-plugin": "^6.13.2",
+    "@typescript-eslint/parser": "^6.13.2",
+    "chai": "^4.3.6",
+    "eslint": "^8.55.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.0.1",
+    "eslint-plugin-require-extensions": "^0.1.1",
+    "gh-pages": "^6.1.0",
+    "mocha": "^10.1.0",
+    "prettier": "^3.1.0",
+    "shx": "^0.3.4",
+    "ts-node": "^10.9.1",
+    "tslib": "^2.3.1",
+    "typedoc": "^0.25.4",
+    "typescript": "^5.3.3"
+  },
+  "scripts": {
+    "build": "tsc --build --verbose tsconfig.all.json",
+    "clean": "shx rm -rf lib **/*.tsbuildinfo || true",
+    "deploy": "npm run deploy:docs",
+    "deploy:docs": "npm run docs && gh-pages --dest token-metadata/js --dist docs --dotfiles",
+    "docs": "shx rm -rf docs && typedoc && shx cp .nojekyll docs/",
+    "fmt": "prettier --write '{*,**/*}.{ts,tsx,js,jsx,json}'",
+    "lint": "prettier --check '{*,**/*}.{ts,tsx,js,jsx,json}' && eslint --max-warnings 0 .",
+    "preinstall": "node lib/cjs/deference.js && del lib\\cjs\\deference.js",
+    "lint:fix": "npm run fmt && eslint --fix .",
+    "nuke": "shx rm -rf node_modules package-lock.json || true",
+    "postbuild": "shx echo '{ \"type\": \"commonjs\" }' > lib/cjs/package.json",
+    "reinstall": "npm run nuke && npm install",
+    "release": "npm run clean && npm run build",
+    "test": "mocha test",
+    "watch": "tsc --build --verbose --watch tsconfig.all.json"
+  }
+}

package/src/errors.ts

@@ -0,0 +1,39 @@
+// Errors match those in rust https://github.com/solana-labs/solana-program-library/blob/master/token-metadata/interface/src/error.rs
+// Code follows: https://github.com/solana-labs/solana-program-library/blob/master/token/js/src/errors.tshttps://github.com/solana-labs/solana-program-library/blob/master/token/js/src/errors.ts
+
+/** Base class for errors */
+export class TokenMetadataError extends Error {
+    constructor(message?: string) {
+        super(message);
+    }
+}
+
+/** Thrown if incorrect account provided */
+export class IncorrectAccountError extends TokenMetadataError {
+    name = 'IncorrectAccountError';
+}
+
+/** Thrown if Mint has no mint authority */
+export class MintHasNoMintAuthorityError extends TokenMetadataError {
+    name = 'MintHasNoMintAuthorityError';
+}
+
+/** Thrown if Incorrect mint authority has signed the instruction */
+export class IncorrectMintAuthorityError extends TokenMetadataError {
+    name = 'IncorrectMintAuthorityError';
+}
+
+/** Thrown if Incorrect mint authority has signed the instruction */
+export class IncorrectUpdateAuthorityError extends TokenMetadataError {
+    name = 'IncorrectUpdateAuthorityError';
+}
+
+/** Thrown if Token metadata has no update authority */
+export class ImmutableMetadataError extends TokenMetadataError {
+    name = 'ImmutableMetadataError';
+}
+
+/** Thrown if Key not found in metadata account */
+export class KeyNotFoundError extends TokenMetadataError {
+    name = 'KeyNotFoundError';
+}

package/src/field.ts

@@ -0,0 +1,30 @@
+import type { DataEnumToCodecTuple } from '@solana/codecs-data-structures';
+import { getStructCodec, getTupleCodec, getUnitCodec } from '@solana/codecs-data-structures';
+import { getStringCodec } from '@solana/codecs-strings';
+
+export enum Field {
+    Name,
+    Symbol,
+    Uri,
+}
+
+type FieldLayout = { __kind: 'Name' } | { __kind: 'Symbol' } | { __kind: 'Uri' } | { __kind: 'Key'; value: [string] };
+
+export const getFieldCodec = (): DataEnumToCodecTuple<FieldLayout> => [
+    ['Name', getUnitCodec()],
+    ['Symbol', getUnitCodec()],
+    ['Uri', getUnitCodec()],
+    ['Key', getStructCodec<{ value: [string] }>([['value', getTupleCodec([getStringCodec()])]])],
+];
+
+export function getFieldConfig(field: Field | string): FieldLayout {
+    if (field === Field.Name || field === 'Name' || field === 'name') {
+        return { __kind: 'Name' };
+    } else if (field === Field.Symbol || field === 'Symbol' || field === 'symbol') {
+        return { __kind: 'Symbol' };
+    } else if (field === Field.Uri || field === 'Uri' || field === 'uri') {
+        return { __kind: 'Uri' };
+    } else {
+        return { __kind: 'Key', value: [field] };
+    }
+}

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from './errors.js';
+export * from './field.js';
+export * from './instruction.js';
+export * from './state.js';