Merge pull request #588 from multiversx/TOOL-512-Cleanup-update-descriptions

Update methods description and delete unnecessary code

Author: danielailie

package-lock.json

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

package.json

@@ -1,5 +1,5 @@
-import { IAccount } from "../accounts/interfaces";
 import { Address, BaseController, BaseControllerInput } from "../core";
+import { IAccount } from "../core/interfaces";
 import { Transaction } from "../core/transaction";
 import { TransactionsFactoryConfig } from "../core/transactionsFactoryConfig";
 import { AccountTransactionsFactory } from "./accountTransactionsFactory";

src/accountManagement/accountController.ts

@@ -1,12 +1,7 @@
 import * as fs from "fs";
 import { PathLike } from "fs";
-import { Message, MessageComputer, TransactionComputer } from "../core";
-import { Address } from "../core/address";
-import { LibraryConfig } from "../core/config";
-import { Transaction } from "../core/transaction";
-import { KeyPair, Mnemonic, UserPublicKey, UserSecretKey, UserSigner, UserWallet } from "../wallet";
-import { UserPem } from "../wallet/userPem";
-import { IAccount } from "./interfaces";
+import { Address, IAccount, LibraryConfig, Message, MessageComputer, Transaction, TransactionComputer } from "../core";
+import { KeyPair, Mnemonic, UserPem, UserPublicKey, UserSecretKey, UserSigner, UserWallet } from "../wallet";
 
 /**
  * An abstraction representing an account (user or Smart Contract) on the Network.

src/accounts/account.ts

@@ -1,2 +1 @@
 export * from "./account";
-export * from "./interfaces";

src/accounts/index.ts

@@ -6,7 +6,7 @@ export * from "./baseController";
 export * from "./codeMetadata";
 export * from "./config";
 export * from "./errors";
-export * from "./interface";
+export * from "./interfaces";
 export * from "./logger";
 export * from "./message";
 export * from "./networkParams";

src/accounts/interfaces.ts

@@ -1,4 +1,14 @@
-import { TransactionOnNetwork } from "./transactionOnNetwork";
+import { Address, Message, Transaction, TransactionOnNetwork } from ".";
+
+export interface IAccount {
+    readonly address: Address;
+
+    sign(data: Uint8Array): Promise<Uint8Array>;
+    signTransaction(transaction: Transaction): Promise<Uint8Array>;
+    verifyTransactionSignature(transaction: Transaction, signature: Uint8Array): Promise<boolean>;
+    signMessage(message: Message): Promise<Uint8Array>;
+    verifyMessageSignature(message: Message, signature: Uint8Array): Promise<boolean>;
+}
 
 export interface ITransactionFetcher {
     /**

src/core/index.ts

@@ -51,6 +51,9 @@ export class MessageComputer {
         return createKeccakHash("keccak256").update(bytesToHash).digest();
     }
 
+    /**
+     * returns the result of `computeBytesForSigning`
+     */
     computeBytesForVerifying(message: Message): Uint8Array {
         return this.computeBytesForSigning(message);
     }
@@ -71,6 +74,10 @@ export class MessageComputer {
         };
     }
 
+    /**
+     * packedMessage should be the one obtained from calling `packMessage()`
+     * should treat both 'legacy message' and current message
+     */
     unpackMessage(packedMessage: {
         message: string;
         signature?: string;

src/core/interface.ts renamed to src/core/interfaces.ts

@@ -21,6 +21,9 @@ interface ILegacyTokenTransferOptions {
 export type TokenType = "NFT" | "SFT" | "META" | "FNG";
 
 export class Token {
+    /**
+     * E.g. "FOO-abcdef", "EGLD-000000".
+     */
     readonly identifier: string;
     readonly nonce: bigint;
 
@@ -88,6 +91,10 @@ export class TokenTransfer {
         }
     }
 
+    /**     *
+     * @param amount
+     * @returns @TokenTransfer from native token
+     */
     static newFromNativeAmount(amount: bigint): TokenTransfer {
         const token = new Token({ identifier: EGLD_IDENTIFIER_FOR_MULTI_ESDTNFT_TRANSFER });
         return new TokenTransfer({ token, amount });
@@ -98,15 +105,15 @@ export class TokenTransfer {
     }
 
     /**
-     * @deprecated Use the constructor instead: new TokenTransfer({ token, amount });
+     * @deprecated Use {@link newFromNativeAmount} instead.
      */
     static egldFromAmount(amount: BigNumber.Value) {
         const amountAsBigInteger = new BigNumber(amount).shiftedBy(EGLDNumDecimals).decimalPlaces(0);
         return this.egldFromBigInteger(amountAsBigInteger);
     }
 
     /**
-     * @deprecated Use the constructor instead: new TokenTransfer({ token, amount });
+     * @deprecated Use {@link newFromNativeAmount} instead.
      */
     static egldFromBigInteger(amountAsBigInteger: BigNumber.Value) {
         return new TokenTransfer({
@@ -232,10 +239,16 @@ export class TokenComputer {
     TOKEN_RANDOM_SEQUENCE_LENGTH = 6;
     constructor() {}
 
+    /**
+     * Returns token.nonce == 0
+     */
     isFungible(token: Token): boolean {
         return token.nonce === 0n;
     }
 
+    /**
+     * Given "FOO-abcdef-0a" returns 10.
+     */
     extractNonceFromExtendedIdentifier(identifier: string): number {
         const parts = identifier.split("-");
 
@@ -252,6 +265,9 @@ export class TokenComputer {
         return decodeUnsignedNumber(Buffer.from(hexNonce, "hex"));
     }
 
+    /**
+     * Given "FOO-abcdef-0a" returns FOO-abcdef.
+     */
     extractIdentifierFromExtendedIdentifier(identifier: string): string {
         const parts = identifier.split("-");
         const { prefix, ticker, randomSequence } = this.splitIdentifierIntoComponents(parts);
@@ -264,6 +280,22 @@ export class TokenComputer {
         return ticker + "-" + randomSequence;
     }
 
+    /**
+     * Given "FOO-abcdef-0a" returns FOO.
+     * Given "FOO-abcdef" returns FOO.
+     */
+    extractTickerFromExtendedIdentifier(identifier: string): string {
+        const parts = identifier.split("-");
+        const { prefix, ticker, randomSequence } = this.splitIdentifierIntoComponents(parts);
+
+        this.validateExtendedIdentifier(prefix, ticker, randomSequence, parts);
+        if (prefix) {
+            this.checkLengthOfPrefix(prefix);
+            return prefix + "-" + ticker + "-" + randomSequence;
+        }
+        return ticker;
+    }
+
     computeExtendedIdentifier(token: Token): string {
         const parts = token.identifier.split("-");
         const { prefix, ticker, randomSequence } = this.splitIdentifierIntoComponents(parts);
@@ -315,10 +347,6 @@ export class TokenComputer {
         }
     }
 
-    private isLowercaseAlphanumeric(str: string): boolean {
-        return /^[a-z0-9]+$/.test(str);
-    }
-
     private checkLengthOfRandomSequence(randomSequence: string): void {
         if (randomSequence.length !== this.TOKEN_RANDOM_SEQUENCE_LENGTH) {
             throw new ErrInvalidTokenIdentifier(