Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kayagokalp committed May 29, 2024
1 parent 0e7a0be commit d4474bd
Showing 1 changed file with 61 additions and 14 deletions.
75 changes: 61 additions & 14 deletions docs/book/src/forc/plugins/forc_client/index.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,73 @@
# `forc-client`

Forc plugin for interacting with a Fuel node.
Forc plugin for interacting with a Fuel node. Since transactions are going to require some gas, you need to sign them with an account that has enough tokens to pay for them.

## Initializing the wallet and adding accounts
We offer multiple ways to sign the transaction:
1. Sign the transaction via your local wallet using forc-client which integrates with our CLI wallet, forc-wallet.
2. Use the default signer to deploy to a local node
3. Use forc-wallet to manually sign transactions, and copy the signed transaction back to forc-client.

If you don't have an initialized wallet or any account for your wallet you won't be able to sign transactions.
The easiest and recommended way to interact with deployed networks, such as our testnets is the option 1, using forc-client to sign your transactions which reads your default forc-wallet vault. For interacting with local node, we recommend using the second option, which leads forc-client to sign transactions with the a private key that comes pre-funded in local environments.

To create a wallet you can use `forc wallet new`. It will ask you to choose a password to encrypt your wallet. After the initialization is done you will have your mnemonic phrase.
## Option 1: Sign transactions via forc-client using your local forc-wallet vault
If you used forc-wallet before, a vault which securely holds your private key is created and written to your file-system in a password encrypted format. forc-client is compatible with forc-wallet such that it can read that vault by asking you your password and use your account to sign transactions.

After you have created a wallet, you can derive a new account by running `forc wallet account new`. It will ask your password to decrypt the wallet before deriving an account.
Example:

## Signing transactions using `forc-wallet` CLI
```console
> forc deploy

To submit the transactions created by `forc deploy` or `forc run`, you need to sign them first (unless you are using a client without UTXO validation). To sign a transaction you can use `forc-wallet` CLI. This section is going to walk you through the whole signing process.
Building /Users/test/test-projects/test-contract
Finished release [optimized + fuel] target(s) in 11.39s

By default `fuel-core` runs without UTXO validation, this allows you to send invalid inputs to emulate different conditions.
Please provide the password of your encrypted wallet vault at "/Users/ceylinbormali/.fuel/wallets/.wallet":
Deploying contract: impl-contract

If you want to run `fuel-core` with UTXO validation, you can pass `--utxo-validation` to `fuel-core run`.
---------------------------------------------------------------------------
Account 0: fuel12pls73y9hnqdqthvduy2x44x48zt8s50pkerf32kq26f2afeqdwq6rj9ar

To install `forc-wallet` please refer to `forc-wallet`'s [GitHub repo](https://github.com/FuelLabs/forc-wallet#forc-wallet).
Asset ID : f8f8b6283d7fa5b672b530cbb84fcccb4ff8dc40f8176ef4544ddb1f1952ad07
Amount : 2197245
---------------------------------------------------------------------------

1. Construct the transaction by using either `forc deploy` or `forc run`. To do so simply run `forc deploy` or `forc run` with your desired parameters. For a list of parameters please refer to the [forc-deploy](./forc_deploy.md) or [forc-run](./forc_run.md) section of the book. Once you run either command you will be asked the address of the wallet you are going to be signing with. After the address is given the transaction will be generated and you will be given a transaction ID. At this point CLI will actively wait for you to insert the signature.
Please provide the index of account to use for signing: 0
Do you agree to sign this transaction with fuel12pls73y9hnqdqthvduy2x44x48zt8s50pkerf32kq26f2afeqdwq6rj9ar? [y/N]: y


Contract impl-contract Deployed!

Network: https://testnet.fuel.network
Contract ID: 0x94b712901f04332682d14c998a5fc5a078ed15321438f46d58d0383200cde43d
Deployed in block 00114d4d
```

As it can be seen from the example, forc-client asks for your password to decrypt the forc-wallet vault, and list your accounts so that you can select the one you want to fund the transaction with.

## Option 2: Using default signer

If you are not interacting with a deployed network, such as testnets, your local fuel-core environment can be structured such that it funds an account by default. Using `--default-signer` flag with forc-client binaries (run, deploy) will instruct forc-client to sign transactions with this pre-funded account. Which makes it a useful command while working against a local node.

Example:
```console
> forc deploy --default-signer

Building /Users/test/test-projects/test-contract
Finished release [optimized + fuel] target(s) in 11.40s
Deploying contract: impl-contract


Contract impl-contract Deployed!

Network: http://127.0.0.1:4000
Contract ID: 0xf9fb08ef18ce226954270d6d4f67677d484b8782a5892b3d436572b405407544
Deployed in block 00000001
```

## Option 3: Manually signing through forc-wallet (Deprecated)

This option is for creating the transaction first, signing it manually and supplying the signed transaction back to forc-client. Since it requires multiple steps, it is more error-prone and not recommended for general use case. Also this will be deprecated soon.

1. Construct the transaction by using either `forc deploy` or `forc run`. To do so simply run `forc deploy --manual-sign` or `forc run --manual-sign` with your desired parameters. For a list of parameters please refer to the [forc-deploy](./forc_deploy.md) or [forc-run](./forc_run.md) section of the book. Once you run either command you will be asked the address of the wallet you are going to be signing with. After the address is given the transaction will be generated and you will be given a transaction ID. At this point CLI will actively wait for you to insert the signature.
2. Take the transaction ID generated in the first step and sign it with `forc wallet sign --account <account_index> tx-id <transaction_id>`. This will generate a signature.
3. Take the signature generated in the second step and provide it to `forc-deploy` (or `forc-run`). Once the signature is provided, the signed transaction will be submitted.

Expand Down Expand Up @@ -56,7 +103,7 @@ By default `--default-signer` flag would sign your transactions with the followi
## Interacting with the testnet

To interact with the latest testnet, use the `--testnet` flag. When this flag is passed, transactions created by `forc-deploy` will be sent to the `beta-4` testnet.
To interact with the latest testnet, use the `--testnet` flag. When this flag is passed, transactions created by `forc-deploy` will be sent to the latest `testnet`.

```sh
forc-deploy --testnet
Expand All @@ -68,10 +115,10 @@ It is also possible to pass the exact node URL while using `forc-deploy` or `for
forc-deploy --node-url https://beta-3.fuel.network
```

Another alternative is the `--target` option, which provides useful aliases to all targets. For example if you want to deploy to `beta-3` you can use:
Another alternative is the `--target` option, which provides useful aliases to all targets. For example if you want to deploy to `beta-5` you can use:

```sh
forc-deploy --target beta-3
forc-deploy --target beta-5
```

Since deploying and running projects on the testnet cost gas, you will need coins to pay for them. You can get some using the [testnet faucet](https://faucet-beta-4.fuel.network/).
Expand Down

0 comments on commit d4474bd

Please sign in to comment.