@alephium/web3 0.26.0 → 0.27.0

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

@@ -1,7 +1,11 @@
 import { Transaction } from '../api/api-alephium';
 import { Address } from '../signer';
 export declare function validateExchangeAddress(address: string): void;
-export declare function isDepositALPHTransaction(tx: Transaction, exchangeAddress: string): boolean;
-export declare function isDepositTokenTransaction(tx: Transaction, exchangeAddress: string): boolean;
-export declare function getDepositAddress(tx: Transaction): Address;
+export declare function isSimpleALPHTransferTx(tx: Transaction): boolean;
+export declare function isSimpleTransferTokenTx(tx: Transaction): boolean;
+export declare function getALPHDepositInfo(tx: Transaction): {
+    targetAddress: Address;
+    depositAmount: bigint;
+};
+export declare function getSenderAddress(tx: Transaction): Address;
 export declare function getAddressFromUnlockScript(unlockScript: string): Address;

package/dist/src/utils/exchange.js

@@ -17,7 +17,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/>.
 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAddressFromUnlockScript = exports.getDepositAddress = exports.isDepositTokenTransaction = exports.isDepositALPHTransaction = exports.validateExchangeAddress = void 0;
+exports.getAddressFromUnlockScript = exports.getSenderAddress = exports.getALPHDepositInfo = exports.isSimpleTransferTokenTx = exports.isSimpleALPHTransferTx = exports.validateExchangeAddress = void 0;
 const __1 = require("..");
 function validateExchangeAddress(address) {
     let decoded;
@@ -38,19 +38,38 @@ function validateExchangeAddress(address) {
     }
 }
 exports.validateExchangeAddress = validateExchangeAddress;
-function isDepositALPHTransaction(tx, exchangeAddress) {
-    return isDepositTransaction(tx, exchangeAddress) && checkALPHOutput(tx);
+function isSimpleALPHTransferTx(tx) {
+    return isSimpleTransferTx(tx) && checkALPHOutput(tx);
 }
-exports.isDepositALPHTransaction = isDepositALPHTransaction;
-function isDepositTokenTransaction(tx, exchangeAddress) {
-    return isDepositTransaction(tx, exchangeAddress) && checkTokenOutput(tx, exchangeAddress);
+exports.isSimpleALPHTransferTx = isSimpleALPHTransferTx;
+function isSimpleTransferTokenTx(tx) {
+    const isTransferTx = isSimpleTransferTx(tx);
+    if (isTransferTx) {
+        const senderAddress = getSenderAddress(tx);
+        const targetAddress = tx.unsigned.fixedOutputs.find((o) => o.address !== senderAddress).address;
+        return checkTokenOutput(tx, targetAddress);
+    }
+    return false;
+}
+exports.isSimpleTransferTokenTx = isSimpleTransferTokenTx;
+// we assume that the tx is a simple transfer tx, i.e. isSimpleTransferALPHTx(tx) == true
+function getALPHDepositInfo(tx) {
+    const senderAddress = getSenderAddress(tx);
+    const targetAddress = tx.unsigned.fixedOutputs.find((o) => o.address !== senderAddress).address;
+    let depositAmount = 0n;
+    tx.unsigned.fixedOutputs.forEach((o) => {
+        if (o.address === targetAddress) {
+            depositAmount += BigInt(o.attoAlphAmount);
+        }
+    });
+    return { targetAddress, depositAmount };
 }
-exports.isDepositTokenTransaction = isDepositTokenTransaction;
-// we assume that the tx is deposit transaction
-function getDepositAddress(tx) {
+exports.getALPHDepositInfo = getALPHDepositInfo;
+// we assume that the tx is a simple transfer tx, i.e. isSimpleTransferALPHTx(tx) == true
+function getSenderAddress(tx) {
     return getAddressFromUnlockScript(tx.unsigned.inputs[0].unlockScript);
 }
-exports.getDepositAddress = getDepositAddress;
+exports.getSenderAddress = getSenderAddress;
 var UnlockScriptType;
 (function (UnlockScriptType) {
     UnlockScriptType[UnlockScriptType["P2PKH"] = 0] = "P2PKH";
@@ -81,50 +100,47 @@ function getAddressFromUnlockScript(unlockScript) {
     }
 }
 exports.getAddressFromUnlockScript = getAddressFromUnlockScript;
-function getFromAddress(tx) {
+function getSenderAddressAnyTx(tx) {
     try {
         const inputAddresses = tx.unsigned.inputs.map((i) => getAddressFromUnlockScript(i.unlockScript));
         // we have checked that the inputs is not empty
-        const from = inputAddresses[0];
-        return inputAddresses.slice(1).every((addr) => addr === from) ? from : undefined;
+        const sender = inputAddresses[0];
+        return inputAddresses.slice(1).every((addr) => addr === sender) ? sender : undefined;
     }
     catch (_) {
         return undefined;
     }
 }
-function checkOutputAddress(tx, from, to) {
-    let fromCount = 0;
-    let toCount = 0;
-    tx.unsigned.fixedOutputs.forEach((o) => {
-        if (o.address === from) {
-            fromCount += 1;
-        }
-        else if (o.address === to) {
-            toCount += 1;
-        }
-    });
-    const outputCount = tx.unsigned.fixedOutputs.length;
-    return toCount === 1 && fromCount === outputCount - 1;
-}
 function checkALPHOutput(tx) {
     const outputs = tx.unsigned.fixedOutputs;
     return outputs.every((o) => o.tokens.length === 0);
 }
 function checkTokenOutput(tx, to) {
     // we have checked the output address
-    const output = tx.unsigned.fixedOutputs.find((o) => o.address === to);
-    return output.attoAlphAmount === __1.DUST_AMOUNT.toString() && output.tokens.length === 1;
+    const outputs = tx.unsigned.fixedOutputs.filter((o) => o.address === to);
+    if (outputs[0].tokens.length === 0) {
+        return false;
+    }
+    const tokenId = outputs[0].tokens[0].id;
+    return outputs.every((o) => BigInt(o.attoAlphAmount) === __1.DUST_AMOUNT && o.tokens.length === 1 && o.tokens[0].id === tokenId);
 }
-function isDepositTransaction(tx, exchangeAddress) {
+function isSimpleTransferTx(tx) {
     if (tx.contractInputs.length !== 0 ||
         tx.generatedOutputs.length !== 0 ||
         tx.unsigned.inputs.length === 0 ||
         tx.unsigned.scriptOpt !== undefined) {
         return false;
     }
-    const from = getFromAddress(tx);
-    if (from === undefined || from === exchangeAddress) {
+    const sender = getSenderAddressAnyTx(tx);
+    if (sender === undefined) {
         return false;
     }
-    return checkOutputAddress(tx, from, exchangeAddress);
+    const outputAddresses = [];
+    tx.unsigned.fixedOutputs.forEach((o) => {
+        if (!outputAddresses.includes(o.address)) {
+            outputAddresses.push(o.address);
+        }
+    });
+    return ((outputAddresses.length === 1 && outputAddresses[0] !== sender) ||
+        (outputAddresses.length === 2 && outputAddresses.includes(sender)));
 }

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

@@ -6,4 +6,4 @@ export * from './utils';
 export * from './subscription';
 export * from './sign';
 export * from './number';
-export { validateExchangeAddress, isDepositALPHTransaction, isDepositTokenTransaction, getDepositAddress } from './exchange';
+export { validateExchangeAddress, isSimpleALPHTransferTx, isSimpleTransferTokenTx, getSenderAddress, getALPHDepositInfo } from './exchange';

package/dist/src/utils/index.js

@@ -31,7 +31,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDepositAddress = exports.isDepositTokenTransaction = exports.isDepositALPHTransaction = exports.validateExchangeAddress = void 0;
+exports.getALPHDepositInfo = exports.getSenderAddress = exports.isSimpleTransferTokenTx = exports.isSimpleALPHTransferTx = exports.validateExchangeAddress = void 0;
 __exportStar(require("./webcrypto"), exports);
 __exportStar(require("./address"), exports);
 __exportStar(require("./bs58"), exports);
@@ -42,6 +42,7 @@ __exportStar(require("./sign"), exports);
 __exportStar(require("./number"), exports);
 var exchange_1 = require("./exchange");
 Object.defineProperty(exports, "validateExchangeAddress", { enumerable: true, get: function () { return exchange_1.validateExchangeAddress; } });
-Object.defineProperty(exports, "isDepositALPHTransaction", { enumerable: true, get: function () { return exchange_1.isDepositALPHTransaction; } });
-Object.defineProperty(exports, "isDepositTokenTransaction", { enumerable: true, get: function () { return exchange_1.isDepositTokenTransaction; } });
-Object.defineProperty(exports, "getDepositAddress", { enumerable: true, get: function () { return exchange_1.getDepositAddress; } });
+Object.defineProperty(exports, "isSimpleALPHTransferTx", { enumerable: true, get: function () { return exchange_1.isSimpleALPHTransferTx; } });
+Object.defineProperty(exports, "isSimpleTransferTokenTx", { enumerable: true, get: function () { return exchange_1.isSimpleTransferTokenTx; } });
+Object.defineProperty(exports, "getSenderAddress", { enumerable: true, get: function () { return exchange_1.getSenderAddress; } });
+Object.defineProperty(exports, "getALPHDepositInfo", { enumerable: true, get: function () { return exchange_1.getALPHDepositInfo; } });

package/package.json

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

package/src/utils/exchange.ts

@@ -37,16 +37,35 @@ export function validateExchangeAddress(address: string) {
   }
 }
 
-export function isDepositALPHTransaction(tx: Transaction, exchangeAddress: string): boolean {
-  return isDepositTransaction(tx, exchangeAddress) && checkALPHOutput(tx)
+export function isSimpleALPHTransferTx(tx: Transaction): boolean {
+  return isSimpleTransferTx(tx) && checkALPHOutput(tx)
 }
 
-export function isDepositTokenTransaction(tx: Transaction, exchangeAddress: string): boolean {
-  return isDepositTransaction(tx, exchangeAddress) && checkTokenOutput(tx, exchangeAddress)
+export function isSimpleTransferTokenTx(tx: Transaction): boolean {
+  const isTransferTx = isSimpleTransferTx(tx)
+  if (isTransferTx) {
+    const senderAddress = getSenderAddress(tx)
+    const targetAddress = tx.unsigned.fixedOutputs.find((o) => o.address !== senderAddress)!.address
+    return checkTokenOutput(tx, targetAddress)
+  }
+  return false
+}
+
+// we assume that the tx is a simple transfer tx, i.e. isSimpleTransferALPHTx(tx) == true
+export function getALPHDepositInfo(tx: Transaction): { targetAddress: Address; depositAmount: bigint } {
+  const senderAddress = getSenderAddress(tx)
+  const targetAddress = tx.unsigned.fixedOutputs.find((o) => o.address !== senderAddress)!.address
+  let depositAmount = 0n
+  tx.unsigned.fixedOutputs.forEach((o) => {
+    if (o.address === targetAddress) {
+      depositAmount += BigInt(o.attoAlphAmount)
+    }
+  })
+  return { targetAddress, depositAmount }
 }
 
-// we assume that the tx is deposit transaction
-export function getDepositAddress(tx: Transaction): Address {
+// we assume that the tx is a simple transfer tx, i.e. isSimpleTransferALPHTx(tx) == true
+export function getSenderAddress(tx: Transaction): Address {
   return getAddressFromUnlockScript(tx.unsigned.inputs[0].unlockScript)
 }
 
@@ -77,31 +96,17 @@ export function getAddressFromUnlockScript(unlockScript: string): Address {
   }
 }
 
-function getFromAddress(tx: Transaction): Address | undefined {
+function getSenderAddressAnyTx(tx: Transaction): Address | undefined {
   try {
     const inputAddresses = tx.unsigned.inputs.map((i) => getAddressFromUnlockScript(i.unlockScript))
     // we have checked that the inputs is not empty
-    const from = inputAddresses[0]
-    return inputAddresses.slice(1).every((addr) => addr === from) ? from : undefined
+    const sender = inputAddresses[0]
+    return inputAddresses.slice(1).every((addr) => addr === sender) ? sender : undefined
   } catch (_) {
     return undefined
   }
 }
 
-function checkOutputAddress(tx: Transaction, from: Address, to: Address): boolean {
-  let fromCount = 0
-  let toCount = 0
-  tx.unsigned.fixedOutputs.forEach((o) => {
-    if (o.address === from) {
-      fromCount += 1
-    } else if (o.address === to) {
-      toCount += 1
-    }
-  })
-  const outputCount = tx.unsigned.fixedOutputs.length
-  return toCount === 1 && fromCount === outputCount - 1
-}
-
 function checkALPHOutput(tx: Transaction): boolean {
   const outputs = tx.unsigned.fixedOutputs
   return outputs.every((o) => o.tokens.length === 0)
@@ -109,11 +114,17 @@ function checkALPHOutput(tx: Transaction): boolean {
 
 function checkTokenOutput(tx: Transaction, to: Address): boolean {
   // we have checked the output address
-  const output = tx.unsigned.fixedOutputs.find((o) => o.address === to)!
-  return output.attoAlphAmount === DUST_AMOUNT.toString() && output.tokens.length === 1
+  const outputs = tx.unsigned.fixedOutputs.filter((o) => o.address === to)
+  if (outputs[0].tokens.length === 0) {
+    return false
+  }
+  const tokenId = outputs[0].tokens[0].id
+  return outputs.every(
+    (o) => BigInt(o.attoAlphAmount) === DUST_AMOUNT && o.tokens.length === 1 && o.tokens[0].id === tokenId
+  )
 }
 
-function isDepositTransaction(tx: Transaction, exchangeAddress: string): boolean {
+function isSimpleTransferTx(tx: Transaction): boolean {
   if (
     tx.contractInputs.length !== 0 ||
     tx.generatedOutputs.length !== 0 ||
@@ -122,9 +133,18 @@ function isDepositTransaction(tx: Transaction, exchangeAddress: string): boolean
   ) {
     return false
   }
-  const from = getFromAddress(tx)
-  if (from === undefined || from === exchangeAddress) {
+  const sender = getSenderAddressAnyTx(tx)
+  if (sender === undefined) {
     return false
   }
-  return checkOutputAddress(tx, from, exchangeAddress)
+  const outputAddresses: Address[] = []
+  tx.unsigned.fixedOutputs.forEach((o) => {
+    if (!outputAddresses.includes(o.address)) {
+      outputAddresses.push(o.address)
+    }
+  })
+  return (
+    (outputAddresses.length === 1 && outputAddresses[0] !== sender) ||
+    (outputAddresses.length === 2 && outputAddresses.includes(sender))
+  )
 }

package/src/utils/index.ts

@@ -26,7 +26,8 @@ export * from './sign'
 export * from './number'
 export {
   validateExchangeAddress,
-  isDepositALPHTransaction,
-  isDepositTokenTransaction,
-  getDepositAddress
+  isSimpleALPHTransferTx,
+  isSimpleTransferTokenTx,
+  getSenderAddress,
+  getALPHDepositInfo
 } from './exchange'