TS SDK pain points

[matt-user]

Hey all, I finished working on a frontend using the ts-sdk and thought I would share some pain points.

1. Command fuels versions not working #1882
2. Nit: fuels dev docs should mention build, type gen, and deploy (I think it only mentions build and deploy)
3. when I used fuels init without create fuels I had difficulty using fuels dev "default account cannot deploy contracts bc of insufficient funds"
4. I didn't use create fuels bc I didn't see it in the cli portion of the docs
5. I also had issues with the private key field not working on the fuels config.
6. Typegen does not automatically use configured inputs and outputs specified in the config
7. Difficulty importing enum from contract Abi so I had to remember what the underlying data of the enum
8. Its hard to distinguish log events from each other. I have to look at the sway code.
   Support logs in typegen #2330
9. Add some documentation about the .fuels folder generated (just a note that it gets created from fuels is probably sufficient)
10. Command fuels dev hangs on generating types #1886
    
11. It would also be nice to just have to list one connector and not all of them

[arboleya]

@matt-user Thanks for putting this feedback together.

I did some formatting and started addressing the first point.

[arboleya]

@matt-user How often the 10th item happens?

[matt-user]

It happened every time for me. I was not able to get it to work.

[danielbate]

Difficulty importing enum from contract Abi so I had to remember what the underlying data of the enum

Do you have an example for this? We can definitely improve enums, #1844 suggests something similar so may be able to sync up the solution.

[matt-user]

Looking back my issue was actually importing the enums not constructing them. I'd like to do something like this gameState === StateOutput.Ended, but I can't import StateOutput so instead I have to do gameState === "Ended". It could be an issue in how I build my app I guess

[petertonysmith94]

Investigate further

3. when I used fuels init without create fuels I had difficulty using fuels dev "default account cannot deploy contracts bc of insufficient funds"

5. I also had issues with the private key field not working on the fuels config.

Potentially related to:

• Remove all state from default stateConfig.json #2783

---

Raise issues

2. Nit: fuels dev docs should mention build, type gen, and deploy (I think it only mentions build and deploy)

Missing links on the homepage to:

• fuels node
• fuels typegen
• fuels versions

9. Add some documentation about the .fuels folder generated (just a note that it gets created from fuels is probably sufficient)

Add issue around documenting the .fuels folder

---

Further discussion required

6. Typegen does not automatically use configured inputs and outputs specified in the config

I can see that we currently don't pass down the config to the typegen command:

https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuels/src/cli.ts#L94-L96

However, potentially the command you were looking to use was the fuels build command which will build the Sway code and typegen. Maybe this is a documentation issue?

7. Difficulty importing enum from contract Abi so I had to remember what the underlying data of the enum

We do export types for the enums in the contract (example below).

pub enum Difficulty {
    Easy: bool,
    Medium: bool,
    Hard: bool,
}

Generates:

export type DifficultyInput = Enum<{
  Easy: boolean;
  Medium: boolean;
  Hard: boolean;
}>;

Maybe we also want to build out the TypeScript base enums as well?

export enum Difficulty {
  Easy = "Easy",
  Medium = "Medium",
  Hard = "Hard",
}

What do you think @nedsalk?

8. Its hard to distinguish log events from each other. I have to look at the sway code.

🍊 There is this issue open for supporting logs in Typegen. I know currently all our logs are typed as any which is not ideal.

Do you think we can alleviate this with the above? cc. @nedsalk

---

Maybe resolved

4. I didn't use create fuels bc I didn't see it in the cli portion of the docs

I believe this has been resolved by moving Creating a Fuel dApp after Getting Started.

What do you think @matt-user?

11. It would also be nice to just have to list one connector and not all of them

:green: I assume this has been resolved by the defaultConnectors exports from @fuels/connectors - would you agree @matt-user?

import { Fuel } from "fuels";
import { defaultConnectors } from "@fuels/connectors";

const fuel = new Fuel({
  connectors: defaultConnectors({ devMode: true }),
});

[nedsalk]

Maybe we also want to build out the TypeScript base enums as well?

export enum Difficulty {
 Easy = "Easy",
 Medium = "Medium",
 Hard = "Hard",
}```

We can do that when mapping native sway enums (that only have () types), but generally enums behave the same as structs so we can't do much about that and we have to map them as types and not as typescript enums.

Its hard to distinguish log events from each other. I have to look at the sway code.
🍊 There is this #2330 open for supporting logs in Typegen. I know currently all our logs are typed as any which is not ideal.
Do you think we can alleviate this with the above?

Yes, that issue should fix it.