Type Alias AccountPolicy

Policies are set on a SaltAccount within an Organisation, and can be used to limit which transactions are allowed.

type AccountPolicy = {
    accountId: string;
    chain: string;
    description: string;
    id: string;
    name: string;
    organisationId: string;
    params: unknown;
    type:
        | "POLICY_ALLOWED_RECIPIENTS"
        | "POLICY_DENIED_RECIPIENTS"
        | "POLICY_TRANSACTION_LIMIT_TOKEN_DENOMINATED"
        | "POLICY_NOMINATED_APPROVERS"
        | "POLICY_DENIED_PROPOSERS";
}

Index

Properties

accountId chain description id name organisationId params type

Properties

accountId

accountId: string

ID of the account the policy belongs to

Example

'6824aa9c27c0fa91b32800a4'

chain

chain: string

Chain ID of the policy. All policies are associated with a single chain.

Example

'11155111'

description

description: string

Policy creator's longer description of the policy

Example

'Limit the size of transfers on Ethereum Sepolia'

id

id: string

name

name: string

Policy creator's name for the policy, a short summary of the policy.

Example

'Limit Amount per Transfer'

organisationId

organisationId: string

ID of the organisation the policy belongs to

Example

'679240f8d14559b720d3ba54'

params

params: unknown

The precise parameters of the policy, specific to the policy type.

type

Type of the policy

Example

'POLICY_TRANSACTION_LIMIT_TOKEN_DENOMINATED'

Type Alias AccountPolicy

Index

Properties

Properties

accountId

Example

chain

Example

description

Example

id

name

Example

organisationId

Example

params

type

Example

Settings

On This Page