Proposals

Get proposals overview

GET https://dao.octusbridge.io/v1/proposals/overview

200: OK Successful request

{
  "proposalsTotalCount": 6
}

This function returns number of all proposals on the Octus Bridge.

It can be used anywhere where number of all proposals is needed.

Request parameters

No required parameters

Response fields explanation

Name	Example value	Comment
proposalsTotalCount	6	Total number of DAO proposals

Example

app.get('/proposals/overview', (req, res) => {
    axios({
        method: 'get',
        url: `${apiUrl}/proposals/overview`
      })
    .then(function (response) {
        res.send(response.data)
    })
    .catch(function(error){
        console.error(error)
        res.send('Error')
    })
})

Get proposals data

POST https://dao.octusbridge.io/v1/proposals/search

200: OK Successful request

{
  "proposals": [
    {
      "proposalId": 6,
      "proposalAddress": "0:b0719c636ebd7e5fde1b4c0374dfe1808b46ca47afd2999379fc23cc9ce1edbd",
      "proposer": "0:56629b68a5ac850b5513ec992998a24eb4330d03171db1db91d485133dbe88c2",
      "description": "[\"Increase Octusbridge vault limits\",\"https://t.me/OctusBridge\",\"**Intro**\\n\\nOctus Bridge is rapidly growing and moving out of beta on many connected networks ... "]",
      "startTime": 1654361225,
      "endTime": 1654620425,
      "executionTime": 1654793225,
      "gracePeriod": 172800,
      "timeLock": 172800,
      "votingDelay": 172800,
      "forVotes": "607634505921299",
      "againstVotes": "0",
      "quorumVotes": "500000000000000",
      "messageHash": "530b6645278c64e8c72822f6bd29cb8d890b2196531404b1387fc403cb885d3c",
      "transactionHash": "eb4c542297509c1662e6e6f268e7ab6670605d454cf36628925a1817b644f24a",
      "actions": {
        "tonActions": [
          {
            "value": "1000000000",
            "target": "0:cb5f0cb869c91731da283f5546c42d3a3353e6e260dda170b4650970b62519b0",
            "payload": "te6ccgEBAgEAEQABCAMFmxgBABBBY2NlcHRlZA=="
          }
        ],
        "ethActions": []
      },
      "executed": true,
      "canceled": false,
      "queued": true,
      "executedAt": 1654796642,
      "canceledAt": null,
      "queuedAt": 1654650616,
      "createdAt": 1654188416,
      "state": "Executed"
    }
  ],
  "totalCount": 1
}

This function returns details about certain proposals based on proposal address, id, proposer’s address, start and end time as well as the proposal’s status (Pending, Executed, etc.).

It can be used for filtering proposals based on parameters such as proposal id, proposal’s address, proposer’s address, start and end time of the proposal, showing all the details about the searched proposal such as: description, state, information about the votes, execution time, grace period, quorum details, message and transaction hash, etc.

Request parameters

Required body parameters:

Name	Example value	Comment
endTimeGe	1641776400	Proposals that ended after or during the given time (in UNIX format)
endTimeLe	1655859600	Proposals that ended before or during the given time (in UNIX format)
limit	10	Maximum number of proposals to be retrieved
offset	0	Offset
ordering		Set of parameters based on which the retrieved proposals will be ordered
column	createdAt	Order by given column name (i.e. createdAt)
direction	ASC	Order by given direction (ascending or descending)
proposalAddress	0:b0719c636ebd7e5fde1b4c0374dfe1808b46ca47afd2999379fc23cc9ce1edbd	Address of the desired proposal
proposalId	6	Id of the desired proposal
proposer	0:56629b68a5ac850b5513ec992998a24eb4330d03171db1db91d485133dbe88c2	Address of the user that created the proposal
startTimeGe	1641776400	Proposals that started after or during the given time (in UNIX format)
startTimeLe	1654822800	Proposals that started before or during the given time (in UNIX format)
state	Executed	State of the proposal (Executed, pending…)

Response fields explanation

Name	Example value	Comment
ethActions		list of all the actions arrived from Everscale with following data:
- callData	"string"	Additional call data
- chainId	0	Id of the chain where the action happened
- signature	"string"	Relay’s signature
- target	"string"	Target address
- value	"string"	Amount of tokens
tonActions		list of all the actions arrived from ethereum side:
- payload	te6ccgEBAgEAEQABCAMFmxgBABBBY2NlcHRlZA	Payload data
- target	0:cb5f0cb869c91731da283f5546c42d3a3353e6e260dda170b4650970b62519b0	Target address
- value	1000000000	Amount of tokens
againstVotes	0	Number of votes against proposal
canceled	false	True if proposal is canceled, false if not
canceledAt	null	Date time of canceling event in UNIX format
createdAt	1654188416	Date time of proposal’s creation in UNIX format
description	Increase Octusbridge vault limits...
endTime	1654620425	Date time of the end of voting in UNIX format
executed	true	True if proposal is executed, false if not
executedAt	1654796642	Date time of proposal’s actual execution
executionTime	1654793225	Predicted execution time in UNIX format
forVotes	607634505921299	Number of votes supporting the proposal
gracePeriod	172800	Timespan in days for how long will the proposal be in the grace period
messageHash	530b6645278c64e8c72822f6bd29cb8d890b2196531404b1387fc403cb885d3c	Hash code of the message
proposalAddress	0:b0719c636ebd7e5fde1b4c0374dfe1808b46ca47afd2999379fc23cc9ce1edbd	Address of the proposal’s contract
proposalId	6	Id of the proposal
proposer	0:56629b68a5ac850b5513ec992998a24eb4330d03171db1db91d485133dbe88c2	Address of the user that created the proposal
queued	true	True if the proposal is queued, false if not
queuedAt	1654650616	Date of queuing the proposal
quorumVotes	500000000000000	Number of votes for reaching the quorum
startTime	1654361225	Date time of the start of voting
state	Executed	State of the proposal (Executed, Pending…)
timeLock	172800	Timespan of the lock of proposal (grace period)
transactionHash	eb4c542297509c1662e6e6f268e7ab6670605d454cf36628925a1817b644f24a	Hash code of the transaction
votingDelay	172800	Timespan of the voting delay (grace period)
totalCount	1	Total number of proposals retrieved

Example

app.post('/proposals/search', (req, res) => {
 
    console.log(req.body)
    axios({
        method: 'post',
        url: `${apiUrl}/proposals/search`,
        data: {
            endTimeGe: req.body.endTimeGe,
            endTimeLe: req.body.endTimeLe,
            limit: req.body.limit,
            offset: req.body.offset,
            ordering: req.body.ordering,
            proposalAddress: req.body.proposalAddress,
            proposalId: req.body.proposalId,
            proposer: req.body.proposer,
            startTimeGe: req.body.startTimeGe,
            startTimeLe: req.body.startTimeLe,
            state: req.body.state
        }
    })
    .then(function(response){
        res.send(response.data)
    })
    .catch(function(error){
        console.error(error)
        res.send('Error')
    })
})