Skip to content

Latest commit

 

History

History
114 lines (62 loc) · 7.53 KB

PolicyRule.md

File metadata and controls

114 lines (62 loc) · 7.53 KB
Raw

PolicyRule

Properties

Name Type Description Notes
type string Policy rule type [default to undefined]
action string Defines what occurs when a transaction meets the rule's criteria * ALLOW - The transaction goes through and can be signed without requiring additional approvals * BLOCK - The transaction is automatically blocked * 2-TIER - Only these users or user groups can approve If any of them reject the transaction before the required approval threshold is met, the transaction doesn't go through The list of entities are set is "authorizationGroups" field [default to undefined]
asset string Defines the type of asset being transacted, options are * "*" - All assets * Specific asset [default to undefined]
amountCurrency string * USD - Limits the amount of any asset users can transfer based on the USD equivalent of the asset. * EUR - Limits the amount of any asset users can transfer based on the EURO equivalent of the asset. * NATIVE - Limits the amount of an asset a user can transfer when using a specific asset. [default to undefined]
amountScope string * SINGLE_TX - limit applies to a single transaction * TIMEFRAME - limit applies to all transactions within the defined time period [default to undefined]
amount PolicyRuleAmount [default to undefined]
periodSec number Time period in seconds applied by the amountScope field to accumulate transferred amounts in transactions that match the rule, until the total exceeds the value you specify under Minimum. When the specified amount is reached within that period, whether by one or many transactions, further transactions in that period either fail or require more approvals. [default to undefined]
operator string (deprecated - replaced by "operators") Defines users who can initiate the type of transaction to which the rule applies. options are * "*" - All users are allowed * Specific User id
operators PolicyRuleOperators [optional] [default to undefined]
transactionType string Defines the type of transaction to which the rule applies. * TRANSFER - Default. Transfers funds from one account to another * CONTRACT_CALL - Calls a smart contract, mainly for DeFi operations. * APPROVE - Allows a smart contract to withdraw from a designated wallet. * MINT - Perform a mint operation (increase supply) on a supported token * BURN - Perform a burn operation (reduce supply) on a supported token * SUPPLY - Use for DeFi to lend assets * REDEEM - Use for DeFi to get lending back * STAKE - Allows you to allocate and lock certain assets for earning staking rewards. * RAW - An off-chain message with no predefined format, use it to sign any message with your private key. * TYPED_MESSAGE - An off-chain message type that follows a predefined format, used to sign specific messages that are not actual transactions. [optional] [default to undefined]
designatedSigner string (deprecated - replaced by "designatedSigners") Id representing the user who signs transactions that match a specific rule [optional] [default to undefined]
designatedSigners PolicyRuleDesignatedSigners [optional] [default to undefined]
srcType PolicySrcOrDestType (deprecated - replaced by "src") source account type [optional] [default to undefined]
srcSubType PolicySrcOrDestSubType (deprecated - replaced by "src") source sub account type [optional] [default to undefined]
srcId string (deprecated - replaced by "src") source account id [optional] [default to undefined]
src PolicyRuleSrc [optional] [default to undefined]
dstType PolicySrcOrDestType (deprecated - replaced by "dst") destination account type [optional] [default to undefined]
dstSubType PolicySrcOrDestSubType (deprecated - replaced by "dst") destination sub account type [optional] [default to undefined]
dstId string (deprecated - replaced by "dst") destination account id [optional] [default to undefined]
dst PolicyRuleDst [optional] [default to undefined]
dstAddressType string Defines whether the destination to which you are sending funds must be whitelisted, to allow one-time transfers to non-whitelisted external addresses, or both. By default, you can only transfer to an external address after it’s whitelisted. * WHITELISTED - Can only be sent to whitelisted addresses. * ONE_TIME - Can only be sent to non-whitelisted external addresses. * "*" - can be sent to whitelisted addresses or non-whitelisted external [optional] [default to undefined]
authorizers Array<string> (deprecated - replaced by &quot;authorizationGroups&quot;) Allowed entities which can approves a transaction [optional] [default to undefined]
authorizersCount number (deprecated - replaced by &quot;authorizationGroups&quot;) Min amount of entities which are needed to approve a transaction [optional] [default to undefined]
authorizationGroups PolicyRuleAuthorizationGroups [optional] [default to undefined]
amountAggregation PolicyRuleAmountAggregation [optional] [default to undefined]
rawMessageSigning PolicyRuleRawMessageSigning [optional] [default to undefined]
applyForApprove boolean Applying this rule over APPROVE type transactions (can only be enabled when rule&#39;s transaction type is TRANSFER) [optional] [default to undefined]
applyForTypedMessage boolean Applying this rule over TYPED_MESSAGE type transactions (can only be enabled when rule&#39;s transaction type is CONTRACT_CALL) [optional] [default to undefined]
externalDescriptor string A unique id identifying the rule [optional] [default to undefined]

Enum: PolicyRuleTypeEnum

  • Transfer (value: 'TRANSFER')

Enum: PolicyRuleActionEnum

  • Allow (value: 'ALLOW')

  • Block (value: 'BLOCK')

  • _2Tier (value: '2-TIER')

Enum: PolicyRuleAmountCurrencyEnum

  • Usd (value: 'USD')

  • Eur (value: 'EUR')

  • Native (value: 'NATIVE')

Enum: PolicyRuleAmountScopeEnum

  • SingleTx (value: 'SINGLE_TX')

  • Timeframe (value: 'TIMEFRAME')

Enum: PolicyRuleTransactionTypeEnum

  • Transfer (value: 'TRANSFER')

  • ContractCall (value: 'CONTRACT_CALL')

  • Approve (value: 'APPROVE')

  • Mint (value: 'MINT')

  • Burn (value: 'BURN')

  • Supply (value: 'SUPPLY')

  • Redeem (value: 'REDEEM')

  • Stake (value: 'STAKE')

  • Raw (value: 'RAW')

  • TypedMessage (value: 'TYPED_MESSAGE')

Enum: PolicyRuleDstAddressTypeEnum

  • Whitelisted (value: 'WHITELISTED')

  • OneTime (value: 'ONE_TIME')

  • Star (value: '*')

[Back to top] [Back to API list] [Back to Model list] [Back to README]