bitpro가 원문에서 글자만 모은 내용이에요. 표·그림·수식은 빠지거나 깨질 수 있어요. 전체 75쪽 중 11쪽
must match the constructor signature. |
| `175004` | `409` | `Contract already exists.` | The contract already exists in the system. |
| `175005` | `400` | `Address is not a contract address.` | The given address is not associated with a smart contract. |
| `175006` | `400` | `Contract is archived.` | Attempted to interact with an archived contract. |
| `175007` | `400` | `Invalid ABI JSON.` | The inputted ABI JSON is not correctly formatted. |
| `175008` | `400` | `Multi-layered proxies are not supported.` | Importing a multi-layered proxy contract is not supported. |
| `175009` | `400` | `Contract deployment pending.` | Contract deployment must be completed before function execution is available. |
| `175010` | `400` | `ABI function not found.` | The ABI function was not found on the contract. |
| `175011` | `400` | `Empty update on a contract.` | An empty update for a contract is not allowed |
| `175012` | `400` | `Unable to query contract.` | Unable to query contract. Check your parameters and try again. |
| `175013` | `400` | `ABI function is not supported.` | The ABI function of the contract is not supported. |
## Template errors
| Error code | HTTP code | Error message | Description |
| - | - | - | - |
| `175201` | `404` | `Template not found.` | The specified template does not exist in the system. |
| `175202` | `400` | `Deploying this template is temporarily disabled.` | Deploying this template is temporarily disabled. |
| `175203` | `400` | `Invalid template deployment parameter.` | The request contains an invalid field in the template parameters. |
| `175204` | `400` | `Missing required template deployment parameter.` | The request is missing a required field in the template parameters. |
| `175205` | `400` | `Estimation is not supported.` | Estimating the deployment of this template is not supported. |
## Event subscription errors
| Error code | HTTP code | Error message | Description |
| - | - | - | - |
| `175301` | `404` | `Event subscription not found.` | The specified event subscription does not exist or is not accessible to the caller. |
| `175302` | `409` | `Event subscription already exist.` | The specified event has already been created for this contract. |
| `175303` | `400` | `The specified event signature does not exist.` | The specified event signature does not exist on this contract. |
## Shared contract errors
| Error code | HTTP code | Error message | Description |
| - | - | - | - |
| `175401` | `400` | `Fail to parse id as UUID in url.` | The specified ID is invalid (must be in UUID format). Try again with a valid ID. |
| `175402` | `400` | `The specified blockchain is either not supported or deprecated.` | The specified blockchain is either not supported or deprecated. |
| `175403` | `409` | `Please use a new idempotency key.` | Use a new idempotency key and try again. |
| `175404` | `400` | `TEST_API key cannot be used with blockchain mainnets, or LIVE_API key cannot be used with blockchain testnets.` | TEST\_API key cannot be used with blockchain mainnets, or LIVE\_API key cannot be used with blockchain testnets. |
| `175405` | `401` | `TEST_API key or LIVE_API key is not found for the request.` | TEST\_API key or LIVE\_API key is not found for the request. |
| `175406` | `400` | `This feature is temporarily disabled.` | This feature is temporarily disabled. |
| `175407` | `400` | `The specified blockchain is unavailable.` | The specified blockchain is unavailable. Check the [Circle Status page](https://status.circle.com/) for more details. |
| `175408` | `404` | `Cannot find corresponding pagination cursor in the system.` | Cannot find corresponding pagination cursor in the system. |
| `175409` | `403` | `Entities with restrictions cannot perform this operation.` | Entities with restrictions cannot perform this operation. |
| `175410` | `400` | `invalid address format` | The address format is invalid. |
## Transaction errors
| Error code | HTTP code | Error message | Description |
| - | - | - | - |
| `177001` | `400` | `transaction nonce is inconsistent with sender's latest nonce` | The transaction nonce is inconsistent with the sender's latest nonce. |
| `177002` | `400` | `user op nonce can not be larger than 0 when smart contract wallet hasn't been deployed` | User op nonce can not be larger than 0 when the smart contract wallet hasn't been deployed. |
| `177003` | `400` | `failed to execute this request on EVM due to insufficient token when estimating fee` | Failed to execute this request on EVM due to insufficient tokens when estimating the fee. |
| `177004` | `400` | `the total cost of executing transaction is higher than the balance of the user's account when estimating fee` | When estimating the fee, the total cost of executing the transaction is higher than the balance of the user's account. |
| `177005` | `400` | `the sender address is not token owner or approved when estimating token transfer` | The sender address is not token owner or approved when estimating token transfer. |
| `177006` | `400` | `gas required exceeds allowance when estimating fee` | Gas required exceeds allowance when estimating fee. |
| `177007` | `400` | `estimate fee execution reverted` | Estimate fee execution reverted. |
| `177008` | `400` | `ABI function signature can't pack ABI parameter` | ABI function signature can't pack ABI parameter. |
| `177009` | `400` | `fails to perform transaction estimation` | Fails to perform transaction estimation. |
| `177010` | `400` | `maxFee * gasLimit exceed configurable max transaction fee (default is 1 native token)` | The `MaxFee` \* `GasLimit` exceeds the configurable max transaction fee (default is 1 native token). |
| `177011` | `400` | `transaction needs feeLevel or gasLimit provided` | The transaction requires `feeLevel` or `gasLimit` to be provided in the request. |
| `177012` | `400` | `sca transaction needs feeLevel provided` | The SCA transaction requires `feeLevel` to be provided in the request. |
| `177013` | `400` | `EIP1559 chains need maxFee/priorityFee provided` | EIP1559 chains require `maxFee` and `priorityFee` to be provided in the request. |
| `177014` | `400` | `priorityFee cannot be larger than maxFee in creating transaction request` | Creating transaction requests`priorityFee` cannot be larger than `maxFee`. |
| `177015` | `400` | `missing bytecode for contract deployment` | Missing bytecode for contract deployment. |
| `177016` | `400` | `cannot provide both WalletID and SourceAddress/Blockchain` | You cannot provide `WalletID` and `SourceAddress`/`Blockchain` in a request. |
| `177017` | `400` | `Invalid amount in contract execution request` | The `amount` in the contract execution request is invalid. |
| `177018` | `400` | `policy is not activated and cannot be used` | The Gas Station paymaster policy is not activated and cannot be used. |
| `177019` | `400` | `exceeded max daily transaction of the policy` | The Gas Station paymaster policy maximum daily transaction limit has been reached. |
| `177020` | `400` | `exceeded max spend USD per transaction of the policy` | The transaction cost exceeds the Gas Station paymaster policy maximum spend per transaction in USD. |
| `177021` | `400` | `exceeded max spend USD daily of the policy` | The Gas Station paymaster policy for maximum spending daily in USD has been reached. |
| `177022` | `400` | `exceeded max native token daily of the policy` | The Gas Station paymaster policy for maximum native tokens daily of the policy. |
| `177023` | `400` | `sender is in policy blocklist` | The sender is on the Gas Station paymaster policy blocklist. |
| `177024` | `400` | `wallet and request's blockchain mismatch.` | The wallet and blockchain in the request should be the same. |
| `177301` | `400` | `wallet is Frozen` | Frozen wallets can not be updated or interacted with; they can only be queried. |
| `177302` | `400` | `invalid sca wallet config` | The SCA wallet configuration is invalid. |
| `177303` | `400` | `sca wallet first-time transaction is still in progress` | The SCA wallet needs to wait for the first-time transaction to finish deploying the wallet before processing more transactions. |
| `177304` | `400` | `SCA account is not supported on the given blockchain` | The SCA account is not supported on the given blockchain. |
| `177305` | `400` | `Entity is not eligible for SCA account creation. Please check paymaster policy setup` | The entity is not eligible for SCA account creation. Check the Gas Station paymaster policy setup. |
| `177601` | `400` | `could be caused by either no such wallet or wallet is not accessible to the caller` | The target wallet cannot be found in the system. Either the specified wallet doesn't exist, or it's inaccessible to the caller. |
| `177602` | `400` | `reusing an entity secret ciphertext is not allowed. Please re-encrypt the entity secret to generate new ciphertext` | Reusing an entity's secret ciphertext is not allowed. Re-encrypt the entity secret to generate a new ciphertext. |
| `177603` | `400` | `entity is likely not properly set up during the onboarding process` | The corresponding entity cannot be found in the system. |
| `177604` | `400` | `the provided entity secret is invalid` | The provided entity secret is invalid. |
| `177605` | `400` | `the entity secret has not been set yet. Please provide encrypted ciphertext in the console` | The entity secret has not been set up on your account. Provide encrypted ciphertext in the console. |
| `177606` | `400` | `current entity secret is invalid. Please rotate the entity secret first` | The provided entity secret is invalid. Rotate the entity secret first and send another API request. |
| `177607` | `400` | `please use a new idempotency key` | Use a new idempotency key. |
| `177901` | `400` | `smart contract query failed` | Error when querying contract. Check parameters and try again. |
# Postman collection
Source: https://developers.circle.com/api-reference/contracts/postman
Use Circle's Postman collection to send API requests and explore the Smart Contract Platform APIs.
Circle's Postman collection provides sample requests for the Smart Contract
Platform APIs. Run them in [Postman](https://www.postman.com/), an API client.
The collection matches the layout of the
[API reference](/api-reference/contracts/smart-contract-platform/list-contracts).
## Run in Postman
Select **Run in Postman** below. Choose one of the following options:
* **Fork**: Copies the collection and keeps a link to the parent.
* **View**: Lets you try the API without importing it.
* **Import**: Copies the collection without keeping a link to Circle's copy.
| Collection | Link |
| :- | :- |
| Contracts | [](https://app.getpostman.com/run-collection/21445022-20c27ad9-62c1-4c95-8adc-e2d2a4a473cd?action=collection%2Ffork\&source=rip_markdown\&collection-url=entityId%3D21445022-20c27ad9-62c1-4c95-8adc-e2d2a4a473cd%26entityType%3Dcollection%26workspaceId%3D73acd722-fab9-49b0-9382-086659476258) |
## Authorization
To authorize your session, use Circle's Postman variable `apiKey` and add your
API key to the `environment` or `collection` variables. See Postman's
[using variables](https://learning.postman.com/docs/sending-requests/variables/)
guide for details.
For more information about creating an API key, see
[API keys](/api-reference/keys).
# Create Event Monitor
Source: https://developers.circle.com/api-reference/contracts/smart-contract-platform/create-event-monitor
openapi/smart-contract-platform.yaml post /v1/w3s/contracts/monitors
Create a new event monitor based on the provided blockchain, contract address, and event signature.
# Delete Event Monitor
Source: https://developers.circle.com/api-reference/contracts/smart-contract-platform/delete-event-monitor
openapi/smart-contract-platform.yaml delete /v1/w3s/contracts/monitors/{id}
Delete an existing event monitor given its ID.
# Deploy a contract
Source: https://developers.circle.com/api-reference/contracts/smart-contract-platform/deploy-contract
openapi/smart-contract-platform.yaml post /v1/w3s/contracts/deploy
Deploy a smart contract on a specified blockchain using the contract's ABI and bytecode. The deployment will originate from one of your Circle Wallets.
# Deploy a contract from a template
Source: https://developers.circle.com/api-reference/contracts/smart-contract-platform/deploy-contract-template
openapi/smart-contract-platform.yaml post /v1/w3s/templates/{id}/deploy
Deploy a smart contract using a template.
# Estimate a contract deployment
Source: https://developers.circle.com/api-reference/contracts/smart-contract-platform/estimate-contract-deploy
openapi/smart-contract-platform.yaml post /v1/w3s/contracts/deploy/estimateFee
Estimate the network fee for deploying a smart contract on a specified blockchain, given the contract bytecode.
# Estimate fee for a contract template deployment
Source: https://developers.circle.com/api-reference/contracts/smart-contract-platform/estimate-contract-template-deploy
openapi/smart-contract-platform.yaml post /v1/w3s/templates/{id}/deploy/estimateFee
Estimate the fee required to deploy contract by template.
# Get a contract
Source: https://developers.circle.com/api-reference/contracts/smart-contract-platform/get-contract
openapi/smart-contract-platform.yaml get /v1/w3s/contracts/{id}
Get a single contract that you've imported or deployed. Retrieved using the contracts ID as opposed to the on-chain address.
# Get Event Monitors
Source: https://developers.circle.com/api-reference/contracts/smart-contract-platform/get-event-monitors
openapi/smart-contract-platform.yaml get /v1/w3s/contracts/monitors
Fetch a list of event monitors, optionally filtered by blockchain, contract address, and event signature.
# Import a contract
Source: https://developers.circle.com/api-reference/contracts/smart-contract-platform/import-contract
openapi/smart-contract-platform.yaml post /v1/w3s/contracts/import
Add an existing smart contract to your library of contracts. It also can be done in the Developer Services Console.
# List contracts
Source: https://developers.circle.com/api-reference/contracts/smart-contract-platform/list-contracts
openapi/smart-contract-platform.yaml get /v1/w3s/contracts
Fetch a list of contracts that you've imported and/or deployed.
# Get Event Logs
Source: https://developers.circle.com/api-reference/contracts/smart-contract-platform/list-event-logs
openapi/smart-contract-platform.yaml get /v1/w3s/contracts/events
Fetch all event logs, optionally filtered by blockchain and contract address.
# Execute a query function on a contract
Source: https://developers.circle.com/api-reference/contracts/smart-contract-platform/query-contract
openapi/smart-contract-platform.yaml post /v1/w3s/contracts/query
Query the state of a contract by providing the address and blockchain.
# Update a contract
Source: https://developers.circle.com/api-reference/contracts/smart-contract-platform/update-contract
openapi/smart-contract-platform.yaml patch /v1/w3s/contracts/{id}
Update the off-chain properties, such as description, of a contract that you've imported or deployed. Updated using the contracts ID as opposed to the on-chain address.
# Update an Event Monitor
Source: https://developers.circle.com/api-reference/contracts/smart-contract-platform/update-event-monitor
openapi/smart-contract-platform.yaml put /v1/w3s/contracts/monitors/{id}
Update an existing event monitor given its ID.
# Circle Payments Network API
Source: https://developers.circle.com/api-reference/cpn
Route and settle stablecoin payments across Circle's network with support for quotes, payments, transactions, and managed payments.
Use CPN if you're a bank, fintech, or crypto platform connecting to a shared
onchain settlement rail. Pick the integration pattern that fits your stack:
direct API access where you operate your own wallets, or a fully Circle-run flow
where Circle handles the underlying subaccounts for you.
## Get started
<CardGroup>
<Card title="API keys" icon="key" href="/api-reference/keys">
Authenticate your requests with an API key.
</Card>
<Card title="Postman collection" icon="rocket" href="/api-reference/cpn/postman">
Try the CPN API with Circle's Postman collection.
</Card>
<Card title="Webhooks" icon="bell" href="/api-reference/cpn/common/get-subscriptions">
Set up webhook subscriptions for CPN events.
</Card>
</CardGroup>
## Endpoint categories
<CardGroup>
<Card title="Circle Payments Network" icon="chart-network" href="/api-reference/cpn/cpn-platform/get-payment-configurations-overview">
Operate your own wallets and settlement: configurations, quotes, payments,
and transactions.
</Card>
<Card title="Managed Payments" icon="briefcase" href="/api-reference/cpn/managed-payments/accounts/list-accounts">
Use Circle-managed subaccounts for stablecoin payins and payouts.
</Card>
</CardGroup>
## OpenAPI specifications
The Circle Payments Network API reference is generated from these OpenAPI
specifications:
* `https://developers.circle.com/openapi/configurations.yaml`
* `https://developers.circle.com/openapi/cpn-ofi.yaml`
* `https://developers.circle.com/openapi/accounts.yaml`
* `https://developers.circle.com/openapi/payments.yaml`
* `https://developers.circle.com/openapi/payouts.yaml`
* `https://developers.circle.com/openapi/managed-payments.yaml`
See [OpenAPI Specifications](/api-reference/openapi-specifications) for the full
catalog of Circle's API specs.
# Create a webhook subscription
Source: https://developers.circle.com/api-reference/cpn/common/create-subscription
openapi/configurations.yaml post /v2/cpn/notifications/subscriptions
Create a webhook subscription by configuring an endpoint to receive notifications.
# Delete a notification subscription
Source: https://developers.circle.com/api-reference/cpn/common/delete-subscription
openapi/configurations.yaml delete /v2/cpn/notifications/subscriptions/{id}
Delete an existing subscription.
# Get a notification signature public key
Source: https://developers.circle.com/api-reference/cpn/common/get-notification-signature
openapi/configurations.yaml get /v2/cpn/notifications/publicKey/{id}
Get the public key and algorithm used to digitally sign webhook notifications. Verifying the digital signature ensures the notification came from Circle.
In the headers of each webhook, you can find
- `X-Circle-Signature`: a header containing the digital signature generated by Circle.
- `X-Circle-Key-Id`: a header containing the UUID. This is will be used as the `ID` as URL parameter to retrieve the relevant public key.
# Get a notification subscription
Source: https://developers.circle.com/api-reference/cpn/common/get-subscription
openapi/configurations.yaml get /v2/cpn/notifications/subscriptions/{id}
Returns an existing notification subscription.
# Get all webhook subscriptions
Source: https://developers.circle.com/api-reference/cpn/common/get-subscriptions
openapi/configurations.yaml get /v2/cpn/notifications/subscriptions
Returns an array of existing webhook subscriptions.
# Ping
Source: https://developers.circle.com/api-reference/cpn/common/ping
openapi/configurations.yaml get /ping
Checks that the service is running.
# Update a notification subscription
Source: https://developers.circle.com/api-reference/cpn/common/update-subscription
openapi/configurations.yaml patch /v2/cpn/notifications/subscriptions/{id}
Update subscription endpoint to receive notifications.
# Accelerate a stuck transaction
Source: https://developers.circle.com/api-reference/cpn/cpn-platform/accelerate-transaction
openapi/cpn-ofi.yaml post /v1/cpn/payments/{paymentId}/transactions/accelerate
- Accelerate a transaction based on the payment ID. It should be used when a transaction associated with the payment is broadcasted but not confirmed for a long period of time (i.e 10 minutes). This is usually due to gas fees being too프로젝트로 돌아가기
