ReferenceAPI ReferenceWallets
Create Wallets
Create Wallets.
Request
interface WalletsCreateRequest {
action: 'add'
resource: '/wallets'
details: {
id: string
name: string
network: 'bitcoin' | 'liquid'
} & { type: 'amp'; value: { signer_id: string | undefined } } | { type: 'kofn_multisig'; value: { k: number | undefined; pubkeys: string[] | undefined } } | { type: 'single_sig'; value: { signer_id: string } }
}Prop
Type
Response
interface WalletsCreateResponse_success {
status: 'success'
error_code?: '-1' | '-2' | '-3' | '-4' | '-5' | '-6' | '-7' | '-8' | '-9' | '-10' | '-11' | '-12' | '-13' | undefined
message?: string | undefined
details: {
wid: string
id: string
name: string | undefined
type: 'amp' | 'kofn_multisig' | 'single_sig'
descriptor: string
k: number
n: number
locked: boolean
address: string | undefined
network: 'liquid' | 'bitcoin'
slip77_hex: string | undefined
created_at: string
updated_at: string
created_by: string
updated_by: string
}
metadata: unknown
}Prop
Type
interface WalletsCreateResponse_pending {
status: 'pending'
error_code?: '-1' | '-2' | '-3' | '-4' | '-5' | '-6' | '-7' | '-8' | '-9' | '-10' | '-11' | '-12' | '-13' | undefined
message?: string | undefined
details: {
proposal_id: string
}
}Prop
Type
Example
import { resourceSchema } from '@blockstream/ecs-js-sdk'
import { broadcastRequest } from './broadcaster'
const response = await broadcastRequest<
typeof resourceSchema.shape.wallets.shape.create
>(
{
action: 'add',
resource: '/wallets',
details: {
// TODO: fill in required fields
},
},
blockstream,
)