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

    Type Alias Policy

    A policy set on a SaltAccount within an Organisation, used to limit which transactions are allowed. This is the shape the SDK surfaces for a policy everywhere — policy CRUD, the policies embedded in an account, and policy-check results.

    type Policy = {
        accountId: string;
        chain: string;
        description?: string;
        id: string;
        name?: string;
        organisationId: string;
        params: PolicyParams;
        type:
            | "allowed_recipients"
            | "denied_recipients"
            | "transaction_limit_token_denominated"
            | "nominated_approvers"
            | "denied_proposers"
            | "contract_param_restriction";
    }
    Index

    Properties

    accountId: string

    ID of the account the policy belongs to.

    '6824aa9c27c0fa91b32800a4'
    
    chain: string

    Chain ID the policy applies to, or '*' to apply it on every chain. Chain matching is an exact string comparison against the transaction's network.

    '11155111'
    
    description?: string

    Longer description of the policy, derived from the policy type. The backend populates this on every endpoint that returns policies.

    'Limit the size of transfers on Ethereum Sepolia'
    
    id: string

    ID of the policy.

    '6824aa9c27c0fa91b32800a4'
    
    name?: string

    Short, human-readable label for the policy, derived from the policy type. The backend populates this on every endpoint that returns policies.

    'Limit Amount per Transfer'
    
    organisationId: string

    ID of the organisation the policy belongs to.

    '679240f8d14559b720d3ba54'
    
    params: PolicyParams

    The precise parameters of the policy. See PolicyParams for which member corresponds to which policy type, and how to narrow it.

    type:
        | "allowed_recipients"
        | "denied_recipients"
        | "transaction_limit_token_denominated"
        | "nominated_approvers"
        | "denied_proposers"
        | "contract_param_restriction"

    Type of the policy.

    'transaction_limit_token_denominated'