Class ConvictionApi

Index

Constructors

Methods

abstain drop flip hold positionOf quorumWeight tally

Constructors

constructor

new ConvictionApi(): ConvictionApi
Returns ConvictionApi

Methods

`Static`abstain

abstain(
    subject: string,
    stock: Stock,
    target: string,
    now?: number,
): Promise<void>
Abstain on {stock, target} — a present, net-zero position. Distinct from drop (not voting / absent): an abstain counts toward quorum at the holder's full standing (see quorumWeight) while contributing 0 to the decision. Lets a heavyweight decline to take a side without starving quorum.
Parameters
- subject: string
- stock: Stock
- target: string
- Optionalnow: number
Returns Promise<void>
- Defined in packages/server/src/mud/api/conviction.ts:89

`Static`drop

drop(subject: string, stock: Stock, target: string): Promise<void>
Drop a held position entirely (delete the row).
Parameters
- subject: string
- stock: Stock
- target: string
Returns Promise<void>
- Defined in packages/server/src/mud/api/conviction.ts:109

`Static`flip

flip(subject: string, stock: Stock, target: string, now?: number): Promise<void>
Reverse a held position (swap yea/nay) and reset its conviction clock.
Parameters
- subject: string
- stock: Stock
- target: string
- Optionalnow: number
Returns Promise<void>
- Defined in packages/server/src/mud/api/conviction.ts:99

`Static`hold

hold(
    subject: string,
    stock: Stock,
    target: string,
    split: { nay: number; yea: number },
    now?: number,
): Promise<void>
Establish or update a holder's position on {stock, target} with a {yea, nay} split (full support is {yea:1, nay:0}). A new position, or a net-direction flip, (re)starts the conviction clock; a same-direction re-hold keeps building. subject is the holder's durable templatePath.
Parameters
- subject: string
- stock: Stock
- target: string
- split: { nay: number; yea: number }
- Optionalnow: number
Returns Promise<void>
- Defined in packages/server/src/mud/api/conviction.ts:72

`Static`positionOf

positionOf(
    subject: string,
    stock: Stock,
    target: string,
    now?: number,
): Promise<ConvictionPosition | null>
Read a holder's position on {stock, target} with its derived conviction ramp at now; null if none is held.
Parameters
- subject: string
- stock: Stock
- target: string
- Optionalnow: number
Returns Promise<ConvictionPosition | null>
- Defined in packages/server/src/mud/api/conviction.ts:121

`Static`quorumWeight

quorumWeight(stock: Stock, target: string): Promise<number>
The quorum weight cast on {stock, target} — Σ standingOf(holder, stock).scalar over every present position (directional or abstain). The participation numerator a passage rule measures against the total possible. Conviction-independent and undirected: showing up counts at full standing; not voting (no position) does not.
Parameters
- stock: Stock
- target: string
Returns Promise<number>
- Defined in packages/server/src/mud/api/conviction.ts:149

`Static`tally

tally(stock: Stock, target: string, now?: number): Promise<ConvictionTally>
Tally held conviction on {stock, target} — the per-house bill number: Σ standingOf(holder, stock).scalar × conviction × (yea − nay).
Parameters
- stock: Stock
- target: string
- Optionalnow: number
Returns Promise<ConvictionTally>
- Defined in packages/server/src/mud/api/conviction.ts:134