Skip to main content

Python package to sign on-chain self-custodial requests for orders, transfers, deposits, withdrawals and RFQs.

Project description

v2-action-signing-python

Python package to sign the following on-chain self-custodial requests:

  1. order
  2. RFQ quote
  3. RFQ execution
  4. transfer positions

Although the below actions are supported by the SDK, we recommend you use the UX developer portal (https://docs.derive.xyz/docs/onboard-via-interface):

  1. create subaccount
  2. deposit
  3. withdrawal
  4. transfer collateral

Usage

  1. Install package: pip install lyra_v2_action_signing

  2. Sign an order

from web3 import Web3
from lyra_v2_action_signing import SignedAction, TradeModuleData, utils

session_key_wallet = Web3().eth.account.from_key("0x2ae8be44db8a590d20bffbe3b6872df9b569147d3bf6801a35a28281a4816bbd")

action = SignedAction(
    subaccount_id=30769,
    owner=SMART_CONTRACT_WALLET_ADDRESS, # from Protocol Constants table in docs.lyra.finance
    signer=session_key_wallet.address,
    signature_expiry_sec=utils.MAX_INT_32,
    nonce=utils.get_action_nonce(),
    module_address=TRADE_MODULE_ADDRESS, # from Protocol Constants table in docs.lyra.finance
    module_data=TradeModuleData(
        asset=instrument_ticker["base_asset_address"],
        sub_id=int(instrument_ticker["base_asset_sub_id"]),
        limit_price=Decimal("100"),
        amount=Decimal("1"),
        max_fee=Decimal("1000"),
        recipient_id=30769,
        is_bid=True,
    ),
    DOMAIN_SEPARATOR=DOMAIN_SEPARATOR, # from Protocol Constants table in docs.derive.xyz
    ACTION_TYPEHASH=ACTION_TYPEHASH, # from Protocol Constants table in docs.derive.xyz
)

action.sign(session_key_wallet.key)

For full signing examples see examples/ in https://github.com/derivexyz/v2-action-signing-python/tree/master/examples.

Acknowledgements

Thank you 8baller for building a full Python client for the v2 API. Much of the signing logic in the repo was used to inform this package: https://github.com/8ball030/lyra_client

Developers

  1. Create venv and run pip install -e ., this reflects changes in package immediately in venv
  2. Install dev related packages with pip install -r requirements-dev.txt

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lyra_v2_action_signing-0.0.7.tar.gz (8.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lyra_v2_action_signing-0.0.7-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

Details for the file lyra_v2_action_signing-0.0.7.tar.gz.

File metadata

  • Download URL: lyra_v2_action_signing-0.0.7.tar.gz
  • Upload date:
  • Size: 8.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for lyra_v2_action_signing-0.0.7.tar.gz
Algorithm Hash digest
SHA256 eb477aa9a7d9956d87e3f46da3132ce58df49f762efce95ed8a70f864cf911e3
MD5 a00e231973dd2b5128a2475740a97da8
BLAKE2b-256 a55ffee8315c9267344207b74c61ee005ead56a170f56976ad1549b8164b5fc3

See more details on using hashes here.

File details

Details for the file lyra_v2_action_signing-0.0.7-py3-none-any.whl.

File metadata

File hashes

Hashes for lyra_v2_action_signing-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 d909dfe53101b3a5cc283498c6ce34a66d269c4c809b070d492f85afccd85c23
MD5 7038b1788a9573e151dda8a5aa91fa45
BLAKE2b-256 0d8dad1d45e6a35595d902b6046a733e96f5c6a2e942656d393347e23b9129bc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page