Merge pull request #1800 from aeternity/release/13.0.1

Release 13.0.1

Author: davidyuk

.github/workflows/main.yml

@@ -9,7 +9,7 @@ jobs:
           sudo apt install --allow-downgrades ./esl-erlang_25.0.4-1~ubuntu~jammy_amd64.deb
       - uses: actions/checkout@v2
         with:
-          fetch-depth: 0
+          fetch-depth: 100
       - uses: actions/setup-node@v2
         with:
           node-version: 18.x
@@ -21,16 +21,11 @@ jobs:
           key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
       - run: npm ci
       - name: Run Commitlint
+        if: github.event_name == 'pull_request'
         env:
-          EVENT_TYPE: ${{ github.event_name }}
           HEAD: ${{ github.event.pull_request.head.sha }}
           BASE: ${{ github.event.pull_request.base.sha }}
-        run: |
-          if [ "$EVENT_TYPE" = "push" ]; then
-            npx commitlint --from HEAD~${{ github.event.push.commits }} --to HEAD --verbose
-          else
-            npx commitlint --from $BASE --to $HEAD --verbose
-          fi
+        run: npx commitlint --from $BASE --to $HEAD --verbose
       - run: npm run lint
       - run: docker-compose up -d
       - name: Ensure that node is running

docs/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [13.0.1](https://github.com/aeternity/aepp-sdk-js/compare/v13.0.0...v13.0.1) (2023-04-24)
+
+
+### Bug Fixes
+
+* **contract:** return type of call/deploy on chain ([c493707](https://github.com/aeternity/aepp-sdk-js/commit/c49370756fa3ed3a6f37bad2cefcbbd858ff94ee))
+* export of `prefixedAmount` helper ([9b3f68f](https://github.com/aeternity/aepp-sdk-js/commit/9b3f68f99b3943c42c4639c3a247ee9881229d18))
+
 ## [13.0.0](https://github.com/aeternity/aepp-sdk-js/compare/v13.0.0-beta.0...v13.0.0) (2023-04-06)
 
 

docs/README.md

@@ -82,6 +82,8 @@ This may be done in `tsconfig.json`:
 ```
 SDK uses modern features available since [email protected]. Though SDK is still compatible with [email protected] and above using types generated separately, but these types are less accurate.
 
+Ensure that you have `strictFunctionTypes` option not enabled (as it is in VS code and `ts-node` by default), otherwise some of SDK types won't work correctly (see [#1793](https://github.com/aeternity/aepp-sdk-js/issues/1793)).
+
 ### Vue CLI@4
 SDK checks are not working correctly because CLI picks both ESM and CJS versions of `autorest`
 dependencies. To fix this, you need to specify aliases in `vue.config.js`.

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@aeternity/aepp-sdk",
-  "version": "13.0.0",
+  "version": "13.0.1",
   "description": "SDK for the æternity blockchain",
   "main": "dist/aepp-sdk.js",
   "types": "es/index.d.ts",

package.json

@@ -72,7 +72,7 @@ type TxData = Awaited<ReturnType<typeof sendTransaction>>;
 interface SendAndProcessReturnType {
   result?: ContractCallObject;
   hash: TxData['hash'];
-  tx: TxUnpacked & { tag: Tag.ContractCallTx | Tag.ContractCreateTx };
+  tx: TxUnpacked & { tag: Tag.SignedTx | Tag.ContractCallTx | Tag.ContractCreateTx };
   txData: TxData;
   rawTx: Encoded.Transaction;
 }

src/contract/Contract.ts

@@ -11,6 +11,23 @@ import getTransactionSignerAddress from './transaction-signer';
  * Calculates the cost of transaction execution
  * Provides an upper cost of contract-call-related transactions because of `gasLimit`.
  * Also assumes that oracle query fee is 0 unless it is provided in options.
+ *
+ * The idea is that if you need to show transaction details with some accuracy you can define
+ * expense fields that you want to show separately. And to show `getExecutionCost` result as a fee,
+ * subtracting all fields shown separately.
+ *
+ * @example
+ * ```vue
+ * <template>
+ * Amount: {{ txUnpacked.amount }}
+ * Name fee: {{ txUnpacked.nameFee }}
+ * Other fees: {{ getExecutionCost(txEncoded) - txUnpacked.amount - txUnpacked.nameFee }}
+ * </template>
+ * ```
+ *
+ * Doing this way you won't worry to show wrong fee for a transaction you may not support. Because
+ * the SDK calculates the overall price of any transaction on its side.
+ *
  * @param transaction - Transaction to calculate the cost of
  * @param innerTx - Should be provided if transaction wrapped with Tag.PayingForTx
  * @param gasUsed - Amount of gas actually used to make calculation more accurate

src/tx/execution-cost.ts

@@ -85,7 +85,7 @@ const getNearestPrefix = (exponent: number): Prefix => prefixes.reduce((p, n) =>
 const getLowerBoundPrefix = (exponent: number): Prefix => prefixes
   .find((p) => p.magnitude <= exponent) ?? prefixes[prefixes.length - 1];
 
-export default (rawValue: string | number | BigNumber): string => {
+export const prefixedAmount = (rawValue: string | number | BigNumber): string => {
   const value: BigNumber = new BigNumber(rawValue);
 
   const exp = value.e ?? 0;

src/typings/@aeternity__aepp-calldata/index.d.ts

@@ -20,7 +20,9 @@ const aeSdk = new AeSdk({
   console.log('Height:', await aeSdk.getHeight());
   console.log('Instanceof works correctly for nodes pool', aeSdk.pool instanceof Map);
 
-  const contract = await aeSdk.initializeContract({ sourceCode: contractSourceCode });
+  const contract = await aeSdk.initializeContract<{
+    getArg: (x: Map<string, number | bigint | string>) => Map<string, bigint>;
+  }>({ sourceCode: contractSourceCode });
   const deployInfo = await contract.$deploy([]);
   console.log('Contract deployed at', deployInfo.address);
   const map = new Map([['foo', 42], ['bar', 43]]);