Skip to content
This repository has been archived by the owner on May 13, 2024. It is now read-only.

Fix: typos #37

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions examples/contract/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Work with smart contract and tokens

Use TzGo to work with smart contracts and tokens. This examples shows you how to
Use TzGo to work with smart contracts and tokens. This example shows you how to

- get contract entrypoints
- execute on-chain views to read data
Expand Down Expand Up @@ -37,10 +37,10 @@ Query Commands
getTotalSupply <contract> FA1: fetch total token supply
getAllowance <contract> <owner> <spender> FA1: fetch spender permit

Transaction Commands (require private key
Transaction Commands (require private key)
transfer <contract> <token_id> <amount> <receiver> <privkey> FA1+2: transfer tokens to receiver
approve <contract> <spender> <amount> <privkey> FA1: grant spending right
revoke <contract> <spender> <amount> <privkey> FA1: revoke spending right
addOperator <contract> <token_id> <spender> <privkey> FA2: grant full operator permissions
removeOperator <contract> <token_id> <spender> <privkey> FA2: revoke full operator permissions
```
```
4 changes: 2 additions & 2 deletions examples/fa12/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ go run . BKuRFhvhsc3Bwdxedu6t25RmrkqpERVqEk867GAQu43muvi7j4d 17

### Implementation details

There are different ways to accomplish this for your own contracts. Here we just use the FA1.2 spec to illustrate how the proces works.
There are different ways to accomplish this for your own contracts. Here we just use the FA1.2 spec to illustrate how the process works.

```go
// you need the contract's script for type info
Expand Down Expand Up @@ -80,4 +80,4 @@ There are different ways to accomplish this for your own contracts. Here we just
}
buf, _ = json.MarshalIndent(transfer, "", " ")
fmt.Printf("FA transfer %s\n", string(buf))
```
```
2 changes: 1 addition & 1 deletion examples/rights/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Working wth baking rights
## Working with baking rights

Use TzGo to fetch baking rights and related data from the Tezos RPC. This example covers a few basic cases.

Expand Down
4 changes: 2 additions & 2 deletions examples/transfer/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Transfer tez with ease

Use TzGo to construct and broadcast valid Tezos transactions. There are many convenience wrappers that help with the construction side and a simple one-stop-shop `Send()` call that does all the heavy lifting of fee estimation, coordinating signing, broadcasting and waitinh for confirmations. Checkout the source code in the `codec` package and `rpc/run.go` to get a sense of what's possible.
Use TzGo to construct and broadcast valid Tezos transactions. There are many convenience wrappers that help with the construction side and a simple one-stop-shop `Send()` call that does all the heavy lifting of fee estimation, coordinating signing, broadcasting and waiting for confirmations. Checkout the source code in the `codec` package and `rpc/run.go` to get a sense of what's possible.

The most simple chain of function calls to send a single transfer with default options is

Expand Down Expand Up @@ -30,4 +30,4 @@ Transaction Commands
transfer {<receiver> <amount>}+ transfer tez to single or multiple receiver(s)
```

If you provide multiple `<receiver> <amount>` pairs to the command, it produces a single batch transaction.
If you provide multiple `<receiver> <amount>` pairs to the command, it produces a single batch transaction.
6 changes: 3 additions & 3 deletions examples/tx/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Build and sign Tezos operations

Use TzGo to produce any type of Tezos operation. One by one, this example shows all the basic steps to make, encode, simulate, sign, broadacst and wait for operation to be confirmed .
Use TzGo to produce any type of Tezos operation. One by one, this example shows all the basic steps to make, encode, simulate, sign, broadcast and wait for operation to be confirmed.

### Usage

Expand All @@ -20,7 +20,7 @@ Commands
decode <msg> decode binary operation
digest <msg> generate operation digest for signing
sign <key> <msg> sign message digest
sign-remoate <key> <msg> sign message digest using remote signer
sign-remote <key> <msg> sign message digest using remote signer
simulate <msg> simulate executing operation using invalid signature
broadcast <msg> <sig> broadcast signed operation
wait <ophash> [<n>] waits for operation to be included after n confirmations (optional)
Expand All @@ -46,7 +46,7 @@ Operation types & required JSON keys

### Examples

We use a `reveal` operation as simple example, but others work with the same schema. Note that the binary encoding used as input to simulation and signing already contains a recent block hash. You can't jost copy paste below examples 1:1 to walk through the steps. Instead, start at the first command and use each command's output as the input to the following.
We use a `reveal` operation as simple example, but others work with the same schema. Note that the binary encoding used as input to simulation and signing already contains a recent block hash. You can't just copy paste below examples 1:1 to walk through the steps. Instead, start at the first command and use each command's output as the input to the following.

```sh
# encode to binary (also adds a recent block hash for TTL control)
Expand Down