Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 | 28x 28x 28x 3x 3x 3x 2x 2x 2x 1x 1x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 28x 2x 2x 2x 28x 3x 3x 3x 2x 2x 2x 2x 2x 4x 3x 3x 2x 3x 3x 3x 3x 3x 3x 3x 2x 2x 3x 3x 2x 2x 2x 2x 3x 1x 1x 1x 1x 2x 2x 2x 2x 2x 3x 2x 2x | import { Script, Transaction, TransactionInput } from "@bsv/sdk"
import { asBsvSdkScript, makeAtomicBeef, PendingSignAction, PendingStorageInput, ScriptTemplateSABPPP, sdk, verifyTruthy, WalletSigner } from "../.."
export async function createActionSdk(signer: WalletSigner, vargs: sdk.ValidCreateActionArgs, originator?: sdk.OriginatorDomainNameStringUnder250Bytes)
: Promise<sdk.CreateActionResult>
{
const r: sdk.CreateActionResult = {}
let prior: PendingSignAction | undefined = undefined
if (vargs.isNewTx) {
prior = await createNewTx(signer, vargs, originator)
if (vargs.isSignAction) {
return makeSignableTransactionResult(prior, signer, vargs)
}
prior.tx = await completeSignedTransaction(prior, {}, signer)
r.txid = prior.tx.id('hex')
r.noSendChange = prior.dcr.noSendChangeOutputVouts?.map(vout => `${r.txid}.${vout}`)
Iif (!vargs.options.returnTXIDOnly)
r.tx = makeAtomicBeef(prior.tx, prior.dcr.inputBeef!)
}
r.sendWithResults = await processActionSdk(prior, signer, vargs, originator)
return r
}
async function createNewTx(signer: WalletSigner, args: sdk.ValidCreateActionArgs, originator?: sdk.OriginatorDomainNameStringUnder250Bytes)
: Promise<PendingSignAction>
{
const storageArgs = removeUnlockScripts(args);
const dcr = await signer.storage.createTransactionSdk(storageArgs, originator)
const reference = dcr.reference
const { tx, amount, pdi } = buildSignableTransaction(dcr, args, signer)
const prior: PendingSignAction = { reference, dcr, args, amount, tx, pdi }
return prior
}
function makeSignableTransactionResult(prior: PendingSignAction, signer: WalletSigner, args: sdk.ValidCreateActionArgs)
: sdk.CreateActionResult
{
Iif (!prior.dcr.inputBeef)
throw new sdk.WERR_INTERNAL('prior.dcr.inputBeef must be valid')
const txid = prior.tx.id('hex')
const r: sdk.CreateActionResult = {
noSendChange: args.isNoSend ? prior.dcr.noSendChangeOutputVouts?.map(vout => `${txid}.${vout}`) : undefined,
signableTransaction: {
reference: prior.dcr.reference,
tx: makeAtomicBeef(prior.tx, prior.dcr.inputBeef)
}
}
signer.pendingSignActions[r.signableTransaction!.reference] = prior
return r
}
/**
* Derive a change output locking script
*/
function makeChangeLock(
out: sdk.StorageCreateTransactionSdkOutput,
dctr: sdk.StorageCreateTransactionSdkResult,
args: sdk.ValidCreateActionArgs,
changeKeys: sdk.KeyPair,
signer: WalletSigner)
: Script
{
const derivationPrefix = dctr.derivationPrefix
const derivationSuffix = verifyTruthy(out.derivationSuffix);
const sabppp = new ScriptTemplateSABPPP({ derivationPrefix, derivationSuffix, keyDeriver: signer.keyDeriver });
const lockingScript = sabppp.lock(changeKeys.privateKey, changeKeys.publicKey)
return lockingScript
}
export async function completeSignedTransaction(
prior: PendingSignAction,
spends: Record<number, sdk.SignActionSpend>,
signer: WalletSigner,
)
: Promise<Transaction>
{
/////////////////////
// Insert the user provided unlocking scripts from "spends" arg
/////////////////////
for (const [key, spend] of Object.entries(spends)) {
const vin = Number(key)
const createInput = prior.args.inputs[vin]
const input = prior.tx.inputs[vin]
Iif (!createInput || !input || createInput.unlockingScript || !Number.isInteger(createInput.unlockingScriptLength))
throw new sdk.WERR_INVALID_PARAMETER('args', `spend does not correspond to prior input with valid unlockingScriptLength.`)
Iif (spend.unlockingScript.length / 2 > createInput.unlockingScriptLength!)
throw new sdk.WERR_INVALID_PARAMETER('args', `spend unlockingScript length ${spend.unlockingScript.length} exceeds expected length ${createInput.unlockingScriptLength}`)
input.unlockingScript = asBsvSdkScript(spend.unlockingScript)
Iif (spend.sequenceNumber !== undefined)
input.sequence = spend.sequenceNumber
}
const results = {
sdk: <sdk.SignActionResult>{}
}
/////////////////////
// Insert SABPPP unlock templates for storage signed inputs
/////////////////////
for (const pdi of prior.pdi) {
const sabppp = new ScriptTemplateSABPPP({
derivationPrefix: pdi.derivationPrefix,
derivationSuffix: pdi.derivationSuffix,
keyDeriver: signer.keyDeriver
})
const keys = signer.getClientChangeKeyPair()
const lockerPrivKey = keys.privateKey
const unlockerPubKey = pdi.unlockerPubKey || keys.publicKey
const sourceSatoshis = pdi.sourceSatoshis
const lockingScript = asBsvSdkScript(pdi.lockingScript)
const unlockTemplate = sabppp.unlock(lockerPrivKey, unlockerPubKey, sourceSatoshis, lockingScript)
const input = prior.tx.inputs[pdi.vin]
input.unlockingScriptTemplate = unlockTemplate
}
/////////////////////
// Sign storage signed inputs making transaction fully valid.
/////////////////////
await prior.tx.sign()
return prior.tx
}
function removeUnlockScripts(args: sdk.ValidCreateActionArgs) {
let storageArgs = args
Iif (!storageArgs.inputs.every(i => i.unlockingScript === undefined)) {
// Never send unlocking scripts to storage, all it needs is the script length.
storageArgs = { ...args, inputs: [] };
for (const i of args.inputs) {
const di: sdk.ValidCreateActionInput = {
...i,
unlockingScriptLength: i.unlockingScript !== undefined ? i.unlockingScript.length : i.unlockingScriptLength
};
delete di.unlockingScript;
storageArgs.inputs.push(di);
}
}
return storageArgs;
}
export async function processActionSdk(prior: PendingSignAction | undefined, signer: WalletSigner, vargs: sdk.ValidProcessActionArgs, originator?: sdk.OriginatorDomainNameStringUnder250Bytes)
: Promise<sdk.SendWithResult[] | undefined>
{
const params: sdk.StorageProcessActionSdkParams = {
userId: vargs.userId!,
isNewTx: vargs.isNewTx,
isSendWith: vargs.isSendWith,
isNoSend: vargs.isNoSend,
isDelayed: vargs.isDelayed,
reference: prior ? prior.reference : undefined,
txid: prior ? prior.tx.id('hex') : undefined,
rawTx: prior ? prior.tx.toBinary() : undefined,
sendWith: vargs.isSendWith ? vargs.options.sendWith : [],
}
const r: sdk.StorageProcessActionSdkResults = await signer.storage.processActionSdk(params, originator)
return r.sendWithResults
}
function buildSignableTransaction(
dctr: sdk.StorageCreateTransactionSdkResult,
args: sdk.ValidCreateActionArgs,
signer: WalletSigner
)
: { tx: Transaction, amount: number, pdi: PendingStorageInput[], log: string }
{
const changeKeys = signer.getClientChangeKeyPair()
const {
inputs: storageInputs,
outputs: storageOutputs,
} = dctr;
const tx = new Transaction(args.version, [], [], args.lockTime);
// The order of outputs in storageOutputs is always:
// CreateActionArgs.outputs in the original order
// Commission output
// Change outputs
// The Vout values will be randomized if args.options.randomizeOutputs is true. Default is true.
const voutToIndex = Array<number>(storageOutputs.length)
for (let vout = 0; vout < storageOutputs.length; vout++) {
const i = storageOutputs.findIndex(o => o.vout === vout)
Iif (i < 0)
throw new sdk.WERR_INVALID_PARAMETER('output.vout', `sequential. ${vout} is missing`)
voutToIndex[vout] = i
}
//////////////
// Add OUTPUTS
/////////////
for (let vout = 0; vout < storageOutputs.length; vout++) {
const i = voutToIndex[vout]
const out = storageOutputs[i]
Iif (vout !== out.vout)
throw new sdk.WERR_INVALID_PARAMETER('output.vout', `equal to array index. ${out.vout} !== ${vout}`)
const change = out.providedBy === 'storage' && out.purpose === 'change'
const lockingScript = change ? makeChangeLock(out, dctr, args, changeKeys, signer) : asBsvSdkScript(out.lockingScript)
const output = {
satoshis: out.satoshis,
lockingScript,
change
}
tx.addOutput(output);
}
//////////////
// Merge and sort INPUTS info by vin order.
/////////////
const inputs: {
argsInput: sdk.ValidCreateActionInput | undefined,
storageInput: sdk.StorageCreateTransactionSdkInput,
}[] = []
for (const storageInput of storageInputs) {
const argsInput = (storageInput.vin !== undefined && storageInput.vin < args.inputs.length) ? args.inputs[storageInput.vin] : undefined
inputs.push({ argsInput, storageInput })
}
inputs.sort((a, b) => a.storageInput.vin! < b.storageInput.vin! ? -1 : a.storageInput.vin! === b.storageInput.vin! ? 0 : 1)
const pendingStorageInputs: PendingStorageInput[] = []
//////////////
// Add INPUTS
/////////////
let totalChangeInputs = 0
for (const { storageInput, argsInput } of inputs) {
// Two types of inputs are handled: user specified wth/without unlockingScript and storage specified using SABPPP template.
if (argsInput) {
// Type 1: User supplied input, with or without an explicit unlockingScript.
// If without, signAction must be used to provide the actual unlockScript.
const hasUnlock = typeof argsInput.unlockingScript === 'string'
const unlock = hasUnlock ? asBsvSdkScript(argsInput.unlockingScript!) : new Script()
const inputToAdd: TransactionInput = {
sourceTXID: argsInput.outpoint.txid,
sourceOutputIndex: argsInput.outpoint.vout,
unlockingScript: unlock,
sequence: argsInput.sequenceNumber
};
tx.addInput(inputToAdd);
} else {
// Type2: SABPPP protocol inputs which are signed using ScriptTemplateSABPPP.
Iif (storageInput.type !== 'P2PKH')
throw new sdk.WERR_INVALID_PARAMETER('type', `vin ${storageInput.vin}, "${storageInput.type}" is not a supported unlocking script type.`);
pendingStorageInputs.push({
vin: tx.inputs.length,
derivationPrefix: verifyTruthy(storageInput.derivationPrefix),
derivationSuffix: verifyTruthy(storageInput.derivationSuffix),
unlockerPubKey: storageInput.senderIdentityKey,
sourceSatoshis: storageInput.sourceSatoshis,
lockingScript: storageInput.sourceLockingScript
})
const inputToAdd: TransactionInput = {
sourceTXID: storageInput.sourceTxid,
sourceOutputIndex: storageInput.sourceVout,
unlockingScript: new Script(),
sequence: 0xffffffff
};
tx.addInput(inputToAdd);
totalChangeInputs += verifyTruthy(storageInput.sourceSatoshis);
}
}
// The amount is the total of non-foreign inputs minus change outputs
// Note that the amount can be negative when we are redeeming more inputs than we are spending
const totalChangeOutputs = storageOutputs.filter(x => x.purpose === 'change').reduce((acc, el) => acc + el.satoshis, 0);
const amount = totalChangeInputs - totalChangeOutputs;
return {
tx,
amount,
pdi: pendingStorageInputs,
log: ''
};
}
|