@zoralabs/coins-sdk 0.2.4 → 0.2.5

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @zoralabs/coins-sdk
 
+## 0.2.5
+
+### Patch Changes
+
+- 4153eddc: Added metadata uploading feature
+
 ## 0.2.4
 
 ### Patch Changes

package/dist/actions/createCoin.d.ts

@@ -1,7 +1,7 @@
 import { coinFactoryABI as zoraFactoryImplABI } from "@zoralabs/protocol-deployments";
 import { Address, TransactionReceipt, WalletClient, SimulateContractParameters, ContractEventArgsFromTopics, Account } from "viem";
 import { GenericPublicClient } from "../utils/genericPublicClient";
-import { ValidMetadataURI } from "../metadata";
+import { ValidMetadataURI } from "../uploader/types";
 export type CoinDeploymentLogArgs = ContractEventArgsFromTopics<typeof zoraFactoryImplABI, "CoinCreatedV4">;
 export declare enum DeployCurrency {
     ZORA = 1,

package/dist/actions/createCoin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createCoin.d.ts","sourceRoot":"","sources":["../../src/actions/createCoin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACtF,OAAO,EACL,OAAO,EACP,kBAAkB,EAClB,YAAY,EACZ,0BAA0B,EAC1B,2BAA2B,EAM3B,OAAO,EACR,MAAM,MAAM,CAAC;AAId,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAA8B,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAQ3E,MAAM,MAAM,qBAAqB,GAAG,2BAA2B,CAC7D,OAAO,kBAAkB,EACzB,eAAe,CAChB,CAAC;AAEF,oBAAY,cAAc;IACxB,IAAI,IAAI;IACR,GAAG,IAAI;CACR;AAED,oBAAY,uBAAuB;IACjC,GAAG,IAAI;CAER;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,gBAAgB,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC;IACnB,eAAe,EAAE,OAAO,CAAC;IACzB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B,eAAe,CAAC,EAAE;QAChB,QAAQ,EAAE,uBAAuB,CAAC;QAClC,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH,CAAC;AAqBF,wBAAsB,cAAc,CAAC,EACnC,IAAI,EACJ,MAAM,EACN,GAAG,EACH,MAAM,EACN,eAAe,EACf,QAAQ,EACR,OAAiB,EACjB,gBAA+D,EAC/D,eAAe,GAChB,EAAE,cAAc,GAAG,OAAO,CACzB,0BAA0B,CAAC,OAAO,kBAAkB,EAAE,QAAQ,CAAC,CAChE,CA8CA;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,kBAAkB,GAC1B,qBAAqB,GAAG,SAAS,CAOnC;AAGD,wBAAsB,UAAU,CAC9B,IAAI,EAAE,cAAc,EACpB,YAAY,EAAE,YAAY,EAC1B,YAAY,EAAE,mBAAmB,EACjC,OAAO,CAAC,EAAE;IACR,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;CAC7B;;;;;;;;;;;;;;;;;;;;;;;GAyBF"}
+{"version":3,"file":"createCoin.d.ts","sourceRoot":"","sources":["../../src/actions/createCoin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACtF,OAAO,EACL,OAAO,EACP,kBAAkB,EAClB,YAAY,EACZ,0BAA0B,EAC1B,2BAA2B,EAM3B,OAAO,EACR,MAAM,MAAM,CAAC;AAId,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAEnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAQrD,MAAM,MAAM,qBAAqB,GAAG,2BAA2B,CAC7D,OAAO,kBAAkB,EACzB,eAAe,CAChB,CAAC;AAEF,oBAAY,cAAc;IACxB,IAAI,IAAI;IACR,GAAG,IAAI;CACR;AAED,oBAAY,uBAAuB;IACjC,GAAG,IAAI;CAER;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,gBAAgB,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC;IACnB,eAAe,EAAE,OAAO,CAAC;IACzB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B,eAAe,CAAC,EAAE;QAChB,QAAQ,EAAE,uBAAuB,CAAC;QAClC,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH,CAAC;AAqBF,wBAAsB,cAAc,CAAC,EACnC,IAAI,EACJ,MAAM,EACN,GAAG,EACH,MAAM,EACN,eAAe,EACf,QAAQ,EACR,OAAiB,EACjB,gBAA+D,EAC/D,eAAe,GAChB,EAAE,cAAc,GAAG,OAAO,CACzB,0BAA0B,CAAC,OAAO,kBAAkB,EAAE,QAAQ,CAAC,CAChE,CA8CA;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,kBAAkB,GAC1B,qBAAqB,GAAG,SAAS,CAOnC;AAGD,wBAAsB,UAAU,CAC9B,IAAI,EAAE,cAAc,EACpB,YAAY,EAAE,YAAY,EAC1B,YAAY,EAAE,mBAAmB,EACjC,OAAO,CAAC,EAAE;IACR,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;CAC7B;;;;;;;;;;;;;;;;;;;;;;;GAyBF"}

package/dist/api/api-key.d.ts

@@ -1,4 +1,5 @@
-export declare function setApiKey(key: string): void;
+export declare function setApiKey(key: string | undefined): void;
+export declare function getApiKey(): string | undefined;
 export declare function getApiKeyMeta(): {
     headers?: undefined;
 } | {

package/dist/api/api-key.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api-key.d.ts","sourceRoot":"","sources":["../../src/api/api-key.ts"],"names":[],"mappings":"AACA,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,QAEpC;AAED,wBAAgB,aAAa;;;;;;EAS5B"}
+{"version":3,"file":"api-key.d.ts","sourceRoot":"","sources":["../../src/api/api-key.ts"],"names":[],"mappings":"AACA,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,QAEhD;AAED,wBAAgB,SAAS,uBAExB;AAED,wBAAgB,aAAa;;;;;;EAS5B"}

package/dist/api/internal.d.ts

@@ -1,8 +1,8 @@
 import { SetCreateUploadJwtData, SetCreateUploadJwtResponse } from "../client/types.gen";
 import { RequestOptionsType } from "./query-types";
 import { RequestResult } from "@hey-api/client-fetch";
-type SetCreateUploadJwtQuery = SetCreateUploadJwtData["query"];
+type SetCreateUploadJwtQuery = SetCreateUploadJwtData["body"];
 export type { SetCreateUploadJwtQuery, SetCreateUploadJwtData };
 export type { SetCreateUploadJwtResponse } from "../client/types.gen";
-export declare const setCreateUploadJwt: (query: SetCreateUploadJwtQuery, options?: RequestOptionsType<SetCreateUploadJwtData>) => Promise<RequestResult<SetCreateUploadJwtResponse>>;
+export declare const setCreateUploadJwt: (body: SetCreateUploadJwtQuery, options?: RequestOptionsType<SetCreateUploadJwtData>) => Promise<RequestResult<SetCreateUploadJwtResponse>>;
 //# sourceMappingURL=internal.d.ts.map

package/dist/api/internal.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"internal.d.ts","sourceRoot":"","sources":["../../src/api/internal.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,0BAA0B,EAC3B,MAAM,qBAAqB,CAAC;AAG7B,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAEtD,KAAK,uBAAuB,GAAG,sBAAsB,CAAC,OAAO,CAAC,CAAC;AAC/D,YAAY,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,CAAC;AAChE,YAAY,EAAE,0BAA0B,EAAE,MAAM,qBAAqB,CAAC;AAEtE,eAAO,MAAM,kBAAkB,GAC7B,OAAO,uBAAuB,EAC9B,UAAU,kBAAkB,CAAC,sBAAsB,CAAC,KACnD,OAAO,CAAC,aAAa,CAAC,0BAA0B,CAAC,CAMnD,CAAC"}
+{"version":3,"file":"internal.d.ts","sourceRoot":"","sources":["../../src/api/internal.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,0BAA0B,EAC3B,MAAM,qBAAqB,CAAC;AAG7B,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAEtD,KAAK,uBAAuB,GAAG,sBAAsB,CAAC,MAAM,CAAC,CAAC;AAC9D,YAAY,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,CAAC;AAChE,YAAY,EAAE,0BAA0B,EAAE,MAAM,qBAAqB,CAAC;AAEtE,eAAO,MAAM,kBAAkB,GAC7B,MAAM,uBAAuB,EAC7B,UAAU,kBAAkB,CAAC,sBAAsB,CAAC,KACnD,OAAO,CAAC,aAAa,CAAC,0BAA0B,CAAC,CAMnD,CAAC"}

package/dist/index.cjs

@@ -580,6 +580,22 @@ var getCoins = (options) => {
     ...options
   });
 };
+var setCreateUploadJwt = (options) => {
+  return (_nullishCoalesce(_optionalChain([options, 'optionalAccess', _11 => _11.client]), () => ( client))).post({
+    security: [
+      {
+        name: "api-key",
+        type: "apiKey"
+      }
+    ],
+    url: "/createUploadJWT",
+    ...options,
+    headers: {
+      "Content-Type": "application/json",
+      ..._optionalChain([options, 'optionalAccess', _12 => _12.headers])
+    }
+  });
+};
 var getExplore = (options) => {
   return (_nullishCoalesce(options.client, () => ( client))).get({
     security: [
@@ -634,6 +650,9 @@ var apiKey;
 function setApiKey(key) {
   apiKey = key;
 }
+function getApiKey() {
+  return apiKey;
+}
 function getApiKeyMeta() {
   if (!apiKey) {
     return {};
@@ -704,6 +723,228 @@ var getCoinsNew = (query = {}, options) => createExploreQuery(query, "NEW", opti
 var getCoinsLastTraded = (query = {}, options) => createExploreQuery(query, "LAST_TRADED", options);
 var getCoinsLastTradedUnique = (query = {}, options) => createExploreQuery(query, "LAST_TRADED_UNIQUE", options);
 
+// src/uploader/metadata.ts
+function validateImageMimeType(mimeType) {
+  if (![
+    "image/png",
+    "image/jpeg",
+    "image/jpg",
+    "image/gif",
+    "image/svg+xml"
+  ].includes(mimeType)) {
+    throw new Error("Image must be a PNG, JPEG, JPG, GIF or SVG");
+  }
+}
+function getURLFromUploadResult(uploadResult) {
+  return new URL(uploadResult.url);
+}
+var CoinMetadataBuilder = class {
+  withName(name) {
+    this.name = name;
+    if (typeof name !== "string") {
+      throw new Error("Name must be a string");
+    }
+    return this;
+  }
+  withSymbol(symbol) {
+    this.symbol = symbol;
+    if (typeof symbol !== "string") {
+      throw new Error("Symbol must be a string");
+    }
+    return this;
+  }
+  withDescription(description) {
+    this.description = description;
+    if (typeof description !== "string") {
+      throw new Error("Description must be a string");
+    }
+    return this;
+  }
+  withImage(image) {
+    if (this.imageURL) {
+      throw new Error("Image URL already set");
+    }
+    if (!(image instanceof File)) {
+      throw new Error("Image must be a File");
+    }
+    validateImageMimeType(image.type);
+    this.imageFile = image;
+    return this;
+  }
+  withImageURI(imageURI) {
+    if (this.imageFile) {
+      throw new Error("Image file already set");
+    }
+    if (typeof imageURI !== "string") {
+      throw new Error("Image URI must be a string");
+    }
+    const url = new URL(imageURI);
+    this.imageURL = url;
+    return this;
+  }
+  withProperties(properties) {
+    for (const [key, value] of Object.entries(properties)) {
+      if (typeof key !== "string") {
+        throw new Error("Property key must be a string");
+      }
+      if (typeof value !== "string") {
+        throw new Error("Property value must be a string");
+      }
+    }
+    if (!this.properties) {
+      this.properties = {};
+    }
+    this.properties = { ...this.properties, ...properties };
+    return this;
+  }
+  withMedia(media) {
+    if (this.mediaURL) {
+      throw new Error("Media URL already set");
+    }
+    if (!(media instanceof File)) {
+      throw new Error("Media must be a File");
+    }
+    this.mediaMimeType = media.type;
+    this.mediaFile = media;
+    return this;
+  }
+  withMediaURI(mediaURI, mediaMimeType) {
+    if (this.mediaFile) {
+      throw new Error("Media file already set");
+    }
+    if (typeof mediaURI !== "string") {
+      throw new Error("Media URI must be a string");
+    }
+    const url = new URL(mediaURI);
+    this.mediaURL = url;
+    this.mediaMimeType = mediaMimeType;
+    return this;
+  }
+  validate() {
+    if (!this.name) {
+      throw new Error("Name is required");
+    }
+    if (!this.symbol) {
+      throw new Error("Symbol is required");
+    }
+    if (!this.imageFile && !this.imageURL) {
+      throw new Error("Image is required");
+    }
+    return this;
+  }
+  generateMetadata() {
+    return {
+      name: this.name,
+      symbol: this.symbol,
+      description: this.description,
+      image: this.imageURL.toString(),
+      animation_url: _optionalChain([this, 'access', _13 => _13.mediaURL, 'optionalAccess', _14 => _14.toString, 'call', _15 => _15()]),
+      content: this.mediaURL ? {
+        uri: _optionalChain([this, 'access', _16 => _16.mediaURL, 'optionalAccess', _17 => _17.toString, 'call', _18 => _18()]),
+        mime: this.mediaMimeType
+      } : void 0,
+      properties: this.properties
+    };
+  }
+  async upload(uploader) {
+    this.validate();
+    if (this.imageFile) {
+      const uploadResult2 = await uploader.upload(this.imageFile);
+      this.imageURL = getURLFromUploadResult(uploadResult2);
+    }
+    if (this.mediaFile) {
+      const uploadResult2 = await uploader.upload(this.mediaFile);
+      this.mediaURL = getURLFromUploadResult(uploadResult2);
+    }
+    const metadata = this.generateMetadata();
+    const uploadResult = await uploader.upload(
+      new File([JSON.stringify(metadata)], "metadata.json", {
+        type: "application/json"
+      })
+    );
+    return {
+      url: getURLFromUploadResult(uploadResult).toString(),
+      createMetadataParameters: {
+        name: this.name,
+        symbol: this.symbol,
+        uri: uploadResult.url
+      },
+      metadata
+    };
+  }
+};
+function createMetadataBuilder() {
+  return new CoinMetadataBuilder();
+}
+
+// src/api/internal.ts
+var setCreateUploadJwt2 = async (body, options) => {
+  return await setCreateUploadJwt({
+    body,
+    ...getApiKeyMeta(),
+    ...options
+  });
+};
+
+// src/uploader/providers/zora.ts
+var ZoraUploader = class {
+  constructor(creatorAddress) {
+    this.creatorAddress = creatorAddress;
+    if (!getApiKey()) {
+      throw new Error("API key is required for metadata interactions");
+    }
+  }
+  async getJWTApiKey() {
+    if (this.jwtApiKey && this.jwtApiKeyExpiresAt && this.jwtApiKeyExpiresAt > Date.now()) {
+      return this.jwtApiKey;
+    }
+    this.jwtApiKeyExpiresAt = Date.now() + 1e3 * 60 * 60;
+    const response = await setCreateUploadJwt2({
+      creatorAddress: this.creatorAddress
+    });
+    this.jwtApiKey = _optionalChain([response, 'access', _19 => _19.data, 'optionalAccess', _20 => _20.createUploadJwtFromApiKey]);
+    if (!this.jwtApiKey) {
+      throw new Error("Failed to create upload JWT");
+    }
+    return this.jwtApiKey;
+  }
+  async upload(file) {
+    const jwtApiKey = await this.getJWTApiKey();
+    const formData = new FormData();
+    formData.append("file", file, file.name);
+    const response = await fetch(
+      "https://ipfs-uploader.zora.co/api/v0/add?cid-version=1",
+      {
+        method: "POST",
+        headers: {
+          Authorization: `Bearer ${jwtApiKey}`,
+          Accept: "*/*"
+        },
+        body: formData
+      }
+    );
+    if (!response.ok) {
+      console.error(await response.text());
+      throw new Error(`Failed to upload file: ${response.statusText}`);
+    }
+    const data = await response.json();
+    return {
+      url: `ipfs://${data.cid}`,
+      size: data.size,
+      mimeType: data.mimeType
+    };
+  }
+};
+function createZoraUploaderForCreator(creatorAddress) {
+  return new ZoraUploader(creatorAddress);
+}
+
+
+
+
+
+
+
 
 
 
@@ -730,5 +971,5 @@ var getCoinsLastTradedUnique = (query = {}, options) => createExploreQuery(query
 
 
 
-exports.DeployCurrency = DeployCurrency; exports.InitialPurchaseCurrency = InitialPurchaseCurrency; exports.cleanAndValidateMetadataURI = cleanAndValidateMetadataURI; exports.createCoin = createCoin; exports.createCoinCall = createCoinCall; exports.getCoin = getCoin2; exports.getCoinComments = getCoinComments2; exports.getCoinCreateFromLogs = getCoinCreateFromLogs; exports.getCoins = getCoins2; exports.getCoinsLastTraded = getCoinsLastTraded; exports.getCoinsLastTradedUnique = getCoinsLastTradedUnique; exports.getCoinsMostValuable = getCoinsMostValuable; exports.getCoinsNew = getCoinsNew; exports.getCoinsTopGainers = getCoinsTopGainers; exports.getCoinsTopVolume24h = getCoinsTopVolume24h; exports.getOnchainCoinDetails = getOnchainCoinDetails; exports.getProfile = getProfile2; exports.getProfileBalances = getProfileBalances2; exports.getProfileCoins = getProfileCoins2; exports.setApiKey = setApiKey; exports.updateCoinURI = updateCoinURI; exports.updateCoinURICall = updateCoinURICall; exports.updatePayoutRecipient = updatePayoutRecipient; exports.updatePayoutRecipientCall = updatePayoutRecipientCall; exports.validateMetadataJSON = validateMetadataJSON; exports.validateMetadataURIContent = validateMetadataURIContent;
+exports.CoinMetadataBuilder = CoinMetadataBuilder; exports.DeployCurrency = DeployCurrency; exports.InitialPurchaseCurrency = InitialPurchaseCurrency; exports.ZoraUploader = ZoraUploader; exports.cleanAndValidateMetadataURI = cleanAndValidateMetadataURI; exports.createCoin = createCoin; exports.createCoinCall = createCoinCall; exports.createMetadataBuilder = createMetadataBuilder; exports.createZoraUploaderForCreator = createZoraUploaderForCreator; exports.getCoin = getCoin2; exports.getCoinComments = getCoinComments2; exports.getCoinCreateFromLogs = getCoinCreateFromLogs; exports.getCoins = getCoins2; exports.getCoinsLastTraded = getCoinsLastTraded; exports.getCoinsLastTradedUnique = getCoinsLastTradedUnique; exports.getCoinsMostValuable = getCoinsMostValuable; exports.getCoinsNew = getCoinsNew; exports.getCoinsTopGainers = getCoinsTopGainers; exports.getCoinsTopVolume24h = getCoinsTopVolume24h; exports.getOnchainCoinDetails = getOnchainCoinDetails; exports.getProfile = getProfile2; exports.getProfileBalances = getProfileBalances2; exports.getProfileCoins = getProfileCoins2; exports.getURLFromUploadResult = getURLFromUploadResult; exports.setApiKey = setApiKey; exports.updateCoinURI = updateCoinURI; exports.updateCoinURICall = updateCoinURICall; exports.updatePayoutRecipient = updatePayoutRecipient; exports.updatePayoutRecipientCall = updatePayoutRecipientCall; exports.validateImageMimeType = validateImageMimeType; exports.validateMetadataJSON = validateMetadataJSON; exports.validateMetadataURIContent = validateMetadataURIContent;
 //# sourceMappingURL=index.cjs.map