Type alias CompilerConfiguration<CompilationContext, CompilerKeyOperations, CompilerSigningSerializationOperations, CompilerAddressDataOperations, CompilerWalletDataOperations, CompilerCurrentBlockHeightOperations, CompilerCurrentBlockTimeOperations>

Type declaration

• Optional createAuthenticationProgram?: ((evaluationBytecode) => any)

  A method that accepts the compiled bytecode contents of a CashAssembly evaluation and produces the equivalent AuthenticationProgram to be evaluated by the VM. This method is used internally to compute CashAssembly evaluations. See createAuthenticationProgramEvaluationCommon for details.

  • • (evaluationBytecode): any

    • A method that accepts the compiled bytecode contents of a CashAssembly evaluation and produces the equivalent AuthenticationProgram to be evaluated by the VM. This method is used internally to compute CashAssembly evaluations. See createAuthenticationProgramEvaluationCommon for details.

      Parameters

      • evaluationBytecode: Uint8Array

      Returns any

• Optional entityOwnership?: {
      [variableId: string]: string;
  }

  An object mapping template variable identifiers to the entity identifiers responsible for them. This is required for HdKey support, as each entity uses a single HD private key (provided in hdKeys.hdPrivateKeys) or HD public key (provided in hdKeys.hdPublicKeys) per compilation, and each HdKey variable is derived from this key.

  To avoid compilation errors, this object must contain all HdKey variables referenced by the script being compiled (including in child scripts). To enable support for error handling like extractMissingVariables, it's recommended that all variables be provided here.

  • [variableId: string]: string

• Optional lockingScriptTypes?: {
      [lockingScriptId: string]: "p2sh20" | "p2sh32" | "standard";
  }

  An object mapping the script identifiers of locking scripts to their locking script type, either standard or p2sh20.

  This is used to transform compilation results into the proper structure for P2SH20 locking and unlocking scripts.

  When compiling locking scripts of type p2sh20, the result will be placed in a P2SH20 "redeemScript" format: OP_HASH160 <$(<result> OP_HASH160)> OP_EQUAL

  When compiling unlocking scripts that unlock locking scripts of type p2sh20, the result will be transformed into the P2SH20 unlocking format: result <locking_script> (where locking_script is the compiled bytecode of the locking script, without the "redeemScript" transformation.)

  By default, all scripts are assumed to have the type standard.

  • [lockingScriptId: string]: "p2sh20" | "p2sh32" | "standard"

• Optional opcodes?: {
      [opcodeIdentifier: string]: Uint8Array;
  }

  An object mapping opcode identifiers to the bytecode they generate.

  • [opcodeIdentifier: string]: Uint8Array

• Optional operations?: {
      addressData?: CompilerAddressDataOperations extends string
          ? {
              [operationId in CompilerAddressDataOperations]?: CompilerOperation<CompilationContext>
          }
          : CompilerOperation<CompilationContext>;
      currentBlockHeight?: CompilerCurrentBlockHeightOperations extends string
          ? {
              [operationId in CompilerCurrentBlockHeightOperations]?: CompilerOperation<CompilationContext>
          }
          : CompilerOperation<CompilationContext>;
      currentBlockTime?: CompilerCurrentBlockTimeOperations extends string
          ? {
              [operationId in CompilerCurrentBlockTimeOperations]?: CompilerOperation<CompilationContext>
          }
          : CompilerOperation<CompilationContext>;
      hdKey?: CompilerKeyOperations extends string
          ? {
              [operationId in CompilerKeyOperations]?: CompilerOperation<CompilationContext>
          }
          : CompilerOperation<CompilationContext>;
      key?: CompilerKeyOperations extends string
          ? {
              [operationId in CompilerKeyOperations]?: CompilerOperation<CompilationContext>
          }
          : CompilerOperation<CompilationContext>;
      signingSerialization?: CompilerSigningSerializationOperations extends string
          ? {
              [operationId in CompilerSigningSerializationOperations]?: CompilerOperation<CompilationContext>
          }
          : CompilerOperation<CompilationContext>;
      walletData?: CompilerWalletDataOperations extends string
          ? {
              [operationId in CompilerWalletDataOperations]?: CompilerOperation<CompilationContext>
          }
          : CompilerOperation<CompilationContext>;
  }

  An object specifying the operations made available by this compiler configuration for each variable type. For example, keys typically support public key derivation (.public_key) and several signature types.

  Compiler operations can be specified as a single operation for all instances of a variable type (as is the default for AddressData or WalletData), or they can be specified as an object, where each key is a valid operation name (as is the default for Key and HdKey).

  • Optional addressData?: CompilerAddressDataOperations extends string
        ? {
            [operationId in CompilerAddressDataOperations]?: CompilerOperation<CompilationContext>
        }
        : CompilerOperation<CompilationContext>

  • Optional currentBlockHeight?: CompilerCurrentBlockHeightOperations extends string
        ? {
            [operationId in CompilerCurrentBlockHeightOperations]?: CompilerOperation<CompilationContext>
        }
        : CompilerOperation<CompilationContext>

  • Optional currentBlockTime?: CompilerCurrentBlockTimeOperations extends string
        ? {
            [operationId in CompilerCurrentBlockTimeOperations]?: CompilerOperation<CompilationContext>
        }
        : CompilerOperation<CompilationContext>

  • Optional hdKey?: CompilerKeyOperations extends string
        ? {
            [operationId in CompilerKeyOperations]?: CompilerOperation<CompilationContext>
        }
        : CompilerOperation<CompilationContext>

  • Optional key?: CompilerKeyOperations extends string
        ? {
            [operationId in CompilerKeyOperations]?: CompilerOperation<CompilationContext>
        }
        : CompilerOperation<CompilationContext>

  • Optional signingSerialization?: CompilerSigningSerializationOperations extends string
        ? {
            [operationId in CompilerSigningSerializationOperations]?: CompilerOperation<CompilationContext>
        }
        : CompilerOperation<CompilationContext>

  • Optional walletData?: CompilerWalletDataOperations extends string
        ? {
            [operationId in CompilerWalletDataOperations]?: CompilerOperation<CompilationContext>
        }
        : CompilerOperation<CompilationContext>

• Optional ripemd160?: {
      hash: Ripemd160["hash"];
  }

  An implementation of ripemd160 is required for any scripts that include HdKeys. This can be instantiated with instantiateRipemd160.

  • hash: Ripemd160["hash"]

• Optional scenarios?: {
      [scriptId: string]: WalletTemplateScenario;
  }

  An object mapping scenario identifiers to the WalletTemplateScenarios they represent.

  • [scriptId: string]: WalletTemplateScenario

• scripts: {
      [scriptId: string]: string;
  }

  An object mapping script identifiers to the text of script in CashAssembly.

  To avoid compilation errors, this object must contain all scripts referenced by the script being compiled (including children of children).

  • [scriptId: string]: string

• Optional secp256k1?: {
      addTweakPrivateKey: Secp256k1["addTweakPrivateKey"];
      addTweakPublicKeyCompressed: Secp256k1["addTweakPublicKeyCompressed"];
      derivePublicKeyCompressed: Secp256k1["derivePublicKeyCompressed"];
      signMessageHashDER: Secp256k1["signMessageHashDER"];
      signMessageHashSchnorr: Secp256k1["signMessageHashSchnorr"];
      validatePublicKey: Secp256k1["validatePublicKey"];
  }

  An implementation of secp256k1 is required for any scripts that include signatures. This can be instantiated with instantiateSecp256k1.

  • addTweakPrivateKey: Secp256k1["addTweakPrivateKey"]

  • addTweakPublicKeyCompressed: Secp256k1["addTweakPublicKeyCompressed"]

  • derivePublicKeyCompressed: Secp256k1["derivePublicKeyCompressed"]

  • signMessageHashDER: Secp256k1["signMessageHashDER"]

  • signMessageHashSchnorr: Secp256k1["signMessageHashSchnorr"]

  • validatePublicKey: Secp256k1["validatePublicKey"]

• Optional sha256?: {
      hash: Sha256["hash"];
  }

  An implementation of sha256 is required for any scripts that include signatures. This can be instantiated with instantiateSha256.

  • hash: Sha256["hash"]

• Optional sha512?: {
      hash: Sha512["hash"];
  }

  An implementation of sha512 is required for any scripts that include HdKeys. This can be instantiated with instantiateSha512.

  • hash: Sha512["hash"]

• Optional sourceScriptIds?: string[]

  Only for use when recursively calling compileScript (e.g. in compiler operations).

  The "breadcrumb" path of script IDs currently being compiled, including the current script. (E.g. ["grandparentId", "parentId", "scriptId"])

  CashAssembly identifier resolution must be acyclic. To prevent an infinite loop, IdentifierResolutionFunctions must abort resolution if they encounter their own id while resolving another identifier. Likewise, child scripts being resolved by a parent script may not reference any script that is already in the process of being resolved.

• Optional unlockingScriptTimeLockTypes?: {
      [unlockingScriptId: string]: "height" | "timestamp";
  }

  An object mapping the identifiers of unlocking scripts to their timeLockType.

  The timestamp type indicates that the transaction's locktime is provided as a UNIX timestamp (the locktime value is greater than or equal to 500000000).

  The height type indicates that the transaction's locktime is provided as a block height (the locktime value is less than 500000000).

  See WalletTemplateScript.timeLockType for details.

  • [unlockingScriptId: string]: "height" | "timestamp"

• Optional unlockingScripts?: {
      [unlockingScriptId: string]: string;
  }

  An object mapping the identifiers of unlocking scripts to the identifiers of the locking scripts they unlock. This is used to identify the coveredBytecode used in signing serializations, and it is required for all signature operations and many signing serialization operations.

  • [unlockingScriptId: string]: string

• Optional variables?: {
      [variableId: string]: WalletTemplateVariable;
  }

  An object mapping template variable identifiers to the WalletTemplateVariable describing them.

  To avoid compilation errors, this object must contain all variables referenced by the script being compiled (including in child scripts).

  • [variableId: string]: WalletTemplateVariable

• Optional vm?: AuthenticationVirtualMachine<any, any, any>

  The AuthenticationVirtualMachine on which CashAssembly evaluation results will be computed.