Blockstream Enterprise

Request

ProposalsCancelRequest

interface ProposalsCancelRequest {
  action: 'cancel'
  resource: string
  details?: {
    reason: string | undefined
  } | undefined
}

Prop

Type

Response

ProposalsCancelResponse_success

interface ProposalsCancelResponse_success {
  status: 'success'
  error_code?: '-1' | '-2' | '-3' | '-4' | '-5' | '-6' | '-7' | '-8' | '-9' | '-10' | '-11' | '-12' | '-13' | undefined
  message?: string | undefined
  details: {
    status: string
  }
  metadata: unknown
}

Prop

Type

ProposalsCancelResponse_failed | pending | unauthorized | rejected

interface ProposalsCancelResponse_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

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

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

Cancel Proposals

Request

Response

Example

On this page