Skip to content

Commit c213c29

Browse files
authored
docs: types format fix for generated docs (#1075)
* docs: types format fix for generated docs * docs: Update index.ts
1 parent d5f0b75 commit c213c29

File tree

4 files changed

+8
-0
lines changed

4 files changed

+8
-0
lines changed

src/types/lib/contract/index.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import { CompiledSierra, SierraContractClass } from './sierra';
44
// Final types
55
/**
66
* format produced after compressing compiled contract
7+
*
78
* CompressedCompiledContract
89
*/
910
export type ContractClass = LegacyContractClass | SierraContractClass;

src/types/lib/contract/sierra.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ export type CairoAssembly = {
1515
/** COMPILED CONTRACT */
1616
/**
1717
* format produced after starknet-compile .cairo to .json
18+
*
1819
* sierra_program is hex array
1920
*/
2021
export type CompiledSierra = {
@@ -27,6 +28,7 @@ export type CompiledSierra = {
2728

2829
/**
2930
* format produced after compressing 'sierra_program', stringifies 'abi' property and omit sierra_program_debug_info
31+
*
3032
* CompressedCompiledSierra
3133
*/
3234
export type SierraContractClass = Omit<CompiledSierra, 'abi' | 'sierra_program_debug_info'> & {

src/types/lib/index.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ export type ByteArray = {
1818

1919
/**
2020
* Compiled calldata ready to be sent
21+
*
2122
* decimal-string array
2223
*/
2324
export type Calldata = string[] & { readonly __compiled__?: true };
@@ -46,6 +47,7 @@ export interface Uint512 {
4647

4748
/**
4849
* BigNumberish array
50+
*
4951
* use CallData.compile() to convert to Calldata
5052
*/
5153
export type RawCalldata = BigNumberish[];

src/types/provider/response.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,8 +152,11 @@ export type PendingStateUpdate = PENDING_STATE_UPDATE;
152152

153153
/**
154154
* Standardized type
155+
*
155156
* Cairo0 program compressed and Cairo1 sierra_program decompressed
157+
*
156158
* abi Abi
159+
*
157160
* CompiledSierra without '.sierra_program_debug_info'
158161
*/
159162
export type ContractClassResponse =

0 commit comments

Comments
 (0)