Skip to content

Commit

Permalink
readme dashes
Browse files Browse the repository at this point in the history
  • Loading branch information
danflo27 committed Jun 6, 2024
1 parent fee10f6 commit c6db2e9
Show file tree
Hide file tree
Showing 5 changed files with 57 additions and 58 deletions.
24 changes: 12 additions & 12 deletions x/dispute/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@ This module handles disputes. Disputes can be handles in 3 levels: as a warning,

## ADRs

adr002 - queryId time frame structure
adr1002 - dual delegation
adr1006 - dispute levels
adr1007 - usage of staked tokens for disputes
adr1008 - voting power by group
adr2001 - trb bridge structure
- adr002 - queryId time frame structure
- adr1002 - dual delegation
- adr1006 - dispute levels
- adr1007 - usage of staked tokens for disputes
- adr1008 - voting power by group
- adr2001 - trb bridge structure

## Transactions

`ExecuteDispute`
`AddFeeToDispute`
`ProposeDispute`
`Vote`
`TallyVote`
`UpdateTeam`
- `ExecuteDispute`
- `AddFeeToDispute`
- `ProposeDispute`
- `Vote`
- `TallyVote`
- `UpdateTeam`

## Getters

Expand Down
10 changes: 5 additions & 5 deletions x/mint/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ This module enables the minting of time based rewards for reporters, validators,

## ADRs

adr1001 - distributions of base rewards
adr1002 - dual delgation
adr1003 - time based rewards eligibility
adr2001 - trb bridge structure
adr3001 - TellorMaster to bridge structure
- adr1001 - distributions of base rewards
- adr1002 - dual delgation
- adr10003 - time based rewards eligibility
- adr2001 - trb bridge structure
- adr3001 - TellorMaster to bridge structure
34 changes: 17 additions & 17 deletions x/oracle/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,29 @@ This module enables reporting of data to the network. Reporters can commit and t

## ADRs

adr002 - queryId time frame structure
adr1001 - distribution of base rewards
adr1002 - dual delegation
adr1003 - time based rewards eligibility
adr1004 - fees on tips
adr1005 - handling of tips after report
adr1008 - voting power by group
- adr002 - queryId time frame structure
- adr1001 - distribution of base rewards
- adr1002 - dual delegation
- adr1003 - time based rewards eligibility
- adr1004 - fees on tips
- adr1005 - handling of tips after report
- adr1008 - voting power by group

## Transactions

`CommitReport`
`SubmitValue`
`Tip`
`UpdateCycleList`
- `CommitReport`
- `SubmitValue`
- `Tip`
- `UpdateCycleList`

## Getters

`Params` - get module parameters
`Reporters` - get all staked reporters
`DelegatorReporter` - get reporter a delegator is staked with.
`ReporterStake` - get a reporter's total tokens.
`DelegationRewards` - get rewards of a delegator
`ReporterOutstandingRewards` - get all outstanding rewards for a reporter
- `Params` - get module parameters
- `Reporters` - get all staked reporters
- `DelegatorReporter` - get reporter a delegator is staked with.
- `ReporterStake` - get a reporter's total tokens.
- `DelegationRewards` - get rewards of a delegator
- `ReporterOutstandingRewards` - get all outstanding rewards for a reporter

## Mocks

Expand Down
21 changes: 10 additions & 11 deletions x/registry/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,22 @@ This module enables the registration of fully customizable data specs to inform

## ADRs

adr002 - queryId time frame structure
adr1004 - fees on tips
adr2002 - nonces for bridging
- adr002 - queryId time frame structure
- adr1004 - fees on tips
- adr2002 - nonces for bridging

## Transactions

`RegisterSpec`
`UpdateSpec`
-`RegisterSpec`
-`UpdateSpec`

## Getters

`Params` - get module parameters
`DecodeQueryData` - decode query data into query type and data fields
`DecodeValue` - decode value into a string
`GenerateQueryData` - generate query data for a given query type and data
`GetDataSpec` - get data specification for a given query type

- `Params` - get module parameters
- `DecodeQueryData` - decode query data into query type and data fields
- `DecodeValue` - decode value into a string
- `GenerateQueryData` - generate query data for a given query type and data
- `GetDataSpec` - get data specification for a given query type

## Mocks

Expand Down
26 changes: 13 additions & 13 deletions x/reporter/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,25 @@ This module enables token holders to stake tokens to become data reporters and d

## ADRs

adr1001 - distribution of base rewards
adr1002 - dual delegation
adr1005 - handling of tips after report
adr1008 - voting power by group
adr2001 - trb bridge structure
- adr1001 - distribution of base rewards
- adr1002 - dual delegation
- adr1005 - handling of tips after report
- adr1008 - voting power by group
- adr2001 - trb bridge structure

## Transactions

`CreateReporter`
`ChangeReporter`
`UnjailReporter`
`WithdrawTip`
`UpdateParams`
-`CreateReporter`
-`ChangeReporter`
-`UnjailReporter`
-`WithdrawTip`
-`UpdateParams`

## Getters

Params - get module parameters
Reporters - get all staked reporters
DelegatorReporter - get reporter a delegator is staked with.
- `Params` - get module parameters
- `Reporters` - get all staked reporters
- `DelegatorReporter` - get reporter a delegator is staked with.

## Mocks

Expand Down

0 comments on commit c6db2e9

Please sign in to comment.