Skip to content

curvegrid/multibaas-sdk-python

Repository files navigation

multibaas-sdk

MultiBaas API provides a unified interface for interacting with blockchain networks. It enables applications to deploy and manage smart contracts, call contract methods, and query blockchain data through standard REST endpoints. The API also includes features for authentication, role-based access control, and integration with existing systems, allowing developers to build blockchain-powered applications without needing deep protocol-level expertise.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 0.0
  • Package version: 1.0.1
  • Generator version: 7.14.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.curvegrid.com/contact

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/curvegrid/multibaas-sdk-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/curvegrid/multibaas-sdk-python.git)

Then import the package:

import multibaas_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import multibaas_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import multibaas_sdk
from multibaas_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://your_deployment.multibaas.com/api/v0
# See configuration.py for a list of all supported configuration parameters.
configuration = multibaas_sdk.Configuration(
    host = "https://your_deployment.multibaas.com/api/v0"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'

# Configure Bearer authorization (JWT): bearer
configuration = multibaas_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with multibaas_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = multibaas_sdk.AddressesApi(api_client)
    chain = multibaas_sdk.ChainName() # ChainName | The blockchain chain label.
    address_or_alias = 'address_or_alias_example' # str | An address or the alias of an address.

    try:
        # Delete address
        api_response = api_instance.delete_address(chain, address_or_alias)
        print("The response of AddressesApi->delete_address:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AddressesApi->delete_address: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://your_deployment.multibaas.com/api/v0

Class Method HTTP request Description
AddressesApi delete_address DELETE /chains/{chain}/addresses/{address-or-alias} Delete address
AddressesApi get_address GET /chains/{chain}/addresses/{address-or-alias} Get address
AddressesApi list_addresses GET /chains/{chain}/addresses List addresses
AddressesApi set_address POST /chains/{chain}/addresses Create or update address
AdminApi accept_invite POST /invites/{inviteID} Accept invite
AdminApi add_cors_origin POST /cors Add CORS origin
AdminApi add_group_api_key PUT /groups/{groupID}/api_keys/{apiKeyID} Add API key to group
AdminApi add_group_role PUT /groups/{groupID}/roles/{roleShortName} Add role to group
AdminApi add_group_user PUT /groups/{groupID}/users/{userID} Add user to group
AdminApi check_invite GET /invites/{inviteID} Check invite
AdminApi create_api_key POST /api_keys Create API key
AdminApi delete_api_key DELETE /api_keys/{apiKeyID} Delete API key
AdminApi delete_invite DELETE /invites/{email}/delete Delete invite
AdminApi delete_user DELETE /users/{userID} Delete user
AdminApi get_api_key GET /api_keys/{apiKeyID} Get API Key
AdminApi get_plan GET /plan Get plan
AdminApi invite_user POST /invites Invite user
AdminApi list_api_keys GET /api_keys List API keys
AdminApi list_audit_logs GET /systemactivities List audit logs
AdminApi list_cors_origins GET /cors List CORS origins
AdminApi list_groups GET /groups List groups
AdminApi list_invites GET /invites List invites
AdminApi list_user_signers GET /users/{userID}/signers List user signers
AdminApi list_users GET /users List users
AdminApi remove_cors_origin DELETE /cors/{originID} Remove CORS Origin
AdminApi remove_group_api_key DELETE /groups/{groupID}/api_keys/{apiKeyID} Remove API key from group
AdminApi remove_group_role DELETE /groups/{groupID}/roles/{roleShortName} Remove role from group
AdminApi remove_group_user DELETE /groups/{groupID}/users/{userID} Remove user from group
AdminApi remove_user_signer_cloud_wallet DELETE /users/{userID}/cloudwallets/{wallet_address} Remove user cloud wallet signer
AdminApi remove_user_signer_safe_account DELETE /users/{userID}/safeaccounts/{wallet_address} Remove user safe account signer
AdminApi remove_user_signer_web3_wallet DELETE /users/{userID}/web3wallets/{wallet_address} Remove user web3 wallet signer
AdminApi set_user_signer_cloud_wallet PUT /users/{userID}/cloudwallets/{wallet_address} Add or update user cloud wallet signer
AdminApi set_user_signer_safe_account PUT /users/{userID}/safeaccounts/{wallet_address} Add or update user safe account signer
AdminApi set_user_signer_web3_wallet PUT /users/{userID}/web3wallets/{wallet_address} Add or update user web3 wallet signer
AdminApi update_api_key PUT /api_keys/{apiKeyID} Update API key
ChainsApi get_block GET /chains/{chain}/blocks/{block} Get a block
ChainsApi get_chain_status GET /chains/{chain}/status Get chain status
ChainsApi get_transaction GET /chains/{chain}/transactions/{hash} Get transaction
ChainsApi get_transaction_receipt GET /chains/{chain}/transactions/receipt/{hash} Get transaction receipt
ChainsApi submit_signed_transaction POST /chains/{chain}/transactions/submit Submit signed transaction
ChainsApi transfer_eth POST /chains/{chain}/transfers Transfer ETH
ContractsApi call_contract_function POST /chains/{chain}/addresses/{address-or-alias}/contracts/{contract}/methods/{method} Call a contract function
ContractsApi create_contract POST /contracts/{contract} Create a contract
ContractsApi create_contracts POST /contracts Create multiple contracts
ContractsApi delete_contract DELETE /contracts/{contract} Delete a contract
ContractsApi delete_contract_version DELETE /contracts/{contract}/{version} Delete a contract version
ContractsApi deploy_contract POST /contracts/{contract}/deploy Deploy a contract
ContractsApi deploy_contract_version POST /contracts/{contract}/{version}/deploy Deploy a contract version
ContractsApi get_contract GET /contracts/{contract} Get a contract
ContractsApi get_contract_version GET /contracts/{contract}/{version} Get a contract version
ContractsApi get_contract_versions GET /contracts/{contract}/all Get all contract versions
ContractsApi get_event_monitor_status GET /chains/{chain}/addresses/{address-or-alias}/contracts/{contract}/status Get event monitor status
ContractsApi get_event_type_conversions GET /contracts/{contract}/{version}/events/{event} Get event type conversions
ContractsApi get_function_type_conversions GET /contracts/{contract}/{version}/methods/{method} Get function type conversions
ContractsApi link_address_contract POST /chains/{chain}/addresses/{address-or-alias}/contracts Link address and contract
ContractsApi list_contract_versions GET /contracts/{contract}/versions List all contract versions
ContractsApi list_contracts GET /contracts List contracts
ContractsApi set_event_type_conversions POST /contracts/{contract}/{version}/events/{event} Set event type conversions
ContractsApi set_function_type_conversions POST /contracts/{contract}/{version}/methods/{method} Set function type conversions
ContractsApi unlink_address_contract DELETE /chains/{chain}/addresses/{address-or-alias}/contracts/{contract} Unlink address and contract
EventQueriesApi count_event_query_records GET /queries/{event_query}/count Count event query records
EventQueriesApi delete_event_query DELETE /queries/{event_query} Delete event query
EventQueriesApi execute_arbitrary_event_query POST /queries Execute arbitrary event query
EventQueriesApi execute_event_query GET /queries/{event_query}/results Execute event query
EventQueriesApi get_event_query GET /queries/{event_query} Get event query
EventQueriesApi list_event_queries GET /queries List event queries
EventQueriesApi set_event_query PUT /queries/{event_query} Create or update event query
EventsApi get_event_count GET /events/count Get event count
EventsApi list_events GET /events List events
HsmApi add_hsm_config POST /hsm/config Add HSM config
HsmApi add_hsm_key POST /hsm/key Add HSM key
HsmApi create_hsm_key POST /hsm/key/new Create HSM key
HsmApi list_hsm GET /hsm List HSM configs and wallets
HsmApi list_hsm_wallets GET /hsm/wallets List HSM wallets
HsmApi remove_hsm_config DELETE /hsm/config/{client_id} Remove HSM config
HsmApi remove_hsm_key DELETE /hsm/key/{wallet_address} Remove HSM key
HsmApi set_local_nonce POST /chains/{chain}/hsm/nonce/{wallet_address} Set local nonce
HsmApi sign_and_submit_transaction POST /chains/{chain}/hsm/submit Sign and submit transaction
HsmApi sign_data POST /chains/{chain}/hsm/sign Sign data
TxmApi cancel_transaction POST /chains/{chain}/txm/{wallet_address}/nonce/{nonce}/cancel Cancel transaction
TxmApi count_wallet_transactions GET /chains/{chain}/txm/{wallet_address}/count Count all transactions for a wallet
TxmApi list_wallet_transactions GET /chains/{chain}/txm/{wallet_address} List transactions for a wallet
TxmApi speed_up_transaction POST /chains/{chain}/txm/{wallet_address}/nonce/{nonce}/speed_up Speed up transaction
WebhooksApi count_webhook_events GET /webhooks/{webhookID}/events/count Count webhook events
WebhooksApi count_webhooks GET /webhooks/count Count webhooks
WebhooksApi create_webhook POST /webhooks Create webhook
WebhooksApi delete_webhook DELETE /webhooks/{webhookID} Delete webhook
WebhooksApi get_webhook GET /webhooks/{webhookID} Get webhook
WebhooksApi list_webhook_events GET /webhooks/{webhookID}/events List webhook events
WebhooksApi list_webhooks GET /webhooks List webhooks
WebhooksApi update_webhook PUT /webhooks/{webhookID} Update webhook

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearer

  • Type: Bearer authentication (JWT)

cookie

  • Type: API key
  • API key parameter name: token
  • Location:

Author

[email protected]

About

MultiBaas Python SDK

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages