-
Notifications
You must be signed in to change notification settings - Fork 117
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
updated docs to group by logical order
- Loading branch information
Showing
11 changed files
with
206 additions
and
62 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
--- | ||
title: Contract API | ||
id: contract_API | ||
author: Davis Sawali | ||
--- | ||
|
||
## What is the Contract API? | ||
Taquito Contract API provides a simple way to interact with the Tezos blockchain. It provides methods and abstractions to prepare, forge, sign, and send operations to the Tezos blockchain, as well as interact with smart contracts. | ||
|
||
## Installing the Contract API | ||
The Contract API is part of the `@taquito/taquito` package. To install it, run the following command: | ||
|
||
``` | ||
npm install @taquito/taquito | ||
``` | ||
|
||
## How does it work? | ||
The Contract API is exposed through the `contract` property of the `TezosToolkit` object. The `contract` property exposes methods that allow you to interact with smart contracts. | ||
|
||
Below is a quick example of how to use the `transaction` operation via the Contract API. | ||
|
||
```js | ||
import { TezosToolkit } from '@taquito/taquito'; | ||
|
||
const Tezos = new TezosToolkit('RPC address here'); | ||
const op = await Tezos.contract.transfer({ to: 'tz1VSUr8wwNhLAzempoch5d6hLRiTh8Cjcjb', amount: 100 }); | ||
await op.confirmation(); | ||
``` | ||
|
||
For a list of methods available from the Contract API please refer to this TypeDoc documentation: https://tezostaquito.io/typedoc/interfaces/_taquito_taquito.contractprovider | ||
|
||
## How it works | ||
Hopefully at this point, the Taquito Contract API seems simple enough to use. But how does it work under the hood? | ||
|
||
Injecting an operation via the Contract API actually consists of a few steps that are abstracted away from the developer. These steps are: | ||
- Preparing the operation | ||
- Estimating the costs of the operation | ||
- Forging the operation | ||
- Signing the operation | ||
- Sending/injecting the operation |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
title: Ledger | ||
title: Ledger tests | ||
author: Roxane Letourneau | ||
--- | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
title: Local Forging Package | ||
title: Local Forger | ||
id: local_forger | ||
author: Michael Kernaghan | ||
--- | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
title: RPC nodes | ||
title: RPC tests | ||
author: Roxane Letourneau | ||
--- | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
title: RPC Package | ||
title: RPC | ||
author: Claude Barde | ||
--- | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
title: Web3js/Taquito differences | ||
title: web3js vs Taquito | ||
id: web3js_taquito | ||
author: Claude Barde | ||
--- | ||
|
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters