Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
cmd committed Jan 30, 2024
1 parent c69c8d5 commit 15e148a
Show file tree
Hide file tree
Showing 7 changed files with 331 additions and 87 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ Key Features:

* __100% private.__ All on-chain transactions appear as single-key spends. Participation is done through randomly generated credentials. Only requires a signing key (hot), and wallet xpub (cold) to participate.

* __100% non-custodial.__ Money is secured in a collaborative 2-of-2 contract. All payouts are pre-signed before deposit. Returns are locked to a cold-stored xpub of your choice.
* __100% non-custodial.__ Money is secured in a collaborative 2-of-2 contract. All payouts are pre-signed before deposit. Addresses are generated from a cold-stored xpub of your choice.

* __100% auditable.__ All contract terms, inputs, and operations are signed and recorded in a commit chain. Each transaction is backed by a verifiable commit history.
* __100% auditable.__ All contract terms, inputs, and operations are signed and recorded in a commit chain. Each settlement transaction is backed by an auditable commit history.

* __Designed for trustless environments.__ Signing keys are disposable and have no capacity to sweep funds. All terms are signed up-front and verifiable before deposit.
* __Designed for trustless environments.__ Signing keys are disposable and have no capacity to sweep funds. Terms are signed up-front and verified before deposit.

* __Designed to be robust.__ Deposits can be re-used if a contract cancels or expires. Credentials are recoverable via your xpub. Refunds are signed upfront and broadcast automatically on expiration.

Expand Down
1 change: 0 additions & 1 deletion docs/api/deposit.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,6 @@ interface RegisterRequest {

```ts

}
```

## View Contracts by Registered Pubkey
Expand Down
23 changes: 19 additions & 4 deletions docs/client.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,22 @@
# EscrowClient Documentation
# EscrowClient

Work in progreess. Check back later!

```ts
interface goes here
```
**Sections**

1. [How to Use](#how-to-use)
2. [Selecting a Network](#selecting-a-network)
3. [Selecting an Oracle](#selecting-an-oracle)

**Interfaces**

- [ClientConfig]()
- [EscrowClient]()
- [ApiResponse]()

## How to Use

## Selecting a Network

## Selecting an Oracle

21 changes: 20 additions & 1 deletion docs/contract.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,26 @@
# Contract Documentation
# Contracts

Work in progreess. Check back later!

**Sections**

1. [Creating a Contract]()
2. [Funding a Contract]()
3. [Contract Activation]()
4. [Virtual Machine (CVM)]()
4. [Submitting Statements]()
5. [Validating Execution]()
6. [Sweeping Funds]()

**Interfaces**

- [ContractRequest]
- [ContractData]
- [ContractStatus]
- [WitnessTemplate]
- [WitnessData]
- [MachineState]

## Creating a Contract

## Funding a Contract
Expand Down
23 changes: 21 additions & 2 deletions docs/deposit.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,27 @@
# Deposit Documentation
# Deposits

Work in progreess. Check back later!

## Requesting a Deposit Account
**Sections**

1. [Request an Account]()
2. [Verify an Account]()
3. [Deposit Funds]()
4. [Create a Covenant]()
5. [Register a Deposit]()
6. [Lock a Deposit]()
7. [Close a Deposit]()

**Interfaces**

- [AccountRequest]
- [DepositAccount]
- [CovenantData]
- [SpendingData]
- [RegisterRequest]
- [DepositData]

### Requesting a Deposit Account

```ts
interface DepositAccount {
Expand Down
Loading

0 comments on commit 15e148a

Please sign in to comment.