You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This issue describes the type of content we need to create for the API/SDK reference section of this issue's parent issue (#287).
Here's the stuff we need to display:
Method descriptions
Parameter explanations
Return value details
Error handling
Let's dive into a bit more detail for each fo these sections.
Method descriptions
These should be a clear and concise explanation of the method functionality. Essentially, we need to explain the method's role in the broader SDK context, and mention any side effects or important behavioral notes.
createAccount(params)
- Creates a new account.
- Generates a unique address identifier.
- Triggers account initialization workflows.
Parameters
Parameter explanation should include:
Data type
Whether it's required or optional
Default value (if applicable)
Validation rules
Example values
Constraints
For example:
Parameters:
- account: string
- Required
- Must be unique
- 3-50 characters long
- Allowed characters: alphanumeric
- Example: "0x2907y4fb8tspiubteciu3296t"
Essentially, how does the SDK handle errors? Or do it not, and expects the devs to handle them instead? If the SDK does handle errors we need to list the following:
Child of #287
This issue describes the type of content we need to create for the API/SDK reference section of this issue's parent issue (#287).
Here's the stuff we need to display:
Let's dive into a bit more detail for each fo these sections.
Method descriptions
These should be a clear and concise explanation of the method functionality. Essentially, we need to explain the method's role in the broader SDK context, and mention any side effects or important behavioral notes.
Parameters
Parameter explanation should include:
For example:
Return values
Error handling
Essentially, how does the SDK handle errors? Or do it not, and expects the devs to handle them instead? If the SDK does handle errors we need to list the following:
The text was updated successfully, but these errors were encountered: