chore: rename LogicSignature to LogicSigSignature

Author: neilcampbell

packages/transact/src/index.ts

@@ -20,7 +20,7 @@ export {
   encodeSignedTransaction,
   encodeSignedTransactions,
   validateSignedTransaction,
-  type LogicSignature,
+  type LogicSigSignature,
   type MultisigSignature,
   type MultisigSubsignature,
   type SignedTransaction,

packages/transact/src/logicsig.spec.ts

@@ -1,8 +1,8 @@
 import { Address, encodeMsgpack } from '@algorandfoundation/algokit-common'
 import { describe, expect, test } from 'vitest'
 import { LogicSigAccount } from './logicsig'
-import { LogicSignature } from './transactions/signed-transaction'
-import { logicSignatureCodec } from './transactions/signed-transaction-meta'
+import { LogicSigSignature } from './transactions/signed-transaction'
+import { logicSigSignatureCodec } from './transactions/signed-transaction-meta'
 
 describe('logicsig', () => {
   describe('LogicSigAccount.fromBytes', () => {
@@ -12,8 +12,8 @@ describe('logicsig', () => {
         logic: new Uint8Array([1, 32, 1, 1, 34]),
         args: [new Uint8Array([1, 2, 3]), new Uint8Array([4, 5, 6])],
         sig: signature,
-      } satisfies LogicSignature
-      const encoded = encodeMsgpack(logicSignatureCodec.encode(logicSignature, 'msgpack'))
+      } satisfies LogicSigSignature
+      const encoded = encodeMsgpack(logicSigSignatureCodec.encode(logicSignature, 'msgpack'))
 
       const decoded = LogicSigAccount.fromBytes(encoded, Address.zeroAddress())
 

packages/transact/src/logicsig.ts

@@ -1,9 +1,9 @@
 import { Address, Addressable, concatArrays, decodeMsgpack, hash } from '@algorandfoundation/algokit-common'
 import { MultisigAccount } from './multisig'
 import { AddressWithDelegatedLsigSigner, TransactionSigner } from './signer'
-import { LogicSignature, MultisigSignature, SignedTransaction, encodeSignedTransaction } from './transactions/signed-transaction'
+import { LogicSigSignature, MultisigSignature, SignedTransaction, encodeSignedTransaction } from './transactions/signed-transaction'
+import { logicSigSignatureCodec } from './transactions/signed-transaction-meta'
 import { Transaction } from './transactions/transaction'
-import { logicSignatureCodec } from './transactions/signed-transaction-meta'
 
 const PROGRAM_TAG = new TextEncoder().encode('Program')
 const MSIG_PROGRAM_TAG = new TextEncoder().encode('MsigProgram')
@@ -35,13 +35,13 @@ export class LogicSig implements Addressable {
     this._addr = new Address(h)
   }
 
-  static fromSignature(signature: LogicSignature): LogicSig {
+  static fromSignature(signature: LogicSigSignature): LogicSig {
     return new LogicSig(signature.logic, signature.args || [])
   }
 
   static fromBytes(encodedLsig: Uint8Array): LogicSig {
     const decoded = decodeMsgpack(encodedLsig)
-    const lsigSignature = logicSignatureCodec.decode(decoded, 'msgpack')
+    const lsigSignature = logicSigSignatureCodec.decode(decoded, 'msgpack')
     return LogicSig.fromSignature(lsigSignature)
   }
 
@@ -83,7 +83,7 @@ export class LogicSigAccount extends LogicSig {
   msig?: MultisigSignature
   lmsig?: MultisigSignature
 
-  static fromSignature(signature: LogicSignature, delegator?: Address): LogicSigAccount {
+  static fromSignature(signature: LogicSigSignature, delegator?: Address): LogicSigAccount {
     if (signature.lmsig || signature.msig) {
       const msigAddr = MultisigAccount.fromSignature((signature.lmsig || signature.msig)!).addr
 
@@ -113,7 +113,7 @@ export class LogicSigAccount extends LogicSig {
 
   static fromBytes(encodedLsig: Uint8Array, delegator?: Address): LogicSigAccount {
     const decoded = decodeMsgpack(encodedLsig)
-    const lsigSignature = logicSignatureCodec.decode(decoded, 'msgpack')
+    const lsigSignature = logicSigSignatureCodec.decode(decoded, 'msgpack')
     return LogicSigAccount.fromSignature(lsigSignature, delegator)
   }
 

packages/transact/src/multisig.spec.ts

@@ -2,7 +2,7 @@ import { Address, decodeMsgpack, encodeMsgpack } from '@algorandfoundation/algok
 import { describe, expect, test } from 'vitest'
 import { MultisigAccount } from './multisig'
 import { MultisigSignature } from './transactions/signed-transaction'
-import { multiSignatureCodec } from './transactions/signed-transaction-meta'
+import { multisigSignatureCodec } from './transactions/signed-transaction-meta'
 
 describe('multisig', () => {
   describe('MultisigAccount.createMultisigSignature', () => {
@@ -202,10 +202,10 @@ describe('multisig', () => {
       const emptyMultisignature = msigAccount.createMultisigSignature()
       const signature = new Uint8Array(64).fill(42)
       const signedMultiSig = msigAccount.applySignature(emptyMultisignature, addrs[0].publicKey, signature)
-      const encoded = encodeMsgpack(multiSignatureCodec.encode(signedMultiSig, 'msgpack'))
+      const encoded = encodeMsgpack(multisigSignatureCodec.encode(signedMultiSig, 'msgpack'))
 
       const decodedData = decodeMsgpack(encoded)
-      const decoded: MultisigSignature = multiSignatureCodec.decode(decodedData, 'msgpack')
+      const decoded: MultisigSignature = multisigSignatureCodec.decode(decodedData, 'msgpack')
 
       expect(decoded.version).toBe(emptyMultisignature.version)
       expect(decoded.threshold).toBe(emptyMultisignature.threshold)

packages/transact/src/transactions/signed-transaction-meta.ts

@@ -9,7 +9,7 @@ import {
   fixedBytes64Codec,
   numberCodec,
 } from '@algorandfoundation/algokit-common'
-import { LogicSignature, MultisigSignature, MultisigSubsignature, SignedTransaction } from './signed-transaction'
+import { LogicSigSignature, MultisigSignature, MultisigSubsignature, SignedTransaction } from './signed-transaction'
 import { transactionCodec } from './transaction'
 
 const MultisigSubsignatureMeta: ObjectModelMetadata<MultisigSubsignature> = {
@@ -36,7 +36,7 @@ const MultisigSignatureMeta: ObjectModelMetadata<MultisigSignature> = {
   ],
 }
 
-const LogicSignatureMeta: ObjectModelMetadata<LogicSignature> = {
+const LogicSigSignatureMeta: ObjectModelMetadata<LogicSigSignature> = {
   name: 'LogicSignature',
   kind: 'object',
   fields: [
@@ -58,8 +58,8 @@ const LogicSignatureMeta: ObjectModelMetadata<LogicSignature> = {
   ],
 }
 
-export const multiSignatureCodec = new ObjectModelCodec<MultisigSignature>(MultisigSignatureMeta)
-export const logicSignatureCodec = new ObjectModelCodec<LogicSignature>(LogicSignatureMeta)
+export const multisigSignatureCodec = new ObjectModelCodec<MultisigSignature>(MultisigSignatureMeta)
+export const logicSigSignatureCodec = new ObjectModelCodec<LogicSigSignature>(LogicSigSignatureMeta)
 
 /**
  * Metadata for SignedTransaction
@@ -79,13 +79,13 @@ export const SignedTransactionMeta: ObjectModelMetadata<SignedTransaction> = {
       name: 'msig',
       wireKey: 'msig',
       optional: true,
-      codec: multiSignatureCodec,
+      codec: multisigSignatureCodec,
     },
     {
       name: 'lsig',
       wireKey: 'lsig',
       optional: true,
-      codec: logicSignatureCodec,
+      codec: logicSigSignatureCodec,
     },
     { name: 'authAddress', wireKey: 'sgnr', optional: true, codec: addressCodec },
   ],

packages/transact/src/transactions/signed-transaction.ts

@@ -25,7 +25,7 @@ export type SignedTransaction = {
   /**
    * Optional logic signature for the transaction.
    */
-  lsig?: LogicSignature
+  lsig?: LogicSigSignature
 
   /**
    * Optional auth address applicable if the transaction sender is a rekeyed account.
@@ -75,9 +75,9 @@ export type MultisigSignature = {
 }
 
 /**
- * Logic signature structure
+ * LogicSig signature structure
  */
-export type LogicSignature = {
+export type LogicSigSignature = {
   /**
    * Logic signature program
    */