feat: add provider interface

Biglup · Sep 27, 2024 · c5c5c4a · c5c5c4a
1 parent 40b10c1
commit c5c5c4a
Show file tree

Hide file tree

Showing 6 changed files with 1,092 additions and 0 deletions.
diff --git a/doc/src/sections/api/providers/index.rst b/doc/src/sections/api/providers/index.rst
@@ -0,0 +1,10 @@
+Providers
+===================
+
+This section of the documentation introduces the data providers for interacting with the Cardano blockchain:
+
+.. toctree::
+ :maxdepth: 1
+
+ provider
+ provider_impl
diff --git a/doc/src/sections/api/providers/provider.rst b/doc/src/sections/api/providers/provider.rst
@@ -0,0 +1,68 @@
+Provider
+==========================
+
+.. doxygentypedef:: cardano_provider_t
+
+------------
+
+.. doxygenfunction:: cardano_provider_new
+
+------------
+
+.. doxygenfunction:: cardano_provider_get_name
+
+------------
+
+.. doxygenfunction:: cardano_provider_get_parameters
+
+------------
+
+.. doxygenfunction:: cardano_provider_get_unspent_outputs
+
+------------
+
+.. doxygenfunction:: cardano_provider_get_unspent_outputs_with_asset
+
+------------
+
+.. doxygenfunction:: cardano_provider_get_unspent_output_by_nft
+
+------------
+
+.. doxygenfunction:: cardano_provider_resolve_unspent_outputs
+
+------------
+
+.. doxygenfunction:: cardano_provider_resolve_datum_outputs
+
+------------
+
+.. doxygenfunction:: cardano_provider_confirm_transaction_outputs
+
+------------
+
+.. doxygenfunction:: cardano_provider_submit_transaction
+
+------------
+
+.. doxygenfunction:: cardano_provider_evaluate_transaction
+
+------------
+
+.. doxygenfunction:: cardano_provider_unref
+
+------------
+
+.. doxygenfunction:: cardano_provider_ref
+
+------------
+
+.. doxygenfunction:: cardano_provider_refcount
+
+------------
+
+.. doxygenfunction:: cardano_provider_set_last_error
+
+------------
+
+.. doxygenfunction:: cardano_provider_get_last_error
diff --git a/doc/src/sections/api/providers/provider_impl.rst b/doc/src/sections/api/providers/provider_impl.rst
@@ -0,0 +1,45 @@
+Provider Implementation
+==========================
+
+.. doxygentypedef:: cardano_provider_impl_t
+
+------------
+
+.. doxygentypedef:: cardano_get_parameters_func_t
+
+
+------------
+
+.. doxygentypedef:: cardano_get_unspent_outputs_func_t
+
+------------
+
+.. doxygentypedef:: cardano_get_unspent_outputs_with_asset_func_t
+
+------------
+
+.. doxygentypedef:: cardano_get_unspent_output_by_nft_func_t
+
+------------
+
+.. doxygentypedef:: cardano_resolve_unspent_outputs_func_t
+
+
+------------
+
+.. doxygentypedef:: cardano_resolve_datum_func_t
+
+------------
+
+.. doxygentypedef:: cardano_confirm_transaction_func_t
+
+
+------------
+
+.. doxygentypedef:: cardano_submit_transaction_func_t
+
+
+------------
+
+.. doxygentypedef:: cardano_evaluate_transaction_func_t
+
diff --git a/doc/src/sections/index.rst b/doc/src/sections/index.rst
@@ -83,6 +83,7 @@ See `APACHE LICENSE, VERSION 2.0`_
  api/pool_params/index
  api/proposal_procedures/index
  api/protocol_params/index
+ api/providers/index
  api/scripts/index
  api/transaction/index
  api/transaction_body/index