Blockstream Enterprise
ReferenceAPI ReferenceSigners

Derive Xpub Signers

Derive Xpub Signers.

Request

SignersDeriveXpubRequest
interface SignersDeriveXpubRequest {
  action: 'add'
  resource: string
  details: {
    id: string
    kind: string
    change: 'receive' | 'change'
  }
}

Prop

Type

Response

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

Prop

Type

SignersDeriveXpubResponse_failed | pending | unauthorized | rejected
interface SignersDeriveXpubResponse_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.signers.shape.derive-xpub
>(
  {
    action: 'add',
    resource: '/signers/{id}/xpubs',
    details: {
      // TODO: fill in required fields
    },
  },
  blockstream,
)

On this page