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 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 | 57x 57x 57x 5x 5x 211x 566x 33x 2x 17x 184x 44x 24x 57x 137x 137x 137x 57x 32x 17x 57x 472x 212x 260x 260x 260x 260x 260x 57x 70x 57x 261x 261x 260x 253x 16x 28x 49x 50x 127x 127x 127x 127x 126x 4x 2x 89x 89x 89x 89x 2x 87x 87x 87x 87x 8x 69x 69x 67x 67x 66x 66x 66x 57x 57x 2x 2x 2x 2x 2x 2x 57x 18x 2x 16x 57x 17x 17x 2x 17x 57x 20x 2x 18x 17x 17x 17x 17x 17x 17x 16x 57x 4x 4x 4x 57x 4x 4x 4x 4x 4x 57x 11x 9x 57x 48x 24x 24x 57x 48x 24x 48x 24x 57x 48x 48x 48x 57x 89x 13x 13x 6x 6x 12x 57x 32x 48x 32x 57x 2x 57x 6x 6x 6x 6x 6x 57x 4x 4x 57x 4x 4x 57x 17x 11x 10x 16x 2x 6x 2x 2x 2x 6x 6x 2x 57x 57x 3x 3x 2x 2x 2x 2x 2x 2x 2x 57x 2x 2x 2x 2x 57x 57x 57x 80x 4x 80x 48x 80x 57x 45x 4x 45x 49x 44x | import {
AbortActionArgs,
AcquireCertificateArgs,
AcquisitionProtocol,
AtomicBEEF,
Base64String,
BasketInsertion,
BasketStringUnder300Bytes,
BEEF,
BooleanDefaultFalse,
BooleanDefaultTrue,
CertificateFieldNameUnder50Bytes,
CreateActionArgs,
CreateActionInput,
CreateActionOptions,
CreateActionOutput,
DescriptionString5to50Bytes,
DiscoverByAttributesArgs,
DiscoverByIdentityKeyArgs,
HexString,
InternalizeActionArgs,
InternalizeOutput,
KeyringRevealer,
LabelStringUnder300Bytes,
ListActionsArgs,
ListCertificatesArgs,
ListOutputsArgs,
OutpointString,
OutputTagStringUnder300Bytes,
PositiveInteger,
PositiveIntegerDefault10Max10000,
PositiveIntegerOrZero,
ProveCertificateArgs,
PubKeyHex,
RelinquishCertificateArgs,
RelinquishOutputArgs,
SatoshiValue,
SignActionArgs,
SignActionOptions,
SignActionSpend,
TrustSelf,
TXIDHexString,
Utils,
WalletPayment
} from '@bsv/sdk'
import { sdk } from '../index.client'
import { OutPoint } from './types'
export function parseWalletOutpoint(outpoint: string): { txid: string; vout: number } {
const [txid, vout] = outpoint.split('.')
return { txid, vout: Number(vout) }
}
function defaultTrue(v?: boolean) {
return v === undefined ? true : v
}
function defaultFalse(v?: boolean) {
return v === undefined ? false : v
}
function defaultZero(v?: number) {
return v === undefined ? 0 : v
}
function default0xffffffff(v?: number) {
return v === undefined ? 0xffffffff : v
}
function defaultOne(v?: number) {
return v === undefined ? 1 : v
}
function defaultEmpty<T>(v?: T[]) {
return v === undefined ? [] : v
}
function validateOptionalStringLength(s: string | undefined, name: string, min?: number, max?: number): string | undefined {
if (s === undefined) return undefined
return validateStringLength(s, name, min, max)
}
export function validateSatoshis(v: number | undefined, name: string, min?: number): number {
Iif (v === undefined || !Number.isInteger(v) || v < 0 || v > 21e14) throw new sdk.WERR_INVALID_PARAMETER(name, 'a valid number of satoshis')
Iif (min !== undefined && v < min) throw new sdk.WERR_INVALID_PARAMETER(name, `at least ${min} satoshis.`)
return v
}
export function validateOptionalInteger(v: number | undefined, name: string, min?: number, max?: number): number | undefined {
if (v === undefined) return undefined
return validateInteger(v, name, undefined, min, max)
}
export function validateInteger(v: number | undefined, name: string, defaultValue?: number, min?: number, max?: number): number {
if (v === undefined) {
if (defaultValue !== undefined) return defaultValue
throw new sdk.WERR_INVALID_PARAMETER(name, 'a valid integer')
}
Iif (!Number.isInteger(v)) throw new sdk.WERR_INVALID_PARAMETER(name, 'an integer')
v = Number(v)
Iif (min !== undefined && v < min) throw new sdk.WERR_INVALID_PARAMETER(name, `at least ${min} length.`)
Iif (max !== undefined && v > max) throw new sdk.WERR_INVALID_PARAMETER(name, `no more than ${max} length.`)
return v
}
export function validatePositiveIntegerOrZero(v: number, name: string): number {
return validateInteger(v, name, 0, 0)
}
export function validateStringLength(s: string, name: string, min?: number, max?: number): string {
const bytes = Utils.toArray(s, 'utf8').length
if (min !== undefined && bytes < min) throw new sdk.WERR_INVALID_PARAMETER(name, `at least ${min} length.`)
if (max !== undefined && bytes > max) throw new sdk.WERR_INVALID_PARAMETER(name, `no more than ${max} length.`)
return s
}
function validateOptionalBasket(s?: string): string | undefined {
if (s === undefined) return undefined
return validateBasket(s)
}
function validateBasket(s: string): string {
return validateIdentifier(s, 'basket', 1, 300)
}
function validateLabel(s: string): string {
return validateIdentifier(s, 'label', 1, 300)
}
function validateTag(s: string): string {
return validateIdentifier(s, 'tag', 1, 300)
}
function validateIdentifier(s: string, name: string, min?: number, max?: number): string {
s = s.trim().toLowerCase()
const bytes = Utils.toArray(s, 'utf8').length
Iif (min !== undefined && bytes < min) throw new sdk.WERR_INVALID_PARAMETER(name, `at least ${min} length.`)
if (max !== undefined && bytes > max) throw new sdk.WERR_INVALID_PARAMETER(name, `no more than ${max} length.`)
return s
}
function validateOptionalBase64String(s: string | undefined, name: string, min?: number, max?: number): string | undefined {
if (s === undefined) return undefined
return validateBase64String(s, name, min, max)
}
function validateBase64String(s: string, name: string, min?: number, max?: number): string {
// Remove any whitespace and check if the string length is valid for Base64
s = s.trim()
const base64Regex = /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/
const paddingCount = (s.match(/=+$/) || [])[0]?.length || 0
if (paddingCount > 2 || (s.length % 4 !== 0 && paddingCount !== 0) || !base64Regex.test(s)) {
throw new sdk.WERR_INVALID_PARAMETER(name, `balid base64 string`)
}
const bytes = Utils.toArray(s, 'base64').length
Iif (min !== undefined && bytes < min) throw new sdk.WERR_INVALID_PARAMETER(name, `at least ${min} length.`)
Iif (max !== undefined && bytes > max) throw new sdk.WERR_INVALID_PARAMETER(name, `no more than ${max} length.`)
return s
}
function validateOptionalHexString(s: string | undefined, name: string, min?: number, max?: number): string | undefined {
if (s === undefined) return undefined
return validateHexString(s, name, min, max)
}
/**
* @param s
* @param name
* @param min if valid, string length minimum (not bytes)
* @param max if valid, string length maximum (not bytes)
* @returns
*/
function validateHexString(s: string, name: string, min?: number, max?: number): string {
s = s.trim().toLowerCase()
if (s.length % 2 === 1) throw new sdk.WERR_INVALID_PARAMETER(name, `even length, not ${s.length}.`)
const hexRegex = /^[0-9A-Fa-f]+$/
if (!hexRegex.test(s)) throw new sdk.WERR_INVALID_PARAMETER(name, `hexadecimal string.`)
Iif (min !== undefined && s.length < min) throw new sdk.WERR_INVALID_PARAMETER(name, `at least ${min} length.`)
Iif (max !== undefined && s.length > max) throw new sdk.WERR_INVALID_PARAMETER(name, `no more than ${max} length.`)
return s
}
export function isHexString(s: string): boolean {
s = s.trim()
Iif (s.length % 2 === 1) return false
const hexRegex = /^[0-9A-Fa-f]+$/
Iif (!hexRegex.test(s)) return false
return true
}
export interface ValidWalletSignerArgs {}
export interface ValidCreateActionInput {
outpoint: OutPoint
inputDescription: DescriptionString5to50Bytes
sequenceNumber: PositiveIntegerOrZero
unlockingScript?: HexString
unlockingScriptLength: PositiveInteger
}
export function validateCreateActionInput(i: CreateActionInput): ValidCreateActionInput {
Iif (i.unlockingScript === undefined && i.unlockingScriptLength === undefined) throw new sdk.WERR_INVALID_PARAMETER('unlockingScript, unlockingScriptLength', `at least one valid value.`)
const unlockingScript = validateOptionalHexString(i.unlockingScript, 'unlockingScript')
const unlockingScriptLength = i.unlockingScriptLength || unlockingScript!.length / 2
Iif (unlockingScript && unlockingScriptLength !== unlockingScript.length / 2) throw new sdk.WERR_INVALID_PARAMETER('unlockingScriptLength', `length unlockingScript if both valid.`)
const vi: ValidCreateActionInput = {
outpoint: parseWalletOutpoint(i.outpoint),
inputDescription: validateStringLength(i.inputDescription, 'inputDescription', 5, 50),
unlockingScript,
unlockingScriptLength,
sequenceNumber: default0xffffffff(i.sequenceNumber)
}
return vi
}
export interface ValidCreateActionOutput {
lockingScript: HexString
satoshis: SatoshiValue
outputDescription: DescriptionString5to50Bytes
basket?: BasketStringUnder300Bytes
customInstructions?: string
tags: BasketStringUnder300Bytes[]
}
export function validateCreateActionOutput(o: CreateActionOutput): ValidCreateActionOutput {
const vo: ValidCreateActionOutput = {
lockingScript: validateHexString(o.lockingScript, 'lockingScript'),
satoshis: validateSatoshis(o.satoshis, 'satoshis'),
outputDescription: validateStringLength(o.outputDescription, 'outputDescription', 5, 50),
basket: validateOptionalBasket(o.basket),
customInstructions: o.customInstructions,
tags: defaultEmpty(o.tags).map(t => validateTag(t))
}
return vo
}
/**
* Set all default true/false booleans to true or false if undefined.
* Set all possibly undefined numbers to their default values.
* Set all possibly undefined arrays to empty arrays.
* Convert string outpoints to `{ txid: string, vout: number }`
*/
export function validateCreateActionOptions(options?: CreateActionOptions): ValidCreateActionOptions {
const o = options || {}
const vo: ValidCreateActionOptions = {
signAndProcess: defaultTrue(o.signAndProcess),
acceptDelayedBroadcast: defaultTrue(o.acceptDelayedBroadcast),
knownTxids: defaultEmpty(o.knownTxids),
returnTXIDOnly: defaultFalse(o.returnTXIDOnly),
noSend: defaultFalse(o.noSend),
noSendChange: defaultEmpty(o.noSendChange).map(nsc => parseWalletOutpoint(nsc)),
sendWith: defaultEmpty(o.sendWith),
randomizeOutputs: defaultTrue(o.randomizeOutputs)
}
return vo
}
export interface ValidProcessActionOptions {
acceptDelayedBroadcast: BooleanDefaultTrue
returnTXIDOnly: BooleanDefaultFalse
noSend: BooleanDefaultFalse
sendWith: TXIDHexString[]
}
export interface ValidCreateActionOptions extends ValidProcessActionOptions {
signAndProcess: boolean
trustSelf?: TrustSelf
knownTxids: TXIDHexString[]
noSendChange: OutPoint[]
randomizeOutputs: boolean
}
export interface ValidSignActionOptions extends ValidProcessActionOptions {
acceptDelayedBroadcast: boolean
returnTXIDOnly: boolean
noSend: boolean
sendWith: TXIDHexString[]
}
export interface ValidProcessActionArgs extends ValidWalletSignerArgs {
options: sdk.ValidProcessActionOptions
// true if a batch of transactions is included for processing.
isSendWith: boolean
// true if there is a new transaction (not no inputs and no outputs)
isNewTx: boolean
// true if any new transaction should NOT be sent to the network
isNoSend: boolean
// true if options.acceptDelayedBroadcast is true
isDelayed: boolean
}
export interface ValidCreateActionArgs extends ValidProcessActionArgs {
description: DescriptionString5to50Bytes
inputBEEF?: BEEF
inputs: sdk.ValidCreateActionInput[]
outputs: sdk.ValidCreateActionOutput[]
lockTime: number
version: number
labels: string[]
options: ValidCreateActionOptions
// true if transaction creation completion will require a `signAction` call.
isSignAction: boolean
}
export interface ValidSignActionArgs extends ValidProcessActionArgs {
spends: Record<PositiveIntegerOrZero, SignActionSpend>
reference: Base64String
options: sdk.ValidSignActionOptions
}
export function validateCreateActionArgs(args: CreateActionArgs): ValidCreateActionArgs {
const vargs: ValidCreateActionArgs = {
description: validateStringLength(args.description, 'description', 5, 50),
inputBEEF: args.inputBEEF,
inputs: defaultEmpty(args.inputs).map(i => validateCreateActionInput(i)),
outputs: defaultEmpty(args.outputs).map(o => validateCreateActionOutput(o)),
lockTime: defaultZero(args.lockTime),
version: defaultOne(args.version),
labels: defaultEmpty(args.labels?.map(l => validateLabel(l))),
options: validateCreateActionOptions(args.options),
isSendWith: false,
isDelayed: false,
isNoSend: false,
isNewTx: false,
isSignAction: false
}
vargs.isSendWith = vargs.options.sendWith.length > 0
vargs.isNewTx = vargs.inputs.length > 0 || vargs.outputs.length > 0
vargs.isSignAction = vargs.isNewTx && (vargs.options.signAndProcess === false || vargs.inputs.some(i => i.unlockingScript === undefined))
vargs.isDelayed = vargs.options.acceptDelayedBroadcast
vargs.isNoSend = vargs.options.noSend
if (!vargs.isSendWith && !vargs.isNewTx) throw new sdk.WERR_INVALID_PARAMETER('args', 'either at least one input or output, or a sendWith.')
return vargs
}
/**
* Set all default true/false booleans to true or false if undefined.
* Set all possibly undefined numbers to their default values.
* Set all possibly undefined arrays to empty arrays.
* Convert string outpoints to `{ txid: string, vout: number }`
*/
export function validateSignActionOptions(options?: SignActionOptions): ValidSignActionOptions {
const o = options || {}
const vo: ValidSignActionOptions = {
acceptDelayedBroadcast: defaultTrue(o.acceptDelayedBroadcast),
returnTXIDOnly: defaultFalse(o.returnTXIDOnly),
noSend: defaultFalse(o.noSend),
sendWith: defaultEmpty(o.sendWith)
}
return vo
}
export function validateSignActionArgs(args: SignActionArgs): ValidSignActionArgs {
const vargs: ValidSignActionArgs = {
spends: args.spends,
reference: args.reference,
options: validateSignActionOptions(args.options),
isSendWith: false,
isDelayed: false,
isNoSend: false,
isNewTx: true
}
vargs.isSendWith = vargs.options.sendWith.length > 0
vargs.isDelayed = vargs.options.acceptDelayedBroadcast
vargs.isNoSend = vargs.options.noSend
return vargs
}
export interface ValidAbortActionArgs extends ValidWalletSignerArgs {
reference: Base64String
}
export function validateAbortActionArgs(args: AbortActionArgs): ValidAbortActionArgs {
const vargs: ValidAbortActionArgs = {
reference: validateBase64String(args.reference, 'reference')
}
return vargs
}
export interface ValidWalletPayment {
derivationPrefix: Base64String
derivationSuffix: Base64String
senderIdentityKey: PubKeyHex
}
export function validateWalletPayment(args?: WalletPayment): ValidWalletPayment | undefined {
if (args === undefined) return undefined
const v: ValidWalletPayment = {
derivationPrefix: validateBase64String(args.derivationPrefix, 'derivationPrefix'),
derivationSuffix: validateBase64String(args.derivationSuffix, 'derivationSuffix'),
senderIdentityKey: validateHexString(args.senderIdentityKey, 'senderIdentityKey')
}
return v
}
export interface ValidBasketInsertion {
basket: BasketStringUnder300Bytes
customInstructions?: string
tags: BasketStringUnder300Bytes[]
}
export function validateBasketInsertion(args?: BasketInsertion): ValidBasketInsertion | undefined {
if (args === undefined) return undefined
const v: ValidBasketInsertion = {
basket: validateBasket(args.basket),
customInstructions: validateOptionalStringLength(args.customInstructions, 'customInstructions', 0, 1000), // TODO: real max??
tags: defaultEmpty(args.tags).map(t => validateTag(t))
}
return v
}
export interface ValidInternalizeOutput {
outputIndex: PositiveIntegerOrZero
protocol: 'wallet payment' | 'basket insertion'
paymentRemittance?: ValidWalletPayment
insertionRemittance?: ValidBasketInsertion
}
export function validateInternalizeOutput(args: InternalizeOutput): ValidInternalizeOutput {
Iif (args.protocol !== 'basket insertion' && args.protocol !== 'wallet payment') throw new sdk.WERR_INVALID_PARAMETER('protocol', `'basket insertion' or 'wallet payment'`)
const v: ValidInternalizeOutput = {
outputIndex: validatePositiveIntegerOrZero(args.outputIndex, 'outputIndex'),
protocol: args.protocol,
paymentRemittance: validateWalletPayment(args.paymentRemittance),
insertionRemittance: validateBasketInsertion(args.insertionRemittance)
}
return v
}
export interface ValidInternalizeActionArgs extends ValidWalletSignerArgs {
tx: AtomicBEEF
outputs: InternalizeOutput[]
description: DescriptionString5to50Bytes
labels: LabelStringUnder300Bytes[]
seekPermission: BooleanDefaultTrue
}
export function validateOriginator(s?: string): string | undefined {
if (s === undefined) return undefined
s = s.trim().toLowerCase()
validateStringLength(s, 'originator', 1, 250)
const sps = s.split('.')
for (const sp of sps) {
validateStringLength(sp, 'originator part', 1, 63)
}
}
export function validateInternalizeActionArgs(args: InternalizeActionArgs): ValidInternalizeActionArgs {
const vargs: ValidInternalizeActionArgs = {
tx: args.tx,
outputs: args.outputs.map(o => validateInternalizeOutput(o)),
description: validateStringLength(args.description, 'description', 5, 50),
labels: (args.labels || []).map(t => validateLabel(t)),
seekPermission: defaultTrue(args.seekPermission)
}
return vargs
}
export function validateOptionalOutpointString(outpoint: string | undefined, name: string): string | undefined {
if (outpoint === undefined) return undefined
return validateOutpointString(outpoint, name)
}
export function validateOutpointString(outpoint: string, name: string): string {
const s = outpoint.split('.')
Iif (s.length !== 2 || !Number.isInteger(Number(s[1]))) throw new sdk.WERR_INVALID_PARAMETER(name, `txid as hex string and numeric output index joined with '.'`)
const txid = validateHexString(s[0], `${name} txid`, undefined, 64)
const vout = validatePositiveIntegerOrZero(Number(s[1]), `${name} vout`)
return `${txid}.${vout}`
}
export interface ValidRelinquishOutputArgs extends ValidWalletSignerArgs {
basket: BasketStringUnder300Bytes
output: OutpointString
}
export function validateRelinquishOutputArgs(args: RelinquishOutputArgs): ValidRelinquishOutputArgs {
const vargs: ValidRelinquishOutputArgs = {
basket: validateBasket(args.basket),
output: validateOutpointString(args.output, 'output')
}
return vargs
}
export interface ValidRelinquishCertificateArgs extends ValidWalletSignerArgs {
type: Base64String
serialNumber: Base64String
certifier: PubKeyHex
}
export function validateRelinquishCertificateArgs(args: RelinquishCertificateArgs): ValidRelinquishCertificateArgs {
const vargs: ValidRelinquishCertificateArgs = {
type: validateBase64String(args.type, 'type'),
serialNumber: validateBase64String(args.serialNumber, 'serialNumber'),
certifier: validateHexString(args.certifier, 'certifier')
}
return vargs
}
export interface ValidListCertificatesArgs extends ValidWalletSignerArgs {
partial?: {
type?: Base64String
serialNumber?: Base64String
certifier?: PubKeyHex
subject?: PubKeyHex
revocationOutpoint?: OutpointString
signature?: HexString
}
certifiers: PubKeyHex[]
types: Base64String[]
limit: PositiveIntegerDefault10Max10000
offset: PositiveIntegerOrZero
privileged: BooleanDefaultFalse
privilegedReason?: DescriptionString5to50Bytes
}
export function validateListCertificatesArgs(args: ListCertificatesArgs): ValidListCertificatesArgs {
const vargs: ValidListCertificatesArgs = {
certifiers: defaultEmpty(args.certifiers.map(c => validateHexString(c.trim(), 'certifiers'))),
types: defaultEmpty(args.types.map(t => validateBase64String(t.trim(), 'types'))),
limit: validateInteger(args.limit, 'limit', 10, 1, 10000),
offset: validatePositiveIntegerOrZero(defaultZero(args.offset), 'offset'),
privileged: defaultFalse(args.privileged),
privilegedReason: validateOptionalStringLength(args.privilegedReason, 'privilegedReason', 5, 50),
partial: undefined
}
return vargs
}
export interface ValidAcquireCertificateArgs extends ValidWalletSignerArgs {
acquisitionProtocol: AcquisitionProtocol
type: Base64String
serialNumber?: Base64String
certifier: PubKeyHex
revocationOutpoint?: OutpointString
fields: Record<CertificateFieldNameUnder50Bytes, string>
signature?: HexString
certifierUrl?: string
keyringRevealer?: KeyringRevealer
keyringForSubject?: Record<CertificateFieldNameUnder50Bytes, Base64String>
privileged: boolean
privilegedReason?: DescriptionString5to50Bytes
}
function validateCertificateFields(fields: Record<CertificateFieldNameUnder50Bytes, string>): Record<CertificateFieldNameUnder50Bytes, string> {
for (const fieldName of Object.keys(fields)) {
validateStringLength(fieldName, 'field name', 1, 50)
}
return fields
}
function validateKeyringRevealer(kr: KeyringRevealer, name: string): KeyringRevealer {
if (kr === 'certifier') return kr
return validateHexString(kr, name)
}
function validateOptionalKeyringRevealer(kr: KeyringRevealer | undefined, name: string): KeyringRevealer | undefined {
Iif (kr === undefined) return undefined
return validateKeyringRevealer(kr, name)
}
function validateKeyringForSubject(kr: Record<CertificateFieldNameUnder50Bytes, Base64String>, name: string): Record<CertificateFieldNameUnder50Bytes, Base64String> {
for (const fn of Object.keys(kr)) {
validateStringLength(fn, `${name} field name`, 1, 50)
validateBase64String(kr[fn], `${name} field value`)
}
return kr
}
function validateOptionalKeyringForSubject(kr: Record<CertificateFieldNameUnder50Bytes, Base64String> | undefined, name: string): Record<CertificateFieldNameUnder50Bytes, Base64String> | undefined {
Iif (kr === undefined) return undefined
return validateKeyringForSubject(kr, name)
}
/**
*
* @param args
* @param subject Must be valid for "direct" `acquisitionProtocol`. public key of the certificate subject.
* @returns
*/
export async function validateAcquireCertificateArgs(args: AcquireCertificateArgs): Promise<ValidAcquireCertificateArgs> {
const vargs: ValidAcquireCertificateArgs = {
acquisitionProtocol: args.acquisitionProtocol,
type: validateBase64String(args.type, 'type'),
serialNumber: validateOptionalBase64String(args.serialNumber, 'serialNumber'),
certifier: validateHexString(args.certifier, 'certifier'),
revocationOutpoint: validateOptionalOutpointString(args.revocationOutpoint, 'revocationOutpoint'),
fields: validateCertificateFields(args.fields),
signature: validateOptionalHexString(args.signature, 'signature'),
certifierUrl: args.certifierUrl,
keyringRevealer: validateOptionalKeyringRevealer(args.keyringRevealer, 'keyringRevealer'),
keyringForSubject: validateOptionalKeyringForSubject(args.keyringForSubject, 'keyringForSubject'),
privileged: defaultFalse(args.privileged),
privilegedReason: validateOptionalStringLength(args.privilegedReason, 'privilegedReason', 5, 50)
}
Iif (vargs.privileged && !vargs.privilegedReason) throw new sdk.WERR_INVALID_PARAMETER('privilegedReason', `valid when 'privileged' is true `)
Iif (vargs.acquisitionProtocol === 'direct') {
Iif (!vargs.serialNumber) throw new sdk.WERR_INVALID_PARAMETER('serialNumber', 'valid when acquisitionProtocol is "direct"')
Iif (!vargs.signature) throw new sdk.WERR_INVALID_PARAMETER('signature', 'valid when acquisitionProtocol is "direct"')
Iif (!vargs.revocationOutpoint) throw new sdk.WERR_INVALID_PARAMETER('revocationOutpoint', 'valid when acquisitionProtocol is "direct"')
}
return vargs
}
export interface ValidAcquireDirectCertificateArgs extends ValidWalletSignerArgs {
type: Base64String
serialNumber: Base64String
certifier: PubKeyHex
revocationOutpoint: OutpointString
fields: Record<CertificateFieldNameUnder50Bytes, string>
signature: HexString
/**
* validated to an empty string, must be provided by wallet and must
* match expectations of keyringForSubject
*/
subject: PubKeyHex
keyringRevealer: KeyringRevealer
keyringForSubject: Record<CertificateFieldNameUnder50Bytes, Base64String>
privileged: boolean
privilegedReason?: DescriptionString5to50Bytes
}
export function validateAcquireDirectCertificateArgs(args: AcquireCertificateArgs): ValidAcquireDirectCertificateArgs {
Iif (args.acquisitionProtocol !== 'direct') throw new sdk.WERR_INTERNAL('Only acquire direct certificate requests allowed here.')
if (!args.serialNumber) throw new sdk.WERR_INVALID_PARAMETER('serialNumber', 'valid when acquisitionProtocol is "direct"')
Iif (!args.signature) throw new sdk.WERR_INVALID_PARAMETER('signature', 'valid when acquisitionProtocol is "direct"')
Iif (!args.revocationOutpoint) throw new sdk.WERR_INVALID_PARAMETER('revocationOutpoint', 'valid when acquisitionProtocol is "direct"')
Iif (!args.keyringRevealer) throw new sdk.WERR_INVALID_PARAMETER('keyringRevealer', 'valid when acquisitionProtocol is "direct"')
Iif (!args.keyringForSubject) throw new sdk.WERR_INVALID_PARAMETER('keyringForSubject', 'valid when acquisitionProtocol is "direct"')
Iif (args.privileged && !args.privilegedReason) throw new sdk.WERR_INVALID_PARAMETER('privilegedReason', `valid when 'privileged' is true `)
const vargs: ValidAcquireDirectCertificateArgs = {
type: validateBase64String(args.type, 'type'),
serialNumber: validateBase64String(args.serialNumber, 'serialNumber'),
certifier: validateHexString(args.certifier, 'certifier'),
revocationOutpoint: validateOutpointString(args.revocationOutpoint, 'revocationOutpoint'),
fields: validateCertificateFields(args.fields),
signature: validateHexString(args.signature, 'signature'),
keyringRevealer: validateKeyringRevealer(args.keyringRevealer, 'keyringRevealer'),
keyringForSubject: validateKeyringForSubject(args.keyringForSubject, 'keyringForSubject'),
privileged: defaultFalse(args.privileged),
privilegedReason: validateOptionalStringLength(args.privilegedReason, 'privilegedReason', 5, 50),
subject: ''
}
return vargs
}
export interface ValidProveCertificateArgs extends ValidWalletSignerArgs {
type?: Base64String
serialNumber?: Base64String
certifier?: PubKeyHex
subject?: PubKeyHex
revocationOutpoint?: OutpointString
signature?: HexString
fieldsToReveal: CertificateFieldNameUnder50Bytes[]
verifier: PubKeyHex
privileged: boolean
privilegedReason?: DescriptionString5to50Bytes
}
export function validateProveCertificateArgs(args: ProveCertificateArgs): ValidProveCertificateArgs {
Iif (args.privileged && !args.privilegedReason) throw new sdk.WERR_INVALID_PARAMETER('privilegedReason', `valid when 'privileged' is true `)
const vargs: ValidProveCertificateArgs = {
type: validateOptionalBase64String(args.certificate.type, 'certificate.type'),
serialNumber: validateOptionalBase64String(args.certificate.serialNumber, 'certificate.serialNumber'),
certifier: validateOptionalHexString(args.certificate.certifier, 'certificate.certifier'),
subject: validateOptionalHexString(args.certificate.subject, 'certificate.subject'),
revocationOutpoint: validateOptionalOutpointString(args.certificate.revocationOutpoint, 'certificate.revocationOutpoint'),
signature: validateOptionalHexString(args.certificate.signature, 'certificate.signature'),
fieldsToReveal: defaultEmpty(args.fieldsToReveal).map(fieldName => validateStringLength(fieldName, `fieldsToReveal ${fieldName}`, 1, 50)),
verifier: validateHexString(args.verifier, 'verifier'),
privileged: defaultFalse(args.privileged),
privilegedReason: validateOptionalStringLength(args.privilegedReason, 'privilegedReason', 5, 50)
}
return vargs
}
export interface ValidDiscoverByIdentityKeyArgs extends ValidWalletSignerArgs {
identityKey: PubKeyHex
limit: PositiveIntegerDefault10Max10000
offset: PositiveIntegerOrZero
seekPermission: boolean
}
export function validateDiscoverByIdentityKeyArgs(args: DiscoverByIdentityKeyArgs): ValidDiscoverByIdentityKeyArgs {
const vargs: ValidDiscoverByIdentityKeyArgs = {
identityKey: validateHexString(args.identityKey, 'identityKey', 66, 66),
limit: validateInteger(args.limit, 'limit', 10, 1, 10000),
offset: validatePositiveIntegerOrZero(defaultZero(args.offset), 'offset'),
seekPermission: defaultFalse(args.seekPermission)
}
return vargs
}
export interface ValidDiscoverByAttributesArgs extends ValidWalletSignerArgs {
attributes: Record<CertificateFieldNameUnder50Bytes, string>
limit: PositiveIntegerDefault10Max10000
offset: PositiveIntegerOrZero
seekPermission: boolean
}
function validateAttributes(attributes: Record<CertificateFieldNameUnder50Bytes, string>): Record<CertificateFieldNameUnder50Bytes, string> {
for (const fieldName of Object.keys(attributes)) {
validateStringLength(fieldName, `field name ${fieldName}`, 1, 50)
}
return attributes
}
export function validateDiscoverByAttributesArgs(args: DiscoverByAttributesArgs): ValidDiscoverByAttributesArgs {
const vargs: ValidDiscoverByAttributesArgs = {
attributes: validateAttributes(args.attributes),
limit: validateInteger(args.limit, 'limit', 10, 1, 10000),
offset: validatePositiveIntegerOrZero(defaultZero(args.offset), 'offset'),
seekPermission: defaultFalse(args.seekPermission)
}
return vargs
}
export interface ValidListOutputsArgs extends ValidWalletSignerArgs {
basket: BasketStringUnder300Bytes
tags: OutputTagStringUnder300Bytes[]
tagQueryMode: 'all' | 'any'
includeLockingScripts: boolean
includeTransactions: boolean
includeCustomInstructions: BooleanDefaultFalse
includeTags: BooleanDefaultFalse
includeLabels: BooleanDefaultFalse
limit: PositiveIntegerDefault10Max10000
offset: PositiveIntegerOrZero
seekPermission: BooleanDefaultTrue
knownTxids: string[]
}
/**
* @param {BasketStringUnder300Bytes} args.basket - Required. The associated basket name whose outputs should be listed.
* @param {OutputTagStringUnder300Bytes[]} [args.tags] - Optional. Filter outputs based on these tags.
* @param {'all' | 'any'} [args.tagQueryMode] - Optional. Filter mode, defining whether all or any of the tags must match. By default, any tag can match.
* @param {'locking scripts' | 'entire transactions'} [args.include] - Optional. Whether to include locking scripts (with each output) or entire transactions (as aggregated BEEF, at the top level) in the result. By default, unless specified, neither are returned.
* @param {BooleanDefaultFalse} [args.includeEntireTransactions] - Optional. Whether to include the entire transaction(s) in the result.
* @param {BooleanDefaultFalse} [args.includeCustomInstructions] - Optional. Whether custom instructions should be returned in the result.
* @param {BooleanDefaultFalse} [args.includeTags] - Optional. Whether the tags associated with the output should be returned.
* @param {BooleanDefaultFalse} [args.includeLabels] - Optional. Whether the labels associated with the transaction containing the output should be returned.
* @param {PositiveIntegerDefault10Max10000} [args.limit] - Optional limit on the number of outputs to return.
* @param {PositiveIntegerOrZero} [args.offset] - Optional. Number of outputs to skip before starting to return results.
* @param {BooleanDefaultTrue} [args.seekPermission] — Optional. Whether to seek permission from the user for this operation if required. Default true, will return an error rather than proceed if set to false.
*/
export function validateListOutputsArgs(args: ListOutputsArgs): ValidListOutputsArgs {
let tagQueryMode: 'any' | 'all'
if (args.tagQueryMode === undefined || args.tagQueryMode === 'any') tagQueryMode = 'any'
else if (args.tagQueryMode === 'all') tagQueryMode = 'all'
else Ethrow new sdk.WERR_INVALID_PARAMETER('tagQueryMode', `undefined, 'any', or 'all'`)
const vargs: ValidListOutputsArgs = {
basket: validateStringLength(args.basket, 'basket', 1, 300),
tags: (args.tags || []).map(t => validateStringLength(t, 'tag', 1, 300)),
tagQueryMode,
includeLockingScripts: args.include === 'locking scripts',
includeTransactions: args.include === 'entire transactions',
includeCustomInstructions: defaultFalse(args.includeCustomInstructions),
includeTags: defaultFalse(args.includeTags),
includeLabels: defaultFalse(args.includeLabels),
limit: validateInteger(args.limit, 'limit', 10, 1, 10000),
offset: validateInteger(args.offset, 'offset', 0, 0, undefined),
seekPermission: defaultTrue(args.seekPermission),
knownTxids: []
}
return vargs
}
export interface ValidListActionsArgs extends ValidWalletSignerArgs {
labels: LabelStringUnder300Bytes[]
labelQueryMode: 'any' | 'all'
includeLabels: BooleanDefaultFalse
includeInputs: BooleanDefaultFalse
includeInputSourceLockingScripts: BooleanDefaultFalse
includeInputUnlockingScripts: BooleanDefaultFalse
includeOutputs: BooleanDefaultFalse
includeOutputLockingScripts: BooleanDefaultFalse
limit: PositiveIntegerDefault10Max10000
offset: PositiveIntegerOrZero
seekPermission: BooleanDefaultTrue
}
/**
* @param {LabelStringUnder300Bytes[]} args.labels - An array of labels used to filter actions.
* @param {'any' | 'all'} [args.labelQueryMode] - Optional. Specifies how to match labels (default is any which matches any of the labels).
* @param {BooleanDefaultFalse} [args.includeLabels] - Optional. Whether to include transaction labels in the result set.
* @param {BooleanDefaultFalse} [args.includeInputs] - Optional. Whether to include input details in the result set.
* @param {BooleanDefaultFalse} [args.includeInputSourceLockingScripts] - Optional. Whether to include input source locking scripts in the result set.
* @param {BooleanDefaultFalse} [args.includeInputUnlockingScripts] - Optional. Whether to include input unlocking scripts in the result set.
* @param {BooleanDefaultFalse} [args.includeOutputs] - Optional. Whether to include output details in the result set.
* @param {BooleanDefaultFalse} [args.includeOutputLockingScripts] - Optional. Whether to include output locking scripts in the result set.
* @param {PositiveIntegerDefault10Max10000} [args.limit] - Optional. The maximum number of transactions to retrieve.
* @param {PositiveIntegerOrZero} [args.offset] - Optional. Number of transactions to skip before starting to return the results.
* @param {BooleanDefaultTrue} [args.seekPermission] — Optional. Whether to seek permission from the user for this operation if required. Default true, will return an error rather than proceed if set to false.
*/
export function validateListActionsArgs(args: ListActionsArgs): ValidListActionsArgs {
let labelQueryMode: 'any' | 'all'
if (args.labelQueryMode === undefined || args.labelQueryMode === 'any') labelQueryMode = 'any'
else if (args.labelQueryMode === 'all') labelQueryMode = 'all'
else Ethrow new sdk.WERR_INVALID_PARAMETER('labelQueryMode', `undefined, 'any', or 'all'`)
const vargs: ValidListActionsArgs = {
labels: (args.labels || []).map(t => validateLabel(t)),
labelQueryMode,
includeLabels: defaultFalse(args.includeLabels),
includeInputs: defaultFalse(args.includeInputs),
includeInputSourceLockingScripts: defaultFalse(args.includeInputSourceLockingScripts),
includeInputUnlockingScripts: defaultFalse(args.includeInputUnlockingScripts),
includeOutputs: defaultFalse(args.includeOutputs),
includeOutputLockingScripts: defaultFalse(args.includeOutputLockingScripts),
limit: validateInteger(args.limit, 'limit', 10, 1, 10000),
offset: validateInteger(args.offset, 'offset', 0, 0, undefined),
seekPermission: defaultTrue(args.seekPermission)
}
return vargs
}
|