UNPKG

@bbachain/spl-token-metadata

Version:
218 lines (217 loc) 10.3 kB
"use strict"; var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { if (k2 === undefined) k2 = k; var desc = Object.getOwnPropertyDescriptor(m, k); if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { desc = { enumerable: true, get: function() { return m[k]; } }; } Object.defineProperty(o, k2, desc); }) : (function(o, m, k, k2) { if (k2 === undefined) k2 = k; o[k2] = m[k]; })); var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) { Object.defineProperty(o, "default", { enumerable: true, value: v }); }) : function(o, v) { o["default"] = v; }); var __importStar = (this && this.__importStar) || function (mod) { if (mod && mod.__esModule) return mod; var result = {}; if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k); __setModuleDefault(result, mod); return result; }; var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) { function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); } return new (P || (P = Promise))(function (resolve, reject) { function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } } function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } } function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); } step((generator = generator.apply(thisArg, _arguments || [])).next()); }); }; var __generator = (this && this.__generator) || function (thisArg, body) { var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g; return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g; function verb(n) { return function (v) { return step([n, v]); }; } function step(op) { if (f) throw new TypeError("Generator is already executing."); while (g && (g = 0, op[0] && (_ = 0)), _) try { if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t; if (y = 0, t) op = [op[0] & 2, t.value]; switch (op[0]) { case 0: case 1: t = op; break; case 4: _.label++; return { value: op[1], done: false }; case 5: _.label++; y = op[1]; op = [0]; continue; case 7: op = _.ops.pop(); _.trys.pop(); continue; default: if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; } if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; } if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; } if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; } if (t[2]) _.ops.pop(); _.trys.pop(); continue; } op = body.call(thisArg, _); } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; } if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true }; } }; exports.__esModule = true; exports.metadataBeet = exports.Metadata = void 0; var beet = __importStar(require("@bbachain/beet")); var beetBBA = __importStar(require("@bbachain/beet-bbachain")); var web3 = __importStar(require("@bbachain/web3.js")); var types_1 = require("../types"); var customSerializer = __importStar(require("../helpers/metadata-deserializer")); var __1 = require(".."); /** * Holds the data for the {@link Metadata} Account and provides de/serialization * functionality for that data * * @category Accounts */ var Metadata = /** @class */ (function () { function Metadata(key, updateAuthority, mint, data, primarySaleHappened, isMutable, tokenStandard, collection, collectionDetails, uses) { this.key = key; this.updateAuthority = updateAuthority; this.mint = mint; this.data = data; this.primarySaleHappened = primarySaleHappened; this.isMutable = isMutable; this.tokenStandard = tokenStandard; this.collection = collection; this.collectionDetails = collectionDetails; this.uses = uses; } /** * Creates a {@link Metadata} instance from the provided args. */ Metadata.fromArgs = function (args) { return new Metadata(args.key, args.updateAuthority, args.mint, args.data, args.primarySaleHappened, args.isMutable, args.tokenStandard, args.collection, args.collectionDetails, args.uses); }; /** * Deserializes the {@link Metadata} from the data of the provided {@link web3.AccountInfo}. * @returns a tuple of the account data and the offset up to which the buffer was read to obtain it. */ Metadata.fromAccountInfo = function (accountInfo, offset) { if (offset === void 0) { offset = 0; } return Metadata.deserialize(accountInfo.data, offset); }; /** * Retrieves the account info from the provided address and deserializes * the {@link Metadata} from its data. * * @throws Error if no account info is found at the address or if deserialization fails */ Metadata.fromAccountAddress = function (connection, address, commitmentOrConfig) { return __awaiter(this, void 0, void 0, function () { var accountInfo; return __generator(this, function (_a) { switch (_a.label) { case 0: return [4 /*yield*/, connection.getAccountInfo(address, commitmentOrConfig)]; case 1: accountInfo = _a.sent(); if (accountInfo == null) { throw new Error("Unable to find Metadata account at ".concat(address)); } return [2 /*return*/, Metadata.fromAccountInfo(accountInfo, 0)[0]]; } }); }); }; /** * Provides a {@link web3.Connection.getProgramAccounts} config builder, * to fetch accounts matching filters that can be specified via that builder. * * @param programId - the program that owns the accounts we are filtering */ Metadata.gpaBuilder = function (programId) { if (programId === void 0) { programId = new web3.PublicKey(__1.PROGRAM_ADDRESS); } return beetBBA.GpaBuilder.fromStruct(programId, exports.metadataBeet); }; /** * Deserializes the {@link Metadata} from the provided data Buffer. * @returns a tuple of the account data and the offset up to which the buffer was read to obtain it. */ Metadata.deserialize = function (buf, offset) { if (offset === void 0) { offset = 0; } return resolvedDeserialize(buf, offset); }; /** * Serializes the {@link Metadata} into a Buffer. * @returns a tuple of the created Buffer and the offset up to which the buffer was written to store it. */ Metadata.prototype.serialize = function () { return resolvedSerialize(this); }; /** * Returns the byteSize of a {@link Buffer} holding the serialized data of * {@link Metadata} for the provided args. * * @param args need to be provided since the byte size for this account * depends on them */ Metadata.byteSize = function (args) { var instance = Metadata.fromArgs(args); return exports.metadataBeet.toFixedFromValue(instance).byteSize; }; /** * Fetches the minimum balance needed to exempt an account holding * {@link Metadata} data from rent * * @param args need to be provided since the byte size for this account * depends on them * @param connection used to retrieve the rent exemption information */ Metadata.getMinimumBalanceForRentExemption = function (args, connection, commitment) { return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_a) { return [2 /*return*/, connection.getMinimumBalanceForRentExemption(Metadata.byteSize(args), commitment)]; }); }); }; /** * Returns a readable version of {@link Metadata} properties * and can be used to convert to JSON and/or logging */ Metadata.prototype.pretty = function () { return { key: 'Key.' + types_1.Key[this.key], updateAuthority: this.updateAuthority.toBase58(), mint: this.mint.toBase58(), data: this.data, primarySaleHappened: this.primarySaleHappened, isMutable: this.isMutable, tokenStandard: this.tokenStandard, collection: this.collection, collectionDetails: this.collectionDetails, uses: this.uses }; }; return Metadata; }()); exports.Metadata = Metadata; /** * @category Accounts */ exports.metadataBeet = new beet.FixableBeetStruct([ ['key', types_1.keyBeet], ['updateAuthority', beetBBA.publicKey], ['mint', beetBBA.publicKey], ['data', types_1.dataBeet], ['primarySaleHappened', beet.bool], ['isMutable', beet.bool], ['tokenStandard', beet.coption(types_1.tokenStandardBeet)], ['collection', beet.coption(types_1.collectionBeet)], ['collectionDetails', beet.coption(types_1.collectionDetailsBeet)], ['uses', beet.coption(types_1.usesBeet)], ], Metadata.fromArgs, 'Metadata'); var serializer = customSerializer; var resolvedSerialize = typeof serializer.serialize === 'function' ? serializer.serialize.bind(serializer) : exports.metadataBeet.serialize.bind(exports.metadataBeet); var resolvedDeserialize = typeof serializer.deserialize === 'function' ? serializer.deserialize.bind(serializer) : exports.metadataBeet.deserialize.bind(exports.metadataBeet);