Blockstream Enterprise
ReferenceAPI ReferenceProposals

Get Proposals

Get Proposals.

Request

ProposalsGetRequest
interface ProposalsGetRequest {
  action: 'get'
  resource: string
  details?: {} | undefined
}

Prop

Type

Response

ProposalsGetResponse_success
interface ProposalsGetResponse_success {
  status: 'success'
  error_code?: '-1' | '-2' | '-3' | '-4' | '-5' | '-6' | '-7' | '-8' | '-9' | '-10' | '-11' | '-12' | '-13' | undefined
  message?: string | undefined
  details: {
    pid: string
    plid: string
    action: string
    resource: string
    details: unknown
    reviews: {
      type: 'kofn'
      data: {
        k: number
        group_id: string
        group: string[]
        reviews: {
          uid: string
          comment: string
          created_at: string
          username: string
          verdict: 'approved' | 'denied' | 'pending'
        } []
      }
    } | { type: 'and' | 'or'; data: { left: unknown | undefined; right: unknown | undefined } }
    created_by: string
    created_at: string
    updated_at: string
    batch_proposal_id: string | undefined
  } & { status: 'approved' | 'canceled' | 'denied' | 'executed' | 'pending' } | { status: 'rejected'; rejection_reason: string }
  metadata: unknown
}

Prop

Type

ProposalsGetResponse_failed | pending | unauthorized | rejected
interface ProposalsGetResponse_failed | pending | unauthorized | rejected {
  status: 'failed' | 'pending' | 'unauthorized' | 'rejected'
  error_code?: '-1' | '-2' | '-3' | '-4' | '-5' | '-6' | '-7' | '-8' | '-9' | '-10' | '-11' | '-12' | '-13' | undefined
  message?: string | undefined
}

Prop

Type

Example

Example
import { resourceSchema } from '@blockstream/ecs-js-sdk'
import { broadcastRequest } from './broadcaster'

const response = await broadcastRequest<
  typeof resourceSchema.shape.proposals.shape.get
>(
  {
    action: 'get',
    resource: '/proposals/{id}',
    details: {
      // TODO: fill in required fields
    },
  },
  blockstream,
)

On this page