Merge pull request #209 from ElrondNetwork/decoupling

Decoupling, minor refactoring

CHANGELOG.md

@@ -7,6 +7,9 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 ## Unreleased
  - TBD
 
+## 10.2.2
+ - [Decoupling, minor refactoring](https://github.com/ElrondNetwork/elrond-sdk-erdjs/pull/209)
+
 ## 10.2.1
  - [When loading the ABI, sort custom types by their type dependencies](https://github.com/ElrondNetwork/elrond-sdk-erdjs/pull/208)
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elrondnetwork/erdjs",
-  "version": "10.2.1",
+  "version": "10.2.2",
   "description": "Smart Contracts interaction framework",
   "main": "out/index.js",
   "types": "out/index.d.js",

src/interface.ts

@@ -27,6 +27,6 @@ export interface ITransactionPayload {
 export interface ITokenPayment {
     readonly tokenIdentifier: string;
     readonly nonce: number;
-    readonly amountAsBigInteger: BigNumber;
-    valueOf(): BigNumber;
+    readonly amountAsBigInteger: BigNumber.Value;
+    valueOf(): BigNumber.Value;
 }

src/smartcontracts/abi.ts

@@ -1,24 +1,18 @@
-import { ErrInvariantFailed } from "../errors";
 import { guardValueIsSetWithMessage } from "../utils";
 import { ContractFunction } from "./function";
 import { AbiRegistry, EndpointDefinition } from "./typesystem";
 import { ContractInterface } from "./typesystem/contractInterface";
 
 export class SmartContractAbi {
-    private readonly interfaces: ContractInterface[] = [];
+    private readonly interface: ContractInterface;
 
-    constructor(registry: AbiRegistry, implementsInterfaces: string[]) {
-        this.interfaces.push(...registry.getInterfaces(implementsInterfaces));
+    // TODO (breaking, next major version): remove second parameter (not used anymore).
+    constructor(registry: AbiRegistry, _implementsInterfaces?: string[]) {
+        this.interface = registry.interfaces[0];
     }
 
     getAllEndpoints(): EndpointDefinition[] {
-        let endpoints = [];
-
-        for (const iface of this.interfaces) {
-            endpoints.push(...iface.endpoints);
-        }
-
-        return endpoints;
+        return this.interface.endpoints;
     }
 
     getEndpoint(name: string | ContractFunction): EndpointDefinition {
@@ -31,20 +25,6 @@ export class SmartContractAbi {
     }
 
     getConstructorDefinition(): EndpointDefinition | null {
-        let constructors = [];
-        for (const iface of this.interfaces) {
-            let constructor_definition = iface.getConstructorDefinition();
-            if (constructor_definition !== null) {
-                constructors.push(constructor_definition);
-            }
-        }
-        switch (constructors.length) {
-            case 0:
-                return null;
-            case 1:
-                return constructors[0];
-            default:
-                throw new ErrInvariantFailed(`Found more than 1 constructor (found ${constructors.length})`);
-        }
+        return this.interface.getConstructorDefinition();
     }
 }

src/smartcontracts/function.ts

@@ -40,6 +40,7 @@ export class ContractFunction {
         return this.name;
     }
 
+    // TODO (breaking, next major version): remove function, not used.
     equals(other: ContractFunction | null): boolean {
         if (!other) {
             return false;

src/smartcontracts/interface.ts

@@ -1,8 +1,5 @@
 import { IAddress, IChainID, IGasLimit, IGasPrice, ITransactionValue } from "../interface";
 import { Transaction } from "../transaction";
-import { Code } from "./code";
-import { CodeMetadata } from "./codeMetadata";
-import { ContractFunction } from "./function";
 import { ReturnCode } from "./returnCode";
 import { TypedValue } from "./typesystem";
 
@@ -32,8 +29,8 @@ export interface ISmartContract {
 }
 
 export interface DeployArguments {
-    code: Code;
-    codeMetadata?: CodeMetadata;
+    code: ICode;
+    codeMetadata?: ICodeMetadata;
     initArguments?: TypedValue[];
     value?: ITransactionValue;
     gasLimit: IGasLimit;
@@ -42,8 +39,8 @@ export interface DeployArguments {
 }
 
 export interface UpgradeArguments {
-    code: Code;
-    codeMetadata?: CodeMetadata;
+    code: ICode;
+    codeMetadata?: ICodeMetadata;
     initArguments?: TypedValue[];
     value?: ITransactionValue;
     gasLimit: IGasLimit;
@@ -52,7 +49,7 @@ export interface UpgradeArguments {
 }
 
 export interface CallArguments {
-    func: ContractFunction;
+    func: IContractFunction;
     args?: TypedValue[];
     value?: ITransactionValue;
     gasLimit: IGasLimit;
@@ -62,7 +59,7 @@ export interface CallArguments {
 }
 
 export interface QueryArguments {
-    func: ContractFunction;
+    func: IContractFunction;
     args?: TypedValue[];
     value?: ITransactionValue;
     caller?: IAddress
@@ -83,3 +80,16 @@ export interface UntypedOutcomeBundle {
     returnMessage: string;
     values: Buffer[];
 }
+
+export interface ICode {
+    toString(): string;
+}
+
+export interface ICodeMetadata {
+    toString(): string;
+}
+
+export interface IContractFunction {
+    name: string;
+    toString(): string;
+}

src/smartcontracts/query.ts

@@ -1,20 +1,20 @@
-import { ContractFunction } from "./function";
 import { Address } from "../address";
 import { TypedValue } from "./typesystem";
 import { ArgSerializer } from "./argSerializer";
 import { IAddress, ITransactionValue } from "../interface";
+import { IContractFunction } from "./interface";
 
 export class Query {
     caller: IAddress;
     address: IAddress;
-    func: ContractFunction;
+    func: IContractFunction;
     args: TypedValue[];
     value: ITransactionValue;
 
     constructor(obj: {
         caller?: IAddress,
         address: IAddress,
-        func: ContractFunction,
+        func: IContractFunction,
         args?: TypedValue[],
         value?: ITransactionValue
     }) {

src/smartcontracts/transactionPayloadBuilders.ts

@@ -1,10 +1,8 @@
 
 import { TransactionPayload } from "../transactionPayload";
 import { guardValueIsSet } from "../utils";
-import { Code } from "./code";
-import { CodeMetadata } from "./codeMetadata";
-import { ContractFunction } from "./function";
 import { ArgSerializer } from "./argSerializer";
+import { ICode, ICodeMetadata, IContractFunction } from "./interface";
 import { TypedValue } from "./typesystem";
 
 export const ArwenVirtualMachine = "0500";
@@ -13,22 +11,22 @@ export const ArwenVirtualMachine = "0500";
  * A builder for {@link TransactionPayload} objects, to be used for Smart Contract deployment transactions.
  */
 export class ContractDeployPayloadBuilder {
-    private code: Code | null = null;
-    private codeMetadata: CodeMetadata = new CodeMetadata();
+    private code: ICode | null = null;
+    private codeMetadata: ICodeMetadata = "";
     private arguments: TypedValue[] = [];
 
     /**
      * Sets the code of the Smart Contract.
      */
-    setCode(code: Code): ContractDeployPayloadBuilder {
+    setCode(code: ICode): ContractDeployPayloadBuilder {
         this.code = code;
         return this;
     }
 
     /**
      * Sets the code metadata of the Smart Contract.
      */
-    setCodeMetadata(codeMetadata: CodeMetadata): ContractDeployPayloadBuilder {
+    setCodeMetadata(codeMetadata: ICodeMetadata): ContractDeployPayloadBuilder {
         this.codeMetadata = codeMetadata;
         return this;
     }
@@ -68,22 +66,22 @@ export class ContractDeployPayloadBuilder {
  * A builder for {@link TransactionPayload} objects, to be used for Smart Contract upgrade transactions.
  */
 export class ContractUpgradePayloadBuilder {
-    private code: Code | null = null;
-    private codeMetadata: CodeMetadata = new CodeMetadata();
+    private code: ICode | null = null;
+    private codeMetadata: ICodeMetadata = "";
     private arguments: TypedValue[] = [];
 
     /**
      * Sets the code of the Smart Contract.
      */
-    setCode(code: Code): ContractUpgradePayloadBuilder {
+    setCode(code: ICode): ContractUpgradePayloadBuilder {
         this.code = code;
         return this;
     }
 
     /**
      * Sets the code metadata of the Smart Contract.
      */
-    setCodeMetadata(codeMetadata: CodeMetadata): ContractUpgradePayloadBuilder {
+    setCodeMetadata(codeMetadata: ICodeMetadata): ContractUpgradePayloadBuilder {
         this.codeMetadata = codeMetadata;
         return this;
     }
@@ -123,13 +121,13 @@ export class ContractUpgradePayloadBuilder {
  * A builder for {@link TransactionPayload} objects, to be used for Smart Contract execution transactions.
  */
 export class ContractCallPayloadBuilder {
-    private contractFunction: ContractFunction | null = null;
+    private contractFunction: IContractFunction | null = null;
     private arguments: TypedValue[] = [];
 
     /**
      * Sets the function to be called (executed).
      */
-    setFunction(contractFunction: ContractFunction): ContractCallPayloadBuilder {
+    setFunction(contractFunction: IContractFunction): ContractCallPayloadBuilder {
         this.contractFunction = contractFunction;
         return this;
     }

src/tokenPayment.ts

@@ -11,8 +11,9 @@ export class TokenPayment {
     readonly tokenIdentifier: string;
     readonly nonce: number;
     readonly amountAsBigInteger: BigNumber;
-    private readonly numDecimals: number;
+    readonly numDecimals: number;
 
+    // TODO (breaking, next major version): constructor({ ... })
     constructor(tokenIdentifier: string, nonce: number, amountAsBigInteger: BigNumber.Value, numDecimals: number) {
         let amount = new BigNumber(amountAsBigInteger);
         if (!amount.isInteger() || amount.isNegative()) {
@@ -72,6 +73,7 @@ export class TokenPayment {
         return `${this.toRationalNumber()} ${this.tokenIdentifier}`;
     }
 
+    // TODO (breaking, next major version): rename to "toAmount()", make it private.
     toRationalNumber() {
         return this.amountAsBigInteger.shiftedBy(-this.numDecimals).toFixed(this.numDecimals);
     }