Class LogicSig

LogicSig implementation

LogicSig cannot sign transactions in all cases. Instead, use LogicSigAccount as a safe, general purpose signing mechanism. Since LogicSig does not track the provided signature's public key, LogicSig cannot sign transactions when delegated to a non-multisig account and the sender is not the delegating account.

Implements

Constructors

constructor

Properties

args logic msig? sig? encodingSchema

Methods

address appendToMultisig getEncodingSchema sign signProgram singleSignMultisig toByte toEncodingData verify fromByte fromEncodingData

Constructors

constructor

  • new LogicSig(program, programArgs?): LogicSig

  • Parameters

    • program: Uint8Array
    • Optional programArgs: null | Uint8Array[]

    Returns LogicSig

Properties

args

args: Uint8Array[]

logic

logic: Uint8Array

Optional msig

msig?: EncodedMultisig

Optional sig

sig?: Uint8Array

Static Readonly encodingSchema

encodingSchema: NamedMapSchema = ...

Methods

address

  • address(): Address

  • Compute hash of the logic sig program (that is the same as escrow account address) as string address

    Returns Address

    String representation of the address

appendToMultisig

  • appendToMultisig(secretKey): void

  • Appends a signature to multi signature

    Parameters

    • secretKey: Uint8Array

      Secret key to sign with

    Returns void

getEncodingSchema

  • getEncodingSchema(): Schema

  • Get the encoding Schema for this object, used to prepare the encoding data for msgpack and JSON.

    Returns Schema

sign

  • sign(secretKey, msig?): void

  • Creates signature (if no msig provided) or multi signature otherwise

    Parameters

    • secretKey: Uint8Array

      Secret key to sign with

    • Optional msig: MultisigMetadata

      Multisig account as {version, threshold, addrs}

    Returns void

signProgram

  • signProgram(secretKey): Uint8Array

  • Parameters

    • secretKey: Uint8Array

    Returns Uint8Array

singleSignMultisig

  • singleSignMultisig(secretKey, msig): [sig: Uint8Array, index: number]

  • Parameters

    Returns [sig: Uint8Array, index: number]

toByte

toEncodingData

  • toEncodingData(): Map<string, unknown>

  • Extract the encoding data for this object. This data, after being prepared by the encoding Schema, can be encoded to msgpack or JSON.

    Returns Map<string, unknown>

verify

  • verify(publicKey): boolean

  • Performs signature verification

    Parameters

    • publicKey: Uint8Array

      Verification key (derived from sender address or escrow address)

    Returns boolean

Static fromByte

Static fromEncodingData

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc