@nevermined-io/payments 0.8.2 → 0.8.4

package/dist/common/helper.d.ts

@@ -1,4 +1,4 @@
-import { Endpoint } from '../payments';
+import { Endpoint } from './types';
 export declare const sleep: (ms: number) => Promise<unknown>;
 export declare const jsonReplacer: (_key: any, value: {
     toString: () => any;

package/dist/common/helper.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"helper.d.ts","sourceRoot":"","sources":["../../src/common/helper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAEtC,eAAO,MAAM,KAAK,OAAQ,MAAM,qBAAsD,CAAA;AAEtF,eAAO,MAAM,YAAY,SAAU,GAAG,SAAS;IAAE,QAAQ,EAAE,MAAM,GAAG,CAAA;CAAE;cAAX,MAAM,GAAG;CAEnE,CAAA;AAED,eAAO,MAAM,2BAA2B,cAAe,QAAQ,EAAE,KAAG,MAOnE,CAAA"}
+{"version":3,"file":"helper.d.ts","sourceRoot":"","sources":["../../src/common/helper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAElC,eAAO,MAAM,KAAK,OAAQ,MAAM,qBAAsD,CAAA;AAEtF,eAAO,MAAM,YAAY,SAAU,GAAG,SAAS;IAAE,QAAQ,EAAE,MAAM,GAAG,CAAA;CAAE;cAAX,MAAM,GAAG;CAEnE,CAAA;AAED,eAAO,MAAM,2BAA2B,cAAe,QAAQ,EAAE,KAAG,MAOnE,CAAA"}

package/dist/common/types.d.ts

@@ -1,3 +1,4 @@
+import { EnvironmentName } from '../environments';
 export declare const FIRST_STEP_NAME = "init";
 /**
  * A task defines something that the agent should execute.
@@ -164,6 +165,35 @@ export interface TaskLogMessage {
     step_id?: string;
 }
 export type TaskCallback = (data: any) => void;
+/**
+ * Options to initialize the Payments class.
+ */
+export interface PaymentOptions {
+    /**
+     * The Nevermined environment to connect to.
+     * If you are developing an agent it's recommended to use the "testing" environment.
+     * When deploying to production use the "arbitrum" environment.
+     */
+    environment: EnvironmentName;
+    /**
+     * The Nevermined API Key. This key identify your user and is required to interact with the Nevermined API.
+     * You can get your API key by logging in to the Nevermined App.
+     * @see https://docs.nevermined.app/docs/tutorials/integration/nvm-api-keys
+     */
+    nvmApiKey?: string;
+    /**
+     * The URL to return to the app after a successful login.
+     */
+    returnUrl?: string;
+    /**
+     * The app id. This attribute is optional and helps to associate assets registered into Nevermined with a common identifier.
+     */
+    appId?: string;
+    /**
+     * The version of the API to use.
+     */
+    version?: string;
+}
 export interface CreateTaskDto {
     /**
      * The query parameter for the task
@@ -184,4 +214,225 @@ export interface CreateTaskDto {
      */
     artifacts?: Artifact[];
 }
+export interface Endpoint {
+    [verb: string]: string;
+}
+export interface CreatePlanTimeDto {
+    /**
+     * The name of the plan.
+     */
+    name: string;
+    /**
+     * A description of what the plan offers.
+     */
+    description: string;
+    /**
+     * The price of the plan. It must be given in the lowest denomination of the currency.
+     */
+    price: bigint;
+    /**
+     * The address of the ERC20 contract used for the payment. Using the `ZeroAddress` will use the chain's native currency instead.
+     */
+    tokenAddress: string;
+    /**
+     * The duration of the plan in days. If `duration` is left undefined an unlimited time duration subscription will be created.
+     */
+    duration?: number;
+    /**
+     * An array of tags or keywords that best fit the subscription.
+     */
+    tags?: string[];
+}
+export interface CreatePlanCreditsDto {
+    /**
+     * The name of the plan.
+     */
+    name: string;
+    /**
+     *  A description of what the plan offers.
+     */
+    description: string;
+    /**
+     * The price of the plan. It must be given in the lowest denomination of the currency.
+     */
+    price: bigint;
+    /**
+     * The address of the ERC20 contract used for the payment. Using the `ZeroAddress` will use the chain's native currency instead.
+     */
+    tokenAddress: string;
+    /**
+     * The number of credits that are transferred to the user when purchases the plan.
+     */
+    amountOfCredits: number;
+    /**
+     *  An array of tags or keywords that best fit the subscription.
+     */
+    tags?: string[];
+}
+export interface CreateServiceDto {
+    /**
+     * The service type ('service', 'agent', or 'assistant').
+     */
+    serviceType: string;
+    /**
+     * The plan unique identifier of the Plan (DID). @see {@link createCreditsPlan} or {@link createTimePlan}
+     */
+    planDID: string;
+    /**
+     * The name of the AI Agent/Service.
+     */
+    name: string;
+    /**
+     * The description of the AI Agent/Service.
+     */
+    description: string;
+    /**
+     * If the agent is using the AI Hub. If true, the agent will be configured to use the AI Hub endpoints.
+     */
+    usesAIHub?: boolean;
+    /**
+     * It the agent implements the Nevermined Query Protocol. @see https://docs.nevermined.io/docs/protocol/query-protocol
+     */
+    implementsQueryProtocol?: boolean;
+    /**
+     *  The service charge type ('fixed' or 'dynamic').
+     */
+    serviceChargeType: 'fixed' | 'dynamic';
+    /**
+     * The upstream agent/service authentication type ('none', 'basic', 'bearer' or 'oauth').
+     */
+    authType?: 'none' | 'basic' | 'oauth' | 'bearer';
+    /**
+     * The amount of credits to charge per request to the agent.
+     */
+    amountOfCredits?: number;
+    /**
+     * The minimum credits to charge.
+     */
+    minCreditsToCharge?: number;
+    /**
+     * The maximum credits to charge.
+     */
+    maxCreditsToCharge?: number;
+    /**
+     * The upstream agent/service username for authentication. Only if `authType` is 'basic'.
+     */
+    username?: string;
+    /**
+     * The upstream agent/service password for authentication. Only if `authType` is 'basic'.
+     */
+    password?: string;
+    /**
+     * The upstream agent/service bearer token for authentication. Only if `authType` is 'bearer' or 'oauth'.
+     */
+    token?: string;
+    /**
+     * The list endpoints of the upstream service. All these endpoints are protected and only accessible to subscribers of the Payment Plan.
+     */
+    endpoints?: Endpoint[];
+    /**
+     * The list of endpoints of the upstream service that publicly available. The access to these endpoints don't require subscription to the Payment Plan. They are useful to expose documentation, etc.
+     */
+    openEndpoints?: string[];
+    /**
+     * The URL to the OpenAPI description of the Upstream API. The access to the OpenAPI definition don't require subscription to the Payment Plan.
+     */
+    openApiUrl?: string;
+    /**
+     * Some description or instructions about how to integrate the Agent.
+     */
+    integration?: string;
+    /**
+     * A link to some same usage of the Agent.
+     */
+    sampleLink?: string;
+    /**
+     * Text describing the API of the Agent.
+     */
+    apiDescription?: string;
+    /**
+     * The curation details.
+     */
+    curation?: object;
+    /**
+     * The tags describing the AI Agent/Service.
+     */
+    tags?: string[];
+}
+export type CreateAgentDto = Omit<CreateServiceDto, 'serviceType'>;
+export type CreateFileDto = {
+    /**
+     * The plan unique identifier of the Plan (DID). @see {@link createCreditsPlan} or {@link createTimePlan}
+     */
+    planDID: string;
+    /**
+     * @param assetType - The type of asset ('dataset' | 'algorithm' | 'model' | 'file' | 'other')
+     *
+     */
+    assetType: 'dataset' | 'algorithm' | 'model' | 'file' | 'other';
+    /**
+     *  The name of the file.
+     */
+    name: string;
+    /**
+     * The description of the file.
+     */
+    description: string;
+    /**
+     * The array of files that can be downloaded for users that are subscribers of the Payment Plan.
+     */
+    files: object[];
+    /**
+     * The data schema of the files.
+     */
+    dataSchema?: string;
+    /**
+     * Some sample code related to the file.
+     */
+    sampleCode?: string;
+    /**
+     * The format of the files.
+     */
+    filesFormat?: string;
+    /**
+     * The usage example.
+     */
+    usageExample?: string;
+    /**
+     * The programming language used in the files.
+     */
+    programmingLanguage?: string;
+    /**
+     * The framework used for creating the file.
+     */
+    framework?: string;
+    /**
+     * The task creating the file.
+     */
+    task?: string;
+    /**
+     * The training details.
+     */
+    trainingDetails?: string;
+    /**
+     *  The variations.
+     */
+    variations?: string;
+    /**
+     * Indicates if the file is fine-tunable.
+     */
+    fineTunable?: boolean;
+    /**
+     * The cost in credits of downloading a file. This parameter is only required if the Payment Plan attached to the file is based on credits.
+     */
+    amountOfCredits?: number;
+    /**
+     * The curation object.
+     */
+    curation?: object;
+    /**
+     * The array of tags describing the file.
+     */
+    tags?: string[];
+};
 //# sourceMappingURL=types.d.ts.map

package/dist/common/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/common/types.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,eAAe,SAAS,CAAA;AAErC;;GAEG;AACH,MAAM,WAAW,IAAK,SAAQ,gBAAgB;IAC5C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,WAAW,EAAE,oBAAoB,CAAA;IAEjC;;OAEG;IACH,KAAK,EAAE,IAAI,EAAE,CAAA;IAEb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,IAAK,SAAQ,gBAAgB;IAC5C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,WAAW,EAAE,oBAAoB,CAAA;IAEjC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,MAAM,WAAW,gBAAiB,SAAQ,cAAc,EAAE,eAAe;IACvE;;OAEG;IACH,UAAU,CAAC,EAAE,IAAI,CAAA;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,IAAI,CAAA;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,YAAY,CAAC,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,EAAE,CAAA;IAE3C;;OAEG;IACH,eAAe,CAAC,EAAE,QAAQ,EAAE,CAAA;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,EAAE,GAAG,CAAA;IAEX;;OAEG;IAEH,iBAAiB,CAAC,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EAAE,CAAA;IAE7C;;OAEG;IACH,gBAAgB,CAAC,EAAE,GAAG,EAAE,CAAA;CACzB;AAED;;GAEG;AACH,oBAAY,oBAAoB;IAC9B;;OAEG;IACH,OAAO,YAAY;IAEnB;;OAEG;IACH,WAAW,gBAAgB;IAE3B;;OAEG;IACH,SAAS,cAAc;IAEvB;;OAEG;IACH,SAAS,cAAc;IAEvB;;OAEG;IACH,MAAM,WAAW;CAClB;AAED,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;;;;;OAMG;IACH,GAAG,EAAE,MAAM,CAAA;CACZ;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,OAAO,CAAA;IAE7C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAA;IAElC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,MAAM,YAAY,GAAG,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,CAAA;AAE9C,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,iBAAiB,CAAC,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,EAAE,CAAA;IAEhD;;OAEG;IACH,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAA;CACvB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/common/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAEjD,eAAO,MAAM,eAAe,SAAS,CAAA;AAErC;;GAEG;AACH,MAAM,WAAW,IAAK,SAAQ,gBAAgB;IAC5C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,WAAW,EAAE,oBAAoB,CAAA;IAEjC;;OAEG;IACH,KAAK,EAAE,IAAI,EAAE,CAAA;IAEb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,IAAK,SAAQ,gBAAgB;IAC5C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,WAAW,EAAE,oBAAoB,CAAA;IAEjC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,MAAM,WAAW,gBAAiB,SAAQ,cAAc,EAAE,eAAe;IACvE;;OAEG;IACH,UAAU,CAAC,EAAE,IAAI,CAAA;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,IAAI,CAAA;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,YAAY,CAAC,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,EAAE,CAAA;IAE3C;;OAEG;IACH,eAAe,CAAC,EAAE,QAAQ,EAAE,CAAA;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,EAAE,GAAG,CAAA;IAEX;;OAEG;IAEH,iBAAiB,CAAC,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EAAE,CAAA;IAE7C;;OAEG;IACH,gBAAgB,CAAC,EAAE,GAAG,EAAE,CAAA;CACzB;AAED;;GAEG;AACH,oBAAY,oBAAoB;IAC9B;;OAEG;IACH,OAAO,YAAY;IAEnB;;OAEG;IACH,WAAW,gBAAgB;IAE3B;;OAEG;IACH,SAAS,cAAc;IAEvB;;OAEG;IACH,SAAS,cAAc;IAEvB;;OAEG;IACH,MAAM,WAAW;CAClB;AAED,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;;;;;OAMG;IACH,GAAG,EAAE,MAAM,CAAA;CACZ;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,OAAO,CAAA;IAE7C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAA;IAElC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,MAAM,YAAY,GAAG,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,CAAA;AAE9C;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;OAIG;IACH,WAAW,EAAE,eAAe,CAAA;IAE5B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,iBAAiB,CAAC,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,EAAE,CAAA;IAEhD;;OAEG;IACH,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAA;CACvB;AAED,MAAM,WAAW,QAAQ;IACvB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CAChB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAA;IACvB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CAChB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;OAEG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAA;IACjC;;OAEG;IACH,iBAAiB,EAAE,OAAO,GAAG,SAAS,CAAA;IACtC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,CAAA;IAChD;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAA;IACtB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;IACxB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CAChB;AAED,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,gBAAgB,EAAE,aAAa,CAAC,CAAA;AAElE,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IACf;;;OAGG;IACH,SAAS,EAAE,SAAS,GAAG,WAAW,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,CAAA;IAC/D;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,KAAK,EAAE,MAAM,EAAE,CAAA;IACf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CAChB,CAAA"}

package/dist/common/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/common/types.ts"],"names":[],"mappings":";;;AAAa,QAAA,eAAe,GAAG,MAAM,CAAA;AA0HrC;;GAEG;AACH,IAAY,oBAyBX;AAzBD,WAAY,oBAAoB;IAC9B;;OAEG;IACH,2CAAmB,CAAA;IAEnB;;OAEG;IACH,mDAA2B,CAAA;IAE3B;;OAEG;IACH,+CAAuB,CAAA;IAEvB;;OAEG;IACH,+CAAuB,CAAA;IAEvB;;OAEG;IACH,yCAAiB,CAAA;AACnB,CAAC,EAzBW,oBAAoB,oCAApB,oBAAoB,QAyB/B"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/common/types.ts"],"names":[],"mappings":";;;AAEa,QAAA,eAAe,GAAG,MAAM,CAAA;AA0HrC;;GAEG;AACH,IAAY,oBAyBX;AAzBD,WAAY,oBAAoB;IAC9B;;OAEG;IACH,2CAAmB,CAAA;IAEnB;;OAEG;IACH,mDAA2B,CAAA;IAE3B;;OAEG;IACH,+CAAuB,CAAA;IAEvB;;OAEG;IACH,+CAAuB,CAAA;IAEvB;;OAEG;IACH,yCAAiB,CAAA;AACnB,CAAC,EAzBW,oBAAoB,oCAApB,oBAAoB,QAyB/B"}

package/dist/environments.d.ts

@@ -5,7 +5,7 @@ export interface EnvironmentInfo {
     proxy: string;
 }
 export declare const ZeroAddress = "0x0000000000000000000000000000000000000000";
-export type EnvironmentName = 'local' | 'staging' | 'testing' | 'arbitrum' | 'peaq' | 'custom';
+export type EnvironmentName = 'local' | 'staging' | 'testing' | 'arbitrum' | 'peaq' | 'base' | 'custom';
 /**
  * Represents the different environments and their corresponding URLs.
  */

package/dist/environments.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"environments.d.ts","sourceRoot":"","sources":["../src/environments.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,gBAAgB,EAAE,MAAM,CAAA;IACxB,KAAK,EAAE,MAAM,CAAA;CACd;AAED,eAAO,MAAM,WAAW,+CAA+C,CAAA;AAEvE,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,GAAG,MAAM,GAAG,QAAQ,CAAA;AAE9F;;GAEG;AACH,eAAO,MAAM,YAAY,EAAE,MAAM,CAAC,eAAe,EAAE,eAAe,CAuDjE,CAAA"}
+{"version":3,"file":"environments.d.ts","sourceRoot":"","sources":["../src/environments.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,gBAAgB,EAAE,MAAM,CAAA;IACxB,KAAK,EAAE,MAAM,CAAA;CACd;AAED,eAAO,MAAM,WAAW,+CAA+C,CAAA;AAEvE,MAAM,MAAM,eAAe,GACvB,OAAO,GACP,SAAS,GACT,SAAS,GACT,UAAU,GACV,MAAM,GACN,MAAM,GACN,QAAQ,CAAA;AAEZ;;GAEG;AACH,eAAO,MAAM,YAAY,EAAE,MAAM,CAAC,eAAe,EAAE,eAAe,CA6DjE,CAAA"}

package/dist/environments.js

@@ -51,6 +51,12 @@ exports.Environments = {
         websocketBackend: 'wss://one-backend.peaq.nevermined.app',
         proxy: 'https://proxy.peaq.nevermined.app',
     },
+    base: {
+        frontend: 'https://base.nevermined.app',
+        backend: 'https://one-backend.base.nevermined.app',
+        websocketBackend: 'wss://one-backend.base.nevermined.app',
+        proxy: 'https://proxy.base.nevermined.app',
+    },
     /**
      * A custom environment URLs.
      */

package/dist/environments.js.map

@@ -1 +1 @@
-{"version":3,"file":"environments.js","sourceRoot":"","sources":["../src/environments.ts"],"names":[],"mappings":";;;AAOa,QAAA,WAAW,GAAG,4CAA4C,CAAA;AAIvE;;GAEG;AACU,QAAA,YAAY,GAA6C;IACpE;;OAEG;IACH,KAAK,EAAE;QACL,QAAQ,EAAE,uBAAuB;QACjC,OAAO,EAAE,uBAAuB;QAChC,gBAAgB,EAAE,qBAAqB;QACvC,KAAK,EAAE,uBAAuB;KAC/B;IACD;;OAEG;IACH,OAAO,EAAE;QACP,QAAQ,EAAE,gCAAgC;QAC1C,OAAO,EAAE,4CAA4C;QACrD,gBAAgB,EAAE,0CAA0C;QAC5D,KAAK,EAAE,sCAAsC;KAC9C;IACD;;OAEG;IACH,OAAO,EAAE;QACP,QAAQ,EAAE,gCAAgC;QAC1C,OAAO,EAAE,4CAA4C;QACrD,gBAAgB,EAAE,0CAA0C;QAC5D,KAAK,EAAE,sCAAsC;KAC9C;IACD;;OAEG;IACH,QAAQ,EAAE;QACR,QAAQ,EAAE,wBAAwB;QAClC,OAAO,EAAE,6CAA6C;QACtD,gBAAgB,EAAE,2CAA2C;QAC7D,KAAK,EAAE,uCAAuC;KAC/C;IACD;;OAEG;IACH,IAAI,EAAE;QACJ,QAAQ,EAAE,6BAA6B;QACvC,OAAO,EAAE,yCAAyC;QAClD,gBAAgB,EAAE,uCAAuC;QACzD,KAAK,EAAE,mCAAmC;KAC3C;IACD;;OAEG;IACH,MAAM,EAAE;QACN,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,uBAAuB;QACjE,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,uBAAuB;QAC/D,gBAAgB,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,IAAI,qBAAqB;QACxE,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,uBAAuB;KAC5D;CACF,CAAA"}
+{"version":3,"file":"environments.js","sourceRoot":"","sources":["../src/environments.ts"],"names":[],"mappings":";;;AAOa,QAAA,WAAW,GAAG,4CAA4C,CAAA;AAWvE;;GAEG;AACU,QAAA,YAAY,GAA6C;IACpE;;OAEG;IACH,KAAK,EAAE;QACL,QAAQ,EAAE,uBAAuB;QACjC,OAAO,EAAE,uBAAuB;QAChC,gBAAgB,EAAE,qBAAqB;QACvC,KAAK,EAAE,uBAAuB;KAC/B;IACD;;OAEG;IACH,OAAO,EAAE;QACP,QAAQ,EAAE,gCAAgC;QAC1C,OAAO,EAAE,4CAA4C;QACrD,gBAAgB,EAAE,0CAA0C;QAC5D,KAAK,EAAE,sCAAsC;KAC9C;IACD;;OAEG;IACH,OAAO,EAAE;QACP,QAAQ,EAAE,gCAAgC;QAC1C,OAAO,EAAE,4CAA4C;QACrD,gBAAgB,EAAE,0CAA0C;QAC5D,KAAK,EAAE,sCAAsC;KAC9C;IACD;;OAEG;IACH,QAAQ,EAAE;QACR,QAAQ,EAAE,wBAAwB;QAClC,OAAO,EAAE,6CAA6C;QACtD,gBAAgB,EAAE,2CAA2C;QAC7D,KAAK,EAAE,uCAAuC;KAC/C;IACD;;OAEG;IACH,IAAI,EAAE;QACJ,QAAQ,EAAE,6BAA6B;QACvC,OAAO,EAAE,yCAAyC;QAClD,gBAAgB,EAAE,uCAAuC;QACzD,KAAK,EAAE,mCAAmC;KAC3C;IACD,IAAI,EAAE;QACJ,QAAQ,EAAE,6BAA6B;QACvC,OAAO,EAAE,yCAAyC;QAClD,gBAAgB,EAAE,uCAAuC;QACzD,KAAK,EAAE,mCAAmC;KAC3C;IACD;;OAEG;IACH,MAAM,EAAE;QACN,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,uBAAuB;QACjE,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,uBAAuB;QAC/D,gBAAgB,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,IAAI,qBAAqB;QACxE,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,uBAAuB;KAC5D;CACF,CAAA"}

package/dist/payments.d.ts

@@ -1,37 +1,6 @@
 import { AIQueryApi } from './api/query-api';
-import { EnvironmentInfo, EnvironmentName } from './environments';
-/**
- * Options to initialize the Payments class.
- */
-export interface PaymentOptions {
-    /**
-     * The Nevermined environment to connect to.
-     * If you are developing an agent it's recommended to use the "testing" environment.
-     * When deploying to production use the "arbitrum" environment.
-     */
-    environment: EnvironmentName;
-    /**
-     * The Nevermined API Key. This key identify your user and is required to interact with the Nevermined API.
-     * You can get your API key by logging in to the Nevermined App.
-     * @see https://docs.nevermined.app/docs/tutorials/integration/nvm-api-keys
-     */
-    nvmApiKey?: string;
-    /**
-     * The URL to return to the app after a successful login.
-     */
-    returnUrl?: string;
-    /**
-     * The app id. This attribute is optional and helps to associate assets registered into Nevermined with a common identifier.
-     */
-    appId?: string;
-    /**
-     * The version of the API to use.
-     */
-    version?: string;
-}
-export interface Endpoint {
-    [verb: string]: string;
-}
+import { CreateAgentDto, CreateFileDto, CreatePlanCreditsDto, CreatePlanTimeDto, CreateServiceDto, PaymentOptions } from './common/types';
+import { EnvironmentInfo } from './environments';
 /**
  * Main class that interacts with the Nevermined payments API.
  * To get an instance of this class use the `getInstance` method.
@@ -177,12 +146,7 @@ export declare class Payments {
      *
      * @see https://docs.nevermined.app/docs/tutorials/builders/create-plan
      *
-     * @param name - The name of the plan.
-     * @param description - A description of what the plan offers.
-     * @param price - The price of the plan. It must be given in the lowest denomination of the currency.
-     * @param tokenAddress - The address of the ERC20 contract used for the payment. Using the `ZeroAddress` will use the chain's native currency instead.
-     * @param amountOfCredits - The number of credits that are transferred to the user when purchases the plan.
-     * @param tags - An array of tags or keywords that best fit the subscription.
+     * @param createPlanCreditsDto - @see {@link CreatePlanCreditsDto}
      *
      * @example
      * ```
@@ -198,14 +162,7 @@ export declare class Payments {
      *
      * @returns The unique identifier of the plan (Plan DID) of the newly created plan.
      */
-    createCreditsPlan({ name, description, price, tokenAddress, amountOfCredits, tags, }: {
-        name: string;
-        description: string;
-        price: bigint;
-        tokenAddress: string;
-        amountOfCredits: number;
-        tags?: string[];
-    }): Promise<{
+    createCreditsPlan(createPlanCreditsDto: CreatePlanCreditsDto): Promise<{
         did: string;
     }>;
     /**
@@ -221,13 +178,7 @@ export declare class Payments {
      *
      * @see https://docs.nevermined.app/docs/tutorials/builders/create-plan
      *
-     * @param name - The name of the plan.
-     * @param description - A description of what the plan offers.
-     * @param price - The price of the plan. It must be given in the lowest denomination of the currency.
-     * @param tokenAddress - The address of the ERC20 contract used for the payment. Using the `ZeroAddress` will use the chain's native currency instead.
-     * @param tags - An array of tags or keywords that best fit the subscription.
-     * @param duration - The duration of the plan in days. If `duration` is left undefined an unlimited time duration subscription will be created.
-     * @param tags - An array of tags or keywords that best fit the subscription.
+     * @param createPlanTimeDto - @see {@link CreatePlanTimeDto}
      *
      * @example
      * ```
@@ -243,14 +194,7 @@ export declare class Payments {
      *
      * @returns The unique identifier of the plan (Plan DID) of the newly created plan.
      */
-    createTimePlan({ name, description, price, tokenAddress, duration, tags, }: {
-        name: string;
-        description: string;
-        price: bigint;
-        tokenAddress: string;
-        duration?: number;
-        tags?: string[];
-    }): Promise<{
+    createTimePlan(createPlanTimeDto: CreatePlanTimeDto): Promise<{
         did: string;
     }>;
     /**
@@ -281,54 +225,59 @@ export declare class Payments {
      *   })
      * ```
      *
-     * @param planDID - The plan unique identifier of the Plan (DID). @see {@link createCreditsPlan} or {@link createTimePlan}
-     * @param name - The name of the AI Agent/Service.
-     * @param description - The description of the AI Agent/Service.
-     * @param tags - The tags describing the AI Agent/Service.
-     * @param usesAIHub - If the agent is using the AI Hub. If true, the agent will be configured to use the AI Hub endpoints.
-     * @param implementsQueryProtocol - It the agent implements the Nevermined Query Protocol. @see https://docs.nevermined.io/docs/protocol/query-protocol
-     * @param serviceChargeType - The service charge type ('fixed' or 'dynamic').
-     * @param amountOfCredits - The amount of credits to charge per request to the agent.
-     * @param minCreditsToCharge - The minimum credits to charge.
-     * @param maxCreditsToCharge - The maximum credits to charge.
-     * @param authType - The upstream agent/service authentication type ('none', 'basic', 'bearer' or 'oauth').
-     * @param username - The upstream agent/service username for authentication. Only if `authType` is 'basic'.
-     * @param password - The upstream agent/service password for authentication. Only if `authType` is 'basic'.
-     * @param token - The upstream agent/service bearer token for authentication. Only if `authType` is 'bearer' or 'oauth'.
-     * @param endpoints - The list endpoints of the upstream service. All these endpoints are protected and only accessible to subscribers of the Payment Plan.
-     * @param openEndpoints - The list of endpoints of the upstream service that publicly available. The access to these endpoints don't require subscription to the Payment Plan. They are useful to expose documentation, etc.
-     * @param openApiUrl - The URL to the OpenAPI description of the Upstream API. The access to the OpenAPI definition don't require subscription to the Payment Plan.
-     * @param integration - Some description or instructions about how to integrate the Agent.
-     * @param sampleLink - A link to some same usage of the Agent.
-     * @param apiDescription - Text describing the API of the Agent.
-     * @param curation - The curation details.
+     * @param createAgentDto - @see {@link CreateAgentDto}
      * @returns A promise that resolves to the created agent DID.
      */
-    createAgent({ planDID, name, description, amountOfCredits, tags, usesAIHub, implementsQueryProtocol, serviceChargeType, minCreditsToCharge, maxCreditsToCharge, authType, username, password, token, endpoints, openEndpoints, openApiUrl, integration, sampleLink, apiDescription, curation, }: {
-        planDID: string;
-        name: string;
-        description: string;
-        usesAIHub?: boolean;
-        implementsQueryProtocol?: boolean;
-        serviceChargeType: 'fixed' | 'dynamic';
-        authType?: 'none' | 'basic' | 'oauth' | 'bearer';
-        amountOfCredits?: number;
-        minCreditsToCharge?: number;
-        maxCreditsToCharge?: number;
-        username?: string;
-        password?: string;
-        token?: string;
-        endpoints?: Endpoint[];
-        openEndpoints?: string[];
-        openApiUrl?: string;
-        integration?: string;
-        sampleLink?: string;
-        apiDescription?: string;
-        curation?: object;
-        tags?: string[];
-    }): Promise<{
+    createAgent(createAgentDto: CreateAgentDto): Promise<{
         did: string;
     }>;
+    /**
+     *
+     * It creates a new AI Agent and a Payment Plan on Nevermined.
+     *
+     * @remarks
+     *
+     * This method is oriented to AI Builders
+     *
+     * @see https://docs.nevermined.app/docs/tutorials/builders/register-agent
+     *
+     * @param plan - @see {@link CreatePlanCreditsDto}
+     * @param agent - @see {@link CreateAgentDto} PlanDID is generated automatically.
+     * @returns A promise that resolves to the Plan DID and Agent DID.
+     *
+     * @example
+     * ```
+     * const { planDID, agentDID } = await paymentsBuilder.createAgentAndPlan(
+     * {
+     * name: 'My AI Payments Plan',
+     * description: 'AI stuff',
+     * price: 10000000n,
+     * tokenAddress: '0x75faf114eafb1BDbe2F0316DF893fd58CE46AA4d',
+     * amountOfCredits: 30,
+     * },
+     * {
+     * name: 'Payments Agent name',
+     * description: 'description',
+     * amountOfCredits: 1,
+     * tags: ['test'],
+     * usesAIHub: true,
+     * implementsQueryProtocol: true,
+     * serviceChargeType: 'fixed',
+     * authType: 'bearer',
+     * token,
+     * endpoints,
+     * integration: 'integration details',
+     * apiDescription: 'description',
+     * curation: {}
+     * })
+     * ```
+     *
+     * @returns A promise that resolves to the Plan DID and Agent DID.
+     */
+    createAgentAndPlan(plan: CreatePlanCreditsDto, agent: Omit<CreateAgentDto, 'planDID'>): Promise<{
+        planDID: string;
+        agentDID: string;
+    }>;
     /**
      * It creates a new AI Agent or Service on Nevermined.
      * The agent/service must be associated to a Payment Plan. Users that are subscribers of a payment plan can access the agent/service.
@@ -361,54 +310,10 @@ export declare class Payments {
      *   })
      * ```
      *
-     * @param planDID - The plan unique identifier of the Plan (DID). @see {@link createCreditsPlan} or {@link createTimePlan}
-     * @param name - The name of the AI Agent/Service.
-     * @param description - The description of the AI Agent/Service.
-     * @param tags - The tags describing the AI Agent/Service.
-     * @param usesAIHub - If the agent is using the AI Hub. If true, the agent will be configured to use the AI Hub endpoints.
-     * @param implementsQueryProtocol - It the agent implements the Nevermined Query Protocol. @see https://docs.nevermined.io/docs/protocol/query-protocol
-     * @param serviceType - The service type ('service', 'agent', or 'assistant').
-     * @param serviceChargeType - The service charge type ('fixed' or 'dynamic').
-     * @param amountOfCredits - The amount of credits to charge per request to the agent.
-     * @param minCreditsToCharge - The minimum credits to charge.
-     * @param maxCreditsToCharge - The maximum credits to charge.
-     * @param authType - The upstream agent/service authentication type ('none', 'basic', 'bearer' or 'oauth').
-     * @param username - The upstream agent/service username for authentication. Only if `authType` is 'basic'.
-     * @param password - The upstream agent/service password for authentication. Only if `authType` is 'basic'.
-     * @param token - The upstream agent/service bearer token for authentication. Only if `authType` is 'bearer' or 'oauth'.
-     * @param endpoints - The list endpoints of the upstream service. All these endpoints are protected and only accessible to subscribers of the Payment Plan.
-     * @param openEndpoints - The list of endpoints of the upstream service that publicly available. The access to these endpoints don't require subscription to the Payment Plan. They are useful to expose documentation, etc.
-     * @param openApiUrl - The URL to the OpenAPI description of the Upstream API. The access to the OpenAPI definition don't require subscription to the Payment Plan.
-     * @param integration - Some description or instructions about how to integrate the Agent.
-     * @param sampleLink - A link to some same usage of the Agent.
-     * @param apiDescription - Text describing the API of the Agent.
-     * @param curation - The curation details.
+     * @param createServiceDto - @see {@link CreateServiceDto}
      * @returns A promise that resolves to the created agent DID.
      */
-    createService({ planDID, name, description, usesAIHub, implementsQueryProtocol, amountOfCredits, tags, serviceType, serviceChargeType, minCreditsToCharge, maxCreditsToCharge, authType, username, password, token, endpoints, openEndpoints, openApiUrl, integration, sampleLink, apiDescription, curation, }: {
-        planDID: string;
-        name: string;
-        description: string;
-        usesAIHub?: boolean;
-        implementsQueryProtocol?: boolean;
-        serviceType: 'service' | 'agent' | 'assistant';
-        serviceChargeType: 'fixed' | 'dynamic';
-        authType?: 'none' | 'basic' | 'oauth' | 'bearer';
-        amountOfCredits?: number;
-        minCreditsToCharge?: number;
-        maxCreditsToCharge?: number;
-        username?: string;
-        password?: string;
-        token?: string;
-        endpoints?: Endpoint[];
-        openEndpoints?: string[];
-        openApiUrl?: string;
-        integration?: string;
-        sampleLink?: string;
-        apiDescription?: string;
-        curation?: object;
-        tags?: string[];
-    }): Promise<{
+    createService(createServiceDto: CreateServiceDto): Promise<{
         did: string;
     }>;
     /**
@@ -423,48 +328,10 @@ export declare class Payments {
      *
      * @see https://docs.nevermined.app/docs/tutorials/builders/register-file-asset
      *
-     * @param planDID - The plan unique identifier of the Plan (DID). @see {@link createCreditsPlan} or {@link createTimePlan}
-     * @param assetType - The type of asset ('dataset' | 'algorithm' | 'model' | 'file' | 'other')
-     * @param name - The name of the file.
-     * @param description - The description of the file.
-     * @param files - The array of files that can be downloaded for users that are subscribers of the Payment Plan.
-     * @param amountOfCredits - The cost in credits of downloading a file. This parameter is only required if the Payment Plan attached to the file is based on credits.
-     * @param tags - The array of tags describing the file.
-     * @param dataSchema - The data schema of the files.
-     * @param sampleCode - Some sample code related to the file.
-     * @param filesFormat - The format of the files.
-     * @param usageExample - The usage example.
-     * @param programmingLanguage - The programming language used in the files.
-     * @param framework - The framework used for creating the file.
-     * @param task - The task creating the file.
-     * @param trainingDetails - The training details.
-     * @param variations - The variations.
-     * @param fineTunable - Indicates if the file is fine-tunable.
-     * @param curation - The curation object.
+     * @param createFileDto - @see {@link CreateFileDto}
      * @returns The promise that resolves to the created file's DID.
      */
-    createFile({ planDID, assetType, name, description, files, amountOfCredits, tags, dataSchema, sampleCode, filesFormat, usageExample, programmingLanguage, framework, task, trainingDetails, variations, fineTunable, curation, }: {
-        planDID: string;
-        assetType: 'dataset' | 'algorithm' | 'model' | 'file' | 'other';
-        name: string;
-        description: string;
-        files: object[];
-        dataSchema?: string;
-        sampleCode?: string;
-        filesFormat?: string;
-        usageExample?: string;
-        programmingLanguage?: string;
-        framework?: string;
-        task?: string;
-        trainingDetails?: string;
-        variations?: string;
-        fineTunable?: boolean;
-        amountOfCredits?: number;
-        minCreditsToCharge?: number;
-        maxCreditsToCharge?: number;
-        curation?: object;
-        tags?: string[];
-    }): Promise<{
+    createFile(createFileDto: CreateFileDto): Promise<{
         did: string;
     }>;
     /**