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 03115f1 commit ee50895
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -326,7 +326,7 @@ For a complete list of the `EscrowClient` API, [click here](docs/client.md).

### Create a Signer

The `EscrowSigner` is used to represent a member of a contract, and perform signature operations on their behalf. The fastest way to setup a new `EscrowSigner` is to generate one randomly:
The `EscrowSigner` is used to represent a member of a contract, and perform signature operations on their behalf. The fastest way to setup a new signer is to generate one randomly:

```ts
import { EscrowSigner } from '@scrow/core/client'
Expand All @@ -335,7 +335,7 @@ import { EscrowSigner } from '@scrow/core/client'
const signer = EscrowSigner.generate(client_config, xpub)
```

You can also create an `EscrowSigner` using BIP39 seed words.
You can also create a signer using BIP39 seed words.

```ts
const words = [ 'your', 'bip39', 'seed', 'words' ]
Expand All @@ -348,7 +348,7 @@ const signer = EscrowSigner
.from_words(words, pass)
```

The `EscrowSigner` is built to plug into a more basic `SignerAPI` and `WalletAPI`, which can be hosted outside the browser in an extension or external software application.
The `EscrowSigner` is designed to plug into a more basic `SignerAPI` and `WalletAPI` which can be hosted outside the browser, such as an extension or external software application.

```ts
import { Signer, Wallet } from '@cmdcode/signer'
Expand All @@ -368,7 +368,7 @@ const signer_config = {
const signer = new EscrowSigner(signer_config)
```

The `EscrowSigner` is designed for insecure environments. The signing key has no direct access to funds, addresses are generated by the xpub, and all transactions are signed and verified before deposit.
The `EscrowSigner` is built for insecure environments. Addresses are generated by the xpub, and all transactions are signed and verified before deposit. The signing key has no direct access to funds.

The signing key is also disposable, and can be tossed from memory once the funding transactions have been signed. Credentials generated by the signer are independently recoverable by the xpub.

Expand Down

0 comments on commit ee50895

Please sign in to comment.