feat!: reduce msig and lsig exports (#492)

* feat!: reduce msig and lsig exports

* chore: fix typo appply -> apply

Author: joe-p

packages/transact/src/logicsig.spec.ts

@@ -1,11 +1,11 @@
 import { encodeMsgpack } from '@algorandfoundation/algokit-common'
 import { describe, expect, test } from 'vitest'
-import { decodeLogicSignature } from './logicsig'
+import { LogicSigAccount } from './logicsig'
 import { LogicSignature } from './transactions/signed-transaction'
 import { logicSignatureCodec } from './transactions/signed-transaction-meta'
 
 describe('logicsig', () => {
-  describe('decodeLogicSignature', () => {
+  describe('LogicSigAccount.fromBytes', () => {
     test('should decode logic signature with signature', () => {
       const signature = new Uint8Array(64).fill(42)
       const logicSignature = {
@@ -15,7 +15,7 @@ describe('logicsig', () => {
       } satisfies LogicSignature
       const encoded = encodeMsgpack(logicSignatureCodec.encode(logicSignature, 'msgpack'))
 
-      const decoded = decodeLogicSignature(encoded)
+      const decoded = LogicSigAccount.fromBytes(encoded)
 
       expect(decoded.logic).toEqual(logicSignature.logic)
       expect(decoded.sig).toEqual(signature)

packages/transact/src/logicsig.ts

@@ -1,38 +1,9 @@
-import { Address, concatArrays, decodeMsgpack, hash, isValidAddress } from '@algorandfoundation/algokit-common'
+import { Address, concatArrays, decodeMsgpack, hash } from '@algorandfoundation/algokit-common'
 import { MultisigAccount } from './multisig'
 import { TransactionSigner } from './signer'
 import { LogicSignature, MultisigSignature, SignedTransaction, encodeSignedTransaction } from './transactions/signed-transaction'
-import { logicSignatureCodec } from './transactions/signed-transaction-meta'
 import { Transaction } from './transactions/transaction'
-
-// base64regex is the regex to test for base64 strings
-const base64regex = /^([0-9a-zA-Z+/]{4})*(([0-9a-zA-Z+/]{2}==)|([0-9a-zA-Z+/]{3}=))?$/
-
-/** sanityCheckProgram performs heuristic program validation:
- * check if passed in bytes are Algorand address or is B64 encoded, rather than Teal bytes
- *
- * @param program - Program bytes to check
- */
-export function sanityCheckProgram(program: Uint8Array) {
-  if (!program || program.length === 0) throw new Error('empty program')
-
-  const lineBreakOrd = '\n'.charCodeAt(0)
-  const blankSpaceOrd = ' '.charCodeAt(0)
-  const tildeOrd = '~'.charCodeAt(0)
-
-  const isPrintable = (x: number) => blankSpaceOrd <= x && x <= tildeOrd
-  const isAsciiPrintable = program.every((x: number) => x === lineBreakOrd || isPrintable(x))
-
-  if (isAsciiPrintable) {
-    const programStr = new TextDecoder().decode(program)
-
-    if (isValidAddress(programStr)) throw new Error('requesting program bytes, get Algorand address')
-
-    if (base64regex.test(programStr)) throw new Error('program should not be b64 encoded')
-
-    throw new Error('program bytes are all ASCII printable characters, not looking like Teal byte code')
-  }
-}
+import { logicSignatureCodec } from './transactions/signed-transaction-meta'
 
 const PROGRAM_TAG = new TextEncoder().encode('Program')
 const MSIG_PROGRAM_TAG = new TextEncoder().encode('MsigProgram')
@@ -51,6 +22,20 @@ export class LogicSigAccount {
   msig?: MultisigSignature
   lmsig?: MultisigSignature
 
+  static fromSignature(signature: LogicSignature): LogicSigAccount {
+    const lsigAccount = new LogicSigAccount(signature.logic, signature.args || [])
+    lsigAccount.sig = signature.sig
+    lsigAccount.msig = signature.msig
+    lsigAccount.lmsig = signature.lmsig
+    return lsigAccount
+  }
+
+  static fromBytes(encodedLsig: Uint8Array): LogicSigAccount {
+    const decoded = decodeMsgpack(encodedLsig)
+    const lsigSignature = logicSignatureCodec.decode(decoded, 'msgpack')
+    return LogicSigAccount.fromSignature(lsigSignature)
+  }
+
   constructor(program: Uint8Array, programArgs?: Array<Uint8Array> | null) {
     if (programArgs && (!Array.isArray(programArgs) || !programArgs.every((arg) => arg.constructor === Uint8Array))) {
       throw new TypeError('Invalid arguments')
@@ -59,8 +44,6 @@ export class LogicSigAccount {
     let args: Uint8Array[] = []
     if (programArgs != null) args = programArgs.map((arg) => new Uint8Array(arg))
 
-    sanityCheckProgram(program)
-
     this.logic = program
     this.args = args
   }
@@ -133,14 +116,3 @@ export class LogicSigAccount {
     return concatArrays(SIGN_PROGRAM_DATA_PREFIX, this.address().publicKey, data)
   }
 }
-
-/**
- * Decodes MsgPack bytes into a logic signature.
- *
- * @param encodedLogicSignature - The MsgPack encoded logic signature
- * @returns The decoded LogicSignature or an error if decoding fails.
- */
-export function decodeLogicSignature(encodedLogicSignature: Uint8Array): LogicSignature {
-  const decodedData = decodeMsgpack(encodedLogicSignature)
-  return logicSignatureCodec.decode(decodedData, 'msgpack')
-}