Added SDK matrix (#632)

* Added SDK matrix * Exposed transaction_data
availproject · Aug 20, 2024 · bd51db2 · bd51db2
1 parent 5dc73fb
commit bd51db2
Show file tree

Hide file tree

Showing 39 changed files with 86 additions and 37,827 deletions.
diff --git a/LIBRARY_MATRIX.md b/LIBRARY_MATRIX.md
@@ -0,0 +1,79 @@
+#### Labels
+- L1 - Available throught SDK as a function
+- L2 - Can be done but requires extra work
+
+## Extrinsics
+
+#### Data Availability
+
+| Lib        | Submit Data | Submit Block Length Proposal | Create Application Key | Set Application Key | Set Submit Data Fee Modifier |
+| ---------- | ----------- | ---------------------------- | ---------------------- | ------------------- | ---------------------------- |
+| Avail-Rust | L1          | L1                           | L1                     | L1                  | L1                           |
+| Avail-JS   | L1          | L1                           | L1                     | L1                  | L1                           |
+| Avail-Deno | L1          | L1                           | L1                     | L1                  | L1                           |
+| Avail-Go   | -           | -                            | -                      | -                   | -                            |
+
+#### Balances
+
+| Lib        | Transfer All | Transfer Allow Death | Transfer Keep Alive |
+| ---------- | ------------ | -------------------- | ------------------- |
+| Avail-Rust | L1           | L1                   | L1                  |
+| Avail-JS   | L1           | L1                   | L1                  |
+| Avail-Deno | L1           | L1                   | L1                  |
+| Avail-Go   | -            | -                    | -                   |
+
+#### Staking
+
+| Lib        | Bond | Bond Extra | Chill | Chill Extra | Nomiate | Unbound | Validate |
+| ---------- | ---- | ---------- | ----- | ----------- | ------- | ------- | -------- |
+| Avail-Rust | L1   | L1         | L1    | L1          | L1      | L1      | L1       |
+| Avail-JS   | L1   | L1         | L1    | L1          | L1      | L1      | L1       |
+| Avail-Deno | L1   | L1         | L1    | L1          | L1      | L1      | L1       |
+| Avail-Go   | -    | -          | -     | -           | -       | -       | -        |
+
+## RPCs
+
+#### Kate
+
+| Lib        | Block Length | Query Data Proof | Query Proof | Query Rows |
+| ---------- | ------------ | ---------------- | ----------- | ---------- |
+| Avail-Rust | L1           | L1               | L1          | L1         |
+| Avail-JS   | -            | -                | -           | -          |
+| Avail-Deno | -            | -                | -           | -          |
+| Avail-Go   | -            | -                | -           | -          |
+
+#### Author
+
+| Lib        | Rotate Keys | Has Key | Has Session Key | Insert Key | Pending Extrinsics | Remove Extrinsic | Submit Extrinsic |
+| ---------- | ----------- | ------- | --------------- | ---------- | ------------------ | ---------------- | ---------------- |
+| Avail-Rust | L1          | -       | -               | -          | -                  | -                | -                |
+| Avail-JS   | -           | -       | -               | -          | -                  | -                | -                |
+| Avail-Deno | -           | -       | -               | -          | -                  | -                | -                |
+| Avail-Go   | -           | -       | -               | -          | -                  | -                | -                |
+
+#### Chain
+
+| Lib        | Get Block | Get Block Hash | Get Finalized Head | Get Header |
+| ---------- | --------- | -------------- | ------------------ | ---------- |
+| Avail-Rust | L1        | L1             | L1                 | L1         |
+| Avail-JS   | -         | -              | -                  | -          |
+| Avail-Deno | -         | -              | -                  | -          |
+| Avail-Go   | -         | -              | -                  | -          |
+
+#### Payment
+
+| Lib        | Query Fee Details | Query Info |
+| ---------- | ----------------- | ---------- |
+| Avail-Rust | L1*               | L1*        |
+| Avail-JS   | -                 | -          |
+| Avail-Deno | -                 | -          |
+| Avail-Go   | -                 | -          |
+
+#### System
+
+| Lib        | Account Next Index | Add Log Filter | Add Reserved Peer | Chain | Chain Type | Dry Run | Health | Local Listen Addresses | Local Peer Id | Name | Node Roles | Peers | Properties | Removed Reserved Peer | Reserved Peers | Reset Log Filter | Sync State | Version |
+| ---------- | ------------------ | -------------- | ----------------- | ----- | ---------- | ------- | ------ | ---------------------- | ------------- | ---- | ---------- | ----- | ---------- | --------------------- | -------------- | ---------------- | ---------- | ------- |
+| Avail-Rust | L1                 | -              | -                 | L1    | L1         | -       | L1     | L1                     | L1            | L1   | L1         | L1    | L1         | -                     | -              | -                | L1         | L1      |
+| Avail-JS   | -                  | -              | -                 | -     | -          | -       | -      | -                      | -             | -    | -          | -     | -          | -                     | -              | -                | -          | -       |
+| Avail-Deno | -                  | -              | -                 | -     | -          | -       | -      | -                      | -             | -    | -          | -     | -          | -                     | -              | -                | -          | -       |
+| Avail-Go   | -                  | -              | -                 | -     | -          | -       | -      | -                      | -             | -    | -          | -     | -          | -                     | -              | -                | -          | -       |
diff --git a/avail-deno/docs/README.md b/avail-deno/docs/README.md
@@ -1,3 +1,4 @@
 # Structure
 
 - `/extrinsics/` folder contains API reference and examples for SDK extrinsics
+- `/advanced-examples/` folder contains advanced examples that showcase how to do things that are not already available through the SDK interface.
diff --git a/avail-deno/adcanced-examples/README.md → avail-deno/docs/advanced-examples/README.md b/avail-deno/adcanced-examples/README.md → avail-deno/docs/advanced-examples/README.md
@@ -1,6 +1,6 @@
 # Structure
 
-If you are looking for the API reference and examples on how to use the SDK check out the `/docs/` folder. This folder contains advanced
+If you are looking for the API reference and examples on how to use the SDK check out the `/extrinsic/` or other folders. This folder contains advanced
 examples that showcase how to do things that are not already available through the SDK interface.
 
 ## Examples

diff --git a/avail-deno/adcanced-examples/connect.ts → avail-deno/docs/advanced-examples/connect.ts b/avail-deno/adcanced-examples/connect.ts → avail-deno/docs/advanced-examples/connect.ts
diff --git a/...ced-examples/estimate_transaction_fees.ts → ...ced-examples/estimate_transaction_fees.ts b/...ced-examples/estimate_transaction_fees.ts → ...ced-examples/estimate_transaction_fees.ts
diff --git a/...adcanced-examples/register_validator.json → ...advanced-examples/register_validator.json b/...adcanced-examples/register_validator.json → ...advanced-examples/register_validator.json
diff --git a/...o/adcanced-examples/register_validator.ts → ...s/advanced-examples/register_validator.ts b/...o/adcanced-examples/register_validator.ts → ...s/advanced-examples/register_validator.ts
diff --git a/...d-examples/rpc_kate_query_block_length.ts → ...d-examples/rpc_kate_query_block_length.ts b/...d-examples/rpc_kate_query_block_length.ts → ...d-examples/rpc_kate_query_block_length.ts
diff --git a/...ced-examples/rpc_kate_query_data_proof.ts → ...ced-examples/rpc_kate_query_data_proof.ts b/...ced-examples/rpc_kate_query_data_proof.ts → ...ced-examples/rpc_kate_query_data_proof.ts
diff --git a/...adcanced-examples/rpc_kate_query_proof.ts → ...advanced-examples/rpc_kate_query_proof.ts b/...adcanced-examples/rpc_kate_query_proof.ts → ...advanced-examples/rpc_kate_query_proof.ts
diff --git a/.../adcanced-examples/rpc_kate_query_rows.ts → .../advanced-examples/rpc_kate_query_rows.ts b/.../adcanced-examples/rpc_kate_query_rows.ts → .../advanced-examples/rpc_kate_query_rows.ts
diff --git a/.../adcanced-examples/subscribe_to_header.ts → .../advanced-examples/subscribe_to_header.ts b/.../adcanced-examples/subscribe_to_header.ts → .../advanced-examples/subscribe_to_header.ts
diff --git a/.../adcanced-examples/tx_balance_transfer.ts → .../advanced-examples/tx_balance_transfer.ts b/.../adcanced-examples/tx_balance_transfer.ts → .../advanced-examples/tx_balance_transfer.ts
diff --git a/...ta_availability_create_application_key.ts → ...ta_availability_create_application_key.ts b/...ta_availability_create_application_key.ts → ...ta_availability_create_application_key.ts
diff --git a/...mples/tx_data_availability_submit_data.ts → ...mples/tx_data_availability_submit_data.ts b/...mples/tx_data_availability_submit_data.ts → ...mples/tx_data_availability_submit_data.ts
diff --git a/...mples/tx_staking_nominate_full_example.ts → ...mples/tx_staking_nominate_full_example.ts b/...mples/tx_staking_nominate_full_example.ts → ...mples/tx_staking_nominate_full_example.ts
diff --git a/...mples/tx_staking_validate_full_example.ts → ...mples/tx_staking_validate_full_example.ts b/...mples/tx_staking_validate_full_example.ts → ...mples/tx_staking_validate_full_example.ts
diff --git a/avail-deno/adcanced-examples/validium.ts → ...l-deno/docs/advanced-examples/validium.ts b/avail-deno/adcanced-examples/validium.ts → ...l-deno/docs/advanced-examples/validium.ts