Class Provider

Hierarchy (View Summary)

Provider
- Provider
  - Provider

Index

Constructors

Methods

circle_createTransaction circle_createWallets circle_createWalletSet circle_deriveWallet circle_estimateTransferFee circle_getNotificationSignature circle_getTransaction circle_getWallet circle_getWalletsWithBalances circle_getWalletTokenBalance circle_listWallets circle_signTransaction circle_signTypedData request

Constructors

constructor

new Provider(
    __namedParameters: {
        apiKey: string;
        baseUrl?: string;
        entitySecret: string;
    },
): Provider
Parameters
- __namedParameters: { apiKey: string; baseUrl?: string; entitySecret: string }
Returns Provider
Overrides BaseProvider.constructor
- Defined in src/providers/developer-controlled-wallets/provider.ts:171

Methods

circle_createTransaction

circle_createTransaction(
params: CreateTransactionInput,
): Promise<undefined | Transaction>
Parameters
- params: CreateTransactionInput
Returns Promise<undefined | Transaction>
- Defined in src/providers/developer-controlled-wallets/provider.ts:285

circle_createWallets

circle_createWallets(params: CreateWalletsInput): Promise<undefined | Wallet[]>
Parameters
- params: CreateWalletsInput
Returns Promise<undefined | Wallet[]>
- Defined in src/providers/developer-controlled-wallets/provider.ts:186

circle_createWalletSet

circle_createWalletSet(
params: CreateWalletSetInput,
): Promise<undefined | WalletSet>
Parameters
- params: CreateWalletSetInput
Returns Promise<undefined | WalletSet>
- Defined in src/providers/developer-controlled-wallets/provider.ts:181

circle_deriveWallet

circle_deriveWallet(params: DeriveWalletInput): Promise<Wallet>
Parameters
- params: DeriveWalletInput
Returns Promise<Wallet>
- Defined in src/providers/developer-controlled-wallets/provider.ts:333

circle_estimateTransferFee

circle_estimateTransferFee(
params: EstimateTransferFeeInput,
): Promise<undefined | EstimateTransactionFee>
Parameters
- params: EstimateTransferFeeInput
Returns Promise<undefined | EstimateTransactionFee>
- Defined in src/providers/developer-controlled-wallets/provider.ts:250

circle_getNotificationSignature

circle_getNotificationSignature(
params: GetNotificationSignatureInput,
): Promise<NotificationSignature>
Parameters
- params: GetNotificationSignatureInput
Returns Promise<NotificationSignature>
- Defined in src/providers/developer-controlled-wallets/provider.ts:327

circle_getTransaction

circle_getTransaction(
params: GetTransactionInput,
): Promise<undefined | Transaction>
Parameters
- params: GetTransactionInput
Returns Promise<undefined | Transaction>
- Defined in src/providers/developer-controlled-wallets/provider.ts:322

circle_getWallet

circle_getWallet(params: GetWalletInput): Promise<undefined | Wallet>
Parameters
- params: GetWalletInput
Returns Promise<undefined | Wallet>
- Defined in src/providers/developer-controlled-wallets/provider.ts:191

circle_getWalletsWithBalances

circle_getWalletsWithBalances(
params: GetWalletsWithBalancesInput,
): Promise<Wallet[]>
Parameters
- params: GetWalletsWithBalancesInput
Returns Promise<Wallet[]>
- Defined in src/providers/developer-controlled-wallets/provider.ts:338

circle_getWalletTokenBalance

circle_getWalletTokenBalance(
params: GetWalletTokenBalanceInput,
): Promise<undefined | Balance[]>
Parameters
- params: GetWalletTokenBalanceInput
Returns Promise<undefined | Balance[]>
- Defined in src/providers/developer-controlled-wallets/provider.ts:201

circle_listWallets

circle_listWallets(params: ListWalletsInput): Promise<Wallet[]>
Parameters
- params: ListWalletsInput
Returns Promise<Wallet[]>
- Defined in src/providers/developer-controlled-wallets/provider.ts:196

circle_signTransaction

circle_signTransaction(params: SignTransactionInput): Promise<SignedTransaction>
Parameters
- params: SignTransactionInput
Returns Promise<SignedTransaction>
- Defined in src/providers/developer-controlled-wallets/provider.ts:364

circle_signTypedData

circle_signTypedData(params: SignTypedDataInput): Promise<SignedTypedData>
Parameters
- params: SignTypedDataInput
Returns Promise<SignedTypedData>
- Defined in src/providers/developer-controlled-wallets/provider.ts:343

request

request(
__namedParameters: { method: string; params?: unknown[] },
): Promise<unknown>
Parameters
- __namedParameters: { method: string; params?: unknown[] }
Returns Promise<unknown>
Inherited from BaseProvider.request
- Defined in src/providers/index.ts:15