@alephium/web3 0.19.1 → 0.20.0

package/dist/src/api/types.d.ts

@@ -21,6 +21,7 @@ export declare function toApiVal(v: Val, tpe: string): node.Val;
 export declare function fromApiVals(vals: node.Val[], names: string[], types: string[], systemEvent?: boolean): NamedVals;
 export declare function fromApiArray(vals: node.Val[], types: string[]): Val[];
 export declare function fromApiVal(v: node.Val, tpe: string): Val;
+export declare function getDefaultValue(tpe: string): Val;
 export declare function typeLength(tpe: string): number;
 export interface ApiRequestArguments {
     path: string;

package/dist/src/api/types.js

@@ -17,7 +17,8 @@ You should have received a copy of the GNU Lesser General Public License
 along with the library. If not, see <http://www.gnu.org/licenses/>.
 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StdInterfaceIds = exports.request = exports.forwardRequests = exports.typeLength = exports.fromApiVal = exports.fromApiArray = exports.fromApiVals = exports.toApiVal = exports.toApiArray = exports.toApiAddress = exports.toApiByteVec = exports.fromApiNumber256 = exports.toApiNumber256Optional = exports.toApiNumber256 = exports.toApiBoolean = exports.fromApiTokens = exports.fromApiToken = exports.toApiTokens = exports.toApiToken = void 0;
+exports.StdInterfaceIds = exports.request = exports.forwardRequests = exports.typeLength = exports.getDefaultValue = exports.fromApiVal = exports.fromApiArray = exports.fromApiVals = exports.toApiVal = exports.toApiArray = exports.toApiAddress = exports.toApiByteVec = exports.fromApiNumber256 = exports.toApiNumber256Optional = exports.toApiNumber256 = exports.toApiBoolean = exports.fromApiTokens = exports.fromApiToken = exports.toApiTokens = exports.toApiToken = void 0;
+const constants_1 = require("../constants");
 const utils_1 = require("../utils");
 utils_1.assertType;
 function toApiToken(token) {
@@ -224,6 +225,21 @@ function decodeArrayType(tpe) {
         return [subType, [dim]];
     }
 }
+function getDefaultValue(tpe) {
+    if (tpe === 'U256' || tpe === 'I256')
+        return 0n;
+    if (tpe === 'Bool')
+        return false;
+    if (tpe === 'ByteVec')
+        return '';
+    if (tpe === 'Address')
+        return constants_1.ZERO_ADDRESS;
+    // array type
+    const [baseType, dims] = decodeArrayType(tpe);
+    const defaultBaseValue = getDefaultValue(baseType);
+    return dims.reduceRight((acc, length) => Array(length).fill(acc), defaultBaseValue);
+}
+exports.getDefaultValue = getDefaultValue;
 function foldVals(vals, dims) {
     if (dims.length == 1) {
         return vals;

package/dist/src/contract/contract.d.ts

@@ -120,6 +120,7 @@ export declare class Contract extends Artifact {
     static fromCompileResult(result: node.CompileContractResult): Contract;
     static fromArtifactFile(path: string, bytecodeDebugPatch: string, codeHashDebug: string): Promise<Contract>;
     toString(): string;
+    getInitialFieldsWithDefaultValues(): Fields;
     toState<T extends Fields>(fields: T, asset: Asset, address?: string): ContractState<T>;
     static randomAddress(): string;
     printDebugMessages(funcName: string, messages: DebugMessage[]): void;

package/dist/src/contract/contract.js

@@ -552,6 +552,19 @@ class Contract extends Artifact {
         }
         return JSON.stringify(object, null, 2);
     }
+    getInitialFieldsWithDefaultValues() {
+        const fields = this.stdInterfaceId === undefined
+            ? this.fieldsSig
+            : {
+                names: this.fieldsSig.names.slice(-1),
+                types: this.fieldsSig.types.slice(-1),
+                isMutable: this.fieldsSig.isMutable.slice(-1)
+            };
+        return fields.names.reduce((acc, key, index) => {
+            acc[`${key}`] = (0, api_1.getDefaultValue)(fields.types[`${index}`]);
+            return acc;
+        }, {});
+    }
     toState(fields, asset, address) {
         const addressDef = typeof address !== 'undefined' ? address : Contract.randomAddress();
         return {

package/dist/src/utils/number.d.ts

@@ -16,3 +16,4 @@ export declare function prettifyNumber(amount: Number256, decimals: number, conf
 export declare function convertAmountWithDecimals(amount: string | number, decimals: number): bigint | undefined;
 export declare function convertAlphAmountWithDecimals(amount: string | number): bigint | undefined;
 export declare function number256ToBigint(number: Number256): bigint;
+export declare function number256ToNumber(number: Number256, decimals: number): number;

package/dist/src/utils/number.js

@@ -20,7 +20,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.number256ToBigint = exports.convertAlphAmountWithDecimals = exports.convertAmountWithDecimals = exports.prettifyNumber = exports.prettifyExactAmount = exports.prettifyTokenAmount = exports.prettifyAttoAlphAmount = exports.prettifyNumberConfig = exports.isNumeric = void 0;
+exports.number256ToNumber = exports.number256ToBigint = exports.convertAlphAmountWithDecimals = exports.convertAmountWithDecimals = exports.prettifyNumber = exports.prettifyExactAmount = exports.prettifyTokenAmount = exports.prettifyAttoAlphAmount = exports.prettifyNumberConfig = exports.isNumeric = void 0;
 // Credits:
 // 1. https://github.com/argentlabs/argent-x/blob/e63affa7f28b27333dca4081a3dcd375bb2da40b/packages/extension/src/shared/utils/number.ts
 // 2. https://github.com/ethers-io/ethers.js/blob/724881f34d428406488a1c9f9dbebe54b6edecda/src.ts/utils/fixednumber.ts
@@ -138,7 +138,7 @@ function convertAmountWithDecimals(amount, decimals) {
     }
 }
 exports.convertAmountWithDecimals = convertAmountWithDecimals;
-// E.g. `1.23 ALPH` will be converted to `1230000000000000000`
+// E.g. `1.23` ALPH will be converted to `1230000000000000000`
 function convertAlphAmountWithDecimals(amount) {
     return convertAmountWithDecimals(amount, 18);
 }
@@ -147,3 +147,7 @@ function number256ToBigint(number) {
     return typeof number === 'string' ? BigInt(number) : number;
 }
 exports.number256ToBigint = number256ToBigint;
+function number256ToNumber(number, decimals) {
+    return parseFloat(toFixedNumber(number256ToBigint(number), decimals));
+}
+exports.number256ToNumber = number256ToNumber;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alephium/web3",
-  "version": "0.19.1",
+  "version": "0.20.0",
   "description": "A JS/TS library to interact with the Alephium platform",
   "license": "GPL",
   "main": "dist/src/index.js",

package/src/api/types.ts

@@ -16,6 +16,7 @@ You should have received a copy of the GNU Lesser General Public License
 along with the library. If not, see <http://www.gnu.org/licenses/>.
 */
 
+import { ZERO_ADDRESS } from '../constants'
 import { assertType, bs58, Eq, isBase58, isHexString } from '../utils'
 import * as node from './api-alephium'
 
@@ -224,6 +225,18 @@ function decodeArrayType(tpe: string): [baseType: string, dims: number[]] {
   }
 }
 
+export function getDefaultValue(tpe: string): Val {
+  if (tpe === 'U256' || tpe === 'I256') return 0n
+  if (tpe === 'Bool') return false
+  if (tpe === 'ByteVec') return ''
+  if (tpe === 'Address') return ZERO_ADDRESS
+
+  // array type
+  const [baseType, dims] = decodeArrayType(tpe)
+  const defaultBaseValue = getDefaultValue(baseType)
+  return dims.reduceRight((acc, length) => Array(length).fill(acc), defaultBaseValue)
+}
+
 function foldVals(vals: Val[], dims: number[]): Val {
   if (dims.length == 1) {
     return vals

package/src/contract/contract.ts

@@ -33,7 +33,8 @@ import {
   Val,
   fromApiTokens,
   fromApiVals,
-  typeLength
+  typeLength,
+  getDefaultValue
 } from '../api'
 import {
   SignDeployContractTxParams,
@@ -844,6 +845,21 @@ export class Contract extends Artifact {
     return JSON.stringify(object, null, 2)
   }
 
+  getInitialFieldsWithDefaultValues(): Fields {
+    const fields =
+      this.stdInterfaceId === undefined
+        ? this.fieldsSig
+        : {
+            names: this.fieldsSig.names.slice(-1),
+            types: this.fieldsSig.types.slice(-1),
+            isMutable: this.fieldsSig.isMutable.slice(-1)
+          }
+    return fields.names.reduce((acc, key, index) => {
+      acc[`${key}`] = getDefaultValue(fields.types[`${index}`])
+      return acc
+    }, {})
+  }
+
   toState<T extends Fields>(fields: T, asset: Asset, address?: string): ContractState<T> {
     const addressDef = typeof address !== 'undefined' ? address : Contract.randomAddress()
     return {

package/src/utils/number.ts

@@ -153,7 +153,7 @@ export function convertAmountWithDecimals(amount: string | number, decimals: num
   }
 }
 
-// E.g. `1.23 ALPH` will be converted to `1230000000000000000`
+// E.g. `1.23` ALPH will be converted to `1230000000000000000`
 export function convertAlphAmountWithDecimals(amount: string | number): bigint | undefined {
   return convertAmountWithDecimals(amount, 18)
 }
@@ -161,3 +161,7 @@ export function convertAlphAmountWithDecimals(amount: string | number): bigint |
 export function number256ToBigint(number: Number256): bigint {
   return typeof number === 'string' ? BigInt(number) : number
 }
+
+export function number256ToNumber(number: Number256, decimals: number): number {
+  return parseFloat(toFixedNumber(number256ToBigint(number), decimals))
+}