@kagamidigital/salt-sdk-mirror
    Preparing search index...

    Interface NudgePayload

    interface NudgePayload {
        accountId?: string;
        accountPublicKey?: string;
        from: string;
        organisationId: string;
        partyId?: number;
        sessionId?: string;
        sessionType?: "keygen" | "signing" | "sign-message";
        threshold?: number;
        to: string;
        totalParties?: number;
        transactionId?: string;
    }
    Index

    Properties

    accountId? accountPublicKey? from organisationId partyId? sessionId? sessionType? threshold? to totalParties? transactionId?

    Properties

    accountId?: string

    salt account id

    '4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97'
    accountPublicKey?: string

    External public key of the account. Used by signing participants as the discriminator when looking up the signer's keyshare for this account in the on-chain shard registry. Included on signing nudges.

    '0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f971E7877BF73cE8B0BAD5f97E787'
    from: string

    address of the user nudging

    '0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97'
    organisationId: string

    salt organisation id

    '4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97'
    partyId?: number

    Zero-based index of this party in the ceremony. Included in keygen nudges.

    sessionId?: string

    MPC session ID on the relay. Present on nudges that announce a new keygen or signing session.

    sessionType?: "keygen" | "signing" | "sign-message"

    Kind of MPC session the nudge announces.

    threshold?: number

    Signing threshold for the ceremony. Included in keygen nudges.

    to: string

    address of the user being nudged

    '0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97'
    totalParties?: number

    Total number of parties in the ceremony. Included in keygen nudges.

    transactionId?: string

    Salt DB transaction record id. Included on signing nudges so a broadcasting participant can update the record's state through BROADCAST/SUCCESS/FAILURE without re-creating it.

    Settings

    Member Visibility

    On This Page

    Properties