Merge pull request #506 from multiversx/TOOL-272-add-title-to-abi-endpoints

Add title to abi endpoint

Author: danielailie

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@multiversx/sdk-core",
-  "version": "13.8.0",
+  "version": "13.9.0",
   "description": "MultiversX SDK for JavaScript and TypeScript",
   "author": "MultiversX",
   "homepage": "https://multiversx.com",

package.json

@@ -203,4 +203,12 @@ describe("test abi registry", () => {
         assert.deepEqual(enumType.variants[1].name, "interrupted");
         assert.deepEqual(enumType.variants[1].discriminant, 1);
     });
+
+    it("should load abi with title for endpoint", async () => {
+        const registry = await loadAbiRegistry("src/testdata/lottery-esdt.abi.json");
+
+        const endpoint = registry.getEndpoint("createLotteryPool");
+
+        assert.equal(endpoint.title, "Create lottery pool");
+    });
 });

src/smartcontracts/typesystem/abiRegistry.spec.ts

@@ -214,7 +214,7 @@ function mapEndpoint(endpoint: EndpointDefinition, mapper: TypeMapper): Endpoint
         (e) => new EndpointParameterDefinition(e.name, e.description, mapper.mapType(e.type)),
     );
 
-    return new EndpointDefinition(endpoint.name, newInput, newOutput, endpoint.modifiers);
+    return new EndpointDefinition(endpoint.name, newInput, newOutput, endpoint.modifiers, endpoint.title);
 }
 
 function mapEvent(event: EventDefinition, mapper: TypeMapper): EventDefinition {

src/smartcontracts/typesystem/abiRegistry.ts

@@ -6,6 +6,7 @@ const DescriptionPlaceholder = "N / A";
 
 export class EndpointDefinition {
     readonly name: string;
+    readonly title: string;
     readonly input: EndpointParameterDefinition[] = [];
     readonly output: EndpointParameterDefinition[] = [];
     readonly modifiers: EndpointModifiers;
@@ -15,8 +16,10 @@ export class EndpointDefinition {
         input: EndpointParameterDefinition[],
         output: EndpointParameterDefinition[],
         modifiers: EndpointModifiers,
+        title?: string,
     ) {
         this.name = name;
+        this.title = title || "";
         this.input = input || [];
         this.output = output || [];
         this.modifiers = modifiers;
@@ -28,6 +31,7 @@ export class EndpointDefinition {
 
     static fromJSON(json: {
         name: string;
+        title?: string;
         onlyOwner?: boolean;
         mutability: string;
         payableInTokens: string[];
@@ -36,6 +40,7 @@ export class EndpointDefinition {
     }): EndpointDefinition {
         json.name = json.name == null ? NamePlaceholder : json.name;
         json.onlyOwner = json.onlyOwner || false;
+        json.title = json.title || "";
         json.payableInTokens = json.payableInTokens || [];
         json.inputs = json.inputs || [];
         json.outputs = json.outputs || [];
@@ -44,7 +49,7 @@ export class EndpointDefinition {
         let output = json.outputs.map((param) => EndpointParameterDefinition.fromJSON(param));
         let modifiers = new EndpointModifiers(json.mutability, json.payableInTokens, json.onlyOwner);
 
-        return new EndpointDefinition(json.name, input, output, modifiers);
+        return new EndpointDefinition(json.name, input, output, modifiers, json.title);
     }
 }
 

src/smartcontracts/typesystem/endpoint.ts

@@ -68,6 +68,7 @@
         },
         {
             "name": "createLotteryPool",
+            "title": "Create lottery pool",
             "mutability": "mutable",
             "inputs": [
                 {