|
| 1 | +import assert from 'assert'; |
| 2 | + |
| 3 | +import * as utxolib from '@bitgo/utxo-lib'; |
| 4 | +import * as bitcoinMessage from 'bitcoinjs-message'; |
| 5 | +import { decodeProprietaryKey } from 'bip174/src/lib/proprietaryKeyVal'; |
| 6 | +import { KeyValue } from 'bip174/src/lib/interfaces'; |
| 7 | +import { checkForOutput } from 'bip174/src/lib/utils'; |
| 8 | + |
| 9 | +import { |
| 10 | + addPaygoAddressProof, |
| 11 | + getPaygoAddressProofOutputIndex, |
| 12 | + psbtOutputIncludesPaygoAddressProof, |
| 13 | + verifyPaygoAddressProof, |
| 14 | +} from '../../../src/paygo/psbt/PayGoUtils'; |
| 15 | +import { generatePayGoAttestationProof } from '../../../src/testutil/generatePayGoAttestationProof.utils'; |
| 16 | + |
| 17 | +// To construct our PSBTs |
| 18 | +const network = utxolib.networks.bitcoin; |
| 19 | +const keys = [1, 2, 3].map((v) => utxolib.bip32.fromSeed(Buffer.alloc(16, `test/2/${v}`), network)); |
| 20 | +const rootWalletKeys = new utxolib.bitgo.RootWalletKeys([keys[0], keys[1], keys[2]]); |
| 21 | + |
| 22 | +// PSBT INPUTS AND OUTPUTS |
| 23 | +const psbtInputs = utxolib.testutil.inputScriptTypes.map((scriptType) => ({ |
| 24 | + scriptType, |
| 25 | + value: BigInt(1000), |
| 26 | +})); |
| 27 | +const psbtOutputs = utxolib.testutil.outputScriptTypes.map((scriptType) => ({ |
| 28 | + scriptType, |
| 29 | + value: BigInt(900), |
| 30 | +})); |
| 31 | + |
| 32 | +// wallet pub and priv key for tbtc |
| 33 | +const dummyPub1 = rootWalletKeys.deriveForChainAndIndex(50, 200); |
| 34 | +const attestationPubKey = dummyPub1.user.publicKey; |
| 35 | +const attestationPrvKey = dummyPub1.user.privateKey!; |
| 36 | + |
| 37 | +// UUID structure |
| 38 | +const nilUUID = '00000000-0000-0000-0000-000000000000'; |
| 39 | + |
| 40 | +// our xpub converted to base58 address |
| 41 | +const addressToVerify = utxolib.address.toBase58Check( |
| 42 | + utxolib.crypto.hash160(Buffer.from(dummyPub1.backup.publicKey)), |
| 43 | + utxolib.networks.bitcoin.pubKeyHash, |
| 44 | + utxolib.networks.bitcoin |
| 45 | +); |
| 46 | + |
| 47 | +// this should be retuning a Buffer |
| 48 | +const addressProofBuffer = generatePayGoAttestationProof(nilUUID, Buffer.from(addressToVerify)); |
| 49 | +// signature with the given msg addressProofBuffer |
| 50 | +const sig = bitcoinMessage.sign(addressProofBuffer, attestationPrvKey!, true, network.messagePrefix); |
| 51 | + |
| 52 | +function getTestPsbt() { |
| 53 | + return utxolib.testutil.constructPsbt(psbtInputs, psbtOutputs, network, rootWalletKeys, 'unsigned'); |
| 54 | +} |
| 55 | + |
| 56 | +describe('addPaygoAddressProof and verifyPaygoAddressProof', () => { |
| 57 | + function getPaygoProprietaryKey(proprietaryKeyVals: KeyValue[]) { |
| 58 | + return proprietaryKeyVals |
| 59 | + .map(({ key, value }) => { |
| 60 | + return { key: decodeProprietaryKey(key), value }; |
| 61 | + }) |
| 62 | + .filter((keyValue) => { |
| 63 | + return ( |
| 64 | + keyValue.key.identifier === utxolib.bitgo.PSBT_PROPRIETARY_IDENTIFIER && |
| 65 | + keyValue.key.subtype === utxolib.bitgo.ProprietaryKeySubtype.PAYGO_ADDRESS_ATTESTATION_PROOF |
| 66 | + ); |
| 67 | + }); |
| 68 | + } |
| 69 | + |
| 70 | + it("should fail a proof verification if the proof isn't valid", () => { |
| 71 | + const outputIndex = 0; |
| 72 | + const psbt = getTestPsbt(); |
| 73 | + addPaygoAddressProof(psbt, outputIndex, sig, Buffer.from(attestationPubKey)); |
| 74 | + const output = checkForOutput(psbt.data.outputs, outputIndex); |
| 75 | + const proofInPsbt = getPaygoProprietaryKey(output.unknownKeyVals!); |
| 76 | + assert(proofInPsbt.length === 1); |
| 77 | + assert.throws( |
| 78 | + () => verifyPaygoAddressProof(psbt, 0, Buffer.from('Random Signed Message'), attestationPubKey), |
| 79 | + (e: any) => e.message === 'Cannot verify the paygo address signature with the provided pubkey.' |
| 80 | + ); |
| 81 | + }); |
| 82 | + |
| 83 | + it('should add and verify a valid paygo address proof on the PSBT', () => { |
| 84 | + const psbt = getTestPsbt(); |
| 85 | + psbt.addOutput({ script: utxolib.address.toOutputScript(addressToVerify, network), value: BigInt(10000) }); |
| 86 | + const outputIndex = psbt.data.outputs.length - 1; |
| 87 | + addPaygoAddressProof(psbt, outputIndex, sig, Buffer.from(attestationPubKey)); |
| 88 | + verifyPaygoAddressProof(psbt, outputIndex, Buffer.from(addressProofBuffer), attestationPubKey); |
| 89 | + }); |
| 90 | + |
| 91 | + it('should throw an error if there are multiple PayGo proprietary keys in the PSBT', () => { |
| 92 | + const outputIndex = 0; |
| 93 | + const psbt = getTestPsbt(); |
| 94 | + addPaygoAddressProof(psbt, outputIndex, sig, Buffer.from(attestationPubKey)); |
| 95 | + addPaygoAddressProof(psbt, outputIndex, Buffer.from('signature2'), Buffer.from('fakepubkey2s')); |
| 96 | + const output = checkForOutput(psbt.data.outputs, outputIndex); |
| 97 | + const proofInPsbt = getPaygoProprietaryKey(output.unknownKeyVals!); |
| 98 | + assert(proofInPsbt.length !== 0); |
| 99 | + assert(proofInPsbt.length > 1); |
| 100 | + assert.throws( |
| 101 | + () => verifyPaygoAddressProof(psbt, outputIndex, addressProofBuffer, attestationPubKey), |
| 102 | + (e: any) => e.message === 'There are multiple paygo address proofs encoded in the PSBT. Something went wrong.' |
| 103 | + ); |
| 104 | + }); |
| 105 | +}); |
| 106 | + |
| 107 | +describe('verifyPaygoAddressProof', () => { |
| 108 | + it('should throw an error if there is no PayGo address in PSBT', () => { |
| 109 | + const psbt = getTestPsbt(); |
| 110 | + assert.throws( |
| 111 | + () => verifyPaygoAddressProof(psbt, 0, addressProofBuffer, attestationPubKey), |
| 112 | + (e: any) => e.message === 'There is no paygo address proof encoded in the PSBT at output 0.' |
| 113 | + ); |
| 114 | + }); |
| 115 | +}); |
| 116 | + |
| 117 | +describe('getPaygoAddressProofIndex', () => { |
| 118 | + it('should get PayGo address proof index from PSBT if there is one', () => { |
| 119 | + const psbt = getTestPsbt(); |
| 120 | + const outputIndex = 0; |
| 121 | + addPaygoAddressProof(psbt, outputIndex, sig, Buffer.from(attestationPubKey)); |
| 122 | + assert(psbtOutputIncludesPaygoAddressProof(psbt)); |
| 123 | + assert(getPaygoAddressProofOutputIndex(psbt) === 0); |
| 124 | + }); |
| 125 | + |
| 126 | + it('should return undefined if there is no PayGo address proof in PSBT', () => { |
| 127 | + const psbt = getTestPsbt(); |
| 128 | + assert(getPaygoAddressProofOutputIndex(psbt) === undefined); |
| 129 | + assert(!psbtOutputIncludesPaygoAddressProof(psbt)); |
| 130 | + }); |
| 131 | + |
| 132 | + it('should return an error and fail if we have multiple PayGo address in the PSBT in the same output index', () => { |
| 133 | + const psbt = getTestPsbt(); |
| 134 | + const outputIndex = 0; |
| 135 | + addPaygoAddressProof(psbt, outputIndex, sig, Buffer.from(attestationPubKey)); |
| 136 | + addPaygoAddressProof(psbt, outputIndex, sig, Buffer.from('xpub12345abcdef29a028510d3b2d4')); |
| 137 | + assert.throws( |
| 138 | + () => getPaygoAddressProofOutputIndex(psbt), |
| 139 | + (e: any) => e.message === 'There are multiple PayGo addresses in the PSBT output 0.' |
| 140 | + ); |
| 141 | + }); |
| 142 | +}); |
0 commit comments