@bsv/templates 1.6.0 → 1.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/dist/cjs/mod.js +2 -1
  2. package/dist/cjs/mod.js.map +1 -1
  3. package/dist/cjs/package.json +3 -3
  4. package/dist/cjs/src/MandalaAdmin.js +46 -37
  5. package/dist/cjs/src/MandalaAdmin.js.map +1 -1
  6. package/dist/cjs/src/MandalaToken.js +8 -12
  7. package/dist/cjs/src/MandalaToken.js.map +1 -1
  8. package/dist/cjs/src/mandala-encoding.js +17 -2
  9. package/dist/cjs/src/mandala-encoding.js.map +1 -1
  10. package/dist/cjs/tsconfig.cjs.tsbuildinfo +1 -1
  11. package/dist/esm/mod.js +1 -1
  12. package/dist/esm/mod.js.map +1 -1
  13. package/dist/esm/src/MandalaAdmin.js +45 -37
  14. package/dist/esm/src/MandalaAdmin.js.map +1 -1
  15. package/dist/esm/src/MandalaToken.js +9 -12
  16. package/dist/esm/src/MandalaToken.js.map +1 -1
  17. package/dist/esm/src/mandala-encoding.js +14 -1
  18. package/dist/esm/src/mandala-encoding.js.map +1 -1
  19. package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
  20. package/dist/types/mod.d.ts +2 -2
  21. package/dist/types/mod.d.ts.map +1 -1
  22. package/dist/types/src/MandalaAdmin.d.ts +14 -10
  23. package/dist/types/src/MandalaAdmin.d.ts.map +1 -1
  24. package/dist/types/src/MandalaToken.d.ts.map +1 -1
  25. package/dist/types/src/mandala-encoding.d.ts +4 -1
  26. package/dist/types/src/mandala-encoding.d.ts.map +1 -1
  27. package/dist/types/tsconfig.types.tsbuildinfo +1 -1
  28. package/mod.ts +5 -2
  29. package/package.json +3 -3
  30. package/src/MandalaAdmin.ts +60 -46
  31. package/src/MandalaToken.ts +10 -12
  32. package/src/__tests/MandalaAdmin.derive.test.ts +7 -9
  33. package/src/__tests/MandalaAdmin.script.test.ts +17 -13
  34. package/src/__tests/MandalaAdmin.spend.test.ts +64 -0
  35. package/src/__tests/MandalaToken.test.ts +22 -9
  36. package/src/__tests/mandala-encoding.test.ts +11 -5
  37. package/src/mandala-encoding.ts +12 -2
@@ -4,8 +4,8 @@ import {
4
4
  TransactionSignature, PrivateKey
5
5
  } from '@bsv/sdk'
6
6
  import {
7
- createMinimallyEncodedScriptChunk, encodeScriptNum, decodeScriptNum,
8
- encodeAssetId, decodeAssetId, MARKER
7
+ createMinimallyEncodedScriptChunk, encodeScriptNum, decodeScriptNumChunk,
8
+ encodeAssetId, decodeAssetId
9
9
  } from './mandala-encoding.js'
10
10
  import { buildSighashPreimage } from './mandala-signing.js'
11
11
 
@@ -47,12 +47,12 @@ export class MandalaToken implements ScriptTemplate {
47
47
  if (pubKeyHash.length !== 20) throw new Error('pubKeyHash must be 20 bytes')
48
48
  if (!Number.isInteger(amount) || amount < 1) throw new Error('amount must be a positive integer')
49
49
  const assetIdBytes = encodeAssetId(assetId)
50
+ // assetId + amount are pushed then dropped by a single OP_2DROP; the tail is
51
+ // a standard P2PKH. No identifier prefix — outputs are classified off-chain.
50
52
  return new LockingScript([
51
- createMinimallyEncodedScriptChunk([MARKER]),
52
53
  createMinimallyEncodedScriptChunk(assetIdBytes),
53
54
  createMinimallyEncodedScriptChunk(encodeScriptNum(amount)),
54
55
  { op: OP.OP_2DROP },
55
- { op: OP.OP_DROP },
56
56
  { op: OP.OP_DUP },
57
57
  { op: OP.OP_HASH160 },
58
58
  { op: pubKeyHash.length, data: pubKeyHash },
@@ -85,17 +85,15 @@ export class MandalaToken implements ScriptTemplate {
85
85
 
86
86
  static decode (script: LockingScript): MandalaTokenDecoded {
87
87
  const c = script.chunks
88
- if (c.length !== 10) throw new Error('not a MandalaToken script: wrong chunk count')
89
- const marker = c[0].data ?? []
90
- if (c[0].op !== 1 || marker.length !== 1 || marker[0] !== MARKER) throw new Error('not a MandalaToken script: missing marker')
91
- if (c[3].op !== OP.OP_2DROP || c[4].op !== OP.OP_DROP) throw new Error('not a MandalaToken script: bad drops')
92
- if (c[5].op !== OP.OP_DUP || c[6].op !== OP.OP_HASH160 || c[8].op !== OP.OP_EQUALVERIFY || c[9].op !== OP.OP_CHECKSIG) {
88
+ if (c.length !== 8) throw new Error('not a MandalaToken script: wrong chunk count')
89
+ if (c[2].op !== OP.OP_2DROP) throw new Error('not a MandalaToken script: bad drops')
90
+ if (c[3].op !== OP.OP_DUP || c[4].op !== OP.OP_HASH160 || c[6].op !== OP.OP_EQUALVERIFY || c[7].op !== OP.OP_CHECKSIG) {
93
91
  throw new Error('not a MandalaToken script: bad P2PKH tail')
94
92
  }
95
- const assetId = decodeAssetId(vt(c[1].data))
96
- const amount = decodeScriptNum(c[2].data ?? [])
93
+ const assetId = decodeAssetId(vt(c[0].data))
94
+ const amount = decodeScriptNumChunk(c[1])
97
95
  if (!Number.isInteger(amount) || amount < 1) throw new Error('not a MandalaToken script: bad amount')
98
- const pubKeyHash = vt(c[7].data)
96
+ const pubKeyHash = vt(c[5].data)
99
97
  if (pubKeyHash.length !== 20) throw new Error('not a MandalaToken script: bad pubKeyHash')
100
98
  return { assetId, amount, pubKeyHash }
101
99
  }
@@ -1,4 +1,4 @@
1
- import { MandalaAdmin } from '../MandalaAdmin.js'
1
+ import { MandalaAdmin, ADMIN_PROTOCOL } from '../MandalaAdmin.js'
2
2
 
3
3
  describe('MandalaAdmin canonicalize/commitment', () => {
4
4
  it('is insensitive to key ordering', () => {
@@ -18,17 +18,15 @@ describe('MandalaAdmin canonicalize/commitment', () => {
18
18
  expect(c).toBe(MandalaAdmin.commitment({ assetId: 'x.0', kind: 'register' } as any))
19
19
  })
20
20
 
21
- it('derives a boundKey via getPublicKey with counterparty anyone', async () => {
21
+ it('locks the output to keyID = commitment(data) with counterparty self by default', async () => {
22
22
  const calls: any[] = []
23
23
  const wallet: any = {
24
24
  getPublicKey: async (args: any) => { calls.push(args); return { publicKey: '02' + 'a'.repeat(64) } }
25
25
  }
26
- const admin = new MandalaAdmin(wallet)
27
- const details = { kind: 'issue', assetId: 'x.0', amount: 10 } as const
28
- const { boundKey, keyID } = await admin.deriveBoundKey([2, 'mandala admin'], details)
29
- expect(boundKey).toBe('02' + 'a'.repeat(64))
30
- expect(keyID).toBe(MandalaAdmin.commitment(details))
31
- expect(calls[0].counterparty).toBe('anyone')
32
- expect(calls[0].keyID).toBe(keyID)
26
+ const data = { kind: 'issue', assetId: 'x.0', amount: 10 } as const
27
+ await MandalaAdmin.lock({ wallet, data })
28
+ expect(calls[0].protocolID).toEqual(ADMIN_PROTOCOL)
29
+ expect(calls[0].keyID).toBe(MandalaAdmin.commitment(data))
30
+ expect(calls[0].counterparty).toBe('self')
33
31
  })
34
32
  })
@@ -1,26 +1,30 @@
1
1
  import { MandalaAdmin } from '../MandalaAdmin.js'
2
- import { PrivateKey, OP } from '@bsv/sdk'
2
+ import { ProtoWallet, PrivateKey, OP } from '@bsv/sdk'
3
3
 
4
4
  describe('MandalaAdmin lock/decode', () => {
5
- it('round-trips the boundKey and has the ! OP_DROP <key> OP_CHECKSIG shape', () => {
6
- const boundKey = PrivateKey.fromRandom().toPublicKey().toString()
7
- const admin = new MandalaAdmin({} as any)
8
- const script = admin.lock(boundKey)
5
+ const wallet = new ProtoWallet(PrivateKey.fromRandom())
6
+ const data = { kind: 'register', assetId: `${'a'.repeat(64)}.0` } as const
7
+
8
+ it('builds a standard P2PKH script (OP_DUP OP_HASH160 <20> OP_EQUALVERIFY OP_CHECKSIG)', async () => {
9
+ const script = await MandalaAdmin.lock({ wallet: wallet as any, data })
9
10
  const ops = script.chunks.map(c => c.op)
10
- expect(script.chunks[0].data).toEqual([0x21])
11
- expect(ops[1]).toBe(OP.OP_DROP)
12
- expect(ops[3]).toBe(OP.OP_CHECKSIG)
13
- expect(MandalaAdmin.decode(script).boundKey).toBe(boundKey)
11
+ expect(ops).toEqual([OP.OP_DUP, OP.OP_HASH160, 20, OP.OP_EQUALVERIFY, OP.OP_CHECKSIG])
12
+ expect(script.chunks[2].data?.length).toBe(20)
13
+ })
14
+
15
+ it('decode returns the pubKeyHash', async () => {
16
+ const script = await MandalaAdmin.lock({ wallet: wallet as any, data })
17
+ const decoded = MandalaAdmin.decode(script)
18
+ expect(decoded.pubKeyHash).toEqual(script.chunks[2].data)
14
19
  })
15
20
 
16
21
  it('decode throws on non-admin scripts', () => {
17
22
  expect(() => MandalaAdmin.decode({ chunks: [{ op: 0x00 }] } as any)).toThrow()
18
23
  })
19
24
 
20
- it('decode rejects a non-minimal (PUSHDATA1) marker encoding', () => {
21
- const boundKey = PrivateKey.fromRandom().toPublicKey().toString()
22
- const script = new MandalaAdmin({} as any).lock(boundKey)
23
- script.chunks[0] = { op: 0x4c, data: [0x21] }
25
+ it('decode throws when the hash push is not 20 bytes', async () => {
26
+ const script = await MandalaAdmin.lock({ wallet: wallet as any, data })
27
+ script.chunks[2] = { op: 19, data: new Array(19).fill(1) }
24
28
  expect(() => MandalaAdmin.decode(script)).toThrow()
25
29
  })
26
30
  })
@@ -0,0 +1,64 @@
1
+ import { MandalaAdmin } from '../MandalaAdmin.js'
2
+ import { ProtoWallet, PrivateKey, Transaction, Spend, LockingScript, OP } from '@bsv/sdk'
3
+
4
+ // End-to-end script test: a P2PKH admin-auth output locked by MandalaAdmin.lock
5
+ // must be spendable by MandalaAdmin.unlock. The lock hashes the counterparty-child
6
+ // public key (forSelf:false); unlock signs with the matching private key and pushes
7
+ // its forSelf:true public key. By BRC-42 symmetry these are the same point, so
8
+ // OP_HASH160 / OP_CHECKSIG pass — for self-spend and for transfer to a new admin.
9
+ describe('MandalaAdmin spend round-trip (interpreter)', () => {
10
+ const data = { kind: 'issue', assetId: `${'a'.repeat(64)}.0`, amount: 5 } as const
11
+
12
+ const buildSpend = (lock: LockingScript, unlock: any, spendTx: Transaction, srcTx: Transaction): Spend =>
13
+ new Spend({
14
+ sourceTXID: srcTx.id('hex'),
15
+ sourceOutputIndex: 0,
16
+ sourceSatoshis: 1,
17
+ lockingScript: lock,
18
+ transactionVersion: spendTx.version,
19
+ otherInputs: [],
20
+ inputIndex: 0,
21
+ unlockingScript: unlock,
22
+ outputs: spendTx.outputs,
23
+ inputSequence: 0xffffffff,
24
+ lockTime: spendTx.lockTime
25
+ })
26
+
27
+ it('CHECKSIG verifies a self-locked, self-spent admin auth output', async () => {
28
+ const wallet = new ProtoWallet(PrivateKey.fromRandom())
29
+ const lock = await MandalaAdmin.lock({ wallet: wallet as any, data })
30
+
31
+ const srcTx = new Transaction()
32
+ srcTx.addOutput({ lockingScript: lock, satoshis: 1 })
33
+ const spendTx = new Transaction()
34
+ spendTx.addInput({ sourceTransaction: srcTx, sourceOutputIndex: 0, sequence: 0xffffffff })
35
+ spendTx.addOutput({ lockingScript: new LockingScript([{ op: OP.OP_TRUE }]), satoshis: 1 })
36
+
37
+ spendTx.inputs[0].unlockingScriptTemplate = MandalaAdmin.unlock({ wallet: wallet as any, data })
38
+ await spendTx.sign()
39
+
40
+ expect(buildSpend(lock, spendTx.inputs[0].unlockingScript!, spendTx, srcTx).validate()).toBe(true)
41
+ })
42
+
43
+ it('transfers admin: granter locks to a new admin who spends it', async () => {
44
+ const granter = new ProtoWallet(PrivateKey.fromRandom())
45
+ const newAdmin = new ProtoWallet(PrivateKey.fromRandom())
46
+ const { publicKey: granterId } = await granter.getPublicKey({ identityKey: true })
47
+ const { publicKey: newAdminId } = await newAdmin.getPublicKey({ identityKey: true })
48
+
49
+ // Granter locks the auth output to the new admin (counterparty = new admin id).
50
+ const lock = await MandalaAdmin.lock({ wallet: granter as any, data, counterparty: newAdminId })
51
+
52
+ const srcTx = new Transaction()
53
+ srcTx.addOutput({ lockingScript: lock, satoshis: 1 })
54
+ const spendTx = new Transaction()
55
+ spendTx.addInput({ sourceTransaction: srcTx, sourceOutputIndex: 0, sequence: 0xffffffff })
56
+ spendTx.addOutput({ lockingScript: new LockingScript([{ op: OP.OP_TRUE }]), satoshis: 1 })
57
+
58
+ // New admin spends, deriving against the granter's identity.
59
+ spendTx.inputs[0].unlockingScriptTemplate = MandalaAdmin.unlock({ wallet: newAdmin as any, data, counterparty: granterId })
60
+ await spendTx.sign()
61
+
62
+ expect(buildSpend(lock, spendTx.inputs[0].unlockingScript!, spendTx, srcTx).validate()).toBe(true)
63
+ })
64
+ })
@@ -13,6 +13,22 @@ describe('MandalaToken lock/decode', () => {
13
13
  expect(decoded.pubKeyHash).toEqual(pubKeyHash)
14
14
  })
15
15
 
16
+ // Regression: amounts 1..16 are minimally encoded as OP_1..OP_16 opcodes (no
17
+ // data bytes) by createMinimallyEncodedScriptChunk. decode must read those
18
+ // back, not mis-read them as 0 and reject the script as a bad amount.
19
+ it('round-trips small amounts encoded as OP_N opcodes (1..16)', () => {
20
+ for (let amount = 1; amount <= 16; amount++) {
21
+ const script = new MandalaToken().lock(assetId, amount, pubKeyHash)
22
+ const decoded = MandalaToken.decode(script)
23
+ expect(decoded.amount).toBe(amount)
24
+ }
25
+ })
26
+
27
+ it('round-trips the boundary amount 17 (first data-push encoding)', () => {
28
+ const decoded = MandalaToken.decode(new MandalaToken().lock(assetId, 17, pubKeyHash))
29
+ expect(decoded.amount).toBe(17)
30
+ })
31
+
16
32
  it('produces a P2PKH tail (OP_DUP OP_HASH160 ... OP_EQUALVERIFY OP_CHECKSIG)', () => {
17
33
  const script = new MandalaToken().lock(assetId, 1, pubKeyHash)
18
34
  const ops = script.chunks.map(c => c.op)
@@ -27,17 +43,14 @@ describe('MandalaToken lock/decode', () => {
27
43
  const assetId = `${'a'.repeat(64)}.0`
28
44
  const pkh = new Array(20).fill(1)
29
45
  const script = new MandalaToken().lock(assetId, 5, pkh)
30
- // Replace the amount push (chunk index 2) with an empty (OP_0) push.
31
- script.chunks[2] = { op: 0 }
46
+ // Replace the amount push (chunk index 1) with an empty (OP_0) push.
47
+ script.chunks[1] = { op: 0 }
32
48
  expect(() => MandalaToken.decode(script)).toThrow()
33
49
  })
34
50
 
35
- it('decode rejects a non-minimal (PUSHDATA1) marker encoding', () => {
36
- const assetId = `${'a'.repeat(64)}.0`
37
- const pkh = new Array(20).fill(1)
38
- const script = new MandalaToken().lock(assetId, 5, pkh)
39
- // Re-encode the marker push (chunk 0) as PUSHDATA1 of the same byte.
40
- script.chunks[0] = { op: 0x4c, data: [0x21] }
41
- expect(() => MandalaToken.decode(script)).toThrow()
51
+ it('has no identifier prefix (8 chunks, leads with the assetId push)', () => {
52
+ const script = new MandalaToken().lock(assetId, 1, pubKeyHash)
53
+ expect(script.chunks).toHaveLength(8)
54
+ expect(script.chunks[0].data?.length).toBe(36) // assetId bytes, not a marker
42
55
  })
43
56
  })
@@ -1,5 +1,6 @@
1
1
  import {
2
- encodeScriptNum, decodeScriptNum, encodeAssetId, decodeAssetId, MARKER
2
+ createMinimallyEncodedScriptChunk, encodeScriptNum, decodeScriptNum,
3
+ decodeScriptNumChunk, encodeAssetId, decodeAssetId
3
4
  } from '../mandala-encoding'
4
5
 
5
6
  describe('mandala-encoding', () => {
@@ -9,6 +10,15 @@ describe('mandala-encoding', () => {
9
10
  }
10
11
  })
11
12
 
13
+ it('decodeScriptNumChunk reads both OP_N opcodes and data pushes', () => {
14
+ // -1, 0 and 1..16 collapse to opcodes with no data; decodeScriptNumChunk
15
+ // must recover them, and still read larger data-push amounts.
16
+ for (const n of [-1, 0, 1, 2, 15, 16, 17, 100, 1000, 0x7fffffff]) {
17
+ const chunk = createMinimallyEncodedScriptChunk(encodeScriptNum(n))
18
+ expect(decodeScriptNumChunk(chunk)).toBe(n)
19
+ }
20
+ })
21
+
12
22
  it('encodes zero as an empty array', () => {
13
23
  expect(encodeScriptNum(0)).toEqual([])
14
24
  })
@@ -25,8 +35,4 @@ describe('mandala-encoding', () => {
25
35
  const assetId = `${'a'.repeat(64)}.4294967295`
26
36
  expect(decodeAssetId(encodeAssetId(assetId))).toBe(assetId)
27
37
  })
28
-
29
- it('exposes the ! marker', () => {
30
- expect(MARKER).toBe(0x21)
31
- })
32
38
  })
@@ -1,7 +1,5 @@
1
1
  import { Utils } from '@bsv/sdk'
2
2
 
3
- export const MARKER = 0x21
4
-
5
3
  export const createMinimallyEncodedScriptChunk = (
6
4
  data: number[]
7
5
  ): { op: number, data?: number[] } => {
@@ -43,6 +41,18 @@ export const decodeScriptNum = (data: number[]): number => {
43
41
  return result
44
42
  }
45
43
 
44
+ // Reads a Bitcoin script number from a chunk that may be either a data push or a
45
+ // minimally-encoded small-integer opcode. createMinimallyEncodedScriptChunk
46
+ // collapses 0, -1 and 1..16 to OP_0 / OP_1NEGATE / OP_1..OP_16 (no data bytes),
47
+ // so a decoder that only reads chunk.data would mis-read those as 0. This reads
48
+ // both encodings symmetrically.
49
+ export const decodeScriptNumChunk = (chunk: { op: number, data?: number[] }): number => {
50
+ if (chunk.op === 0) return 0 // OP_0 / OP_FALSE
51
+ if (chunk.op === 0x4f) return -1 // OP_1NEGATE
52
+ if (chunk.op >= 0x51 && chunk.op <= 0x60) return chunk.op - 0x50 // OP_1..OP_16
53
+ return decodeScriptNum(chunk.data ?? [])
54
+ }
55
+
46
56
  export const encodeAssetId = (assetId: string): number[] => {
47
57
  const dot = assetId.lastIndexOf('.')
48
58
  if (dot === -1) throw new Error('assetId must be "<txid>.<vout>"')