#substrate #interop #ismp #polkadot-sdk

no-std pallet-hyperbridge

Pallet hyperbridge mediates the connection between hyperbridge and substrate-based chains

2 stable releases

1.6.2 May 10, 2024
1.6.1 May 6, 2024

#2214 in Magic Beans

Download history 139/week @ 2024-05-03 150/week @ 2024-05-10 10/week @ 2024-05-17 4/week @ 2024-05-24

303 downloads per month

Apache-2.0

205KB
3.5K SLoC

Pallet Hyperbridge

Pallet hyperbridge mediates the connection between hyperbridge and substrate-based chains. This pallet provides:

  • An IsmpDispatcher implementation which collects protocol fees and commits the reciepts for these fees to child storage. Hyperbridge only accepts messages that have been paid for using this module.
  • An IsmpModule which recieves and processes requests from hyperbridge. These requests are dispatched by hyperbridge governance and may adjust fees or request payouts for both relayers and protocol revenue.

This pallet contains no calls and dispatches no requests. Substrate based chains should use this to dispatch requests that should be processed by hyperbridge.

Usage

This module must be configured as an IsmpModule in your IsmpRouter implementation so that it may receive important messages from hyperbridge such as paramter updates or relayer fee withdrawals.

use ismp::Error;
use ismp::module::IsmpModule;
use ismp::router::IsmpRouter;
use pallet_hyperbridge::PALLET_HYPERBRIDGE_ID;

#[derive(Default)]
struct ModuleRouter;

impl IsmpRouter for ModuleRouter {
    fn module_for_id(&self, id: Vec<u8>) -> Result<Box<dyn IsmpModule>, Error> {
        return match id.as_slice() {
            PALLET_HYPERBRIDGE_ID => Ok(Box::new(pallet_hyperbridge::Pallet::<Runtime>::default())),
            _ => Err(Error::ModuleNotFound(id)),
        };
    }
}

License

This library is licensed under the Apache 2.0 License, Copyright (c) 2024 Polytope Labs.

Dependencies

~17–35MB
~581K SLoC