Class PoliciesClient

The namespace containing all Policy methods.

Implements

PoliciesClientInterface

Index

Constructors

constructor

Methods

createPolicy deletePolicy getPolicyById listPolicies updatePolicy

Constructors

constructor

new PoliciesClient(): PoliciesClient
Returns PoliciesClient

Methods

createPolicy

createPolicy(options: CreatePolicyOptions): Promise<Policy>
Creates a new policy that can be used to govern the behavior of projects and accounts.
Parameters
- options: CreatePolicyOptions
  Options for creating the policy
  
  Options for creating a Policy.
  - OptionalidempotencyKey?: string
    The idempotency key to ensure the request is processed exactly once. Used to safely retry requests without accidentally performing the same operation twice.
  - policy: {
        description?: string;
        rules: (
            | {
                action: "reject"
                | "accept";
                criteria: (
                    | {
                        ethValue: string;
                        operator: ">"
                        | ">="
                        | "<"
                        | "<="
                        | "==";
                        type: "ethValue";
                    }
                    | {
                        addresses: `0x${string}`[];
                        operator: "in"
                        | "not in";
                        type: "evmAddress";
                    }
                    | {
                        abi: | "erc20"
                        | "erc721"
                        | "erc1155"
                        | readonly (
                            | { inputs: ...; name: ...; type: ... }
                            | { anonymous?: ...; inputs: ...; name: ...; type: ... }
                            | (
                                { payable?: boolean | undefined; constant?: boolean | undefined; gas?: number | undefined; } & ({ inputs: readonly AbiParameter[]; outputs: readonly AbiParameter[]; type: "function"; name: string; stateMutability: "pure" | ... 2 more ... | "payable"; } | { ...; } | { ...; } | { ...; })
                            )
                        )[];
                        conditions: { function: string; params?: (...)[] }[];
                        type: "evmData";
                    }
                )[];
                operation: "signEvmTransaction";
            }
            | { action: "reject"
            | "accept"; operation: "signEvmHash" }
            | {
                action: "reject" | "accept";
                criteria: { match: string; type: "evmMessage" }[];
                operation: "signEvmMessage";
            }
            | {
                action: "reject"
                | "accept";
                criteria: (
                    | {
                        ethValue: string;
                        operator: ">"
                        | ">="
                        | "<"
                        | "<="
                        | "==";
                        type: "ethValue";
                    }
                    | {
                        addresses: `0x${string}`[];
                        operator: "in"
                        | "not in";
                        type: "evmAddress";
                    }
                    | {
                        networks: ("base-sepolia" | "base")[];
                        operator: "in" | "not in";
                        type: "evmNetwork";
                    }
                    | {
                        abi: | "erc20"
                        | "erc721"
                        | "erc1155"
                        | readonly (
                            | { inputs: ...; name: ...; type: ... }
                            | { anonymous?: ...; inputs: ...; name: ...; type: ... }
                            | (
                                { payable?: boolean | undefined; constant?: boolean | undefined; gas?: number | undefined; } & ({ inputs: readonly AbiParameter[]; outputs: readonly AbiParameter[]; type: "function"; name: string; stateMutability: "pure" | ... 2 more ... | "payable"; } | { ...; } | { ...; } | { ...; })
                            )
                        )[];
                        conditions: { function: string; params?: (...)[] }[];
                        type: "evmData";
                    }
                )[];
                operation: "sendEvmTransaction";
            }
            | {
                action: "reject"
                | "accept";
                criteria: {
                    addresses: string[];
                    operator: "in" | "not in";
                    type: "solAddress";
                }[];
                operation: "signSolTransaction";
            }
        )[];
        scope: "project"
        | "account";
    }
    The policy definition to create. Contains the scope, description, and rules for the policy.
    
    Optionaldescription?: string
    An optional human-readable description for the policy. Limited to 50 characters of alphanumeric characters, spaces, commas, and periods.
    
    rules: (
        | {
            action: "reject"
            | "accept";
            criteria: (
                | {
                    ethValue: string;
                    operator: ">"
                    | ">="
                    | "<"
                    | "<="
                    | "==";
                    type: "ethValue";
                }
                | {
                    addresses: `0x${string}`[];
                    operator: "in"
                    | "not in";
                    type: "evmAddress";
                }
                | {
                    abi: | "erc20"
                    | "erc721"
                    | "erc1155"
                    | readonly (
                        | { inputs: ...; name: ...; type: ... }
                        | { anonymous?: ...; inputs: ...; name: ...; type: ... }
                        | (
                            { payable?: boolean | undefined; constant?: boolean | undefined; gas?: number | undefined; } & ({ inputs: readonly AbiParameter[]; outputs: readonly AbiParameter[]; type: "function"; name: string; stateMutability: "pure" | ... 2 more ... | "payable"; } | { ...; } | { ...; } | { ...; })
                        )
                    )[];
                    conditions: { function: string; params?: (...)[] }[];
                    type: "evmData";
                }
            )[];
            operation: "signEvmTransaction";
        }
        | { action: "reject"
        | "accept"; operation: "signEvmHash" }
        | {
            action: "reject" | "accept";
            criteria: { match: string; type: "evmMessage" }[];
            operation: "signEvmMessage";
        }
        | {
            action: "reject"
            | "accept";
            criteria: (
                | {
                    ethValue: string;
                    operator: ">"
                    | ">="
                    | "<"
                    | "<="
                    | "==";
                    type: "ethValue";
                }
                | {
                    addresses: `0x${string}`[];
                    operator: "in"
                    | "not in";
                    type: "evmAddress";
                }
                | {
                    networks: ("base-sepolia" | "base")[];
                    operator: "in" | "not in";
                    type: "evmNetwork";
                }
                | {
                    abi: | "erc20"
                    | "erc721"
                    | "erc1155"
                    | readonly (
                        | { inputs: ...; name: ...; type: ... }
                        | { anonymous?: ...; inputs: ...; name: ...; type: ... }
                        | (
                            { payable?: boolean | undefined; constant?: boolean | undefined; gas?: number | undefined; } & ({ inputs: readonly AbiParameter[]; outputs: readonly AbiParameter[]; type: "function"; name: string; stateMutability: "pure" | ... 2 more ... | "payable"; } | { ...; } | { ...; } | { ...; })
                        )
                    )[];
                    conditions: { function: string; params?: (...)[] }[];
                    type: "evmData";
                }
            )[];
            operation: "sendEvmTransaction";
        }
        | {
            action: "reject"
            | "accept";
            criteria: {
                addresses: string[];
                operator: "in" | "not in";
                type: "solAddress";
            }[];
            operation: "signSolTransaction";
        }
    )[]
    Array of rules that comprise the policy. Limited to a maximum of 10 rules per policy.
    
    scope: "project" | "account"
    The scope of the policy. "project" applies to the entire project, "account" applies to specific accounts.
Returns Promise<Policy>
The created policy
Throws
When the policy is invalid
Example: **Creating a new policy**
```
         const policy = await cdp.policies.createPolicy({
           policy: {
             scope: "account",
             description: "Limits the amount of ETH in transaction",
             rules: [
               {
                 action: "reject",
                 operation: "signEvmTransaction",
                 criteria: [
                   {
                     type: "ethValue",
                     ethValue: "1000000000000000000",
                     operator: ">",
                   },
                 ],
               },
             ],
           }
         });
         
```
Example: **With idempotency key**
```
         const idempotencyKey = uuidv4();

         // First call creates the policy
         const policy = await cdp.policies.createPolicy({
           policy: {
             scope: "account",
             description: "Limits the amount of ETH in transaction",
             rules: [
               {
                 action: "reject",
                 operation: "signEvmTransaction",
                 criteria: [
                   {
                     type: "ethValue",
                     ethValue: "1000000000000000000",
                     operator: ">",
                   },
                 ],
               },
             ],
           },
           idempotencyKey
         });

         // Second call with same key returns the same policy
         const samePolicy = await cdp.policies.createPolicy({
           policy: { ... },
           idempotencyKey
         });
         
```
Implementation of PoliciesClientInterface.createPolicy
- Defined in src/client/policies/policies.ts:131

deletePolicy

deletePolicy(options: DeletePolicyOptions): Promise<void>
Deletes a policy by its unique identifier. If a policy is referenced by an active project or account, this operation will fail.
Parameters
- options: DeletePolicyOptions
  Options containing the policy ID to delete
  
  Options for deleting a Policy.
  - id: string
    The unique identifier of the policy to delete. This is a UUID that's generated when the policy is created.
  - OptionalidempotencyKey?: string
    The idempotency key to ensure the request is processed exactly once. Used to safely retry requests without accidentally performing the same operation twice.
Returns Promise<void>
Void on successful deletion
Example: **Deleting a policy**
```
         await cdp.policies.deletePolicy({
           id: "__ID__"
         });
         
```
Example: **With idempotency key**
```
         const idempotencyKey = uuidv4();

         // This operation is idempotent with the key
         await cdp.policies.deletePolicy({
           id: "__ID__",
           idempotencyKey
         });
         
```
Implementation of PoliciesClientInterface.deletePolicy
- Defined in src/client/policies/policies.ts:190

getPolicyById

getPolicyById(options: GetPolicyByIdOptions): Promise<Policy>
Retrieves a policy by its unique identifier.
Parameters
- options: GetPolicyByIdOptions
  Options containing the policy ID to retrieve
  
  Options for retrieving a Policy by ID.
  - id: string
    The unique identifier of the policy to retrieve. This is a UUID that's generated when the policy is created.
Returns Promise<Policy>
The requested policy
Example: **Retrieving a policy by ID**
```
         const policy = await cdp.policies.getPolicyById({
           id: "__ID__"
         });

         console.log(policy.name);
         console.log(policy.rules);
         
```
Implementation of PoliciesClientInterface.getPolicyById
- Defined in src/client/policies/policies.ts:158

listPolicies

listPolicies(options?: ListPoliciesOptions): Promise<ListPoliciesResult>
Lists policies belonging to the developer's CDP Project. Can be filtered by scope (project or account).
Parameters
- Optionaloptions: ListPoliciesOptions = {}
  Options for filtering and paginating the results
  - OptionalpageSize?: number
    The page size to paginate through the accounts.
  - OptionalpageToken?: string
    The page token to paginate through the accounts.
  - Optionalscope?: "project" | "account"
    The scope of the policies to return. If project, the response will include exactly one policy, which is the project-level policy. If account, the response will include all account-level policies for the developer's CDP Project.
Returns Promise<ListPoliciesResult>
A paginated list of policies
Example: **List all policies**
```
         const { policies } = await cdp.policies.listPolicies();
         
```
Example: **Filter by scope**
```
         const { policies } = await cdp.policies.listPolicies({
           scope: 'project'
         });
         
```
Example: **With pagination**
```
         // Get first page
         const firstPage = await cdp.policies.listPolicies({
           pageSize: 10
         });

         // Get next page using cursor
         const nextPage = await cdp.policies.listPolicies({
           pageSize: 10,
           pageToken: firstPage.pageToken
         });
         
```
Implementation of PoliciesClientInterface.listPolicies
- Defined in src/client/policies/policies.ts:59

updatePolicy

updatePolicy(options: UpdatePolicyOptions): Promise<Policy>
Updates an existing policy by its unique identifier. This will apply the updated policy to any project or accounts that are currently using it.
Parameters
- options: UpdatePolicyOptions
  Options containing the policy ID and updated policy data
  
  Options for updating a Policy.
  - id: string
    The unique identifier of the policy to update. This is a UUID that's generated when the policy is created.
  - OptionalidempotencyKey?: string
    The idempotency key to ensure the request is processed exactly once. Used to safely retry requests without accidentally performing the same operation twice.
  - policy: {
        description?: string;
        rules: (
            | {
                action: "reject"
                | "accept";
                criteria: (
                    | {
                        ethValue: string;
                        operator: ">"
                        | ">="
                        | "<"
                        | "<="
                        | "==";
                        type: "ethValue";
                    }
                    | {
                        addresses: `0x${string}`[];
                        operator: "in"
                        | "not in";
                        type: "evmAddress";
                    }
                    | {
                        abi: | "erc20"
                        | "erc721"
                        | "erc1155"
                        | readonly (
                            | { inputs: ...; name: ...; type: ... }
                            | { anonymous?: ...; inputs: ...; name: ...; type: ... }
                            | (
                                { payable?: boolean | undefined; constant?: boolean | undefined; gas?: number | undefined; } & ({ inputs: readonly AbiParameter[]; outputs: readonly AbiParameter[]; type: "function"; name: string; stateMutability: "pure" | ... 2 more ... | "payable"; } | { ...; } | { ...; } | { ...; })
                            )
                        )[];
                        conditions: { function: string; params?: (...)[] }[];
                        type: "evmData";
                    }
                )[];
                operation: "signEvmTransaction";
            }
            | { action: "reject"
            | "accept"; operation: "signEvmHash" }
            | {
                action: "reject" | "accept";
                criteria: { match: string; type: "evmMessage" }[];
                operation: "signEvmMessage";
            }
            | {
                action: "reject"
                | "accept";
                criteria: (
                    | {
                        ethValue: string;
                        operator: ">"
                        | ">="
                        | "<"
                        | "<="
                        | "==";
                        type: "ethValue";
                    }
                    | {
                        addresses: `0x${string}`[];
                        operator: "in"
                        | "not in";
                        type: "evmAddress";
                    }
                    | {
                        networks: ("base-sepolia" | "base")[];
                        operator: "in" | "not in";
                        type: "evmNetwork";
                    }
                    | {
                        abi: | "erc20"
                        | "erc721"
                        | "erc1155"
                        | readonly (
                            | { inputs: ...; name: ...; type: ... }
                            | { anonymous?: ...; inputs: ...; name: ...; type: ... }
                            | (
                                { payable?: boolean | undefined; constant?: boolean | undefined; gas?: number | undefined; } & ({ inputs: readonly AbiParameter[]; outputs: readonly AbiParameter[]; type: "function"; name: string; stateMutability: "pure" | ... 2 more ... | "payable"; } | { ...; } | { ...; } | { ...; })
                            )
                        )[];
                        conditions: { function: string; params?: (...)[] }[];
                        type: "evmData";
                    }
                )[];
                operation: "sendEvmTransaction";
            }
            | {
                action: "reject"
                | "accept";
                criteria: {
                    addresses: string[];
                    operator: "in" | "not in";
                    type: "solAddress";
                }[];
                operation: "signSolTransaction";
            }
        )[];
    }
    The updated policy definition. Contains the description and rules for the policy.
    
    Optionaldescription?: string
    An optional human-readable description for the policy. Limited to 50 characters of alphanumeric characters, spaces, commas, and periods.
    
    rules: (
        | {
            action: "reject"
            | "accept";
            criteria: (
                | {
                    ethValue: string;
                    operator: ">"
                    | ">="
                    | "<"
                    | "<="
                    | "==";
                    type: "ethValue";
                }
                | {
                    addresses: `0x${string}`[];
                    operator: "in"
                    | "not in";
                    type: "evmAddress";
                }
                | {
                    abi: | "erc20"
                    | "erc721"
                    | "erc1155"
                    | readonly (
                        | { inputs: ...; name: ...; type: ... }
                        | { anonymous?: ...; inputs: ...; name: ...; type: ... }
                        | (
                            { payable?: boolean | undefined; constant?: boolean | undefined; gas?: number | undefined; } & ({ inputs: readonly AbiParameter[]; outputs: readonly AbiParameter[]; type: "function"; name: string; stateMutability: "pure" | ... 2 more ... | "payable"; } | { ...; } | { ...; } | { ...; })
                        )
                    )[];
                    conditions: { function: string; params?: (...)[] }[];
                    type: "evmData";
                }
            )[];
            operation: "signEvmTransaction";
        }
        | { action: "reject"
        | "accept"; operation: "signEvmHash" }
        | {
            action: "reject" | "accept";
            criteria: { match: string; type: "evmMessage" }[];
            operation: "signEvmMessage";
        }
        | {
            action: "reject"
            | "accept";
            criteria: (
                | {
                    ethValue: string;
                    operator: ">"
                    | ">="
                    | "<"
                    | "<="
                    | "==";
                    type: "ethValue";
                }
                | {
                    addresses: `0x${string}`[];
                    operator: "in"
                    | "not in";
                    type: "evmAddress";
                }
                | {
                    networks: ("base-sepolia" | "base")[];
                    operator: "in" | "not in";
                    type: "evmNetwork";
                }
                | {
                    abi: | "erc20"
                    | "erc721"
                    | "erc1155"
                    | readonly (
                        | { inputs: ...; name: ...; type: ... }
                        | { anonymous?: ...; inputs: ...; name: ...; type: ... }
                        | (
                            { payable?: boolean | undefined; constant?: boolean | undefined; gas?: number | undefined; } & ({ inputs: readonly AbiParameter[]; outputs: readonly AbiParameter[]; type: "function"; name: string; stateMutability: "pure" | ... 2 more ... | "payable"; } | { ...; } | { ...; } | { ...; })
                        )
                    )[];
                    conditions: { function: string; params?: (...)[] }[];
                    type: "evmData";
                }
            )[];
            operation: "sendEvmTransaction";
        }
        | {
            action: "reject"
            | "accept";
            criteria: {
                addresses: string[];
                operator: "in" | "not in";
                type: "solAddress";
            }[];
            operation: "signSolTransaction";
        }
    )[]
    Array of rules that comprise the policy. Limited to a maximum of 10 rules per policy.
Returns Promise<Policy>
The updated policy
Throws
When the updated policy is invalid
Example: **Updating a policy**
```
         const updatedPolicy = await cdp.policies.updatePolicy({
           id: "__ID__",
           policy: {
             description: "Now with lower transaction limits",
             rules: [
               {
                 action: "reject",
                 operation: "signEvmTransaction",
                 criteria: [
                   {
                     type: "ethValue",
                     ethValue: "1000000000",
                     operator: ">",
                   },
                 ],
               },
             ],
           },
         });
         
```
Example: **With idempotency key**
```
         const idempotencyKey = uuidv4();

         // This operation is idempotent with the key
         await cdp.policies.updatePolicy({
           id: "__ID__",
           policy: {
             description: "Modified Policy",
             rules: { ... }
           },
           idempotencyKey
         });
         
```
Implementation of PoliciesClientInterface.updatePolicy
- Defined in src/client/policies/policies.ts:246

Class PoliciesClient

Implements

Index

Constructors

Methods

Constructors

constructor

Returns PoliciesClient

Methods

createPolicy

Parameters

OptionalidempotencyKey?: string

Optionaldescription?: string

scope: "project" | "account"

Returns Promise<Policy>

Throws

Example: **Creating a new policy**

Example: **With idempotency key**

deletePolicy

Parameters

id: string

OptionalidempotencyKey?: string

Returns Promise<void>

Example: **Deleting a policy**

Example: **With idempotency key**

getPolicyById

Parameters

id: string

Returns Promise<Policy>

Example: **Retrieving a policy by ID**

listPolicies

Parameters

OptionalpageSize?: number

OptionalpageToken?: string

Optionalscope?: "project" | "account"

Returns Promise<ListPoliciesResult>

Example: **List all policies**

Example: **Filter by scope**

Example: **With pagination**

updatePolicy

Parameters

id: string

OptionalidempotencyKey?: string

Optionaldescription?: string

Returns Promise<Policy>

Throws

Example: **Updating a policy**

Example: **With idempotency key**

Settings

On This Page

`Optional`idempotencyKey?: string

`Optional`description?: string

Example: Creating a new policy

Example: With idempotency key

`Optional`idempotencyKey?: string

Example: Deleting a policy

Example: With idempotency key

Example: Retrieving a policy by ID

`Optional`pageSize?: number

`Optional`pageToken?: string

`Optional`scope?: "project" | "account"

Example: List all policies

Example: Filter by scope

Example: With pagination

`Optional`idempotencyKey?: string

`Optional`description?: string

Example: Updating a policy

Example: With idempotency key