Contract wrapper #9

claudiu725 · 2021-06-28T14:26:22Z

Implements a contract wrapper which allows an user to interact with smart contracts, with the main focus being on simplicity.
The examples which this pull request enables can be found in: multiversx/mx-sdk-rs#268

Added ContractWrapper - a wrapper over a smart contract
- it uses the ABI json to create methods for calling, querying, formatting
  - example call: await adder.gas(3_000_000).call.add(30);
  - example query: let sum = await adder.query.getSum();
  - format is used for packing transaction data into a FormattedCall object
    - it can be used to forward arguments to another call - as is the case for the multisig smart contract, where actions are "proposed"
    - allows checks during unit tests
    - allows inspection when debugging
- may be used to deploy smart contracts
- wrappers are loaded from a project folder
  - example
    - let adder = await erdSys.loadWrapper("contracts/examples/adder");
  - this loads the ABI, and if a deployment is requested, the WASM code as well
  - but the WASM is optional - useful when working with pre-deployed contracts
  - where more than one contract exists in the same folder, an additional argument may specify which one has to be loaded
    - let answer = await erdSys.loadWrapper("src/testdata", "answer");
- calls with both EGLD and ESDT (FT, SFT, NFT) payments are supported
  - specified for a call via .value(MyToken(amount))
  - if the value being sent is an ESDT, the appropriate builtin function is called (ESDTTransfer or ESDTNFTTransfer)
- added SendContext and ChainSendContext which help in keeping track of transaction properties
  - re-usable ones, which keep the old value, unless overwritten: provider, logger, sender, address, gas
  - one-time use: value
Added commonly used ABIs
- ESDT system smart contract
- builtin functions
- send wrapper, for emulating EGLD and ESDT transfers without endpoint calls to as a method with an empty name
Updated existing ABIs with constructor information which is generated in the latest versions of elrond-wasm-rs
Added SystemWrapper class which encapsulates the builtin functions and ESDT system smart contract and provides a more intuitive API
Enhanced the Balance class - generalized it to accept other currencies as well
- now it stores the token and nonce for which the amount is for
- generalized it to handle any number of decimals
Added BalanceBuilder which can be used to create Balance instances for any EGLD or ESDT
- denominated values can be specified by MyToken(10.0)
- when receiving raw values from smart contracts, a non-denominated value can be built by using MyToken.raw(amount)
Added IProvider (ProxyProvider) endpoints
- address/:address/esdt - getAddressEsdtList
- address/:address/esdt/:tokenIdentifier - getAddressEsdt
- address/:address/nft/:tokenIdentifier/nonce/:nonce - getAddressEsdt
Added NativeSerializer namespace which allow easier conversion from javascript native types to the typed value system of erdjs
- it allows calling myMethod(1_000_000) instead of myMethod(new U32Value(1_000_000))
- the argument is automatically cast to the appropriate type (deduced from the ABI json)
- in case of unexpected input, useful error messages are returned through ArgumentErrorContext
Added several convenience functions which were useful in contract examples: print, printList, minutesToNonce, now, hours, minutes
Added utf8 string parsing
Updated test wallets (alice, bob, carol etc.)
- Test wallets are no longer embedded in the typescript source code, but instead are loaded from their own files
- Instead of 3 test wallets, now all 12 test wallets are included
Added npm run lint command
- Added no-floating-promises check
Refactor provider selection
- Added chooseProvider function which accepts one of local-testnet, elrond-testnet, elrond-devnet, elrond-mainnet
- Removed getDevnetProvider, getTestnetProvider, getMainnetProvider because of confusing naming (getDevnetProvider was returning the proxy for http://localhost:7950)
Refactor result logic
- De-duplicate code by extracting it into a common namespace Result
- Rename ImmediateResult to TypedResult and re-use it for both immediate results and resulting calls
Removed several out-of-date comments

alyn509 · 2021-06-30T09:31:50Z

src/smartcontracts/nativeSerializer.ts

+        if (type instanceof U8Type) {
+            return new U8Value(number);
+        }
+        if (type instanceof I8Type) {
+            return new I8Value(number);
+        }
+        if (type instanceof U16Type) {
+            return new U16Value(number);
+        }
+        if (type instanceof I16Type) {
+            return new I16Value(number);
+        }
+        if (type instanceof U32Type) {
+            return new U32Value(number);
+        }
+        if (type instanceof I32Type) {
+            return new I32Value(number);
+        }
+        if (type instanceof U64Type) {
+            return new U64Value(number);
+        }
+        if (type instanceof I64Type) {
+            return new I64Value(number);
+        }
+        if (type instanceof BigUIntType) {
+            return new BigUIntValue(number);
+        }
+        if (type instanceof BigIntType) {
+            return new BigIntValue(number);
+        }


how about a switch? https://log.havrlant.cz/typescript-switch-instanceof/

camilbancioiu · 2021-07-02T09:37:06Z

src/esdtToken.ts

+    FungibleESDT,
+    SemiFungibleESDT,
+    NonFungibleESDT


Consider renaming these to Fungible, Semifungible, Nonfunginble, i.e. without the ESDT suffix and without capitalizing the word "fungible" when prefixed.

camilbancioiu · 2021-07-02T09:39:35Z

src/esdtToken.ts

+    FungibleESDT,
+    SemiFungibleESDT,
+    NonFungibleESDT
+}

 export class ESDTToken {


Optional, but consider renaming ESDTToken to TokenDefinition, or simply Token. It's true that this class is used for ESDT, but also EGLD, which is not an ESDT. Moreover, ESDT means "Elrond Standard Digital Token", so the "T" in ESDT already means "Token". ESDTToken is redundant.

True 😄
Renamed to Token

camilbancioiu · 2021-07-02T09:41:44Z

src/esdtToken.ts

+        let [tokenName, tokenType, owner, totalMinted, totalBurned, ...propertiesBuffers] = results;
+        let properties = parseTokenProperties(propertiesBuffers);


Consider extracting these two lines into a separate function which takes results and returns properties.

I end up unpacking and then re-packing the first arguments when I extract those lines into a separate function:

function parseTokenPropertiesFromResults(results: any[]): { tokenName: any, tokenType: any, owner: any, totalMinted: any, totalBurned: any, properties: Record<string, any> } { let [tokenName, tokenType, owner, totalMinted, totalBurned, ...propertiesBuffers] = results; let properties = parseTokenProperties(propertiesBuffers); return { tokenName, tokenType, owner, totalMinted, totalBurned, properties }; }

I think it's fine as it is right now.

camilbancioiu · 2021-07-02T09:53:28Z

src/esdtToken.ts

+            canChangeOwner: response.canChangeOwner,
+            canPause: response.canPause,
+            canFreeze: response.canFreeze,
+            canWipe: response.canWipe,


Should the properties canAddSpecialRoles, canTransferNftCreateRole, nftCreateStopped and wiped be also set here? Are they available in response?

At the moment they aren't: https://testnet-api.elrond.com/tokens

camilbancioiu · 2021-07-02T09:56:58Z

src/esdtToken.ts

+}
+
+function parseValue(value: string): any {
+    switch (value) {


Before this switch, consider adding an if that checks if the value is strictly an alphanumeric string (without the decimal point), and if it is, create a BigNumber. Otherwise, go to the switch, but on the default branch, throw an exception (something like "unknown property").

This way, a malformed string will be prevented from reaching the BigNumber() constructor.

This function is used to check the results of the query to getTokenProperties, which, for its properties has values of the form: NumDecimals-2, IsPaused-false.
Because they come from the ESDT system smart contract, I don't expect them to be malformatted.

camilbancioiu · 2021-07-05T10:26:39Z

src/smartcontracts/typesystem/contractInterface.ts

+
+function constructorFromJSON(json: any): EndpointDefinition | null {
+    // if the JSON "constructor" field is missing
+    if (json.constructor == Object.constructor) {


It's safer to test for json.constructor.inputs and json.constructor.outputs. If either of them is missing, then there's no definition in the ABI for the contract constructor.

camilbancioiu · 2021-07-05T10:27:59Z

src/smartcontracts/typesystem/string.ts

+     * Returns whether two objects have the same value.
+     */
+    equals(other: StringValue): boolean {
+        return this.value == other.value;


For extra safety, use === here.

Done. There's a linter check for this, but it's explicitly disabled at the moment. It should be re-enabled at some point.

camilbancioiu · 2021-07-05T10:30:16Z

src/smartcontracts/typesystem/typeExpressionParser.ts

-    let symbolsRegex = /(:|\{|\}|,|\s)/;
-    let tokens = jsoned.split(symbolsRegex).filter((token) => token);
-    jsoned = tokens.map((token) => (symbolsRegex.test(token) ? token : `"${token}"`)).join("");
+        let symbolsRegex = /(:|\{|\}|,|(?<!utf\-8)\s)/;


Does this mean "a symbol is one of :{}, and space (\s), but up to and excluding utf-8"?

The utf-8 string is a single type but because this code was splitting by space, I had to add an exception.
The (?<!utf\-8) is a negative look-ahead.
I added a comment for this in the code.

I would recommend moving these lines to a method called splitBySpaceExceptUTF8(), then adding a few small unit tests just for it.

I can't neatly split this into a separate function (since the symbolsRegex is used in 2 places, and bringing both lines into the function would bring the rest of the code in as well, because of the re-used tokens and jsoned ).
However, this function is well tested through the parse method. I added a test-case for the utf-8 string to the already existing tests in typeExpressionParser.spec.ts.

camilbancioiu · 2021-07-05T10:31:18Z

src/smartcontracts/wrapper/generateMethods.ts

+export type Method<ReturnType> = (...args: any[]) => ReturnType;
+export type Methods<ReturnType> = Record<string, Method<ReturnType>>;
+
+export function generateMethods<ThisType, ReturnType>(this_: ThisType, abi: SmartContractAbi, endpointHandler: EndpointHandler<ThisType, ReturnType>): Methods<ReturnType> {


Please format as one parameter per line, for readability.

camilbancioiu · 2021-07-05T10:43:19Z

src/smartcontracts/nativeSerializer.ts

+    // A function may have one of the following formats:
+    // f(arg1, arg2, optional<arg3>, optional<arg4>) returns { min: 2, max: 4, variadic: false }
+    // f(arg1, variadic<bytes>) returns { min: 1, max: Infinity, variadic: true }
+    // f(arg1, arg2, optional<arg3>, arg4, optional<arg5>, variadic<bytes>) returns { min: 4, max: Infinity, variadic: true }


Shouldn't this return { min: 2, max: Infinity, variadic: true }? Only the first 2 arguments are required, the rest are optional.

True. I corrected the comment.

…-wrapper

camilbancioiu · 2021-08-06T09:15:35Z

src/dapp/walletProvider.ts

@@ -94,7 +96,7 @@ export class WalletProvider implements IDappProvider {
    /**
     * Fetches the login hook url and redirects the client to the wallet login.
     */
-    async login(options?: { callbackUrl?: string }): Promise<string> {
+    async login(options?: { callbackUrl?: string; token?: string }): Promise<string> {


Line 141 will overwrite any value provided to this argument here. Is this intentional?

This change was displayed due to more commits being made on the development branch and it's not something I wrote.
Basically, I had to do a merge from development first.

camilbancioiu · 2021-08-06T09:23:39Z

src/smartcontracts/typesystem/typeExpressionParser.ts

-    let symbolsRegex = /(:|\{|\}|,|\s)/;
-    let tokens = jsoned.split(symbolsRegex).filter((token) => token);
-    jsoned = tokens.map((token) => (symbolsRegex.test(token) ? token : `"${token}"`)).join("");
+        let symbolsRegex = /(:|\{|\}|,|(?<!utf\-8)\s)/;


I would recommend moving these lines to a method called splitBySpaceExceptUTF8(), then adding a few small unit tests just for it.

camilbancioiu · 2021-08-06T09:58:51Z

src/dapp/walletProvider.ts

+                if (!this.isValidWalletSource(ev.origin)) {
+                    return;
+                }
+
+                const { data } = ev;
+                if (data.type !== DAPP_MESSAGE_SIGN_TRANSACTION_URL) {
+                    return;
+                }


Should these be return reject(...); instead?

Same as above - these were changes from the development branch.

camilbancioiu · 2021-08-06T09:59:31Z

src/dapp/walletProvider.ts

+        plainTransaction["value"] = transaction.getValue().toString();
+        plainTransaction["gasPrice"] = transaction.getGasPrice().valueOf();
+        plainTransaction["gasLimit"] = transaction.getGasLimit().valueOf();
+


Chain ID and transaction spec version?

Same as above - these were changes from the development branch.

…-wrapper

Better handle transaction completion: proxy vs. API

Contract wrapper

fixed changelog, export encryptor/decryptor and prepared release

Contract wrapper

fixed changelog, export encryptor/decryptor and prepared release

claudiu725 added 2 commits June 23, 2021 13:03

Add wallets

b3e26f0

Add contract wrapper

b915ff8

claudiu725 changed the base branch from main to development June 28, 2021 14:27

claudiu725 mentioned this pull request Jun 28, 2021

Erdjs interaction examples multiversx/mx-sdk-rs#268

Merged

alyn509 reviewed Jun 30, 2021

View reviewed changes

camilbancioiu requested changes Jul 5, 2021

View reviewed changes

claudiu725 mentioned this pull request Jul 7, 2021

[WIP] Add contract wrapper multiversx/mx-deprecated-sdk-monorepo#270

Closed

claudiu725 added 6 commits July 27, 2021 18:09

Fix after review

4a8b09e

Merge commit '3e3db61a69e75abce880141545a12b0f0a1cb85a' into contract…

7e88902

…-wrapper

Post merge fixes, refactor chooseProvider

483e3c7

Fix after review

ddf05ae

Update changelog

355596f

Merge branch 'development' into contract-wrapper

afc2988

claudiu725 requested review from alyn509 and camilbancioiu July 28, 2021 15:17

alyn509 previously approved these changes Jul 29, 2021

View reviewed changes

camilbancioiu reviewed Aug 6, 2021

View reviewed changes

Merge commit 'a26fa9a8b460172f3bd9eb3857387676ce200a9a' into contract…

c8a4e24

…-wrapper

claudiu725 dismissed alyn509’s stale review via c8a4e24 August 6, 2021 10:52

claudiu725 added 3 commits August 6, 2021 15:15

Add test for utf-8 strings

543048c

Refactor - extract arguments to interfaces

15c370b

Add check for the number of decimals

3521311

claudiu725 requested review from camilbancioiu and alyn509 August 6, 2021 13:21

camilbancioiu approved these changes Aug 6, 2021

View reviewed changes

alyn509 approved these changes Aug 9, 2021

View reviewed changes

claudiu725 merged commit ade6d67 into development Aug 9, 2021

claudiu725 deleted the contract-wrapper branch August 9, 2021 10:48

andreibancioiu mentioned this pull request Mar 22, 2022

Breaking changes (erdjs 10): improve contract interactions and interpretation of contract results #159

Merged

andreibancioiu added a commit that referenced this pull request Sep 25, 2024

Merge pull request #9 from ElrondNetwork/handle-completion

b99a17f

Better handle transaction completion: proxy vs. API

danielailie pushed a commit that referenced this pull request Oct 2, 2024

Merge pull request #9 from ElrondNetwork/contract-wrapper

82cd483

Contract wrapper

danielailie pushed a commit that referenced this pull request Oct 2, 2024

Merge pull request #9 from ElrondNetwork/bump-version

df39ff5

fixed changelog, export encryptor/decryptor and prepared release

danielailie pushed a commit that referenced this pull request Oct 2, 2024

Merge pull request #9 from ElrondNetwork/contract-wrapper

e4e5d04

Contract wrapper

danielailie pushed a commit that referenced this pull request Oct 2, 2024

Merge pull request #9 from ElrondNetwork/bump-version

bb4c079

fixed changelog, export encryptor/decryptor and prepared release

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Contract wrapper #9

Contract wrapper #9

claudiu725 commented Jun 28, 2021

alyn509 Jun 30, 2021

claudiu725 Jul 26, 2021

camilbancioiu Jul 2, 2021

claudiu725 Jul 26, 2021

camilbancioiu Jul 2, 2021

claudiu725 Jul 26, 2021

camilbancioiu Jul 2, 2021

claudiu725 Jul 27, 2021

camilbancioiu Jul 2, 2021

claudiu725 Jul 27, 2021

camilbancioiu Jul 2, 2021

claudiu725 Jul 27, 2021

camilbancioiu Jul 5, 2021

claudiu725 Jul 23, 2021

camilbancioiu Jul 5, 2021

claudiu725 Jul 23, 2021

camilbancioiu Jul 5, 2021

claudiu725 Jul 23, 2021

camilbancioiu Aug 6, 2021

claudiu725 Aug 6, 2021

camilbancioiu Jul 5, 2021

claudiu725 Jul 23, 2021

camilbancioiu Jul 5, 2021

claudiu725 Jul 23, 2021

camilbancioiu Aug 6, 2021

claudiu725 Aug 6, 2021

camilbancioiu Aug 6, 2021

camilbancioiu Aug 6, 2021

claudiu725 Aug 6, 2021

camilbancioiu Aug 6, 2021

claudiu725 Aug 6, 2021

		let [tokenName, tokenType, owner, totalMinted, totalBurned, ...propertiesBuffers] = results;
		let properties = parseTokenProperties(propertiesBuffers);

Contract wrapper #9

Contract wrapper #9

Conversation

claudiu725 commented Jun 28, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment