BitEscrow API

Create a client.

``ts
import { EscrowClient } from '@cmdcode/escrow-api'
// Create a secret key.
const secret = Buff.str('alice').digest
// Create a client object using a secret key.
const client = new EscrowAPI(secret)
// You can view the pubkey and access the API tools directly.
const { API, pubkey } = client
// You can fetch a contract by Id.
const contract = await client.getContract(contract_id)
`

Create a contract

`ts
import { EscrowContract } from '@cmdcode/escrow-api'
// Create a contract using a client and template.
const contract = await EscrowContract.create(client, {
title : 'Example Escrow Contract'
})
`

Client API Reference

`ts
let client = new EscrowClient(secret)

client.API = {
contract : {
list : () => Promise>,
create : (template: ContractCreate) => Promise>,
read : (contractId: string) => Promise>,
prune : () => Promise,
update : (contractId: string, template: ContractTemplate) => Promise,
cancel : (contractId: string) => Promise
},
endorse: {
update : (contractId: string, endorsement: string) => Promise,
remove : (contractId: string) => Promise
},
members: {
update : (contractId: string, members: string[]) => Promise,
remove : (contractId: string, members: string[]) => Promise
},
profile : {
list : () => Promise>,
read : (contractId: string) => Promise>,
update : (contractId: string, template: ProfileTemplate) => Promise,
remove : (contractId: string) => Promise,
clear : () => Promise,
tags : {
update: (contractId: string, records: ProfileRecord[]) => Promise,
remove: (contractId: string, labels: string[]) => Promise
}
},
records: {
update : (contractId: string, records: RecordTemplate[]) => Promise,
remove : (contractId: string, queries: RecordQuery[]) => Promise
},
sign: {
list : (contractId: string) => Promise>,
update : (contractId: string, signature: string) => Promise,
remove : (contractId: string) => Promise
}
}
`

`ts
// Main ContractData object.
interface ContractData {
contract_id : string
members : string[]
status : "draft" | "published" | "active" | "disputed" | "closed"
revision : number
created_at : Date
updated_at : Date

claims: ClaimData[] {

data : string[]
methods : string[]
params : string[]
value : number
}

data: {

}

details: {
// Contract info is editable by the admin.
updated_at : Date
title : string
admin : string
agent : string
depositor : string
desc ?: string | undefined
terms ?: string | undefined
}

endorsements : EndorseData[] {
// Collect signed endorsements from other members.
updated_at : Date
pubkey : string
hash : string
signature : string
}

fees: PaymentData[] {
address : string
note ?: string
value : number
}

meta: {
// Metadata is updated by the server.
block_id : string
open_txid ?: string | undefined
close_txid ?: string | undefined
}

payments: PaymentData[] {
address : string
note ?: string
value : number
}

room: {
// This data is for collaboration and signing.
secret : string
nonce ?: string | undefined
pubkey ?: string | undefined
hash ?: string | undefined
}

profiles: {
// Each member manages their own profile data.
updated_at : Date
pubkey : string
nonce : string
alias : string
}[]
records: {
// All members can manage records for the contract.
updated_at : Date
pubkey : string
label : string
kind : "data" | "script" | "term"
content : string[]
}[]
signatures: {
updated_at : Date
kind : "claim" | "settle"
outputs : string[]
pubkey : string
sighash : string
txhex : string
psig : string
}[]
transactions: string[]
}

interface PaymentData {
address : string
note ?: string
value : number
}

interface CoinLock {
method : string
params : string[]
version : string
}
`


EscrowContract API Reference

`ts
const contract = new EscrowContract(client, contract_id)

let contract = {
cid : string,
API : ContractRouter,
pubkey : string,

// Claim outputs show pending closing tx.
claims : Promise,
// Deposit inputs are used in the closing tx.
deposits : Promise,
details : Promise,
endorsements : Promise,
// Fee outputs are used in the closing tx.
fees : Promise,
members : Promise>,
meta : Promise,
// Payment outputs are used in the closing tx.
payments : Promise,
records : Promise,
refund : Promise,
scripts : Promise,
session : Promise,
signatures : Promise,
// All transactions tied to the contract are here.
transactions : Promise

fetch () => Promise

join()
leave()

// These options are only available
// during the draft stage of a contract.
access : {
// Add pubkeys to the member list.
add (pubkeys : string[]) : Promise,
// Remove pubkeys from the member list.
remove (pubkeys : string[]) : Promise,
}

// These options are only available
// during the draft stage of a contract.
admin : {
// Cancel the contract.
cancel ()
// Transfer admin rights to another key.
transfer()
// Update the details of the contract.
update ()
}

check : {
claims()
deposits()
}

data : {
// Add a record to the contract output.
add()
// Remove a record from the contract output.
remove()
}

endorse : {
API : EndorseRouter,
list
add (hash ?: string) : Promise
remove() : Promise
}

payment : {
// Add a payment output.
add()
// Remove a payment output.
remove()
}

profile : {
data : Promise,
update (template: ProfileTemplate) : Promise,
tag : {
add()
remove()
}
}

script : {
// Add a custom script to the contract output.
add()
// Remove a custom script from the contract output.
remove()
}

signature : {
data
add (hash ?: string) : Promise
remove () : Promise
}
}
``