mirror of
https://github.com/Permissionless-Software-Foundation/psf-memo.git
synced 2026-09-21 16:52:01 -07:00
Chris Troutner
2e2db86263
Reply, topic message, add-poll-option, poll-vote, and create-poll now broadcast each protocol field as its own OP_RETURN script push instead of combining them into one push. The indexer requires three pushes for reply, topic message, and poll children, and accepts four for create-poll; the combined form was rejected or misparsed. hex.js builds the txid and text as separate pushes, and a new memo-multipush adapter teaches minimal-slp-wallet's single-push sendOpReturn to expand an array of fields into separate pushes. Acceptance step handlers assert the individual pushes, and unit/property tests cover the new shape. By coder.
107 lines
4.2 KiB
JavaScript
107 lines
4.2 KiB
JavaScript
/*
|
|
Memo create-poll behavior: compose, validate, and broadcast a Memo create-poll
|
|
action (0x6d10).
|
|
|
|
A create-poll transaction carries the Memo create-poll protocol prefix
|
|
followed by a poll_type byte, an option_count byte, and the question text.
|
|
The question is limited to 209 bytes.
|
|
|
|
The wallet and an injected poll store are used so this module stays testable
|
|
and free of UI/network concerns; environmentally unsuitable I/O lives behind
|
|
those small adapter boundaries.
|
|
|
|
Constants
|
|
MEMO_CREATE_POLL_PREFIX : hex prefix for the Memo create-poll action (0x6d10)
|
|
MAX_QUESTION_BYTES : maximum question byte length (209)
|
|
DEFAULT_POLL_TYPE : default poll type byte (1)
|
|
*/
|
|
|
|
const MemoAction = require('./memo-action')
|
|
const { byteLength } = require('./utf8')
|
|
|
|
const MEMO_CREATE_POLL_PREFIX = '6d10'
|
|
const MAX_QUESTION_BYTES = 209
|
|
const DEFAULT_POLL_TYPE = 1
|
|
|
|
class MemoPollCreate extends MemoAction {
|
|
static config = {
|
|
prefix: MEMO_CREATE_POLL_PREFIX,
|
|
walletRequiredMsg: 'Memo poll create requires a wallet.',
|
|
lengthMessage: `Poll question is too long. Maximum is ${MAX_QUESTION_BYTES} bytes.`,
|
|
emptyMessage: 'Poll question must not be empty.',
|
|
lengthCode: 'poll_create_length',
|
|
validationCode: 'poll_create_validation'
|
|
}
|
|
|
|
constructor (deps = {}) {
|
|
super(deps)
|
|
this.pollType = deps.pollType ?? DEFAULT_POLL_TYPE
|
|
this.polls = deps.polls || null
|
|
}
|
|
|
|
// A poll question is over-length when its UTF-8 byte count exceeds the limit.
|
|
isTooLong (question) {
|
|
return byteLength(question) > MAX_QUESTION_BYTES
|
|
}
|
|
|
|
// Compose and broadcast a Memo create-poll action.
|
|
async create (question, optionCount) {
|
|
const check = this.validate(question)
|
|
this._throwIfInvalid(check)
|
|
|
|
const count = parseInt(optionCount, 10)
|
|
if (Number.isNaN(count) || count < 1) {
|
|
const err = new Error('Poll option count must be a positive number.')
|
|
err.code = 'poll_create_validation'
|
|
throw err
|
|
}
|
|
|
|
if (!this.wallet) {
|
|
throw new Error(this.walletRequiredMsg)
|
|
}
|
|
|
|
await this.wallet.getUtxos()
|
|
|
|
const pushes = buildCreatePollPushes(question, this.pollType, count)
|
|
const txid = await this.wallet.sendOpReturn(pushes, this.prefix)
|
|
|
|
this.reflect(txid, question, count)
|
|
|
|
return txid
|
|
}
|
|
|
|
// Record the new poll on the injected poll store when one is present.
|
|
reflect (txid, question, optionCount) {
|
|
if (this.polls && typeof this.polls.addPoll === 'function') {
|
|
this.polls.addPoll({
|
|
txid,
|
|
address: this.wallet.walletInfo.cashAddress,
|
|
question,
|
|
optionCount,
|
|
pollType: this.pollType
|
|
})
|
|
}
|
|
}
|
|
}
|
|
|
|
// Build the separate OP_RETURN pushes for a create-poll action: the poll type
|
|
// byte, the option count byte, and the UTF-8 question, each as its own push.
|
|
function buildCreatePollPushes (question, pollType, optionCount) {
|
|
const textBytes = new TextEncoder().encode(question)
|
|
return [
|
|
Uint8Array.from([pollType & 0xff]),
|
|
Uint8Array.from([optionCount & 0xff]),
|
|
textBytes
|
|
]
|
|
}
|
|
|
|
MemoPollCreate.MEMO_CREATE_POLL_PREFIX = MEMO_CREATE_POLL_PREFIX
|
|
MemoPollCreate.MAX_QUESTION_BYTES = MAX_QUESTION_BYTES
|
|
MemoPollCreate.DEFAULT_POLL_TYPE = DEFAULT_POLL_TYPE
|
|
|
|
module.exports = MemoPollCreate
|
|
|
|
// mutate4javascript-manifest-begin
|
|
// {"version":1,"tested_at":"2026-08-28T22:45:49.496Z","module_hash":"3455852bee199b40530bbbe787f85429a7a15bf0116989231ac06f9ca9eadf36","functions":[{"id":"func/MemoPollCreate.constructor","name":"MemoPollCreate.constructor","line":36,"end_line":40,"hash":"9404cf1f0df5cc8756e0ea24abab27ade844fa461f84818162faac807b838dd1"},{"id":"func/MemoPollCreate.isTooLong","name":"MemoPollCreate.isTooLong","line":43,"end_line":45,"hash":"ca9087a454f1fba64ac35738a037372ade36ba6d4c2270d2025adc00b860412c"},{"id":"func/MemoPollCreate.create","name":"MemoPollCreate.create","line":48,"end_line":71,"hash":"b5e769b07f3795a5db0d4202106f4b25b5a0b69e30e70491a7a9c2ac52085fce"},{"id":"func/MemoPollCreate.reflect","name":"MemoPollCreate.reflect","line":74,"end_line":84,"hash":"ec559b778b279c1efb46bdb2440a0c197dae242052d7c1ebf5331078258b719f"},{"id":"func/buildCreatePollPayload","name":"buildCreatePollPayload","line":89,"end_line":96,"hash":"f5abdaad00f9e3c857c65766a981d6971e1bc7c64e0200cbb4105ab798bd94da"}]}
|
|
// mutate4javascript-manifest-end
|