@alephium/web3 2.0.0-rc.0 → 2.0.0-rc.2

package/dist/src/api/api-alephium.d.ts

@@ -268,7 +268,7 @@ export interface BuildGrouplessDeployContractTxResult {
     txId: string;
     /** @format address */
     contractAddress: string;
-    transferTxs: BuildSimpleTransferTxResult[];
+    fundingTxs?: BuildSimpleTransferTxResult[];
 }
 /** BuildGrouplessExecuteScriptTxResult */
 export interface BuildGrouplessExecuteScriptTxResult {
@@ -284,7 +284,7 @@ export interface BuildGrouplessExecuteScriptTxResult {
     /** @format 32-byte-hash */
     txId: string;
     simulationResult: SimulationResult;
-    transferTxs: BuildSimpleTransferTxResult[];
+    fundingTxs?: BuildSimpleTransferTxResult[];
 }
 /** BuildGrouplessTransferTxResult */
 export interface BuildGrouplessTransferTxResult {
@@ -299,7 +299,7 @@ export interface BuildGrouplessTransferTxResult {
     fromGroup: number;
     /** @format int32 */
     toGroup: number;
-    transferTxs: BuildSimpleTransferTxResult[];
+    fundingTxs?: BuildSimpleTransferTxResult[];
 }
 /** BuildInfo */
 export interface BuildInfo {
@@ -328,7 +328,7 @@ export interface BuildMultisig {
     gasPrice?: string;
     /** @format group-index */
     group?: number;
-    multiSigType?: MultiSigType;
+    multiSigType?: 'P2HMPK' | 'P2MPKH';
 }
 /** BuildMultisigAddress */
 export interface BuildMultisigAddress {
@@ -336,7 +336,7 @@ export interface BuildMultisigAddress {
     keyTypes?: string[];
     /** @format int32 */
     mrequired: number;
-    multiSigType?: MultiSigType;
+    multiSigType?: 'P2HMPK' | 'P2MPKH';
 }
 /** BuildMultisigAddressResult */
 export interface BuildMultisigAddressResult {
@@ -442,7 +442,7 @@ export interface BuildSweepMultisig {
     targetBlockHash?: string;
     /** @format group-index */
     group?: number;
-    multiSigType?: MultiSigType;
+    multiSigType?: 'P2HMPK' | 'P2MPKH';
 }
 /** BuildTransferTx */
 export interface BuildTransferTx {
@@ -849,8 +849,6 @@ export interface MinerAddressesInfo {
 }
 /** MisbehaviorAction */
 export type MisbehaviorAction = Ban | Unban;
-/** MultiSigType */
-export type MultiSigType = P2HMPK | P2MPKH;
 /** MultipleCallContract */
 export interface MultipleCallContract {
     calls: CallContract[];
@@ -889,14 +887,6 @@ export interface OutputRef {
     /** @format 32-byte-hash */
     key: string;
 }
-/** P2HMPK */
-export interface P2HMPK {
-    type: string;
-}
-/** P2MPKH */
-export interface P2MPKH {
-    type: string;
-}
 /** PeerAddress */
 export interface PeerAddress {
     /** @format inet-address */
@@ -1431,7 +1421,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Alephium API
- * @version 3.15.1
+ * @version 3.15.2
  * @baseUrl ../
  */
 export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {

package/dist/src/api/api-alephium.js

@@ -151,7 +151,7 @@ class HttpClient {
 exports.HttpClient = HttpClient;
 /**
  * @title Alephium API
- * @version 3.15.1
+ * @version 3.15.2
  * @baseUrl ../
  */
 class Api extends HttpClient {

package/dist/src/contract/contract.js

@@ -694,8 +694,8 @@ class ContractFactory {
         const result = await signer.signAndSubmitDeployContractTx(signerParams);
         if ('transferTxs' in result) {
             return {
-                ...result.tx,
-                contractInstance: this.at(result.tx.contractAddress)
+                ...result,
+                contractInstance: this.at(result.contractAddress)
             };
         }
         else {
@@ -733,13 +733,7 @@ class ExecutableScript {
     }
     async execute(params) {
         const signerParams = await this.script.txParamsForExecution(params);
-        const result = await params.signer.signAndSubmitExecuteScriptTx(signerParams);
-        if ('transferTxs' in result) {
-            return result.tx;
-        }
-        else {
-            return result;
-        }
+        return await params.signer.signAndSubmitExecuteScriptTx(signerParams);
     }
     async call(params) {
         const mainFunc = this.script.functions.find((f) => f.name === 'main');

package/dist/src/signer/signer.js

@@ -48,6 +48,7 @@ const crypto_1 = require("crypto");
 const api_1 = require("../api");
 const utils = __importStar(require("../utils"));
 const blakejs_1 = __importDefault(require("blakejs"));
+const types_1 = require("./types");
 const tx_builder_1 = require("./tx-builder");
 const address_1 = require("../address");
 class SignerProvider {
@@ -59,7 +60,7 @@ class SignerProvider {
     static validateAccount(account) {
         const derivedAddress = (0, address_1.addressFromPublicKey)(account.publicKey, account.keyType);
         const derivedGroup = (0, address_1.groupOfAddress)(derivedAddress);
-        if (derivedAddress !== account.address || derivedGroup !== account.group) {
+        if (derivedAddress !== account.address || ((0, types_1.isGroupedAccount)(account) && derivedGroup !== account.group)) {
             throw Error(`Invalid accounot data: ${JSON.stringify(account)}`);
         }
     }
@@ -81,11 +82,11 @@ class SignerProviderSimple extends SignerProvider {
     }
     async signAndSubmitTransferTx(params) {
         const signResult = await this.signTransferTx(params);
-        if ('transferTxs' in signResult) {
-            for (const r of signResult.transferTxs) {
+        if ('fundingTxs' in signResult && signResult.fundingTxs !== undefined) {
+            for (const r of signResult.fundingTxs) {
                 await this.submitTransaction(r);
             }
-            await this.submitTransaction(signResult.tx);
+            await this.submitTransaction(signResult);
         }
         else {
             await this.submitTransaction(signResult);
@@ -94,11 +95,11 @@ class SignerProviderSimple extends SignerProvider {
     }
     async signAndSubmitDeployContractTx(params) {
         const signResult = await this.signDeployContractTx(params);
-        if ('transferTxs' in signResult) {
-            for (const r of signResult.transferTxs) {
+        if ('fundingTxs' in signResult && signResult.fundingTxs !== undefined) {
+            for (const r of signResult.fundingTxs) {
                 await this.submitTransaction(r);
             }
-            await this.submitTransaction(signResult.tx);
+            await this.submitTransaction(signResult);
         }
         else {
             await this.submitTransaction(signResult);
@@ -107,11 +108,11 @@ class SignerProviderSimple extends SignerProvider {
     }
     async signAndSubmitExecuteScriptTx(params) {
         const signResult = await this.signExecuteScriptTx(params);
-        if ('transferTxs' in signResult) {
-            for (const r of signResult.transferTxs) {
+        if ('fundingTxs' in signResult && signResult.fundingTxs !== undefined) {
+            for (const r of signResult.fundingTxs) {
                 await this.submitTransaction(r);
             }
-            await this.submitTransaction(signResult.tx);
+            await this.submitTransaction(signResult);
         }
         else {
             await this.submitTransaction(signResult);
@@ -132,19 +133,25 @@ class SignerProviderSimple extends SignerProvider {
     }
     async signTransferTx(params) {
         const response = await this.buildTransferTx(params);
-        if ('transferTxs' in response) {
+        if ('fundingTxs' in response && response.fundingTxs !== undefined) {
             const transferTxs = [];
-            for (let i = 0; i < response.transferTxs.length; i++) {
-                const txSignature = await this.signRaw(params.signerAddress, response.transferTxs[i].txId);
+            for (let i = 0; i < response.fundingTxs.length; i++) {
+                const txSignature = await this.signRaw(params.signerAddress, response.fundingTxs[i].txId);
                 transferTxs.push({
-                    ...response.transferTxs[i],
+                    ...response.fundingTxs[i],
                     signature: txSignature
                 });
             }
-            const signature = await this.signRaw(params.signerAddress, response.tx.txId);
+            const signature = await this.signRaw(params.signerAddress, response.txId);
             return {
-                transferTxs,
-                tx: { ...response.tx, signature }
+                fromGroup: response.fromGroup,
+                toGroup: response.toGroup,
+                gasAmount: response.gasAmount,
+                gasPrice: response.gasPrice,
+                txId: response.txId,
+                unsignedTx: response.unsignedTx,
+                signature,
+                fundingTxs: transferTxs
             };
         }
         else {
@@ -157,19 +164,26 @@ class SignerProviderSimple extends SignerProvider {
     }
     async signDeployContractTx(params) {
         const response = await this.buildDeployContractTx(params);
-        if ('transferTxs' in response) {
+        if ('fundingTxs' in response && response.fundingTxs !== undefined) {
             const transferTxs = [];
-            for (let i = 0; i < response.transferTxs.length; i++) {
-                const txSignature = await this.signRaw(params.signerAddress, response.transferTxs[i].txId);
+            for (let i = 0; i < response.fundingTxs.length; i++) {
+                const txSignature = await this.signRaw(params.signerAddress, response.fundingTxs[i].txId);
                 transferTxs.push({
-                    ...response.transferTxs[i],
+                    ...response.fundingTxs[i],
                     signature: txSignature
                 });
             }
-            const signature = await this.signRaw(params.signerAddress, response.tx.txId);
+            const signature = await this.signRaw(params.signerAddress, response.txId);
             return {
-                transferTxs,
-                tx: { ...response.tx, signature }
+                contractAddress: response.contractAddress,
+                contractId: response.contractId,
+                gasAmount: response.gasAmount,
+                gasPrice: response.gasPrice,
+                groupIndex: response.groupIndex,
+                unsignedTx: response.unsignedTx,
+                txId: response.txId,
+                signature,
+                fundingTxs: transferTxs
             };
         }
         else {
@@ -182,19 +196,25 @@ class SignerProviderSimple extends SignerProvider {
     }
     async signExecuteScriptTx(params) {
         const response = await this.buildExecuteScriptTx(params);
-        if ('transferTxs' in response) {
+        if ('fundingTxs' in response && response.fundingTxs !== undefined) {
             const transferTxs = [];
-            for (let i = 0; i < response.transferTxs.length; i++) {
-                const txSignature = await this.signRaw(params.signerAddress, response.transferTxs[i].txId);
+            for (let i = 0; i < response.fundingTxs.length; i++) {
+                const txSignature = await this.signRaw(params.signerAddress, response.fundingTxs[i].txId);
                 transferTxs.push({
-                    ...response.transferTxs[i],
+                    ...response.fundingTxs[i],
                     signature: txSignature
                 });
             }
-            const signature = await this.signRaw(params.signerAddress, response.tx.txId);
+            const signature = await this.signRaw(params.signerAddress, response.txId);
             return {
-                transferTxs,
-                tx: { ...response.tx, signature }
+                gasAmount: response.gasAmount,
+                gasPrice: response.gasPrice,
+                groupIndex: response.groupIndex,
+                unsignedTx: response.unsignedTx,
+                txId: response.txId,
+                simulationResult: response.simulationResult,
+                signature,
+                fundingTxs: transferTxs
             };
         }
         else {

package/dist/src/signer/tx-builder.js

@@ -161,16 +161,18 @@ class TransactionBuilder {
     }
     convertTransferTxResult(result) {
         // BuildGrouplessTransferTxResult
-        if ('transferTxs' in result) {
+        if ('fundingTxs' in result) {
             return {
-                transferTxs: result.transferTxs.map((r) => ({
+                unsignedTx: result.unsignedTx,
+                gasAmount: result.gasAmount,
+                gasPrice: (0, api_1.fromApiNumber256)(result.gasPrice),
+                txId: result.txId,
+                fromGroup: result.fromGroup,
+                toGroup: result.toGroup,
+                fundingTxs: result.fundingTxs?.map((r) => ({
                     ...r,
                     gasPrice: (0, api_1.fromApiNumber256)(r.gasPrice)
-                })),
-                tx: {
-                    ...result,
-                    gasPrice: (0, api_1.fromApiNumber256)(result.gasPrice)
-                }
+                }))
             };
         }
         return {
@@ -179,19 +181,20 @@ class TransactionBuilder {
         };
     }
     convertDeployContractTxResult(result) {
-        if ('transferTxs' in result) {
+        if ('fundingTxs' in result) {
             const contractId = (0, utils_1.binToHex)((0, address_1.contractIdFromAddress)(result.contractAddress));
             return {
-                transferTxs: result.transferTxs.map((r) => ({
+                groupIndex: result.fromGroup,
+                unsignedTx: result.unsignedTx,
+                gasAmount: result.gasAmount,
+                gasPrice: (0, api_1.fromApiNumber256)(result.gasPrice),
+                txId: result.txId,
+                contractAddress: result.contractAddress,
+                contractId,
+                fundingTxs: result.fundingTxs?.map((r) => ({
                     ...r,
                     gasPrice: (0, api_1.fromApiNumber256)(r.gasPrice)
-                })),
-                tx: {
-                    ...result,
-                    groupIndex: result.fromGroup,
-                    contractId,
-                    gasPrice: (0, api_1.fromApiNumber256)(result.gasPrice)
-                }
+                }))
             };
         }
         const contractId = (0, utils_1.binToHex)((0, address_1.contractIdFromAddress)(result.contractAddress));
@@ -203,17 +206,18 @@ class TransactionBuilder {
         };
     }
     convertExecuteScriptTxResult(result) {
-        if ('transferTxs' in result) {
+        if ('fundingTxs' in result) {
             return {
-                transferTxs: result.transferTxs.map((r) => ({
+                groupIndex: result.fromGroup,
+                unsignedTx: result.unsignedTx,
+                txId: result.txId,
+                gasAmount: result.gasAmount,
+                simulationResult: result.simulationResult,
+                gasPrice: (0, api_1.fromApiNumber256)(result.gasPrice),
+                fundingTxs: result.fundingTxs?.map((r) => ({
                     ...r,
                     gasPrice: (0, api_1.fromApiNumber256)(r.gasPrice)
-                })),
-                tx: {
-                    ...result,
-                    groupIndex: result.fromGroup,
-                    gasPrice: (0, api_1.fromApiNumber256)(result.gasPrice)
-                }
+                }))
             };
         }
         return {

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

@@ -11,13 +11,23 @@ export interface Destination {
     lockTime?: number;
     message?: string;
 }
-export type KeyType = 'default' | 'bip340-schnorr' | 'gl-secp256k1' | 'gl-secp256r1' | 'gl-ed25519' | 'gl-webauthn';
-export interface Account {
-    keyType: KeyType;
+export type GroupedKeyType = 'default' | 'bip340-schnorr';
+export type GrouplessKeyType = 'gl-secp256k1' | 'gl-secp256r1' | 'gl-ed25519' | 'gl-webauthn';
+export type KeyType = GroupedKeyType | GrouplessKeyType;
+export interface GroupedAccount {
+    keyType: GroupedKeyType;
     address: string;
     group: number;
     publicKey: string;
 }
+export interface GrouplessAccount {
+    keyType: GrouplessKeyType;
+    address: string;
+    publicKey: string;
+}
+export type Account = GroupedAccount | GrouplessAccount;
+export declare function isGroupedAccount(account: Account): account is GroupedAccount;
+export declare function isGrouplessAccount(account: Account): account is GrouplessAccount;
 export type SignerAddress = {
     signerAddress: string;
     signerKeyType?: KeyType;
@@ -82,16 +92,14 @@ export interface SignExecuteScriptTxResult {
     gasPrice: Number256;
     simulationResult: SimulationResult;
 }
-export interface GrouplessBuildTxResult<T extends SignExecuteScriptTxResult | SignDeployContractTxResult | SignTransferTxResult> {
-    transferTxs: Omit<SignTransferTxResult, 'signature'>[];
-    tx: Omit<T, 'signature'>;
-}
+export type GrouplessBuildTxResult<T extends SignExecuteScriptTxResult | SignDeployContractTxResult | SignTransferTxResult> = {
+    fundingTxs?: Omit<SignTransferTxResult, 'signature'>[];
+} & Omit<T, 'signature'>;
 export type BuildTxResult<T extends SignExecuteScriptTxResult | SignDeployContractTxResult | SignTransferTxResult> = GrouplessBuildTxResult<T> | Omit<T, 'signature'>;
-export interface GrouplessSignTxResult<T extends SignExecuteScriptTxResult | SignDeployContractTxResult | SignTransferTxResult> {
-    transferTxs: SignTransferTxResult[];
-    tx: T;
-}
-export type SignTxResult<T extends SignExecuteScriptTxResult | SignDeployContractTxResult | SignTransferTxResult> = GrouplessSignTxResult<T> | T;
+export type GrouplessSignTxResult<T extends SignExecuteScriptTxResult | SignDeployContractTxResult | SignTransferTxResult> = {
+    fundingTxs?: SignTransferTxResult[];
+} & T;
+export type SignTxResult<T extends SignExecuteScriptTxResult | SignDeployContractTxResult | SignTransferTxResult> = T | GrouplessSignTxResult<T>;
 export interface SignUnsignedTxParams {
     signerAddress: string;
     signerKeyType?: KeyType;

package/dist/src/signer/types.js

@@ -17,8 +17,17 @@ 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.isGrouplessAccount = exports.isGroupedAccount = void 0;
 const utils_1 = require("../utils");
 utils_1.assertType;
+function isGroupedAccount(account) {
+    return account.keyType === 'default' || account.keyType === 'bip340-schnorr';
+}
+exports.isGroupedAccount = isGroupedAccount;
+function isGrouplessAccount(account) {
+    return account.keyType !== 'default' && account.keyType !== 'bip340-schnorr';
+}
+exports.isGrouplessAccount = isGrouplessAccount;
 (0, utils_1.assertType)();
 (0, utils_1.assertType)();
 (0, utils_1.assertType)();

package/dist/src/utils/sign.js

@@ -57,9 +57,15 @@ necc.utils.hmacSha256Sync = (key, ...messages) => {
     messages.forEach((m) => hash.update(m));
     return Uint8Array.from(hash.digest());
 };
+function checkKeyType(keyType) {
+    if (keyType !== 'default' && keyType !== 'bip340-schnorr' && keyType !== 'gl-secp256k1') {
+        throw new Error(`Invalid key type ${keyType}`);
+    }
+}
 // hash has to be 32 bytes
 function sign(hash, privateKey, _keyType) {
     const keyType = _keyType ?? 'default';
+    checkKeyType(keyType);
     if (keyType === 'default' || keyType === 'gl-secp256k1') {
         const key = ec.keyFromPrivate(privateKey);
         const signature = key.sign(hash);
@@ -73,6 +79,7 @@ function sign(hash, privateKey, _keyType) {
 exports.sign = sign;
 function verifySignature(hash, publicKey, signature, _keyType) {
     const keyType = _keyType ?? 'default';
+    checkKeyType(keyType);
     try {
         if (keyType === 'default' || keyType === 'gl-secp256k1') {
             const key = ec.keyFromPublic(publicKey, 'hex');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alephium/web3",
-  "version": "2.0.0-rc.0",
+  "version": "2.0.0-rc.2",
   "description": "A JS/TS library to interact with the Alephium platform",
   "license": "GPL",
   "main": "dist/src/index.js",
@@ -33,7 +33,7 @@
   },
   "author": "Alephium dev <dev@alephium.org>",
   "config": {
-    "alephium_version": "3.15.1",
+    "alephium_version": "3.15.2",
     "explorer_backend_version": "2.3.2"
   },
   "type": "commonjs",

package/src/api/api-alephium.ts

@@ -312,7 +312,7 @@ export interface BuildGrouplessDeployContractTxResult {
   txId: string
   /** @format address */
   contractAddress: string
-  transferTxs: BuildSimpleTransferTxResult[]
+  fundingTxs?: BuildSimpleTransferTxResult[]
 }
 
 /** BuildGrouplessExecuteScriptTxResult */
@@ -329,7 +329,7 @@ export interface BuildGrouplessExecuteScriptTxResult {
   /** @format 32-byte-hash */
   txId: string
   simulationResult: SimulationResult
-  transferTxs: BuildSimpleTransferTxResult[]
+  fundingTxs?: BuildSimpleTransferTxResult[]
 }
 
 /** BuildGrouplessTransferTxResult */
@@ -345,7 +345,7 @@ export interface BuildGrouplessTransferTxResult {
   fromGroup: number
   /** @format int32 */
   toGroup: number
-  transferTxs: BuildSimpleTransferTxResult[]
+  fundingTxs?: BuildSimpleTransferTxResult[]
 }
 
 /** BuildInfo */
@@ -377,7 +377,7 @@ export interface BuildMultisig {
   gasPrice?: string
   /** @format group-index */
   group?: number
-  multiSigType?: MultiSigType
+  multiSigType?: 'P2HMPK' | 'P2MPKH'
 }
 
 /** BuildMultisigAddress */
@@ -386,7 +386,7 @@ export interface BuildMultisigAddress {
   keyTypes?: string[]
   /** @format int32 */
   mrequired: number
-  multiSigType?: MultiSigType
+  multiSigType?: 'P2HMPK' | 'P2MPKH'
 }
 
 /** BuildMultisigAddressResult */
@@ -499,7 +499,7 @@ export interface BuildSweepMultisig {
   targetBlockHash?: string
   /** @format group-index */
   group?: number
-  multiSigType?: MultiSigType
+  multiSigType?: 'P2HMPK' | 'P2MPKH'
 }
 
 /** BuildTransferTx */
@@ -958,9 +958,6 @@ export interface MinerAddressesInfo {
 /** MisbehaviorAction */
 export type MisbehaviorAction = Ban | Unban
 
-/** MultiSigType */
-export type MultiSigType = P2HMPK | P2MPKH
-
 /** MultipleCallContract */
 export interface MultipleCallContract {
   calls: CallContract[]
@@ -1006,16 +1003,6 @@ export interface OutputRef {
   key: string
 }
 
-/** P2HMPK */
-export interface P2HMPK {
-  type: string
-}
-
-/** P2MPKH */
-export interface P2MPKH {
-  type: string
-}
-
 /** PeerAddress */
 export interface PeerAddress {
   /** @format inet-address */
@@ -1767,7 +1754,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title Alephium API
- * @version 3.15.1
+ * @version 3.15.2
  * @baseUrl ../
  */
 export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {

package/src/contract/contract.ts

@@ -1111,8 +1111,8 @@ export abstract class ContractFactory<I extends ContractInstance, F extends Fiel
     const result = await signer.signAndSubmitDeployContractTx(signerParams)
     if ('transferTxs' in result) {
       return {
-        ...result.tx,
-        contractInstance: this.at(result.tx.contractAddress)
+        ...result,
+        contractInstance: this.at(result.contractAddress)
       }
     } else {
       return {
@@ -1160,13 +1160,7 @@ export class ExecutableScript<P extends Fields = Fields, R extends Val | null =
 
   async execute(params: ExecuteScriptParams<P>): Promise<ExecuteScriptResult> {
     const signerParams = await this.script.txParamsForExecution(params)
-    const result = await params.signer.signAndSubmitExecuteScriptTx(signerParams)
-
-    if ('transferTxs' in result) {
-      return result.tx
-    } else {
-      return result
-    }
+    return await params.signer.signAndSubmitExecuteScriptTx(signerParams)
   }
 
   async call(params: CallScriptParams<P>): Promise<CallScriptResult<R>> {