-
Notifications
You must be signed in to change notification settings - Fork 11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: Add approval process create API + example #275
base: main
Are you sure you want to change the base?
Changes from all commits
97492e8
817f654
29131fb
a38e6ab
8cac5a7
cf1e030
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
require('dotenv').config(); | ||
|
||
const { Defender } = require('@openzeppelin/defender-sdk'); | ||
|
||
async function main() { | ||
const creds = { apiKey: process.env.API_KEY, apiSecret: process.env.API_SECRET }; | ||
const client = new Defender(creds); | ||
|
||
const relayers = await client.relay.list(); | ||
let relayer = relayers.items.find((relayer) => relayer.network === 'sepolia'); | ||
if (!relayer) { | ||
console.log('Relayer not found, creating one'); | ||
relayer = await client.relay.create({ name: 'My Testnet Relayer', network: 'sepolia', minBalance: 0 }); | ||
} | ||
|
||
const approvalProcess = await client.approvalProcess.create({ | ||
name: 'My Approval Process 2', | ||
network: 'sepolia', | ||
via: relayer.address, | ||
viaType: 'Relayer', | ||
relayerId: relayer.relayerId, | ||
}); | ||
|
||
console.log(approvalProcess); | ||
} | ||
|
||
if (require.main === module) { | ||
main().catch(console.error); | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
{ | ||
"name": "@openzeppelin/defender-sdk-example-create-approval-process", | ||
"version": "1.14.4", | ||
"private": true, | ||
"main": "index.js", | ||
"author": "Marcos Carlomagno <marcos.carlomagno@openzeppelin.com>", | ||
"license": "MIT", | ||
"scripts": { | ||
"start": "node index.js" | ||
}, | ||
"dependencies": { | ||
"@openzeppelin/defender-sdk": "1.14.4", | ||
"dotenv": "^16.3.1" | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Defender SDK Approval Process client | ||
|
||
The OpenZeppelin Defender provides a security operations (SecOps) platform for Ethereum with built-in best practices. Development teams implement Defender to ship faster and minimize security risks. | ||
|
||
This library provides methods related to Approval Processes. See Examples for usage. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
module.exports = require('../../jest.config'); |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
{ | ||
"name": "@openzeppelin/defender-sdk-approval-process-client", | ||
"version": "1.14.4", | ||
"description": "", | ||
"main": "./lib/index.js", | ||
"types": "./lib/index.d.ts", | ||
"scripts": { | ||
"build": "rm -rf lib && tsc", | ||
"test": "npm run test:unit", | ||
"test:unit": "jest --verbose --passWithNoTests --forceExit", | ||
"watch": "tsc -w" | ||
}, | ||
"files": [ | ||
"lib", | ||
"!*.test.js", | ||
"!*.test.js.map", | ||
"!*.test.d.ts", | ||
"!*__mocks__" | ||
], | ||
"author": "OpenZeppelin Defender <defender@openzeppelin.com>", | ||
"license": "MIT", | ||
"dependencies": { | ||
"@openzeppelin/defender-sdk-base-client": "^1.14.4", | ||
"axios": "^1.6.7", | ||
"lodash": "^4.17.21" | ||
}, | ||
"publishConfig": { | ||
"access": "public" | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
import { BaseApiClient } from '@openzeppelin/defender-sdk-base-client'; | ||
import { CreateApprovalProcessRequest, CreateApprovalProcessResponse } from '../models/approval-process'; | ||
|
||
const PATH = '/approval-process'; | ||
|
||
export class ApprovalProcessClient extends BaseApiClient { | ||
protected getPoolId(): string { | ||
return process.env.DEFENDER_POOL_ID ?? 'us-west-2_94f3puJWv'; | ||
} | ||
|
||
protected getPoolClientId(): string { | ||
return process.env.DEFENDER_POOL_CLIENT_ID ?? '40e58hbc7pktmnp9i26hh5nsav'; | ||
} | ||
|
||
protected getApiUrl(): string { | ||
return process.env.DEFENDER_API_URL ?? 'https://defender-api.openzeppelin.com/v2/'; | ||
} | ||
|
||
public async create(approvalProcess: CreateApprovalProcessRequest): Promise<CreateApprovalProcessResponse> { | ||
return this.apiCall(async (api) => { | ||
return await api.post(PATH, approvalProcess); | ||
}); | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
export { ApprovalProcessClient } from './api'; | ||
export { CreateApprovalProcessRequest, CreateApprovalProcessResponse } from './models/approval-process'; | ||
|
||
// eslint-disable-next-line @typescript-eslint/no-var-requires | ||
export const VERSION = require('../package.json').version; |
Original file line number | Diff line number | Diff line change | ||||||
---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,67 @@ | ||||||||
import { Network } from '@openzeppelin/defender-sdk-base-client'; | ||||||||
|
||||||||
export type ComponentType = ('deploy' | 'upgrade')[]; | ||||||||
|
||||||||
export interface Timelock { | ||||||||
address: string; | ||||||||
delay: string; | ||||||||
} | ||||||||
export interface FireblocksProposalParams { | ||||||||
apiKeyId: string; | ||||||||
vaultId: string; | ||||||||
assetId: string; | ||||||||
} | ||||||||
|
||||||||
export interface CreateApprovalProcessRequest { | ||||||||
name: string; | ||||||||
component?: ComponentType; | ||||||||
network: Network; | ||||||||
via?: string; | ||||||||
viaType?: | ||||||||
| 'EOA' | ||||||||
| 'Contract' | ||||||||
| 'Multisig' | ||||||||
| 'Gnosis Safe' | ||||||||
| 'Safe' | ||||||||
| 'Gnosis Multisig' | ||||||||
| 'Relayer' | ||||||||
| 'Unknown' | ||||||||
| 'Timelock Controller' | ||||||||
| 'ERC20' | ||||||||
| 'Governor' | ||||||||
| 'Fireblocks'; | ||||||||
timelock?: Timelock; | ||||||||
multisigSender?: string; | ||||||||
fireblocks?: FireblocksProposalParams; | ||||||||
relayerId?: string; | ||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||
stackResourceId?: string; | ||||||||
} | ||||||||
|
||||||||
export interface CreateApprovalProcessResponse { | ||||||||
approvalProcessId: string; | ||||||||
createdAt: string; | ||||||||
name: string; | ||||||||
component?: ComponentType; | ||||||||
network?: Network; | ||||||||
via?: string; | ||||||||
viaType?: | ||||||||
| 'EOA' | ||||||||
| 'Contract' | ||||||||
| 'Multisig' | ||||||||
| 'Gnosis Safe' | ||||||||
| 'Safe' | ||||||||
| 'Gnosis Multisig' | ||||||||
| 'Relayer' | ||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Note for relayer groups we need to add "Relayer Group" type here. |
||||||||
| 'Relayer Group' | ||||||||
| 'Unknown' | ||||||||
| 'Timelock Controller' | ||||||||
| 'ERC20' | ||||||||
| 'Governor' | ||||||||
| 'Fireblocks'; | ||||||||
timelock?: Timelock; | ||||||||
multisigSender?: string; | ||||||||
fireblocks?: FireblocksProposalParams; | ||||||||
relayerId?: string; | ||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. and also |
||||||||
relayerGroupId?: string; | ||||||||
stackResourceId?: string; | ||||||||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
{ | ||
"extends": "code-style/tsconfig.json", | ||
"compilerOptions": { | ||
"declaration": true, | ||
"outDir": "./lib", | ||
"skipLibCheck": true, | ||
"sourceMap": false | ||
}, | ||
"include": ["./src"], | ||
"exclude": ["**/*.test.ts", "**/__mocks__/*"] | ||
} |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.