@nevermined-io/core-kit 0.1.3 → 0.1.5

package/dist/models/NeverminedOptions.js

@@ -0,0 +1,28 @@
+export class NeverminedOptions {
+    chainId;
+    /**
+     * Ethereum Web3 Provider URL. This Url allows the SDK to connect to a blockchain.
+     * This provider depends on the network where you want to connect (Ethereum Mainnet, Rinkeby, Polygon Matic, etc).
+     * It's possible to use a public available provider or a private/paid one like Infura, Alchemy, etc.
+     */
+    web3ProviderUri;
+    /**
+     * The Nevermined App URL.
+     */
+    appUrl;
+    backendUrl;
+    agentsProxy;
+    /**
+     * Log level.
+     */
+    logLevel = 'info';
+    accounts;
+    /**
+     * ZeroDev project id
+     */
+    zeroDevProjectId;
+    /**
+     * Contracts version
+     */
+    contractsVersion;
+}

package/dist/models/NvmApiKey.d.ts

@@ -0,0 +1,137 @@
+import { JWTPayload } from 'jose';
+import { Account } from 'viem';
+import { SmartAccount } from 'viem/account-abstraction';
+import { SignatureUtils } from '../nevermined/utils/SignatureUtils.js';
+export declare class NvmApiKey implements JWTPayload {
+    /**
+     * The public address of the account issuing the key.
+     */
+    iss?: string;
+    /**
+     * The chain id of the network the key is valid for. If zero the key is not having any network limitation
+     */
+    aud?: string;
+    /**
+     * The public address of the account the key is issued for.
+     */
+    sub?: string;
+    /**
+     * The version of the key
+     */
+    ver: string;
+    /**
+     * The ZeroDev session key
+     */
+    zsk?: string;
+    /**
+     * The Marketplace auth token
+     */
+    /**
+     * JWT Expiration Time
+     *
+     * @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4 RFC7519#section-4.1.4}
+     */
+    exp?: number;
+    /**
+     * JWT Issued At
+     *
+     * @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6 RFC7519#section-4.1.6}
+     */
+    iat?: number;
+    /**
+     * Additional attributes
+     */
+    [propName: string]: any;
+    /**
+     * It generates a new serialized and encrypted NvmApiKey including the ZeroDev session key and the Marketplace auth token.
+     * The string  representing this key can be used to authenticate against the Nevermined API.
+     * @param signatureUtils The SignatureUtils instance
+     * @param issuerAccount The account issuing the key
+     * @param zeroDevSessionKey The ZeroDev session key
+     * @param receiverAddress The address of the account the key is issued for
+     * @param receiverPublicKey The public key of the account the key is issued for
+     * @param chainId The chain id of the network the key is valid for
+     * @param additionalParams Addintional  params to be added to the Key generated
+     * @returns The encrypted string representing the @see {@link NvmApiKey}
+     */
+    static generate(signatureUtils: SignatureUtils, issuerAccount: Account | SmartAccount, zeroDevSessionKey: string | undefined, receiverAddress: string, receiverPublicKey: string, expirationTime?: number | string, additionalParams?: {}, nvmApiKeyVersion?: string): Promise<string>;
+    /**
+     * Given an encrypted JWT and a private key, it decrypts and decodes the JWT into a NvmApiKey
+     * @param encryptedJwt The encrypted JWT
+     * @param privateKey The private key representing the account
+     * @returns The @see {@link NvmApiKey}
+     */
+    static decryptAndDecode(encryptedJwt: string, privateKey: string): Promise<NvmApiKey>;
+    /**
+     * Given a signed JWT, it recovers the signer address
+     * @param jwtString The signed JWT
+     * @returns The signer address
+     */
+    static getSignerAddress(jwtString: string): Promise<string>;
+    /**
+     * It checks if the NVM API Key attributes are valid
+     * @param chainId The chain id of the network the key is valid for
+     * @returns true if the key is valid, false otherwise
+     */
+    isValid(chainId?: number): boolean;
+    /**
+     * It generates a signed JWT from the NvmApiKey
+     * @param signatureUtils The SignatureUtils instance
+     * @param issuerAccount The account issuing the key
+     * @returns the string in JWT format represeting the NvmApiKey
+     */
+    toJWT(signatureUtils: SignatureUtils, issuerAccount: Account | SmartAccount): Promise<string>;
+    /**
+     * It generates the hash in JWT format of the NvmApiKey
+     * @param signatureUtils the SignatureUtils instance
+     * @param issuerAccount the account  issuing the key
+     * @returns a JWT string representing the hash of the NvmApiKey
+     */
+    hashJWT(signatureUtils: SignatureUtils, issuerAccount: Account | SmartAccount, heliconeApiKey?: string): Promise<string>;
+    /**
+     * It regenerates the NvmApiKey from a JSON object
+     * @param jwt JWTPayload in JSON format
+     * @returns the @see {@link NvmApiKey}
+     */
+    static fromJSON(jwt: JWTPayload): NvmApiKey;
+    /**
+     * It regenerates the NvmApiKey from a JWT
+     * @param jwtString the string in JWT format represeting the NvmApiKey
+     * @returns the @see {@link NvmApiKey}
+     */
+    static fromJWT(jwtString: string): NvmApiKey;
+    /**
+     * It regenerates the NvmApiKey from a string
+     * @param str the string represeting the NvmApiKey
+     * @returns the @see {@link NvmApiKey}
+     */
+    static deserialize(str: string): NvmApiKey;
+    /**
+     * It serializes the NVM Api Key into a string
+     * @returns a string representing the NVM API Key
+     */
+    serialize(): string;
+    /**
+     * It serializes the NVM Api Key into a string
+     * @returns a string representing the NVM API Key
+     */
+    toString(): string;
+    /**
+     * It decodes a string JWT into a JWTPayload
+     * @param str jwt string
+     * @returns the JWTPayload
+     */
+    static decodeJWT(str: string): JWTPayload;
+    /**
+     * It generates the hash of the NvmApiKey
+     * @returns a string representing the hash of the NvmApiKey
+     */
+    hash(): string;
+    /**
+     * Given a serialized string, it generates the hash
+     * @param serialized the serialized string
+     * @returns the hash
+     */
+    static hash(serialized: string): string;
+}
+//# sourceMappingURL=NvmApiKey.d.ts.map

package/dist/models/NvmApiKey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NvmApiKey.d.ts","sourceRoot":"","sources":["../../src/models/NvmApiKey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAa,MAAM,MAAM,CAAA;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAC9B,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AAIvD,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAA;AAGtE,qBAAa,SAAU,YAAW,UAAU;IAC1C;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,GAAG,SAAO;IAEV;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ;;OAEG;IAGH;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAA;IAEvB;;;;;;;;;;;OAWG;WACiB,QAAQ,CAC1B,cAAc,EAAE,cAAc,EAC9B,aAAa,EAAE,OAAO,GAAG,YAAY,EACrC,iBAAiB,EAAE,MAAM,GAAG,SAAS,EACrC,eAAe,EAAE,MAAM,EACvB,iBAAiB,EAAE,MAAM,EACzB,cAAc,GAAE,MAAM,GAAG,MAAa,EACtC,gBAAgB,KAAK,EACrB,gBAAgB,SAAO,GACtB,OAAO,CAAC,MAAM,CAAC;IA4BlB;;;;;OAKG;WACiB,gBAAgB,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;IAK7E;;;;OAIG;WACiB,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAcxE;;;;OAIG;IACI,OAAO,CAAC,OAAO,SAAI,GAAG,OAAO;IAWpC;;;;;OAKG;IACU,KAAK,CAChB,cAAc,EAAE,cAAc,EAC9B,aAAa,EAAE,OAAO,GAAG,YAAY,GACpC,OAAO,CAAC,MAAM,CAAC;IAalB;;;;;OAKG;IACU,OAAO,CAClB,cAAc,EAAE,cAAc,EAC9B,aAAa,EAAE,OAAO,GAAG,YAAY,EACrC,cAAc,CAAC,EAAE,MAAM,GACtB,OAAO,CAAC,MAAM,CAAC;IAiBlB;;;;OAIG;WACW,QAAQ,CAAC,GAAG,EAAE,UAAU,GAAG,SAAS;IAYlD;;;;OAIG;WACW,OAAO,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS;IAKnD;;;;OAIG;WACW,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS;IAIjD;;;OAGG;IACI,SAAS,IAAI,MAAM;IAI1B;;;OAGG;IACI,QAAQ,IAAI,MAAM;IAIzB;;;;OAIG;WACW,SAAS,CAAC,GAAG,EAAE,MAAM;IAInC;;;OAGG;IACI,IAAI;IAIX;;;;OAIG;IACH,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM;CAG/B"}

package/dist/models/NvmApiKey.js

@@ -0,0 +1,235 @@
+import { decodeJwt } from 'jose';
+import { bytesToHex } from 'viem/utils';
+import { getChecksumAddress } from '../nevermined/utils/BlockchainViemUtils.js';
+import { EthSignJWT } from '../nevermined/utils/JwtUtils.js';
+import { SignatureUtils } from '../nevermined/utils/SignatureUtils.js';
+import { decryptMessage, encryptMessage, urlSafeBase64Decode } from '../utils/helpers.js';
+export class NvmApiKey {
+    /**
+     * The public address of the account issuing the key.
+     */
+    iss;
+    /**
+     * The chain id of the network the key is valid for. If zero the key is not having any network limitation
+     */
+    aud;
+    /**
+     * The public address of the account the key is issued for.
+     */
+    sub;
+    /**
+     * The version of the key
+     */
+    ver = 'v1';
+    /**
+     * The ZeroDev session key
+     */
+    zsk;
+    /**
+     * The Marketplace auth token
+     */
+    // nvt?: string
+    /**
+     * JWT Expiration Time
+     *
+     * @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4 RFC7519#section-4.1.4}
+     */
+    exp;
+    /**
+     * JWT Issued At
+     *
+     * @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6 RFC7519#section-4.1.6}
+     */
+    iat;
+    /**
+     * It generates a new serialized and encrypted NvmApiKey including the ZeroDev session key and the Marketplace auth token.
+     * The string  representing this key can be used to authenticate against the Nevermined API.
+     * @param signatureUtils The SignatureUtils instance
+     * @param issuerAccount The account issuing the key
+     * @param zeroDevSessionKey The ZeroDev session key
+     * @param receiverAddress The address of the account the key is issued for
+     * @param receiverPublicKey The public key of the account the key is issued for
+     * @param chainId The chain id of the network the key is valid for
+     * @param additionalParams Addintional  params to be added to the Key generated
+     * @returns The encrypted string representing the @see {@link NvmApiKey}
+     */
+    static async generate(signatureUtils, issuerAccount, zeroDevSessionKey, receiverAddress, receiverPublicKey, expirationTime = '1y', additionalParams = {}, nvmApiKeyVersion = 'v1') {
+        const issuerAddress = getChecksumAddress(issuerAccount.address);
+        const chainId = signatureUtils.client.chain?.id || 0;
+        const sub = getChecksumAddress(receiverAddress);
+        const eip712Data = {
+            message: 'Sign this message to generate the Encrypted Nevermined API Key',
+            ...(chainId > 0 && { chainId }),
+        };
+        const params = {
+            iss: issuerAddress,
+            aud: chainId.toString(),
+            sub,
+            ver: nvmApiKeyVersion,
+            zsk: zeroDevSessionKey,
+            eip712Data,
+            ...additionalParams,
+        };
+        const signedJWT = await new EthSignJWT(params)
+            .setProtectedHeader({ alg: 'ES256K' })
+            .setIssuedAt()
+            .setExpirationTime(expirationTime)
+            .ethSign(signatureUtils, issuerAccount);
+        return encryptMessage(signedJWT, receiverPublicKey);
+    }
+    /**
+     * Given an encrypted JWT and a private key, it decrypts and decodes the JWT into a NvmApiKey
+     * @param encryptedJwt The encrypted JWT
+     * @param privateKey The private key representing the account
+     * @returns The @see {@link NvmApiKey}
+     */
+    static async decryptAndDecode(encryptedJwt, privateKey) {
+        const decrypted = await decryptMessage(encryptedJwt, privateKey);
+        return NvmApiKey.fromJWT(decrypted);
+    }
+    /**
+     * Given a signed JWT, it recovers the signer address
+     * @param jwtString The signed JWT
+     * @returns The signer address
+     */
+    static async getSignerAddress(jwtString) {
+        try {
+            const tokens = jwtString.split('.');
+            const signature = bytesToHex(urlSafeBase64Decode(tokens[2]));
+            return SignatureUtils.recoverSignerAddress(`${tokens[0]}.${tokens[1]}`, signature);
+        }
+        catch (e) {
+            if (e instanceof Error) {
+                throw new Error(`Error recovering signer address: ${e.message}`);
+            }
+            else {
+                throw new Error(`Error recovering signer address`);
+            }
+        }
+    }
+    /**
+     * It checks if the NVM API Key attributes are valid
+     * @param chainId The chain id of the network the key is valid for
+     * @returns true if the key is valid, false otherwise
+     */
+    isValid(chainId = 0) {
+        if (this.exp) {
+            const now = new Date();
+            if (now.getTime() > Number(this.exp) * 1000)
+                return false;
+        }
+        if (chainId !== 0) {
+            if (Number(this.aud) !== chainId)
+                return false;
+        }
+        return true;
+    }
+    /**
+     * It generates a signed JWT from the NvmApiKey
+     * @param signatureUtils The SignatureUtils instance
+     * @param issuerAccount The account issuing the key
+     * @returns the string in JWT format represeting the NvmApiKey
+     */
+    async toJWT(signatureUtils, issuerAccount) {
+        const params = {};
+        Object.keys(this)
+            .filter((val) => val !== undefined)
+            .forEach((key) => {
+            if (!key.startsWith('_'))
+                params[key] = this[key];
+        });
+        const jwt = new EthSignJWT(params).setProtectedHeader({ alg: 'ES256K' }).setIssuedAt(this.iat);
+        if (this.exp)
+            jwt.setExpirationTime(this.exp);
+        return jwt.ethSign(signatureUtils, issuerAccount);
+    }
+    /**
+     * It generates the hash in JWT format of the NvmApiKey
+     * @param signatureUtils the SignatureUtils instance
+     * @param issuerAccount the account  issuing the key
+     * @returns a JWT string representing the hash of the NvmApiKey
+     */
+    async hashJWT(signatureUtils, issuerAccount, heliconeApiKey) {
+        const issuerAddress = getChecksumAddress(issuerAccount.address);
+        return (new EthSignJWT({
+            iss: issuerAddress, // the account generating the hash (node/provider, etc) is the issuer of the hash
+            sub: this.iss, // the issuer of the NVMApiKey (the user) is the subject of the hash
+            jti: this.hash(),
+            exp: this.exp,
+            o11y: heliconeApiKey,
+        })
+            .setProtectedHeader({ alg: 'ES256K' })
+            // .setIssuedAt() // WARNING: If enabled, the hash will change for the same NvmApiKey
+            .ethSign(signatureUtils, issuerAccount));
+    }
+    /**
+     * It regenerates the NvmApiKey from a JSON object
+     * @param jwt JWTPayload in JSON format
+     * @returns the @see {@link NvmApiKey}
+     */
+    static fromJSON(jwt) {
+        const nvmKey = new NvmApiKey();
+        const str = JSON.stringify(jwt);
+        const _obj = JSON.parse(str);
+        Object.keys(_obj)
+            .filter((val) => val !== undefined)
+            .forEach((key) => {
+            nvmKey[key] = _obj[key];
+        });
+        return nvmKey;
+    }
+    /**
+     * It regenerates the NvmApiKey from a JWT
+     * @param jwtString the string in JWT format represeting the NvmApiKey
+     * @returns the @see {@link NvmApiKey}
+     */
+    static fromJWT(jwtString) {
+        const jwt = NvmApiKey.decodeJWT(jwtString);
+        return NvmApiKey.fromJSON(jwt);
+    }
+    /**
+     * It regenerates the NvmApiKey from a string
+     * @param str the string represeting the NvmApiKey
+     * @returns the @see {@link NvmApiKey}
+     */
+    static deserialize(str) {
+        return NvmApiKey.fromJSON(JSON.parse(str));
+    }
+    /**
+     * It serializes the NVM Api Key into a string
+     * @returns a string representing the NVM API Key
+     */
+    serialize() {
+        return this.toString();
+    }
+    /**
+     * It serializes the NVM Api Key into a string
+     * @returns a string representing the NVM API Key
+     */
+    toString() {
+        return JSON.stringify(this);
+    }
+    /**
+     * It decodes a string JWT into a JWTPayload
+     * @param str jwt string
+     * @returns the JWTPayload
+     */
+    static decodeJWT(str) {
+        return decodeJwt(str);
+    }
+    /**
+     * It generates the hash of the NvmApiKey
+     * @returns a string representing the hash of the NvmApiKey
+     */
+    hash() {
+        return SignatureUtils.hash(this.serialize());
+    }
+    /**
+     * Given a serialized string, it generates the hash
+     * @param serialized the serialized string
+     * @returns the hash
+     */
+    static hash(serialized) {
+        return SignatureUtils.hash(serialized);
+    }
+}

package/dist/models/Transactions.d.ts

@@ -0,0 +1,11 @@
+export interface TxParameters {
+    value?: bigint;
+    gasLimit?: bigint;
+    gasMultiplier?: number;
+    gasPrice?: string;
+    maxPriorityFeePerGas?: string;
+    maxFeePerGas?: string;
+    nonce?: number;
+    progress?: (data: any) => void;
+}
+//# sourceMappingURL=Transactions.d.ts.map

package/dist/models/Transactions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Transactions.d.ts","sourceRoot":"","sources":["../../src/models/Transactions.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,YAAY;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,oBAAoB,CAAC,EAAE,MAAM,CAAA;IAC7B,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,CAAA;CAC/B"}

package/dist/models/Transactions.js

@@ -0,0 +1 @@
+export {};

package/dist/models/index.d.ts

@@ -0,0 +1,7 @@
+export * from './Logger.js';
+export * from './NeverminedOptions.js';
+export * from './NvmApiKey.js';
+export * from './Transactions.js';
+export * from './AgentAccessToken.js';
+export * from './AgentX402AccessToken.js';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,wBAAwB,CAAA;AACtC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,mBAAmB,CAAA;AACjC,cAAc,uBAAuB,CAAA;AACrC,cAAc,2BAA2B,CAAA"}

package/dist/models/index.js

@@ -0,0 +1,6 @@
+export * from './Logger.js';
+export * from './NeverminedOptions.js';
+export * from './NvmApiKey.js';
+export * from './Transactions.js';
+export * from './AgentAccessToken.js';
+export * from './AgentX402AccessToken.js';

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,24 @@
+import { OrderResult, Plan } from '@nvm-monorepo/commons';
+import { Account, Address } from 'viem';
+import { SmartAccount } from 'viem/account-abstraction';
+import { Instantiable, InstantiableConfig } from '../../Instantiable.abstract.js';
+export declare class PaymentsApi extends Instantiable {
+    /**
+     * Creates a new PaymentsApi
+     * @param config - Configuration of the Nevermined instance
+     * @returns {@link PaymentsApi}
+     */
+    constructor(config: InstantiableConfig);
+    getERC20Balance(userAddress: Address, tokenAddress: Address): Promise<bigint>;
+    getPlanFees(planId: bigint): Promise<{
+        cryptoFeeRate: bigint;
+        fiatFeeRate: bigint;
+        feeDenominator: bigint;
+        totalAmount: bigint;
+        ownerAmount: bigint;
+    }>;
+    orderFiatPayment(planId: bigint, planReceiver: Address, from: Account | SmartAccount, numberOfPurchases?: bigint): Promise<OrderResult>;
+    orderCryptoPlan(planId: bigint, plan: Plan, from: Account | SmartAccount, planReceiver?: Address, numberOfPurchases?: bigint): Promise<OrderResult>;
+    private _orderCryptoPlan;
+}
+//# 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,EAAE,WAAW,EAAE,IAAI,EAA8B,MAAM,uBAAuB,CAAA;AACrF,OAAO,EAAE,OAAO,EAAE,OAAO,EAAoC,MAAM,MAAM,CAAA;AACzE,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AAEvD,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAA;AAOjF,qBAAa,WAAY,SAAQ,YAAY;IAC3C;;;;OAIG;gBACS,MAAM,EAAE,kBAAkB;IAKzB,eAAe,CAAC,WAAW,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAgB7E,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;QAChD,aAAa,EAAE,MAAM,CAAA;QACrB,WAAW,EAAE,MAAM,CAAA;QACnB,cAAc,EAAE,MAAM,CAAA;QACtB,WAAW,EAAE,MAAM,CAAA;QACnB,WAAW,EAAE,MAAM,CAAA;KACpB,CAAC;IA4CW,gBAAgB,CAC3B,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,OAAO,EACrB,IAAI,EAAE,OAAO,GAAG,YAAY,EAC5B,iBAAiB,SAAK,GACrB,OAAO,CAAC,WAAW,CAAC;IA0BV,eAAe,CAC1B,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,OAAO,GAAG,YAAY,EAC5B,YAAY,CAAC,EAAE,OAAO,EACtB,iBAAiB,SAAK,GACrB,OAAO,CAAC,WAAW,CAAC;YAUT,gBAAgB;CAqH/B"}