@gstohl/t2z

Auto-generated - Do not edit directly. All changes must be made in gstohl/t2z.

TypeScript/Node.js bindings for t2z - enabling transparent Zcash wallets to send shielded Orchard outputs via PCZT (ZIP 374).

Installation

npm install @gstohl/t2z

Native libraries are bundled for: macOS (arm64/x64), Linux (x64/arm64), Windows (x64/arm64).

Usage

import {
  TransactionRequest,
  proposeTransaction,
  proveTransaction,
  getSighash,
  appendSignature,
  finalizeAndExtract,
  signMessage,
} from '@gstohl/t2z';

// 1. Create payment request
const request = new TransactionRequest([{
  address: 'u1...',       // unified or transparent address
  amount: '100000',       // 0.001 ZEC in zatoshis
}]);

// 2. Create PCZT from transparent UTXOs
const pczt = proposeTransaction([{
  pubkey: pubkeyBuffer,       // 33 bytes compressed
  txid: txidBuffer,           // 32 bytes
  vout: 0,
  amount: '100000000',        // 1 ZEC in zatoshis
  scriptPubKey: scriptBuffer,
}], request);

// 3. Add Orchard proofs
const proved = proveTransaction(pczt);

// 4. Sign transparent inputs
const sighash = getSighash(proved, 0);
const signature = await signMessage(privateKey, sighash);
const signed = appendSignature(proved, 0, signature);

// 5. Finalize and broadcast
const txBytes = finalizeAndExtract(signed);
// submit txBytes to Zcash network

API

See the main repo for full documentation.

| Function | Description | |----------|-------------| | new TransactionRequest(payments) | Create payment request | | proposeTransaction(inputs, request) | Create PCZT from inputs | | proveTransaction(pczt) | Add Orchard proofs | | verifyBeforeSigning(pczt, request, change) | Verify PCZT integrity | | getSighash(pczt, index) | Get 32-byte signature hash | | appendSignature(pczt, index, sig) | Add 64-byte signature | | combine(pczts) | Merge multiple PCZTs | | finalizeAndExtract(pczt) | Extract transaction bytes | | parsePczt(bytes) / serializePczt(pczt) | PCZT serialization | | signMessage(privKey, hash) | secp256k1 signing utility | | getPublicKey(privKey) | Derive compressed public key | | calculateFee(inputs, outputs) | Calculate ZIP-317 fee |

Types

interface Payment {
  address: string;    // transparent (t1...) or unified (u1...)
  amount: string;     // zatoshis as string (BigInt compatibility)
  memo?: string;      // optional, for shielded outputs
}

interface TransparentInput {
  pubkey: Buffer;       // 33 bytes compressed secp256k1
  txid: Buffer;         // 32 bytes
  vout: number;
  amount: string;       // zatoshis as string
  scriptPubKey: Buffer; // P2PKH script
}

Examples

See examples/ for complete working examples:

• zebrad-regtest/ - Local regtest network examples (1-9)
• zebrad-mainnet/ - Mainnet examples with hardware wallet flow

Memory

Automatic cleanup: All handles are automatically freed by the garbage collector via FinalizationRegistry. No manual cleanup required.

Consuming functions transfer ownership (input PCZT becomes invalid):

• proveTransaction, appendSignature, finalizeAndExtract, combine

Non-consuming (read-only):

• getSighash, serialize, verifyBeforeSigning

License

MIT