@campnetwork/origin 0.0.1 → 0.0.3

package/dist/core.d.ts

@@ -1,4 +1,4 @@
-import { Abi } from 'viem';
+import { Address, Hex, Abi } from 'viem';
 
 /**
  * The TwitterAPI class.
@@ -196,6 +196,99 @@ declare class SpotifyAPI {
     _fetchDataWithAuth(url: string): Promise<object>;
 }
 
+/**
+ * Represents the terms of a license for a digital asset.
+ * @property price - The price of the asset in wei.
+ * @property duration - The duration of the license in seconds.
+ * @property royaltyBps - The royalty percentage in basis points (0-10000).
+ * @property paymentToken - The address of the payment token (ERC20 / address(0) for native currency).
+ */
+type LicenseTerms = {
+    price: bigint;
+    duration: number;
+    royaltyBps: number;
+    paymentToken: Address;
+};
+/**
+ * Enum representing the status of data in the system.
+ * * - ACTIVE: The data is currently active and available.
+ * * - PENDING_DELETE: The data is scheduled for deletion but not yet removed.
+ * * - DELETED: The data has been deleted and is no longer available.
+ */
+declare enum DataStatus {
+    ACTIVE = 0,
+    PENDING_DELETE = 1,
+    DELETED = 2
+}
+/**
+ * Represents the source of a Data NFT.
+ * This can be one of the supported social media platforms or a file upload.
+ */
+type DataNFTSource = "spotify" | "twitter" | "tiktok" | "file";
+
+/**
+ * Mints a Data NFT with a signature.
+ * @param to The address to mint the NFT to.
+ * @param tokenId The ID of the token to mint.
+ * @param hash The hash of the data associated with the NFT.
+ * @param uri The URI of the NFT metadata.
+ * @param licenseTerms The terms of the license for the NFT.
+ * @param deadline The deadline for the minting operation.
+ * @param signature The signature for the minting operation.
+ * @returns A promise that resolves when the minting is complete.
+ */
+declare function mintWithSignature(this: Origin, to: Address, tokenId: bigint, hash: Hex, uri: string, licenseTerms: LicenseTerms, deadline: bigint, signature: {
+    v: number;
+    r: Hex;
+    s: Hex;
+}): Promise<any>;
+/**
+ * Registers a Data NFT with the Origin service in order to obtain a signature for minting.
+ * @param source The source of the Data NFT (e.g., "spotify", "twitter", "tiktok", or "file").
+ * @param deadline The deadline for the registration operation.
+ * @param fileKey Optional file key for file uploads.
+ * @return A promise that resolves with the registration data.
+ */
+declare function registerDataNFT(this: Origin, source: DataNFTSource, deadline: bigint, fileKey?: string | string[]): Promise<any>;
+
+declare function updateTerms(this: Origin, tokenId: bigint, newTerms: LicenseTerms): Promise<any>;
+
+declare function requestDelete(this: Origin, tokenId: bigint): Promise<any>;
+
+declare function getTerms(this: Origin, tokenId: bigint): Promise<any>;
+
+declare function ownerOf(this: Origin, tokenId: bigint): Promise<any>;
+
+declare function balanceOf(this: Origin, owner: Address): Promise<any>;
+
+declare function contentHash(this: Origin, tokenId: bigint): Promise<any>;
+
+declare function tokenURI(this: Origin, tokenId: bigint): Promise<any>;
+
+declare function dataStatus(this: Origin, tokenId: bigint): Promise<DataStatus>;
+
+declare function royaltyInfo(this: Origin, tokenId: bigint, salePrice: bigint): Promise<[Address, bigint]>;
+
+declare function getApproved(this: Origin, tokenId: bigint): Promise<Address>;
+
+declare function isApprovedForAll(this: Origin, owner: Address, operator: Address): Promise<boolean>;
+
+declare function transferFrom(this: Origin, from: Address, to: Address, tokenId: bigint): Promise<any>;
+
+declare function safeTransferFrom(this: Origin, from: Address, to: Address, tokenId: bigint, data?: Hex): Promise<any>;
+
+declare function approve(this: Origin, to: Address, tokenId: bigint): Promise<any>;
+
+declare function setApprovalForAll(this: Origin, operator: Address, approved: boolean): Promise<any>;
+
+declare function buyAccess(this: Origin, tokenId: bigint, periods: number, value?: bigint): Promise<any>;
+
+declare function renewAccess(this: Origin, tokenId: bigint, buyer: Address, periods: number, value?: bigint): Promise<any>;
+
+declare function hasAccess(this: Origin, user: Address, tokenId: bigint): Promise<boolean>;
+
+declare function subscriptionExpiry(this: Origin, tokenId: bigint, user: Address): Promise<bigint>;
+
 interface OriginUsageReturnType {
     user: {
         multiplier: number;
@@ -205,17 +298,50 @@ interface OriginUsageReturnType {
     teams: Array<any>;
     dataSources: Array<any>;
 }
+type CallOptions = {
+    value?: bigint;
+    gas?: bigint;
+    waitForReceipt?: boolean;
+};
 /**
  * The Origin class
  * Handles the upload of files to Origin, as well as querying the user's stats
  */
 declare class Origin {
     #private;
+    mintWithSignature: typeof mintWithSignature;
+    registerDataNFT: typeof registerDataNFT;
+    updateTerms: typeof updateTerms;
+    requestDelete: typeof requestDelete;
+    getTerms: typeof getTerms;
+    ownerOf: typeof ownerOf;
+    balanceOf: typeof balanceOf;
+    contentHash: typeof contentHash;
+    tokenURI: typeof tokenURI;
+    dataStatus: typeof dataStatus;
+    royaltyInfo: typeof royaltyInfo;
+    getApproved: typeof getApproved;
+    isApprovedForAll: typeof isApprovedForAll;
+    transferFrom: typeof transferFrom;
+    safeTransferFrom: typeof safeTransferFrom;
+    approve: typeof approve;
+    setApprovalForAll: typeof setApprovalForAll;
+    buyAccess: typeof buyAccess;
+    renewAccess: typeof renewAccess;
+    hasAccess: typeof hasAccess;
+    subscriptionExpiry: typeof subscriptionExpiry;
     private jwt;
-    constructor(jwt: string);
+    private viemClient?;
+    constructor(jwt: string, viemClient?: any);
+    getJwt(): string;
+    setViemClient(client: any): void;
     uploadFile: (file: File, options?: {
         progressCallback?: (percent: number) => void;
-    }) => Promise<void>;
+    }) => Promise<any>;
+    mintFile: (file: File, license: LicenseTerms, options?: {
+        progressCallback?: (percent: number) => void;
+    }) => Promise<string | null>;
+    mintSocial: (source: "spotify" | "twitter" | "tiktok") => Promise<string | null>;
     getOriginUploads: () => Promise<any>;
     /**
      * Get the user's Origin stats (multiplier, consent, usage, etc.).
@@ -236,6 +362,25 @@ declare class Origin {
      * @throws {Error|APIError} - Throws an error if the user is not authenticated. Also throws an error if the multiplier is not provided.
      */
     setOriginMultiplier(multiplier: number): Promise<void>;
+    /**
+     * Call a contract method.
+     * @param {string} contractAddress The contract address.
+     * @param {Abi} abi The contract ABI.
+     * @param {string} methodName The method name.
+     * @param {any[]} params The method parameters.
+     * @param {CallOptions} [options] The call options.
+     * @returns {Promise<any>} A promise that resolves with the result of the contract call or transaction hash.
+     * @throws {Error} - Throws an error if the wallet client is not connected and the method is not a view function.
+     */
+    callContractMethod(contractAddress: string, abi: Abi, methodName: string, params: any[], options?: CallOptions): Promise<any>;
+    /**
+     * Buy access to an asset by first checking its price via getTerms, then calling buyAccess.
+     * @param {bigint} tokenId The token ID of the asset.
+     * @param {number} periods The number of periods to buy access for.
+     * @returns {Promise<any>} The result of the buyAccess call.
+     */
+    buyAccessSmart(tokenId: bigint, periods: number): Promise<any>;
+    getData(tokenId: bigint): Promise<any>;
 }
 
 declare global {
@@ -243,11 +388,6 @@ declare global {
         ethereum?: any;
     }
 }
-type CallOptions = {
-    value?: bigint;
-    gas?: bigint;
-    waitForReceipt?: boolean;
-};
 /**
  * The Auth class.
  * @class
@@ -413,91 +553,6 @@ declare class Auth {
      * @throws {APIError} - Throws an error if the request fails.
      */
     unlinkTelegram(): Promise<any>;
-    /**
-     * Call a contract method.
-     * @param {string} contractAddress The contract address.
-     * @param {Abi} abi The contract ABI.
-     * @param {string} methodName The method name.
-     * @param {any[]} params The method parameters.
-     * @param {CallOptions} [options] The call options.
-     * @returns {Promise<any>} A promise that resolves with the result of the contract call or transaction hash.
-     * @throws {Error} - Throws an error if the wallet client is not connected or if the method is not a view function.
-     */
-    callContractMethod(contractAddress: string, abi: Abi, methodName: string, params: any[], options?: CallOptions): Promise<any>;
-}
-
-/**
-The MIT License (MIT)
-
-Copyright (c) Tobias Reich
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
-*/
-interface Options {
-    detailed?: boolean;
-    ignoreLocalhost?: boolean;
-    ignoreOwnVisits?: boolean;
-}
-interface Attributes {
-    siteLocation: string;
-    siteReferrer: string;
-    source?: string;
-    siteLanguage?: string;
-    screenWidth?: number;
-    screenHeight?: number;
-    screenColorDepth?: number;
-    browserWidth?: number;
-    browserHeight?: number;
-}
-/**
- * Gathers all platform-, screen- and user-related information.
- * @param {Boolean} detailed - Include personal data.
- * @returns {Object} attributes - User-related information.
- */
-declare const attributes: (detailed?: boolean) => Attributes;
-/**
- * Looks for an element with Ackee attributes and executes Ackee with the given attributes.
- * Fails silently.
- */
-declare const detect: () => void;
-/**
- * Creates a new instance.
- * @param {String} server - URL of the Ackee server.
- * @param {?Object} opts
- * @returns {Object} instance
- */
-declare const create: (server: string, opts?: Options) => {
-    record: (domainId: string, attrs?: Attributes, next?: (recordId: string) => void) => {
-        stop: () => void;
-    };
-    updateRecord: (recordId: string) => {
-        stop: () => void;
-    };
-    action: (eventId: string, attrs: any, next?: (actionId: string) => void) => void;
-    updateAction: (actionId: string, attrs: any) => void;
-};
-
-declare const ackeeUtil_attributes: typeof attributes;
-declare const ackeeUtil_create: typeof create;
-declare const ackeeUtil_detect: typeof detect;
-declare namespace ackeeUtil {
-  export { ackeeUtil_attributes as attributes, ackeeUtil_create as create, ackeeUtil_detect as detect };
 }
 
-export { ackeeUtil as Ackee, Auth, SpotifyAPI, TwitterAPI };
+export { Auth, SpotifyAPI, TwitterAPI };

package/dist/core.esm.d.ts

@@ -1,4 +1,4 @@
-import { Abi } from 'viem';
+import { Address, Hex, Abi } from 'viem';
 
 /**
  * The TwitterAPI class.
@@ -196,6 +196,99 @@ declare class SpotifyAPI {
     _fetchDataWithAuth(url: string): Promise<object>;
 }
 
+/**
+ * Represents the terms of a license for a digital asset.
+ * @property price - The price of the asset in wei.
+ * @property duration - The duration of the license in seconds.
+ * @property royaltyBps - The royalty percentage in basis points (0-10000).
+ * @property paymentToken - The address of the payment token (ERC20 / address(0) for native currency).
+ */
+type LicenseTerms = {
+    price: bigint;
+    duration: number;
+    royaltyBps: number;
+    paymentToken: Address;
+};
+/**
+ * Enum representing the status of data in the system.
+ * * - ACTIVE: The data is currently active and available.
+ * * - PENDING_DELETE: The data is scheduled for deletion but not yet removed.
+ * * - DELETED: The data has been deleted and is no longer available.
+ */
+declare enum DataStatus {
+    ACTIVE = 0,
+    PENDING_DELETE = 1,
+    DELETED = 2
+}
+/**
+ * Represents the source of a Data NFT.
+ * This can be one of the supported social media platforms or a file upload.
+ */
+type DataNFTSource = "spotify" | "twitter" | "tiktok" | "file";
+
+/**
+ * Mints a Data NFT with a signature.
+ * @param to The address to mint the NFT to.
+ * @param tokenId The ID of the token to mint.
+ * @param hash The hash of the data associated with the NFT.
+ * @param uri The URI of the NFT metadata.
+ * @param licenseTerms The terms of the license for the NFT.
+ * @param deadline The deadline for the minting operation.
+ * @param signature The signature for the minting operation.
+ * @returns A promise that resolves when the minting is complete.
+ */
+declare function mintWithSignature(this: Origin, to: Address, tokenId: bigint, hash: Hex, uri: string, licenseTerms: LicenseTerms, deadline: bigint, signature: {
+    v: number;
+    r: Hex;
+    s: Hex;
+}): Promise<any>;
+/**
+ * Registers a Data NFT with the Origin service in order to obtain a signature for minting.
+ * @param source The source of the Data NFT (e.g., "spotify", "twitter", "tiktok", or "file").
+ * @param deadline The deadline for the registration operation.
+ * @param fileKey Optional file key for file uploads.
+ * @return A promise that resolves with the registration data.
+ */
+declare function registerDataNFT(this: Origin, source: DataNFTSource, deadline: bigint, fileKey?: string | string[]): Promise<any>;
+
+declare function updateTerms(this: Origin, tokenId: bigint, newTerms: LicenseTerms): Promise<any>;
+
+declare function requestDelete(this: Origin, tokenId: bigint): Promise<any>;
+
+declare function getTerms(this: Origin, tokenId: bigint): Promise<any>;
+
+declare function ownerOf(this: Origin, tokenId: bigint): Promise<any>;
+
+declare function balanceOf(this: Origin, owner: Address): Promise<any>;
+
+declare function contentHash(this: Origin, tokenId: bigint): Promise<any>;
+
+declare function tokenURI(this: Origin, tokenId: bigint): Promise<any>;
+
+declare function dataStatus(this: Origin, tokenId: bigint): Promise<DataStatus>;
+
+declare function royaltyInfo(this: Origin, tokenId: bigint, salePrice: bigint): Promise<[Address, bigint]>;
+
+declare function getApproved(this: Origin, tokenId: bigint): Promise<Address>;
+
+declare function isApprovedForAll(this: Origin, owner: Address, operator: Address): Promise<boolean>;
+
+declare function transferFrom(this: Origin, from: Address, to: Address, tokenId: bigint): Promise<any>;
+
+declare function safeTransferFrom(this: Origin, from: Address, to: Address, tokenId: bigint, data?: Hex): Promise<any>;
+
+declare function approve(this: Origin, to: Address, tokenId: bigint): Promise<any>;
+
+declare function setApprovalForAll(this: Origin, operator: Address, approved: boolean): Promise<any>;
+
+declare function buyAccess(this: Origin, tokenId: bigint, periods: number, value?: bigint): Promise<any>;
+
+declare function renewAccess(this: Origin, tokenId: bigint, buyer: Address, periods: number, value?: bigint): Promise<any>;
+
+declare function hasAccess(this: Origin, user: Address, tokenId: bigint): Promise<boolean>;
+
+declare function subscriptionExpiry(this: Origin, tokenId: bigint, user: Address): Promise<bigint>;
+
 interface OriginUsageReturnType {
     user: {
         multiplier: number;
@@ -205,17 +298,50 @@ interface OriginUsageReturnType {
     teams: Array<any>;
     dataSources: Array<any>;
 }
+type CallOptions = {
+    value?: bigint;
+    gas?: bigint;
+    waitForReceipt?: boolean;
+};
 /**
  * The Origin class
  * Handles the upload of files to Origin, as well as querying the user's stats
  */
 declare class Origin {
     #private;
+    mintWithSignature: typeof mintWithSignature;
+    registerDataNFT: typeof registerDataNFT;
+    updateTerms: typeof updateTerms;
+    requestDelete: typeof requestDelete;
+    getTerms: typeof getTerms;
+    ownerOf: typeof ownerOf;
+    balanceOf: typeof balanceOf;
+    contentHash: typeof contentHash;
+    tokenURI: typeof tokenURI;
+    dataStatus: typeof dataStatus;
+    royaltyInfo: typeof royaltyInfo;
+    getApproved: typeof getApproved;
+    isApprovedForAll: typeof isApprovedForAll;
+    transferFrom: typeof transferFrom;
+    safeTransferFrom: typeof safeTransferFrom;
+    approve: typeof approve;
+    setApprovalForAll: typeof setApprovalForAll;
+    buyAccess: typeof buyAccess;
+    renewAccess: typeof renewAccess;
+    hasAccess: typeof hasAccess;
+    subscriptionExpiry: typeof subscriptionExpiry;
     private jwt;
-    constructor(jwt: string);
+    private viemClient?;
+    constructor(jwt: string, viemClient?: any);
+    getJwt(): string;
+    setViemClient(client: any): void;
     uploadFile: (file: File, options?: {
         progressCallback?: (percent: number) => void;
-    }) => Promise<void>;
+    }) => Promise<any>;
+    mintFile: (file: File, license: LicenseTerms, options?: {
+        progressCallback?: (percent: number) => void;
+    }) => Promise<string | null>;
+    mintSocial: (source: "spotify" | "twitter" | "tiktok") => Promise<string | null>;
     getOriginUploads: () => Promise<any>;
     /**
      * Get the user's Origin stats (multiplier, consent, usage, etc.).
@@ -236,6 +362,25 @@ declare class Origin {
      * @throws {Error|APIError} - Throws an error if the user is not authenticated. Also throws an error if the multiplier is not provided.
      */
     setOriginMultiplier(multiplier: number): Promise<void>;
+    /**
+     * Call a contract method.
+     * @param {string} contractAddress The contract address.
+     * @param {Abi} abi The contract ABI.
+     * @param {string} methodName The method name.
+     * @param {any[]} params The method parameters.
+     * @param {CallOptions} [options] The call options.
+     * @returns {Promise<any>} A promise that resolves with the result of the contract call or transaction hash.
+     * @throws {Error} - Throws an error if the wallet client is not connected and the method is not a view function.
+     */
+    callContractMethod(contractAddress: string, abi: Abi, methodName: string, params: any[], options?: CallOptions): Promise<any>;
+    /**
+     * Buy access to an asset by first checking its price via getTerms, then calling buyAccess.
+     * @param {bigint} tokenId The token ID of the asset.
+     * @param {number} periods The number of periods to buy access for.
+     * @returns {Promise<any>} The result of the buyAccess call.
+     */
+    buyAccessSmart(tokenId: bigint, periods: number): Promise<any>;
+    getData(tokenId: bigint): Promise<any>;
 }
 
 declare global {
@@ -243,11 +388,6 @@ declare global {
         ethereum?: any;
     }
 }
-type CallOptions = {
-    value?: bigint;
-    gas?: bigint;
-    waitForReceipt?: boolean;
-};
 /**
  * The Auth class.
  * @class
@@ -413,91 +553,6 @@ declare class Auth {
      * @throws {APIError} - Throws an error if the request fails.
      */
     unlinkTelegram(): Promise<any>;
-    /**
-     * Call a contract method.
-     * @param {string} contractAddress The contract address.
-     * @param {Abi} abi The contract ABI.
-     * @param {string} methodName The method name.
-     * @param {any[]} params The method parameters.
-     * @param {CallOptions} [options] The call options.
-     * @returns {Promise<any>} A promise that resolves with the result of the contract call or transaction hash.
-     * @throws {Error} - Throws an error if the wallet client is not connected or if the method is not a view function.
-     */
-    callContractMethod(contractAddress: string, abi: Abi, methodName: string, params: any[], options?: CallOptions): Promise<any>;
-}
-
-/**
-The MIT License (MIT)
-
-Copyright (c) Tobias Reich
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
-*/
-interface Options {
-    detailed?: boolean;
-    ignoreLocalhost?: boolean;
-    ignoreOwnVisits?: boolean;
-}
-interface Attributes {
-    siteLocation: string;
-    siteReferrer: string;
-    source?: string;
-    siteLanguage?: string;
-    screenWidth?: number;
-    screenHeight?: number;
-    screenColorDepth?: number;
-    browserWidth?: number;
-    browserHeight?: number;
-}
-/**
- * Gathers all platform-, screen- and user-related information.
- * @param {Boolean} detailed - Include personal data.
- * @returns {Object} attributes - User-related information.
- */
-declare const attributes: (detailed?: boolean) => Attributes;
-/**
- * Looks for an element with Ackee attributes and executes Ackee with the given attributes.
- * Fails silently.
- */
-declare const detect: () => void;
-/**
- * Creates a new instance.
- * @param {String} server - URL of the Ackee server.
- * @param {?Object} opts
- * @returns {Object} instance
- */
-declare const create: (server: string, opts?: Options) => {
-    record: (domainId: string, attrs?: Attributes, next?: (recordId: string) => void) => {
-        stop: () => void;
-    };
-    updateRecord: (recordId: string) => {
-        stop: () => void;
-    };
-    action: (eventId: string, attrs: any, next?: (actionId: string) => void) => void;
-    updateAction: (actionId: string, attrs: any) => void;
-};
-
-declare const ackeeUtil_attributes: typeof attributes;
-declare const ackeeUtil_create: typeof create;
-declare const ackeeUtil_detect: typeof detect;
-declare namespace ackeeUtil {
-  export { ackeeUtil_attributes as attributes, ackeeUtil_create as create, ackeeUtil_detect as detect };
 }
 
-export { ackeeUtil as Ackee, Auth, SpotifyAPI, TwitterAPI };
+export { Auth, SpotifyAPI, TwitterAPI };