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
Copy file name to clipboardExpand all lines: README.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,8 +31,8 @@ Because everything is designed as a `Node`, we can transform the IDL, aggregate
31
31
32
32
There are various ways to extract information from your Solana programs in order to obtain a Codama IDL.
33
33
34
-
-**Using Codama macros**. This is not yet available but you will soon have access to a set of Rust macros that help attach IDL information directly within your Rust code. These macros enable Codama IDLs to be generated whenever you build your programs.
35
-
-**From Anchor IDLs**. If you are using [Anchor programs](https://github.com/coral-xyz/anchor) or [Shank macros](https://github.com/metaplex-foundation/shank), then you can get an Anchor IDL from them. You can then use the `@codama/nodes-from-anchor` package to convert that IDL into a Codama IDL as shown in the code snippet below. Note that the Anchor IDL might not offer all the information that Codama can hold and therefore, you may want to transform your Codama IDL to provide additional information. You can learn more about this in the next section.
34
+
-**Using Codama macros**. This is not yet available but you will soon have access to a set of Rust macros that help attach IDL information directly within your Rust code. These macros enable Codama IDLs to be generated whenever you build your programs.
35
+
-**From Anchor IDLs**. If you are using [Anchor programs](https://github.com/coral-xyz/anchor) or [Shank macros](https://github.com/metaplex-foundation/shank), then you can get an Anchor IDL from them. You can then use the `@codama/nodes-from-anchor` package to convert that IDL into a Codama IDL as shown in the code snippet below. Note that the Anchor IDL might not offer all the information that Codama can hold and therefore, you may want to transform your Codama IDL to provide additional information. You can learn more about this in the next section.
36
36
37
37
```ts
38
38
import { createFromRoot } from'codama';
@@ -42,7 +42,7 @@ There are various ways to extract information from your Solana programs in order
@@ -61,12 +61,12 @@ Now that you have the perfect Codama IDL for your Solana program, you can benefi
61
61
62
62
_NotethatsomefeaturessuchasrenderingCLIsarenotyetavailable. However, becausetheCodamaIDLisdesignedasatreeofnodes, thesefeaturesareonlyavisitorawayfrombeingready. Feelfreetoreachoutifyou’dliketocontributetothisCodamaecosystem._
Copy file name to clipboardExpand all lines: packages/errors/README.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -75,9 +75,9 @@ To add a new error in Codama, follow these steps:
75
75
76
76
### Removing an error message
77
77
78
-
-Don't remove errors.
79
-
-Don't change the meaning of an error message.
80
-
-Don't change or reorder error codes.
81
-
-Don't change or remove members of an error's context.
78
+
- Don't remove errors.
79
+
- Don't change the meaning of an error message.
80
+
- Don't change or reorder error codes.
81
+
- Don't change or remove members of an error's context.
82
82
83
83
When an older client throws an error, we want to make sure that they can always decode the error. If you make any of the changes above, old clients will, by definition, not have received your changes. This could make the errors that they throw impossible to decode going forward.
0 commit comments