Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/floppy-cycles-teach.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@evolution-sdk/devnet": patch
"@evolution-sdk/evolution": patch
---

Add propose and vote APIs: introduce new operations for creating governance proposals and casting votes, including supporting types, procedures, and validators.
23 changes: 23 additions & 0 deletions docs/content/docs/modules/core/ProposalProcedures.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ parent: Modules
- [encoding](#encoding)
- [toCBORBytes](#tocborbytes)
- [toCBORHex](#tocborhex)
- [helpers](#helpers)
- [single](#single)
- [model](#model)
- [ProposalProcedures (class)](#proposalprocedures-class)
- [toJSON (method)](#tojson-method)
Expand Down Expand Up @@ -73,6 +75,27 @@ export declare const toCBORHex: (data: ProposalProcedures, options?: CBOR.CodecO

Added in v2.0.0

# helpers

## single

Create ProposalProcedures for a single proposal.

Convenience function for the common case of submitting one governance action.

**Signature**

```ts
export declare const single: (
deposit: Coin.Coin,
rewardAccount: RewardAccount.RewardAccount,
governanceAction: GovernanceAction.GovernanceAction,
anchor: Anchor.Anchor | null
) => ProposalProcedures
```

Added in v2.0.0

# model

## ProposalProcedures (class)
Expand Down
40 changes: 40 additions & 0 deletions docs/content/docs/modules/core/VotingProcedures.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ parent: Modules
- [encoding](#encoding)
- [toCBORBytes](#tocborbytes)
- [toCBORHex](#tocborhex)
- [helpers](#helpers)
- [multiVote](#multivote)
- [singleVote](#singlevote)
- [model](#model)
- [VotingProcedures (class)](#votingprocedures-class)
- [toJSON (method)](#tojson-method)
Expand Down Expand Up @@ -178,6 +181,43 @@ export declare const toCBORHex: (data: VotingProcedures, options?: CBOR.CodecOpt

Added in v2.0.0

# helpers

## multiVote

Create VotingProcedures for one voter voting on multiple proposals.

Convenience function for submitting multiple votes from a single voter.

**Signature**

```ts
export declare const multiVote: (
voter: Voter,
votes: ReadonlyArray<readonly [GovernanceAction.GovActionId, VotingProcedure]>
) => VotingProcedures
```

Added in v2.0.0

## singleVote

Create VotingProcedures for a single vote.

Convenience function for the common case of one voter voting on one proposal.

**Signature**

```ts
export declare const singleVote: (
voter: Voter,
govActionId: GovernanceAction.GovActionId,
procedure: VotingProcedure
) => VotingProcedures
```

Added in v2.0.0

# model

## VotingProcedures (class)
Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/sdk/Credential.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: sdk/Credential.ts
nav_order: 185
nav_order: 187
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/sdk/Datum.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: sdk/Datum.ts
nav_order: 186
nav_order: 188
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/sdk/Delegation.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: sdk/Delegation.ts
nav_order: 187
nav_order: 189
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/sdk/EvalRedeemer.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: sdk/EvalRedeemer.ts
nav_order: 188
nav_order: 190
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/sdk/Network.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: sdk/Network.ts
nav_order: 189
nav_order: 191
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/sdk/OutRef.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: sdk/OutRef.ts
nav_order: 190
nav_order: 192
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/sdk/PolicyId.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: sdk/PolicyId.ts
nav_order: 191
nav_order: 193
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/sdk/PoolParams.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: sdk/PoolParams.ts
nav_order: 192
nav_order: 194
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/sdk/ProtocolParameters.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: sdk/ProtocolParameters.ts
nav_order: 193
nav_order: 195
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/sdk/Relay.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: sdk/Relay.ts
nav_order: 199
nav_order: 201
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/sdk/RewardAddress.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: sdk/RewardAddress.ts
nav_order: 200
nav_order: 202
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/sdk/Script.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: sdk/Script.ts
nav_order: 201
nav_order: 203
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/sdk/Type.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: sdk/Type.ts
nav_order: 202
nav_order: 204
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/sdk/UTxO.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: sdk/UTxO.ts
nav_order: 204
nav_order: 206
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/sdk/Unit.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: sdk/Unit.ts
nav_order: 203
nav_order: 205
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/sdk/builders/RedeemerBuilder.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: sdk/builders/RedeemerBuilder.ts
nav_order: 174
nav_order: 176
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/sdk/builders/SignBuilder.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: sdk/builders/SignBuilder.ts
nav_order: 175
nav_order: 177
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/sdk/builders/SignBuilderImpl.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: sdk/builders/SignBuilderImpl.ts
nav_order: 176
nav_order: 178
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/sdk/builders/SubmitBuilder.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: sdk/builders/SubmitBuilder.ts
nav_order: 177
nav_order: 179
parent: Modules
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: sdk/builders/SubmitBuilderImpl.ts
nav_order: 178
nav_order: 180
parent: Modules
---

Expand Down
Loading