@nevermined-io/core-kit 0.0.2-rc19

package/dist/nevermined/Nevermined.d.ts

@@ -0,0 +1,48 @@
+import { Instantiable } from '../Instantiable.abstract.js';
+import { NeverminedOptions } from '../models/NeverminedOptions.js';
+import { UtilsApi } from '../nevermined/api/UtilsApi.js';
+import { ServicesApi } from './api/ServicesApi.js';
+import { ContractsApi } from '../contracts/ContractsApi.js';
+import { PaymentsApi } from './api/PaymentsApi.js';
+/**
+ * Main interface for Nevermined Protocol.
+ */
+export declare class Nevermined extends Instantiable {
+    /**
+     * Returns the instance of Nevermined.
+     *
+     * @example
+     * ```ts
+     * import { Nevermined, Config } from '@nevermined-io/sdk'
+     *
+     * const config: Config = {...}
+     * const nevermined = await Nevermined.getInstance(config)
+     * ```
+     *
+     * @param config - Nevermined instance configuration.
+     * @returns A {@link Nevermined} instance
+     */
+    static getInstance(config: NeverminedOptions): Promise<Nevermined>;
+    /**
+     * ContractsApi instance.
+     */
+    contracts: ContractsApi;
+    /**
+     * SearchApi API
+     */
+    services: ServicesApi;
+    /**
+     * Utils submodule
+     */
+    utils: UtilsApi;
+    payments: PaymentsApi;
+    /**
+     * Web3 Clients
+     */
+    /**
+     * If contracts are initialized
+     */
+    contractsInitialized: boolean | undefined;
+    private constructor();
+}
+//# sourceMappingURL=Nevermined.d.ts.map

package/dist/nevermined/Nevermined.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Nevermined.d.ts","sourceRoot":"","sources":["../../src/nevermined/Nevermined.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAwC,MAAM,6BAA6B,CAAA;AAChG,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAA;AAClE,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAA;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAElD;;GAEG;AACH,qBAAa,UAAW,SAAQ,YAAY;IAC1C;;;;;;;;;;;;;OAaG;WAC0B,WAAW,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC;IAgCxF;;OAEG;IACI,SAAS,EAAG,YAAY,CAAA;IAE/B;;OAEG;IACI,QAAQ,EAAG,WAAW,CAAA;IAE7B;;OAEG;IACI,KAAK,EAAG,QAAQ,CAAA;IAEhB,QAAQ,EAAG,WAAW,CAAA;IAE7B;;OAEG;IAGH;;OAEG;IACI,oBAAoB,EAAE,OAAO,GAAG,SAAS,CAAA;IAEhD,OAAO;CAGR"}

package/dist/nevermined/Nevermined.js

@@ -0,0 +1,72 @@
+import { Instantiable, generateInstantiableConfigFromConfig } from '../Instantiable.abstract.js';
+import { UtilsApi } from '../nevermined/api/UtilsApi.js';
+import { ServicesApi } from './api/ServicesApi.js';
+import { ContractsApi } from '../contracts/ContractsApi.js';
+import { PaymentsApi } from './api/PaymentsApi.js';
+/**
+ * Main interface for Nevermined Protocol.
+ */
+export class Nevermined extends Instantiable {
+    /**
+     * Returns the instance of Nevermined.
+     *
+     * @example
+     * ```ts
+     * import { Nevermined, Config } from '@nevermined-io/sdk'
+     *
+     * const config: Config = {...}
+     * const nevermined = await Nevermined.getInstance(config)
+     * ```
+     *
+     * @param config - Nevermined instance configuration.
+     * @returns A {@link Nevermined} instance
+     */
+    static async getInstance(config) {
+        const instance = new Nevermined();
+        // Nevermined main API
+        try {
+            const instanceConfig = {
+                ...(await generateInstantiableConfigFromConfig(config, true)),
+                nevermined: instance,
+            };
+            instance.setInstanceConfig(instanceConfig);
+            // instance.search = new SearchApi(instanceConfig)
+            instance.services = new ServicesApi(instanceConfig);
+            instance.utils = new UtilsApi(instanceConfig);
+            instance.contracts = await ContractsApi.getInstance(instanceConfig);
+            await instance.contracts.init();
+            instance.payments = new PaymentsApi(instanceConfig);
+            instance.contractsInitialized = true;
+        }
+        catch (error) {
+            instance.contractsInitialized = false;
+            instance.logger.error(error);
+            instance.logger.error("Contracts didn't initialize because for the above mentioned reason. Loading SDK in offchain mode...");
+        }
+        return instance;
+    }
+    /**
+     * ContractsApi instance.
+     */
+    contracts;
+    /**
+     * SearchApi API
+     */
+    services;
+    /**
+     * Utils submodule
+     */
+    utils;
+    payments;
+    /**
+     * Web3 Clients
+     */
+    // public web3: Web3Clients
+    /**
+     * If contracts are initialized
+     */
+    contractsInitialized;
+    constructor() {
+        super();
+    }
+}

package/dist/nevermined/api/PaymentsApi.d.ts

@@ -0,0 +1,17 @@
+import { Account, Address } from 'viem';
+import { Instantiable, InstantiableConfig } from '../../Instantiable.abstract.js';
+import { SmartAccount } from 'viem/account-abstraction';
+import { OrderResult, Plan } from '@nvm-monorepo/commons';
+export declare class PaymentsApi extends Instantiable {
+    /**
+     * Creates a new PaymentsApi
+     * @param config - Configuration of the Nevermined instance
+     * @returns {@link PaymentsApi}
+     */
+    constructor(config: InstantiableConfig);
+    private getTokenContract;
+    getERC20Balance(userAddress: Address, tokenAddress: Address): Promise<bigint>;
+    orderFiatPayment(planId: bigint, planReceiver: Address, from: Account | SmartAccount): Promise<OrderResult>;
+    orderCryptoPayment(planId: bigint, plan: Plan, from: Account | SmartAccount): Promise<OrderResult>;
+}
+//# sourceMappingURL=PaymentsApi.d.ts.map

package/dist/nevermined/api/PaymentsApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PaymentsApi.d.ts","sourceRoot":"","sources":["../../../src/nevermined/api/PaymentsApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAO,OAAO,EAAE,OAAO,EAAsC,MAAM,MAAM,CAAA;AAChF,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAA;AAEjF,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AAEvD,OAAO,EAAE,WAAW,EAAE,IAAI,EAA8B,MAAM,uBAAuB,CAAA;AAQrF,qBAAa,WAAY,SAAQ,YAAY;IAC3C;;;;OAIG;gBACS,MAAM,EAAE,kBAAkB;YAKxB,gBAAgB;IAsBjB,eAAe,CAAC,WAAW,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAgB7E,gBAAgB,CAC3B,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,OAAO,EACrB,IAAI,EAAE,OAAO,GAAG,YAAY,GAC3B,OAAO,CAAC,WAAW,CAAC;IAqBV,kBAAkB,CAC7B,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,OAAO,GAAG,YAAY,GAC3B,OAAO,CAAC,WAAW,CAAC;CA8ExB"}

package/dist/nevermined/api/PaymentsApi.js

@@ -0,0 +1,125 @@
+import { getContract, parseAbi, zeroAddress } from 'viem';
+import { Instantiable } from '../../Instantiable.abstract.js';
+import { lockPaymentConditionAddress } from '../../artifacts/generated.js';
+import { createKernelClient } from '../utils/BlockchainViemUtils.js';
+import { PlanTransactionPaymentType } from '@nvm-monorepo/commons';
+const TOKEN_APPROVE_ABI = parseAbi([
+    'function approve(address spender, uint256 amount) external returns (bool)',
+]);
+const TOKEN_BALANCE_ABI = parseAbi(['function balanceOf(address) view returns (uint256)']);
+export class PaymentsApi extends Instantiable {
+    /**
+     * Creates a new PaymentsApi
+     * @param config - Configuration of the Nevermined instance
+     * @returns {@link PaymentsApi}
+     */
+    constructor(config) {
+        super();
+        this.setInstanceConfig(config);
+    }
+    async getTokenContract(token, from) {
+        if (from.type === 'smart') {
+            const kernelClient = await createKernelClient(from, this.config.chainId, this.config.zeroDevProjectId, this.nevermined.contracts.assetRegistry.publicClient);
+            return getContract({
+                address: token,
+                abi: TOKEN_APPROVE_ABI,
+                client: kernelClient,
+            });
+        }
+        else {
+            return getContract({
+                address: token,
+                abi: TOKEN_APPROVE_ABI,
+                client: this.walletClient,
+            });
+        }
+    }
+    async getERC20Balance(userAddress, tokenAddress) {
+        try {
+            return this.client.public.readContract({
+                address: tokenAddress,
+                abi: TOKEN_BALANCE_ABI,
+                functionName: 'balanceOf',
+                args: [userAddress],
+            });
+        }
+        catch (error) {
+            this.logger.debug(`Error fetching ERC20 balance for ${userAddress} in ${tokenAddress}: ${error}`);
+        }
+        return 0n;
+    }
+    async orderFiatPayment(planId, planReceiver, from) {
+        const plan = await this.nevermined.contracts.assetRegistry.getPlan(planId);
+        const totalAmount = plan.price.amounts.reduce((a, b) => a + b, 0n);
+        const txHash = await this.nevermined.contracts.fiatPaymentTemplate.createAgreement(planId, planReceiver, from);
+        const txReceipt = await this.nevermined.contracts.assetRegistry.getTransactionReceipt(txHash);
+        return {
+            txHash: txReceipt.transactionHash,
+            planId,
+            planReceiver: from.address,
+            totalAmount,
+            numCredits: plan.credits.amount,
+            paymentMethod: PlanTransactionPaymentType.Fiat,
+            currency: 'USD',
+        };
+    }
+    async orderCryptoPayment(planId, plan, from) {
+        try {
+            // const plan = await this.nevermined.contracts.assetRegistry.getPlan(planId)
+            const tokenAddress = plan.price.tokenAddress;
+            const totalAmount = plan.price.amounts.reduce((a, b) => a + b, 0n);
+            this.logger.debug(`Ordering ${tokenAddress} ${totalAmount}`);
+            if (tokenAddress && tokenAddress !== zeroAddress) {
+                // ERC20 token payment
+                if (totalAmount > 0n) {
+                    const erc20Balance = await this.getERC20Balance(from.address, tokenAddress);
+                    if (erc20Balance < totalAmount) {
+                        throw new Error(`Insufficient balance (${erc20Balance} < ${totalAmount}) for ERC20 ${tokenAddress}`);
+                    }
+                    const tokenContract = await this.getTokenContract(tokenAddress, from);
+                    // Approve lockPayment contract
+                    const hash = await tokenContract.write.approve([lockPaymentConditionAddress, totalAmount]);
+                    const receipt = await this.nevermined.contracts.fixedPaymentTemplate.publicClient.waitForTransactionReceipt({ hash });
+                    this.logger.debug('Approving token transfer to lockPayment contract', receipt);
+                }
+                const txHash = await this.nevermined.contracts.fixedPaymentTemplate.createAgreement(planId, from);
+                const txReceipt = await this.nevermined.contracts.assetRegistry.getTransactionReceipt(txHash);
+                return {
+                    txHash: txReceipt.transactionHash,
+                    planId,
+                    planReceiver: from.address,
+                    totalAmount,
+                    numCredits: plan.credits.amount,
+                    paymentMethod: PlanTransactionPaymentType.Crypto,
+                    currency: 'USDC',
+                    tokenAddress,
+                };
+            }
+            else {
+                // Native token payment
+                const nativeTokenBalance = await this.client.public.getBalance({ address: from.address });
+                if (nativeTokenBalance < totalAmount) {
+                    throw new Error(`Insufficient balance (${nativeTokenBalance} < ${totalAmount}) for native token payment`);
+                }
+                const txHash = await this.nevermined.contracts.fixedPaymentTemplate.createAgreement(planId, from, {
+                    value: totalAmount,
+                });
+                const txReceipt = await this.nevermined.contracts.assetRegistry.getTransactionReceipt(txHash);
+                return {
+                    txHash: txReceipt.transactionHash,
+                    planId,
+                    planReceiver: from.address,
+                    totalAmount,
+                    numCredits: plan.credits.amount,
+                    paymentMethod: PlanTransactionPaymentType.Crypto,
+                    currency: 'Native',
+                    tokenAddress: zeroAddress,
+                };
+            }
+        }
+        catch (error) {
+            this.logger.error('Error in PaymentsApi order method:', error);
+            throw error;
+        }
+    }
+}

package/dist/nevermined/api/ServicesApi.d.ts

@@ -0,0 +1,28 @@
+import { Instantiable, InstantiableConfig } from '../../Instantiable.abstract.js';
+import { Api } from '../../services/Api.js';
+import { MetadataService } from '../../services/MetadataService.js';
+import { Profiles } from '../../services/Profiles.js';
+/**
+ * Utils internal submodule of Nevermined.
+ */
+export declare class ServicesApi extends Instantiable {
+    /**
+     * Nevermined Node Service
+     */
+    api: Api;
+    /**
+     * Marketplace instance.
+     */
+    metadata: MetadataService;
+    /**
+     * Profiles instance
+     */
+    profiles: Profiles;
+    /**
+     * Creates a new ServicesApi
+     * @param config - Configuration of the Nevermined instance
+     * @returns {@link ServicesApi}
+     */
+    constructor(config: InstantiableConfig);
+}
+//# sourceMappingURL=ServicesApi.d.ts.map

package/dist/nevermined/api/ServicesApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ServicesApi.d.ts","sourceRoot":"","sources":["../../../src/nevermined/api/ServicesApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAA;AACjF,OAAO,EAAE,GAAG,EAAE,MAAM,uBAAuB,CAAA;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAA;AACnE,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAA;AAErD;;GAEG;AACH,qBAAa,WAAY,SAAQ,YAAY;IAC3C;;OAEG;IACI,GAAG,EAAE,GAAG,CAAA;IAEf;;OAEG;IACI,QAAQ,EAAE,eAAe,CAAA;IAEhC;;OAEG;IACI,QAAQ,EAAE,QAAQ,CAAA;IAEzB;;;;OAIG;gBACS,MAAM,EAAE,kBAAkB;CAQvC"}

package/dist/nevermined/api/ServicesApi.js

@@ -0,0 +1,33 @@
+import { Instantiable } from '../../Instantiable.abstract.js';
+import { Api } from '../../services/Api.js';
+import { MetadataService } from '../../services/MetadataService.js';
+import { Profiles } from '../../services/Profiles.js';
+/**
+ * Utils internal submodule of Nevermined.
+ */
+export class ServicesApi extends Instantiable {
+    /**
+     * Nevermined Node Service
+     */
+    api;
+    /**
+     * Marketplace instance.
+     */
+    metadata;
+    /**
+     * Profiles instance
+     */
+    profiles;
+    /**
+     * Creates a new ServicesApi
+     * @param config - Configuration of the Nevermined instance
+     * @returns {@link ServicesApi}
+     */
+    constructor(config) {
+        super();
+        this.setInstanceConfig(config);
+        this.api = new Api(config);
+        this.metadata = new MetadataService(config);
+        this.profiles = new Profiles(config);
+    }
+}

package/dist/nevermined/api/UtilsApi.d.ts

@@ -0,0 +1,28 @@
+import { Instantiable, InstantiableConfig } from '../../Instantiable.abstract.js';
+import { JwtUtils } from '../utils/JwtUtils.js';
+import { SignatureUtils } from '../utils/SignatureUtils.js';
+import { WebServiceConnector } from '../utils/WebServiceConnector.js';
+/**
+ * Nevermined Utils API
+ */
+export declare class UtilsApi extends Instantiable {
+    /**
+     * Fetch utils.
+     */
+    fetch: WebServiceConnector;
+    /**
+     * Jwt utils.
+     */
+    jwt: JwtUtils;
+    /**
+     * Signature utils.
+     */
+    signature: SignatureUtils;
+    /**
+     * Creates a new AssetsApi
+     * @param config - Configuration of the Nevermined instance
+     * @returns {@link UtilsApi}
+     */
+    constructor(config: InstantiableConfig);
+}
+//# sourceMappingURL=UtilsApi.d.ts.map

package/dist/nevermined/api/UtilsApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UtilsApi.d.ts","sourceRoot":"","sources":["../../../src/nevermined/api/UtilsApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAA;AACjF,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAA;AAErE;;GAEG;AACH,qBAAa,QAAS,SAAQ,YAAY;IACxC;;OAEG;IACI,KAAK,EAAE,mBAAmB,CAAA;IAEjC;;OAEG;IACI,GAAG,EAAE,QAAQ,CAAA;IAEpB;;OAEG;IACI,SAAS,EAAE,cAAc,CAAA;IAEhC;;;;OAIG;gBACS,MAAM,EAAE,kBAAkB;CAQvC"}

package/dist/nevermined/api/UtilsApi.js

@@ -0,0 +1,33 @@
+import { Instantiable } from '../../Instantiable.abstract.js';
+import { JwtUtils } from '../utils/JwtUtils.js';
+import { SignatureUtils } from '../utils/SignatureUtils.js';
+import { WebServiceConnector } from '../utils/WebServiceConnector.js';
+/**
+ * Nevermined Utils API
+ */
+export class UtilsApi extends Instantiable {
+    /**
+     * Fetch utils.
+     */
+    fetch;
+    /**
+     * Jwt utils.
+     */
+    jwt;
+    /**
+     * Signature utils.
+     */
+    signature;
+    /**
+     * Creates a new AssetsApi
+     * @param config - Configuration of the Nevermined instance
+     * @returns {@link UtilsApi}
+     */
+    constructor(config) {
+        super();
+        this.setInstanceConfig(config);
+        this.fetch = new WebServiceConnector(config);
+        this.jwt = new JwtUtils(config);
+        this.signature = new SignatureUtils(config);
+    }
+}

package/dist/nevermined/index.d.ts

@@ -0,0 +1,4 @@
+export * from './DID.js';
+export { Nevermined } from './Nevermined.js';
+export * from './utils/index.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/nevermined/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/nevermined/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,cAAc,kBAAkB,CAAA"}

package/dist/nevermined/index.js

@@ -0,0 +1,3 @@
+export * from './DID.js';
+export { Nevermined } from './Nevermined.js';
+export * from './utils/index.js';