web3-circle-sdk

Circle SDK

This is a TypeScript SDK for interacting with the Circle Web3 Services REST API. Keep reading for more information.

Classes

This SDK exposes the following classes for interacting with the Circle Web3 Services REST API:

• CircleSdk
  • This is a convenience class for working with all the other classes described below.
  • Instantiate with const circle: CircleSdk = new CircleSdk(apiKey, secret); then initialize with await circle.init();.
• FaucetApi
  • Exposed by the CircleSdk class as the faucet property (i.e. CircleSdk.faucet).
  • Supports the following Circle Web3 Services REST API endpoints:
    • Request testnet tokens (FaucetApi.request)
• MonitoredTokensApi
  • Exposed by the CircleSdk class as the monitoredTokens property (i.e. CircleSdk.monitoredTokens).
  • Supports the following Circle Web3 Services REST API endpoints:
    • Set monitored tokens (MonitoredTokensApi.set)
    • Update monitored tokens (MonitoredTokensApi.update)
    • Retrieve existing monitored tokens (MonitoredTokensApi.get)
    • Delete monitored tokens (MonitoredTokensApi.delete)
    • Update monitored tokens scope (MonitoredTokensApi.updateScope)
• SecretApi
  • Exposed by the CircleSdk class as the secret property (i.e. CircleSdk.secret).
  • Supports the following Circle Web3 Services REST API endpoints:
    • Get public key for entity (SecretApi.getPublicKey)
    • Get configuration for entity (SecretApi.getConfig)
• SignApi
  • Exposed by the CircleSdk class as the sign property (i.e. CircleSdk.sign).
  • Supports the following Circle Web3 Services REST API endpoints:
    • Sign message (SignApi.signMessage)
    • Sign typed data (SignApi.signTypedData)
    • Sign transaction (SignApi.signTransaction)
    • Sign delegate action (SignApi.signDelegateAction)
• SmartContractApi
  • Exposed by the CircleSdk class as the smartContract property (i.e. CircleSdk.smartContract).
  • Supports the following Circle Web3 Services REST API endpoints:
    • List contracts (SmartContractApi.list)
    • Get a contract (SmartContractApi.get)
    • Update a contract (SmartContractApi.update)
    • Import a contract (SmartContractApi.import)
    • Estimate a contract deployment (SmartContractApi.estimateDeploymentFee)
    • Deploy a contract (SmartContractApi.deploy)
    • Execute a query function on a contract (SmartContractApi.query)
• SmartContractEventMonitorApi
  • Exposed by the CircleSdk class as the smartContractEventMonitor property (i.e. CircleSdk.smartContractEventMonitor).
  • Supports the following Circle Web3 Services REST API endpoints:
    • Get event monitors (SmartContractEventMonitorApi.get)
    • Create event monitor (SmartContractEventMonitorApi.create)
    • Update an event monitor (SmartContractEventMonitorApi.update)
    • Delete event monitor (SmartContractEventMonitorApi.delete)
    • Get event logs (SmartContractEventMonitorApi.getEventLogs)
• SmartContractTemplateApi
  • Exposed by the CircleSdk class as the smartContractTemplate property (i.e. CircleSdk.smartContractTemplate).
  • Supports the following Circle Web3 Services REST API endpoints:
    • Estimate fee for a contract template deployment (SmartContractTemplateApi.estimateDeploymentFee)
    • Deploy a contract from a template (SmartContractTemplateApi.deploy)
• TokenLookupApi
  • Exposed by the CircleSdk class as the tokenLookup property (i.e. CircleSdk.tokenLookup).
  • Supports the following Circle Web3 Services REST API endpoints:
    • Get token details (TokenLookupApi.get)
• TransactionApi
  • Exposed by the CircleSdk class as the transaction property (i.e. CircleSdk.transaction).
  • Supports the following Circle Web3 Services REST API endpoints:
    • List transactions (TransactionApi.list)
    • Get a transaction (TransactionApi.get)
    • Create a transfer transaction (TransactionApi.createTransfer)
    • Validate an address (TransactionApi.validateAddress)
    • Estimate fee for a contract execution transaction (TransactionApi.estimateContractExecutionFee)
    • Estimate fee for a transfer transaction (TransactionApi.estimateTransferFee)
    • Create a contract execution transaction (TransactionApi.createContractExecutionTransaction)
    • Cancel a transaction (TransactionApi.cancel)
    • Accelerate a transaction (TransactionApi.accelerate)
• WalletApi
  • Exposed by the CircleSdk class as the wallet property (i.e. CircleSdk.wallet).
  • Supports the following Circle Web3 Services REST API endpoints:
    • Create wallets (WalletApi.create)
    • List wallets (WalletApi.list)
    • Retrieve a wallet (WalletApi.get)
    • Update a wallet (WalletApi.update)
    • Get token balance for a wallet (WalletApi.balance)
    • Get NFTs for a wallet (WalletApi.nfts)
• WalletSetApi
  • Exposed by the CircleSdk class as the walletSet property (i.e. CircleSdk.walletSet).
  • Supports the following Circle Web3 Services REST API endpoints:
    • Create a new wallet set (WalletSetApi.create)
    • Update a wallet set (WalletSetApi.update)
    • Get all wallet sets (WalletSetApi.list)
    • Get a wallet set (WalletSetApi.get)

Constants

Helpful constant variables are defined in src/constants.ts.

Types

The types for interacting with the Circle Web3 Services REST API are defined in src/types.ts.