Add docs on sncast_std, update cast docs (#1297)

<!-- Reference any GitHub issues resolved by this PR -->

Closes #

## Introduced changes

<!-- A brief description of the changes -->

- Add docs for sncast_std, update docs for
#1283

## Checklist

<!-- Make sure all of these are complete -->

- [X] Linked relevant issue
- [X] Updated relevant documentation
- [X] Added relevant tests
- [X] Performed self-review of the code
- [X] Added changes to `CHANGELOG.md`

Author: THenry14

docs/src/SUMMARY.md

@@ -59,8 +59,6 @@
     * [spy_events](appendix/cheatcodes/spy_events.md)
     * [start_spoof](appendix/cheatcodes/start_spoof.md)
     * [stop_spoof](appendix/cheatcodes/stop_spoof.md)
-    
-
 * [Forge Library Functions References](appendix/forge-library.md)
     * [declare](appendix/forge-library/declare.md)
     * [precalculate_address](appendix/forge-library/precalculate_address.md)
@@ -93,3 +91,8 @@
         * [run](appendix/cast/multicall/run.md)
     * [show-config](appendix/cast/show_config.md)
     * [script](appendix/cast/script.md)
+* [Cast Library Functions References](appendix/cast-library.md)
+    * [declare](appendix/cast-library/declare.md)
+    * [deploy](appendix/cast-library/deploy.md)
+    * [invoke](appendix/cast-library/invoke.md)
+    * [call](appendix/cast-library/call.md)

docs/src/appendix/cast-library.md

@@ -0,0 +1,15 @@
+# Library Functions References
+
+* [`declare`](cast-library/declare.md) - declares a contract
+* [`deploy`](cast-library/deploy.md) - deploys a contract
+* [`invoke`](cast-library/invoke.md) - invokes a contract's function
+* [`call`](cast-library/call.md) - calls a contract's function
+
+> ℹ️ **Info**
+> To use the library functions you need to add `sncast_std` package as a dependency in
+> your [`Scarb.toml`](https://docs.swmansion.com/scarb/docs/guides/dependencies.html#adding-a-dependency)
+> using appropriate release tag.
+>```toml
+> [dependencies]
+> sncast_std = { git = "https://github.com/foundry-rs/starknet-foundry.git", tag = "v0.12.0" }
+> ```

docs/src/appendix/cast-library/call.md

@@ -0,0 +1,34 @@
+# `call`
+
+> `fn call(
+    contract_address: ContractAddress, function_name: felt252, calldata: Array::<felt252>
+) -> CallResult`
+
+Calls a contract and returns `CallResult`.
+
+```rust
+#[derive(Drop, Clone)]
+struct CallResult {
+    data: Array::<felt252>,
+}
+```
+
+- `contract_address` - address of the contract to call.
+- `function_name` - the name of the function to call, as Cairo shortstring.
+- `calldata` - inputs to the function to be called.
+
+```rust
+use sncast_std::{call, CallResult};
+use starknet::{ContractAddress, Felt252TryIntoContractAddress};
+use debug::PrintTrait;
+
+fn main() {
+    let contract_address: ContractAddress = 0x1e52f6ebc3e594d2a6dc2a0d7d193cb50144cfdfb7fdd9519135c29b67e427
+        .try_into()
+        .expect('Invalid contract address value');
+
+    let call_result = call(contract_address, 'get', array![0x1]);
+    let first_item = *call_result.data[0];
+    first_item.print();
+}
+```

docs/src/appendix/cast-library/declare.md

@@ -0,0 +1,30 @@
+# `declare`
+
+> `fn declare(contract_name: felt252, max_fee: Option<felt252>, nonce: Option<felt252>) -> DeclareResult`
+
+Declares a contract and returns `DeclareResult`.
+
+```rust
+#[derive(Drop, Clone)]
+struct DeclareResult {
+    class_hash: ClassHash,
+    transaction_hash: felt252,
+}
+```
+
+- `contract_name` - name of a contract as Cairo shortstring. It is a name of the contract (part after `mod` keyword) e.g. `'HelloStarknet'`.
+- `max_fee` - max fee for declare transaction. If not provided, max fee will be automatically estimated.
+- `nonce` - nonce for declare transaction. If not provided, nonce will be set automatically.
+
+```rust
+use sncast_std::{declare, DeclareResult};
+use debug::PrintTrait;
+
+fn main() {
+    let max_fee = 9999999;
+    let declare_result = declare('HelloStarknet', Option::Some(max_fee), nonce::None);
+
+    let class_hash = declare_result.class_hash;
+    class_hash.print();
+}
+```

docs/src/appendix/cast-library/deploy.md

@@ -0,0 +1,53 @@
+# `deploy`
+
+> `fn deploy(
+    class_hash: ClassHash,
+    constructor_calldata: Array::<felt252>,
+    salt: Option<felt252>,
+    unique: bool,
+    max_fee: Option<felt252>,
+    nonce: Option<felt252>
+) -> DeployResult`
+
+Deploys a contract and returns `DeployResult`.
+
+```rust
+#[derive(Drop, Clone)]
+struct DeployResult {
+    contract_address: ContractAddress,
+    transaction_hash: felt252,
+}
+```
+
+- `class_hash` - class hash of a contract to deploy.
+- `constructor_calldata` - calldata for the contract constructor.
+- `salt` - salt for the contract address.
+- `unique` - determines if salt should be further modified with the account address.
+- `max_fee` - max fee for declare transaction. If not provided, max fee will be automatically estimated.
+- `nonce` - nonce for declare transaction. If not provided, nonce will be set automatically.
+
+```rust
+use sncast_std::{deploy, DeployResult};
+use starknet::{ClassHash, Felt252TryIntoClassHash};
+use debug::PrintTrait;
+
+fn main() {
+    let max_fee = 9999999;
+    let salt = 0x1;
+    let nonce = 0x1;
+    let class_hash: ClassHash = 0x03a8b191831033ba48ee176d5dde7088e71c853002b02a1cfa5a760aa98be046
+        .try_into()
+        .expect('Invalid class hash value');
+
+    let deploy_result = deploy(
+        class_hash,
+        ArrayTrait::new(),
+        Option::Some(salt),
+        true,
+        Option::Some(max_fee),
+        Option::Some(nonce)
+    );
+
+    deploy_result.contract_address.print();
+}
+```

docs/src/appendix/cast-library/invoke.md

@@ -0,0 +1,40 @@
+# `invoke`
+
+> `fn invoke(
+    contract_address: ContractAddress,
+    entry_point_selector: felt252,
+    calldata: Array::<felt252>,
+    max_fee: Option<felt252>,
+    nonce: Option<felt252>
+) -> InvokeResult`
+
+Deploys a contract and returns `InvokeResult`.
+
+```rust
+#[derive(Drop, Clone)]
+struct InvokeResult {
+    transaction_hash: felt252,
+}
+```
+
+- `contract_address` - address of the contract to invoke.
+- `entry_point_selector` - the name of the function to invoke, as Cairo shortstring.
+- `calldata` - inputs to the function to be invoked.
+- `max_fee` - max fee for declare transaction. If not provided, max fee will be automatically estimated.
+- `nonce` - nonce for declare transaction. If not provided, nonce will be set automatically.
+
+```rust
+use sncast_std::{invoke, InvokeResult};
+use starknet::{ContractAddress, Felt252TryIntoContractAddress};
+
+fn main() {
+    let contract_address: ContractAddress = 0x1e52f6ebc3e594d2a6dc2a0d7d193cb50144cfdfb7fdd9519135c29b67e427
+        .try_into()
+        .expect('Invalid contract address value');
+
+    let invoke_result = invoke(
+        contract_address, 'put', array![0x1, 0x2], Option::None, Option::None
+    );
+
+}
+```

docs/src/appendix/cast/common.md

@@ -59,6 +59,16 @@ Optional.
 
 If passed, command will wait until transaction is accepted or rejected.
 
+## `--wait-timeout <TIME_IN_SECONDS>`
+Optional.
+
+If `--wait` is passed, this will set the time after which cast times out. Defaults to 60s.
+
+## `--wait-retry-timeout <TIME_IN_SECONDS>`
+Optional.
+
+If `--wait` is passed, this will set the retry interval - how often cast should fetch tx info from the node. Defaults to 5s.
+
 ## `--version, -v`
 
 Prints out `sncast` version.

docs/src/appendix/cast/declare.md

@@ -10,3 +10,8 @@ Name of the contract. Contract name is a part after the mod keyword in your cont
 Optional.
 
 Max fee for transaction. If not provided, max fee will be automatically estimated.
+
+## `--nonce, -n <NONCE>`
+Optional.
+
+Nonce for transaction. If not provided, nonce will be set automatically.

docs/src/appendix/cast/deploy.md

@@ -25,3 +25,8 @@ If passed, the salt will be additionally modified with an account address.
 Optional.
 
 Max fee for the transaction. If not provided, max fee will be automatically estimated.
+
+## `--nonce, -n <NONCE>`
+Optional.
+
+Nonce for transaction. If not provided, nonce will be set automatically.

docs/src/appendix/cast/invoke.md

@@ -21,3 +21,8 @@ Calldata arguments may be either 0x hex or decimal felts.
 Optional.
 
 Max fee for the transaction. If not provided, it will be automatically estimated.
+
+## `--nonce, -n <NONCE>`
+Optional.
+
+Nonce for transaction. If not provided, nonce will be set automatically.