invarch / saturn-sdk

Saturn Multisig SDK

Saturn SDK Documentation

Please visit: https://saturn-docs.invarch.network

saturn-sdk's Issues

Add/remove members

Compute parachain balances of multisig account

List open calls

Implement a complex permission builder

Create multisig call

Execute transact instructions

Configure thresholds

Vote/remove vote from open call

Create multisig

There should be a function to create a multisig, taking the INV-Core parameters like threshold and default permission as arguments in the function.

Preset calls with metadata

Saturn allows for custom metadata that can be used for the call being made to carry it's context and intentions with it to be interpreted and used in custom renders that replace the traditional call data json/yaml renders.

We should have preset calls that come with metadata already in it and we should have a metadata matcher to interpret metadata from retrieved multisig calls.

Things like function:metadata:

batchMemberManagement:"Sat:BMM"
setParameters:"Sat:SP"
callXcm:"Sat:CX"
balanceTransfer:"Sat:BT"
xcmBalanceTransfer:"Sat:XBT"

And then the matcher could take the entire multisig call data and transform it into an enum like so:

enum {
batchMemberManagement { members: {adding: bool, who: account, amount: number}[] },
setParameters { metadata: string, frozenTokens: bool, minimumSupport: perbill, requiredApproval: perbill },
callXcm { destination: string, call: string, weight: number },
balanceTransfer { to: account, amount: number },
xcmBalanceTransfer { asset: { chain: string, token: string }, to: account, amount: number }
}

This basically allows for extremely easy Saturn integration with the ability to create custom rendering for these predefined calls, and also gives developers the base to implement their own predefined functions with custom metadata and matchers.

Saturn SDK v2

Saturn SDK v2 will be a complete rewrite on Rust using Subxt as the Substrate client, the goal is to have a WASM binary with TypeScript interfaces generated through bindgen, this should solve every issue that comes with p.js api's approach of type generation by using only Rust primitives with direct TS equivalents in the function signatures and letting the Rust/Substrate type conversions happen inside the Rust functions.

As a bonus we also get a Rust version of the SDK with no extra work.

Compute derived addresses

Generate and process custom metadata

Generalized chain API interface

The SDK currently revolves around polkadot-js/api, this issue tracks the implementation of a generalized interface and the integration of not only polkadot-js/api into this interface, but also other read/write APIs, like CAPI and substrate-api-sidecar.

Compute votes

Overall architecture

We should have a class that contains all of the functions and keep everything up to general typescript standards.
Or another architecture designed besides classes if it would make fora better design.

Execute token transfers

Create ranks

Compute balances of multisig account