From 247102019ccf8ebb647284370049c59b86eebcdc Mon Sep 17 00:00:00 2001 From: rohan-agarwal-coinbase Date: Fri, 18 Oct 2024 21:59:57 -0400 Subject: [PATCH] Release 0.9.1 (#301) * Updating readContract args to take in any for the value (#300) * Updated docs (#302) --- CHANGELOG.md | 5 + docs/classes/client_api.AddressesApi.html | 22 ++--- docs/classes/client_api.AssetsApi.html | 6 +- .../classes/client_api.BalanceHistoryApi.html | 6 +- .../classes/client_api.ContractEventsApi.html | 6 +- .../client_api.ContractInvocationsApi.html | 12 +-- .../client_api.ExternalAddressesApi.html | 10 +- docs/classes/client_api.NetworksApi.html | 6 +- docs/classes/client_api.ServerSignersApi.html | 16 +-- .../classes/client_api.SmartContractsApi.html | 14 +-- docs/classes/client_api.StakeApi.html | 14 +-- docs/classes/client_api.TradesApi.html | 12 +-- .../client_api.TransactionHistoryApi.html | 6 +- docs/classes/client_api.TransfersApi.html | 12 +-- docs/classes/client_api.UsersApi.html | 6 +- docs/classes/client_api.ValidatorsApi.html | 8 +- docs/classes/client_api.WalletStakeApi.html | 10 +- docs/classes/client_api.WalletsApi.html | 14 +-- docs/classes/client_api.WebhooksApi.html | 14 +-- docs/classes/client_base.BaseAPI.html | 4 +- docs/classes/client_base.RequiredError.html | 4 +- .../client_configuration.Configuration.html | 22 ++--- docs/classes/coinbase_address.Address.html | 40 ++++---- ...ress_external_address.ExternalAddress.html | 46 ++++----- ..._address_wallet_address.WalletAddress.html | 96 +++++++++--------- docs/classes/coinbase_api_error.APIError.html | 8 +- ...coinbase_api_error.AlreadyExistsError.html | 8 +- ...ase_api_error.FaucetLimitReachedError.html | 8 +- .../coinbase_api_error.InternalError.html | 8 +- ...oinbase_api_error.InvalidAddressError.html | 8 +- ...nbase_api_error.InvalidAddressIDError.html | 8 +- ...coinbase_api_error.InvalidAmountError.html | 8 +- ...oinbase_api_error.InvalidAssetIDError.html | 8 +- ...ase_api_error.InvalidDestinationError.html | 8 +- .../coinbase_api_error.InvalidLimitError.html | 8 +- ...nbase_api_error.InvalidNetworkIDError.html | 8 +- .../coinbase_api_error.InvalidPageError.html | 8 +- ...e_api_error.InvalidSignedPayloadError.html | 8 +- ...base_api_error.InvalidTransferIDError.html | 8 +- ..._api_error.InvalidTransferStatusError.html | 8 +- ...coinbase_api_error.InvalidWalletError.html | 8 +- ...inbase_api_error.InvalidWalletIDError.html | 8 +- ...nbase_api_error.MalformedRequestError.html | 8 +- ..._error.NetworkFeatureUnsupportedError.html | 8 +- .../coinbase_api_error.NotFoundError.html | 8 +- ...base_api_error.ResourceExhaustedError.html | 8 +- .../coinbase_api_error.UnauthorizedError.html | 8 +- ...coinbase_api_error.UnimplementedError.html | 8 +- ...nbase_api_error.UnsupportedAssetError.html | 8 +- docs/classes/coinbase_asset.Asset.html | 20 ++-- ...e_authenticator.CoinbaseAuthenticator.html | 14 +-- docs/classes/coinbase_balance.Balance.html | 8 +- .../coinbase_balance_map.BalanceMap.html | 8 +- docs/classes/coinbase_coinbase.Coinbase.html | 22 ++--- ...coinbase_contract_event.ContractEvent.html | 32 +++--- ...ontract_invocation.ContractInvocation.html | 44 ++++----- .../coinbase_errors.AlreadySignedError.html | 4 +- .../coinbase_errors.ArgumentError.html | 4 +- ...nbase_errors.InvalidAPIKeyFormatError.html | 4 +- ...base_errors.InvalidConfigurationError.html | 4 +- ...se_errors.InvalidUnsignedPayloadError.html | 4 +- .../coinbase_errors.NotSignedError.html | 4 +- .../classes/coinbase_errors.TimeoutError.html | 4 +- ..._faucet_transaction.FaucetTransaction.html | 10 +- ..._historical_balance.HistoricalBalance.html | 6 +- ...se_payload_signature.PayloadSignature.html | 24 ++--- .../coinbase_server_signer.ServerSigner.html | 12 +-- ...coinbase_smart_contract.SmartContract.html | 40 ++++---- ...coinbase_sponsored_send.SponsoredSend.html | 22 ++--- ...inbase_staking_balance.StakingBalance.html | 18 ++-- ...se_staking_operation.StakingOperation.html | 36 +++---- ...coinbase_staking_reward.StakingReward.html | 20 ++-- docs/classes/coinbase_trade.Trade.html | 38 +++---- .../coinbase_transaction.Transaction.html | 36 +++---- docs/classes/coinbase_transfer.Transfer.html | 44 ++++----- .../classes/coinbase_validator.Validator.html | 16 +-- docs/classes/coinbase_wallet.Wallet.html | 98 +++++++++---------- docs/classes/coinbase_webhook.Webhook.html | 30 +++--- docs/enums/client_api.NetworkIdentifier.html | 4 +- docs/enums/client_api.SmartContractType.html | 4 +- .../enums/client_api.StakingRewardFormat.html | 4 +- docs/enums/client_api.TransactionType.html | 4 +- docs/enums/client_api.ValidatorStatus.html | 4 +- docs/enums/client_api.WebhookEventType.html | 4 +- ...coinbase_types.PayloadSignatureStatus.html | 4 +- .../coinbase_types.ServerSignerStatus.html | 4 +- .../coinbase_types.SmartContractType.html | 4 +- .../coinbase_types.SponsoredSendStatus.html | 4 +- .../coinbase_types.StakeOptionsMode.html | 8 +- .../coinbase_types.StakingRewardFormat.html | 4 +- .../coinbase_types.TransactionStatus.html | 4 +- docs/enums/coinbase_types.TransferStatus.html | 4 +- .../enums/coinbase_types.ValidatorStatus.html | 4 +- ...ent_api.AddressesApiAxiosParamCreator.html | 2 +- .../client_api.AddressesApiFactory.html | 18 ++-- docs/functions/client_api.AddressesApiFp.html | 18 ++-- ...client_api.AssetsApiAxiosParamCreator.html | 2 +- .../client_api.AssetsApiFactory.html | 2 +- docs/functions/client_api.AssetsApiFp.html | 2 +- ...pi.BalanceHistoryApiAxiosParamCreator.html | 2 +- .../client_api.BalanceHistoryApiFactory.html | 2 +- .../client_api.BalanceHistoryApiFp.html | 2 +- ...pi.ContractEventsApiAxiosParamCreator.html | 2 +- .../client_api.ContractEventsApiFactory.html | 2 +- .../client_api.ContractEventsApiFp.html | 2 +- ...ntractInvocationsApiAxiosParamCreator.html | 2 +- ...ent_api.ContractInvocationsApiFactory.html | 8 +- .../client_api.ContractInvocationsApiFp.html | 8 +- ...ExternalAddressesApiAxiosParamCreator.html | 2 +- ...lient_api.ExternalAddressesApiFactory.html | 6 +- .../client_api.ExternalAddressesApiFp.html | 6 +- ...ient_api.NetworksApiAxiosParamCreator.html | 2 +- .../client_api.NetworksApiFactory.html | 2 +- docs/functions/client_api.NetworksApiFp.html | 2 +- ...api.ServerSignersApiAxiosParamCreator.html | 2 +- .../client_api.ServerSignersApiFactory.html | 12 +-- .../client_api.ServerSignersApiFp.html | 12 +-- ...pi.SmartContractsApiAxiosParamCreator.html | 2 +- .../client_api.SmartContractsApiFactory.html | 10 +- .../client_api.SmartContractsApiFp.html | 10 +- .../client_api.StakeApiAxiosParamCreator.html | 2 +- .../functions/client_api.StakeApiFactory.html | 10 +- docs/functions/client_api.StakeApiFp.html | 10 +- ...client_api.TradesApiAxiosParamCreator.html | 2 +- .../client_api.TradesApiFactory.html | 8 +- docs/functions/client_api.TradesApiFp.html | 8 +- ...ransactionHistoryApiAxiosParamCreator.html | 2 +- ...ient_api.TransactionHistoryApiFactory.html | 2 +- .../client_api.TransactionHistoryApiFp.html | 2 +- ...ent_api.TransfersApiAxiosParamCreator.html | 2 +- .../client_api.TransfersApiFactory.html | 8 +- docs/functions/client_api.TransfersApiFp.html | 8 +- .../client_api.UsersApiAxiosParamCreator.html | 2 +- .../functions/client_api.UsersApiFactory.html | 2 +- docs/functions/client_api.UsersApiFp.html | 2 +- ...nt_api.ValidatorsApiAxiosParamCreator.html | 2 +- .../client_api.ValidatorsApiFactory.html | 4 +- .../functions/client_api.ValidatorsApiFp.html | 4 +- ...t_api.WalletStakeApiAxiosParamCreator.html | 2 +- .../client_api.WalletStakeApiFactory.html | 6 +- .../client_api.WalletStakeApiFp.html | 6 +- ...lient_api.WalletsApiAxiosParamCreator.html | 2 +- .../client_api.WalletsApiFactory.html | 10 +- docs/functions/client_api.WalletsApiFp.html | 10 +- ...ient_api.WebhooksApiAxiosParamCreator.html | 2 +- .../client_api.WebhooksApiFactory.html | 10 +- docs/functions/client_api.WebhooksApiFp.html | 10 +- .../client_common.assertParamExists.html | 2 +- .../client_common.createRequestFunction.html | 2 +- .../client_common.serializeDataIfNeeded.html | 2 +- .../client_common.setApiKeyToObject.html | 2 +- .../client_common.setBasicAuthToObject.html | 2 +- .../client_common.setBearerAuthToObject.html | 2 +- .../client_common.setOAuthToObject.html | 2 +- .../client_common.setSearchParams.html | 2 +- .../functions/client_common.toPathString.html | 2 +- docs/functions/coinbase_hash.hashMessage.html | 2 +- .../coinbase_hash.hashTypedDataMessage.html | 2 +- .../coinbase_read_contract.readContract.html | 8 +- .../coinbase_utils.convertStringToHex.html | 2 +- docs/functions/coinbase_utils.delay.html | 2 +- docs/functions/coinbase_utils.formatDate.html | 2 +- .../coinbase_utils.getWeekBackDate.html | 2 +- .../coinbase_utils.logApiResponse.html | 2 +- .../coinbase_utils.parseUnsignedPayload.html | 2 +- ...nbase_utils.registerAxiosInterceptors.html | 2 +- docs/interfaces/client_api.Address.html | 12 +-- .../client_api.AddressBalanceList.html | 10 +- ...ient_api.AddressHistoricalBalanceList.html | 8 +- docs/interfaces/client_api.AddressList.html | 10 +- .../client_api.AddressTransactionList.html | 8 +- .../client_api.AddressesApiInterface.html | 20 ++-- docs/interfaces/client_api.Asset.html | 10 +- .../client_api.AssetsApiInterface.html | 4 +- docs/interfaces/client_api.Balance.html | 6 +- ...client_api.BalanceHistoryApiInterface.html | 4 +- ...pi.BroadcastContractInvocationRequest.html | 4 +- ..._api.BroadcastStakingOperationRequest.html | 6 +- .../client_api.BroadcastTradeRequest.html | 6 +- .../client_api.BroadcastTransferRequest.html | 4 +- ...ient_api.BuildStakingOperationRequest.html | 12 +-- docs/interfaces/client_api.ContractEvent.html | 28 +++--- .../client_api.ContractEventList.html | 8 +- ...client_api.ContractEventsApiInterface.html | 4 +- .../client_api.ContractInvocation.html | 22 ++--- .../client_api.ContractInvocationList.html | 10 +- ...t_api.ContractInvocationsApiInterface.html | 10 +- .../client_api.CreateAddressRequest.html | 8 +- ...t_api.CreateContractInvocationRequest.html | 12 +-- ...ent_api.CreatePayloadSignatureRequest.html | 6 +- .../client_api.CreateServerSignerRequest.html | 8 +- ...client_api.CreateSmartContractRequest.html | 6 +- ...ent_api.CreateStakingOperationRequest.html | 10 +- .../client_api.CreateTradeRequest.html | 8 +- .../client_api.CreateTransferRequest.html | 12 +-- .../client_api.CreateWalletRequest.html | 4 +- .../client_api.CreateWalletRequestWallet.html | 6 +- ...client_api.CreateWalletWebhookRequest.html | 6 +- .../client_api.CreateWebhookRequest.html | 14 +-- ...client_api.DeploySmartContractRequest.html | 4 +- .../client_api.ERC20TransferEvent.html | 28 +++--- .../client_api.ERC721TransferEvent.html | 28 +++--- .../client_api.EthereumTransaction.html | 36 +++---- .../client_api.EthereumTransactionAccess.html | 6 +- ...ent_api.EthereumTransactionAccessList.html | 4 +- ...api.EthereumTransactionFlattenedTrace.html | 40 ++++---- .../client_api.EthereumValidatorMetadata.html | 20 ++-- ...ent_api.ExternalAddressesApiInterface.html | 8 +- .../client_api.FaucetTransaction.html | 6 +- docs/interfaces/client_api.FeatureSet.html | 14 +-- ...hHistoricalStakingBalances200Response.html | 8 +- ...nt_api.FetchStakingRewards200Response.html | 8 +- ...client_api.FetchStakingRewardsRequest.html | 14 +-- .../client_api.GetStakingContextRequest.html | 10 +- .../client_api.HistoricalBalance.html | 10 +- docs/interfaces/client_api.ModelError.html | 8 +- .../client_api.MultiTokenContractOptions.html | 4 +- .../client_api.NFTContractOptions.html | 8 +- docs/interfaces/client_api.Network.html | 18 ++-- .../client_api.NetworksApiInterface.html | 4 +- .../client_api.PayloadSignature.html | 14 +-- .../client_api.PayloadSignatureList.html | 10 +- .../client_api.ReadContractRequest.html | 8 +- .../client_api.SeedCreationEvent.html | 6 +- .../client_api.SeedCreationEventResult.html | 10 +- docs/interfaces/client_api.ServerSigner.html | 8 +- .../client_api.ServerSignerEvent.html | 6 +- .../client_api.ServerSignerEventList.html | 10 +- .../client_api.ServerSignerList.html | 10 +- .../client_api.ServerSignersApiInterface.html | 14 +-- .../client_api.SignatureCreationEvent.html | 18 ++-- ...ient_api.SignatureCreationEventResult.html | 14 +-- ...pi.SignedVoluntaryExitMessageMetadata.html | 8 +- docs/interfaces/client_api.SmartContract.html | 20 ++-- .../client_api.SmartContractList.html | 8 +- ...client_api.SmartContractsApiInterface.html | 12 +-- docs/interfaces/client_api.SolidityValue.html | 10 +- docs/interfaces/client_api.SponsoredSend.html | 16 +-- .../client_api.StakeApiInterface.html | 12 +-- .../interfaces/client_api.StakingBalance.html | 12 +-- .../interfaces/client_api.StakingContext.html | 4 +- .../client_api.StakingContextContext.html | 8 +- .../client_api.StakingOperation.html | 16 +-- docs/interfaces/client_api.StakingReward.html | 14 +-- .../client_api.StakingRewardUSDValue.html | 8 +- .../client_api.TokenContractOptions.html | 8 +- docs/interfaces/client_api.Trade.html | 22 ++--- docs/interfaces/client_api.TradeList.html | 10 +- .../client_api.TradesApiInterface.html | 10 +- docs/interfaces/client_api.Transaction.html | 24 ++--- ...nt_api.TransactionHistoryApiInterface.html | 4 +- docs/interfaces/client_api.Transfer.html | 32 +++--- docs/interfaces/client_api.TransferList.html | 10 +- .../client_api.TransfersApiInterface.html | 10 +- .../client_api.UpdateWebhookRequest.html | 8 +- docs/interfaces/client_api.User.html | 6 +- .../client_api.UsersApiInterface.html | 4 +- docs/interfaces/client_api.Validator.html | 12 +-- docs/interfaces/client_api.ValidatorList.html | 8 +- .../client_api.ValidatorsApiInterface.html | 6 +- docs/interfaces/client_api.Wallet.html | 12 +-- docs/interfaces/client_api.WalletList.html | 10 +- .../client_api.WalletStakeApiInterface.html | 8 +- .../client_api.WalletsApiInterface.html | 12 +-- docs/interfaces/client_api.Webhook.html | 20 ++-- .../client_api.WebhookEventFilter.html | 8 +- docs/interfaces/client_api.WebhookList.html | 8 +- ...lient_api.WebhookWalletActivityFilter.html | 6 +- .../client_api.WebhooksApiInterface.html | 12 +-- docs/interfaces/client_base.RequestArgs.html | 4 +- ...configuration.ConfigurationParameters.html | 4 +- ...oinbase_types.BalanceHistoryApiClient.html | 4 +- .../coinbase_types.PaginationResponse.html | 4 +- ...coinbase_types.SmartContractAPIClient.html | 12 +-- ...ase_types.TransactionHistoryApiClient.html | 4 +- .../coinbase_types.WebhookApiClient.html | 12 +-- docs/modules/client.html | 2 +- docs/modules/client_api.html | 2 +- docs/modules/client_base.html | 2 +- docs/modules/client_common.html | 2 +- docs/modules/client_configuration.html | 2 +- docs/modules/coinbase_address.html | 2 +- .../coinbase_address_external_address.html | 2 +- .../coinbase_address_wallet_address.html | 2 +- docs/modules/coinbase_api_error.html | 2 +- docs/modules/coinbase_asset.html | 2 +- docs/modules/coinbase_authenticator.html | 2 +- docs/modules/coinbase_balance.html | 2 +- docs/modules/coinbase_balance_map.html | 2 +- docs/modules/coinbase_coinbase.html | 2 +- docs/modules/coinbase_constants.html | 2 +- docs/modules/coinbase_contract_event.html | 2 +- .../modules/coinbase_contract_invocation.html | 2 +- docs/modules/coinbase_errors.html | 2 +- docs/modules/coinbase_faucet_transaction.html | 2 +- docs/modules/coinbase_hash.html | 2 +- docs/modules/coinbase_historical_balance.html | 2 +- docs/modules/coinbase_payload_signature.html | 2 +- docs/modules/coinbase_read_contract.html | 2 +- docs/modules/coinbase_server_signer.html | 2 +- docs/modules/coinbase_smart_contract.html | 2 +- docs/modules/coinbase_sponsored_send.html | 2 +- docs/modules/coinbase_staking_balance.html | 2 +- docs/modules/coinbase_staking_operation.html | 2 +- docs/modules/coinbase_staking_reward.html | 2 +- docs/modules/coinbase_trade.html | 2 +- docs/modules/coinbase_transaction.html | 2 +- docs/modules/coinbase_transfer.html | 2 +- docs/modules/coinbase_types.html | 2 +- docs/modules/coinbase_types_contract.html | 2 +- docs/modules/coinbase_utils.html | 2 +- docs/modules/coinbase_validator.html | 2 +- docs/modules/coinbase_wallet.html | 2 +- docs/modules/coinbase_webhook.html | 2 +- docs/modules/index.html | 2 +- .../client_api.NetworkProtocolFamilyEnum.html | 2 +- ...client_api.PayloadSignatureStatusEnum.html | 2 +- .../client_api.ServerSignerEventEvent.html | 2 +- .../client_api.SmartContractOptions.html | 2 +- .../client_api.SolidityValueTypeEnum.html | 2 +- .../client_api.SponsoredSendStatusEnum.html | 2 +- .../client_api.StakingOperationMetadata.html | 2 +- ...client_api.StakingOperationStatusEnum.html | 2 +- .../client_api.StakingRewardStateEnum.html | 2 +- docs/types/client_api.TransactionContent.html | 2 +- .../client_api.TransactionStatusEnum.html | 2 +- docs/types/client_api.TransferStatusEnum.html | 2 +- docs/types/client_api.ValidatorDetails.html | 2 +- ...ient_api.WalletServerSignerStatusEnum.html | 2 +- .../client_api.WebhookEventTypeFilter.html | 2 +- .../coinbase_types.AddressAPIClient.html | 18 ++-- docs/types/coinbase_types.Amount.html | 2 +- docs/types/coinbase_types.ApiClients.html | 2 +- docs/types/coinbase_types.AssetAPIClient.html | 2 +- ...ypes.CoinbaseConfigureFromJsonOptions.html | 2 +- .../types/coinbase_types.CoinbaseOptions.html | 2 +- ...ase_types.ContractInvocationAPIClient.html | 8 +- ...types.CreateContractInvocationOptions.html | 2 +- .../coinbase_types.CreateERC1155Options.html | 2 +- .../coinbase_types.CreateERC20Options.html | 2 +- .../coinbase_types.CreateERC721Options.html | 2 +- .../coinbase_types.CreateTradeOptions.html | 2 +- .../coinbase_types.CreateTransferOptions.html | 2 +- .../coinbase_types.CreateWebhookOptions.html | 2 +- docs/types/coinbase_types.Destination.html | 2 +- ...inbase_types.ExternalAddressAPIClient.html | 6 +- ..._types.ExternalSmartContractAPIClient.html | 2 +- ...e_types.ListHistoricalBalancesOptions.html | 2 +- ...se_types.ListHistoricalBalancesResult.html | 2 +- ...oinbase_types.ListTransactionsOptions.html | 2 +- ...coinbase_types.ListTransactionsResult.html | 2 +- ...nbase_types.MultiTokenContractOptions.html | 2 +- .../coinbase_types.NFTContractOptions.html | 2 +- .../coinbase_types.PaginationOptions.html | 2 +- docs/types/coinbase_types.SeedData.html | 2 +- .../coinbase_types.ServerSignerAPIClient.html | 2 +- .../coinbase_types.SmartContractOptions.html | 2 +- docs/types/coinbase_types.StakeAPIClient.html | 10 +- .../coinbase_types.TokenContractOptions.html | 2 +- .../types/coinbase_types.TradeApiClients.html | 8 +- .../coinbase_types.TransferAPIClient.html | 8 +- .../types/coinbase_types.TypedDataDomain.html | 2 +- docs/types/coinbase_types.TypedDataField.html | 2 +- .../coinbase_types.UpdateWebhookOptions.html | 2 +- .../coinbase_types.ValidatorAPIClient.html | 4 +- .../types/coinbase_types.WalletAPIClient.html | 8 +- .../coinbase_types.WalletCreateOptions.html | 2 +- docs/types/coinbase_types.WalletData.html | 2 +- .../coinbase_types.WalletStakeAPIClient.html | 2 +- ...s_contract.ContractFunctionReturnType.html | 4 +- ...lient_api.NetworkProtocolFamilyEnum-1.html | 2 +- ...ient_api.PayloadSignatureStatusEnum-1.html | 2 +- .../client_api.SolidityValueTypeEnum-1.html | 2 +- .../client_api.SponsoredSendStatusEnum-1.html | 2 +- ...ient_api.StakingOperationStatusEnum-1.html | 2 +- .../client_api.StakingRewardStateEnum-1.html | 2 +- .../client_api.TransactionStatusEnum-1.html | 2 +- .../client_api.TransferStatusEnum-1.html | 2 +- ...nt_api.WalletServerSignerStatusEnum-1.html | 2 +- docs/variables/client_base.BASE_PATH.html | 2 +- .../client_base.COLLECTION_FORMATS.html | 2 +- .../client_base.operationServerMap.html | 2 +- .../client_common.DUMMY_BASE_URL.html | 2 +- .../coinbase_constants.GWEI_DECIMALS.html | 2 +- package.json | 2 +- quickstart-template/package.json | 2 +- src/coinbase/read_contract.ts | 9 +- src/coinbase/types/contract.ts | 14 +-- 388 files changed, 1552 insertions(+), 1546 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 98d69a30..f28b95b3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,11 @@ ## Unreleased +## [0.9.1] - 2024-10-18 + +### Fixed +- Fixed a bug where readContract was not working for nested types + ## [0.9.0] - 2024-10-17 ### Added diff --git a/docs/classes/client_api.AddressesApi.html b/docs/classes/client_api.AddressesApi.html index 6d93ff5e..49c609e9 100644 --- a/docs/classes/client_api.AddressesApi.html +++ b/docs/classes/client_api.AddressesApi.html @@ -1,6 +1,6 @@ AddressesApi | @coinbase/coinbase-sdk

Class AddressesApi

AddressesApi - object-oriented interface

Export

AddressesApi

-

Hierarchy (view full)

Implements

Constructors

constructor +

Hierarchy (view full)

Implements

Constructors

constructor

Properties

axios basePath configuration @@ -13,52 +13,52 @@ listAddresses listPayloadSignatures requestFaucetFunds -

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

createAddress

  • createAddress(walletId, createAddressRequest?, options?): Promise<AxiosResponse<Address, any>>

  • Create a new address scoped to the wallet.

    +

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

createAddress

  • createAddress(walletId, createAddressRequest?, options?): Promise<AxiosResponse<Address, any>>

  • Create a new address scoped to the wallet.

    Parameters

    • walletId: string

      The ID of the wallet to create the address in.

    • Optional createAddressRequest: CreateAddressRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Address, any>>

    Summary

    Create a new address

    Throws

    Memberof

    AddressesApi

    -

createPayloadSignature

createPayloadSignature

  • createPayloadSignature(walletId, addressId, createPayloadSignatureRequest?, options?): Promise<AxiosResponse<PayloadSignature, any>>

  • Create a new payload signature with an address.

    Parameters

    • walletId: string

      The ID of the wallet the address belongs to.

    • addressId: string

      The onchain address of the address to sign the payload with.

    • Optional createPayloadSignatureRequest: CreatePayloadSignatureRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<PayloadSignature, any>>

    Summary

    Create a new payload signature.

    Throws

    Memberof

    AddressesApi

    -

getAddress

getAddress

  • getAddress(walletId, addressId, options?): Promise<AxiosResponse<Address, any>>

  • Get address

    Parameters

    • walletId: string

      The ID of the wallet the address belongs to.

    • addressId: string

      The onchain address of the address that is being fetched.

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Address, any>>

    Summary

    Get address by onchain address

    Throws

    Memberof

    AddressesApi

    -

getAddressBalance

getAddressBalance

  • getAddressBalance(walletId, addressId, assetId, options?): Promise<AxiosResponse<Balance, any>>

  • Get address balance

    Parameters

    • walletId: string

      The ID of the wallet to fetch the balance for

    • addressId: string

      The onchain address of the address that is being fetched.

    • assetId: string

      The symbol of the asset to fetch the balance for

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Balance, any>>

    Summary

    Get address balance for asset

    Throws

    Memberof

    AddressesApi

    -

getPayloadSignature

getPayloadSignature

  • getPayloadSignature(walletId, addressId, payloadSignatureId, options?): Promise<AxiosResponse<PayloadSignature, any>>

  • Get payload signature.

    Parameters

    • walletId: string

      The ID of the wallet the address belongs to.

    • addressId: string

      The onchain address of the address that signed the payload.

    • payloadSignatureId: string

      The ID of the payload signature to fetch.

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<PayloadSignature, any>>

    Summary

    Get payload signature.

    Throws

    Memberof

    AddressesApi

    -

listAddressBalances

listAddressBalances

  • listAddressBalances(walletId, addressId, page?, options?): Promise<AxiosResponse<AddressBalanceList, any>>

  • Get address balances

    Parameters

    • walletId: string

      The ID of the wallet to fetch the balances for

    • addressId: string

      The onchain address of the address that is being fetched.

    • Optional page: string

      A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<AddressBalanceList, any>>

    Summary

    Get all balances for address

    Throws

    Memberof

    AddressesApi

    -

listAddresses

listAddresses

  • listAddresses(walletId, limit?, page?, options?): Promise<AxiosResponse<AddressList, any>>

  • List addresses in the wallet.

    Parameters

    • walletId: string

      The ID of the wallet whose addresses to fetch

    • Optional limit: number

      A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

    • Optional page: string

      A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<AddressList, any>>

    Summary

    List addresses in a wallet.

    Throws

    Memberof

    AddressesApi

    -

listPayloadSignatures

listPayloadSignatures

  • listPayloadSignatures(walletId, addressId, limit?, page?, options?): Promise<AxiosResponse<PayloadSignatureList, any>>

  • List payload signatures for an address.

    Parameters

    • walletId: string

      The ID of the wallet the address belongs to.

    • addressId: string

      The onchain address of the address whose payload signatures to fetch.

    • Optional limit: number

      A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

      @@ -66,11 +66,11 @@

      Throws

      Memberof

      AddressesApi

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<PayloadSignatureList, any>>

    Summary

    List payload signatures for an address.

    Throws

    Memberof

    AddressesApi

    -

requestFaucetFunds

requestFaucetFunds

  • requestFaucetFunds(walletId, addressId, assetId?, options?): Promise<AxiosResponse<FaucetTransaction, any>>

  • Request faucet funds to be sent to onchain address.

    Parameters

    • walletId: string

      The ID of the wallet the address belongs to.

    • addressId: string

      The onchain address of the address that is being fetched.

    • Optional assetId: string

      The ID of the asset to transfer from the faucet.

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<FaucetTransaction, any>>

    Summary

    Request faucet funds for onchain address.

    Throws

    Memberof

    AddressesApi

    -

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationcreateAddresscreatePayloadSignaturegetAddressgetAddressBalancegetPayloadSignaturelistAddressBalanceslistAddresseslistPayloadSignaturesrequestFaucetFunds
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationcreateAddresscreatePayloadSignaturegetAddressgetAddressBalancegetPayloadSignaturelistAddressBalanceslistAddresseslistPayloadSignaturesrequestFaucetFunds
\ No newline at end of file diff --git a/docs/classes/client_api.AssetsApi.html b/docs/classes/client_api.AssetsApi.html index b3e5175c..33d05c5c 100644 --- a/docs/classes/client_api.AssetsApi.html +++ b/docs/classes/client_api.AssetsApi.html @@ -1,14 +1,14 @@ AssetsApi | @coinbase/coinbase-sdk

Class AssetsApi

AssetsApi - object-oriented interface

Export

AssetsApi

-

Hierarchy (view full)

Implements

Constructors

constructor +

Hierarchy (view full)

Implements

Constructors

constructor

Properties

axios basePath configuration

Methods

getAsset -

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

getAsset

  • getAsset(networkId, assetId, options?): Promise<AxiosResponse<Asset, any>>

  • Get the asset for the specified asset ID.

    +

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

getAsset

  • getAsset(networkId, assetId, options?): Promise<AxiosResponse<Asset, any>>

  • Get the asset for the specified asset ID.

    Parameters

    • networkId: string

      The ID of the blockchain network

    • assetId: string

      The ID of the asset to fetch. This could be a symbol or an ERC20 contract address.

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Asset, any>>

    Summary

    Get the asset for the specified asset ID.

    Throws

    Memberof

    AssetsApi

    -

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationgetAsset
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationgetAsset
\ No newline at end of file diff --git a/docs/classes/client_api.BalanceHistoryApi.html b/docs/classes/client_api.BalanceHistoryApi.html index 96b3ab8d..efc6a95a 100644 --- a/docs/classes/client_api.BalanceHistoryApi.html +++ b/docs/classes/client_api.BalanceHistoryApi.html @@ -1,11 +1,11 @@ BalanceHistoryApi | @coinbase/coinbase-sdk

Class BalanceHistoryApi

BalanceHistoryApi - object-oriented interface

Export

BalanceHistoryApi

-

Hierarchy (view full)

Implements

Constructors

constructor +

Hierarchy (view full)

Implements

Constructors

constructor

Properties

axios basePath configuration

Methods

listAddressHistoricalBalance -

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

listAddressHistoricalBalance

  • listAddressHistoricalBalance(networkId, addressId, assetId, limit?, page?, options?): Promise<AxiosResponse<AddressHistoricalBalanceList, any>>

  • List the historical balance of an asset in a specific address.

    +

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

listAddressHistoricalBalance

  • listAddressHistoricalBalance(networkId, addressId, assetId, limit?, page?, options?): Promise<AxiosResponse<AddressHistoricalBalanceList, any>>

  • List the historical balance of an asset in a specific address.

    Parameters

    • networkId: string

      The ID of the blockchain network

    • addressId: string

      The ID of the address to fetch the historical balance for.

    • assetId: string

      The symbol of the asset to fetch the historical balance for.

      @@ -14,4 +14,4 @@
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<AddressHistoricalBalanceList, any>>

    Summary

    Get address balance history for asset

    Throws

    Memberof

    BalanceHistoryApi

    -

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationlistAddressHistoricalBalance
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationlistAddressHistoricalBalance
\ No newline at end of file diff --git a/docs/classes/client_api.ContractEventsApi.html b/docs/classes/client_api.ContractEventsApi.html index 927e6354..f339b367 100644 --- a/docs/classes/client_api.ContractEventsApi.html +++ b/docs/classes/client_api.ContractEventsApi.html @@ -1,11 +1,11 @@ ContractEventsApi | @coinbase/coinbase-sdk

Class ContractEventsApi

ContractEventsApi - object-oriented interface

Export

ContractEventsApi

-

Hierarchy (view full)

Implements

Constructors

constructor +

Hierarchy (view full)

Implements

Constructors

constructor

Properties

axios basePath configuration

Methods

listContractEvents -

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

listContractEvents

  • listContractEvents(networkId, protocolName, contractAddress, contractName, eventName, fromBlockHeight, toBlockHeight, nextPage?, options?): Promise<AxiosResponse<ContractEventList, any>>

  • Retrieve events for a specific contract

    +

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

listContractEvents

  • listContractEvents(networkId, protocolName, contractAddress, contractName, eventName, fromBlockHeight, toBlockHeight, nextPage?, options?): Promise<AxiosResponse<ContractEventList, any>>

  • Retrieve events for a specific contract

    Parameters

    • networkId: string

      Unique identifier for the blockchain network

    • protocolName: string

      Case-sensitive name of the blockchain protocol

    • contractAddress: string

      EVM address of the smart contract (42 characters, including &#39;0x&#39;, in lowercase)

      @@ -17,4 +17,4 @@
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<ContractEventList, any>>

    Summary

    List contract events

    Throws

    Memberof

    ContractEventsApi

    -

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationlistContractEvents
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationlistContractEvents
\ No newline at end of file diff --git a/docs/classes/client_api.ContractInvocationsApi.html b/docs/classes/client_api.ContractInvocationsApi.html index 9a000432..8cadef8b 100644 --- a/docs/classes/client_api.ContractInvocationsApi.html +++ b/docs/classes/client_api.ContractInvocationsApi.html @@ -1,6 +1,6 @@ ContractInvocationsApi | @coinbase/coinbase-sdk

Class ContractInvocationsApi

ContractInvocationsApi - object-oriented interface

Export

ContractInvocationsApi

-

Hierarchy (view full)

Implements

Constructors

constructor +

Hierarchy (view full)

Implements

Constructors

constructor

Properties

axios basePath configuration @@ -8,27 +8,27 @@ createContractInvocation getContractInvocation listContractInvocations -

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

broadcastContractInvocation

  • broadcastContractInvocation(walletId, addressId, contractInvocationId, broadcastContractInvocationRequest, options?): Promise<AxiosResponse<ContractInvocation, any>>

  • Broadcast a contract invocation.

    +

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

broadcastContractInvocation

  • broadcastContractInvocation(walletId, addressId, contractInvocationId, broadcastContractInvocationRequest, options?): Promise<AxiosResponse<ContractInvocation, any>>

  • Broadcast a contract invocation.

    Parameters

    • walletId: string

      The ID of the wallet the address belongs to.

    • addressId: string

      The ID of the address the contract invocation belongs to.

    • contractInvocationId: string

      The ID of the contract invocation to broadcast.

    • broadcastContractInvocationRequest: BroadcastContractInvocationRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<ContractInvocation, any>>

    Summary

    Broadcast a contract invocation.

    Throws

    Memberof

    ContractInvocationsApi

    -

createContractInvocation

createContractInvocation

getContractInvocation

getContractInvocation

  • getContractInvocation(walletId, addressId, contractInvocationId, options?): Promise<AxiosResponse<ContractInvocation, any>>

  • Get a contract invocation by ID.

    Parameters

    • walletId: string

      The ID of the wallet the address belongs to.

    • addressId: string

      The ID of the address the contract invocation belongs to.

    • contractInvocationId: string

      The ID of the contract invocation to fetch.

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<ContractInvocation, any>>

    Summary

    Get a contract invocation by ID.

    Throws

    Memberof

    ContractInvocationsApi

    -

listContractInvocations

listContractInvocations

  • listContractInvocations(walletId, addressId, limit?, page?, options?): Promise<AxiosResponse<ContractInvocationList, any>>

  • List contract invocations for an address.

    Parameters

    • walletId: string

      The ID of the wallet the address belongs to.

    • addressId: string

      The ID of the address to list contract invocations for.

    • Optional limit: number

      A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

      @@ -36,4 +36,4 @@

      Throws

      Memberof

      ContractInvocationsApi

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<ContractInvocationList, any>>

    Summary

    List contract invocations for an address.

    Throws

    Memberof

    ContractInvocationsApi

    -

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationbroadcastContractInvocationcreateContractInvocationgetContractInvocationlistContractInvocations
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationbroadcastContractInvocationcreateContractInvocationgetContractInvocationlistContractInvocations
\ No newline at end of file diff --git a/docs/classes/client_api.ExternalAddressesApi.html b/docs/classes/client_api.ExternalAddressesApi.html index d628e8d2..93968e8b 100644 --- a/docs/classes/client_api.ExternalAddressesApi.html +++ b/docs/classes/client_api.ExternalAddressesApi.html @@ -1,31 +1,31 @@ ExternalAddressesApi | @coinbase/coinbase-sdk

Class ExternalAddressesApi

ExternalAddressesApi - object-oriented interface

Export

ExternalAddressesApi

-

Hierarchy (view full)

Implements

Constructors

constructor +

Hierarchy (view full)

Implements

Constructors

constructor

Properties

axios basePath configuration

Methods

getExternalAddressBalance listExternalAddressBalances requestExternalFaucetFunds -

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

getExternalAddressBalance

  • getExternalAddressBalance(networkId, addressId, assetId, options?): Promise<AxiosResponse<Balance, any>>

  • Get the balance of an asset in an external address

    +

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

getExternalAddressBalance

  • getExternalAddressBalance(networkId, addressId, assetId, options?): Promise<AxiosResponse<Balance, any>>

  • Get the balance of an asset in an external address

    Parameters

    • networkId: string

      The ID of the blockchain network

    • addressId: string

      The ID of the address to fetch the balance for

    • assetId: string

      The ID of the asset to fetch the balance for

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Balance, any>>

    Summary

    Get the balance of an asset in an external address

    Throws

    Memberof

    ExternalAddressesApi

    -

listExternalAddressBalances

listExternalAddressBalances

  • listExternalAddressBalances(networkId, addressId, page?, options?): Promise<AxiosResponse<AddressBalanceList, any>>

  • List all of the balances of an external address

    Parameters

    • networkId: string

      The ID of the blockchain network

    • addressId: string

      The ID of the address to fetch the balance for

    • Optional page: string

      A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<AddressBalanceList, any>>

    Summary

    Get the balances of an external address

    Throws

    Memberof

    ExternalAddressesApi

    -

requestExternalFaucetFunds

requestExternalFaucetFunds

  • requestExternalFaucetFunds(networkId, addressId, assetId?, options?): Promise<AxiosResponse<FaucetTransaction, any>>

  • Request faucet funds to be sent to external address.

    Parameters

    • networkId: string

      The ID of the wallet the address belongs to.

    • addressId: string

      The onchain address of the address that is being fetched.

    • Optional assetId: string

      The ID of the asset to transfer from the faucet.

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<FaucetTransaction, any>>

    Summary

    Request faucet funds for external address.

    Throws

    Memberof

    ExternalAddressesApi

    -

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationgetExternalAddressBalancelistExternalAddressBalancesrequestExternalFaucetFunds
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationgetExternalAddressBalancelistExternalAddressBalancesrequestExternalFaucetFunds
\ No newline at end of file diff --git a/docs/classes/client_api.NetworksApi.html b/docs/classes/client_api.NetworksApi.html index 6fa979ab..d00d2838 100644 --- a/docs/classes/client_api.NetworksApi.html +++ b/docs/classes/client_api.NetworksApi.html @@ -1,13 +1,13 @@ NetworksApi | @coinbase/coinbase-sdk

Class NetworksApi

NetworksApi - object-oriented interface

Export

NetworksApi

-

Hierarchy (view full)

Implements

Constructors

constructor +

Hierarchy (view full)

Implements

Constructors

constructor

Properties

axios basePath configuration

Methods

getNetwork -

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

getNetwork

  • getNetwork(networkId, options?): Promise<AxiosResponse<Network, any>>

  • Get network

    +

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

getNetwork

  • getNetwork(networkId, options?): Promise<AxiosResponse<Network, any>>

  • Get network

    Parameters

    • networkId: string

      The ID of the network to fetch.

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Network, any>>

    Summary

    Get network by ID

    Throws

    Memberof

    NetworksApi

    -

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationgetNetwork
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationgetNetwork
\ No newline at end of file diff --git a/docs/classes/client_api.ServerSignersApi.html b/docs/classes/client_api.ServerSignersApi.html index d4c27d12..346ce328 100644 --- a/docs/classes/client_api.ServerSignersApi.html +++ b/docs/classes/client_api.ServerSignersApi.html @@ -1,6 +1,6 @@ ServerSignersApi | @coinbase/coinbase-sdk

Class ServerSignersApi

ServerSignersApi - object-oriented interface

Export

ServerSignersApi

-

Hierarchy (view full)

Implements

Constructors

constructor +

Hierarchy (view full)

Implements

Constructors

constructor

Properties

axios basePath configuration @@ -10,36 +10,36 @@ listServerSigners submitServerSignerSeedEventResult submitServerSignerSignatureEventResult -

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

createServerSigner

  • createServerSigner(createServerSignerRequest?, options?): Promise<AxiosResponse<ServerSigner, any>>

  • Create a new Server-Signer

    +

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

createServerSigner

getServerSigner

getServerSigner

  • getServerSigner(serverSignerId, options?): Promise<AxiosResponse<ServerSigner, any>>

  • Get a server signer by ID

    Parameters

    • serverSignerId: string

      The ID of the server signer to fetch

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<ServerSigner, any>>

    Summary

    Get a server signer by ID

    Throws

    Memberof

    ServerSignersApi

    -

listServerSignerEvents

listServerSignerEvents

  • listServerSignerEvents(serverSignerId, limit?, page?, options?): Promise<AxiosResponse<ServerSignerEventList, any>>

  • List events for a server signer

    Parameters

    • serverSignerId: string

      The ID of the server signer to fetch events for

    • Optional limit: number

      A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

    • Optional page: string

      A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<ServerSignerEventList, any>>

    Summary

    List events for a server signer

    Deprecated

    Throws

    Memberof

    ServerSignersApi

    -

listServerSigners

listServerSigners

  • listServerSigners(limit?, page?, options?): Promise<AxiosResponse<ServerSignerList, any>>

  • List server signers for the current project

    Parameters

    • Optional limit: number

      A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

    • Optional page: string

      A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<ServerSignerList, any>>

    Summary

    List server signers for the current project

    Throws

    Memberof

    ServerSignersApi

    -

submitServerSignerSeedEventResult

submitServerSignerSeedEventResult

submitServerSignerSignatureEventResult

submitServerSignerSignatureEventResult

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationcreateServerSignergetServerSignerlistServerSignerEventslistServerSignerssubmitServerSignerSeedEventResultsubmitServerSignerSignatureEventResult
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationcreateServerSignergetServerSignerlistServerSignerEventslistServerSignerssubmitServerSignerSeedEventResultsubmitServerSignerSignatureEventResult
\ No newline at end of file diff --git a/docs/classes/client_api.SmartContractsApi.html b/docs/classes/client_api.SmartContractsApi.html index c6093aca..e2a9569b 100644 --- a/docs/classes/client_api.SmartContractsApi.html +++ b/docs/classes/client_api.SmartContractsApi.html @@ -1,6 +1,6 @@ SmartContractsApi | @coinbase/coinbase-sdk

Class SmartContractsApi

SmartContractsApi - object-oriented interface

Export

SmartContractsApi

-

Hierarchy (view full)

Implements

Constructors

constructor +

Hierarchy (view full)

Implements

Constructors

constructor

Properties

axios basePath configuration @@ -9,34 +9,34 @@ getSmartContract listSmartContracts readContract -

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

createSmartContract

  • createSmartContract(walletId, addressId, createSmartContractRequest, options?): Promise<AxiosResponse<SmartContract, any>>

  • Create a new smart contract

    +

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

createSmartContract

  • createSmartContract(walletId, addressId, createSmartContractRequest, options?): Promise<AxiosResponse<SmartContract, any>>

  • Create a new smart contract

    Parameters

    • walletId: string

      The ID of the wallet the address belongs to.

    • addressId: string

      The ID of the address to deploy the smart contract from.

    • createSmartContractRequest: CreateSmartContractRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<SmartContract, any>>

    Summary

    Create a new smart contract

    Throws

    Memberof

    SmartContractsApi

    -

deploySmartContract

deploySmartContract

  • deploySmartContract(walletId, addressId, smartContractId, deploySmartContractRequest, options?): Promise<AxiosResponse<SmartContract, any>>

  • Deploys a smart contract, by broadcasting the transaction to the network.

    Parameters

    • walletId: string

      The ID of the wallet the address belongs to.

    • addressId: string

      The ID of the address to broadcast the transaction from.

    • smartContractId: string

      The UUID of the smart contract to broadcast the transaction to.

    • deploySmartContractRequest: DeploySmartContractRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<SmartContract, any>>

    Summary

    Deploy a smart contract

    Throws

    Memberof

    SmartContractsApi

    -

getSmartContract

getSmartContract

  • getSmartContract(walletId, addressId, smartContractId, options?): Promise<AxiosResponse<SmartContract, any>>

  • Get a specific smart contract deployed by address.

    Parameters

    • walletId: string

      The ID of the wallet the address belongs to.

    • addressId: string

      The ID of the address to fetch the smart contract for.

    • smartContractId: string

      The UUID of the smart contract to fetch.

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<SmartContract, any>>

    Summary

    Get a specific smart contract deployed by address

    Throws

    Memberof

    SmartContractsApi

    -

listSmartContracts

listSmartContracts

  • listSmartContracts(walletId, addressId, options?): Promise<AxiosResponse<SmartContractList, any>>

  • List all smart contracts deployed by address.

    Parameters

    • walletId: string

      The ID of the wallet the address belongs to.

    • addressId: string

      The ID of the address to fetch the smart contracts for.

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<SmartContractList, any>>

    Summary

    List smart contracts deployed by address

    Throws

    Memberof

    SmartContractsApi

    -

readContract

readContract

  • readContract(networkId, contractAddress, readContractRequest, options?): Promise<AxiosResponse<SolidityValue, any>>

  • Perform a read operation on a smart contract without creating a transaction

    Parameters

    • networkId: string
    • contractAddress: string
    • readContractRequest: ReadContractRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<SolidityValue, any>>

    Summary

    Read data from a smart contract

    Throws

    Memberof

    SmartContractsApi

    -

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationcreateSmartContractdeploySmartContractgetSmartContractlistSmartContractsreadContract
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationcreateSmartContractdeploySmartContractgetSmartContractlistSmartContractsreadContract
\ No newline at end of file diff --git a/docs/classes/client_api.StakeApi.html b/docs/classes/client_api.StakeApi.html index 7c384f4c..f15f95a3 100644 --- a/docs/classes/client_api.StakeApi.html +++ b/docs/classes/client_api.StakeApi.html @@ -1,6 +1,6 @@ StakeApi | @coinbase/coinbase-sdk

Class StakeApi

StakeApi - object-oriented interface

Export

StakeApi

-

Hierarchy (view full)

Implements

Constructors

constructor +

Hierarchy (view full)

Implements

Constructors

constructor

Properties

axios basePath configuration @@ -9,11 +9,11 @@ fetchStakingRewards getExternalStakingOperation getStakingContext -

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

buildStakingOperation

  • buildStakingOperation(buildStakingOperationRequest, options?): Promise<AxiosResponse<StakingOperation, any>>

  • Build a new staking operation

    +

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

buildStakingOperation

fetchHistoricalStakingBalances

fetchHistoricalStakingBalances

  • fetchHistoricalStakingBalances(networkId, assetId, addressId, startTime, endTime, limit?, page?, options?): Promise<AxiosResponse<FetchHistoricalStakingBalances200Response, any>>

  • Fetch historical staking balances for given address.

    Parameters

    • networkId: string

      The ID of the blockchain network.

    • assetId: string

      The ID of the asset for which the historical staking balances are being fetched.

    • addressId: string

      The onchain address for which the historical staking balances are being fetched.

      @@ -24,21 +24,21 @@

      Throws

      Memberof

      StakeApi

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<FetchHistoricalStakingBalances200Response, any>>

    Summary

    Fetch historical staking balances

    Throws

    Memberof

    StakeApi

    -

fetchStakingRewards

fetchStakingRewards

  • fetchStakingRewards(fetchStakingRewardsRequest, limit?, page?, options?): Promise<AxiosResponse<FetchStakingRewards200Response, any>>

  • Fetch staking rewards for a list of addresses

    Parameters

    • fetchStakingRewardsRequest: FetchStakingRewardsRequest
    • Optional limit: number

      A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 50.

    • Optional page: string

      A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<FetchStakingRewards200Response, any>>

    Summary

    Fetch staking rewards

    Throws

    Memberof

    StakeApi

    -

getExternalStakingOperation

getExternalStakingOperation

  • getExternalStakingOperation(networkId, addressId, stakingOperationId, options?): Promise<AxiosResponse<StakingOperation, any>>

  • Get the latest state of a staking operation

    Parameters

    • networkId: string

      The ID of the blockchain network

    • addressId: string

      The ID of the address to fetch the staking operation for

    • stakingOperationId: string

      The ID of the staking operation

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<StakingOperation, any>>

    Summary

    Get the latest state of a staking operation

    Throws

    Memberof

    StakeApi

    -

getStakingContext

getStakingContext

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationbuildStakingOperationfetchHistoricalStakingBalancesfetchStakingRewardsgetExternalStakingOperationgetStakingContext
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationbuildStakingOperationfetchHistoricalStakingBalancesfetchStakingRewardsgetExternalStakingOperationgetStakingContext
\ No newline at end of file diff --git a/docs/classes/client_api.TradesApi.html b/docs/classes/client_api.TradesApi.html index 8d37e4df..611ac9c5 100644 --- a/docs/classes/client_api.TradesApi.html +++ b/docs/classes/client_api.TradesApi.html @@ -1,6 +1,6 @@ TradesApi | @coinbase/coinbase-sdk

Class TradesApi

TradesApi - object-oriented interface

Export

TradesApi

-

Hierarchy (view full)

Implements

Constructors

constructor +

Hierarchy (view full)

Implements

Constructors

constructor

Properties

axios basePath configuration @@ -8,27 +8,27 @@ createTrade getTrade listTrades -

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

broadcastTrade

  • broadcastTrade(walletId, addressId, tradeId, broadcastTradeRequest, options?): Promise<AxiosResponse<Trade, any>>

  • Broadcast a trade

    +

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

broadcastTrade

  • broadcastTrade(walletId, addressId, tradeId, broadcastTradeRequest, options?): Promise<AxiosResponse<Trade, any>>

  • Broadcast a trade

    Parameters

    • walletId: string

      The ID of the wallet the address belongs to

    • addressId: string

      The ID of the address the trade belongs to

    • tradeId: string

      The ID of the trade to broadcast

    • broadcastTradeRequest: BroadcastTradeRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Trade, any>>

    Summary

    Broadcast a trade

    Throws

    Memberof

    TradesApi

    -

createTrade

createTrade

  • createTrade(walletId, addressId, createTradeRequest, options?): Promise<AxiosResponse<Trade, any>>

  • Create a new trade

    Parameters

    • walletId: string

      The ID of the wallet the source address belongs to

    • addressId: string

      The ID of the address to conduct the trade from

    • createTradeRequest: CreateTradeRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Trade, any>>

    Summary

    Create a new trade for an address

    Throws

    Memberof

    TradesApi

    -

getTrade

getTrade

  • getTrade(walletId, addressId, tradeId, options?): Promise<AxiosResponse<Trade, any>>

  • Get a trade by ID

    Parameters

    • walletId: string

      The ID of the wallet the address belongs to

    • addressId: string

      The ID of the address the trade belongs to

    • tradeId: string

      The ID of the trade to fetch

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Trade, any>>

    Summary

    Get a trade by ID

    Throws

    Memberof

    TradesApi

    -

listTrades

listTrades

  • listTrades(walletId, addressId, limit?, page?, options?): Promise<AxiosResponse<TradeList, any>>

  • List trades for an address.

    Parameters

    • walletId: string

      The ID of the wallet the address belongs to

    • addressId: string

      The ID of the address to list trades for

    • Optional limit: number

      A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

      @@ -36,4 +36,4 @@

      Throws

      Memberof

      TradesApi

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<TradeList, any>>

    Summary

    List trades for an address.

    Throws

    Memberof

    TradesApi

    -

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationbroadcastTradecreateTradegetTradelistTrades
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationbroadcastTradecreateTradegetTradelistTrades
\ No newline at end of file diff --git a/docs/classes/client_api.TransactionHistoryApi.html b/docs/classes/client_api.TransactionHistoryApi.html index 2aad0ba2..c538ca15 100644 --- a/docs/classes/client_api.TransactionHistoryApi.html +++ b/docs/classes/client_api.TransactionHistoryApi.html @@ -1,11 +1,11 @@ TransactionHistoryApi | @coinbase/coinbase-sdk

Class TransactionHistoryApi

TransactionHistoryApi - object-oriented interface

Export

TransactionHistoryApi

-

Hierarchy (view full)

Implements

Constructors

constructor +

Hierarchy (view full)

Implements

Constructors

constructor

Properties

axios basePath configuration

Methods

listAddressTransactions -

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

listAddressTransactions

  • listAddressTransactions(networkId, addressId, limit?, page?, options?): Promise<AxiosResponse<AddressTransactionList, any>>

  • List all transactions that interact with the address.

    +

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

listAddressTransactions

  • listAddressTransactions(networkId, addressId, limit?, page?, options?): Promise<AxiosResponse<AddressTransactionList, any>>

  • List all transactions that interact with the address.

    Parameters

    • networkId: string

      The ID of the blockchain network

    • addressId: string

      The ID of the address to fetch the transactions for.

    • Optional limit: number

      A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

      @@ -13,4 +13,4 @@
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<AddressTransactionList, any>>

    Summary

    List transactions for an address.

    Throws

    Memberof

    TransactionHistoryApi

    -

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationlistAddressTransactions
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationlistAddressTransactions
\ No newline at end of file diff --git a/docs/classes/client_api.TransfersApi.html b/docs/classes/client_api.TransfersApi.html index 1c90e5db..b0b8ca4c 100644 --- a/docs/classes/client_api.TransfersApi.html +++ b/docs/classes/client_api.TransfersApi.html @@ -1,6 +1,6 @@ TransfersApi | @coinbase/coinbase-sdk

Class TransfersApi

TransfersApi - object-oriented interface

Export

TransfersApi

-

Hierarchy (view full)

Implements

Constructors

constructor +

Hierarchy (view full)

Implements

Constructors

constructor

Properties

axios basePath configuration @@ -8,27 +8,27 @@ createTransfer getTransfer listTransfers -

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

broadcastTransfer

  • broadcastTransfer(walletId, addressId, transferId, broadcastTransferRequest, options?): Promise<AxiosResponse<Transfer, any>>

  • Broadcast a transfer

    +

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

broadcastTransfer

  • broadcastTransfer(walletId, addressId, transferId, broadcastTransferRequest, options?): Promise<AxiosResponse<Transfer, any>>

  • Broadcast a transfer

    Parameters

    • walletId: string

      The ID of the wallet the address belongs to

    • addressId: string

      The ID of the address the transfer belongs to

    • transferId: string

      The ID of the transfer to broadcast

    • broadcastTransferRequest: BroadcastTransferRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Transfer, any>>

    Summary

    Broadcast a transfer

    Throws

    Memberof

    TransfersApi

    -

createTransfer

createTransfer

  • createTransfer(walletId, addressId, createTransferRequest, options?): Promise<AxiosResponse<Transfer, any>>

  • Create a new transfer

    Parameters

    • walletId: string

      The ID of the wallet the source address belongs to

    • addressId: string

      The ID of the address to transfer from

    • createTransferRequest: CreateTransferRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Transfer, any>>

    Summary

    Create a new transfer for an address

    Throws

    Memberof

    TransfersApi

    -

getTransfer

getTransfer

  • getTransfer(walletId, addressId, transferId, options?): Promise<AxiosResponse<Transfer, any>>

  • Get a transfer by ID

    Parameters

    • walletId: string

      The ID of the wallet the address belongs to

    • addressId: string

      The ID of the address the transfer belongs to

    • transferId: string

      The ID of the transfer to fetch

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Transfer, any>>

    Summary

    Get a transfer by ID

    Throws

    Memberof

    TransfersApi

    -

listTransfers

listTransfers

  • listTransfers(walletId, addressId, limit?, page?, options?): Promise<AxiosResponse<TransferList, any>>

  • List transfers for an address.

    Parameters

    • walletId: string

      The ID of the wallet the address belongs to

    • addressId: string

      The ID of the address to list transfers for

    • Optional limit: number

      A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

      @@ -36,4 +36,4 @@

      Throws

      Memberof

      TransfersApi

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<TransferList, any>>

    Summary

    List transfers for an address.

    Throws

    Memberof

    TransfersApi

    -

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationbroadcastTransfercreateTransfergetTransferlistTransfers
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationbroadcastTransfercreateTransfergetTransferlistTransfers
\ No newline at end of file diff --git a/docs/classes/client_api.UsersApi.html b/docs/classes/client_api.UsersApi.html index 8b07eff7..d1abfcd6 100644 --- a/docs/classes/client_api.UsersApi.html +++ b/docs/classes/client_api.UsersApi.html @@ -1,12 +1,12 @@ UsersApi | @coinbase/coinbase-sdk

Class UsersApi

UsersApi - object-oriented interface

Export

UsersApi

-

Hierarchy (view full)

Implements

Constructors

constructor +

Hierarchy (view full)

Implements

Constructors

constructor

Properties

axios basePath configuration

Methods

getCurrentUser -

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

getCurrentUser

  • getCurrentUser(options?): Promise<AxiosResponse<User, any>>

  • Get current user

    +

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

getCurrentUser

  • getCurrentUser(options?): Promise<AxiosResponse<User, any>>

  • Get current user

    Parameters

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<User, any>>

    Summary

    Get current user

    Throws

    Memberof

    UsersApi

    -

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationgetCurrentUser
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationgetCurrentUser
\ No newline at end of file diff --git a/docs/classes/client_api.ValidatorsApi.html b/docs/classes/client_api.ValidatorsApi.html index e49234fd..acd3aca5 100644 --- a/docs/classes/client_api.ValidatorsApi.html +++ b/docs/classes/client_api.ValidatorsApi.html @@ -1,19 +1,19 @@ ValidatorsApi | @coinbase/coinbase-sdk

Class ValidatorsApi

ValidatorsApi - object-oriented interface

Export

ValidatorsApi

-

Hierarchy (view full)

Implements

Constructors

constructor +

Hierarchy (view full)

Implements

Constructors

constructor

Properties

axios basePath configuration

Methods

getValidator listValidators -

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

getValidator

  • getValidator(networkId, assetId, validatorId, options?): Promise<AxiosResponse<Validator, any>>

  • Get a validator belonging to the user for a given network, asset and id.

    +

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

getValidator

  • getValidator(networkId, assetId, validatorId, options?): Promise<AxiosResponse<Validator, any>>

  • Get a validator belonging to the user for a given network, asset and id.

    Parameters

    • networkId: string

      The ID of the blockchain network.

    • assetId: string

      The symbol of the asset to get the validator for.

    • validatorId: string

      The unique id of the validator to fetch details for.

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Validator, any>>

    Summary

    Get a validator belonging to the CDP project

    Throws

    Memberof

    ValidatorsApi

    -

listValidators

listValidators

  • listValidators(networkId, assetId, status?, limit?, page?, options?): Promise<AxiosResponse<ValidatorList, any>>

  • List validators belonging to the user for a given network and asset.

    Parameters

    • networkId: string

      The ID of the blockchain network.

    • assetId: string

      The symbol of the asset to get the validators for.

    • Optional status: ValidatorStatus

      A filter to list validators based on a status.

      @@ -22,4 +22,4 @@

      Throws

      Memberof

      ValidatorsApi

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<ValidatorList, any>>

    Summary

    List validators belonging to the CDP project

    Throws

    Memberof

    ValidatorsApi

    -

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationgetValidatorlistValidators
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationgetValidatorlistValidators
\ No newline at end of file diff --git a/docs/classes/client_api.WalletStakeApi.html b/docs/classes/client_api.WalletStakeApi.html index 77926671..eb12d688 100644 --- a/docs/classes/client_api.WalletStakeApi.html +++ b/docs/classes/client_api.WalletStakeApi.html @@ -1,30 +1,30 @@ WalletStakeApi | @coinbase/coinbase-sdk

Class WalletStakeApi

WalletStakeApi - object-oriented interface

Export

WalletStakeApi

-

Hierarchy (view full)

Implements

Constructors

constructor +

Hierarchy (view full)

Implements

Constructors

constructor

Properties

axios basePath configuration

Methods

broadcastStakingOperation createStakingOperation getStakingOperation -

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

broadcastStakingOperation

  • broadcastStakingOperation(walletId, addressId, stakingOperationId, broadcastStakingOperationRequest, options?): Promise<AxiosResponse<StakingOperation, any>>

  • Broadcast a staking operation.

    +

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

broadcastStakingOperation

  • broadcastStakingOperation(walletId, addressId, stakingOperationId, broadcastStakingOperationRequest, options?): Promise<AxiosResponse<StakingOperation, any>>

  • Broadcast a staking operation.

    Parameters

    • walletId: string

      The ID of the wallet the address belongs to.

    • addressId: string

      The ID of the address the staking operation belongs to.

    • stakingOperationId: string

      The ID of the staking operation to broadcast.

    • broadcastStakingOperationRequest: BroadcastStakingOperationRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<StakingOperation, any>>

    Summary

    Broadcast a staking operation

    Throws

    Memberof

    WalletStakeApi

    -

createStakingOperation

createStakingOperation

  • createStakingOperation(walletId, addressId, createStakingOperationRequest, options?): Promise<AxiosResponse<StakingOperation, any>>

  • Create a new staking operation.

    Parameters

    • walletId: string

      The ID of the wallet the address belongs to.

    • addressId: string

      The ID of the address to create the staking operation for.

    • createStakingOperationRequest: CreateStakingOperationRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<StakingOperation, any>>

    Summary

    Create a new staking operation for an address

    Throws

    Memberof

    WalletStakeApi

    -

getStakingOperation

getStakingOperation

  • getStakingOperation(walletId, addressId, stakingOperationId, options?): Promise<AxiosResponse<StakingOperation, any>>

  • Get the latest state of a staking operation.

    Parameters

    • walletId: string

      The ID of the wallet the address belongs to

    • addressId: string

      The ID of the address to fetch the staking operation for.

    • stakingOperationId: string

      The ID of the staking operation.

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<StakingOperation, any>>

    Summary

    Get the latest state of a staking operation

    Throws

    Memberof

    WalletStakeApi

    -

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationbroadcastStakingOperationcreateStakingOperationgetStakingOperation
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationbroadcastStakingOperationcreateStakingOperationgetStakingOperation
\ No newline at end of file diff --git a/docs/classes/client_api.WalletsApi.html b/docs/classes/client_api.WalletsApi.html index a598ab9c..274a5856 100644 --- a/docs/classes/client_api.WalletsApi.html +++ b/docs/classes/client_api.WalletsApi.html @@ -1,6 +1,6 @@ WalletsApi | @coinbase/coinbase-sdk

Class WalletsApi

WalletsApi - object-oriented interface

Export

WalletsApi

-

Hierarchy (view full)

Implements

Constructors

constructor +

Hierarchy (view full)

Implements

Constructors

constructor

Properties

axios basePath configuration @@ -9,30 +9,30 @@ getWalletBalance listWalletBalances listWallets -

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

createWallet

  • createWallet(createWalletRequest?, options?): Promise<AxiosResponse<Wallet, any>>

  • Create a new wallet scoped to the user.

    +

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

createWallet

  • createWallet(createWalletRequest?, options?): Promise<AxiosResponse<Wallet, any>>

  • Create a new wallet scoped to the user.

    Parameters

    • Optional createWalletRequest: CreateWalletRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Wallet, any>>

    Summary

    Create a new wallet

    Throws

    Memberof

    WalletsApi

    -

getWallet

getWallet

  • getWallet(walletId, options?): Promise<AxiosResponse<Wallet, any>>

  • Get wallet

    Parameters

    • walletId: string

      The ID of the wallet to fetch

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Wallet, any>>

    Summary

    Get wallet by ID

    Throws

    Memberof

    WalletsApi

    -

getWalletBalance

getWalletBalance

  • getWalletBalance(walletId, assetId, options?): Promise<AxiosResponse<Balance, any>>

  • Get the aggregated balance of an asset across all of the addresses in the wallet.

    Parameters

    • walletId: string

      The ID of the wallet to fetch the balance for

    • assetId: string

      The symbol of the asset to fetch the balance for

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Balance, any>>

    Summary

    Get the balance of an asset in the wallet

    Throws

    Memberof

    WalletsApi

    -

listWalletBalances

listWalletBalances

  • listWalletBalances(walletId, options?): Promise<AxiosResponse<AddressBalanceList, any>>

  • List the balances of all of the addresses in the wallet aggregated by asset.

    Parameters

    • walletId: string

      The ID of the wallet to fetch the balances for

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<AddressBalanceList, any>>

    Summary

    List wallet balances

    Throws

    Memberof

    WalletsApi

    -

listWallets

listWallets

  • listWallets(limit?, page?, options?): Promise<AxiosResponse<WalletList, any>>

  • List wallets belonging to the user.

    Parameters

    • Optional limit: number

      A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

    • Optional page: string

      A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<WalletList, any>>

    Summary

    List wallets

    Throws

    Memberof

    WalletsApi

    -

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationcreateWalletgetWalletgetWalletBalancelistWalletBalanceslistWallets
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationcreateWalletgetWalletgetWalletBalancelistWalletBalanceslistWallets
\ No newline at end of file diff --git a/docs/classes/client_api.WebhooksApi.html b/docs/classes/client_api.WebhooksApi.html index 76942c7a..d7428a30 100644 --- a/docs/classes/client_api.WebhooksApi.html +++ b/docs/classes/client_api.WebhooksApi.html @@ -1,6 +1,6 @@ WebhooksApi | @coinbase/coinbase-sdk

Class WebhooksApi

WebhooksApi - object-oriented interface

Export

WebhooksApi

-

Hierarchy (view full)

Implements

Constructors

constructor +

Hierarchy (view full)

Implements

Constructors

constructor

Properties

axios basePath configuration @@ -9,29 +9,29 @@ deleteWebhook listWebhooks updateWebhook -

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

createWalletWebhook

  • createWalletWebhook(walletId, createWalletWebhookRequest?, options?): Promise<AxiosResponse<Webhook, any>>

  • Create a new webhook scoped to a wallet

    +

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

createWalletWebhook

  • createWalletWebhook(walletId, createWalletWebhookRequest?, options?): Promise<AxiosResponse<Webhook, any>>

  • Create a new webhook scoped to a wallet

    Parameters

    • walletId: string

      The ID of the wallet to create the webhook for.

    • Optional createWalletWebhookRequest: CreateWalletWebhookRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Webhook, any>>

    Summary

    Create a new webhook scoped to a wallet

    Throws

    Memberof

    WebhooksApi

    -

createWebhook

createWebhook

deleteWebhook

deleteWebhook

  • deleteWebhook(webhookId, options?): Promise<AxiosResponse<void, any>>

  • Delete a webhook

    Parameters

    • webhookId: string

      The Webhook uuid that needs to be deleted

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<void, any>>

    Summary

    Delete a webhook

    Throws

    Memberof

    WebhooksApi

    -

listWebhooks

listWebhooks

  • listWebhooks(limit?, page?, options?): Promise<AxiosResponse<WebhookList, any>>

  • List webhooks, optionally filtered by event type.

    Parameters

    • Optional limit: number

      A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

    • Optional page: string

      A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<WebhookList, any>>

    Summary

    List webhooks

    Throws

    Memberof

    WebhooksApi

    -

updateWebhook

updateWebhook

  • updateWebhook(webhookId, updateWebhookRequest?, options?): Promise<AxiosResponse<Webhook, any>>

  • Update a webhook

    Parameters

    • webhookId: string

      The Webhook id that needs to be updated

    • Optional updateWebhookRequest: UpdateWebhookRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Webhook, any>>

    Summary

    Update a webhook

    Throws

    Memberof

    WebhooksApi

    -

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationcreateWalletWebhookcreateWebhookdeleteWebhooklistWebhooksupdateWebhook
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationcreateWalletWebhookcreateWebhookdeleteWebhooklistWebhooksupdateWebhook
\ No newline at end of file diff --git a/docs/classes/client_base.BaseAPI.html b/docs/classes/client_base.BaseAPI.html index 467dfeb4..ace21efa 100644 --- a/docs/classes/client_base.BaseAPI.html +++ b/docs/classes/client_base.BaseAPI.html @@ -1,6 +1,6 @@ BaseAPI | @coinbase/coinbase-sdk

Class BaseAPI

Export

BaseAPI

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

axios basePath configuration -

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfiguration
\ No newline at end of file +

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfiguration
\ No newline at end of file diff --git a/docs/classes/client_base.RequiredError.html b/docs/classes/client_base.RequiredError.html index 1ea360b6..955baa5c 100644 --- a/docs/classes/client_base.RequiredError.html +++ b/docs/classes/client_base.RequiredError.html @@ -1,5 +1,5 @@ RequiredError | @coinbase/coinbase-sdk

Class RequiredError

Export

RequiredError

-

Hierarchy

  • Error
    • RequiredError

Constructors

constructor +

Hierarchy

  • Error
    • RequiredError

Constructors

constructor

Properties

cause? field message @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

field

field: string

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

field

field: string

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausefieldmessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/docs/classes/client_configuration.Configuration.html b/docs/classes/client_configuration.Configuration.html index b6315196..c5ad7f97 100644 --- a/docs/classes/client_configuration.Configuration.html +++ b/docs/classes/client_configuration.Configuration.html @@ -1,4 +1,4 @@ -Configuration | @coinbase/coinbase-sdk

Class Configuration

Constructors

constructor +Configuration | @coinbase/coinbase-sdk

Class Configuration

Constructors

constructor

Properties

accessToken? apiKey? baseOptions? @@ -8,27 +8,27 @@ serverIndex? username?

Methods

isJsonMime -

Constructors

constructor

Properties

Optional accessToken

accessToken?: string | Promise<string> | ((name?, scopes?) => string) | ((name?, scopes?) => Promise<string>)

parameter for oauth2 security

+

Constructors

constructor

Properties

Optional accessToken

accessToken?: string | Promise<string> | ((name?, scopes?) => string) | ((name?, scopes?) => Promise<string>)

parameter for oauth2 security

Type declaration

    • (name?, scopes?): string

    • Parameters

      • Optional name: string
      • Optional scopes: string[]

      Returns string

Type declaration

    • (name?, scopes?): Promise<string>

    • Parameters

      • Optional name: string
      • Optional scopes: string[]

      Returns Promise<string>

Param: name

security name

Param: scopes

oauth2 scope

Memberof

Configuration

-

Optional apiKey

apiKey?: string | Promise<string> | ((name) => string) | ((name) => Promise<string>)

parameter for apiKey security

+

Optional apiKey

apiKey?: string | Promise<string> | ((name) => string) | ((name) => Promise<string>)

parameter for apiKey security

Type declaration

    • (name): string

    • Parameters

      • name: string

      Returns string

Type declaration

    • (name): Promise<string>

    • Parameters

      • name: string

      Returns Promise<string>

Param: name

security name

Memberof

Configuration

-

Optional baseOptions

baseOptions?: any

base options for axios calls

+

Optional baseOptions

baseOptions?: any

base options for axios calls

Memberof

Configuration

-

Optional basePath

basePath?: string

override base path

+

Optional basePath

basePath?: string

override base path

Memberof

Configuration

-

Optional formDataCtor

formDataCtor?: (new () => any)

The FormData constructor that will be used to create multipart form data +

Optional formDataCtor

formDataCtor?: (new () => any)

The FormData constructor that will be used to create multipart form data requests. You can inject this here so that execution environments that do not support the FormData class can still run the generated client.

-

Type declaration

    • new (): any

    • Returns any

Optional password

password?: string

parameter for basic security

+

Type declaration

    • new (): any

    • Returns any

Optional password

password?: string

parameter for basic security

Memberof

Configuration

-

Optional serverIndex

serverIndex?: number

override server index

+

Optional serverIndex

serverIndex?: number

override server index

Memberof

Configuration

-

Optional username

username?: string

parameter for basic security

+

Optional username

username?: string

parameter for basic security

Memberof

Configuration

-

Methods

isJsonMime

Methods

isJsonMime

  • isJsonMime(mime): boolean

  • Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 @@ -36,4 +36,4 @@

    Memberof

    Configuration

    application/vnd.company+json

    Parameters

    • mime: string

      MIME (Multipurpose Internet Mail Extensions)

    Returns boolean

    True if the given MIME is JSON, false otherwise.

    -

Settings

Member Visibility

Theme

On This Page

constructoraccessTokenapiKeybaseOptionsbasePathformDataCtorpasswordserverIndexusernameisJsonMime
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraccessTokenapiKeybaseOptionsbasePathformDataCtorpasswordserverIndexusernameisJsonMime
\ No newline at end of file diff --git a/docs/classes/coinbase_address.Address.html b/docs/classes/coinbase_address.Address.html index fdb53cd1..4a56d94a 100644 --- a/docs/classes/coinbase_address.Address.html +++ b/docs/classes/coinbase_address.Address.html @@ -1,5 +1,5 @@ Address | @coinbase/coinbase-sdk

Class Address

A representation of a blockchain address, which is a user-controlled account on a network.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

id networkId MAX_HISTORICAL_BALANCE @@ -24,60 +24,60 @@

Constructors

constructor

  • new Address(networkId, id): Address

  • Initializes a new Address instance.

    Parameters

    • networkId: string

      The network id.

    • id: string

      The onchain address id.

      -

    Returns Address

Properties

Protected id

id: string

Protected networkId

networkId: string

Static Private MAX_HISTORICAL_BALANCE

MAX_HISTORICAL_BALANCE: number = 1000

Methods

claimableBalance

  • claimableBalance(asset_id, mode?, options?): Promise<Decimal>

  • Get the claimable balance for the supplied asset.

    +

Returns Address

Properties

Protected id

id: string

Protected networkId

networkId: string

Static Private MAX_HISTORICAL_BALANCE

MAX_HISTORICAL_BALANCE: number = 1000

Methods

claimableBalance

  • claimableBalance(asset_id, mode?, options?): Promise<Decimal>

  • Get the claimable balance for the supplied asset.

    Parameters

    • asset_id: string

      The asset to check claimable balance for.

    • mode: StakeOptionsMode = StakeOptionsMode.DEFAULT

      The staking mode. Defaults to DEFAULT.

    • options: {
          [key: string]: string;
      } = {}

      Additional options for getting the claimable balance.

      • [key: string]: string

    Returns Promise<Decimal>

    The claimable balance.

    -

Private copyOptions

  • copyOptions(options?): {
        [key: string]: string;
    }
  • Private

    Create a shallow copy of given options.

    +

Private copyOptions

  • copyOptions(options?): {
        [key: string]: string;
    }
  • Private

    Create a shallow copy of given options.

    Parameters

    • Optional options: {
          [key: string]: string;
      }

      The supplied options to be copied

      • [key: string]: string

    Returns {
        [key: string]: string;
    }

    A copy of the options.

    -
    • [key: string]: string

faucet

faucet

  • faucet(assetId?): Promise<FaucetTransaction>

  • Requests faucet funds for the address. Only supported on testnet networks.

    Parameters

    • Optional assetId: string

      The ID of the asset to transfer from the faucet.

    Returns Promise<FaucetTransaction>

    The faucet transaction object.

    Throws

    If the request does not return a transaction hash.

    Throws

    If the request fails.

    -

getBalance

getBalance

  • getBalance(assetId): Promise<Decimal>

  • Returns the balance of the provided asset.

    Parameters

    • assetId: string

      The asset ID.

    Returns Promise<Decimal>

    The balance of the asset.

    -

getId

getId

getNetworkId

getNetworkId

Private getStakingBalances

  • getStakingBalances(assetId, mode?, options?): Promise<{
        [key: string]: Decimal;
    }>
  • Private

    Get the different staking balance types for the supplied asset.

    +

Private getStakingBalances

  • getStakingBalances(assetId, mode?, options?): Promise<{
        [key: string]: Decimal;
    }>
  • Private

    Get the different staking balance types for the supplied asset.

    Parameters

    • assetId: string

      The asset to lookup balances for.

    • Optional mode: StakeOptionsMode

      The staking mode. Defaults to DEFAULT.

    • Optional options: {
          [key: string]: string;
      }

      Additional options for the balance lookup.

      • [key: string]: string

    Returns Promise<{
        [key: string]: Decimal;
    }>

    The different balance types.

    -

historicalStakingBalances

historicalStakingBalances

  • historicalStakingBalances(assetId, startTime?, endTime?): Promise<StakingBalance[]>

  • Lists the historical staking balances for the address.

    Parameters

    • assetId: string

      The asset ID.

    • startTime: string = ...

      The start time.

    • endTime: string = ...

      The end time.

    Returns Promise<StakingBalance[]>

    The staking balances.

    -

listBalances

listBalances

listHistoricalBalances

listHistoricalBalances

listTransactions

listTransactions

stakeableBalance

  • stakeableBalance(asset_id, mode?, options?): Promise<Decimal>

  • Get the stakeable balance for the supplied asset.

    +

stakeableBalance

  • stakeableBalance(asset_id, mode?, options?): Promise<Decimal>

  • Get the stakeable balance for the supplied asset.

    Parameters

    • asset_id: string

      The asset to check the stakeable balance for.

    • mode: StakeOptionsMode = StakeOptionsMode.DEFAULT

      The staking mode. Defaults to DEFAULT.

    • options: {
          [key: string]: string;
      } = {}

      Additional options for getting the stakeable balance.

      • [key: string]: string

    Returns Promise<Decimal>

    The stakeable balance.

    -

stakingRewards

stakingRewards

  • stakingRewards(assetId, startTime?, endTime?, format?): Promise<StakingReward[]>

  • Lists the staking rewards for the address.

    Parameters

    • assetId: string

      The asset ID.

    • startTime: string = ...

      The start time.

    • endTime: string = ...

      The end time.

    • format: StakingRewardFormat = StakingRewardFormat.USD

      The format to return the rewards in. (usd, native). Defaults to usd.

    Returns Promise<StakingReward[]>

    The staking rewards.

    -

toString

toString

  • toString(): string

  • Returns a string representation of the address.

    Returns string

    A string representing the address.

    -

unstakeableBalance

  • unstakeableBalance(asset_id, mode?, options?): Promise<Decimal>

  • Get the unstakeable balance for the supplied asset.

    +

unstakeableBalance

  • unstakeableBalance(asset_id, mode?, options?): Promise<Decimal>

  • Get the unstakeable balance for the supplied asset.

    Parameters

    • asset_id: string

      The asset to check the unstakeable balance for.

    • mode: StakeOptionsMode = StakeOptionsMode.DEFAULT

      The staking mode. Defaults to DEFAULT.

    • options: {
          [key: string]: string;
      } = {}

      Additional options for getting the unstakeable balance. @@ -86,22 +86,22 @@

      Throws

      If the request fails.

    • validator_pub_keys (optional): List of comma separated validator public keys to retrieve unstakeable balance for. Defaults to all validators.
    • [key: string]: string

Returns Promise<Decimal>

The unstakeable balance.

-

Private validateCanClaimStake

  • validateCanClaimStake(amount, assetId, mode, options): Promise<void>
  • Private

    Validate if the operation is able to claim stake with the supplied input.

    +

Private validateCanClaimStake

  • validateCanClaimStake(amount, assetId, mode, options): Promise<void>
  • Private

    Validate if the operation is able to claim stake with the supplied input.

    Parameters

    • amount: Amount

      The amount of the asset to claim stake.

    • assetId: string

      The asset to claim stake.

    • mode: StakeOptionsMode

      The staking mode. Defaults to DEFAULT.

    • options: {
          [key: string]: string;
      }

      Additional options for the claim stake operation.

      • [key: string]: string

    Returns Promise<void>

    Throws

    If the supplied input is not able to create a claim stake operation.

    -

Private validateCanStake

  • validateCanStake(amount, assetId, mode, options): Promise<void>
  • Private

    Validate if the operation is able to stake with the supplied input.

    +

Private validateCanStake

  • validateCanStake(amount, assetId, mode, options): Promise<void>
  • Private

    Validate if the operation is able to stake with the supplied input.

    Parameters

    • amount: Amount

      The amount of the asset to stake.

    • assetId: string

      The asset to stake.

    • mode: StakeOptionsMode

      The staking mode. Defaults to DEFAULT.

    • options: {
          [key: string]: string;
      }

      Additional options for the stake operation.

      • [key: string]: string

    Returns Promise<void>

    Throws

    If the supplied input is not able to create a stake operation.

    -

Private validateCanUnstake

  • validateCanUnstake(amount, assetId, mode, options): Promise<void>
  • Private

    Validate if the operation is able to unstake with the supplied input.

    +

Private validateCanUnstake

  • validateCanUnstake(amount, assetId, mode, options): Promise<void>
  • Private

    Validate if the operation is able to unstake with the supplied input.

    Parameters

    • amount: Amount

      The amount of the asset to unstake.

    • assetId: string

      The asset to unstake.

    • mode: StakeOptionsMode

      The staking mode. Defaults to DEFAULT.

    • options: {
          [key: string]: string;
      }

      Additional options for the unstake operation.

      • [key: string]: string

    Returns Promise<void>

    Throws

    If the supplied input is not able to create an unstake operation.

    -

Settings

Member Visibility

Theme

On This Page

constructoridnetworkIdMAX_HISTORICAL_BALANCEclaimableBalancecopyOptionsfaucetgetBalancegetIdgetNetworkIdgetStakingBalanceshistoricalStakingBalanceslistBalanceslistHistoricalBalanceslistTransactionsstakeableBalancestakingRewardstoStringunstakeableBalancevalidateCanClaimStakevalidateCanStakevalidateCanUnstake
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoridnetworkIdMAX_HISTORICAL_BALANCEclaimableBalancecopyOptionsfaucetgetBalancegetIdgetNetworkIdgetStakingBalanceshistoricalStakingBalanceslistBalanceslistHistoricalBalanceslistTransactionsstakeableBalancestakingRewardstoStringunstakeableBalancevalidateCanClaimStakevalidateCanStakevalidateCanUnstake
\ No newline at end of file diff --git a/docs/classes/coinbase_address_external_address.ExternalAddress.html b/docs/classes/coinbase_address_external_address.ExternalAddress.html index 6ee4b8f1..1f59a963 100644 --- a/docs/classes/coinbase_address_external_address.ExternalAddress.html +++ b/docs/classes/coinbase_address_external_address.ExternalAddress.html @@ -1,7 +1,7 @@ ExternalAddress | @coinbase/coinbase-sdk

Class ExternalAddress

A representation of a blockchain Address, which is a user-controlled account on a Network. Addresses are used to send and receive Assets. An ExternalAddress is an Address that is not controlled by the developer, but is instead controlled by the user.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

id networkId

Methods

buildClaimStakeOperation @@ -28,7 +28,7 @@

Constructors

constructor

Properties

Protected id

id: string

Protected networkId

networkId: string

Methods

buildClaimStakeOperation

  • buildClaimStakeOperation(amount, assetId, mode?, options?): Promise<StakingOperation>

  • Builds a claim stake operation for the supplied asset.

    +

Returns ExternalAddress

Properties

Protected id

id: string

Protected networkId

networkId: string

Methods

buildClaimStakeOperation

  • buildClaimStakeOperation(amount, assetId, mode?, options?): Promise<StakingOperation>

  • Builds a claim stake operation for the supplied asset.

    Parameters

    • amount: Amount

      The amount of the asset to claim stake.

    • assetId: string

      The asset to claim stake.

    • mode: StakeOptionsMode = StakeOptionsMode.DEFAULT

      The staking mode. Defaults to DEFAULT.

      @@ -38,7 +38,7 @@
    • integrator_contract_address (optional): The contract address to which the claim stake operation is directed to. Defaults to the integrator contract address associated with CDP account (if available) or else defaults to a shared integrator contract address for that network.
    • [key: string]: string

Returns Promise<StakingOperation>

The claim stake operation.

-

buildStakeOperation

buildStakeOperation

  • buildStakeOperation(amount, assetId, mode?, options?): Promise<StakingOperation>

  • Builds a stake operation for the supplied asset. The stake operation may take a few minutes to complete in the case when infrastructure is spun up.

    Parameters

    • amount: Amount

      The amount of the asset to stake.

    • assetId: string

      The asset to stake.

      @@ -55,7 +55,7 @@
    • fee_recipient_address (optional): Ethereum address for receiving transaction fees. Defaults to the address initiating the stake operation.
    • [key: string]: string

Returns Promise<StakingOperation>

The stake operation.

-

Private buildStakingOperation

Private buildStakingOperation

buildUnstakeOperation

buildUnstakeOperation

Returns Promise<StakingOperation>

The unstake operation.

-

claimableBalance

claimableBalance

Private copyOptions

Private copyOptions

faucet

faucet

getBalance

getBalance

getId

getId

getNetworkId

getNetworkId

historicalStakingBalances

historicalStakingBalances

listBalances

listBalances

listHistoricalBalances

listHistoricalBalances

listTransactions

listTransactions

stakeableBalance

stakeableBalance

stakingRewards

stakingRewards

toString

toString

unstakeableBalance

unstakeableBalance

Returns Promise<Decimal>

The unstakeable balance.

-

Private validateCanClaimStake

Private validateCanClaimStake

Private validateCanStake

Private validateCanStake

Private validateCanUnstake

Private validateCanUnstake

Settings

Member Visibility

Theme

On This Page

constructoridnetworkIdbuildClaimStakeOperationbuildStakeOperationbuildStakingOperationbuildUnstakeOperationclaimableBalancecopyOptionsfaucetgetBalancegetIdgetNetworkIdhistoricalStakingBalanceslistBalanceslistHistoricalBalanceslistTransactionsstakeableBalancestakingRewardstoStringunstakeableBalancevalidateCanClaimStakevalidateCanStakevalidateCanUnstake
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoridnetworkIdbuildClaimStakeOperationbuildStakeOperationbuildStakingOperationbuildUnstakeOperationclaimableBalancecopyOptionsfaucetgetBalancegetIdgetNetworkIdhistoricalStakingBalanceslistBalanceslistHistoricalBalanceslistTransactionsstakeableBalancestakingRewardstoStringunstakeableBalancevalidateCanClaimStakevalidateCanStakevalidateCanUnstake
\ No newline at end of file diff --git a/docs/classes/coinbase_address_wallet_address.WalletAddress.html b/docs/classes/coinbase_address_wallet_address.WalletAddress.html index a1ccbfeb..8c8677cd 100644 --- a/docs/classes/coinbase_address_wallet_address.WalletAddress.html +++ b/docs/classes/coinbase_address_wallet_address.WalletAddress.html @@ -1,5 +1,5 @@ WalletAddress | @coinbase/coinbase-sdk

Class WalletAddress

A representation of a blockchain address, which is a wallet-controlled account on a network.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

id key? model @@ -54,22 +54,22 @@

Parameters

  • model: Address

    The address model data.

  • Optional key: Wallet

    The ethers.js SigningKey the Address uses to sign data.

Returns WalletAddress

Throws

If the address model is empty.

-

Properties

Protected id

id: string

Private Optional key

key?: Wallet

Private model

model: Address

Protected networkId

networkId: string

Methods

Private broadcastStakingOperationRequest

Properties

Protected id

id: string

Private Optional key

key?: Wallet

Private model

model: Address

Protected networkId

networkId: string

Methods

Private broadcastStakingOperationRequest

  • broadcastStakingOperationRequest(stakingOperationID, signedPayload, transactionIndex): Promise<StakingOperation>
  • Private

    A helper function that broadcasts the signed payload.

    Parameters

    • stakingOperationID: string

      The staking operation id related to the signed payload.

    • signedPayload: string

      The payload that's being broadcasted.

    • transactionIndex: number

      The index of the transaction in the array from the staking operation.

    Returns Promise<StakingOperation>

    An updated staking operation with the broadcasted transaction.

    -

canSign

canSign

  • canSign(): boolean

  • Returns whether the Address has a private key backing it to sign transactions.

    Returns boolean

    Whether the Address has a private key backing it to sign transactions.

    -

claimableBalance

claimableBalance

  • claimableBalance(asset_id, mode?, options?): Promise<Decimal>

  • Get the claimable balance for the supplied asset.

    Parameters

    • asset_id: string

      The asset to check claimable balance for.

    • mode: StakeOptionsMode = StakeOptionsMode.DEFAULT

      The staking mode. Defaults to DEFAULT.

    • options: {
          [key: string]: string;
      } = {}

      Additional options for getting the claimable balance.

      • [key: string]: string

    Returns Promise<Decimal>

    The claimable balance.

    -

Private copyOptions

Private copyOptions

  • copyOptions(options?): {
        [key: string]: string;
    }
  • Private

    Create a shallow copy of given options.

    Parameters

    • Optional options: {
          [key: string]: string;
      }

      The supplied options to be copied

      • [key: string]: string

    Returns {
        [key: string]: string;
    }

    A copy of the options.

    -
    • [key: string]: string

createClaimStake

createClaimStake

  • createClaimStake(amount, assetId, mode?, options?, timeoutSeconds?, intervalSeconds?): Promise<StakingOperation>

  • Creates a staking operation to claim stake.

    Parameters

    • amount: Amount

      The amount to claim stake.

    • assetId: string

      The asset to claim stake.

    • mode: StakeOptionsMode = StakeOptionsMode.DEFAULT

      The staking mode. Defaults to DEFAULT.

      @@ -81,7 +81,7 @@
      • [key: string]: string
    • timeoutSeconds: number = 600

      The amount to wait for the transaction to complete when broadcasted.

    • intervalSeconds: number = 0.2

      The amount to check each time for a successful broadcast.

    Returns Promise<StakingOperation>

    The staking operation after it's completed successfully.

    -

Private createContractInvocation

Private createContractInvocation

  • createContractInvocation(contractAddress, method, abi, args, atomicAmount?): Promise<ContractInvocation>

  • Creates a contract invocation with the given data.

    Parameters

    • contractAddress: string

      The address of the contract the method will be invoked on.

    • method: string

      The method to invoke on the contract.

    • abi: object

      The ABI of the contract.

      @@ -90,24 +90,24 @@
    • Optional atomicAmount: string

      The atomic amount of the native asset to send to a payable contract method.

    Returns Promise<ContractInvocation>

    The ContractInvocation object.

    Throws

    if the API request to create a contract invocation fails.

    -

Private createERC1155

Private createERC1155

Private createERC20

Private createERC20

Private createERC721

Private createERC721

createPayloadSignature

createPayloadSignature

  • createPayloadSignature(unsignedPayload): Promise<PayloadSignature>

  • Creates a Payload Signature.

    Parameters

    • unsignedPayload: string

      The Unsigned Payload to sign.

    Returns Promise<PayloadSignature>

    A promise that resolves to the Payload Signature object.

    Throws

    if the API request to create a Payload Signature fails.

    Throws

    if the address does not have a private key loaded or an associated Server-Signer.

    -

createStake

createStake

  • createStake(amount, assetId, mode?, options?, timeoutSeconds?, intervalSeconds?): Promise<StakingOperation>

  • Creates a staking operation to stake.

    Parameters

    • amount: Amount

      The amount to stake.

    • assetId: string

      The asset to stake.

    • mode: StakeOptionsMode = StakeOptionsMode.DEFAULT

      The staking mode. Defaults to DEFAULT.

      @@ -125,7 +125,7 @@

      Throws

      if the address does not have a private key loaded or an associ

      • [key: string]: string
    • timeoutSeconds: number = 600

      The amount to wait for the transaction to complete when broadcasted.

    • intervalSeconds: number = 0.2

      The amount to check each time for a successful broadcast.

    Returns Promise<StakingOperation>

    The staking operation after it's completed successfully.

    -

Private createStakingOperation

Private createStakingOperation

  • createStakingOperation(amount, assetId, action, mode, options, timeoutSeconds, intervalSeconds): Promise<StakingOperation>

  • Creates a staking operation to stake, signs it, and broadcasts it on the blockchain.

    Parameters

    • amount: Amount

      The amount for the staking operation.

    • assetId: string

      The asset to the staking operation.

    • action: string

      The type of staking action to perform.

      @@ -136,7 +136,7 @@

      Throws

      if the address does not have a private key loaded or an associ

    Returns Promise<StakingOperation>

    The staking operation after it's completed fully.

    Throws

    if the API request to create or broadcast staking operation fails.

    Throws

    if the amount is less than zero.

    -

Private createStakingOperationRequest

Private createStakingOperationRequest

  • createStakingOperationRequest(amount, assetId, action, mode?, options?): Promise<StakingOperation>
  • Private

    A helper function that creates the staking operation.

    Parameters

    • amount: Amount

      The amount for the staking operation.

    • assetId: string

      The asset for the staking operation.

    • action: string

      The type of staking action to perform.

      @@ -144,17 +144,17 @@

      Throws

      if the amount is less than zero.

    • options: {
          [key: string]: string;
      } = {}

      Additional options such as setting the mode for the staking action.

      • [key: string]: string

    Returns Promise<StakingOperation>

    The created staking operation.

    Throws

    if the API request to create staking operation fails.

    -

createTrade

createTrade

  • createTrade(options): Promise<Trade>

  • Trades the given amount of the given Asset for another Asset. Only same-network Trades are supported.

    Parameters

    Returns Promise<Trade>

    The Trade object.

    Throws

    if the API request to create or broadcast a Trade fails.

    Throws

    if the Trade times out.

    -

Private createTradeRequest

Private createTradeRequest

  • createTradeRequest(amount, fromAsset, toAsset): Promise<Trade>

  • Creates a trade model for the specified amount and assets.

    Parameters

    • amount: Amount

      The amount of the Asset to send.

    • fromAsset: Asset

      The Asset to trade from.

    • toAsset: Asset

      The Asset to trade to.

    Returns Promise<Trade>

    A promise that resolves to a Trade object representing the new trade.

    -

createTransfer

createTransfer

  • createTransfer(options): Promise<Transfer>

  • Transfers the given amount of the given Asset to the given address. Only same-Network Transfers are supported. This returns a Transfer object that has been signed and broadcasted, you can wait for this to land on-chain (or fail) by calling transfer.wait().

    @@ -162,7 +162,7 @@

    Throws

    if the Trade times out.

Returns Promise<Transfer>

The transfer object.

Throws

if the API request to create a Transfer fails.

Throws

if the API request to broadcast a Transfer fails.

-

createUnstake

createUnstake

  • createUnstake(amount, assetId, mode?, options?, timeoutSeconds?, intervalSeconds?): Promise<StakingOperation>

  • Creates a staking operation to unstake.

    Parameters

    • amount: Amount

      The amount to unstake.

    • assetId: string

      The asset to unstake.

    • mode: StakeOptionsMode = StakeOptionsMode.DEFAULT

      The staking mode. Defaults to DEFAULT.

      @@ -179,92 +179,92 @@

      Throws

      if the API request to broadcast a Transfer fails.

      • [key: string]: string
    • timeoutSeconds: number = 600

      The amount to wait for the transaction to complete when broadcasted.

    • intervalSeconds: number = 0.2

      The amount to check each time for a successful broadcast.

    Returns Promise<StakingOperation>

    The staking operation after it's completed successfully.

    -

deployMultiToken

deployMultiToken

deployNFT

deployNFT

deployToken

deployToken

export

export

faucet

faucet

  • faucet(assetId?): Promise<FaucetTransaction>

  • Requests faucet funds for the address. Only supported on testnet networks.

    Parameters

    • Optional assetId: string

      The ID of the asset to transfer from the faucet.

    Returns Promise<FaucetTransaction>

    The faucet transaction object.

    Throws

    If the request does not return a transaction hash.

    Throws

    If the request fails.

    -

getBalance

getBalance

  • getBalance(assetId): Promise<Decimal>

  • Returns the balance of the provided asset.

    Parameters

    • assetId: string

      The asset ID.

    Returns Promise<Decimal>

    The balance of the asset.

    -

Private getDestinationAddressAndNetwork

Private getDestinationAddressAndNetwork

  • getDestinationAddressAndNetwork(destination): Promise<[string, string]>

  • Returns the address and network ID of the given destination.

    Parameters

    • destination: Destination

      The destination to get the address and network ID of.

    Returns Promise<[string, string]>

    The address and network ID of the destination.

    -

getId

getId

getNetworkId

getNetworkId

getPayloadSignature

getPayloadSignature

  • getPayloadSignature(payloadSignatureId): Promise<PayloadSignature>

  • Gets a Payload Signature.

    Parameters

    • payloadSignatureId: string

      The ID of the Payload Signature to fetch.

    Returns Promise<PayloadSignature>

    A promise that resolves to the Payload Signature object.

    Throws

    if the API request to get the Payload Signature fails.

    -

Private getSigner

Private getSigner

getWalletId

getWalletId

historicalStakingBalances

historicalStakingBalances

invokeContract

invokeContract

listBalances

listBalances

listHistoricalBalances

listHistoricalBalances

listPayloadSignatures

listPayloadSignatures

listTrades

listTrades

listTransactions

listTransactions

listTransfers

listTransfers

setKey

setKey

  • setKey(key): void

  • Sets the private key.

    Parameters

    • key: Wallet

      The ethers.js SigningKey the Address uses to sign data.

    Returns void

    Throws

    If the private key is already set.

    -

stakeableBalance

stakeableBalance

  • stakeableBalance(asset_id, mode?, options?): Promise<Decimal>

  • Get the stakeable balance for the supplied asset.

    Parameters

    • asset_id: string

      The asset to check the stakeable balance for.

    • mode: StakeOptionsMode = StakeOptionsMode.DEFAULT

      The staking mode. Defaults to DEFAULT.

    • options: {
          [key: string]: string;
      } = {}

      Additional options for getting the stakeable balance.

      • [key: string]: string

    Returns Promise<Decimal>

    The stakeable balance.

    -

stakingRewards

stakingRewards

  • stakingRewards(assetId, startTime?, endTime?, format?): Promise<StakingReward[]>

  • Lists the staking rewards for the address.

    Parameters

    • assetId: string

      The asset ID.

    • startTime: string = ...

      The start time.

    • endTime: string = ...

      The end time.

    • format: StakingRewardFormat = StakingRewardFormat.USD

      The format to return the rewards in. (usd, native). Defaults to usd.

    Returns Promise<StakingReward[]>

    The staking rewards.

    -

toString

toString

unstakeableBalance

unstakeableBalance

  • unstakeableBalance(asset_id, mode?, options?): Promise<Decimal>

  • Get the unstakeable balance for the supplied asset.

    Parameters

    • asset_id: string

      The asset to check the unstakeable balance for.

    • mode: StakeOptionsMode = StakeOptionsMode.DEFAULT

      The staking mode. Defaults to DEFAULT.

    • options: {
          [key: string]: string;
      } = {}

      Additional options for getting the unstakeable balance. @@ -273,26 +273,26 @@

      Throws

      if the address does not have sufficient balance.

    • validator_pub_keys (optional): List of comma separated validator public keys to retrieve unstakeable balance for. Defaults to all validators.
    • [key: string]: string

Returns Promise<Decimal>

The unstakeable balance.

-

Private validateCanClaimStake

Private validateCanClaimStake

  • validateCanClaimStake(amount, assetId, mode, options): Promise<void>
  • Private

    Validate if the operation is able to claim stake with the supplied input.

    Parameters

    • amount: Amount

      The amount of the asset to claim stake.

    • assetId: string

      The asset to claim stake.

    • mode: StakeOptionsMode

      The staking mode. Defaults to DEFAULT.

    • options: {
          [key: string]: string;
      }

      Additional options for the claim stake operation.

      • [key: string]: string

    Returns Promise<void>

    Throws

    If the supplied input is not able to create a claim stake operation.

    -

Private validateCanStake

Private validateCanStake

  • validateCanStake(amount, assetId, mode, options): Promise<void>
  • Private

    Validate if the operation is able to stake with the supplied input.

    Parameters

    • amount: Amount

      The amount of the asset to stake.

    • assetId: string

      The asset to stake.

    • mode: StakeOptionsMode

      The staking mode. Defaults to DEFAULT.

    • options: {
          [key: string]: string;
      }

      Additional options for the stake operation.

      • [key: string]: string

    Returns Promise<void>

    Throws

    If the supplied input is not able to create a stake operation.

    -

Private validateCanTrade

Private validateCanTrade

  • validateCanTrade(amount, fromAssetId): Promise<void>

  • Checks if trading is possible and raises an error if not.

    Parameters

    • amount: Amount

      The amount of the Asset to send.

    • fromAssetId: string

      The ID of the Asset to trade from. For Ether, eth, gwei, and wei are supported.

    Returns Promise<void>

    Throws

    If the private key is not loaded, or if the asset IDs are unsupported, or if there are insufficient funds.

    -

Private validateCanUnstake

Private validateCanUnstake

  • validateCanUnstake(amount, assetId, mode, options): Promise<void>
  • Private

    Validate if the operation is able to unstake with the supplied input.

    Parameters

    • amount: Amount

      The amount of the asset to unstake.

    • assetId: string

      The asset to unstake.

    • mode: StakeOptionsMode

      The staking mode. Defaults to DEFAULT.

    • options: {
          [key: string]: string;
      }

      Additional options for the unstake operation.

      • [key: string]: string

    Returns Promise<void>

    Throws

    If the supplied input is not able to create an unstake operation.

    -

Settings

Member Visibility

Theme

On This Page

constructoridkeymodelnetworkIdbroadcastStakingOperationRequestcanSignclaimableBalancecopyOptionscreateClaimStakecreateContractInvocationcreateERC1155createERC20createERC721createPayloadSignaturecreateStakecreateStakingOperationcreateStakingOperationRequestcreateTradecreateTradeRequestcreateTransfercreateUnstakedeployMultiTokendeployNFTdeployTokenexportfaucetgetBalancegetDestinationAddressAndNetworkgetIdgetNetworkIdgetPayloadSignaturegetSignergetWalletIdhistoricalStakingBalancesinvokeContractlistBalanceslistHistoricalBalanceslistPayloadSignatureslistTradeslistTransactionslistTransferssetKeystakeableBalancestakingRewardstoStringunstakeableBalancevalidateCanClaimStakevalidateCanStakevalidateCanTradevalidateCanUnstake
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoridkeymodelnetworkIdbroadcastStakingOperationRequestcanSignclaimableBalancecopyOptionscreateClaimStakecreateContractInvocationcreateERC1155createERC20createERC721createPayloadSignaturecreateStakecreateStakingOperationcreateStakingOperationRequestcreateTradecreateTradeRequestcreateTransfercreateUnstakedeployMultiTokendeployNFTdeployTokenexportfaucetgetBalancegetDestinationAddressAndNetworkgetIdgetNetworkIdgetPayloadSignaturegetSignergetWalletIdhistoricalStakingBalancesinvokeContractlistBalanceslistHistoricalBalanceslistPayloadSignatureslistTradeslistTransactionslistTransferssetKeystakeableBalancestakingRewardstoStringunstakeableBalancevalidateCanClaimStakevalidateCanStakevalidateCanTradevalidateCanUnstake
\ No newline at end of file diff --git a/docs/classes/coinbase_api_error.APIError.html b/docs/classes/coinbase_api_error.APIError.html index d06d55e3..7eb95c2c 100644 --- a/docs/classes/coinbase_api_error.APIError.html +++ b/docs/classes/coinbase_api_error.APIError.html @@ -1,5 +1,5 @@ APIError | @coinbase/coinbase-sdk

Class APIError

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

apiCode apiMessage cause? @@ -35,12 +35,12 @@ fromError

Constructors

constructor

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns APIError

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

toString

  • toString(): string

  • Returns a String representation of the APIError.

    Returns string

    a String representation of the APIError

    -

Static captureStackTrace

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static from

  • from<T, D>(error, code?, config?, request?, response?, customProps?): AxiosError<T, D>

  • Type Parameters

    • T = unknown
    • D = any

    Parameters

    • error: unknown
    • Optional code: string
    • Optional config: InternalAxiosRequestConfig<D>
    • Optional request: any
    • Optional response: AxiosResponse<T, D>
    • Optional customProps: object

    Returns AxiosError<T, D>

Static fromError

  • fromError(error): APIError

  • Creates a specific APIError based on the API error code.

    Parameters

    • error: AxiosError<unknown, any>

      The underlying error object.

    Returns APIError

    A specific APIError instance.

    -

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file diff --git a/docs/classes/coinbase_api_error.AlreadyExistsError.html b/docs/classes/coinbase_api_error.AlreadyExistsError.html index 2dd5b8eb..c9cfd6ee 100644 --- a/docs/classes/coinbase_api_error.AlreadyExistsError.html +++ b/docs/classes/coinbase_api_error.AlreadyExistsError.html @@ -1,5 +1,5 @@ AlreadyExistsError | @coinbase/coinbase-sdk

Class AlreadyExistsError

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

apiCode apiMessage cause? @@ -35,12 +35,12 @@ fromError

Constructors

constructor

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns AlreadyExistsError

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

toString

Static captureStackTrace

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static from

  • from<T, D>(error, code?, config?, request?, response?, customProps?): AxiosError<T, D>

  • Type Parameters

    • T = unknown
    • D = any

    Parameters

    • error: unknown
    • Optional code: string
    • Optional config: InternalAxiosRequestConfig<D>
    • Optional request: any
    • Optional response: AxiosResponse<T, D>
    • Optional customProps: object

    Returns AxiosError<T, D>

Static fromError

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file diff --git a/docs/classes/coinbase_api_error.FaucetLimitReachedError.html b/docs/classes/coinbase_api_error.FaucetLimitReachedError.html index 98720af2..eb4b649f 100644 --- a/docs/classes/coinbase_api_error.FaucetLimitReachedError.html +++ b/docs/classes/coinbase_api_error.FaucetLimitReachedError.html @@ -1,5 +1,5 @@ FaucetLimitReachedError | @coinbase/coinbase-sdk

Class FaucetLimitReachedError

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

apiCode apiMessage cause? @@ -35,12 +35,12 @@ fromError

Constructors

constructor

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns FaucetLimitReachedError

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

toString

Static captureStackTrace

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static from

  • from<T, D>(error, code?, config?, request?, response?, customProps?): AxiosError<T, D>

  • Type Parameters

    • T = unknown
    • D = any

    Parameters

    • error: unknown
    • Optional code: string
    • Optional config: InternalAxiosRequestConfig<D>
    • Optional request: any
    • Optional response: AxiosResponse<T, D>
    • Optional customProps: object

    Returns AxiosError<T, D>

Static fromError

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file diff --git a/docs/classes/coinbase_api_error.InternalError.html b/docs/classes/coinbase_api_error.InternalError.html index f08c52c0..5c51fd9b 100644 --- a/docs/classes/coinbase_api_error.InternalError.html +++ b/docs/classes/coinbase_api_error.InternalError.html @@ -1,5 +1,5 @@ InternalError | @coinbase/coinbase-sdk

Class InternalError

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

apiCode apiMessage cause? @@ -35,12 +35,12 @@ fromError

Constructors

constructor

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns InternalError

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

toString

Static captureStackTrace

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static from

  • from<T, D>(error, code?, config?, request?, response?, customProps?): AxiosError<T, D>

  • Type Parameters

    • T = unknown
    • D = any

    Parameters

    • error: unknown
    • Optional code: string
    • Optional config: InternalAxiosRequestConfig<D>
    • Optional request: any
    • Optional response: AxiosResponse<T, D>
    • Optional customProps: object

    Returns AxiosError<T, D>

Static fromError

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file diff --git a/docs/classes/coinbase_api_error.InvalidAddressError.html b/docs/classes/coinbase_api_error.InvalidAddressError.html index b1f8a199..0fa7d4aa 100644 --- a/docs/classes/coinbase_api_error.InvalidAddressError.html +++ b/docs/classes/coinbase_api_error.InvalidAddressError.html @@ -1,5 +1,5 @@ InvalidAddressError | @coinbase/coinbase-sdk

Class InvalidAddressError

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

apiCode apiMessage cause? @@ -35,12 +35,12 @@ fromError

Constructors

constructor

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns InvalidAddressError

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

toString

Static captureStackTrace

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static from

  • from<T, D>(error, code?, config?, request?, response?, customProps?): AxiosError<T, D>

  • Type Parameters

    • T = unknown
    • D = any

    Parameters

    • error: unknown
    • Optional code: string
    • Optional config: InternalAxiosRequestConfig<D>
    • Optional request: any
    • Optional response: AxiosResponse<T, D>
    • Optional customProps: object

    Returns AxiosError<T, D>

Static fromError

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file diff --git a/docs/classes/coinbase_api_error.InvalidAddressIDError.html b/docs/classes/coinbase_api_error.InvalidAddressIDError.html index 857dfb5f..daf7d380 100644 --- a/docs/classes/coinbase_api_error.InvalidAddressIDError.html +++ b/docs/classes/coinbase_api_error.InvalidAddressIDError.html @@ -1,5 +1,5 @@ InvalidAddressIDError | @coinbase/coinbase-sdk

Class InvalidAddressIDError

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

apiCode apiMessage cause? @@ -35,12 +35,12 @@ fromError

Constructors

constructor

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns InvalidAddressIDError

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

toString

Static captureStackTrace

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static from

  • from<T, D>(error, code?, config?, request?, response?, customProps?): AxiosError<T, D>

  • Type Parameters

    • T = unknown
    • D = any

    Parameters

    • error: unknown
    • Optional code: string
    • Optional config: InternalAxiosRequestConfig<D>
    • Optional request: any
    • Optional response: AxiosResponse<T, D>
    • Optional customProps: object

    Returns AxiosError<T, D>

Static fromError

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file diff --git a/docs/classes/coinbase_api_error.InvalidAmountError.html b/docs/classes/coinbase_api_error.InvalidAmountError.html index e64f6c43..1a28ef72 100644 --- a/docs/classes/coinbase_api_error.InvalidAmountError.html +++ b/docs/classes/coinbase_api_error.InvalidAmountError.html @@ -1,5 +1,5 @@ InvalidAmountError | @coinbase/coinbase-sdk

Class InvalidAmountError

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

apiCode apiMessage cause? @@ -35,12 +35,12 @@ fromError

Constructors

constructor

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns InvalidAmountError

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

toString

Static captureStackTrace

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static from

  • from<T, D>(error, code?, config?, request?, response?, customProps?): AxiosError<T, D>

  • Type Parameters

    • T = unknown
    • D = any

    Parameters

    • error: unknown
    • Optional code: string
    • Optional config: InternalAxiosRequestConfig<D>
    • Optional request: any
    • Optional response: AxiosResponse<T, D>
    • Optional customProps: object

    Returns AxiosError<T, D>

Static fromError

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file diff --git a/docs/classes/coinbase_api_error.InvalidAssetIDError.html b/docs/classes/coinbase_api_error.InvalidAssetIDError.html index b43afd2b..7a38709d 100644 --- a/docs/classes/coinbase_api_error.InvalidAssetIDError.html +++ b/docs/classes/coinbase_api_error.InvalidAssetIDError.html @@ -1,5 +1,5 @@ InvalidAssetIDError | @coinbase/coinbase-sdk

Class InvalidAssetIDError

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

apiCode apiMessage cause? @@ -35,12 +35,12 @@ fromError

Constructors

constructor

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns InvalidAssetIDError

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

toString

Static captureStackTrace

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static from

  • from<T, D>(error, code?, config?, request?, response?, customProps?): AxiosError<T, D>

  • Type Parameters

    • T = unknown
    • D = any

    Parameters

    • error: unknown
    • Optional code: string
    • Optional config: InternalAxiosRequestConfig<D>
    • Optional request: any
    • Optional response: AxiosResponse<T, D>
    • Optional customProps: object

    Returns AxiosError<T, D>

Static fromError

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file diff --git a/docs/classes/coinbase_api_error.InvalidDestinationError.html b/docs/classes/coinbase_api_error.InvalidDestinationError.html index 999809bb..be3c6578 100644 --- a/docs/classes/coinbase_api_error.InvalidDestinationError.html +++ b/docs/classes/coinbase_api_error.InvalidDestinationError.html @@ -1,5 +1,5 @@ InvalidDestinationError | @coinbase/coinbase-sdk

Class InvalidDestinationError

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

apiCode apiMessage cause? @@ -35,12 +35,12 @@ fromError

Constructors

constructor

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns InvalidDestinationError

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

toString

Static captureStackTrace

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static from

  • from<T, D>(error, code?, config?, request?, response?, customProps?): AxiosError<T, D>

  • Type Parameters

    • T = unknown
    • D = any

    Parameters

    • error: unknown
    • Optional code: string
    • Optional config: InternalAxiosRequestConfig<D>
    • Optional request: any
    • Optional response: AxiosResponse<T, D>
    • Optional customProps: object

    Returns AxiosError<T, D>

Static fromError

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file diff --git a/docs/classes/coinbase_api_error.InvalidLimitError.html b/docs/classes/coinbase_api_error.InvalidLimitError.html index 036e7367..5f85f8e9 100644 --- a/docs/classes/coinbase_api_error.InvalidLimitError.html +++ b/docs/classes/coinbase_api_error.InvalidLimitError.html @@ -1,5 +1,5 @@ InvalidLimitError | @coinbase/coinbase-sdk

Class InvalidLimitError

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

apiCode apiMessage cause? @@ -35,12 +35,12 @@ fromError

Constructors

constructor

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns InvalidLimitError

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

toString

Static captureStackTrace

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static from

  • from<T, D>(error, code?, config?, request?, response?, customProps?): AxiosError<T, D>

  • Type Parameters

    • T = unknown
    • D = any

    Parameters

    • error: unknown
    • Optional code: string
    • Optional config: InternalAxiosRequestConfig<D>
    • Optional request: any
    • Optional response: AxiosResponse<T, D>
    • Optional customProps: object

    Returns AxiosError<T, D>

Static fromError

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file diff --git a/docs/classes/coinbase_api_error.InvalidNetworkIDError.html b/docs/classes/coinbase_api_error.InvalidNetworkIDError.html index ec0f93e3..3e525493 100644 --- a/docs/classes/coinbase_api_error.InvalidNetworkIDError.html +++ b/docs/classes/coinbase_api_error.InvalidNetworkIDError.html @@ -1,5 +1,5 @@ InvalidNetworkIDError | @coinbase/coinbase-sdk

Class InvalidNetworkIDError

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

apiCode apiMessage cause? @@ -35,12 +35,12 @@ fromError

Constructors

constructor

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns InvalidNetworkIDError

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

toString

Static captureStackTrace

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static from

  • from<T, D>(error, code?, config?, request?, response?, customProps?): AxiosError<T, D>

  • Type Parameters

    • T = unknown
    • D = any

    Parameters

    • error: unknown
    • Optional code: string
    • Optional config: InternalAxiosRequestConfig<D>
    • Optional request: any
    • Optional response: AxiosResponse<T, D>
    • Optional customProps: object

    Returns AxiosError<T, D>

Static fromError

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file diff --git a/docs/classes/coinbase_api_error.InvalidPageError.html b/docs/classes/coinbase_api_error.InvalidPageError.html index 4d7c3a2a..a0f06939 100644 --- a/docs/classes/coinbase_api_error.InvalidPageError.html +++ b/docs/classes/coinbase_api_error.InvalidPageError.html @@ -1,5 +1,5 @@ InvalidPageError | @coinbase/coinbase-sdk

Class InvalidPageError

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

apiCode apiMessage cause? @@ -35,12 +35,12 @@ fromError

Constructors

constructor

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns InvalidPageError

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

toString

Static captureStackTrace

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static from

  • from<T, D>(error, code?, config?, request?, response?, customProps?): AxiosError<T, D>

  • Type Parameters

    • T = unknown
    • D = any

    Parameters

    • error: unknown
    • Optional code: string
    • Optional config: InternalAxiosRequestConfig<D>
    • Optional request: any
    • Optional response: AxiosResponse<T, D>
    • Optional customProps: object

    Returns AxiosError<T, D>

Static fromError

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file diff --git a/docs/classes/coinbase_api_error.InvalidSignedPayloadError.html b/docs/classes/coinbase_api_error.InvalidSignedPayloadError.html index 797b57b9..af7fbc85 100644 --- a/docs/classes/coinbase_api_error.InvalidSignedPayloadError.html +++ b/docs/classes/coinbase_api_error.InvalidSignedPayloadError.html @@ -1,5 +1,5 @@ InvalidSignedPayloadError | @coinbase/coinbase-sdk

Class InvalidSignedPayloadError

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

apiCode apiMessage cause? @@ -35,12 +35,12 @@ fromError

Constructors

constructor

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns InvalidSignedPayloadError

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

toString

Static captureStackTrace

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static from

  • from<T, D>(error, code?, config?, request?, response?, customProps?): AxiosError<T, D>

  • Type Parameters

    • T = unknown
    • D = any

    Parameters

    • error: unknown
    • Optional code: string
    • Optional config: InternalAxiosRequestConfig<D>
    • Optional request: any
    • Optional response: AxiosResponse<T, D>
    • Optional customProps: object

    Returns AxiosError<T, D>

Static fromError

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file diff --git a/docs/classes/coinbase_api_error.InvalidTransferIDError.html b/docs/classes/coinbase_api_error.InvalidTransferIDError.html index 76ce7790..039ef33d 100644 --- a/docs/classes/coinbase_api_error.InvalidTransferIDError.html +++ b/docs/classes/coinbase_api_error.InvalidTransferIDError.html @@ -1,5 +1,5 @@ InvalidTransferIDError | @coinbase/coinbase-sdk

Class InvalidTransferIDError

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

apiCode apiMessage cause? @@ -35,12 +35,12 @@ fromError

Constructors

constructor

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns InvalidTransferIDError

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

toString

Static captureStackTrace

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static from

  • from<T, D>(error, code?, config?, request?, response?, customProps?): AxiosError<T, D>

  • Type Parameters

    • T = unknown
    • D = any

    Parameters

    • error: unknown
    • Optional code: string
    • Optional config: InternalAxiosRequestConfig<D>
    • Optional request: any
    • Optional response: AxiosResponse<T, D>
    • Optional customProps: object

    Returns AxiosError<T, D>

Static fromError

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file diff --git a/docs/classes/coinbase_api_error.InvalidTransferStatusError.html b/docs/classes/coinbase_api_error.InvalidTransferStatusError.html index 4da2255d..a71f3527 100644 --- a/docs/classes/coinbase_api_error.InvalidTransferStatusError.html +++ b/docs/classes/coinbase_api_error.InvalidTransferStatusError.html @@ -1,5 +1,5 @@ InvalidTransferStatusError | @coinbase/coinbase-sdk

Class InvalidTransferStatusError

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

apiCode apiMessage cause? @@ -35,12 +35,12 @@ fromError

Constructors

constructor

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns InvalidTransferStatusError

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

toString

Static captureStackTrace

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static from

  • from<T, D>(error, code?, config?, request?, response?, customProps?): AxiosError<T, D>

  • Type Parameters

    • T = unknown
    • D = any

    Parameters

    • error: unknown
    • Optional code: string
    • Optional config: InternalAxiosRequestConfig<D>
    • Optional request: any
    • Optional response: AxiosResponse<T, D>
    • Optional customProps: object

    Returns AxiosError<T, D>

Static fromError

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file diff --git a/docs/classes/coinbase_api_error.InvalidWalletError.html b/docs/classes/coinbase_api_error.InvalidWalletError.html index a7707cbe..27c2b315 100644 --- a/docs/classes/coinbase_api_error.InvalidWalletError.html +++ b/docs/classes/coinbase_api_error.InvalidWalletError.html @@ -1,5 +1,5 @@ InvalidWalletError | @coinbase/coinbase-sdk

Class InvalidWalletError

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

apiCode apiMessage cause? @@ -35,12 +35,12 @@ fromError

Constructors

constructor

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns InvalidWalletError

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

toString

Static captureStackTrace

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static from

  • from<T, D>(error, code?, config?, request?, response?, customProps?): AxiosError<T, D>

  • Type Parameters

    • T = unknown
    • D = any

    Parameters

    • error: unknown
    • Optional code: string
    • Optional config: InternalAxiosRequestConfig<D>
    • Optional request: any
    • Optional response: AxiosResponse<T, D>
    • Optional customProps: object

    Returns AxiosError<T, D>

Static fromError

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file diff --git a/docs/classes/coinbase_api_error.InvalidWalletIDError.html b/docs/classes/coinbase_api_error.InvalidWalletIDError.html index 4a2610bb..2c9d4182 100644 --- a/docs/classes/coinbase_api_error.InvalidWalletIDError.html +++ b/docs/classes/coinbase_api_error.InvalidWalletIDError.html @@ -1,5 +1,5 @@ InvalidWalletIDError | @coinbase/coinbase-sdk

Class InvalidWalletIDError

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

apiCode apiMessage cause? @@ -35,12 +35,12 @@ fromError

Constructors

constructor

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns InvalidWalletIDError

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

toString

Static captureStackTrace

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static from

  • from<T, D>(error, code?, config?, request?, response?, customProps?): AxiosError<T, D>

  • Type Parameters

    • T = unknown
    • D = any

    Parameters

    • error: unknown
    • Optional code: string
    • Optional config: InternalAxiosRequestConfig<D>
    • Optional request: any
    • Optional response: AxiosResponse<T, D>
    • Optional customProps: object

    Returns AxiosError<T, D>

Static fromError

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file diff --git a/docs/classes/coinbase_api_error.MalformedRequestError.html b/docs/classes/coinbase_api_error.MalformedRequestError.html index 3a3019d1..e1576672 100644 --- a/docs/classes/coinbase_api_error.MalformedRequestError.html +++ b/docs/classes/coinbase_api_error.MalformedRequestError.html @@ -1,5 +1,5 @@ MalformedRequestError | @coinbase/coinbase-sdk

Class MalformedRequestError

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

apiCode apiMessage cause? @@ -35,12 +35,12 @@ fromError

Constructors

constructor

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns MalformedRequestError

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

toString

Static captureStackTrace

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static from

  • from<T, D>(error, code?, config?, request?, response?, customProps?): AxiosError<T, D>

  • Type Parameters

    • T = unknown
    • D = any

    Parameters

    • error: unknown
    • Optional code: string
    • Optional config: InternalAxiosRequestConfig<D>
    • Optional request: any
    • Optional response: AxiosResponse<T, D>
    • Optional customProps: object

    Returns AxiosError<T, D>

Static fromError

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file diff --git a/docs/classes/coinbase_api_error.NetworkFeatureUnsupportedError.html b/docs/classes/coinbase_api_error.NetworkFeatureUnsupportedError.html index 7be729fc..25aa4ed3 100644 --- a/docs/classes/coinbase_api_error.NetworkFeatureUnsupportedError.html +++ b/docs/classes/coinbase_api_error.NetworkFeatureUnsupportedError.html @@ -1,5 +1,5 @@ NetworkFeatureUnsupportedError | @coinbase/coinbase-sdk

Class NetworkFeatureUnsupportedError

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

apiCode apiMessage cause? @@ -35,12 +35,12 @@ fromError

Constructors

constructor

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns NetworkFeatureUnsupportedError

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

toString

Static captureStackTrace

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static from

  • from<T, D>(error, code?, config?, request?, response?, customProps?): AxiosError<T, D>

  • Type Parameters

    • T = unknown
    • D = any

    Parameters

    • error: unknown
    • Optional code: string
    • Optional config: InternalAxiosRequestConfig<D>
    • Optional request: any
    • Optional response: AxiosResponse<T, D>
    • Optional customProps: object

    Returns AxiosError<T, D>

Static fromError

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file diff --git a/docs/classes/coinbase_api_error.NotFoundError.html b/docs/classes/coinbase_api_error.NotFoundError.html index 1732595c..41bacfa3 100644 --- a/docs/classes/coinbase_api_error.NotFoundError.html +++ b/docs/classes/coinbase_api_error.NotFoundError.html @@ -1,5 +1,5 @@ NotFoundError | @coinbase/coinbase-sdk

Class NotFoundError

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

apiCode apiMessage cause? @@ -35,12 +35,12 @@ fromError

Constructors

constructor

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns NotFoundError

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

toString

Static captureStackTrace

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static from

  • from<T, D>(error, code?, config?, request?, response?, customProps?): AxiosError<T, D>

  • Type Parameters

    • T = unknown
    • D = any

    Parameters

    • error: unknown
    • Optional code: string
    • Optional config: InternalAxiosRequestConfig<D>
    • Optional request: any
    • Optional response: AxiosResponse<T, D>
    • Optional customProps: object

    Returns AxiosError<T, D>

Static fromError

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file diff --git a/docs/classes/coinbase_api_error.ResourceExhaustedError.html b/docs/classes/coinbase_api_error.ResourceExhaustedError.html index eaf2700c..bf401094 100644 --- a/docs/classes/coinbase_api_error.ResourceExhaustedError.html +++ b/docs/classes/coinbase_api_error.ResourceExhaustedError.html @@ -1,5 +1,5 @@ ResourceExhaustedError | @coinbase/coinbase-sdk

Class ResourceExhaustedError

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

apiCode apiMessage cause? @@ -35,12 +35,12 @@ fromError

Constructors

constructor

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns ResourceExhaustedError

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

toString

Static captureStackTrace

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static from

  • from<T, D>(error, code?, config?, request?, response?, customProps?): AxiosError<T, D>

  • Type Parameters

    • T = unknown
    • D = any

    Parameters

    • error: unknown
    • Optional code: string
    • Optional config: InternalAxiosRequestConfig<D>
    • Optional request: any
    • Optional response: AxiosResponse<T, D>
    • Optional customProps: object

    Returns AxiosError<T, D>

Static fromError

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file diff --git a/docs/classes/coinbase_api_error.UnauthorizedError.html b/docs/classes/coinbase_api_error.UnauthorizedError.html index cd12aef6..36f30fde 100644 --- a/docs/classes/coinbase_api_error.UnauthorizedError.html +++ b/docs/classes/coinbase_api_error.UnauthorizedError.html @@ -1,5 +1,5 @@ UnauthorizedError | @coinbase/coinbase-sdk

Class UnauthorizedError

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

apiCode apiMessage cause? @@ -35,12 +35,12 @@ fromError

Constructors

constructor

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns UnauthorizedError

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

toString

Static captureStackTrace

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static from

  • from<T, D>(error, code?, config?, request?, response?, customProps?): AxiosError<T, D>

  • Type Parameters

    • T = unknown
    • D = any

    Parameters

    • error: unknown
    • Optional code: string
    • Optional config: InternalAxiosRequestConfig<D>
    • Optional request: any
    • Optional response: AxiosResponse<T, D>
    • Optional customProps: object

    Returns AxiosError<T, D>

Static fromError

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file diff --git a/docs/classes/coinbase_api_error.UnimplementedError.html b/docs/classes/coinbase_api_error.UnimplementedError.html index 0d5bfded..b6bc45d5 100644 --- a/docs/classes/coinbase_api_error.UnimplementedError.html +++ b/docs/classes/coinbase_api_error.UnimplementedError.html @@ -1,5 +1,5 @@ UnimplementedError | @coinbase/coinbase-sdk

Class UnimplementedError

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

apiCode apiMessage cause? @@ -35,12 +35,12 @@ fromError

Constructors

constructor

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns UnimplementedError

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

toString

Static captureStackTrace

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static from

  • from<T, D>(error, code?, config?, request?, response?, customProps?): AxiosError<T, D>

  • Type Parameters

    • T = unknown
    • D = any

    Parameters

    • error: unknown
    • Optional code: string
    • Optional config: InternalAxiosRequestConfig<D>
    • Optional request: any
    • Optional response: AxiosResponse<T, D>
    • Optional customProps: object

    Returns AxiosError<T, D>

Static fromError

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file diff --git a/docs/classes/coinbase_api_error.UnsupportedAssetError.html b/docs/classes/coinbase_api_error.UnsupportedAssetError.html index 2b9284dc..03628ad0 100644 --- a/docs/classes/coinbase_api_error.UnsupportedAssetError.html +++ b/docs/classes/coinbase_api_error.UnsupportedAssetError.html @@ -1,5 +1,5 @@ UnsupportedAssetError | @coinbase/coinbase-sdk

Class UnsupportedAssetError

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

apiCode apiMessage cause? @@ -35,12 +35,12 @@ fromError

Constructors

constructor

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns UnsupportedAssetError

Properties

apiCode

apiCode: null | string

apiMessage

apiMessage: null | string

Optional cause

cause?: Error

Optional code

code?: string

Optional config

config?: InternalAxiosRequestConfig<any>

correlationId

correlationId: null | string

httpCode

httpCode: null | number

isAxiosError

isAxiosError: boolean

message

message: string

name

name: string

Optional request

request?: any

Optional response

response?: AxiosResponse<unknown, any>

Optional stack

stack?: string

Optional status

status?: number

toJSON

toJSON: (() => object)

Type declaration

    • (): object

    • Returns object

Static Readonly ECONNABORTED

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"

Static Readonly ERR_BAD_OPTION

ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"

Static Readonly ERR_BAD_OPTION_VALUE

ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"

Static Readonly ERR_BAD_REQUEST

ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"

Static Readonly ERR_BAD_RESPONSE

ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"

Static Readonly ERR_CANCELED

ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"

Static Readonly ERR_DEPRECATED

ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"

Static Readonly ERR_FR_TOO_MANY_REDIRECTS

ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"

Static Readonly ERR_INVALID_URL

ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"

Static Readonly ERR_NETWORK

ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"

Static Readonly ERR_NOT_SUPPORT

ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"

Static Readonly ETIMEDOUT

ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

toString

Static captureStackTrace

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static from

  • from<T, D>(error, code?, config?, request?, response?, customProps?): AxiosError<T, D>

  • Type Parameters

    • T = unknown
    • D = any

    Parameters

    • error: unknown
    • Optional code: string
    • Optional config: InternalAxiosRequestConfig<D>
    • Optional request: any
    • Optional response: AxiosResponse<T, D>
    • Optional customProps: object

    Returns AxiosError<T, D>

Static fromError

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorapiCodeapiMessagecausecodeconfigcorrelationIdhttpCodeisAxiosErrormessagenamerequestresponsestackstatustoJSONECONNABORTEDERR_BAD_OPTIONERR_BAD_OPTION_VALUEERR_BAD_REQUESTERR_BAD_RESPONSEERR_CANCELEDERR_DEPRECATEDERR_FR_TOO_MANY_REDIRECTSERR_INVALID_URLERR_NETWORKERR_NOT_SUPPORTETIMEDOUTprepareStackTracestackTraceLimittoStringcaptureStackTracefromfromError
\ No newline at end of file diff --git a/docs/classes/coinbase_asset.Asset.html b/docs/classes/coinbase_asset.Asset.html index 909e21ff..d18d43bf 100644 --- a/docs/classes/coinbase_asset.Asset.html +++ b/docs/classes/coinbase_asset.Asset.html @@ -1,5 +1,5 @@ Asset | @coinbase/coinbase-sdk

Class Asset

A representation of an Asset.

-

Constructors

constructor +

Constructors

constructor

Properties

assetId contractAddress decimals @@ -17,31 +17,31 @@
  • assetId: string

    The asset ID.

  • contractAddress: string

    The address ID.

  • decimals: number

    The number of decimals.

    -

    • Returns Asset

    Properties

    Readonly assetId

    assetId: string

    Readonly contractAddress

    contractAddress: string

    Readonly decimals

    decimals: number

    Readonly networkId

    networkId: string

    Methods

    fromAtomicAmount

    • fromAtomicAmount(atomicAmount): Decimal

    • Converts the amount of the Asset from atomic to whole units.

      +

    Returns Asset

    Properties

    Readonly assetId

    assetId: string

    Readonly contractAddress

    contractAddress: string

    Readonly decimals

    decimals: number

    Readonly networkId

    networkId: string

    Methods

    fromAtomicAmount

    • fromAtomicAmount(atomicAmount): Decimal

    • Converts the amount of the Asset from atomic to whole units.

      Parameters

      • atomicAmount: Decimal

        The atomic amount to convert to whole units.

      Returns Decimal

      The amount in atomic units

      -

    getAssetId

    getAssetId

    primaryDenomination

    primaryDenomination

    • primaryDenomination(): string

    • Returns the primary denomination for the Asset.

      Returns string

      The primary denomination for the Asset.

      -

    toAtomicAmount

    • toAtomicAmount(wholeAmount): bigint

    • Converts the amount of the Asset from whole to atomic units.

      +

    toAtomicAmount

    • toAtomicAmount(wholeAmount): bigint

    • Converts the amount of the Asset from whole to atomic units.

      Parameters

      • wholeAmount: Decimal

        The whole amount to convert to atomic units.

      Returns bigint

      The amount in atomic units

      -

    toString

    toString

    • toString(): string

    • Returns a string representation of the Asset.

      Returns string

      a string representation of the Asset

      -

    Static fetch

    Static fetch

    • fetch(networkId, assetId): Promise<Asset>

    • Fetches the Asset with the provided Asset ID.

      Parameters

      • networkId: string

        The network ID.

      • assetId: string

        The asset ID.

      Returns Promise<Asset>

      The Asset Class.

      Throws

      If the Asset cannot be fetched.

      -

    Static fromModel

    Static fromModel

    • fromModel(model, assetId?): Asset

    • Creates an Asset from an Asset Model.

      Parameters

      • model: Asset

        The Asset Model.

      • Optional assetId: string

        The Asset ID.

      Returns Asset

      The Asset Class.

      Throws

      If the Asset Model is invalid.

      -

    Static primaryDenomination

    • primaryDenomination(assetId): string

    • Returns the primary denomination for the provided Asset ID. +

    Static primaryDenomination

    • primaryDenomination(assetId): string

    • Returns the primary denomination for the provided Asset ID. For gwei and wei the primary denomination is eth. For all other assets, the primary denomination is the same asset ID.

      Parameters

      • assetId: string

        The Asset ID.

      Returns string

      The primary denomination for the Asset ID.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorassetIdcontractAddressdecimalsnetworkIdfromAtomicAmountgetAssetIdprimaryDenominationtoAtomicAmounttoStringfetchfromModelprimaryDenomination
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    constructorassetIdcontractAddressdecimalsnetworkIdfromAtomicAmountgetAssetIdprimaryDenominationtoAtomicAmounttoStringfetchfromModelprimaryDenomination
    \ No newline at end of file diff --git a/docs/classes/coinbase_authenticator.CoinbaseAuthenticator.html b/docs/classes/coinbase_authenticator.CoinbaseAuthenticator.html index 06272a40..be8cb098 100644 --- a/docs/classes/coinbase_authenticator.CoinbaseAuthenticator.html +++ b/docs/classes/coinbase_authenticator.CoinbaseAuthenticator.html @@ -1,5 +1,5 @@ CoinbaseAuthenticator | @coinbase/coinbase-sdk

    Class CoinbaseAuthenticator

    A class that builds JWTs for authenticating with the Coinbase Platform APIs.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    apiKey privateKey

    Methods

    authenticateRequest @@ -10,22 +10,22 @@

    Constructors

    constructor

    Properties

    Private apiKey

    apiKey: string

    Private privateKey

    privateKey: string

    Methods

    authenticateRequest

    • authenticateRequest(config, debugging?): Promise<InternalAxiosRequestConfig<any>>

    • Middleware to intercept requests and add JWT to Authorization header.

      +

    Returns CoinbaseAuthenticator

    Properties

    Private apiKey

    apiKey: string

    Private privateKey

    privateKey: string

    Methods

    authenticateRequest

    • authenticateRequest(config, debugging?): Promise<InternalAxiosRequestConfig<any>>

    • Middleware to intercept requests and add JWT to Authorization header.

      Parameters

      • config: InternalAxiosRequestConfig<any>

        The request configuration.

      • debugging: boolean = false

        Flag to enable debugging.

      Returns Promise<InternalAxiosRequestConfig<any>>

      The request configuration with the Authorization header added.

      Throws

      If JWT could not be built.

      -

    buildJWT

    buildJWT

    • buildJWT(url, method?): Promise<string>

    • Builds the JWT for the given API endpoint URL.

      Parameters

      • url: string

        URL of the API endpoint.

      • method: string = "GET"

        HTTP method of the request.

      Returns Promise<string>

      JWT token.

      Throws

      If the private key is not in the correct format.

      -

    Private extractPemKey

    Private extractPemKey

    • extractPemKey(privateKeyString): string

    • Extracts the PEM key from the given private key string.

      Parameters

      • privateKeyString: string

        The private key string.

      Returns string

      The PEM key.

      Throws

      If the private key string is not in the correct format.

      -

    Private getCorrelationData

    Private getCorrelationData

    • getCorrelationData(): string

    • Returns encoded correlation data including the SDK version and language.

      Returns string

      Encoded correlation data.

      -

    Private nonce

    Private nonce

    Settings

    Member Visibility

    Theme

    On This Page

    constructorapiKeyprivateKeyauthenticateRequestbuildJWTextractPemKeygetCorrelationDatanonce
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    constructorapiKeyprivateKeyauthenticateRequestbuildJWTextractPemKeygetCorrelationDatanonce
    \ No newline at end of file diff --git a/docs/classes/coinbase_balance.Balance.html b/docs/classes/coinbase_balance.Balance.html index 8a886ead..97d8e420 100644 --- a/docs/classes/coinbase_balance.Balance.html +++ b/docs/classes/coinbase_balance.Balance.html @@ -1,14 +1,14 @@ Balance | @coinbase/coinbase-sdk

    Class Balance

    A representation of a balance.

    -

    Properties

    amount +

    Properties

    amount asset? assetId

    Methods

    fromModel fromModelAndAssetId -

    Properties

    Readonly amount

    amount: Decimal

    Optional Readonly asset

    asset?: Asset

    Readonly assetId

    assetId: string

    Methods

    Static fromModel

    • fromModel(model): Balance

    • Converts a BalanceModel into a Balance object.

      +

    Properties

    Readonly amount

    amount: Decimal

    Optional Readonly asset

    asset?: Asset

    Readonly assetId

    assetId: string

    Methods

    Static fromModel

    Static fromModelAndAssetId

    Static fromModelAndAssetId

    • fromModelAndAssetId(model, assetId): Balance

    • Converts a BalanceModel and asset ID into a Balance object.

      Parameters

      • model: Balance

        The balance model object.

      • assetId: string

        The asset ID.

      Returns Balance

      The Balance object.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    amountassetassetIdfromModelfromModelAndAssetId
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    amountassetassetIdfromModelfromModelAndAssetId
    \ No newline at end of file diff --git a/docs/classes/coinbase_balance_map.BalanceMap.html b/docs/classes/coinbase_balance_map.BalanceMap.html index 0f71bc3d..aaeff086 100644 --- a/docs/classes/coinbase_balance_map.BalanceMap.html +++ b/docs/classes/coinbase_balance_map.BalanceMap.html @@ -1,5 +1,5 @@ BalanceMap | @coinbase/coinbase-sdk

    Class BalanceMap

    A convenience class for storing and manipulating Asset balances in a human-readable format.

    -

    Hierarchy

    • Map<string, Decimal>
      • BalanceMap

    Constructors

    constructor +

    Hierarchy

    • Map<string, Decimal>
      • BalanceMap

    Constructors

    constructor

    Properties

    [toStringTag] size [species] @@ -21,7 +21,7 @@

    Static Readonly [species]

    [species]: MapConstructor

    Methods

    [iterator]

    • [iterator](): IterableIterator<[string, Decimal]>

    • Returns an iterable of entries in the map.

      Returns IterableIterator<[string, Decimal]>

    add

    clear

    • clear(): void

    • Returns void

    delete

    • delete(key): boolean

    • Parameters

      • key: string

      Returns boolean

      true if an element in the Map existed and has been removed, or false if the element does not exist.

      +

    Returns void

    clear

    • clear(): void

    • Returns void

    delete

    • delete(key): boolean

    • Parameters

      • key: string

      Returns boolean

      true if an element in the Map existed and has been removed, or false if the element does not exist.

    entries

    • entries(): IterableIterator<[string, Decimal]>

    • Returns an iterable of key, value pairs for every entry in the map.

      Returns IterableIterator<[string, Decimal]>

    forEach

    • forEach(callbackfn, thisArg?): void

    • Executes a provided function once per each key/value pair in the Map, in insertion order.

      Parameters

      • callbackfn: ((value, key, map) => void)
          • (value, key, map): void

          • Parameters

            • value: Decimal
            • key: string
            • map: Map<string, Decimal>

            Returns void

      • Optional thisArg: any

      Returns void

    get

    • get(key): undefined | Decimal

    • Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.

      @@ -31,11 +31,11 @@

      Returns IterableIterator<string>

    set

    • set(key, value): this

    • Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.

      Parameters

      • key: string
      • value: Decimal

      Returns this

    toString

    • toString(): string

    • Returns a string representation of the balance map.

      Returns string

      The string representation of the balance map.

      -

    values

    values

    • values(): IterableIterator<Decimal>

    • Returns an iterable of values in the map

      Returns IterableIterator<Decimal>

    Static fromBalances

    Static groupBy

    • groupBy<K, T>(items, keySelector): Map<K, T[]>

    • Groups members of an iterable according to the return value of the passed callback.

      +

    Static groupBy

    • groupBy<K, T>(items, keySelector): Map<K, T[]>

    • Groups members of an iterable according to the return value of the passed callback.

      Type Parameters

      • K
      • T

      Parameters

      • items: Iterable<T>

        An iterable.

      • keySelector: ((item, index) => K)

        A callback which will be invoked for each item in items.

          • (item, index): K

          • Parameters

            • item: T
            • index: number

            Returns K

      Returns Map<K, T[]>

    Settings

    Member Visibility

    Theme

    On This Page

    constructor[toStringTag]size[species][iterator]addcleardeleteentriesforEachgethaskeyssettoStringvaluesfromBalancesgroupBy
    \ No newline at end of file diff --git a/docs/classes/coinbase_coinbase.Coinbase.html b/docs/classes/coinbase_coinbase.Coinbase.html index 4838fe82..eba33bc6 100644 --- a/docs/classes/coinbase_coinbase.Coinbase.html +++ b/docs/classes/coinbase_coinbase.Coinbase.html @@ -1,5 +1,5 @@ Coinbase | @coinbase/coinbase-sdk

    Class Coinbase

    The Coinbase SDK.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    apiClients apiKeyPrivateKey assets @@ -15,26 +15,26 @@

    Returns Coinbase

    Deprecated

    as of v0.5.0, use configure or configureFromJson instead.

    Throws

    If the configuration is invalid.

    Throws

    If not able to create JWT token.

    -

    Properties

    Static apiClients

    apiClients: ApiClients = {}

    Static apiKeyPrivateKey

    apiKeyPrivateKey: string

    The CDP API key Private Key.

    -

    Constant

    Static assets

    assets: {
        Eth: string;
        Gwei: string;
        Lamport: string;
        Sol: string;
        Usdc: string;
        Wei: string;
        Weth: string;
    } = ...

    The list of supported assets.

    -

    Type declaration

    • Eth: string
    • Gwei: string
    • Lamport: string
    • Sol: string
    • Usdc: string
    • Wei: string
    • Weth: string

    Constant

    Static defaultPageLimit

    defaultPageLimit: number = 100

    The default page limit for list methods.

    -

    Constant

    Static networks

    networks: {
        ArbitrumMainnet: "arbitrum-mainnet";
        BaseMainnet: "base-mainnet";
        BaseSepolia: "base-sepolia";
        EthereumHolesky: "ethereum-holesky";
        EthereumMainnet: "ethereum-mainnet";
        PolygonMainnet: "polygon-mainnet";
        SolanaDevnet: "solana-devnet";
        SolanaMainnet: "solana-mainnet";
    } = NetworkIdentifier

    The map of supported networks to network ID. Generated from the OpenAPI spec.

    +

    Properties

    Static apiClients

    apiClients: ApiClients = {}

    Static apiKeyPrivateKey

    apiKeyPrivateKey: string

    The CDP API key Private Key.

    +

    Constant

    Static assets

    assets: {
        Eth: string;
        Gwei: string;
        Lamport: string;
        Sol: string;
        Usdc: string;
        Wei: string;
        Weth: string;
    } = ...

    The list of supported assets.

    +

    Type declaration

    • Eth: string
    • Gwei: string
    • Lamport: string
    • Sol: string
    • Usdc: string
    • Wei: string
    • Weth: string

    Constant

    Static defaultPageLimit

    defaultPageLimit: number = 100

    The default page limit for list methods.

    +

    Constant

    Static networks

    networks: {
        ArbitrumMainnet: "arbitrum-mainnet";
        BaseMainnet: "base-mainnet";
        BaseSepolia: "base-sepolia";
        EthereumHolesky: "ethereum-holesky";
        EthereumMainnet: "ethereum-mainnet";
        PolygonMainnet: "polygon-mainnet";
        SolanaDevnet: "solana-devnet";
        SolanaMainnet: "solana-mainnet";
    } = NetworkIdentifier

    The map of supported networks to network ID. Generated from the OpenAPI spec.

    Type declaration

    • Readonly ArbitrumMainnet: "arbitrum-mainnet"
    • Readonly BaseMainnet: "base-mainnet"
    • Readonly BaseSepolia: "base-sepolia"
    • Readonly EthereumHolesky: "ethereum-holesky"
    • Readonly EthereumMainnet: "ethereum-mainnet"
    • Readonly PolygonMainnet: "polygon-mainnet"
    • Readonly SolanaDevnet: "solana-devnet"
    • Readonly SolanaMainnet: "solana-mainnet"

    Constant

    Example

    Coinbase.networks.BaseMainnet
    -

    Static useServerSigner

    useServerSigner: boolean

    Whether to use a server signer or not.

    -

    Constant

    Methods

    Static configure

    Static useServerSigner

    useServerSigner: boolean

    Whether to use a server signer or not.

    +

    Constant

    Methods

    Static configure

    Static configureFromJson

    Static configureFromJson

    • configureFromJson(options?): Coinbase

    • Reads the API key and private key from a JSON file and initializes the Coinbase SDK.

      Parameters

      Returns Coinbase

      A new instance of the Coinbase SDK.

      Throws

      If the file does not exist or the configuration values are missing/invalid.

      Throws

      If the configuration is invalid.

      Throws

      If not able to create JWT token.

      -

    Static normalizeNetwork

    • normalizeNetwork(network): string

    • Converts a network symbol to a string, replacing underscores with hyphens.

      +

    Static normalizeNetwork

    • normalizeNetwork(network): string

    • Converts a network symbol to a string, replacing underscores with hyphens.

      Parameters

      • network: string

        The network symbol to convert

      Returns string

      the converted string

      -

    Static toAssetId

    Static toAssetId

    • toAssetId(asset): string

    • Converts a string to a symbol, replacing hyphens with underscores.

      Parameters

      • asset: string

        The string to convert

      Returns string

      the converted symbol

      -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorapiClientsapiKeyPrivateKeyassetsdefaultPageLimitnetworksuseServerSignerconfigureconfigureFromJsonnormalizeNetworktoAssetId
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    constructorapiClientsapiKeyPrivateKeyassetsdefaultPageLimitnetworksuseServerSignerconfigureconfigureFromJsonnormalizeNetworktoAssetId
    \ No newline at end of file diff --git a/docs/classes/coinbase_contract_event.ContractEvent.html b/docs/classes/coinbase_contract_event.ContractEvent.html index 5c2703a1..fb65b035 100644 --- a/docs/classes/coinbase_contract_event.ContractEvent.html +++ b/docs/classes/coinbase_contract_event.ContractEvent.html @@ -1,5 +1,5 @@ ContractEvent | @coinbase/coinbase-sdk

    Class ContractEvent

    A representation of a single contract event.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    model

    Methods

    blockHeight blockTime @@ -17,32 +17,32 @@ txIndex

    Constructors

    constructor

    Properties

    Private model

    model: ContractEvent

    Methods

    blockHeight

    • blockHeight(): number

    • Returns the block height of the ContractEvent.

      +

    Returns ContractEvent

    Properties

    Private model

    model: ContractEvent

    Methods

    blockHeight

    blockTime

    blockTime

    contractAddress

    contractAddress

    contractName

    contractName

    data

    data

    eventIndex

    eventIndex

    eventName

    eventName

    fourBytes

    fourBytes

    • fourBytes(): string

    • Returns the four bytes of the Keccak hash of the event signature.

      Returns string

      The four bytes of the event signature hash.

      -

    networkId

    networkId

    protocolName

    protocolName

    sig

    sig

    toString

    toString

    txHash

    txHash

    txIndex

    txIndex

    Settings

    Member Visibility

    Theme

    On This Page

    constructormodelblockHeightblockTimecontractAddresscontractNamedataeventIndexeventNamefourBytesnetworkIdprotocolNamesigtoStringtxHashtxIndex
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    constructormodelblockHeightblockTimecontractAddresscontractNamedataeventIndexeventNamefourBytesnetworkIdprotocolNamesigtoStringtxHashtxIndex
    \ No newline at end of file diff --git a/docs/classes/coinbase_contract_invocation.ContractInvocation.html b/docs/classes/coinbase_contract_invocation.ContractInvocation.html index d9c0f757..7c1870e5 100644 --- a/docs/classes/coinbase_contract_invocation.ContractInvocation.html +++ b/docs/classes/coinbase_contract_invocation.ContractInvocation.html @@ -1,6 +1,6 @@ ContractInvocation | @coinbase/coinbase-sdk

    Class ContractInvocation

    A representation of a ContractInvocation, which calls a smart contract method onchain. The fee is assumed to be paid in the native Asset of the Network.

    -

    Properties

    model +

    Properties

    model

    Methods

    broadcast getAbi getAmount @@ -21,48 +21,48 @@ toString wait fromModel -

    Properties

    Private model

    model: ContractInvocation

    Methods

    broadcast

    • broadcast(): Promise<ContractInvocation>

    • Broadcasts the ContractInvocation to the Network.

      +

    Properties

    Private model

    model: ContractInvocation

    Methods

    broadcast

    getAbi

    getAbi

    • getAbi(): undefined | object

    • Returns the ABI of the ContractInvocation, if specified.

      Returns undefined | object

      The ABI as an object, or undefined if not available.

      -

    getAmount

    getAmount

    • getAmount(): Decimal

    • Returns the amount of the native asset sent to a payable contract method, if applicable.

      Returns Decimal

      The amount in atomic units of the native asset.

      -

    getArgs

    getArgs

    • getArgs(): object

    • Returns the Arguments of the ContractInvocation.

      Returns object

      The arguments object passed to the contract invocation. The key is the argument name and the value is the argument value.

      -

    getContractAddressId

    getContractAddressId

    getFromAddressId

    getFromAddressId

    getId

    getId

    getMethod

    getMethod

    getNetworkId

    getNetworkId

    getRawTransaction

    getRawTransaction

    • getRawTransaction(): Transaction

    • Returns the Transaction of the ContractInvocation.

      Returns Transaction

      The ethers.js Transaction object.

      Throws

      (InvalidUnsignedPayload) If the Unsigned Payload is invalid.

      -

    getStatus

    getStatus

    getTransaction

    getTransaction

    getTransactionHash

    getTransactionHash

    • getTransactionHash(): undefined | string

    • Returns the Transaction Hash of the ContractInvocation.

      Returns undefined | string

      The Transaction Hash as a Hex string, or undefined if not yet available.

      -

    getTransactionLink

    getTransactionLink

    • getTransactionLink(): string

    • Returns the link to the Transaction on the blockchain explorer.

      Returns string

      The link to the Transaction on the blockchain explorer.

      -

    getWalletId

    getWalletId

    reload

    reload

    • reload(): Promise<void>

    • Reloads the ContractInvocation model with the latest data from the server.

      Returns Promise<void>

      Throws

      if the API request to get a ContractInvocation fails.

      -

    sign

    sign

    • sign(key): Promise<string>

    • Signs the ContractInvocation with the provided key and returns the hex signature required for broadcasting the ContractInvocation.

      Parameters

      • key: Wallet

        The key to sign the ContractInvocation with

      Returns Promise<string>

      The hex-encoded signed payload

      -

    toString

    toString

    • toString(): string

    • Returns a string representation of the ContractInvocation.

      Returns string

      The string representation of the ContractInvocation.

      -

    wait

    wait

    • wait(options?): Promise<ContractInvocation>

    • Waits for the ContractInvocation to be confirmed on the Network or fail on chain. Waits until the ContractInvocation is completed or failed on-chain by polling at the given interval. Raises an error if the ContractInvocation takes longer than the given timeout.

      Parameters

      • options: {
            intervalSeconds: undefined | number;
            timeoutSeconds: undefined | number;
        } = {}

        The options to configure the wait function.

        @@ -70,7 +70,7 @@
      • timeoutSeconds: undefined | number

        The maximum time to wait for the ContractInvocation to be confirmed.

    Returns Promise<ContractInvocation>

    The ContractInvocation object in a terminal state.

    Throws

    if the ContractInvocation times out.

    -

    Static fromModel

    Static fromModel

    Settings

    Member Visibility

    Theme

    On This Page

    modelbroadcastgetAbigetAmountgetArgsgetContractAddressIdgetFromAddressIdgetIdgetMethodgetNetworkIdgetRawTransactiongetStatusgetTransactiongetTransactionHashgetTransactionLinkgetWalletIdreloadsigntoStringwaitfromModel
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    modelbroadcastgetAbigetAmountgetArgsgetContractAddressIdgetFromAddressIdgetIdgetMethodgetNetworkIdgetRawTransactiongetStatusgetTransactiongetTransactionHashgetTransactionLinkgetWalletIdreloadsigntoStringwaitfromModel
    \ No newline at end of file diff --git a/docs/classes/coinbase_errors.AlreadySignedError.html b/docs/classes/coinbase_errors.AlreadySignedError.html index 85e7fec6..1fd77850 100644 --- a/docs/classes/coinbase_errors.AlreadySignedError.html +++ b/docs/classes/coinbase_errors.AlreadySignedError.html @@ -1,5 +1,5 @@ AlreadySignedError | @coinbase/coinbase-sdk

    Class AlreadySignedError

    AlreadySignedError is thrown when a resource is already signed.

    -

    Hierarchy

    • Error
      • AlreadySignedError

    Constructors

    constructor +

    Hierarchy

    • Error
      • AlreadySignedError

    Constructors

    constructor

    Properties

    cause? message name @@ -10,7 +10,7 @@

    Methods

    captureStackTrace

    Constructors

    constructor

    Properties

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static DEFAULT_MESSAGE

    DEFAULT_MESSAGE: string = "Resource already signed"

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns AlreadySignedError

    Properties

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static DEFAULT_MESSAGE

    DEFAULT_MESSAGE: string = "Resource already signed"

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any

      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    Static stackTraceLimit

    stackTraceLimit: number

    Methods

    Static captureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcausemessagenamestackDEFAULT_MESSAGEprepareStackTracestackTraceLimitcaptureStackTrace
    \ No newline at end of file diff --git a/docs/classes/coinbase_errors.ArgumentError.html b/docs/classes/coinbase_errors.ArgumentError.html index ff46e6aa..5c7331af 100644 --- a/docs/classes/coinbase_errors.ArgumentError.html +++ b/docs/classes/coinbase_errors.ArgumentError.html @@ -1,5 +1,5 @@ ArgumentError | @coinbase/coinbase-sdk

    Class ArgumentError

    ArgumentError is thrown when an argument is invalid.

    -

    Hierarchy

    • Error
      • ArgumentError

    Constructors

    constructor +

    Hierarchy

    • Error
      • ArgumentError

    Constructors

    constructor

    Properties

    cause? message name @@ -10,7 +10,7 @@

    Methods

    captureStackTrace

    Constructors

    constructor

    Properties

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static DEFAULT_MESSAGE

    DEFAULT_MESSAGE: string = "Argument Error"

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns ArgumentError

    Properties

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static DEFAULT_MESSAGE

    DEFAULT_MESSAGE: string = "Argument Error"

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any

      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    Static stackTraceLimit

    stackTraceLimit: number

    Methods

    Static captureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcausemessagenamestackDEFAULT_MESSAGEprepareStackTracestackTraceLimitcaptureStackTrace
    \ No newline at end of file diff --git a/docs/classes/coinbase_errors.InvalidAPIKeyFormatError.html b/docs/classes/coinbase_errors.InvalidAPIKeyFormatError.html index 02c5a972..34170e03 100644 --- a/docs/classes/coinbase_errors.InvalidAPIKeyFormatError.html +++ b/docs/classes/coinbase_errors.InvalidAPIKeyFormatError.html @@ -1,5 +1,5 @@ InvalidAPIKeyFormatError | @coinbase/coinbase-sdk

    Class InvalidAPIKeyFormatError

    InvalidAPIKeyFormatError error is thrown when the API key format is invalid.

    -

    Hierarchy

    • Error
      • InvalidAPIKeyFormatError

    Constructors

    constructor +

    Hierarchy

    • Error
      • InvalidAPIKeyFormatError

    Constructors

    constructor

    Properties

    cause? message name @@ -10,7 +10,7 @@

    Methods

    captureStackTrace

    Constructors

    constructor

    Properties

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static DEFAULT_MESSAGE

    DEFAULT_MESSAGE: string = "Invalid API key format"

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidAPIKeyFormatError

    Properties

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static DEFAULT_MESSAGE

    DEFAULT_MESSAGE: string = "Invalid API key format"

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any

      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    Static stackTraceLimit

    stackTraceLimit: number

    Methods

    Static captureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcausemessagenamestackDEFAULT_MESSAGEprepareStackTracestackTraceLimitcaptureStackTrace
    \ No newline at end of file diff --git a/docs/classes/coinbase_errors.InvalidConfigurationError.html b/docs/classes/coinbase_errors.InvalidConfigurationError.html index f388ca4e..e3645ab4 100644 --- a/docs/classes/coinbase_errors.InvalidConfigurationError.html +++ b/docs/classes/coinbase_errors.InvalidConfigurationError.html @@ -1,5 +1,5 @@ InvalidConfigurationError | @coinbase/coinbase-sdk

    Class InvalidConfigurationError

    InvalidConfigurationError error is thrown when apikey/privateKey configuration is invalid.

    -

    Hierarchy

    • Error
      • InvalidConfigurationError

    Constructors

    constructor +

    Hierarchy

    • Error
      • InvalidConfigurationError

    Constructors

    constructor

    Properties

    cause? message name @@ -10,7 +10,7 @@

    Methods

    captureStackTrace

    Constructors

    constructor

    Properties

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static DEFAULT_MESSAGE

    DEFAULT_MESSAGE: string = "Invalid configuration"

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidConfigurationError

    Properties

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static DEFAULT_MESSAGE

    DEFAULT_MESSAGE: string = "Invalid configuration"

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any

      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    Static stackTraceLimit

    stackTraceLimit: number

    Methods

    Static captureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcausemessagenamestackDEFAULT_MESSAGEprepareStackTracestackTraceLimitcaptureStackTrace
    \ No newline at end of file diff --git a/docs/classes/coinbase_errors.InvalidUnsignedPayloadError.html b/docs/classes/coinbase_errors.InvalidUnsignedPayloadError.html index 0d0eb1d0..7a361568 100644 --- a/docs/classes/coinbase_errors.InvalidUnsignedPayloadError.html +++ b/docs/classes/coinbase_errors.InvalidUnsignedPayloadError.html @@ -1,5 +1,5 @@ InvalidUnsignedPayloadError | @coinbase/coinbase-sdk

    Class InvalidUnsignedPayloadError

    InvalidUnsignedPayload error is thrown when the unsigned payload is invalid.

    -

    Hierarchy

    • Error
      • InvalidUnsignedPayloadError

    Constructors

    constructor +

    Hierarchy

    • Error
      • InvalidUnsignedPayloadError

    Constructors

    constructor

    Properties

    cause? message name @@ -10,7 +10,7 @@

    Methods

    captureStackTrace

    Constructors

    constructor

    Properties

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static DEFAULT_MESSAGE

    DEFAULT_MESSAGE: string = "Invalid unsigned payload"

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidUnsignedPayloadError

    Properties

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static DEFAULT_MESSAGE

    DEFAULT_MESSAGE: string = "Invalid unsigned payload"

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any

      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    Static stackTraceLimit

    stackTraceLimit: number

    Methods

    Static captureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcausemessagenamestackDEFAULT_MESSAGEprepareStackTracestackTraceLimitcaptureStackTrace
    \ No newline at end of file diff --git a/docs/classes/coinbase_errors.NotSignedError.html b/docs/classes/coinbase_errors.NotSignedError.html index beb9679c..903d9b61 100644 --- a/docs/classes/coinbase_errors.NotSignedError.html +++ b/docs/classes/coinbase_errors.NotSignedError.html @@ -1,5 +1,5 @@ NotSignedError | @coinbase/coinbase-sdk

    Class NotSignedError

    NotSignedError is thrown when a resource is not signed.

    -

    Hierarchy

    • Error
      • NotSignedError

    Constructors

    constructor +

    Hierarchy

    • Error
      • NotSignedError

    Constructors

    constructor

    Properties

    cause? message name @@ -9,7 +9,7 @@

    Methods

    captureStackTrace

    Constructors

    constructor

    Properties

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns NotSignedError

    Properties

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any

      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    Static stackTraceLimit

    stackTraceLimit: number

    Methods

    Static captureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcausemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
    \ No newline at end of file diff --git a/docs/classes/coinbase_errors.TimeoutError.html b/docs/classes/coinbase_errors.TimeoutError.html index 9205187e..91d8c342 100644 --- a/docs/classes/coinbase_errors.TimeoutError.html +++ b/docs/classes/coinbase_errors.TimeoutError.html @@ -1,5 +1,5 @@ TimeoutError | @coinbase/coinbase-sdk

    Class TimeoutError

    TimeoutError is thrown when an operation times out.

    -

    Hierarchy

    • Error
      • TimeoutError

    Constructors

    constructor +

    Hierarchy

    • Error
      • TimeoutError

    Constructors

    constructor

    Properties

    cause? message name @@ -9,7 +9,7 @@

    Methods

    captureStackTrace

    Constructors

    constructor

    Properties

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns TimeoutError

    Properties

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any

      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    Static stackTraceLimit

    stackTraceLimit: number

    Methods

    Static captureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcausemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
    \ No newline at end of file diff --git a/docs/classes/coinbase_faucet_transaction.FaucetTransaction.html b/docs/classes/coinbase_faucet_transaction.FaucetTransaction.html index 45ee0f38..520065d1 100644 --- a/docs/classes/coinbase_faucet_transaction.FaucetTransaction.html +++ b/docs/classes/coinbase_faucet_transaction.FaucetTransaction.html @@ -1,5 +1,5 @@ FaucetTransaction | @coinbase/coinbase-sdk

    Class FaucetTransaction

    Represents a transaction from a faucet.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    model

    Methods

    getTransactionHash getTransactionLink @@ -8,10 +8,10 @@ Do not use this method directly - instead, use Address.faucet().

    Parameters

    Returns FaucetTransaction

    Throws

    If the model does not exist.

    -

    Properties

    Private model

    model: FaucetTransaction

    Methods

    getTransactionHash

    Properties

    Private model

    model: FaucetTransaction

    Methods

    getTransactionHash

    getTransactionLink

    getTransactionLink

    • getTransactionLink(): string

    • Returns the link to the transaction on the blockchain explorer.

      Returns string

      The link to the transaction on the blockchain explorer

      -

    toString

    toString

    • toString(): string

    • Returns a string representation of the FaucetTransaction.

      Returns string

      A string representation of the FaucetTransaction.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    constructormodelgetTransactionHashgetTransactionLinktoString
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    constructormodelgetTransactionHashgetTransactionLinktoString
    \ No newline at end of file diff --git a/docs/classes/coinbase_historical_balance.HistoricalBalance.html b/docs/classes/coinbase_historical_balance.HistoricalBalance.html index c37aa417..d8a52814 100644 --- a/docs/classes/coinbase_historical_balance.HistoricalBalance.html +++ b/docs/classes/coinbase_historical_balance.HistoricalBalance.html @@ -1,10 +1,10 @@ HistoricalBalance | @coinbase/coinbase-sdk

    Class HistoricalBalance

    A representation of historical balance.

    -

    Properties

    amount +

    Properties

    amount asset blockHash blockHeight

    Methods

    fromModel -

    Properties

    Readonly amount

    amount: Decimal

    Readonly asset

    asset: Asset

    Readonly blockHash

    blockHash: string

    Readonly blockHeight

    blockHeight: Decimal

    Methods

    Static fromModel

    • fromModel(model): HistoricalBalance

    • Converts a HistoricalBalanceModel into a HistoricalBalance object.

      +

    Properties

    Readonly amount

    amount: Decimal

    Readonly asset

    asset: Asset

    Readonly blockHash

    blockHash: string

    Readonly blockHeight

    blockHeight: Decimal

    Methods

    Static fromModel

    Settings

    Member Visibility

    Theme

    On This Page

    amountassetblockHashblockHeightfromModel
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    amountassetblockHashblockHeightfromModel
    \ No newline at end of file diff --git a/docs/classes/coinbase_payload_signature.PayloadSignature.html b/docs/classes/coinbase_payload_signature.PayloadSignature.html index 87aa31bd..1c65f8ff 100644 --- a/docs/classes/coinbase_payload_signature.PayloadSignature.html +++ b/docs/classes/coinbase_payload_signature.PayloadSignature.html @@ -1,5 +1,5 @@ PayloadSignature | @coinbase/coinbase-sdk

    Class PayloadSignature

    A representation of a Payload Signature.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    model

    Methods

    getAddressId getId @@ -13,28 +13,28 @@ wait

    Constructors

    constructor

    Properties

    Private model

    model: PayloadSignature

    Methods

    getAddressId

    • getAddressId(): string

    • Returns the Address ID of the Payload Signature.

      +

    Returns PayloadSignature

    Properties

    Private model

    model: PayloadSignature

    Methods

    getAddressId

    getId

    getId

    getSignature

    getSignature

    getStatus

    getStatus

    getUnsignedPayload

    getUnsignedPayload

    getWalletId

    getWalletId

    isTerminalState

    isTerminalState

    • isTerminalState(): boolean

    • Returns whether the Payload Signature is in a terminal State.

      Returns boolean

      Whether the Payload Signature is in a terminal State

      -

    reload

    reload

    • reload(): Promise<void>

    • Reloads the Payload Signature model with the latest data from the server.

      Returns Promise<void>

      Throws

      if the API request to get a Payload Signature fails.

      -

    toString

    toString

    • toString(): string

    • Returns a string representation of the Payload Signature.

      Returns string

      A string representation of the Payload Signature.

      -

    wait

    wait

    • wait(options?): Promise<PayloadSignature>

    • Waits for the Payload Signature to be signed or for the signature operation to fail.

      Parameters

      • options: {
            intervalSeconds: undefined | number;
            timeoutSeconds: undefined | number;
        } = {}

        The options to configure the wait function.

        • intervalSeconds: undefined | number

          The interval to check the status of the Payload Signature.

        • timeoutSeconds: undefined | number

          The maximum time to wait for the Payload Signature to be confirmed.

      Returns Promise<PayloadSignature>

      The Payload Signature object in a terminal state.

      Throws

      if the Payload Signature times out.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    constructormodelgetAddressIdgetIdgetSignaturegetStatusgetUnsignedPayloadgetWalletIdisTerminalStatereloadtoStringwait
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    constructormodelgetAddressIdgetIdgetSignaturegetStatusgetUnsignedPayloadgetWalletIdisTerminalStatereloadtoStringwait
    \ No newline at end of file diff --git a/docs/classes/coinbase_server_signer.ServerSigner.html b/docs/classes/coinbase_server_signer.ServerSigner.html index 487e8a9c..3541f965 100644 --- a/docs/classes/coinbase_server_signer.ServerSigner.html +++ b/docs/classes/coinbase_server_signer.ServerSigner.html @@ -1,17 +1,17 @@ ServerSigner | @coinbase/coinbase-sdk

    Class ServerSigner

    A representation of a Server-Signer. Server-Signers are assigned to sign transactions for a Wallet.

    -

    Properties

    model +

    Properties

    model

    Methods

    getId getWallets toString getDefault -

    Properties

    Private model

    model: ServerSigner

    Methods

    getId

    • getId(): string

    • Returns the ID of the Server-Signer.

      +

    Properties

    Private model

    model: ServerSigner

    Methods

    getId

    getWallets

    getWallets

    • getWallets(): undefined | string[]

    • Returns the IDs of the Wallet's the Server-Signer can sign for.

      Returns undefined | string[]

      The Wallet IDs.

      -

    toString

    toString

    • toString(): string

    • Returns a String representation of the Server-Signer.

      Returns string

      a String representation of the Server-Signer.

      -

    Static getDefault

    Static getDefault

    • getDefault(): Promise<ServerSigner>

    • Returns the default Server-Signer for the CDP Project.

      Returns Promise<ServerSigner>

      The default Server-Signer.

      Throws

      if the API request to list Server-Signers fails.

      Throws

      if there is no Server-Signer associated with the CDP Project.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    modelgetIdgetWalletstoStringgetDefault
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    modelgetIdgetWalletstoStringgetDefault
    \ No newline at end of file diff --git a/docs/classes/coinbase_smart_contract.SmartContract.html b/docs/classes/coinbase_smart_contract.SmartContract.html index 54fc6bf6..24b01dc6 100644 --- a/docs/classes/coinbase_smart_contract.SmartContract.html +++ b/docs/classes/coinbase_smart_contract.SmartContract.html @@ -1,5 +1,5 @@ SmartContract | @coinbase/coinbase-sdk

    Class SmartContract

    A representation of a SmartContract on the blockchain.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    model

    Methods

    broadcast getAbi @@ -21,44 +21,44 @@ listEvents

    Constructors

    constructor

    Properties

    Private model

    model: SmartContract

    Methods

    broadcast

    • broadcast(): Promise<SmartContract>

    • Broadcasts the SmartContract deployment to the Network.

      +

    Returns SmartContract

    Properties

    Private model

    model: SmartContract

    Methods

    broadcast

    getAbi

    getAbi

    getContractAddress

    getContractAddress

    getDeployerAddress

    getDeployerAddress

    getId

    getId

    getNetworkId

    getNetworkId

    getOptions

    getOptions

    getTransaction

    getTransaction

    getType

    getType

    getWalletId

    getWalletId

    Private isERC20

    Private isERC20

    Private isERC721

    Private isERC721

    reload

    reload

    • reload(): Promise<void>

    • Reloads the SmartContract model with the latest data from the server.

      Returns Promise<void>

      Throws

      if the API request to get a SmartContract fails.

      -

    sign

    sign

    • sign(key): Promise<string>

    • Signs the SmartContract deployment with the provided key and returns the hex signature required for broadcasting the SmartContract deployment.

      Parameters

      • key: Wallet

        The key to sign the SmartContract deployment with

      Returns Promise<string>

      The hex-encoded signed payload

      -

    toString

    toString

    • toString(): string

    • Returns a string representation of the SmartContract.

      Returns string

      The string representation of the SmartContract.

      -

    wait

    wait

    • wait(options?): Promise<SmartContract>

    • Waits for the SmartContract deployment to be confirmed on the Network or fail on chain. Waits until the SmartContract deployment is completed or failed on-chain by polling at the given interval. Raises an error if the SmartContract deployment takes longer than the given timeout.

      Parameters

      • options: {
            intervalSeconds: undefined | number;
            timeoutSeconds: undefined | number;
        } = {}

        The options to configure the wait function.

        @@ -66,10 +66,10 @@
      • timeoutSeconds: undefined | number

        The maximum time to wait for the SmartContract deployment to be confirmed.

    Returns Promise<SmartContract>

    The SmartContract object in a terminal state.

    Throws

    if the SmartContract deployment times out.

    -

    Static fromModel

    Static fromModel

    Static listEvents

    • listEvents(networkId, protocolName, contractAddress, contractName, eventName, fromBlockHeight, toBlockHeight): Promise<ContractEvent[]>

    • Returns a list of ContractEvents for the provided network, contract, and event details.

      +

    Static listEvents

    • listEvents(networkId, protocolName, contractAddress, contractName, eventName, fromBlockHeight, toBlockHeight): Promise<ContractEvent[]>

    • Returns a list of ContractEvents for the provided network, contract, and event details.

      Parameters

      • networkId: string

        The network ID.

      • protocolName: string

        The protocol name.

      • contractAddress: string

        The contract address.

        @@ -78,4 +78,4 @@
      • fromBlockHeight: number

        The start block height.

      • toBlockHeight: number

        The end block height.

      Returns Promise<ContractEvent[]>

      The contract events.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    constructormodelbroadcastgetAbigetContractAddressgetDeployerAddressgetIdgetNetworkIdgetOptionsgetTransactiongetTypegetWalletIdisERC20isERC721reloadsigntoStringwaitfromModellistEvents
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    constructormodelbroadcastgetAbigetContractAddressgetDeployerAddressgetIdgetNetworkIdgetOptionsgetTransactiongetTypegetWalletIdisERC20isERC721reloadsigntoStringwaitfromModellistEvents
    \ No newline at end of file diff --git a/docs/classes/coinbase_sponsored_send.SponsoredSend.html b/docs/classes/coinbase_sponsored_send.SponsoredSend.html index 6cbf72e2..cb2cb9a6 100644 --- a/docs/classes/coinbase_sponsored_send.SponsoredSend.html +++ b/docs/classes/coinbase_sponsored_send.SponsoredSend.html @@ -1,5 +1,5 @@ SponsoredSend | @coinbase/coinbase-sdk

    Class SponsoredSend

    A representation of an onchain Sponsored Send.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    model

    Methods

    getSignature getStatus @@ -12,24 +12,24 @@ toString

    Constructors

    constructor

    Properties

    Private model

    model: SponsoredSend

    Methods

    getSignature

    • getSignature(): undefined | string

    • Returns the signature of the typed data.

      +

    Returns SponsoredSend

    Properties

    Private model

    model: SponsoredSend

    Methods

    getSignature

    • getSignature(): undefined | string

    • Returns the signature of the typed data.

      Returns undefined | string

      The hash of the typed data signature.

      -

    getStatus

    getStatus

    getTransactionHash

    getTransactionHash

    • getTransactionHash(): undefined | string

    • Returns the Transaction Hash of the Sponsored Send.

      Returns undefined | string

      The Transaction Hash

      -

    getTransactionLink

    getTransactionLink

    • getTransactionLink(): undefined | string

    • Returns the link to the Sponsored Send on the blockchain explorer.

      Returns undefined | string

      The link to the Sponsored Send on the blockchain explorer

      -

    getTypedDataHash

    getTypedDataHash

    • getTypedDataHash(): string

    • Returns the Keccak256 hash of the typed data. This payload must be signed by the sender to be used as an approval in the EIP-3009 transaction.

      Returns string

      The Keccak256 hash of the typed data.

      -

    isSigned

    isSigned

    • isSigned(): boolean

    • Returns whether the Sponsored Send has been signed.

      Returns boolean

      if the Sponsored Send has been signed.

      -

    isTerminalState

    isTerminalState

    • isTerminalState(): boolean

    • Returns whether the Sponsored Send is in a terminal State.

      Returns boolean

      Whether the Sponsored Send is in a terminal State

      -

    sign

    sign

    • sign(key): Promise<string>

    • Signs the Sponsored Send with the provided key and returns the hex signature.

      Parameters

      • key: Wallet

        The key to sign the Sponsored Send with

      Returns Promise<string>

      The hex-encoded signature

      -

    toString

    toString

    • toString(): string

    • Returns a string representation of the Sponsored Send.

      Returns string

      A string representation of the Sponsored Send

      -

    Settings

    Member Visibility

    Theme

    On This Page

    constructormodelgetSignaturegetStatusgetTransactionHashgetTransactionLinkgetTypedDataHashisSignedisTerminalStatesigntoString
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    constructormodelgetSignaturegetStatusgetTransactionHashgetTransactionLinkgetTypedDataHashisSignedisTerminalStatesigntoString
    \ No newline at end of file diff --git a/docs/classes/coinbase_staking_balance.StakingBalance.html b/docs/classes/coinbase_staking_balance.StakingBalance.html index 9df2e359..0511c827 100644 --- a/docs/classes/coinbase_staking_balance.StakingBalance.html +++ b/docs/classes/coinbase_staking_balance.StakingBalance.html @@ -1,5 +1,5 @@ StakingBalance | @coinbase/coinbase-sdk

    Class StakingBalance

    A representation of the staking balance for a given asset on a specific date.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    model

    Methods

    address bondedStake @@ -10,23 +10,23 @@ list

    Constructors

    constructor

    Properties

    Private model

    model: StakingBalance

    Methods

    address

    • address(): string

    • Returns the onchain address of the StakingBalance.

      +

    Returns StakingBalance

    Properties

    Private model

    model: StakingBalance

    Methods

    address

    bondedStake

    bondedStake

    date

    date

    participantType

    participantType

    toString

    toString

    unbondedBalance

    unbondedBalance

    Static list

    Static list

    • list(networkId, assetId, addressId, startTime, endTime): Promise<StakingBalance[]>

    • Returns a list of StakingBalances for the provided network, asset, and address.

      Parameters

      • networkId: string

        The network ID.

      • assetId: string

        The asset ID.

      • addressId: string

        The address ID.

      • startTime: string

        The start time.

      • endTime: string

        The end time.

      Returns Promise<StakingBalance[]>

      The staking balances.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    constructormodeladdressbondedStakedateparticipantTypetoStringunbondedBalancelist
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    constructormodeladdressbondedStakedateparticipantTypetoStringunbondedBalancelist
    \ No newline at end of file diff --git a/docs/classes/coinbase_staking_operation.StakingOperation.html b/docs/classes/coinbase_staking_operation.StakingOperation.html index 51010694..1159eb06 100644 --- a/docs/classes/coinbase_staking_operation.StakingOperation.html +++ b/docs/classes/coinbase_staking_operation.StakingOperation.html @@ -1,6 +1,6 @@ StakingOperation | @coinbase/coinbase-sdk

    Class StakingOperation

    A representation of a staking operation (stake, unstake, claim stake, etc.). It may have multiple steps with some being transactions to sign, and others to wait.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    model transactions

    Methods

    getAddressID @@ -21,53 +21,53 @@ fetch

    Constructors

    constructor

    Properties

    Private model

    model: StakingOperation

    Private Readonly transactions

    transactions: Transaction[]

    Methods

    getAddressID

    • getAddressID(): string

    • Returns the Address ID.

      +

    Returns StakingOperation

    Properties

    Private model

    model: StakingOperation

    Private Readonly transactions

    transactions: Transaction[]

    Methods

    getAddressID

    getID

    getID

    getNetworkID

    getNetworkID

    getSignedVoluntaryExitMessages

    getSignedVoluntaryExitMessages

    • getSignedVoluntaryExitMessages(): string[]

    • Get signed voluntary exit messages for native eth unstaking

      Returns string[]

      The signed voluntary exit messages for a native eth unstaking operation.

      -

    getStatus

    getStatus

    getTransactions

    getTransactions

    getWalletID

    getWalletID

    isCompleteState

    isCompleteState

    • isCompleteState(): boolean

    • Returns whether the Staking operation is in a complete state.

      Returns boolean

      Whether the Staking operation is in a complete state.

      -

    isFailedState

    isFailedState

    • isFailedState(): boolean

    • Returns whether the Staking operation is in a failed state.

      Returns boolean

      Whether the Staking operation is in a failed state.

      -

    isTerminalState

    isTerminalState

    • isTerminalState(): boolean

    • Returns whether the Staking operation is in a terminal State.

      Returns boolean

      Whether the Staking operation is in a terminal State

      -

    Private loadTransactionsFromModel

    Private loadTransactionsFromModel

    • loadTransactionsFromModel(): void

    • loadTransactionsFromModel loads new unsigned transactions from the model into the transactions array. Note: For External Address model since tx signing and broadcast status happens by the end user and not our backend we need to be careful to not overwrite the transactions array with the response from the API. Ex: End user could have used stakingOperation.sign() method to sign the transactions, and we should not overwrite them with the response from the API. This however is ok to do so for the Wallet Address model since the transactions states are maintained by our backend. This method attempts to be safe for both address models, and only adds newly created unsigned transactions that are not already in the transactions array.

      -

      Returns void

    reload

    reload

    • reload(): Promise<void>

    • Reloads the StakingOperation model with the latest data from the server. If the StakingOperation object was created by an ExternalAddress then it will not have a wallet ID.

      Returns Promise<void>

      Throws

      if the API request to get the StakingOperation fails.

      Throws

      if this function is called on a StakingOperation without a wallet ID.

      -

    sign

    sign

    • sign(key): Promise<void>

    • Sign the transactions in the StakingOperation object.

      Parameters

      • key: Wallet

        The key used to sign the transactions.

        -

      Returns Promise<void>

    toString

    • toString(): string

    • Return a human-readable string representation of the StakingOperation object.

      +

    Returns Promise<void>

    toString

    • toString(): string

    • Return a human-readable string representation of the StakingOperation object.

      Returns string

      The string representation of the StakingOperation object.

      -

    wait

    wait

    • wait(options?): Promise<StakingOperation>

    • Waits until the Staking Operation is completed or failed by polling its status at the given interval.

      Parameters

      • options: {
            intervalSeconds: undefined | number;
            timeoutSeconds: undefined | number;
        } = {}

        The options to configure the wait function.

        • intervalSeconds: undefined | number

          The interval at which to poll, in seconds

        • timeoutSeconds: undefined | number

          The maximum amount of time to wait for the StakingOperation to complete, in seconds

      Returns Promise<StakingOperation>

      The completed StakingOperation object.

      Throws

      If the StakingOperation takes longer than the given timeout.

      -

    Static fetch

    Static fetch

    • fetch(networkId, addressId, id, walletId?): Promise<StakingOperation>

    • Get the staking operation for the given ID.

      Parameters

      • networkId: string

        The network ID.

      • addressId: string

        The address ID.

      • id: string

        The staking operation ID.

      • Optional walletId: string

        The wallet ID of the staking operation.

      Returns Promise<StakingOperation>

      The staking operation object.

      Throws

      If the wallet id is defined but empty.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    constructormodeltransactionsgetAddressIDgetIDgetNetworkIDgetSignedVoluntaryExitMessagesgetStatusgetTransactionsgetWalletIDisCompleteStateisFailedStateisTerminalStateloadTransactionsFromModelreloadsigntoStringwaitfetch
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    constructormodeltransactionsgetAddressIDgetIDgetNetworkIDgetSignedVoluntaryExitMessagesgetStatusgetTransactionsgetWalletIDisCompleteStateisFailedStateisTerminalStateloadTransactionsFromModelreloadsigntoStringwaitfetch
    \ No newline at end of file diff --git a/docs/classes/coinbase_staking_reward.StakingReward.html b/docs/classes/coinbase_staking_reward.StakingReward.html index 14653aa3..2dc2ad1e 100644 --- a/docs/classes/coinbase_staking_reward.StakingReward.html +++ b/docs/classes/coinbase_staking_reward.StakingReward.html @@ -1,5 +1,5 @@ StakingReward | @coinbase/coinbase-sdk

    Class StakingReward

    A representation of a staking reward earned on a network for a given asset.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    asset format model @@ -15,21 +15,21 @@

    Parameters

    • model: StakingReward

      The underlying staking reward object.

    • asset: Asset

      The asset for the staking reward.

    • format: StakingRewardFormat

      The format to return the rewards in. (usd, native). Defaults to usd.

      -

    Returns StakingReward

    Properties

    Private asset

    asset: Asset

    Private Readonly format

    format: StakingRewardFormat

    Private model

    model: StakingReward

    Methods

    addressId

    • addressId(): string

    • Returns the onchain address of the StakingReward.

      +

    Returns StakingReward

    Properties

    Private asset

    asset: Asset

    Private Readonly format

    format: StakingRewardFormat

    Private model

    model: StakingReward

    Methods

    addressId

    amount

    amount

    conversionPrice

    conversionPrice

    conversionTime

    conversionTime

    date

    date

    toString

    toString

    usdValue

    usdValue

    Static list

    Static list

    • list(networkId, assetId, addressIds, startTime, endTime, format?): Promise<StakingReward[]>

    • Returns a list of StakingRewards for the provided network, asset, and addresses.

      Parameters

      • networkId: string

        The network ID.

      • assetId: string

        The asset ID.

      • addressIds: string[]

        The address ID.

        @@ -37,4 +37,4 @@
      • endTime: string

        The end time.

      • format: StakingRewardFormat = StakingRewardFormat.USD

        The format to return the rewards in. (usd, native). Defaults to usd.

      Returns Promise<StakingReward[]>

      The staking rewards.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorassetformatmodeladdressIdamountconversionPriceconversionTimedatetoStringusdValuelist
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    constructorassetformatmodeladdressIdamountconversionPriceconversionTimedatetoStringusdValuelist
    \ No newline at end of file diff --git a/docs/classes/coinbase_trade.Trade.html b/docs/classes/coinbase_trade.Trade.html index 2d052bfa..6cd83357 100644 --- a/docs/classes/coinbase_trade.Trade.html +++ b/docs/classes/coinbase_trade.Trade.html @@ -1,6 +1,6 @@ Trade | @coinbase/coinbase-sdk

    Class Trade

    A representation of a Trade, which trades an amount of an Asset to another Asset on a Network. The fee is assumed to be paid in the native Asset of the Network.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    approveTransaction? model transaction? @@ -26,42 +26,42 @@

    Returns Trade

    Throws

    • If the Trade model is empty.
    -

    Properties

    Private Optional approveTransaction

    approveTransaction?: Transaction

    Private model

    model: Trade

    Private Optional transaction

    transaction?: Transaction

    Methods

    broadcast

    Properties

    Private Optional approveTransaction

    approveTransaction?: Transaction

    Private model

    model: Trade

    Private Optional transaction

    transaction?: Transaction

    Methods

    broadcast

    • broadcast(): Promise<Trade>

    • Broadcasts the Trade to the Network.

      Returns Promise<Trade>

      The Trade object

      Throws

      if the API request to broadcast a Trade fails.

      -

    getAddressId

    getAddressId

    • getAddressId(): string

    • Returns the Address ID of the Trade.

      Returns string

      The Address ID.

      -

    getApproveTransaction

    getApproveTransaction

    getFromAmount

    getFromAmount

    • getFromAmount(): Decimal

    • Returns the amount of the from asset for the Trade.

      Returns Decimal

      The amount of the from asset.

      -

    getFromAssetId

    getFromAssetId

    • getFromAssetId(): string

    • Returns the From Asset ID of the Trade.

      Returns string

      The From Asset ID.

      -

    getId

    getId

    getNetworkId

    getNetworkId

    • getNetworkId(): string

    • Returns the Network ID of the Trade.

      Returns string

      The Network ID.

      -

    getStatus

    getStatus

    getToAmount

    getToAmount

    • getToAmount(): Decimal

    • Returns the amount of the to asset for the Trade.

      Returns Decimal

      The amount of the to asset.

      -

    getToAssetId

    getToAssetId

    • getToAssetId(): string

    • Returns the To Asset ID of the Trade.

      Returns string

      The To Asset ID.

      -

    getTransaction

    getTransaction

    getWalletId

    getWalletId

    • getWalletId(): string

    • Returns the Wallet ID of the Trade.

      Returns string

      The Wallet ID.

      -

    reload

    reload

    • reload(): Promise<Trade>

    • Reloads the Trade model with the latest version from the server side.

      Returns Promise<Trade>

      The most recent version of Trade from the server.

      -

    Private resetModel

    Private resetModel

    • resetModel(model): Trade

    • Resets the trade model with the specified data from the server.

      Parameters

      • model: Trade

        The Trade model

      Returns Trade

      The updated Trade object

      -

    sign

    sign

    • sign(key): Promise<void>

    • Signs the Trade with the provided key. This signs the transfer transaction and will sign the approval transaction if present.

      Parameters

      • key: Wallet

        The key to sign the Transfer with

        -

      Returns Promise<void>

    toString

    • toString(): string

    • Returns a String representation of the Trade.

      +

    Returns Promise<void>

    toString

    • toString(): string

    • Returns a String representation of the Trade.

      Returns string

      A String representation of the Trade.

      -

    wait

    • wait(options?): Promise<Trade>

    • Waits until the Trade is completed or failed by polling the Network at the given interval. +

    wait

    • wait(options?): Promise<Trade>

    • Waits until the Trade is completed or failed by polling the Network at the given interval. Raises an error if the Trade takes longer than the given timeout.

      Parameters

      • options: {
            intervalSeconds: undefined | number;
            timeoutSeconds: undefined | number;
        } = {}

        The options to configure the wait function.

        • intervalSeconds: undefined | number

          The interval at which to poll the Network, in seconds

          @@ -69,4 +69,4 @@

      Returns Promise<Trade>

      The completed Trade object.

      Throws

      If the Trade takes longer than the given timeout.

      Throws

      If the request fails.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorapproveTransactionmodeltransactionbroadcastgetAddressIdgetApproveTransactiongetFromAmountgetFromAssetIdgetIdgetNetworkIdgetStatusgetToAmountgetToAssetIdgetTransactiongetWalletIdreloadresetModelsigntoStringwait
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    constructorapproveTransactionmodeltransactionbroadcastgetAddressIdgetApproveTransactiongetFromAmountgetFromAssetIdgetIdgetNetworkIdgetStatusgetToAmountgetToAssetIdgetTransactiongetWalletIdreloadresetModelsigntoStringwait
    \ No newline at end of file diff --git a/docs/classes/coinbase_transaction.Transaction.html b/docs/classes/coinbase_transaction.Transaction.html index 0d92aabd..f62e0024 100644 --- a/docs/classes/coinbase_transaction.Transaction.html +++ b/docs/classes/coinbase_transaction.Transaction.html @@ -1,5 +1,5 @@ Transaction | @coinbase/coinbase-sdk

    Class Transaction

    A representation of an onchain Transaction.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    model raw?

    Methods

    blockHash @@ -20,38 +20,38 @@ toString

    Constructors

    constructor

    Properties

    Private model

    model: Transaction

    Private Optional raw

    raw?: Transaction

    Methods

    blockHash

    • blockHash(): undefined | string

    • Returns the Block Hash where the Transaction is recorded.

      +

    Returns Transaction

    Properties

    Private model

    model: Transaction

    Private Optional raw

    raw?: Transaction

    Methods

    blockHash

    • blockHash(): undefined | string

    • Returns the Block Hash where the Transaction is recorded.

      Returns undefined | string

      The Block Hash

      -

    blockHeight

    blockHeight

    • blockHeight(): undefined | string

    • Returns the Block Height where the Transaction is recorded.

      Returns undefined | string

      The Block Height

      -

    content

    content

    fromAddressId

    fromAddressId

    getSignature

    getSignature

    • getSignature(): undefined | string

    • Returns the Signed Payload of the Transaction.

      Returns undefined | string

      The Signed Payload

      -

    getSignedPayload

    getSignedPayload

    • getSignedPayload(): undefined | string

    • Returns the Signed Payload of the Transaction.

      Returns undefined | string

      The Signed Payload

      -

    getStatus

    getStatus

    getTransactionHash

    getTransactionHash

    • getTransactionHash(): undefined | string

    • Returns the Transaction Hash of the Transaction.

      Returns undefined | string

      The Transaction Hash

      -

    getTransactionLink

    getTransactionLink

    • getTransactionLink(): string

    • Returns the link to the Transaction on the blockchain explorer.

      Returns string

      The link to the Transaction on the blockchain explorer

      -

    getUnsignedPayload

    getUnsignedPayload

    • getUnsignedPayload(): string

    • Returns the Unsigned Payload of the Transaction.

      Returns string

      The Unsigned Payload

      -

    isSigned

    isSigned

    • isSigned(): boolean

    • Returns whether the transaction has been signed.

      Returns boolean

      if the transaction has been signed.

      -

    isTerminalState

    isTerminalState

    • isTerminalState(): boolean

    • Returns whether the Transaction is in a terminal State.

      Returns boolean

      Whether the Transaction is in a terminal State

      -

    rawTransaction

    rawTransaction

    • rawTransaction(): Transaction

    • Returns the underlying raw transaction.

      Returns Transaction

      The ethers.js Transaction object

      Throws

      If the Unsigned Payload is invalid.

      -

    sign

    sign

    • sign(key): Promise<string>

    • Signs the Transaction with the provided key and returns the hex signing payload.

      Parameters

      • key: Wallet

        The key to sign the transaction with

      Returns Promise<string>

      The hex-encoded signed payload

      -

    toAddressId

    toAddressId

    • toAddressId(): undefined | string

    • Returns the To Address ID for the Transaction if it's available.

      Returns undefined | string

      The To Address ID

      -

    toString

    toString

    • toString(): string

    • Returns a string representation of the Transaction.

      Returns string

      A string representation of the Transaction.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    constructormodelrawblockHashblockHeightcontentfromAddressIdgetSignaturegetSignedPayloadgetStatusgetTransactionHashgetTransactionLinkgetUnsignedPayloadisSignedisTerminalStaterawTransactionsigntoAddressIdtoString
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    constructormodelrawblockHashblockHeightcontentfromAddressIdgetSignaturegetSignedPayloadgetStatusgetTransactionHashgetTransactionLinkgetUnsignedPayloadisSignedisTerminalStaterawTransactionsigntoAddressIdtoString
    \ No newline at end of file diff --git a/docs/classes/coinbase_transfer.Transfer.html b/docs/classes/coinbase_transfer.Transfer.html index 8b52996f..19d6d58b 100644 --- a/docs/classes/coinbase_transfer.Transfer.html +++ b/docs/classes/coinbase_transfer.Transfer.html @@ -1,7 +1,7 @@ Transfer | @coinbase/coinbase-sdk

    Class Transfer

    A representation of a Transfer, which moves an Amount of an Asset from a user-controlled Wallet to another Address. The fee is assumed to be paid in the native Asset of the Network.

    -

    Properties

    model +

    Properties

    model

    Methods

    broadcast getAmount getAssetId @@ -22,47 +22,47 @@ toString wait fromModel -

    Properties

    Private model

    model: Transfer

    Methods

    broadcast

    • broadcast(): Promise<Transfer>

    • Broadcasts the Transfer to the Network.

      +

    Properties

    Private model

    model: Transfer

    Methods

    broadcast

    getAmount

    getAmount

    getAssetId

    getAssetId

    getDestinationAddressId

    getDestinationAddressId

    • getDestinationAddressId(): string

    • Returns the Destination Address ID of the Transfer.

      Returns string

      The Destination Address ID.

      -

    getFromAddressId

    getFromAddressId

    • getFromAddressId(): string

    • Returns the From Address ID of the Transfer.

      Returns string

      The From Address ID.

      -

    getId

    getId

    getNetworkId

    getNetworkId

    getRawTransaction

    getRawTransaction

    • getRawTransaction(): undefined | Transaction

    • Returns the Transaction of the Transfer.

      Returns undefined | Transaction

      The ethers.js Transaction object.

      Throws

      (InvalidUnsignedPayload) If the Unsigned Payload is invalid.

      -

    getSendTransactionDelegate

    getSendTransactionDelegate

    getSponsoredSend

    getSponsoredSend

    getStatus

    getStatus

    getTransaction

    getTransaction

    getTransactionHash

    getTransactionHash

    • getTransactionHash(): undefined | string

    • Returns the Transaction Hash of the Transfer.

      Returns undefined | string

      The Transaction Hash as a Hex string, or undefined if not yet available.

      -

    getTransactionLink

    • getTransactionLink(): undefined | string

    • Returns the link to the Transaction on the blockchain explorer.

      +

    getTransactionLink

    • getTransactionLink(): undefined | string

    • Returns the link to the Transaction on the blockchain explorer.

      Returns undefined | string

      The link to the Transaction on the blockchain explorer.

      -

    getWalletId

    getWalletId

    reload

    reload

    • reload(): Promise<void>

    • Reloads the Transfer model with the latest data from the server.

      Returns Promise<void>

      Throws

      if the API request to get a Transfer fails.

      -

    sign

    sign

    • sign(key): Promise<string>

    • Signs the Transfer with the provided key and returns the hex signature required for broadcasting the Transfer.

      Parameters

      • key: Wallet

        The key to sign the Transfer with

      Returns Promise<string>

      The hex-encoded signed payload

      -

    toString

    toString

    • toString(): string

    • Returns a string representation of the Transfer.

      Returns string

      The string representation of the Transfer.

      -

    wait

    wait

    • wait(options?): Promise<Transfer>

    • Waits for the Transfer to be confirmed on the Network or fail on chain. Waits until the Transfer is completed or failed on-chain by polling at the given interval. Raises an error if the Trade takes longer than the given timeout.

      Parameters

      • options: {
            intervalSeconds: undefined | number;
            timeoutSeconds: undefined | number;
        } = {}

        The options to configure the wait function.

        @@ -70,7 +70,7 @@
      • timeoutSeconds: undefined | number

        The maximum time to wait for the Transfer to be confirmed.

    Returns Promise<Transfer>

    The Transfer object in a terminal state.

    Throws

    if the Transfer times out.

    -

    Static fromModel

    Static fromModel

    Settings

    Member Visibility

    Theme

    On This Page

    modelbroadcastgetAmountgetAssetIdgetDestinationAddressIdgetFromAddressIdgetIdgetNetworkIdgetRawTransactiongetSendTransactionDelegategetSponsoredSendgetStatusgetTransactiongetTransactionHashgetTransactionLinkgetWalletIdreloadsigntoStringwaitfromModel
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    modelbroadcastgetAmountgetAssetIdgetDestinationAddressIdgetFromAddressIdgetIdgetNetworkIdgetRawTransactiongetSendTransactionDelegategetSponsoredSendgetStatusgetTransactiongetTransactionHashgetTransactionLinkgetWalletIdreloadsigntoStringwaitfromModel
    \ No newline at end of file diff --git a/docs/classes/coinbase_validator.Validator.html b/docs/classes/coinbase_validator.Validator.html index 70e3ae8d..38e7d0f9 100644 --- a/docs/classes/coinbase_validator.Validator.html +++ b/docs/classes/coinbase_validator.Validator.html @@ -1,5 +1,5 @@ Validator | @coinbase/coinbase-sdk

    Class Validator

    A representation of a validator onchain.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    model

    Methods

    getStatus getValidatorId @@ -12,23 +12,23 @@

    Returns Validator

    Throws

    • If the Validator model is empty.
    -

    Properties

    Private model

    model: Validator

    Methods

    getStatus

    Properties

    Private model

    model: Validator

    Methods

    getStatus

    getValidatorId

    getValidatorId

    toString

    toString

    • toString(): string

    • Returns the string representation of the Validator.

      Returns string

      The string representation of the Validator.

      -

    Static fetch

    Static fetch

    • fetch(networkId, assetId, id): Promise<Validator>

    • Returns the details of a specific validator.

      Parameters

      • networkId: string

        The network ID.

      • assetId: string

        The asset ID.

      • id: string

        The unique publicly identifiable id of the validator for which to fetch the data.

      Returns Promise<Validator>

      The requested validator details.

      -

    Static Private getAPIValidatorStatus

    Static Private getAPIValidatorStatus

    Static list

    Static list

    • list(networkId, assetId, status?): Promise<Validator[]>

    • Returns the list of Validators.

      Parameters

      • networkId: string

        The network ID.

      • assetId: string

        The asset ID.

      • Optional status: ValidatorStatus

        The status to filter by.

      Returns Promise<Validator[]>

      The list of Validators.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    constructormodelgetStatusgetValidatorIdtoStringfetchgetAPIValidatorStatuslist
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    constructormodelgetStatusgetValidatorIdtoStringfetchgetAPIValidatorStatuslist
    \ No newline at end of file diff --git a/docs/classes/coinbase_wallet.Wallet.html b/docs/classes/coinbase_wallet.Wallet.html index c6a6a5be..8aa92253 100644 --- a/docs/classes/coinbase_wallet.Wallet.html +++ b/docs/classes/coinbase_wallet.Wallet.html @@ -4,7 +4,7 @@ Wallets should be created using Wallet.create, imported using Wallet.import, or fetched using Wallet.fetch. Existing wallets can be imported with a seed using Wallet.import. Wallets backed by a Server Signer can be fetched with Wallet.fetch and used for signing operations immediately.

    -

    Properties

    addressPathPrefix +

    Properties

    addressPathPrefix addresses master? model @@ -57,27 +57,27 @@ import init listWallets -

    Properties

    Private Readonly addressPathPrefix

    addressPathPrefix: "m/44'/60'/0'/0" = "m/44'/60'/0'/0"

    Private addresses

    addresses: WalletAddress[] = []

    Private Optional master

    master?: HDKey

    Private model

    model: Wallet

    Private Optional seed

    seed?: string

    Static MAX_ADDRESSES

    MAX_ADDRESSES: number = 20

    Methods

    Private buildWalletAddress

    • buildWalletAddress(addressModel, index): WalletAddress

    • Returns a WalletAddress object for the given AddressModel.

      +

    Properties

    Private Readonly addressPathPrefix

    addressPathPrefix: "m/44'/60'/0'/0" = "m/44'/60'/0'/0"

    Private addresses

    addresses: WalletAddress[] = []

    Private Optional master

    master?: HDKey

    Private model

    model: Wallet

    Private Optional seed

    seed?: string

    Static MAX_ADDRESSES

    MAX_ADDRESSES: number = 20

    Methods

    Private buildWalletAddress

    • buildWalletAddress(addressModel, index): WalletAddress

    • Returns a WalletAddress object for the given AddressModel.

      Parameters

      • addressModel: Address

        The AddressModel to build the WalletAddress from.

      • index: number

        The index of the AddressModel.

      Returns WalletAddress

      The WalletAddress object.

      -

    canSign

    • canSign(): boolean

    • Returns whether the Wallet has a seed with which to derive keys and sign transactions.

      +

    canSign

    • canSign(): boolean

    • Returns whether the Wallet has a seed with which to derive keys and sign transactions.

      Returns boolean

      Whether the Wallet has a seed with which to derive keys and sign transactions.

      -

    claimableBalance

    • claimableBalance(asset_id, mode?, options?): Promise<Decimal>

    • Get the claimable balance for the supplied asset.

      +

    claimableBalance

    • claimableBalance(asset_id, mode?, options?): Promise<Decimal>

    • Get the claimable balance for the supplied asset.

      Parameters

      • asset_id: string

        The asset to check claimable balance for.

      • mode: StakeOptionsMode = StakeOptionsMode.DEFAULT

        The staking mode. Defaults to DEFAULT.

      • options: {
            [key: string]: string;
        } = {}

        Additional options for getting the claimable balance.

        • [key: string]: string

      Returns Promise<Decimal>

      The claimable balance.

      Throws

      if the default address is not found.

      -

    createAddress

    createAddress

    Private createAttestation

    • createAttestation(key): string

    • Creates an attestation for the Address currently being created.

      +

    Private createAttestation

    • createAttestation(key): string

    • Creates an attestation for the Address currently being created.

      Parameters

      • key: HDKey

        The key of the Wallet.

      Returns string

      The attestation.

      -

    createClaimStake

    • createClaimStake(amount, assetId, mode?, options?, timeoutSeconds?, intervalSeconds?): Promise<StakingOperation>

    • Creates a staking operation to claim stake, signs it, and broadcasts it on the blockchain.

      +

    createClaimStake

    • createClaimStake(amount, assetId, mode?, options?, timeoutSeconds?, intervalSeconds?): Promise<StakingOperation>

    • Creates a staking operation to claim stake, signs it, and broadcasts it on the blockchain.

      Parameters

      • amount: Amount

        The amount for the staking operation.

      • assetId: string

        The asset for the staking operation.

      • mode: StakeOptionsMode = StakeOptionsMode.DEFAULT

        The staking mode. Defaults to DEFAULT.

        @@ -86,12 +86,12 @@
      • intervalSeconds: number = 0.2

        The amount to check each time for a successful broadcast.

      Returns Promise<StakingOperation>

      The staking operation after it's completed fully.

      Throws

      if the default address is not found.

      -

    createPayloadSignature

    createPayloadSignature

    • createPayloadSignature(unsignedPayload): Promise<PayloadSignature>

    • Creates a Payload Signature.

      Parameters

      • unsignedPayload: string

        The Unsigned Payload to sign.

      Returns Promise<PayloadSignature>

      A promise that resolves to the Payload Signature object.

      Throws

      if the API request to create a Payload Signature fails.

      Throws

      if the default address is not found.

      -

    createStake

    • createStake(amount, assetId, mode?, options?, timeoutSeconds?, intervalSeconds?): Promise<StakingOperation>

    • Creates a staking operation to stake, signs it, and broadcasts it on the blockchain.

      +

    createStake

    • createStake(amount, assetId, mode?, options?, timeoutSeconds?, intervalSeconds?): Promise<StakingOperation>

    • Creates a staking operation to stake, signs it, and broadcasts it on the blockchain.

      Parameters

      • amount: Amount

        The amount for the staking operation.

      • assetId: string

        The asset for the staking operation.

      • mode: StakeOptionsMode = StakeOptionsMode.DEFAULT

        The staking mode. Defaults to DEFAULT.

        @@ -100,19 +100,19 @@

        Throws

        if the default address is not found.

      • intervalSeconds: number = 0.2

        The amount to check each time for a successful broadcast.

      Returns Promise<StakingOperation>

      The staking operation after it's completed fully.

      Throws

      if the default address is not found.

      -

    createTrade

    createTrade

    • createTrade(options): Promise<Trade>

    • Trades the given amount of the given Asset for another Asset. Currently only the default address is used to source the Trade.

      Parameters

      Returns Promise<Trade>

      The created Trade object.

      Throws

      If the default address is not found.

      Throws

      If the private key is not loaded, or if the asset IDs are unsupported, or if there are insufficient funds.

      -

    createTransfer

    • createTransfer(options): Promise<Transfer>

    • Transfers the given amount of the given Asset to the given address. Only same-Network Transfers are supported. +

    createTransfer

    • createTransfer(options): Promise<Transfer>

    • Transfers the given amount of the given Asset to the given address. Only same-Network Transfers are supported. Currently only the default_address is used to source the Transfer.

      Parameters

      Returns Promise<Transfer>

      The created Transfer object.

      Throws

      if the API request to create a Transfer fails.

      Throws

      if the API request to broadcast a Transfer fails.

      -

    createUnstake

    • createUnstake(amount, assetId, mode?, options?, timeoutSeconds?, intervalSeconds?): Promise<StakingOperation>

    • Creates a staking operation to unstake, signs it, and broadcasts it on the blockchain.

      +

    createUnstake

    • createUnstake(amount, assetId, mode?, options?, timeoutSeconds?, intervalSeconds?): Promise<StakingOperation>

    • Creates a staking operation to unstake, signs it, and broadcasts it on the blockchain.

      Parameters

      • amount: Amount

        The amount for the staking operation.

      • assetId: string

        The asset for the staking operation.

      • mode: StakeOptionsMode = StakeOptionsMode.DEFAULT

        The staking mode. Defaults to DEFAULT.

        @@ -121,81 +121,81 @@

        Throws

        if the API request to broadcast a Transfer fails.

      • intervalSeconds: number = 0.2

        The amount to check each time for a successful broadcast.

      Returns Promise<StakingOperation>

      The staking operation after it's completed successfully.

      Throws

      if the default address is not found.

      -

    createWebhook

    • createWebhook(notificationUri): Promise<Webhook>

    • Creates a Webhook for a wallet, monitors all wallet addresses for onchain events.

      +

    createWebhook

    • createWebhook(notificationUri): Promise<Webhook>

    • Creates a Webhook for a wallet, monitors all wallet addresses for onchain events.

      Parameters

      • notificationUri: string

        The URI to which the webhook notifications will be sent.

      Returns Promise<Webhook>

      The newly created webhook instance.

      -

    deployMultiToken

    deployMultiToken

    • deployMultiToken(options): Promise<SmartContract>

    • Deploys an ERC1155 token contract.

      Parameters

      Returns Promise<SmartContract>

      A Promise that resolves to the deployed SmartContract object.

      Throws

      If the private key is not loaded when not using server signer.

      -

    deployNFT

    deployNFT

    • deployNFT(options): Promise<SmartContract>

    • Deploys an ERC721 token contract.

      Parameters

      Returns Promise<SmartContract>

      A Promise that resolves to the deployed SmartContract object.

      Throws

      If the private key is not loaded when not using server signer.

      -

    deployToken

    deployToken

    • deployToken(options): Promise<SmartContract>

    • Deploys an ERC20 token contract.

      Parameters

      Returns Promise<SmartContract>

      A Promise that resolves to the deployed SmartContract object.

      Throws

      If the private key is not loaded when not using server signer.

      -

    Private deriveKey

    Private deriveKey

    • deriveKey(index): HDKey

    • Derives a key for an already registered Address in the Wallet.

      Parameters

      • index: number

        The index of the Address to derive.

      Returns HDKey

      The derived key.

      Throws

      • If the key derivation fails.
      -

    export

    export

    faucet

    faucet

    • faucet(assetId?): Promise<FaucetTransaction>

    • Requests funds from the faucet for the Wallet's default address and returns the faucet transaction. This is only supported on testnet networks.

      Parameters

      • Optional assetId: string

        The ID of the Asset to request from the faucet.

      Returns Promise<FaucetTransaction>

      The successful faucet transaction

      Throws

      If the default address is not found.

      Throws

      If the request fails.

      -

    getAddress

    getAddress

    • getAddress(addressId): Promise<undefined | WalletAddress>

    • Returns the WalletAddress with the given ID.

      Parameters

      • addressId: string

        The ID of the WalletAddress to retrieve.

      Returns Promise<undefined | WalletAddress>

      The WalletAddress.

      -

    getBalance

    • getBalance(assetId): Promise<Decimal>

    • Returns the balance of the provided Asset. Balances are aggregated across all Addresses in the Wallet.

      +

    getBalance

    • getBalance(assetId): Promise<Decimal>

    • Returns the balance of the provided Asset. Balances are aggregated across all Addresses in the Wallet.

      Parameters

      • assetId: string

        The ID of the Asset to retrieve the balance for.

      Returns Promise<Decimal>

      The balance of the Asset.

      -

    getDefaultAddress

    getDefaultAddress

    Private getEncryptionKey

    Private getEncryptionKey

    • getEncryptionKey(): Buffer

    • Gets the key for encrypting seed data.

      Returns Buffer

      The encryption key.

      -

    Private getExistingSeeds

    Private getExistingSeeds

    • getExistingSeeds(filePath): Record<string, SeedData>

    • Loads the seed data from the given file.

      Parameters

      • filePath: string

        The path of the file to load the seed data from

      Returns Record<string, SeedData>

      The seed data

      -

    getId

    getId

    getNetworkId

    getNetworkId

    getServerSignerStatus

    getServerSignerStatus

    historicalStakingBalances

    historicalStakingBalances

    • historicalStakingBalances(assetId, startTime?, endTime?): Promise<StakingBalance[]>

    • Lists the historical staking balances for the address.

      Parameters

      • assetId: string

        The asset ID.

      • startTime: string = ...

        The start time.

      • endTime: string = ...

        The end time.

      Returns Promise<StakingBalance[]>

      The staking balances.

      Throws

      if the default address is not found.

      -

    invokeContract

    invokeContract

    listAddresses

    listAddresses

    listBalances

    listBalances

    • listBalances(): Promise<BalanceMap>

    • Returns the list of balances of this Wallet. Balances are aggregated across all Addresses in the Wallet.

      Returns Promise<BalanceMap>

      The list of balances. The key is the Asset ID, and the value is the balance.

      -

    listHistoricalBalances

    listHistoricalBalances

    loadSeed

    loadSeed

    • loadSeed(filePath): Promise<string>

    • Loads the seed of the Wallet from the given file.

      Parameters

      • filePath: string

        The path of the file to load the seed from

      Returns Promise<string>

      A string indicating the success of the operation

      -

    Private reload

    Private reload

    • reload(): Promise<void>

    • Reloads the Wallet model with the latest data from the server.

      Returns Promise<void>

      Throws

      if the API request to get a Wallet fails.

      -

    saveSeed

    • saveSeed(filePath, encrypt?): string

    • Saves the seed of the Wallet to the given file. Wallets whose seeds are saved this way can be +

    saveSeed

    • saveSeed(filePath, encrypt?): string

    • Saves the seed of the Wallet to the given file. Wallets whose seeds are saved this way can be rehydrated using load_seed. A single file can be used for multiple Wallet seeds. This is an insecure method of storing Wallet seeds and should only be used for development purposes.

      Parameters

      • filePath: string

        The path of the file to save the seed to

        @@ -203,43 +203,43 @@

        Throws

        If the request fails.

        encrypted or not. Data is unencrypted by default.

      Returns string

      A string indicating the success of the operation

      Throws

      If the Wallet does not have a seed

      -

    Private setMasterNode

    • setMasterNode(seed): undefined | HDKey

    • Sets the master node for the given seed, if valid. If the seed is undefined it will set the master node using a random seed.

      +

    Private setMasterNode

    • setMasterNode(seed): undefined | HDKey

    • Sets the master node for the given seed, if valid. If the seed is undefined it will set the master node using a random seed.

      Parameters

      • seed: undefined | string

        The seed to use for the Wallet.

      Returns undefined | HDKey

      The master node for the given seed.

      -

    setSeed

    setSeed

    • setSeed(seed): void

    • Set the seed for the Wallet.

      Parameters

      • seed: string

        The seed to use for the Wallet. Expects a 32-byte hexadecimal with no 0x prefix.

      Returns void

      Throws

      If the seed is empty.

      Throws

      If the seed is already set.

      -

    stakeableBalance

    • stakeableBalance(asset_id, mode?, options?): Promise<Decimal>

    • Get the stakeable balance for the supplied asset.

      +

    stakeableBalance

    • stakeableBalance(asset_id, mode?, options?): Promise<Decimal>

    • Get the stakeable balance for the supplied asset.

      Parameters

      • asset_id: string

        The asset to check the stakeable balance for.

      • mode: StakeOptionsMode = StakeOptionsMode.DEFAULT

        The staking mode. Defaults to DEFAULT.

      • options: {
            [key: string]: string;
        } = {}

        Additional options for getting the stakeable balance.

        • [key: string]: string

      Returns Promise<Decimal>

      The stakeable balance.

      Throws

      if the default address is not found.

      -

    stakingRewards

    stakingRewards

    • stakingRewards(assetId, startTime?, endTime?, format?): Promise<StakingReward[]>

    • Lists the staking rewards for the address.

      Parameters

      • assetId: string

        The asset ID.

      • startTime: string = ...

        The start time.

      • endTime: string = ...

        The end time.

      • format: StakingRewardFormat = StakingRewardFormat.USD

        The format to return the rewards in. (usd, native). Defaults to usd.

      Returns Promise<StakingReward[]>

      The staking rewards.

      Throws

      if the default address is not found.

      -

    toString

    toString

    • toString(): string

    • Returns a String representation of the Wallet.

      Returns string

      a String representation of the Wallet

      -

    unstakeableBalance

    • unstakeableBalance(asset_id, mode?, options?): Promise<Decimal>

    • Get the unstakeable balance for the supplied asset.

      +

    unstakeableBalance

    • unstakeableBalance(asset_id, mode?, options?): Promise<Decimal>

    • Get the unstakeable balance for the supplied asset.

      Parameters

      • asset_id: string

        The asset to check the unstakeable balance for.

      • mode: StakeOptionsMode = StakeOptionsMode.DEFAULT

        The staking mode. Defaults to DEFAULT.

      • options: {
            [key: string]: string;
        } = {}

        Additional options for getting the unstakeable balance.

        • [key: string]: string

      Returns Promise<Decimal>

      The unstakeable balance.

      Throws

      if the default address is not found.

      -

    Private validateSeed

    Private validateSeed

    • validateSeed(seed): void

    • Validates the seed and address models passed to the constructor.

      Parameters

      • seed: undefined | string

        The seed to use for the Wallet

        -

      Returns void

    Private waitForSigner

    • waitForSigner(walletId, intervalSeconds?, timeoutSeconds?): Promise<void>

    • Waits until the ServerSigner has created a seed for the Wallet.

      +

    Returns void

    Private waitForSigner

    • waitForSigner(walletId, intervalSeconds?, timeoutSeconds?): Promise<void>

    • Waits until the ServerSigner has created a seed for the Wallet.

      Parameters

      • walletId: string

        The ID of the Wallet that is awaiting seed creation.

      • intervalSeconds: number = 0.2

        The interval at which to poll the CDPService, in seconds.

      • timeoutSeconds: number = 20

        The maximum amount of time to wait for the ServerSigner to create a seed, in seconds.

      Returns Promise<void>

      Throws

      if the API request to get a Wallet fails.

      Throws

      if the ServerSigner times out.

      -

    Static create

    Static create

    • create(options?): Promise<Wallet>

    • Returns a newly created Wallet object.

      Parameters

      Returns Promise<Wallet>

      A promise that resolves with the new Wallet object.

      Constructs

      Wallet

      @@ -250,17 +250,17 @@

      Throws

        Throws

        • If the request fails.
        -

    Static fetch

    • fetch(wallet_id): Promise<Wallet>

    • Fetches a Wallet by its ID. The returned wallet can be immediately used for signing operations if backed by a server signer. +

    Static fetch

    • fetch(wallet_id): Promise<Wallet>

    • Fetches a Wallet by its ID. The returned wallet can be immediately used for signing operations if backed by a server signer. If the wallet is not backed by a server signer, the wallet's seed will need to be set before it can be used for signing operations.

      Parameters

      • wallet_id: string

        The ID of the Wallet to fetch

      Returns Promise<Wallet>

      The fetched Wallet

      -

    Static import

    Static import

    • import(data): Promise<Wallet>

    • Imports a Wallet for the given Wallet data.

      Parameters

      Returns Promise<Wallet>

      The imported Wallet.

      Throws

      If the Wallet ID is not provided.

      Throws

      If the seed is not provided.

      Throws

      If the request fails.

      -

    Static init

    Static init

    • init(model, seed?): Wallet

    • Returns a new Wallet object. Do not use this method directly. Instead, use one of:

      • Wallet.create (Create a new Wallet),
      • Wallet.import (Import a Wallet with seed),
        • @@ -278,7 +278,7 @@

        Throws

          Throws

          • If the request fails.
          -

    Static listWallets

    Static listWallets

    Settings

    Member Visibility

    Theme

    On This Page

    addressPathPrefixaddressesmastermodelseedMAX_ADDRESSESbuildWalletAddresscanSignclaimableBalancecreateAddresscreateAttestationcreateClaimStakecreatePayloadSignaturecreateStakecreateTradecreateTransfercreateUnstakecreateWebhookdeployMultiTokendeployNFTdeployTokenderiveKeyexportfaucetgetAddressgetBalancegetDefaultAddressgetEncryptionKeygetExistingSeedsgetIdgetNetworkIdgetServerSignerStatushistoricalStakingBalancesinvokeContractlistAddresseslistBalanceslistHistoricalBalancesloadSeedreloadsaveSeedsetMasterNodesetSeedstakeableBalancestakingRewardstoStringunstakeableBalancevalidateSeedwaitForSignercreatefetchimportinitlistWallets
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    addressPathPrefixaddressesmastermodelseedMAX_ADDRESSESbuildWalletAddresscanSignclaimableBalancecreateAddresscreateAttestationcreateClaimStakecreatePayloadSignaturecreateStakecreateTradecreateTransfercreateUnstakecreateWebhookdeployMultiTokendeployNFTdeployTokenderiveKeyexportfaucetgetAddressgetBalancegetDefaultAddressgetEncryptionKeygetExistingSeedsgetIdgetNetworkIdgetServerSignerStatushistoricalStakingBalancesinvokeContractlistAddresseslistBalanceslistHistoricalBalancesloadSeedreloadsaveSeedsetMasterNodesetSeedstakeableBalancestakingRewardstoStringunstakeableBalancevalidateSeedwaitForSignercreatefetchimportinitlistWallets
    \ No newline at end of file diff --git a/docs/classes/coinbase_webhook.Webhook.html b/docs/classes/coinbase_webhook.Webhook.html index 829adb94..7b69a230 100644 --- a/docs/classes/coinbase_webhook.Webhook.html +++ b/docs/classes/coinbase_webhook.Webhook.html @@ -1,6 +1,6 @@ Webhook | @coinbase/coinbase-sdk

    Class Webhook

    A representation of a Webhook, which provides methods to create, list, update, and delete webhooks that are used to receive notifications of specific events.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    model

    Methods

    delete getEventFilters @@ -18,35 +18,35 @@

    Constructors

    Private constructor

    Properties

    Private model

    model: null | Webhook

    Methods

    delete

    Properties

    Private model

    model: null | Webhook

    Methods

    delete

    • delete(): Promise<void>

    • Deletes the webhook.

      Returns Promise<void>

      A promise that resolves when the webhook is deleted and its attributes are set to null.

      -

    getEventFilters

    getEventFilters

    getEventType

    getEventType

    getEventTypeFilter

    getEventTypeFilter

    getId

    getId

    • getId(): undefined | string

    • Returns the ID of the webhook.

      Returns undefined | string

      The ID of the webhook, or undefined if the model is null.

      -

    getNetworkId

    getNetworkId

    • getNetworkId(): undefined | string

    • Returns the network ID associated with the webhook.

      Returns undefined | string

      The network ID of the webhook, or undefined if the model is null.

      -

    getNotificationURI

    getNotificationURI

    • getNotificationURI(): undefined | string

    • Returns the notification URI of the webhook.

      Returns undefined | string

      The URI where notifications are sent, or undefined if the model is null.

      -

    getSignatureHeader

    getSignatureHeader

    • getSignatureHeader(): undefined | string

    • Returns the signature header of the webhook.

      Returns undefined | string

      The signature header which will be set on the callback requests, or undefined if the model is null.

      -

    toString

    toString

    • toString(): string

    • Returns a String representation of the Webhook.

      Returns string

      A String representation of the Webhook.

      -

    update

    • update(options): Promise<Webhook>

    • Updates the webhook with a new notification URI, and optionally a new list of addresses to monitor.

      +

    update

    • update(options): Promise<Webhook>

    • Updates the webhook with a new notification URI, and optionally a new list of addresses to monitor.

      Parameters

      Returns Promise<Webhook>

      A promise that resolves to the updated Webhook object.

      -

    Static create

    Static create

    Static init

    Static init

    • init(model): Webhook

    • Returns a new Webhook object. Do not use this method directly. Instead, Webhook.create(...)

      Parameters

      • model: Webhook

        The underlying Webhook model object

      Returns Webhook

      A Webhook object.

      Constructs

      Webhook

      -

    Static list

    Static list

    Settings

    Member Visibility

    Theme

    On This Page

    constructormodeldeletegetEventFiltersgetEventTypegetEventTypeFiltergetIdgetNetworkIdgetNotificationURIgetSignatureHeadertoStringupdatecreateinitlist
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    constructormodeldeletegetEventFiltersgetEventTypegetEventTypeFiltergetIdgetNetworkIdgetNotificationURIgetSignatureHeadertoStringupdatecreateinitlist
    \ No newline at end of file diff --git a/docs/enums/client_api.NetworkIdentifier.html b/docs/enums/client_api.NetworkIdentifier.html index 86d682df..42be4edc 100644 --- a/docs/enums/client_api.NetworkIdentifier.html +++ b/docs/enums/client_api.NetworkIdentifier.html @@ -1,5 +1,5 @@ NetworkIdentifier | @coinbase/coinbase-sdk

    Enumeration NetworkIdentifier

    The ID of the blockchain network. This is unique across all networks, and takes the form of <blockchain>-<network>.

    -

    Export

    Enumeration Members

    ArbitrumMainnet +

    Export

    Enumeration Members

    ArbitrumMainnet BaseMainnet BaseSepolia EthereumHolesky @@ -7,4 +7,4 @@ PolygonMainnet SolanaDevnet SolanaMainnet -

    Enumeration Members

    ArbitrumMainnet

    ArbitrumMainnet: "arbitrum-mainnet"

    BaseMainnet

    BaseMainnet: "base-mainnet"

    BaseSepolia

    BaseSepolia: "base-sepolia"

    EthereumHolesky

    EthereumHolesky: "ethereum-holesky"

    EthereumMainnet

    EthereumMainnet: "ethereum-mainnet"

    PolygonMainnet

    PolygonMainnet: "polygon-mainnet"

    SolanaDevnet

    SolanaDevnet: "solana-devnet"

    SolanaMainnet

    SolanaMainnet: "solana-mainnet"

    Settings

    Member Visibility

    Theme

    On This Page

    ArbitrumMainnetBaseMainnetBaseSepoliaEthereumHoleskyEthereumMainnetPolygonMainnetSolanaDevnetSolanaMainnet
    \ No newline at end of file +

    Enumeration Members

    ArbitrumMainnet

    ArbitrumMainnet: "arbitrum-mainnet"

    BaseMainnet

    BaseMainnet: "base-mainnet"

    BaseSepolia

    BaseSepolia: "base-sepolia"

    EthereumHolesky

    EthereumHolesky: "ethereum-holesky"

    EthereumMainnet

    EthereumMainnet: "ethereum-mainnet"

    PolygonMainnet

    PolygonMainnet: "polygon-mainnet"

    SolanaDevnet

    SolanaDevnet: "solana-devnet"

    SolanaMainnet

    SolanaMainnet: "solana-mainnet"

    Settings

    Member Visibility

    Theme

    On This Page

    ArbitrumMainnetBaseMainnetBaseSepoliaEthereumHoleskyEthereumMainnetPolygonMainnetSolanaDevnetSolanaMainnet
    \ No newline at end of file diff --git a/docs/enums/client_api.SmartContractType.html b/docs/enums/client_api.SmartContractType.html index 12881cb6..14c5db16 100644 --- a/docs/enums/client_api.SmartContractType.html +++ b/docs/enums/client_api.SmartContractType.html @@ -1,5 +1,5 @@ SmartContractType | @coinbase/coinbase-sdk

    Enumeration SmartContractType

    The type of the smart contract.

    -

    Export

    Enumeration Members

    Erc1155 +

    Export

    Enumeration Members

    Erc1155 Erc20 Erc721 -

    Enumeration Members

    Erc1155

    Erc1155: "erc1155"

    Erc20

    Erc20: "erc20"

    Erc721

    Erc721: "erc721"

    Settings

    Member Visibility

    Theme

    On This Page

    Erc1155Erc20Erc721
    \ No newline at end of file +

    Enumeration Members

    Erc1155

    Erc1155: "erc1155"

    Erc20

    Erc20: "erc20"

    Erc721

    Erc721: "erc721"

    Settings

    Member Visibility

    Theme

    On This Page

    Erc1155Erc20Erc721
    \ No newline at end of file diff --git a/docs/enums/client_api.StakingRewardFormat.html b/docs/enums/client_api.StakingRewardFormat.html index a9fc255b..ff5b594f 100644 --- a/docs/enums/client_api.StakingRewardFormat.html +++ b/docs/enums/client_api.StakingRewardFormat.html @@ -1,4 +1,4 @@ StakingRewardFormat | @coinbase/coinbase-sdk

    Enumeration StakingRewardFormat

    The format in which the rewards are to be fetched i.e native or in equivalent USD

    -

    Export

    Enumeration Members

    Native +

    Export

    Enumeration Members

    Native Usd -

    Enumeration Members

    Native

    Native: "native"

    Usd

    Usd: "usd"

    Settings

    Member Visibility

    Theme

    On This Page

    NativeUsd
    \ No newline at end of file +

    Enumeration Members

    Native

    Native: "native"

    Usd

    Usd: "usd"

    Settings

    Member Visibility

    Theme

    On This Page

    NativeUsd
    \ No newline at end of file diff --git a/docs/enums/client_api.TransactionType.html b/docs/enums/client_api.TransactionType.html index e5cdf476..b2a0db7c 100644 --- a/docs/enums/client_api.TransactionType.html +++ b/docs/enums/client_api.TransactionType.html @@ -1,2 +1,2 @@ -TransactionType | @coinbase/coinbase-sdk

    Enumeration TransactionType

    Export

    Enumeration Members

    Transfer -

    Enumeration Members

    Transfer

    Transfer: "transfer"

    Settings

    Member Visibility

    Theme

    On This Page

    Transfer
    \ No newline at end of file +TransactionType | @coinbase/coinbase-sdk

    Enumeration TransactionType

    Export

    Enumeration Members

    Transfer +

    Enumeration Members

    Transfer

    Transfer: "transfer"

    Settings

    Member Visibility

    Theme

    On This Page

    Transfer
    \ No newline at end of file diff --git a/docs/enums/client_api.ValidatorStatus.html b/docs/enums/client_api.ValidatorStatus.html index 0906c802..47795aaf 100644 --- a/docs/enums/client_api.ValidatorStatus.html +++ b/docs/enums/client_api.ValidatorStatus.html @@ -1,5 +1,5 @@ ValidatorStatus | @coinbase/coinbase-sdk

    Enumeration ValidatorStatus

    The status of the validator.

    -

    Export

    Enumeration Members

    Active +

    Export

    Enumeration Members

    Active ActiveSlashed Deposited Exited @@ -12,4 +12,4 @@ Unknown WithdrawalAvailable WithdrawalComplete -

    Enumeration Members

    Active

    Active: "active"

    ActiveSlashed

    ActiveSlashed: "active_slashed"

    Deposited

    Deposited: "deposited"

    Exited

    Exited: "exited"

    ExitedSlashed

    ExitedSlashed: "exited_slashed"

    Exiting

    Exiting: "exiting"

    PendingActivation

    PendingActivation: "pending_activation"

    Provisioned

    Provisioned: "provisioned"

    Provisioning

    Provisioning: "provisioning"

    Reaped

    Reaped: "reaped"

    Unknown

    Unknown: "unknown"

    WithdrawalAvailable

    WithdrawalAvailable: "withdrawal_available"

    WithdrawalComplete

    WithdrawalComplete: "withdrawal_complete"

    Settings

    Member Visibility

    Theme

    On This Page

    ActiveActiveSlashedDepositedExitedExitedSlashedExitingPendingActivationProvisionedProvisioningReapedUnknownWithdrawalAvailableWithdrawalComplete
    \ No newline at end of file +

    Enumeration Members

    Active

    Active: "active"

    ActiveSlashed

    ActiveSlashed: "active_slashed"

    Deposited

    Deposited: "deposited"

    Exited

    Exited: "exited"

    ExitedSlashed

    ExitedSlashed: "exited_slashed"

    Exiting

    Exiting: "exiting"

    PendingActivation

    PendingActivation: "pending_activation"

    Provisioned

    Provisioned: "provisioned"

    Provisioning

    Provisioning: "provisioning"

    Reaped

    Reaped: "reaped"

    Unknown

    Unknown: "unknown"

    WithdrawalAvailable

    WithdrawalAvailable: "withdrawal_available"

    WithdrawalComplete

    WithdrawalComplete: "withdrawal_complete"

    Settings

    Member Visibility

    Theme

    On This Page

    ActiveActiveSlashedDepositedExitedExitedSlashedExitingPendingActivationProvisionedProvisioningReapedUnknownWithdrawalAvailableWithdrawalComplete
    \ No newline at end of file diff --git a/docs/enums/client_api.WebhookEventType.html b/docs/enums/client_api.WebhookEventType.html index e25e4f86..18c7ba3c 100644 --- a/docs/enums/client_api.WebhookEventType.html +++ b/docs/enums/client_api.WebhookEventType.html @@ -1,5 +1,5 @@ -WebhookEventType | @coinbase/coinbase-sdk

    Enumeration WebhookEventType

    Export

    Enumeration Members

    Erc20Transfer +WebhookEventType | @coinbase/coinbase-sdk

    Enumeration WebhookEventType

    Export

    Enumeration Members

    Erc20Transfer Erc721Transfer Unspecified WalletActivity -

    Enumeration Members

    Erc20Transfer

    Erc20Transfer: "erc20_transfer"

    Erc721Transfer

    Erc721Transfer: "erc721_transfer"

    Unspecified

    Unspecified: "unspecified"

    WalletActivity

    WalletActivity: "wallet_activity"

    Settings

    Member Visibility

    Theme

    On This Page

    Erc20TransferErc721TransferUnspecifiedWalletActivity
    \ No newline at end of file +

    Enumeration Members

    Erc20Transfer

    Erc20Transfer: "erc20_transfer"

    Erc721Transfer

    Erc721Transfer: "erc721_transfer"

    Unspecified

    Unspecified: "unspecified"

    WalletActivity

    WalletActivity: "wallet_activity"

    Settings

    Member Visibility

    Theme

    On This Page

    Erc20TransferErc721TransferUnspecifiedWalletActivity
    \ No newline at end of file diff --git a/docs/enums/coinbase_types.PayloadSignatureStatus.html b/docs/enums/coinbase_types.PayloadSignatureStatus.html index 121d371f..5d6a50f4 100644 --- a/docs/enums/coinbase_types.PayloadSignatureStatus.html +++ b/docs/enums/coinbase_types.PayloadSignatureStatus.html @@ -1,5 +1,5 @@ PayloadSignatureStatus | @coinbase/coinbase-sdk

    Enumeration PayloadSignatureStatus

    Payload Signature status type definition.

    -

    Enumeration Members

    FAILED +

    Enumeration Members

    FAILED PENDING SIGNED -

    Enumeration Members

    FAILED

    FAILED: "failed"

    PENDING

    PENDING: "pending"

    SIGNED

    SIGNED: "signed"

    Settings

    Member Visibility

    Theme

    On This Page

    FAILEDPENDINGSIGNED
    \ No newline at end of file +

    Enumeration Members

    FAILED

    FAILED: "failed"

    PENDING

    PENDING: "pending"

    SIGNED

    SIGNED: "signed"

    Settings

    Member Visibility

    Theme

    On This Page

    FAILEDPENDINGSIGNED
    \ No newline at end of file diff --git a/docs/enums/coinbase_types.ServerSignerStatus.html b/docs/enums/coinbase_types.ServerSignerStatus.html index 986491f4..c4b33d3e 100644 --- a/docs/enums/coinbase_types.ServerSignerStatus.html +++ b/docs/enums/coinbase_types.ServerSignerStatus.html @@ -1,4 +1,4 @@ ServerSignerStatus | @coinbase/coinbase-sdk

    Enumeration ServerSignerStatus

    ServerSigner status type definition.

    -

    Enumeration Members

    ACTIVE +

    Enumeration Members

    ACTIVE PENDING -

    Enumeration Members

    ACTIVE

    ACTIVE: "active_seed"

    PENDING

    PENDING: "pending_seed_creation"

    Settings

    Member Visibility

    Theme

    On This Page

    ACTIVEPENDING
    \ No newline at end of file +

    Enumeration Members

    ACTIVE

    ACTIVE: "active_seed"

    PENDING

    PENDING: "pending_seed_creation"

    Settings

    Member Visibility

    Theme

    On This Page

    ACTIVEPENDING
    \ No newline at end of file diff --git a/docs/enums/coinbase_types.SmartContractType.html b/docs/enums/coinbase_types.SmartContractType.html index f232aaff..f2580ac6 100644 --- a/docs/enums/coinbase_types.SmartContractType.html +++ b/docs/enums/coinbase_types.SmartContractType.html @@ -1,5 +1,5 @@ SmartContractType | @coinbase/coinbase-sdk

    Enumeration SmartContractType

    Smart Contract Type

    -

    Enumeration Members

    ERC1155 +

    Enumeration Members

    ERC1155 ERC20 ERC721 -

    Enumeration Members

    ERC1155

    ERC1155: "erc1155"

    ERC20

    ERC20: "erc20"

    ERC721

    ERC721: "erc721"

    Settings

    Member Visibility

    Theme

    On This Page

    ERC1155ERC20ERC721
    \ No newline at end of file +

    Enumeration Members

    ERC1155

    ERC1155: "erc1155"

    ERC20

    ERC20: "erc20"

    ERC721

    ERC721: "erc721"

    Settings

    Member Visibility

    Theme

    On This Page

    ERC1155ERC20ERC721
    \ No newline at end of file diff --git a/docs/enums/coinbase_types.SponsoredSendStatus.html b/docs/enums/coinbase_types.SponsoredSendStatus.html index f0f8e575..a4843773 100644 --- a/docs/enums/coinbase_types.SponsoredSendStatus.html +++ b/docs/enums/coinbase_types.SponsoredSendStatus.html @@ -1,7 +1,7 @@ SponsoredSendStatus | @coinbase/coinbase-sdk

    Enumeration SponsoredSendStatus

    Sponsored Send status type definition.

    -

    Enumeration Members

    COMPLETE +

    Enumeration Members

    COMPLETE FAILED PENDING SIGNED SUBMITTED -

    Enumeration Members

    COMPLETE

    COMPLETE: "complete"

    FAILED

    FAILED: "failed"

    PENDING

    PENDING: "pending"

    SIGNED

    SIGNED: "signed"

    SUBMITTED

    SUBMITTED: "submitted"

    Settings

    Member Visibility

    Theme

    On This Page

    COMPLETEFAILEDPENDINGSIGNEDSUBMITTED
    \ No newline at end of file +

    Enumeration Members

    COMPLETE

    COMPLETE: "complete"

    FAILED

    FAILED: "failed"

    PENDING

    PENDING: "pending"

    SIGNED

    SIGNED: "signed"

    SUBMITTED

    SUBMITTED: "submitted"

    Settings

    Member Visibility

    Theme

    On This Page

    COMPLETEFAILEDPENDINGSIGNEDSUBMITTED
    \ No newline at end of file diff --git a/docs/enums/coinbase_types.StakeOptionsMode.html b/docs/enums/coinbase_types.StakeOptionsMode.html index b1ebcb24..4e7a28a6 100644 --- a/docs/enums/coinbase_types.StakeOptionsMode.html +++ b/docs/enums/coinbase_types.StakeOptionsMode.html @@ -1,8 +1,8 @@ StakeOptionsMode | @coinbase/coinbase-sdk

    Enumeration StakeOptionsMode

    StakeOptionsMode type definition.

    -

    Enumeration Members

    DEFAULT +

    Enumeration Members

    DEFAULT NATIVE PARTIAL

    Enumeration Members

    DEFAULT

    DEFAULT: "default"

    Defaults to the mode specific to the asset.

    -

    NATIVE

    NATIVE: "native"

    Native represents Native Ethereum Staking mode.

    -

    PARTIAL

    PARTIAL: "partial"

    Partial represents Partial Ethereum Staking mode.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    DEFAULTNATIVEPARTIAL
    \ No newline at end of file +

    NATIVE

    NATIVE: "native"

    Native represents Native Ethereum Staking mode.

    +

    PARTIAL

    PARTIAL: "partial"

    Partial represents Partial Ethereum Staking mode.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    DEFAULTNATIVEPARTIAL
    \ No newline at end of file diff --git a/docs/enums/coinbase_types.StakingRewardFormat.html b/docs/enums/coinbase_types.StakingRewardFormat.html index a788163e..ac5191cb 100644 --- a/docs/enums/coinbase_types.StakingRewardFormat.html +++ b/docs/enums/coinbase_types.StakingRewardFormat.html @@ -1,5 +1,5 @@ StakingRewardFormat | @coinbase/coinbase-sdk

    Enumeration StakingRewardFormat

    Staking reward format type definition. Represents the format in which staking rewards can be queried.

    -

    Enumeration Members

    NATIVE +

    Enumeration Members

    NATIVE USD -

    Enumeration Members

    NATIVE

    NATIVE: "native"

    USD

    USD: "usd"

    Settings

    Member Visibility

    Theme

    On This Page

    NATIVEUSD
    \ No newline at end of file +

    Enumeration Members

    NATIVE

    NATIVE: "native"

    USD

    USD: "usd"

    Settings

    Member Visibility

    Theme

    On This Page

    NATIVEUSD
    \ No newline at end of file diff --git a/docs/enums/coinbase_types.TransactionStatus.html b/docs/enums/coinbase_types.TransactionStatus.html index 6afee156..c280da8a 100644 --- a/docs/enums/coinbase_types.TransactionStatus.html +++ b/docs/enums/coinbase_types.TransactionStatus.html @@ -1,6 +1,6 @@ TransactionStatus | @coinbase/coinbase-sdk

    Enumeration TransactionStatus

    Transaction status type definition.

    -

    Enumeration Members

    BROADCAST +

    Enumeration Members

    BROADCAST COMPLETE FAILED PENDING -

    Enumeration Members

    BROADCAST

    BROADCAST: "broadcast"

    COMPLETE

    COMPLETE: "complete"

    FAILED

    FAILED: "failed"

    PENDING

    PENDING: "pending"

    Settings

    Member Visibility

    Theme

    On This Page

    BROADCASTCOMPLETEFAILEDPENDING
    \ No newline at end of file +

    Enumeration Members

    BROADCAST

    BROADCAST: "broadcast"

    COMPLETE

    COMPLETE: "complete"

    FAILED

    FAILED: "failed"

    PENDING

    PENDING: "pending"

    Settings

    Member Visibility

    Theme

    On This Page

    BROADCASTCOMPLETEFAILEDPENDING
    \ No newline at end of file diff --git a/docs/enums/coinbase_types.TransferStatus.html b/docs/enums/coinbase_types.TransferStatus.html index 7f2262cc..11bf1e79 100644 --- a/docs/enums/coinbase_types.TransferStatus.html +++ b/docs/enums/coinbase_types.TransferStatus.html @@ -1,6 +1,6 @@ TransferStatus | @coinbase/coinbase-sdk

    Enumeration TransferStatus

    Transfer status type definition.

    -

    Enumeration Members

    BROADCAST +

    Enumeration Members

    BROADCAST COMPLETE FAILED PENDING -

    Enumeration Members

    BROADCAST

    BROADCAST: "broadcast"

    COMPLETE

    COMPLETE: "complete"

    FAILED

    FAILED: "failed"

    PENDING

    PENDING: "pending"

    Settings

    Member Visibility

    Theme

    On This Page

    BROADCASTCOMPLETEFAILEDPENDING
    \ No newline at end of file +

    Enumeration Members

    BROADCAST

    BROADCAST: "broadcast"

    COMPLETE

    COMPLETE: "complete"

    FAILED

    FAILED: "failed"

    PENDING

    PENDING: "pending"

    Settings

    Member Visibility

    Theme

    On This Page

    BROADCASTCOMPLETEFAILEDPENDING
    \ No newline at end of file diff --git a/docs/enums/coinbase_types.ValidatorStatus.html b/docs/enums/coinbase_types.ValidatorStatus.html index 2929f6fd..701f6a7c 100644 --- a/docs/enums/coinbase_types.ValidatorStatus.html +++ b/docs/enums/coinbase_types.ValidatorStatus.html @@ -1,6 +1,6 @@ ValidatorStatus | @coinbase/coinbase-sdk

    Enumeration ValidatorStatus

    Validator status type definition. Represents the various states a validator can be in.

    -

    Enumeration Members

    ACTIVE +

    Enumeration Members

    ACTIVE ACTIVE_SLASHED DEPOSITED EXITED @@ -13,4 +13,4 @@ UNKNOWN WITHDRAWAL_AVAILABLE WITHDRAWAL_COMPLETE -

    Enumeration Members

    ACTIVE

    ACTIVE: "active"

    ACTIVE_SLASHED

    ACTIVE_SLASHED: "active_slashed"

    DEPOSITED

    DEPOSITED: "deposited"

    EXITED

    EXITED: "exited"

    EXITED_SLASHED

    EXITED_SLASHED: "exited_slashed"

    EXITING

    EXITING: "exiting"

    PENDING_ACTIVATION

    PENDING_ACTIVATION: "pending_activation"

    PROVISIONED

    PROVISIONED: "provisioned"

    PROVISIONING

    PROVISIONING: "provisioning"

    REAPED

    REAPED: "reaped"

    UNKNOWN

    UNKNOWN: "unknown"

    WITHDRAWAL_AVAILABLE

    WITHDRAWAL_AVAILABLE: "withdrawal_available"

    WITHDRAWAL_COMPLETE

    WITHDRAWAL_COMPLETE: "withdrawal_complete"

    Settings

    Member Visibility

    Theme

    On This Page

    ACTIVEACTIVE_SLASHEDDEPOSITEDEXITEDEXITED_SLASHEDEXITINGPENDING_ACTIVATIONPROVISIONEDPROVISIONINGREAPEDUNKNOWNWITHDRAWAL_AVAILABLEWITHDRAWAL_COMPLETE
    \ No newline at end of file +

    Enumeration Members

    ACTIVE

    ACTIVE: "active"

    ACTIVE_SLASHED

    ACTIVE_SLASHED: "active_slashed"

    DEPOSITED

    DEPOSITED: "deposited"

    EXITED

    EXITED: "exited"

    EXITED_SLASHED

    EXITED_SLASHED: "exited_slashed"

    EXITING

    EXITING: "exiting"

    PENDING_ACTIVATION

    PENDING_ACTIVATION: "pending_activation"

    PROVISIONED

    PROVISIONED: "provisioned"

    PROVISIONING

    PROVISIONING: "provisioning"

    REAPED

    REAPED: "reaped"

    UNKNOWN

    UNKNOWN: "unknown"

    WITHDRAWAL_AVAILABLE

    WITHDRAWAL_AVAILABLE: "withdrawal_available"

    WITHDRAWAL_COMPLETE

    WITHDRAWAL_COMPLETE: "withdrawal_complete"

    Settings

    Member Visibility

    Theme

    On This Page

    ACTIVEACTIVE_SLASHEDDEPOSITEDEXITEDEXITED_SLASHEDEXITINGPENDING_ACTIVATIONPROVISIONEDPROVISIONINGREAPEDUNKNOWNWITHDRAWAL_AVAILABLEWITHDRAWAL_COMPLETE
    \ No newline at end of file diff --git a/docs/functions/client_api.AddressesApiAxiosParamCreator.html b/docs/functions/client_api.AddressesApiAxiosParamCreator.html index f6dcda5f..0e02011a 100644 --- a/docs/functions/client_api.AddressesApiAxiosParamCreator.html +++ b/docs/functions/client_api.AddressesApiAxiosParamCreator.html @@ -50,4 +50,4 @@

    Throws

    Returns Promise<RequestArgs>

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.AddressesApiFactory.html b/docs/functions/client_api.AddressesApiFactory.html index 6feff4c2..b78521ba 100644 --- a/docs/functions/client_api.AddressesApiFactory.html +++ b/docs/functions/client_api.AddressesApiFactory.html @@ -3,51 +3,51 @@

    Parameters

    Returns AxiosPromise<Address>

    Summary

    Create a new address

    -

    Throws

  • createPayloadSignature:function
  • createPayloadSignature:function
  • getAddress:function
  • getAddress:function
  • getAddressBalance:function
  • getAddressBalance:function
  • getPayloadSignature:function
  • getPayloadSignature:function
  • listAddressBalances:function
  • listAddressBalances:function
  • listAddresses:function
  • listAddresses:function
  • listPayloadSignatures:function
  • listPayloadSignatures:function
  • requestFaucetFunds:function
  • requestFaucetFunds:function

    • Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.AddressesApiFp.html b/docs/functions/client_api.AddressesApiFp.html index 12bf930f..0554fe5d 100644 --- a/docs/functions/client_api.AddressesApiFp.html +++ b/docs/functions/client_api.AddressesApiFp.html @@ -3,51 +3,51 @@

    Parameters

    Returns Promise<((axios?, basePath?) => AxiosPromise<Address>)>

    Summary

    Create a new address

    -

    Throws

  • createPayloadSignature:function
  • createPayloadSignature:function
  • getAddress:function
  • getAddress:function
  • getAddressBalance:function
  • getAddressBalance:function
  • getPayloadSignature:function
  • getPayloadSignature:function
  • listAddressBalances:function
  • listAddressBalances:function
  • listAddresses:function
  • listAddresses:function
  • listPayloadSignatures:function
  • listPayloadSignatures:function
  • requestFaucetFunds:function
  • requestFaucetFunds:function

    • Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.AssetsApiAxiosParamCreator.html b/docs/functions/client_api.AssetsApiAxiosParamCreator.html index 929a80b5..0b56805b 100644 --- a/docs/functions/client_api.AssetsApiAxiosParamCreator.html +++ b/docs/functions/client_api.AssetsApiAxiosParamCreator.html @@ -4,4 +4,4 @@

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.AssetsApiFactory.html b/docs/functions/client_api.AssetsApiFactory.html index 665d945b..1262edff 100644 --- a/docs/functions/client_api.AssetsApiFactory.html +++ b/docs/functions/client_api.AssetsApiFactory.html @@ -4,4 +4,4 @@
  • assetId: string

    The ID of the asset to fetch. This could be a symbol or an ERC20 contract address.

  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns AxiosPromise<Asset>

    Summary

    Get the asset for the specified asset ID.

    -

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.AssetsApiFp.html b/docs/functions/client_api.AssetsApiFp.html index d1718967..2c14069d 100644 --- a/docs/functions/client_api.AssetsApiFp.html +++ b/docs/functions/client_api.AssetsApiFp.html @@ -4,4 +4,4 @@
  • assetId: string

    The ID of the asset to fetch. This could be a symbol or an ERC20 contract address.

  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns Promise<((axios?, basePath?) => AxiosPromise<Asset>)>

    Summary

    Get the asset for the specified asset ID.

    -

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.BalanceHistoryApiAxiosParamCreator.html b/docs/functions/client_api.BalanceHistoryApiAxiosParamCreator.html index e4fa7910..79dc82a9 100644 --- a/docs/functions/client_api.BalanceHistoryApiAxiosParamCreator.html +++ b/docs/functions/client_api.BalanceHistoryApiAxiosParamCreator.html @@ -7,4 +7,4 @@

    Throws

    Returns Promise<RequestArgs>

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.BalanceHistoryApiFactory.html b/docs/functions/client_api.BalanceHistoryApiFactory.html index 4117138a..f5e52b09 100644 --- a/docs/functions/client_api.BalanceHistoryApiFactory.html +++ b/docs/functions/client_api.BalanceHistoryApiFactory.html @@ -7,4 +7,4 @@
  • Optional page: string

    A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns AxiosPromise<AddressHistoricalBalanceList>

    Summary

    Get address balance history for asset

    -

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.BalanceHistoryApiFp.html b/docs/functions/client_api.BalanceHistoryApiFp.html index 13b05844..c69ed9e8 100644 --- a/docs/functions/client_api.BalanceHistoryApiFp.html +++ b/docs/functions/client_api.BalanceHistoryApiFp.html @@ -7,4 +7,4 @@
  • Optional page: string

    A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns Promise<((axios?, basePath?) => AxiosPromise<AddressHistoricalBalanceList>)>

    Summary

    Get address balance history for asset

    -

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.ContractEventsApiAxiosParamCreator.html b/docs/functions/client_api.ContractEventsApiAxiosParamCreator.html index 6eac2d80..e309f7e5 100644 --- a/docs/functions/client_api.ContractEventsApiAxiosParamCreator.html +++ b/docs/functions/client_api.ContractEventsApiAxiosParamCreator.html @@ -10,4 +10,4 @@

    Throws

    Returns Promise<RequestArgs>

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.ContractEventsApiFactory.html b/docs/functions/client_api.ContractEventsApiFactory.html index 5b7e4125..a509b126 100644 --- a/docs/functions/client_api.ContractEventsApiFactory.html +++ b/docs/functions/client_api.ContractEventsApiFactory.html @@ -10,4 +10,4 @@
  • Optional nextPage: string

    Pagination token for retrieving the next set of results

  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns AxiosPromise<ContractEventList>

    Summary

    List contract events

    -

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.ContractEventsApiFp.html b/docs/functions/client_api.ContractEventsApiFp.html index b69df1eb..5d8eb644 100644 --- a/docs/functions/client_api.ContractEventsApiFp.html +++ b/docs/functions/client_api.ContractEventsApiFp.html @@ -10,4 +10,4 @@
  • Optional nextPage: string

    Pagination token for retrieving the next set of results

  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns Promise<((axios?, basePath?) => AxiosPromise<ContractEventList>)>

    Summary

    List contract events

    -

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.ContractInvocationsApiAxiosParamCreator.html b/docs/functions/client_api.ContractInvocationsApiAxiosParamCreator.html index a5c431ce..c42e044f 100644 --- a/docs/functions/client_api.ContractInvocationsApiAxiosParamCreator.html +++ b/docs/functions/client_api.ContractInvocationsApiAxiosParamCreator.html @@ -23,4 +23,4 @@

    Throws

    Returns Promise<RequestArgs>

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.ContractInvocationsApiFactory.html b/docs/functions/client_api.ContractInvocationsApiFactory.html index 9dacfc97..aae3d27c 100644 --- a/docs/functions/client_api.ContractInvocationsApiFactory.html +++ b/docs/functions/client_api.ContractInvocationsApiFactory.html @@ -5,22 +5,22 @@
  • contractInvocationId: string

    The ID of the contract invocation to broadcast.

  • broadcastContractInvocationRequest: BroadcastContractInvocationRequest
  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns AxiosPromise<ContractInvocation>

    Summary

    Broadcast a contract invocation.

    -

    Throws

  • createContractInvocation:function
  • createContractInvocation:function
  • getContractInvocation:function
  • getContractInvocation:function
  • listContractInvocations:function
  • listContractInvocations:function

    • Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.ContractInvocationsApiFp.html b/docs/functions/client_api.ContractInvocationsApiFp.html index 2262339b..ca6fd210 100644 --- a/docs/functions/client_api.ContractInvocationsApiFp.html +++ b/docs/functions/client_api.ContractInvocationsApiFp.html @@ -5,22 +5,22 @@
  • contractInvocationId: string

    The ID of the contract invocation to broadcast.

  • broadcastContractInvocationRequest: BroadcastContractInvocationRequest
  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns Promise<((axios?, basePath?) => AxiosPromise<ContractInvocation>)>

    Summary

    Broadcast a contract invocation.

    -

    Throws

  • createContractInvocation:function
  • createContractInvocation:function
  • getContractInvocation:function
  • getContractInvocation:function
  • listContractInvocations:function
  • listContractInvocations:function

    • Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.ExternalAddressesApiAxiosParamCreator.html b/docs/functions/client_api.ExternalAddressesApiAxiosParamCreator.html index f72d8b89..0ff8f2c9 100644 --- a/docs/functions/client_api.ExternalAddressesApiAxiosParamCreator.html +++ b/docs/functions/client_api.ExternalAddressesApiAxiosParamCreator.html @@ -17,4 +17,4 @@

    Throws

    Returns Promise<RequestArgs>

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.ExternalAddressesApiFactory.html b/docs/functions/client_api.ExternalAddressesApiFactory.html index 9da1663b..6ba0706a 100644 --- a/docs/functions/client_api.ExternalAddressesApiFactory.html +++ b/docs/functions/client_api.ExternalAddressesApiFactory.html @@ -5,16 +5,16 @@
  • assetId: string

    The ID of the asset to fetch the balance for

  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns AxiosPromise<Balance>

    Summary

    Get the balance of an asset in an external address

    -

    Throws

  • listExternalAddressBalances:function
  • listExternalAddressBalances:function
  • requestExternalFaucetFunds:function
  • requestExternalFaucetFunds:function

    • Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.ExternalAddressesApiFp.html b/docs/functions/client_api.ExternalAddressesApiFp.html index 387089ec..d749bb1b 100644 --- a/docs/functions/client_api.ExternalAddressesApiFp.html +++ b/docs/functions/client_api.ExternalAddressesApiFp.html @@ -5,16 +5,16 @@
  • assetId: string

    The ID of the asset to fetch the balance for

  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns Promise<((axios?, basePath?) => AxiosPromise<Balance>)>

    Summary

    Get the balance of an asset in an external address

    -

    Throws

  • listExternalAddressBalances:function
  • listExternalAddressBalances:function
  • requestExternalFaucetFunds:function
  • requestExternalFaucetFunds:function

    • Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.NetworksApiAxiosParamCreator.html b/docs/functions/client_api.NetworksApiAxiosParamCreator.html index 85ff34c2..d258cbbc 100644 --- a/docs/functions/client_api.NetworksApiAxiosParamCreator.html +++ b/docs/functions/client_api.NetworksApiAxiosParamCreator.html @@ -3,4 +3,4 @@

    Summary

    Get network by ID

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.NetworksApiFactory.html b/docs/functions/client_api.NetworksApiFactory.html index d6f243a2..6b82185d 100644 --- a/docs/functions/client_api.NetworksApiFactory.html +++ b/docs/functions/client_api.NetworksApiFactory.html @@ -3,4 +3,4 @@

    Parameters

    Returns AxiosPromise<Network>

    Summary

    Get network by ID

    -

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.NetworksApiFp.html b/docs/functions/client_api.NetworksApiFp.html index df71a9df..0e67a95a 100644 --- a/docs/functions/client_api.NetworksApiFp.html +++ b/docs/functions/client_api.NetworksApiFp.html @@ -3,4 +3,4 @@

    Parameters

    Returns Promise<((axios?, basePath?) => AxiosPromise<Network>)>

    Summary

    Get network by ID

    -

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.ServerSignersApiAxiosParamCreator.html b/docs/functions/client_api.ServerSignersApiAxiosParamCreator.html index b90fc278..05b3a4e1 100644 --- a/docs/functions/client_api.ServerSignersApiAxiosParamCreator.html +++ b/docs/functions/client_api.ServerSignersApiAxiosParamCreator.html @@ -25,4 +25,4 @@

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.ServerSignersApiFactory.html b/docs/functions/client_api.ServerSignersApiFactory.html index c5f4a70a..0be7473f 100644 --- a/docs/functions/client_api.ServerSignersApiFactory.html +++ b/docs/functions/client_api.ServerSignersApiFactory.html @@ -2,27 +2,27 @@

    Parameters

    Returns {
        createServerSigner(createServerSignerRequest?, options?): AxiosPromise<ServerSigner>;
        getServerSigner(serverSignerId, options?): AxiosPromise<ServerSigner>;
        listServerSignerEvents(serverSignerId, limit?, page?, options?): AxiosPromise<ServerSignerEventList>;
        listServerSigners(limit?, page?, options?): AxiosPromise<ServerSignerList>;
        submitServerSignerSeedEventResult(serverSignerId, seedCreationEventResult?, options?): AxiosPromise<SeedCreationEventResult>;
        submitServerSignerSignatureEventResult(serverSignerId, signatureCreationEventResult?, options?): AxiosPromise<SignatureCreationEventResult>;
    }

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.ServerSignersApiFp.html b/docs/functions/client_api.ServerSignersApiFp.html index 1dc3672f..921e9d3e 100644 --- a/docs/functions/client_api.ServerSignersApiFp.html +++ b/docs/functions/client_api.ServerSignersApiFp.html @@ -2,27 +2,27 @@

    Parameters

    Returns {
        createServerSigner(createServerSignerRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<ServerSigner>)>;
        getServerSigner(serverSignerId, options?): Promise<((axios?, basePath?) => AxiosPromise<ServerSigner>)>;
        listServerSignerEvents(serverSignerId, limit?, page?, options?): Promise<((axios?, basePath?) => AxiosPromise<ServerSignerEventList>)>;
        listServerSigners(limit?, page?, options?): Promise<((axios?, basePath?) => AxiosPromise<ServerSignerList>)>;
        submitServerSignerSeedEventResult(serverSignerId, seedCreationEventResult?, options?): Promise<((axios?, basePath?) => AxiosPromise<SeedCreationEventResult>)>;
        submitServerSignerSignatureEventResult(serverSignerId, signatureCreationEventResult?, options?): Promise<((axios?, basePath?) => AxiosPromise<SignatureCreationEventResult>)>;
    }

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.SmartContractsApiAxiosParamCreator.html b/docs/functions/client_api.SmartContractsApiAxiosParamCreator.html index 7c6c5a38..88ef088e 100644 --- a/docs/functions/client_api.SmartContractsApiAxiosParamCreator.html +++ b/docs/functions/client_api.SmartContractsApiAxiosParamCreator.html @@ -24,4 +24,4 @@

    Throws

    Returns Promise<RequestArgs>

  • readContract: ((networkId, contractAddress, readContractRequest, options?) => Promise<RequestArgs>)

    Perform a read operation on a smart contract without creating a transaction

    Summary

    Read data from a smart contract

    Throws

    • Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.SmartContractsApiFactory.html b/docs/functions/client_api.SmartContractsApiFactory.html index f6b12dfa..34eeaf89 100644 --- a/docs/functions/client_api.SmartContractsApiFactory.html +++ b/docs/functions/client_api.SmartContractsApiFactory.html @@ -4,24 +4,24 @@
  • addressId: string

    The ID of the address to deploy the smart contract from.

  • createSmartContractRequest: CreateSmartContractRequest
  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns AxiosPromise<SmartContract>

    Summary

    Create a new smart contract

    -

    Throws

  • deploySmartContract:function
  • deploySmartContract:function
  • getSmartContract:function
  • getSmartContract:function
  • listSmartContracts:function
  • listSmartContracts:function
  • readContract:function
  • readContract:function

    • Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.SmartContractsApiFp.html b/docs/functions/client_api.SmartContractsApiFp.html index f631c82e..85e91216 100644 --- a/docs/functions/client_api.SmartContractsApiFp.html +++ b/docs/functions/client_api.SmartContractsApiFp.html @@ -4,24 +4,24 @@
  • addressId: string

    The ID of the address to deploy the smart contract from.

  • createSmartContractRequest: CreateSmartContractRequest
  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns Promise<((axios?, basePath?) => AxiosPromise<SmartContract>)>

    Summary

    Create a new smart contract

    -

    Throws

  • deploySmartContract:function
  • deploySmartContract:function
  • getSmartContract:function
  • getSmartContract:function
  • listSmartContracts:function
  • listSmartContracts:function
  • readContract:function
  • readContract:function

    • Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.StakeApiAxiosParamCreator.html b/docs/functions/client_api.StakeApiAxiosParamCreator.html index df34b75b..0ed0beba 100644 --- a/docs/functions/client_api.StakeApiAxiosParamCreator.html +++ b/docs/functions/client_api.StakeApiAxiosParamCreator.html @@ -26,4 +26,4 @@

    Throws

    Returns Promise<RequestArgs>

  • getStakingContext: ((getStakingContextRequest, options?) => Promise<RequestArgs>)

    Get staking context for an address

    Summary

    Get staking context

    Throws

    • Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.StakeApiFactory.html b/docs/functions/client_api.StakeApiFactory.html index 5c0a1844..0b72e3f2 100644 --- a/docs/functions/client_api.StakeApiFactory.html +++ b/docs/functions/client_api.StakeApiFactory.html @@ -2,7 +2,7 @@

    Parameters

    Returns {
        buildStakingOperation(buildStakingOperationRequest, options?): AxiosPromise<StakingOperation>;
        fetchHistoricalStakingBalances(networkId, assetId, addressId, startTime, endTime, limit?, page?, options?): AxiosPromise<FetchHistoricalStakingBalances200Response>;
        fetchStakingRewards(fetchStakingRewardsRequest, limit?, page?, options?): AxiosPromise<FetchStakingRewards200Response>;
        getExternalStakingOperation(networkId, addressId, stakingOperationId, options?): AxiosPromise<StakingOperation>;
        getStakingContext(getStakingContextRequest, options?): AxiosPromise<StakingContext>;
    }

  • fetchStakingRewards:function
  • fetchStakingRewards:function
  • getExternalStakingOperation:function
  • getExternalStakingOperation:function
  • getStakingContext:function
  • getStakingContext:function

    • Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.StakeApiFp.html b/docs/functions/client_api.StakeApiFp.html index 979476fa..15e1bb99 100644 --- a/docs/functions/client_api.StakeApiFp.html +++ b/docs/functions/client_api.StakeApiFp.html @@ -2,7 +2,7 @@

    Parameters

    Returns {
        buildStakingOperation(buildStakingOperationRequest, options?): Promise<((axios?, basePath?) => AxiosPromise<StakingOperation>)>;
        fetchHistoricalStakingBalances(networkId, assetId, addressId, startTime, endTime, limit?, page?, options?): Promise<((axios?, basePath?) => AxiosPromise<FetchHistoricalStakingBalances200Response>)>;
        fetchStakingRewards(fetchStakingRewardsRequest, limit?, page?, options?): Promise<((axios?, basePath?) => AxiosPromise<FetchStakingRewards200Response>)>;
        getExternalStakingOperation(networkId, addressId, stakingOperationId, options?): Promise<((axios?, basePath?) => AxiosPromise<StakingOperation>)>;
        getStakingContext(getStakingContextRequest, options?): Promise<((axios?, basePath?) => AxiosPromise<StakingContext>)>;
    }

  • fetchStakingRewards:function
  • fetchStakingRewards:function
  • getExternalStakingOperation:function
  • getExternalStakingOperation:function
  • getStakingContext:function
  • getStakingContext:function

    • Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.TradesApiAxiosParamCreator.html b/docs/functions/client_api.TradesApiAxiosParamCreator.html index 11aad269..ba36ebf6 100644 --- a/docs/functions/client_api.TradesApiAxiosParamCreator.html +++ b/docs/functions/client_api.TradesApiAxiosParamCreator.html @@ -23,4 +23,4 @@

    Throws

    Returns Promise<RequestArgs>

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.TradesApiFactory.html b/docs/functions/client_api.TradesApiFactory.html index 1e88cf64..6ec75063 100644 --- a/docs/functions/client_api.TradesApiFactory.html +++ b/docs/functions/client_api.TradesApiFactory.html @@ -5,22 +5,22 @@
  • tradeId: string

    The ID of the trade to broadcast

  • broadcastTradeRequest: BroadcastTradeRequest
  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns AxiosPromise<Trade>

    Summary

    Broadcast a trade

    -

    Throws

  • createTrade:function
  • createTrade:function
  • getTrade:function
  • getTrade:function
  • listTrades:function
  • listTrades:function

    • Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.TradesApiFp.html b/docs/functions/client_api.TradesApiFp.html index 6ef90529..e1bc805a 100644 --- a/docs/functions/client_api.TradesApiFp.html +++ b/docs/functions/client_api.TradesApiFp.html @@ -5,22 +5,22 @@
  • tradeId: string

    The ID of the trade to broadcast

  • broadcastTradeRequest: BroadcastTradeRequest
  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns Promise<((axios?, basePath?) => AxiosPromise<Trade>)>

    Summary

    Broadcast a trade

    -

    Throws

  • createTrade:function
  • createTrade:function
  • getTrade:function
  • getTrade:function
  • listTrades:function
  • listTrades:function

    • Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.TransactionHistoryApiAxiosParamCreator.html b/docs/functions/client_api.TransactionHistoryApiAxiosParamCreator.html index 2c0a508c..3b8ecde7 100644 --- a/docs/functions/client_api.TransactionHistoryApiAxiosParamCreator.html +++ b/docs/functions/client_api.TransactionHistoryApiAxiosParamCreator.html @@ -6,4 +6,4 @@

    Throws

    Returns Promise<RequestArgs>

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.TransactionHistoryApiFactory.html b/docs/functions/client_api.TransactionHistoryApiFactory.html index 34064ad0..41cf10d0 100644 --- a/docs/functions/client_api.TransactionHistoryApiFactory.html +++ b/docs/functions/client_api.TransactionHistoryApiFactory.html @@ -6,4 +6,4 @@
  • Optional page: string

    A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns AxiosPromise<AddressTransactionList>

    Summary

    List transactions for an address.

    -

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.TransactionHistoryApiFp.html b/docs/functions/client_api.TransactionHistoryApiFp.html index 23037b18..46841670 100644 --- a/docs/functions/client_api.TransactionHistoryApiFp.html +++ b/docs/functions/client_api.TransactionHistoryApiFp.html @@ -6,4 +6,4 @@
  • Optional page: string

    A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns Promise<((axios?, basePath?) => AxiosPromise<AddressTransactionList>)>

    Summary

    List transactions for an address.

    -

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.TransfersApiAxiosParamCreator.html b/docs/functions/client_api.TransfersApiAxiosParamCreator.html index fe8a7df0..95e3225e 100644 --- a/docs/functions/client_api.TransfersApiAxiosParamCreator.html +++ b/docs/functions/client_api.TransfersApiAxiosParamCreator.html @@ -23,4 +23,4 @@

    Throws

    Returns Promise<RequestArgs>

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.TransfersApiFactory.html b/docs/functions/client_api.TransfersApiFactory.html index 15bf7bb0..be1f55f6 100644 --- a/docs/functions/client_api.TransfersApiFactory.html +++ b/docs/functions/client_api.TransfersApiFactory.html @@ -5,22 +5,22 @@
  • transferId: string

    The ID of the transfer to broadcast

  • broadcastTransferRequest: BroadcastTransferRequest
  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns AxiosPromise<Transfer>

    Summary

    Broadcast a transfer

    -

    Throws

  • createTransfer:function
  • createTransfer:function
  • getTransfer:function
  • getTransfer:function
  • listTransfers:function
  • listTransfers:function

    • Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.TransfersApiFp.html b/docs/functions/client_api.TransfersApiFp.html index e7029bd2..a3e63121 100644 --- a/docs/functions/client_api.TransfersApiFp.html +++ b/docs/functions/client_api.TransfersApiFp.html @@ -5,22 +5,22 @@
  • transferId: string

    The ID of the transfer to broadcast

  • broadcastTransferRequest: BroadcastTransferRequest
  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns Promise<((axios?, basePath?) => AxiosPromise<Transfer>)>

    Summary

    Broadcast a transfer

    -

    Throws

  • createTransfer:function
  • createTransfer:function
  • getTransfer:function
  • getTransfer:function
  • listTransfers:function
  • listTransfers:function

    • Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.UsersApiAxiosParamCreator.html b/docs/functions/client_api.UsersApiAxiosParamCreator.html index 7271d5aa..ff862d67 100644 --- a/docs/functions/client_api.UsersApiAxiosParamCreator.html +++ b/docs/functions/client_api.UsersApiAxiosParamCreator.html @@ -2,4 +2,4 @@

    Parameters

    Returns {
        getCurrentUser: ((options?) => Promise<RequestArgs>);
    }

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.UsersApiFactory.html b/docs/functions/client_api.UsersApiFactory.html index 44a52e65..5a4884b4 100644 --- a/docs/functions/client_api.UsersApiFactory.html +++ b/docs/functions/client_api.UsersApiFactory.html @@ -2,4 +2,4 @@

    Parameters

    Returns {
        getCurrentUser(options?): AxiosPromise<User>;
    }

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.UsersApiFp.html b/docs/functions/client_api.UsersApiFp.html index bdf9ee79..bbc1144d 100644 --- a/docs/functions/client_api.UsersApiFp.html +++ b/docs/functions/client_api.UsersApiFp.html @@ -2,4 +2,4 @@

    Parameters

    Returns {
        getCurrentUser(options?): Promise<((axios?, basePath?) => AxiosPromise<User>)>;
    }

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.ValidatorsApiAxiosParamCreator.html b/docs/functions/client_api.ValidatorsApiAxiosParamCreator.html index acce93ef..5d700341 100644 --- a/docs/functions/client_api.ValidatorsApiAxiosParamCreator.html +++ b/docs/functions/client_api.ValidatorsApiAxiosParamCreator.html @@ -13,4 +13,4 @@

    Throws

    Returns Promise<RequestArgs>

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.ValidatorsApiFactory.html b/docs/functions/client_api.ValidatorsApiFactory.html index cec03e73..9d48fdb6 100644 --- a/docs/functions/client_api.ValidatorsApiFactory.html +++ b/docs/functions/client_api.ValidatorsApiFactory.html @@ -5,7 +5,7 @@
  • validatorId: string

    The unique id of the validator to fetch details for.

  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns AxiosPromise<Validator>

    Summary

    Get a validator belonging to the CDP project

    -

    Throws

  • listValidators:function
  • listValidators:function

    Returns AxiosPromise<ValidatorList>

    Summary

    List validators belonging to the CDP project

    -

    Throws

    • Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.ValidatorsApiFp.html b/docs/functions/client_api.ValidatorsApiFp.html index a97cf335..c90c2630 100644 --- a/docs/functions/client_api.ValidatorsApiFp.html +++ b/docs/functions/client_api.ValidatorsApiFp.html @@ -5,7 +5,7 @@
  • validatorId: string

    The unique id of the validator to fetch details for.

  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns Promise<((axios?, basePath?) => AxiosPromise<Validator>)>

    Summary

    Get a validator belonging to the CDP project

    -

    Throws

  • listValidators:function
  • listValidators:function

    Returns Promise<((axios?, basePath?) => AxiosPromise<ValidatorList>)>

    Summary

    List validators belonging to the CDP project

    -

    Throws

    • Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.WalletStakeApiAxiosParamCreator.html b/docs/functions/client_api.WalletStakeApiAxiosParamCreator.html index 8a2707b9..423a09b8 100644 --- a/docs/functions/client_api.WalletStakeApiAxiosParamCreator.html +++ b/docs/functions/client_api.WalletStakeApiAxiosParamCreator.html @@ -16,4 +16,4 @@

    Throws

    Returns Promise<RequestArgs>

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.WalletStakeApiFactory.html b/docs/functions/client_api.WalletStakeApiFactory.html index 43cbf89b..a1fdda7d 100644 --- a/docs/functions/client_api.WalletStakeApiFactory.html +++ b/docs/functions/client_api.WalletStakeApiFactory.html @@ -5,15 +5,15 @@
  • stakingOperationId: string

    The ID of the staking operation to broadcast.

  • broadcastStakingOperationRequest: BroadcastStakingOperationRequest
  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns AxiosPromise<StakingOperation>

    Summary

    Broadcast a staking operation

    -

    Throws

  • createStakingOperation:function
  • createStakingOperation:function
  • getStakingOperation:function
  • getStakingOperation:function

    • Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.WalletStakeApiFp.html b/docs/functions/client_api.WalletStakeApiFp.html index ca5efd0a..d4413287 100644 --- a/docs/functions/client_api.WalletStakeApiFp.html +++ b/docs/functions/client_api.WalletStakeApiFp.html @@ -5,15 +5,15 @@
  • stakingOperationId: string

    The ID of the staking operation to broadcast.

  • broadcastStakingOperationRequest: BroadcastStakingOperationRequest
  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns Promise<((axios?, basePath?) => AxiosPromise<StakingOperation>)>

    Summary

    Broadcast a staking operation

    -

    Throws

  • createStakingOperation:function
  • createStakingOperation:function
  • getStakingOperation:function
  • getStakingOperation:function

    • Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.WalletsApiAxiosParamCreator.html b/docs/functions/client_api.WalletsApiAxiosParamCreator.html index 679d3ff4..aab473d7 100644 --- a/docs/functions/client_api.WalletsApiAxiosParamCreator.html +++ b/docs/functions/client_api.WalletsApiAxiosParamCreator.html @@ -20,4 +20,4 @@

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.WalletsApiFactory.html b/docs/functions/client_api.WalletsApiFactory.html index 2e6cb0d7..071a208a 100644 --- a/docs/functions/client_api.WalletsApiFactory.html +++ b/docs/functions/client_api.WalletsApiFactory.html @@ -2,22 +2,22 @@

    Parameters

    Returns {
        createWallet(createWalletRequest?, options?): AxiosPromise<Wallet>;
        getWallet(walletId, options?): AxiosPromise<Wallet>;
        getWalletBalance(walletId, assetId, options?): AxiosPromise<Balance>;
        listWalletBalances(walletId, options?): AxiosPromise<AddressBalanceList>;
        listWallets(limit?, page?, options?): AxiosPromise<WalletList>;
    }

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.WalletsApiFp.html b/docs/functions/client_api.WalletsApiFp.html index 4a51afc8..d864e993 100644 --- a/docs/functions/client_api.WalletsApiFp.html +++ b/docs/functions/client_api.WalletsApiFp.html @@ -2,22 +2,22 @@

    Parameters

    Returns {
        createWallet(createWalletRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<Wallet>)>;
        getWallet(walletId, options?): Promise<((axios?, basePath?) => AxiosPromise<Wallet>)>;
        getWalletBalance(walletId, assetId, options?): Promise<((axios?, basePath?) => AxiosPromise<Balance>)>;
        listWalletBalances(walletId, options?): Promise<((axios?, basePath?) => AxiosPromise<AddressBalanceList>)>;
        listWallets(limit?, page?, options?): Promise<((axios?, basePath?) => AxiosPromise<WalletList>)>;
    }

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.WebhooksApiAxiosParamCreator.html b/docs/functions/client_api.WebhooksApiAxiosParamCreator.html index 9952474f..8c468627 100644 --- a/docs/functions/client_api.WebhooksApiAxiosParamCreator.html +++ b/docs/functions/client_api.WebhooksApiAxiosParamCreator.html @@ -19,4 +19,4 @@

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.WebhooksApiFactory.html b/docs/functions/client_api.WebhooksApiFactory.html index 6a2dcd95..04bf32a5 100644 --- a/docs/functions/client_api.WebhooksApiFactory.html +++ b/docs/functions/client_api.WebhooksApiFactory.html @@ -3,20 +3,20 @@

    Parameters

    Returns AxiosPromise<Webhook>

    Summary

    Create a new webhook scoped to a wallet

    -

    Throws

  • createWebhook:function
  • createWebhook:function
  • deleteWebhook:function
  • deleteWebhook:function
  • listWebhooks:function
  • listWebhooks:function
  • updateWebhook:function
  • updateWebhook:function

    • Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_api.WebhooksApiFp.html b/docs/functions/client_api.WebhooksApiFp.html index 2f655fb1..aedfdc4c 100644 --- a/docs/functions/client_api.WebhooksApiFp.html +++ b/docs/functions/client_api.WebhooksApiFp.html @@ -3,20 +3,20 @@

    Parameters

    Returns Promise<((axios?, basePath?) => AxiosPromise<Webhook>)>

    Summary

    Create a new webhook scoped to a wallet

    -

    Throws

  • createWebhook:function
  • createWebhook:function
  • deleteWebhook:function
  • deleteWebhook:function
  • listWebhooks:function
  • listWebhooks:function
  • updateWebhook:function
  • updateWebhook:function

    • Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Throws

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_common.assertParamExists.html b/docs/functions/client_common.assertParamExists.html index ed8e2aec..01082d2b 100644 --- a/docs/functions/client_common.assertParamExists.html +++ b/docs/functions/client_common.assertParamExists.html @@ -1 +1 @@ -assertParamExists | @coinbase/coinbase-sdk

    Function assertParamExists

    • assertParamExists(functionName, paramName, paramValue): void

    • Parameters

      • functionName: string
      • paramName: string
      • paramValue: unknown

      Returns void

      Throws

      Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +assertParamExists | @coinbase/coinbase-sdk

    Function assertParamExists

    • assertParamExists(functionName, paramName, paramValue): void

    • Parameters

      • functionName: string
      • paramName: string
      • paramValue: unknown

      Returns void

      Throws

      Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_common.createRequestFunction.html b/docs/functions/client_common.createRequestFunction.html index 385db432..c363a89e 100644 --- a/docs/functions/client_common.createRequestFunction.html +++ b/docs/functions/client_common.createRequestFunction.html @@ -1 +1 @@ -createRequestFunction | @coinbase/coinbase-sdk

    Function createRequestFunction

    • createRequestFunction(axiosArgs, globalAxios, BASE_PATH, configuration?): (<T, R>(axios?, basePath?) => Promise<R>)

    • Parameters

      Returns (<T, R>(axios?, basePath?) => Promise<R>)

        • <T, R>(axios?, basePath?): Promise<R>

        • Type Parameters

          • T = unknown
          • R = AxiosResponse<T, any>

          Parameters

          • axios: AxiosInstance = globalAxios
          • basePath: string = BASE_PATH

          Returns Promise<R>

      Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +createRequestFunction | @coinbase/coinbase-sdk

    Function createRequestFunction

    • createRequestFunction(axiosArgs, globalAxios, BASE_PATH, configuration?): (<T, R>(axios?, basePath?) => Promise<R>)

    • Parameters

      Returns (<T, R>(axios?, basePath?) => Promise<R>)

        • <T, R>(axios?, basePath?): Promise<R>

        • Type Parameters

          • T = unknown
          • R = AxiosResponse<T, any>

          Parameters

          • axios: AxiosInstance = globalAxios
          • basePath: string = BASE_PATH

          Returns Promise<R>

      Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_common.serializeDataIfNeeded.html b/docs/functions/client_common.serializeDataIfNeeded.html index 55f1ce04..615c777b 100644 --- a/docs/functions/client_common.serializeDataIfNeeded.html +++ b/docs/functions/client_common.serializeDataIfNeeded.html @@ -1 +1 @@ -serializeDataIfNeeded | @coinbase/coinbase-sdk

    Function serializeDataIfNeeded

    • serializeDataIfNeeded(value, requestOptions, configuration?): any

    • Parameters

      • value: any
      • requestOptions: any
      • Optional configuration: Configuration

      Returns any

      Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +serializeDataIfNeeded | @coinbase/coinbase-sdk

    Function serializeDataIfNeeded

    • serializeDataIfNeeded(value, requestOptions, configuration?): any

    • Parameters

      • value: any
      • requestOptions: any
      • Optional configuration: Configuration

      Returns any

      Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_common.setApiKeyToObject.html b/docs/functions/client_common.setApiKeyToObject.html index 5726e361..b23dbe1a 100644 --- a/docs/functions/client_common.setApiKeyToObject.html +++ b/docs/functions/client_common.setApiKeyToObject.html @@ -1 +1 @@ -setApiKeyToObject | @coinbase/coinbase-sdk

    Function setApiKeyToObject

    • setApiKeyToObject(object, keyParamName, configuration?): Promise<void>

    • Parameters

      • object: any
      • keyParamName: string
      • Optional configuration: Configuration

      Returns Promise<void>

      Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +setApiKeyToObject | @coinbase/coinbase-sdk

    Function setApiKeyToObject

    • setApiKeyToObject(object, keyParamName, configuration?): Promise<void>

    • Parameters

      • object: any
      • keyParamName: string
      • Optional configuration: Configuration

      Returns Promise<void>

      Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_common.setBasicAuthToObject.html b/docs/functions/client_common.setBasicAuthToObject.html index 52ccc167..f42b33de 100644 --- a/docs/functions/client_common.setBasicAuthToObject.html +++ b/docs/functions/client_common.setBasicAuthToObject.html @@ -1 +1 @@ -setBasicAuthToObject | @coinbase/coinbase-sdk

    Function setBasicAuthToObject

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +setBasicAuthToObject | @coinbase/coinbase-sdk

    Function setBasicAuthToObject

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_common.setBearerAuthToObject.html b/docs/functions/client_common.setBearerAuthToObject.html index 62f90974..6842d375 100644 --- a/docs/functions/client_common.setBearerAuthToObject.html +++ b/docs/functions/client_common.setBearerAuthToObject.html @@ -1 +1 @@ -setBearerAuthToObject | @coinbase/coinbase-sdk

    Function setBearerAuthToObject

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +setBearerAuthToObject | @coinbase/coinbase-sdk

    Function setBearerAuthToObject

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_common.setOAuthToObject.html b/docs/functions/client_common.setOAuthToObject.html index 53953a04..4949657e 100644 --- a/docs/functions/client_common.setOAuthToObject.html +++ b/docs/functions/client_common.setOAuthToObject.html @@ -1 +1 @@ -setOAuthToObject | @coinbase/coinbase-sdk

    Function setOAuthToObject

    • setOAuthToObject(object, name, scopes, configuration?): Promise<void>

    • Parameters

      • object: any
      • name: string
      • scopes: string[]
      • Optional configuration: Configuration

      Returns Promise<void>

      Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +setOAuthToObject | @coinbase/coinbase-sdk

    Function setOAuthToObject

    • setOAuthToObject(object, name, scopes, configuration?): Promise<void>

    • Parameters

      • object: any
      • name: string
      • scopes: string[]
      • Optional configuration: Configuration

      Returns Promise<void>

      Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_common.setSearchParams.html b/docs/functions/client_common.setSearchParams.html index b8fa4d60..72d319ae 100644 --- a/docs/functions/client_common.setSearchParams.html +++ b/docs/functions/client_common.setSearchParams.html @@ -1 +1 @@ -setSearchParams | @coinbase/coinbase-sdk

    Function setSearchParams

    • setSearchParams(url, ...objects): void

    • Parameters

      • url: URL
      • Rest ...objects: any[]

      Returns void

      Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +setSearchParams | @coinbase/coinbase-sdk

    Function setSearchParams

    • setSearchParams(url, ...objects): void

    • Parameters

      • url: URL
      • Rest ...objects: any[]

      Returns void

      Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/client_common.toPathString.html b/docs/functions/client_common.toPathString.html index bfb7bf8c..6d2fc176 100644 --- a/docs/functions/client_common.toPathString.html +++ b/docs/functions/client_common.toPathString.html @@ -1 +1 @@ -toPathString | @coinbase/coinbase-sdk

    Function toPathString

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +toPathString | @coinbase/coinbase-sdk

    Function toPathString

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/coinbase_hash.hashMessage.html b/docs/functions/coinbase_hash.hashMessage.html index 2a232a24..cb7ae7de 100644 --- a/docs/functions/coinbase_hash.hashMessage.html +++ b/docs/functions/coinbase_hash.hashMessage.html @@ -2,4 +2,4 @@

    Parameters

    Returns string

    The EIP-191 hash of the message as a string.

    Throws

    if the message cannot be hashed.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/coinbase_hash.hashTypedDataMessage.html b/docs/functions/coinbase_hash.hashTypedDataMessage.html index 18b49ee8..a0901ee8 100644 --- a/docs/functions/coinbase_hash.hashTypedDataMessage.html +++ b/docs/functions/coinbase_hash.hashTypedDataMessage.html @@ -4,4 +4,4 @@
  • value: Record<string, any>

    The actual data object to hash, conforming to the types defined.

    • Returns string

    The EIP-712 hash of the typed data as a hex-encoded string.

    Throws

    if the typed data cannot be hashed.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/coinbase_read_contract.readContract.html b/docs/functions/coinbase_read_contract.readContract.html index e74c9b6d..d154c2a1 100644 --- a/docs/functions/coinbase_read_contract.readContract.html +++ b/docs/functions/coinbase_read_contract.readContract.html @@ -1,12 +1,12 @@ -readContract | @coinbase/coinbase-sdk

    Function readContract

    • readContract<TAbi, TFunctionName, TArgs>(params): Promise<TAbi extends Abi
          ? ContractFunctionReturnType<TAbi, Extract<TFunctionName, ContractFunctionName<TAbi, "view" | "pure">>, TArgs>
          : unknown>

    • Reads data from a smart contract using the Coinbase API.

      +readContract | @coinbase/coinbase-sdk

      Function readContract

      • readContract<TAbi, TFunctionName, TArgs>(params): Promise<TAbi extends Abi
            ? ContractFunctionReturnType<TAbi, Extract<TFunctionName, ContractFunctionName<TAbi, "view" | "pure">>, TArgs>
            : any>

      • Reads data from a smart contract using the Coinbase API.

        Type Parameters

        • TAbi extends undefined | Abi

          The ABI type.

        • TFunctionName extends string

          The contract function name type.

          -
        • TArgs extends Record<string, string>

          The function arguments type.

          +
        • TArgs extends Record<string, any>

          The function arguments type.

        Parameters

        • params: {
              abi?: TAbi;
              args: TArgs;
              contractAddress: `0x${string}`;
              method: TFunctionName;
              networkId: string;
          }

          The parameters for reading the contract.

          • Optional abi?: TAbi

            The contract ABI (optional).

          • args: TArgs

            The arguments for the contract method.

          • contractAddress: `0x${string}`

            The contract address (as a hexadecimal string).

          • method: TFunctionName

            The contract method to call.

          • networkId: string

            The network ID.

            -

        Returns Promise<TAbi extends Abi
            ? ContractFunctionReturnType<TAbi, Extract<TFunctionName, ContractFunctionName<TAbi, "view" | "pure">>, TArgs>
            : unknown>

        The result of the contract call.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

    Returns Promise<TAbi extends Abi
        ? ContractFunctionReturnType<TAbi, Extract<TFunctionName, ContractFunctionName<TAbi, "view" | "pure">>, TArgs>
        : any>

    The result of the contract call.

    +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/coinbase_utils.convertStringToHex.html b/docs/functions/coinbase_utils.convertStringToHex.html index 5895581c..61229608 100644 --- a/docs/functions/coinbase_utils.convertStringToHex.html +++ b/docs/functions/coinbase_utils.convertStringToHex.html @@ -1,4 +1,4 @@ convertStringToHex | @coinbase/coinbase-sdk

    Function convertStringToHex

    • convertStringToHex(key): string

    • Converts a Uint8Array to a hex string.

      Parameters

      • key: Uint8Array

        The key to convert.

      Returns string

      The converted hex string.

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/coinbase_utils.delay.html b/docs/functions/coinbase_utils.delay.html index ba1e6e3b..fcbd5e55 100644 --- a/docs/functions/coinbase_utils.delay.html +++ b/docs/functions/coinbase_utils.delay.html @@ -1,4 +1,4 @@ delay | @coinbase/coinbase-sdk

    Function delay

    • delay(seconds): Promise<void>

    • Delays the execution of the function by the specified number of seconds.

      Parameters

      • seconds: number

        The number of seconds to delay the execution.

      Returns Promise<void>

      A promise that resolves after the specified number of seconds.

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/coinbase_utils.formatDate.html b/docs/functions/coinbase_utils.formatDate.html index baec0a0d..ad7989c2 100644 --- a/docs/functions/coinbase_utils.formatDate.html +++ b/docs/functions/coinbase_utils.formatDate.html @@ -1,4 +1,4 @@ formatDate | @coinbase/coinbase-sdk

    Function formatDate

    • formatDate(date): string

    • Formats the input date to 'YYYY-MM-DD'

      Parameters

      • date: Date

        The date to format.

      Returns string

      a formated date of 'YYYY-MM-DD'

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/coinbase_utils.getWeekBackDate.html b/docs/functions/coinbase_utils.getWeekBackDate.html index 50f6f03c..d3d6631e 100644 --- a/docs/functions/coinbase_utils.getWeekBackDate.html +++ b/docs/functions/coinbase_utils.getWeekBackDate.html @@ -1,4 +1,4 @@ getWeekBackDate | @coinbase/coinbase-sdk

    Function getWeekBackDate

    • getWeekBackDate(date): string

    • Takes a date and subtracts a week from it. (7 days)

      Parameters

      • date: Date

        The date to be formatted.

      Returns string

      a formatted date that is one week ago.

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/coinbase_utils.logApiResponse.html b/docs/functions/coinbase_utils.logApiResponse.html index 1d143f97..d32a8c38 100644 --- a/docs/functions/coinbase_utils.logApiResponse.html +++ b/docs/functions/coinbase_utils.logApiResponse.html @@ -2,4 +2,4 @@

    Parameters

    Returns AxiosResponse<any, any>

    The Axios response object.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/coinbase_utils.parseUnsignedPayload.html b/docs/functions/coinbase_utils.parseUnsignedPayload.html index b6e74dd1..143bb499 100644 --- a/docs/functions/coinbase_utils.parseUnsignedPayload.html +++ b/docs/functions/coinbase_utils.parseUnsignedPayload.html @@ -2,4 +2,4 @@

    Parameters

    Returns Record<string, any>

    The parsed JSON object.

    Throws

    If the Unsigned Payload is invalid.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/coinbase_utils.registerAxiosInterceptors.html b/docs/functions/coinbase_utils.registerAxiosInterceptors.html index 37eb8751..ae22b424 100644 --- a/docs/functions/coinbase_utils.registerAxiosInterceptors.html +++ b/docs/functions/coinbase_utils.registerAxiosInterceptors.html @@ -2,4 +2,4 @@

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/interfaces/client_api.Address.html b/docs/interfaces/client_api.Address.html index 3f0c6682..e778e39c 100644 --- a/docs/interfaces/client_api.Address.html +++ b/docs/interfaces/client_api.Address.html @@ -1,17 +1,17 @@ Address | @coinbase/coinbase-sdk

    Interface Address

    Export

    Address

    -
    interface Address {
        address_id: string;
        index: number;
        network_id: string;
        public_key: string;
        wallet_id: string;
    }

    Properties

    address_id +
    interface Address {
        address_id: string;
        index: number;
        network_id: string;
        public_key: string;
        wallet_id: string;
    }

    Properties

    address_id index network_id public_key wallet_id

    Properties

    address_id

    address_id: string

    The onchain address derived on the server-side.

    Memberof

    Address

    -

    index

    index: number

    The index of the address in the wallet.

    +

    index

    index: number

    The index of the address in the wallet.

    Memberof

    Address

    -

    network_id

    network_id: string

    The ID of the blockchain network

    +

    network_id

    network_id: string

    The ID of the blockchain network

    Memberof

    Address

    -

    public_key

    public_key: string

    The public key from which the address is derived.

    +

    public_key

    public_key: string

    The public key from which the address is derived.

    Memberof

    Address

    -

    wallet_id

    wallet_id: string

    The ID of the wallet that owns the address

    +

    wallet_id

    wallet_id: string

    The ID of the wallet that owns the address

    Memberof

    Address

    -

    Settings

    Member Visibility

    Theme

    On This Page

    address_idindexnetwork_idpublic_keywallet_id
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    address_idindexnetwork_idpublic_keywallet_id
    \ No newline at end of file diff --git a/docs/interfaces/client_api.AddressBalanceList.html b/docs/interfaces/client_api.AddressBalanceList.html index 25a8b80d..d8370c88 100644 --- a/docs/interfaces/client_api.AddressBalanceList.html +++ b/docs/interfaces/client_api.AddressBalanceList.html @@ -1,13 +1,13 @@ AddressBalanceList | @coinbase/coinbase-sdk

    Interface AddressBalanceList

    Export

    AddressBalanceList

    -
    interface AddressBalanceList {
        data: Balance[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data +
    interface AddressBalanceList {
        data: Balance[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data has_more next_page total_count

    Properties

    data

    data: Balance[]

    Memberof

    AddressBalanceList

    -

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    AddressBalanceList

    -

    next_page

    next_page: string

    The page token to be used to fetch the next page.

    +

    next_page

    next_page: string

    The page token to be used to fetch the next page.

    Memberof

    AddressBalanceList

    -

    total_count

    total_count: number

    The total number of balances for the wallet.

    +

    total_count

    total_count: number

    The total number of balances for the wallet.

    Memberof

    AddressBalanceList

    -

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_pagetotal_count
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_pagetotal_count
    \ No newline at end of file diff --git a/docs/interfaces/client_api.AddressHistoricalBalanceList.html b/docs/interfaces/client_api.AddressHistoricalBalanceList.html index 666452fc..e933298b 100644 --- a/docs/interfaces/client_api.AddressHistoricalBalanceList.html +++ b/docs/interfaces/client_api.AddressHistoricalBalanceList.html @@ -1,10 +1,10 @@ AddressHistoricalBalanceList | @coinbase/coinbase-sdk

    Interface AddressHistoricalBalanceList

    Export

    AddressHistoricalBalanceList

    -
    interface AddressHistoricalBalanceList {
        data: HistoricalBalance[];
        has_more: boolean;
        next_page: string;
    }

    Properties

    data +
    interface AddressHistoricalBalanceList {
        data: HistoricalBalance[];
        has_more: boolean;
        next_page: string;
    }

    Properties

    data has_more next_page

    Properties

    data

    data: HistoricalBalance[]

    Memberof

    AddressHistoricalBalanceList

    -

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    AddressHistoricalBalanceList

    -

    next_page

    next_page: string

    The page token to be used to fetch the next page.

    +

    next_page

    next_page: string

    The page token to be used to fetch the next page.

    Memberof

    AddressHistoricalBalanceList

    -

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_page
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_page
    \ No newline at end of file diff --git a/docs/interfaces/client_api.AddressList.html b/docs/interfaces/client_api.AddressList.html index 3238a216..62acd80d 100644 --- a/docs/interfaces/client_api.AddressList.html +++ b/docs/interfaces/client_api.AddressList.html @@ -1,13 +1,13 @@ AddressList | @coinbase/coinbase-sdk

    Interface AddressList

    Export

    AddressList

    -
    interface AddressList {
        data: Address[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data +
    interface AddressList {
        data: Address[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data has_more next_page total_count

    Properties

    data

    data: Address[]

    Memberof

    AddressList

    -

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    AddressList

    -

    next_page

    next_page: string

    The page token to be used to fetch the next page.

    +

    next_page

    next_page: string

    The page token to be used to fetch the next page.

    Memberof

    AddressList

    -

    total_count

    total_count: number

    The total number of addresses for the wallet.

    +

    total_count

    total_count: number

    The total number of addresses for the wallet.

    Memberof

    AddressList

    -

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_pagetotal_count
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_pagetotal_count
    \ No newline at end of file diff --git a/docs/interfaces/client_api.AddressTransactionList.html b/docs/interfaces/client_api.AddressTransactionList.html index b0164b96..dbc6108a 100644 --- a/docs/interfaces/client_api.AddressTransactionList.html +++ b/docs/interfaces/client_api.AddressTransactionList.html @@ -1,10 +1,10 @@ AddressTransactionList | @coinbase/coinbase-sdk

    Interface AddressTransactionList

    Export

    AddressTransactionList

    -
    interface AddressTransactionList {
        data: Transaction[];
        has_more: boolean;
        next_page: string;
    }

    Properties

    data +
    interface AddressTransactionList {
        data: Transaction[];
        has_more: boolean;
        next_page: string;
    }

    Properties

    data has_more next_page

    Properties

    data

    data: Transaction[]

    Memberof

    AddressTransactionList

    -

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    AddressTransactionList

    -

    next_page

    next_page: string

    The page token to be used to fetch the next page.

    +

    next_page

    next_page: string

    The page token to be used to fetch the next page.

    Memberof

    AddressTransactionList

    -

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_page
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_page
    \ No newline at end of file diff --git a/docs/interfaces/client_api.AddressesApiInterface.html b/docs/interfaces/client_api.AddressesApiInterface.html index 213c3783..a89ac9cb 100644 --- a/docs/interfaces/client_api.AddressesApiInterface.html +++ b/docs/interfaces/client_api.AddressesApiInterface.html @@ -1,6 +1,6 @@ AddressesApiInterface | @coinbase/coinbase-sdk

    Interface AddressesApiInterface

    AddressesApi - interface

    Export

    AddressesApi

    -
    interface AddressesApiInterface {
        createAddress(walletId, createAddressRequest?, options?): AxiosPromise<Address>;
        createPayloadSignature(walletId, addressId, createPayloadSignatureRequest?, options?): AxiosPromise<PayloadSignature>;
        getAddress(walletId, addressId, options?): AxiosPromise<Address>;
        getAddressBalance(walletId, addressId, assetId, options?): AxiosPromise<Balance>;
        getPayloadSignature(walletId, addressId, payloadSignatureId, options?): AxiosPromise<PayloadSignature>;
        listAddressBalances(walletId, addressId, page?, options?): AxiosPromise<AddressBalanceList>;
        listAddresses(walletId, limit?, page?, options?): AxiosPromise<AddressList>;
        listPayloadSignatures(walletId, addressId, limit?, page?, options?): AxiosPromise<PayloadSignatureList>;
        requestFaucetFunds(walletId, addressId, assetId?, options?): AxiosPromise<FaucetTransaction>;
    }

    Implemented by

    Methods

    createAddress +
    interface AddressesApiInterface {
        createAddress(walletId, createAddressRequest?, options?): AxiosPromise<Address>;
        createPayloadSignature(walletId, addressId, createPayloadSignatureRequest?, options?): AxiosPromise<PayloadSignature>;
        getAddress(walletId, addressId, options?): AxiosPromise<Address>;
        getAddressBalance(walletId, addressId, assetId, options?): AxiosPromise<Balance>;
        getPayloadSignature(walletId, addressId, payloadSignatureId, options?): AxiosPromise<PayloadSignature>;
        listAddressBalances(walletId, addressId, page?, options?): AxiosPromise<AddressBalanceList>;
        listAddresses(walletId, limit?, page?, options?): AxiosPromise<AddressList>;
        listPayloadSignatures(walletId, addressId, limit?, page?, options?): AxiosPromise<PayloadSignatureList>;
        requestFaucetFunds(walletId, addressId, assetId?, options?): AxiosPromise<FaucetTransaction>;
    }

    Implemented by

    Methods

    createAddress createPayloadSignature getAddress getAddressBalance @@ -14,47 +14,47 @@
  • Optional createAddressRequest: CreateAddressRequest
  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns AxiosPromise<Address>

    Summary

    Create a new address

    Throws

    Memberof

    AddressesApiInterface

    -

    createPayloadSignature

    • createPayloadSignature(walletId, addressId, createPayloadSignatureRequest?, options?): AxiosPromise<PayloadSignature>

    • Create a new payload signature with an address.

      +

    createPayloadSignature

    • createPayloadSignature(walletId, addressId, createPayloadSignatureRequest?, options?): AxiosPromise<PayloadSignature>

    • Create a new payload signature with an address.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The onchain address of the address to sign the payload with.

      • Optional createPayloadSignatureRequest: CreatePayloadSignatureRequest
      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<PayloadSignature>

      Summary

      Create a new payload signature.

      Throws

      Memberof

      AddressesApiInterface

      -

    getAddress

    getAddress

    • getAddress(walletId, addressId, options?): AxiosPromise<Address>

    • Get address

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The onchain address of the address that is being fetched.

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<Address>

      Summary

      Get address by onchain address

      Throws

      Memberof

      AddressesApiInterface

      -

    getAddressBalance

    getAddressBalance

    • getAddressBalance(walletId, addressId, assetId, options?): AxiosPromise<Balance>

    • Get address balance

      Parameters

      • walletId: string

        The ID of the wallet to fetch the balance for

      • addressId: string

        The onchain address of the address that is being fetched.

      • assetId: string

        The symbol of the asset to fetch the balance for

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<Balance>

      Summary

      Get address balance for asset

      Throws

      Memberof

      AddressesApiInterface

      -

    getPayloadSignature

    getPayloadSignature

    • getPayloadSignature(walletId, addressId, payloadSignatureId, options?): AxiosPromise<PayloadSignature>

    • Get payload signature.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The onchain address of the address that signed the payload.

      • payloadSignatureId: string

        The ID of the payload signature to fetch.

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<PayloadSignature>

      Summary

      Get payload signature.

      Throws

      Memberof

      AddressesApiInterface

      -

    listAddressBalances

    listAddressBalances

    • listAddressBalances(walletId, addressId, page?, options?): AxiosPromise<AddressBalanceList>

    • Get address balances

      Parameters

      • walletId: string

        The ID of the wallet to fetch the balances for

      • addressId: string

        The onchain address of the address that is being fetched.

      • Optional page: string

        A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<AddressBalanceList>

      Summary

      Get all balances for address

      Throws

      Memberof

      AddressesApiInterface

      -

    listAddresses

    listAddresses

    • listAddresses(walletId, limit?, page?, options?): AxiosPromise<AddressList>

    • List addresses in the wallet.

      Parameters

      • walletId: string

        The ID of the wallet whose addresses to fetch

      • Optional limit: number

        A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

      • Optional page: string

        A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<AddressList>

      Summary

      List addresses in a wallet.

      Throws

      Memberof

      AddressesApiInterface

      -

    listPayloadSignatures

    listPayloadSignatures

    • listPayloadSignatures(walletId, addressId, limit?, page?, options?): AxiosPromise<PayloadSignatureList>

    • List payload signatures for an address.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The onchain address of the address whose payload signatures to fetch.

      • Optional limit: number

        A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

        @@ -62,11 +62,11 @@

        Throws

        Memberof

        AddressesApiInterface

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<PayloadSignatureList>

      Summary

      List payload signatures for an address.

      Throws

      Memberof

      AddressesApiInterface

      -

    requestFaucetFunds

    requestFaucetFunds

    • requestFaucetFunds(walletId, addressId, assetId?, options?): AxiosPromise<FaucetTransaction>

    • Request faucet funds to be sent to onchain address.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The onchain address of the address that is being fetched.

      • Optional assetId: string

        The ID of the asset to transfer from the faucet.

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<FaucetTransaction>

      Summary

      Request faucet funds for onchain address.

      Throws

      Memberof

      AddressesApiInterface

      -

    Settings

    Member Visibility

    Theme

    On This Page

    createAddresscreatePayloadSignaturegetAddressgetAddressBalancegetPayloadSignaturelistAddressBalanceslistAddresseslistPayloadSignaturesrequestFaucetFunds
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    createAddresscreatePayloadSignaturegetAddressgetAddressBalancegetPayloadSignaturelistAddressBalanceslistAddresseslistPayloadSignaturesrequestFaucetFunds
    \ No newline at end of file diff --git a/docs/interfaces/client_api.Asset.html b/docs/interfaces/client_api.Asset.html index d0aa69f2..652cdf50 100644 --- a/docs/interfaces/client_api.Asset.html +++ b/docs/interfaces/client_api.Asset.html @@ -1,15 +1,15 @@ Asset | @coinbase/coinbase-sdk

    Interface Asset

    An asset onchain scoped to a particular network, e.g. ETH on base-sepolia, or the USDC ERC20 Token on ethereum-mainnet.

    Export

    Asset

    -
    interface Asset {
        asset_id: string;
        contract_address?: string;
        decimals?: number;
        network_id: string;
    }

    Properties

    asset_id +
    interface Asset {
        asset_id: string;
        contract_address?: string;
        decimals?: number;
        network_id: string;
    }

    Properties

    asset_id contract_address? decimals? network_id

    Properties

    asset_id

    asset_id: string

    The ID for the asset on the network

    Memberof

    Asset

    -

    Optional contract_address

    contract_address?: string

    The optional contract address for the asset. This will be specified for smart contract-based assets, for example ERC20s.

    +

    Optional contract_address

    contract_address?: string

    The optional contract address for the asset. This will be specified for smart contract-based assets, for example ERC20s.

    Memberof

    Asset

    -

    Optional decimals

    decimals?: number

    The number of decimals the asset supports. This is used to convert from atomic units to base units.

    +

    Optional decimals

    decimals?: number

    The number of decimals the asset supports. This is used to convert from atomic units to base units.

    Memberof

    Asset

    -

    network_id

    network_id: string

    The ID of the blockchain network

    +

    network_id

    network_id: string

    The ID of the blockchain network

    Memberof

    Asset

    -

    Settings

    Member Visibility

    Theme

    On This Page

    asset_idcontract_addressdecimalsnetwork_id
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    asset_idcontract_addressdecimalsnetwork_id
    \ No newline at end of file diff --git a/docs/interfaces/client_api.AssetsApiInterface.html b/docs/interfaces/client_api.AssetsApiInterface.html index 5a04340a..beb7b0da 100644 --- a/docs/interfaces/client_api.AssetsApiInterface.html +++ b/docs/interfaces/client_api.AssetsApiInterface.html @@ -1,10 +1,10 @@ AssetsApiInterface | @coinbase/coinbase-sdk

    Interface AssetsApiInterface

    AssetsApi - interface

    Export

    AssetsApi

    -
    interface AssetsApiInterface {
        getAsset(networkId, assetId, options?): AxiosPromise<Asset>;
    }

    Implemented by

    Methods

    getAsset +
    interface AssetsApiInterface {
        getAsset(networkId, assetId, options?): AxiosPromise<Asset>;
    }

    Implemented by

    Methods

    getAsset

    Methods

    getAsset

    • getAsset(networkId, assetId, options?): AxiosPromise<Asset>

    • Get the asset for the specified asset ID.

      Parameters

      • networkId: string

        The ID of the blockchain network

      • assetId: string

        The ID of the asset to fetch. This could be a symbol or an ERC20 contract address.

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<Asset>

      Summary

      Get the asset for the specified asset ID.

      Throws

      Memberof

      AssetsApiInterface

      -

    Settings

    Member Visibility

    Theme

    On This Page

    getAsset
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    getAsset
    \ No newline at end of file diff --git a/docs/interfaces/client_api.Balance.html b/docs/interfaces/client_api.Balance.html index dced9b8b..33e033c0 100644 --- a/docs/interfaces/client_api.Balance.html +++ b/docs/interfaces/client_api.Balance.html @@ -1,8 +1,8 @@ Balance | @coinbase/coinbase-sdk

    Interface Balance

    The balance of an asset onchain

    Export

    Balance

    -
    interface Balance {
        amount: string;
        asset: Asset;
    }

    Properties

    amount +
    interface Balance {
        amount: string;
        asset: Asset;
    }

    Properties

    amount asset

    Properties

    amount

    amount: string

    The amount in the atomic units of the asset

    Memberof

    Balance

    -

    asset

    asset: Asset

    Memberof

    Balance

    -

    Settings

    Member Visibility

    Theme

    On This Page

    amountasset
    \ No newline at end of file +

    asset

    asset: Asset

    Memberof

    Balance

    +

    Settings

    Member Visibility

    Theme

    On This Page

    amountasset
    \ No newline at end of file diff --git a/docs/interfaces/client_api.BalanceHistoryApiInterface.html b/docs/interfaces/client_api.BalanceHistoryApiInterface.html index 18ef9012..d5674c84 100644 --- a/docs/interfaces/client_api.BalanceHistoryApiInterface.html +++ b/docs/interfaces/client_api.BalanceHistoryApiInterface.html @@ -1,6 +1,6 @@ BalanceHistoryApiInterface | @coinbase/coinbase-sdk

    Interface BalanceHistoryApiInterface

    BalanceHistoryApi - interface

    Export

    BalanceHistoryApi

    -
    interface BalanceHistoryApiInterface {
        listAddressHistoricalBalance(networkId, addressId, assetId, limit?, page?, options?): AxiosPromise<AddressHistoricalBalanceList>;
    }

    Implemented by

    Methods

    listAddressHistoricalBalance +
    interface BalanceHistoryApiInterface {
        listAddressHistoricalBalance(networkId, addressId, assetId, limit?, page?, options?): AxiosPromise<AddressHistoricalBalanceList>;
    }

    Implemented by

    Methods

    listAddressHistoricalBalance

    Methods

    listAddressHistoricalBalance

    • listAddressHistoricalBalance(networkId, addressId, assetId, limit?, page?, options?): AxiosPromise<AddressHistoricalBalanceList>

    • List the historical balance of an asset in a specific address.

      Parameters

      • networkId: string

        The ID of the blockchain network

      • addressId: string

        The ID of the address to fetch the historical balance for.

        @@ -10,4 +10,4 @@
      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<AddressHistoricalBalanceList>

      Summary

      Get address balance history for asset

      Throws

      Memberof

      BalanceHistoryApiInterface

      -

    Settings

    Member Visibility

    Theme

    On This Page

    listAddressHistoricalBalance
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    listAddressHistoricalBalance
    \ No newline at end of file diff --git a/docs/interfaces/client_api.BroadcastContractInvocationRequest.html b/docs/interfaces/client_api.BroadcastContractInvocationRequest.html index ab543038..59f2b4b2 100644 --- a/docs/interfaces/client_api.BroadcastContractInvocationRequest.html +++ b/docs/interfaces/client_api.BroadcastContractInvocationRequest.html @@ -1,5 +1,5 @@ BroadcastContractInvocationRequest | @coinbase/coinbase-sdk

    Interface BroadcastContractInvocationRequest

    Export

    BroadcastContractInvocationRequest

    -
    interface BroadcastContractInvocationRequest {
        signed_payload: string;
    }

    Properties

    signed_payload +
    interface BroadcastContractInvocationRequest {
        signed_payload: string;
    }

    Properties

    signed_payload

    Properties

    signed_payload

    signed_payload: string

    The hex-encoded signed payload of the contract invocation

    Memberof

    BroadcastContractInvocationRequest

    -

    Settings

    Member Visibility

    Theme

    On This Page

    signed_payload
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    signed_payload
    \ No newline at end of file diff --git a/docs/interfaces/client_api.BroadcastStakingOperationRequest.html b/docs/interfaces/client_api.BroadcastStakingOperationRequest.html index 1d0a79cf..fc0203ca 100644 --- a/docs/interfaces/client_api.BroadcastStakingOperationRequest.html +++ b/docs/interfaces/client_api.BroadcastStakingOperationRequest.html @@ -1,8 +1,8 @@ BroadcastStakingOperationRequest | @coinbase/coinbase-sdk

    Interface BroadcastStakingOperationRequest

    Export

    BroadcastStakingOperationRequest

    -
    interface BroadcastStakingOperationRequest {
        signed_payload: string;
        transaction_index: number;
    }

    Properties

    signed_payload +
    interface BroadcastStakingOperationRequest {
        signed_payload: string;
        transaction_index: number;
    }

    Properties

    signed_payload transaction_index

    Properties

    signed_payload

    signed_payload: string

    The hex-encoded signed payload of the staking operation.

    Memberof

    BroadcastStakingOperationRequest

    -

    transaction_index

    transaction_index: number

    The index in the transaction array of the staking operation.

    +

    transaction_index

    transaction_index: number

    The index in the transaction array of the staking operation.

    Memberof

    BroadcastStakingOperationRequest

    -

    Settings

    Member Visibility

    Theme

    On This Page

    signed_payloadtransaction_index
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    signed_payloadtransaction_index
    \ No newline at end of file diff --git a/docs/interfaces/client_api.BroadcastTradeRequest.html b/docs/interfaces/client_api.BroadcastTradeRequest.html index 807a970f..bb938241 100644 --- a/docs/interfaces/client_api.BroadcastTradeRequest.html +++ b/docs/interfaces/client_api.BroadcastTradeRequest.html @@ -1,8 +1,8 @@ BroadcastTradeRequest | @coinbase/coinbase-sdk

    Interface BroadcastTradeRequest

    Export

    BroadcastTradeRequest

    -
    interface BroadcastTradeRequest {
        approve_transaction_signed_payload?: string;
        signed_payload: string;
    }

    Properties

    approve_transaction_signed_payload? +
    interface BroadcastTradeRequest {
        approve_transaction_signed_payload?: string;
        signed_payload: string;
    }

    Properties

    approve_transaction_signed_payload? signed_payload

    Properties

    Optional approve_transaction_signed_payload

    approve_transaction_signed_payload?: string

    The hex-encoded signed payload of the approval transaction

    Memberof

    BroadcastTradeRequest

    -

    signed_payload

    signed_payload: string

    The hex-encoded signed payload of the trade

    +

    signed_payload

    signed_payload: string

    The hex-encoded signed payload of the trade

    Memberof

    BroadcastTradeRequest

    -

    Settings

    Member Visibility

    Theme

    On This Page

    approve_transaction_signed_payloadsigned_payload
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    approve_transaction_signed_payloadsigned_payload
    \ No newline at end of file diff --git a/docs/interfaces/client_api.BroadcastTransferRequest.html b/docs/interfaces/client_api.BroadcastTransferRequest.html index 2b2514a2..a079c989 100644 --- a/docs/interfaces/client_api.BroadcastTransferRequest.html +++ b/docs/interfaces/client_api.BroadcastTransferRequest.html @@ -1,5 +1,5 @@ BroadcastTransferRequest | @coinbase/coinbase-sdk

    Interface BroadcastTransferRequest

    Export

    BroadcastTransferRequest

    -
    interface BroadcastTransferRequest {
        signed_payload: string;
    }

    Properties

    signed_payload +
    interface BroadcastTransferRequest {
        signed_payload: string;
    }

    Properties

    signed_payload

    Properties

    signed_payload

    signed_payload: string

    The hex-encoded signed payload of the transfer

    Memberof

    BroadcastTransferRequest

    -

    Settings

    Member Visibility

    Theme

    On This Page

    signed_payload
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    signed_payload
    \ No newline at end of file diff --git a/docs/interfaces/client_api.BuildStakingOperationRequest.html b/docs/interfaces/client_api.BuildStakingOperationRequest.html index bc61ce1f..350e1527 100644 --- a/docs/interfaces/client_api.BuildStakingOperationRequest.html +++ b/docs/interfaces/client_api.BuildStakingOperationRequest.html @@ -1,16 +1,16 @@ BuildStakingOperationRequest | @coinbase/coinbase-sdk

    Interface BuildStakingOperationRequest

    Export

    BuildStakingOperationRequest

    -
    interface BuildStakingOperationRequest {
        action: string;
        address_id: string;
        asset_id: string;
        network_id: string;
        options: {
            [key: string]: string;
        };
    }

    Properties

    action +
    interface BuildStakingOperationRequest {
        action: string;
        address_id: string;
        asset_id: string;
        network_id: string;
        options: {
            [key: string]: string;
        };
    }

    Properties

    action address_id asset_id network_id options

    Properties

    action

    action: string

    The type of staking operation

    Memberof

    BuildStakingOperationRequest

    -

    address_id

    address_id: string

    The onchain address from which the staking transaction originates and is responsible for signing the transaction.

    +

    address_id

    address_id: string

    The onchain address from which the staking transaction originates and is responsible for signing the transaction.

    Memberof

    BuildStakingOperationRequest

    -

    asset_id

    asset_id: string

    The ID of the asset being staked

    +

    asset_id

    asset_id: string

    The ID of the asset being staked

    Memberof

    BuildStakingOperationRequest

    -

    network_id

    network_id: string

    The ID of the blockchain network

    +

    network_id

    network_id: string

    The ID of the blockchain network

    Memberof

    BuildStakingOperationRequest

    -

    options

    options: {
        [key: string]: string;
    }

    Type declaration

    • [key: string]: string

    Memberof

    BuildStakingOperationRequest

    -

    Settings

    Member Visibility

    Theme

    On This Page

    actionaddress_idasset_idnetwork_idoptions
    \ No newline at end of file +

    options

    options: {
        [key: string]: string;
    }

    Type declaration

    • [key: string]: string

    Memberof

    BuildStakingOperationRequest

    +

    Settings

    Member Visibility

    Theme

    On This Page

    actionaddress_idasset_idnetwork_idoptions
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ContractEvent.html b/docs/interfaces/client_api.ContractEvent.html index 9b4d17ab..2fc96c4c 100644 --- a/docs/interfaces/client_api.ContractEvent.html +++ b/docs/interfaces/client_api.ContractEvent.html @@ -1,6 +1,6 @@ ContractEvent | @coinbase/coinbase-sdk

    Interface ContractEvent

    Represents a single decoded event emitted by a smart contract

    Export

    ContractEvent

    -
    interface ContractEvent {
        block_height: number;
        block_time: string;
        contract_address: string;
        contract_name: string;
        data: string;
        event_index: number;
        event_name: string;
        four_bytes: string;
        network_id: string;
        protocol_name: string;
        sig: string;
        tx_hash: string;
        tx_index: number;
    }

    Properties

    block_height +
    interface ContractEvent {
        block_height: number;
        block_time: string;
        contract_address: string;
        contract_name: string;
        data: string;
        event_index: number;
        event_name: string;
        four_bytes: string;
        network_id: string;
        protocol_name: string;
        sig: string;
        tx_hash: string;
        tx_index: number;
    }

    Properties

    block_height block_time contract_address contract_name @@ -15,28 +15,28 @@ tx_index

    Properties

    block_height

    block_height: number

    The block number in which the event was emitted

    Memberof

    ContractEvent

    -

    block_time

    block_time: string

    The timestamp of the block in which the event was emitted

    +

    block_time

    block_time: string

    The timestamp of the block in which the event was emitted

    Memberof

    ContractEvent

    -

    contract_address

    contract_address: string

    The EVM address of the smart contract

    +

    contract_address

    contract_address: string

    The EVM address of the smart contract

    Memberof

    ContractEvent

    -

    contract_name

    contract_name: string

    The name of the specific contract within the project

    +

    contract_name

    contract_name: string

    The name of the specific contract within the project

    Memberof

    ContractEvent

    -

    data

    data: string

    The event data in a stringified format

    +

    data

    data: string

    The event data in a stringified format

    Memberof

    ContractEvent

    -

    event_index

    event_index: number

    The index of the event within the transaction

    +

    event_index

    event_index: number

    The index of the event within the transaction

    Memberof

    ContractEvent

    -

    event_name

    event_name: string

    The name of the event emitted by the contract

    +

    event_name

    event_name: string

    The name of the event emitted by the contract

    Memberof

    ContractEvent

    -

    four_bytes

    four_bytes: string

    The first four bytes of the Keccak hash of the event signature

    +

    four_bytes

    four_bytes: string

    The first four bytes of the Keccak hash of the event signature

    Memberof

    ContractEvent

    -

    network_id

    network_id: string

    The name of the blockchain network

    +

    network_id

    network_id: string

    The name of the blockchain network

    Memberof

    ContractEvent

    -

    protocol_name

    protocol_name: string

    The name of the blockchain project or protocol

    +

    protocol_name

    protocol_name: string

    The name of the blockchain project or protocol

    Memberof

    ContractEvent

    -

    sig

    sig: string

    The signature of the event, including parameter types

    +

    sig

    sig: string

    The signature of the event, including parameter types

    Memberof

    ContractEvent

    -

    tx_hash

    tx_hash: string

    The transaction hash in which the event was emitted

    +

    tx_hash

    tx_hash: string

    The transaction hash in which the event was emitted

    Memberof

    ContractEvent

    -

    tx_index

    tx_index: number

    The index of the transaction within the block

    +

    tx_index

    tx_index: number

    The index of the transaction within the block

    Memberof

    ContractEvent

    -

    Settings

    Member Visibility

    Theme

    On This Page

    block_heightblock_timecontract_addresscontract_namedataevent_indexevent_namefour_bytesnetwork_idprotocol_namesigtx_hashtx_index
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    block_heightblock_timecontract_addresscontract_namedataevent_indexevent_namefour_bytesnetwork_idprotocol_namesigtx_hashtx_index
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ContractEventList.html b/docs/interfaces/client_api.ContractEventList.html index 4fbabf68..a5af059d 100644 --- a/docs/interfaces/client_api.ContractEventList.html +++ b/docs/interfaces/client_api.ContractEventList.html @@ -1,12 +1,12 @@ ContractEventList | @coinbase/coinbase-sdk

    Interface ContractEventList

    A list of contract events with pagination information

    Export

    ContractEventList

    -
    interface ContractEventList {
        data: ContractEvent[];
        has_more: boolean;
        next_page: string;
    }

    Properties

    data +
    interface ContractEventList {
        data: ContractEvent[];
        has_more: boolean;
        next_page: string;
    }

    Properties

    data has_more next_page

    Properties

    data

    data: ContractEvent[]

    An array of ContractEvent objects

    Memberof

    ContractEventList

    -

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched

    +

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched

    Memberof

    ContractEventList

    -

    next_page

    next_page: string

    The page token to be used to fetch the next page

    +

    next_page

    next_page: string

    The page token to be used to fetch the next page

    Memberof

    ContractEventList

    -

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_page
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_page
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ContractEventsApiInterface.html b/docs/interfaces/client_api.ContractEventsApiInterface.html index b990373b..fe0e551a 100644 --- a/docs/interfaces/client_api.ContractEventsApiInterface.html +++ b/docs/interfaces/client_api.ContractEventsApiInterface.html @@ -1,6 +1,6 @@ ContractEventsApiInterface | @coinbase/coinbase-sdk

    Interface ContractEventsApiInterface

    ContractEventsApi - interface

    Export

    ContractEventsApi

    -
    interface ContractEventsApiInterface {
        listContractEvents(networkId, protocolName, contractAddress, contractName, eventName, fromBlockHeight, toBlockHeight, nextPage?, options?): AxiosPromise<ContractEventList>;
    }

    Implemented by

    Methods

    listContractEvents +
    interface ContractEventsApiInterface {
        listContractEvents(networkId, protocolName, contractAddress, contractName, eventName, fromBlockHeight, toBlockHeight, nextPage?, options?): AxiosPromise<ContractEventList>;
    }

    Implemented by

    Methods

    listContractEvents

    Methods

    listContractEvents

    • listContractEvents(networkId, protocolName, contractAddress, contractName, eventName, fromBlockHeight, toBlockHeight, nextPage?, options?): AxiosPromise<ContractEventList>

    • Retrieve events for a specific contract

      Parameters

      • networkId: string

        Unique identifier for the blockchain network

      • protocolName: string

        Case-sensitive name of the blockchain protocol

        @@ -13,4 +13,4 @@
      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<ContractEventList>

      Summary

      List contract events

      Throws

      Memberof

      ContractEventsApiInterface

      -

    Settings

    Member Visibility

    Theme

    On This Page

    listContractEvents
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    listContractEvents
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ContractInvocation.html b/docs/interfaces/client_api.ContractInvocation.html index 202acba3..1b6ad022 100644 --- a/docs/interfaces/client_api.ContractInvocation.html +++ b/docs/interfaces/client_api.ContractInvocation.html @@ -1,6 +1,6 @@ ContractInvocation | @coinbase/coinbase-sdk

    Interface ContractInvocation

    A contract invocation onchain.

    Export

    ContractInvocation

    -
    interface ContractInvocation {
        abi?: string;
        address_id: string;
        amount: string;
        args: string;
        contract_address: string;
        contract_invocation_id: string;
        method: string;
        network_id: string;
        transaction: Transaction;
        wallet_id: string;
    }

    Properties

    abi? +
    interface ContractInvocation {
        abi?: string;
        address_id: string;
        amount: string;
        args: string;
        contract_address: string;
        contract_invocation_id: string;
        method: string;
        network_id: string;
        transaction: Transaction;
        wallet_id: string;
    }

    Properties

    abi? address_id amount args @@ -12,21 +12,21 @@ wallet_id

    Properties

    Optional abi

    abi?: string

    The JSON-encoded ABI of the contract.

    Memberof

    ContractInvocation

    -

    address_id

    address_id: string

    The onchain address of the address invoking the contract.

    +

    address_id

    address_id: string

    The onchain address of the address invoking the contract.

    Memberof

    ContractInvocation

    -

    amount

    amount: string

    The amount to send to the contract for a payable method

    +

    amount

    amount: string

    The amount to send to the contract for a payable method

    Memberof

    ContractInvocation

    -

    args

    args: string

    The JSON-encoded arguments to pass to the contract method. The keys should be the argument names and the values should be the argument values.

    +

    args

    args: string

    The JSON-encoded arguments to pass to the contract method. The keys should be the argument names and the values should be the argument values.

    Memberof

    ContractInvocation

    -

    contract_address

    contract_address: string

    The onchain address of the contract.

    +

    contract_address

    contract_address: string

    The onchain address of the contract.

    Memberof

    ContractInvocation

    -

    contract_invocation_id

    contract_invocation_id: string

    The ID of the contract invocation.

    +

    contract_invocation_id

    contract_invocation_id: string

    The ID of the contract invocation.

    Memberof

    ContractInvocation

    -

    method

    method: string

    The method to be invoked on the contract.

    +

    method

    method: string

    The method to be invoked on the contract.

    Memberof

    ContractInvocation

    -

    network_id

    network_id: string

    The ID of the blockchain network.

    +

    network_id

    network_id: string

    The ID of the blockchain network.

    Memberof

    ContractInvocation

    -

    transaction

    transaction: Transaction

    Memberof

    ContractInvocation

    -

    wallet_id

    wallet_id: string

    The ID of the wallet that owns the address.

    +

    transaction

    transaction: Transaction

    Memberof

    ContractInvocation

    +

    wallet_id

    wallet_id: string

    The ID of the wallet that owns the address.

    Memberof

    ContractInvocation

    -

    Settings

    Member Visibility

    Theme

    On This Page

    abiaddress_idamountargscontract_addresscontract_invocation_idmethodnetwork_idtransactionwallet_id
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    abiaddress_idamountargscontract_addresscontract_invocation_idmethodnetwork_idtransactionwallet_id
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ContractInvocationList.html b/docs/interfaces/client_api.ContractInvocationList.html index 8676be4a..8db4a0f0 100644 --- a/docs/interfaces/client_api.ContractInvocationList.html +++ b/docs/interfaces/client_api.ContractInvocationList.html @@ -1,13 +1,13 @@ ContractInvocationList | @coinbase/coinbase-sdk

    Interface ContractInvocationList

    Export

    ContractInvocationList

    -
    interface ContractInvocationList {
        data: ContractInvocation[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data +
    interface ContractInvocationList {
        data: ContractInvocation[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data has_more next_page total_count

    Properties

    data

    data: ContractInvocation[]

    Memberof

    ContractInvocationList

    -

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    ContractInvocationList

    -

    next_page

    next_page: string

    The page token to be used to fetch the next page.

    +

    next_page

    next_page: string

    The page token to be used to fetch the next page.

    Memberof

    ContractInvocationList

    -

    total_count

    total_count: number

    The total number of contract invocations for the address in the wallet.

    +

    total_count

    total_count: number

    The total number of contract invocations for the address in the wallet.

    Memberof

    ContractInvocationList

    -

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_pagetotal_count
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_pagetotal_count
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ContractInvocationsApiInterface.html b/docs/interfaces/client_api.ContractInvocationsApiInterface.html index 035b32a9..82a00d7d 100644 --- a/docs/interfaces/client_api.ContractInvocationsApiInterface.html +++ b/docs/interfaces/client_api.ContractInvocationsApiInterface.html @@ -1,6 +1,6 @@ ContractInvocationsApiInterface | @coinbase/coinbase-sdk

    Interface ContractInvocationsApiInterface

    ContractInvocationsApi - interface

    Export

    ContractInvocationsApi

    -
    interface ContractInvocationsApiInterface {
        broadcastContractInvocation(walletId, addressId, contractInvocationId, broadcastContractInvocationRequest, options?): AxiosPromise<ContractInvocation>;
        createContractInvocation(walletId, addressId, createContractInvocationRequest, options?): AxiosPromise<ContractInvocation>;
        getContractInvocation(walletId, addressId, contractInvocationId, options?): AxiosPromise<ContractInvocation>;
        listContractInvocations(walletId, addressId, limit?, page?, options?): AxiosPromise<ContractInvocationList>;
    }

    Implemented by

    Methods

    broadcastContractInvocation +
    interface ContractInvocationsApiInterface {
        broadcastContractInvocation(walletId, addressId, contractInvocationId, broadcastContractInvocationRequest, options?): AxiosPromise<ContractInvocation>;
        createContractInvocation(walletId, addressId, createContractInvocationRequest, options?): AxiosPromise<ContractInvocation>;
        getContractInvocation(walletId, addressId, contractInvocationId, options?): AxiosPromise<ContractInvocation>;
        listContractInvocations(walletId, addressId, limit?, page?, options?): AxiosPromise<ContractInvocationList>;
    }

    Implemented by

    Methods

    broadcastContractInvocation createContractInvocation getContractInvocation listContractInvocations @@ -11,20 +11,20 @@
  • broadcastContractInvocationRequest: BroadcastContractInvocationRequest
  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns AxiosPromise<ContractInvocation>

    Summary

    Broadcast a contract invocation.

    Throws

    Memberof

    ContractInvocationsApiInterface

    -

    createContractInvocation

    createContractInvocation

    • createContractInvocation(walletId, addressId, createContractInvocationRequest, options?): AxiosPromise<ContractInvocation>

    • Create a new contract invocation.

      Parameters

      • walletId: string

        The ID of the wallet the source address belongs to.

      • addressId: string

        The ID of the address to invoke the contract from.

      • createContractInvocationRequest: CreateContractInvocationRequest
      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<ContractInvocation>

      Summary

      Create a new contract invocation for an address.

      Throws

      Memberof

      ContractInvocationsApiInterface

      -

    getContractInvocation

    getContractInvocation

    • getContractInvocation(walletId, addressId, contractInvocationId, options?): AxiosPromise<ContractInvocation>

    • Get a contract invocation by ID.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The ID of the address the contract invocation belongs to.

      • contractInvocationId: string

        The ID of the contract invocation to fetch.

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<ContractInvocation>

      Summary

      Get a contract invocation by ID.

      Throws

      Memberof

      ContractInvocationsApiInterface

      -

    listContractInvocations

    listContractInvocations

    • listContractInvocations(walletId, addressId, limit?, page?, options?): AxiosPromise<ContractInvocationList>

    • List contract invocations for an address.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The ID of the address to list contract invocations for.

      • Optional limit: number

        A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

        @@ -32,4 +32,4 @@

        Throws

        Memberof

        ContractInvocationsApiInterface

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<ContractInvocationList>

      Summary

      List contract invocations for an address.

      Throws

      Memberof

      ContractInvocationsApiInterface

      -

    Settings

    Member Visibility

    Theme

    On This Page

    broadcastContractInvocationcreateContractInvocationgetContractInvocationlistContractInvocations
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    broadcastContractInvocationcreateContractInvocationgetContractInvocationlistContractInvocations
    \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateAddressRequest.html b/docs/interfaces/client_api.CreateAddressRequest.html index b352b59c..570d280a 100644 --- a/docs/interfaces/client_api.CreateAddressRequest.html +++ b/docs/interfaces/client_api.CreateAddressRequest.html @@ -1,11 +1,11 @@ CreateAddressRequest | @coinbase/coinbase-sdk

    Interface CreateAddressRequest

    Export

    CreateAddressRequest

    -
    interface CreateAddressRequest {
        address_index?: number;
        attestation?: string;
        public_key?: string;
    }

    Properties

    address_index? +
    interface CreateAddressRequest {
        address_index?: number;
        attestation?: string;
        public_key?: string;
    }

    Properties

    address_index? attestation? public_key?

    Properties

    Optional address_index

    address_index?: number

    The index of the address within the wallet.

    Memberof

    CreateAddressRequest

    -

    Optional attestation

    attestation?: string

    An attestation signed by the private key that is associated with the wallet. The attestation will be a hex-encoded signature of a json payload with fields wallet_id and public_key, signed by the private key associated with the public_key set in the request.

    +

    Optional attestation

    attestation?: string

    An attestation signed by the private key that is associated with the wallet. The attestation will be a hex-encoded signature of a json payload with fields wallet_id and public_key, signed by the private key associated with the public_key set in the request.

    Memberof

    CreateAddressRequest

    -

    Optional public_key

    public_key?: string

    The public key from which the address will be derived.

    +

    Optional public_key

    public_key?: string

    The public key from which the address will be derived.

    Memberof

    CreateAddressRequest

    -

    Settings

    Member Visibility

    Theme

    On This Page

    address_indexattestationpublic_key
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    address_indexattestationpublic_key
    \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateContractInvocationRequest.html b/docs/interfaces/client_api.CreateContractInvocationRequest.html index bb6685a4..2f5e7615 100644 --- a/docs/interfaces/client_api.CreateContractInvocationRequest.html +++ b/docs/interfaces/client_api.CreateContractInvocationRequest.html @@ -1,17 +1,17 @@ CreateContractInvocationRequest | @coinbase/coinbase-sdk

    Interface CreateContractInvocationRequest

    Export

    CreateContractInvocationRequest

    -
    interface CreateContractInvocationRequest {
        abi?: string;
        amount?: string;
        args: string;
        contract_address: string;
        method: string;
    }

    Properties

    abi? +
    interface CreateContractInvocationRequest {
        abi?: string;
        amount?: string;
        args: string;
        contract_address: string;
        method: string;
    }

    Properties

    abi? amount? args contract_address method

    Properties

    Optional abi

    abi?: string

    The JSON-encoded ABI of the contract.

    Memberof

    CreateContractInvocationRequest

    -

    Optional amount

    amount?: string

    The amount in atomic units of the native asset to send to the contract for a payable method

    +

    Optional amount

    amount?: string

    The amount in atomic units of the native asset to send to the contract for a payable method

    Memberof

    CreateContractInvocationRequest

    -

    args

    args: string

    The JSON-encoded arguments to pass to the contract method. The keys should be the argument names and the values should be the argument values.

    +

    args

    args: string

    The JSON-encoded arguments to pass to the contract method. The keys should be the argument names and the values should be the argument values.

    Memberof

    CreateContractInvocationRequest

    -

    contract_address

    contract_address: string

    The address of the contract to invoke.

    +

    contract_address

    contract_address: string

    The address of the contract to invoke.

    Memberof

    CreateContractInvocationRequest

    -

    method

    method: string

    The method to invoke on the contract.

    +

    method

    method: string

    The method to invoke on the contract.

    Memberof

    CreateContractInvocationRequest

    -

    Settings

    Member Visibility

    Theme

    On This Page

    abiamountargscontract_addressmethod
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    abiamountargscontract_addressmethod
    \ No newline at end of file diff --git a/docs/interfaces/client_api.CreatePayloadSignatureRequest.html b/docs/interfaces/client_api.CreatePayloadSignatureRequest.html index 999efeb3..9d1f09cf 100644 --- a/docs/interfaces/client_api.CreatePayloadSignatureRequest.html +++ b/docs/interfaces/client_api.CreatePayloadSignatureRequest.html @@ -1,8 +1,8 @@ CreatePayloadSignatureRequest | @coinbase/coinbase-sdk

    Interface CreatePayloadSignatureRequest

    Export

    CreatePayloadSignatureRequest

    -
    interface CreatePayloadSignatureRequest {
        signature?: string;
        unsigned_payload: string;
    }

    Properties

    signature? +
    interface CreatePayloadSignatureRequest {
        signature?: string;
        unsigned_payload: string;
    }

    Properties

    signature? unsigned_payload

    Properties

    Optional signature

    signature?: string

    The signature of the payload.

    Memberof

    CreatePayloadSignatureRequest

    -

    unsigned_payload

    unsigned_payload: string

    The unsigned payload.

    +

    unsigned_payload

    unsigned_payload: string

    The unsigned payload.

    Memberof

    CreatePayloadSignatureRequest

    -

    Settings

    Member Visibility

    Theme

    On This Page

    signatureunsigned_payload
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    signatureunsigned_payload
    \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateServerSignerRequest.html b/docs/interfaces/client_api.CreateServerSignerRequest.html index eb898ea4..022a1427 100644 --- a/docs/interfaces/client_api.CreateServerSignerRequest.html +++ b/docs/interfaces/client_api.CreateServerSignerRequest.html @@ -1,11 +1,11 @@ CreateServerSignerRequest | @coinbase/coinbase-sdk

    Interface CreateServerSignerRequest

    Export

    CreateServerSignerRequest

    -
    interface CreateServerSignerRequest {
        enrollment_data: string;
        is_mpc: boolean;
        server_signer_id?: string;
    }

    Properties

    enrollment_data +
    interface CreateServerSignerRequest {
        enrollment_data: string;
        is_mpc: boolean;
        server_signer_id?: string;
    }

    Properties

    enrollment_data is_mpc server_signer_id?

    Properties

    enrollment_data

    enrollment_data: string

    The enrollment data of the server signer. This will be the base64 encoded server-signer-id for the 1 of 1 server signer.

    Memberof

    CreateServerSignerRequest

    -

    is_mpc

    is_mpc: boolean

    Whether the Server-Signer uses MPC.

    +

    is_mpc

    is_mpc: boolean

    Whether the Server-Signer uses MPC.

    Memberof

    CreateServerSignerRequest

    -

    Optional server_signer_id

    server_signer_id?: string

    The ID of the server signer for the 1 of 1 server signer.

    +

    Optional server_signer_id

    server_signer_id?: string

    The ID of the server signer for the 1 of 1 server signer.

    Memberof

    CreateServerSignerRequest

    -

    Settings

    Member Visibility

    Theme

    On This Page

    enrollment_datais_mpcserver_signer_id
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    enrollment_datais_mpcserver_signer_id
    \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateSmartContractRequest.html b/docs/interfaces/client_api.CreateSmartContractRequest.html index 9bbd4ef0..76cb0974 100644 --- a/docs/interfaces/client_api.CreateSmartContractRequest.html +++ b/docs/interfaces/client_api.CreateSmartContractRequest.html @@ -1,6 +1,6 @@ CreateSmartContractRequest | @coinbase/coinbase-sdk

    Interface CreateSmartContractRequest

    Export

    CreateSmartContractRequest

    -
    interface CreateSmartContractRequest {
        options: SmartContractOptions;
        type: SmartContractType;
    }

    Properties

    options +
    interface CreateSmartContractRequest {
        options: SmartContractOptions;
        type: SmartContractType;
    }

    Properties

    options type

    Properties

    options

    options: SmartContractOptions

    Memberof

    CreateSmartContractRequest

    -

    type

    type: SmartContractType

    Memberof

    CreateSmartContractRequest

    -

    Settings

    Member Visibility

    Theme

    On This Page

    optionstype
    \ No newline at end of file +

    type

    type: SmartContractType

    Memberof

    CreateSmartContractRequest

    +

    Settings

    Member Visibility

    Theme

    On This Page

    optionstype
    \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateStakingOperationRequest.html b/docs/interfaces/client_api.CreateStakingOperationRequest.html index e1881443..b3850f00 100644 --- a/docs/interfaces/client_api.CreateStakingOperationRequest.html +++ b/docs/interfaces/client_api.CreateStakingOperationRequest.html @@ -1,13 +1,13 @@ CreateStakingOperationRequest | @coinbase/coinbase-sdk

    Interface CreateStakingOperationRequest

    Export

    CreateStakingOperationRequest

    -
    interface CreateStakingOperationRequest {
        action: string;
        asset_id: string;
        network_id: string;
        options: {
            [key: string]: string;
        };
    }

    Properties

    action +
    interface CreateStakingOperationRequest {
        action: string;
        asset_id: string;
        network_id: string;
        options: {
            [key: string]: string;
        };
    }

    Properties

    action asset_id network_id options

    Properties

    action

    action: string

    The type of staking operation.

    Memberof

    CreateStakingOperationRequest

    -

    asset_id

    asset_id: string

    The ID of the asset being staked.

    +

    asset_id

    asset_id: string

    The ID of the asset being staked.

    Memberof

    CreateStakingOperationRequest

    -

    network_id

    network_id: string

    The ID of the blockchain network.

    +

    network_id

    network_id: string

    The ID of the blockchain network.

    Memberof

    CreateStakingOperationRequest

    -

    options

    options: {
        [key: string]: string;
    }

    Type declaration

    • [key: string]: string

    Memberof

    CreateStakingOperationRequest

    -

    Settings

    Member Visibility

    Theme

    On This Page

    actionasset_idnetwork_idoptions
    \ No newline at end of file +

    options

    options: {
        [key: string]: string;
    }

    Type declaration

    • [key: string]: string

    Memberof

    CreateStakingOperationRequest

    +

    Settings

    Member Visibility

    Theme

    On This Page

    actionasset_idnetwork_idoptions
    \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateTradeRequest.html b/docs/interfaces/client_api.CreateTradeRequest.html index 67484e41..7177e1b0 100644 --- a/docs/interfaces/client_api.CreateTradeRequest.html +++ b/docs/interfaces/client_api.CreateTradeRequest.html @@ -1,11 +1,11 @@ CreateTradeRequest | @coinbase/coinbase-sdk

    Interface CreateTradeRequest

    Export

    CreateTradeRequest

    -
    interface CreateTradeRequest {
        amount: string;
        from_asset_id: string;
        to_asset_id: string;
    }

    Properties

    amount +
    interface CreateTradeRequest {
        amount: string;
        from_asset_id: string;
        to_asset_id: string;
    }

    Properties

    amount from_asset_id to_asset_id

    Properties

    amount

    amount: string

    The amount to trade

    Memberof

    CreateTradeRequest

    -

    from_asset_id

    from_asset_id: string

    The ID of the asset to trade

    +

    from_asset_id

    from_asset_id: string

    The ID of the asset to trade

    Memberof

    CreateTradeRequest

    -

    to_asset_id

    to_asset_id: string

    The ID of the asset to receive from the trade

    +

    to_asset_id

    to_asset_id: string

    The ID of the asset to receive from the trade

    Memberof

    CreateTradeRequest

    -

    Settings

    Member Visibility

    Theme

    On This Page

    amountfrom_asset_idto_asset_id
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    amountfrom_asset_idto_asset_id
    \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateTransferRequest.html b/docs/interfaces/client_api.CreateTransferRequest.html index a6eb9c7b..7a9df06e 100644 --- a/docs/interfaces/client_api.CreateTransferRequest.html +++ b/docs/interfaces/client_api.CreateTransferRequest.html @@ -1,17 +1,17 @@ CreateTransferRequest | @coinbase/coinbase-sdk

    Interface CreateTransferRequest

    Export

    CreateTransferRequest

    -
    interface CreateTransferRequest {
        amount: string;
        asset_id: string;
        destination: string;
        gasless?: boolean;
        network_id: string;
    }

    Properties

    amount +
    interface CreateTransferRequest {
        amount: string;
        asset_id: string;
        destination: string;
        gasless?: boolean;
        network_id: string;
    }

    Properties

    amount asset_id destination gasless? network_id

    Properties

    amount

    amount: string

    The amount to transfer

    Memberof

    CreateTransferRequest

    -

    asset_id

    asset_id: string

    The ID of the asset to transfer

    +

    asset_id

    asset_id: string

    The ID of the asset to transfer

    Memberof

    CreateTransferRequest

    -

    destination

    destination: string

    The destination address, which can be a 0x address, Basename, or ENS name

    +

    destination

    destination: string

    The destination address, which can be a 0x address, Basename, or ENS name

    Memberof

    CreateTransferRequest

    -

    Optional gasless

    gasless?: boolean

    Whether the transfer uses sponsored gas

    +

    Optional gasless

    gasless?: boolean

    Whether the transfer uses sponsored gas

    Memberof

    CreateTransferRequest

    -

    network_id

    network_id: string

    The ID of the blockchain network

    +

    network_id

    network_id: string

    The ID of the blockchain network

    Memberof

    CreateTransferRequest

    -

    Settings

    Member Visibility

    Theme

    On This Page

    amountasset_iddestinationgaslessnetwork_id
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    amountasset_iddestinationgaslessnetwork_id
    \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateWalletRequest.html b/docs/interfaces/client_api.CreateWalletRequest.html index 20cdefa3..5aa3ff71 100644 --- a/docs/interfaces/client_api.CreateWalletRequest.html +++ b/docs/interfaces/client_api.CreateWalletRequest.html @@ -1,4 +1,4 @@ CreateWalletRequest | @coinbase/coinbase-sdk

    Interface CreateWalletRequest

    Export

    CreateWalletRequest

    -
    interface CreateWalletRequest {
        wallet: CreateWalletRequestWallet;
    }

    Properties

    wallet +
    interface CreateWalletRequest {
        wallet: CreateWalletRequestWallet;
    }

    Properties

    wallet

    Properties

    wallet

    wallet: CreateWalletRequestWallet

    Memberof

    CreateWalletRequest

    -

    Settings

    Member Visibility

    Theme

    On This Page

    wallet
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    wallet
    \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateWalletRequestWallet.html b/docs/interfaces/client_api.CreateWalletRequestWallet.html index 8e2d554c..e6700d9a 100644 --- a/docs/interfaces/client_api.CreateWalletRequestWallet.html +++ b/docs/interfaces/client_api.CreateWalletRequestWallet.html @@ -1,9 +1,9 @@ CreateWalletRequestWallet | @coinbase/coinbase-sdk

    Interface CreateWalletRequestWallet

    Parameters for configuring a wallet

    Export

    CreateWalletRequestWallet

    -
    interface CreateWalletRequestWallet {
        network_id: string;
        use_server_signer?: boolean;
    }

    Properties

    network_id +
    interface CreateWalletRequestWallet {
        network_id: string;
        use_server_signer?: boolean;
    }

    Properties

    network_id use_server_signer?

    Properties

    network_id

    network_id: string

    The ID of the blockchain network

    Memberof

    CreateWalletRequestWallet

    -

    Optional use_server_signer

    use_server_signer?: boolean

    Whether the wallet should use the project's server signer or if the addresses in the wallets will belong to a private key the developer manages. Defaults to false.

    +

    Optional use_server_signer

    use_server_signer?: boolean

    Whether the wallet should use the project's server signer or if the addresses in the wallets will belong to a private key the developer manages. Defaults to false.

    Memberof

    CreateWalletRequestWallet

    -

    Settings

    Member Visibility

    Theme

    On This Page

    network_iduse_server_signer
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    network_iduse_server_signer
    \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateWalletWebhookRequest.html b/docs/interfaces/client_api.CreateWalletWebhookRequest.html index f7782320..c226a3b2 100644 --- a/docs/interfaces/client_api.CreateWalletWebhookRequest.html +++ b/docs/interfaces/client_api.CreateWalletWebhookRequest.html @@ -1,8 +1,8 @@ CreateWalletWebhookRequest | @coinbase/coinbase-sdk

    Interface CreateWalletWebhookRequest

    Export

    CreateWalletWebhookRequest

    -
    interface CreateWalletWebhookRequest {
        notification_uri: string;
        signature_header?: string;
    }

    Properties

    notification_uri +
    interface CreateWalletWebhookRequest {
        notification_uri: string;
        signature_header?: string;
    }

    Properties

    notification_uri signature_header?

    Properties

    notification_uri

    notification_uri: string

    The URL to which the notifications will be sent.

    Memberof

    CreateWalletWebhookRequest

    -

    Optional signature_header

    signature_header?: string

    The custom header to be used for x-webhook-signature header on callbacks, so developers can verify the requests are coming from Coinbase.

    +

    Optional signature_header

    signature_header?: string

    The custom header to be used for x-webhook-signature header on callbacks, so developers can verify the requests are coming from Coinbase.

    Memberof

    CreateWalletWebhookRequest

    -

    Settings

    Member Visibility

    Theme

    On This Page

    notification_urisignature_header
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    notification_urisignature_header
    \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateWebhookRequest.html b/docs/interfaces/client_api.CreateWebhookRequest.html index 206dc1b2..662dc449 100644 --- a/docs/interfaces/client_api.CreateWebhookRequest.html +++ b/docs/interfaces/client_api.CreateWebhookRequest.html @@ -1,5 +1,5 @@ CreateWebhookRequest | @coinbase/coinbase-sdk

    Interface CreateWebhookRequest

    Export

    CreateWebhookRequest

    -
    interface CreateWebhookRequest {
        event_filters?: WebhookEventFilter[];
        event_type: WebhookEventType;
        event_type_filter?: WebhookWalletActivityFilter;
        network_id: string;
        notification_uri: string;
        signature_header?: string;
    }

    Properties

    event_filters? +
    interface CreateWebhookRequest {
        event_filters?: WebhookEventFilter[];
        event_type: WebhookEventType;
        event_type_filter?: WebhookWalletActivityFilter;
        network_id: string;
        notification_uri: string;
        signature_header?: string;
    }

    Properties

    event_filters? event_type event_type_filter? network_id @@ -7,12 +7,12 @@ signature_header?

    Properties

    Optional event_filters

    event_filters?: WebhookEventFilter[]

    Webhook will monitor all events that matches any one of the event filters.

    Memberof

    CreateWebhookRequest

    -

    event_type

    event_type: WebhookEventType

    Memberof

    CreateWebhookRequest

    -

    Optional event_type_filter

    event_type_filter?: WebhookWalletActivityFilter

    Memberof

    CreateWebhookRequest

    -

    network_id

    network_id: string

    The ID of the blockchain network

    +

    event_type

    event_type: WebhookEventType

    Memberof

    CreateWebhookRequest

    +

    Optional event_type_filter

    event_type_filter?: WebhookWalletActivityFilter

    Memberof

    CreateWebhookRequest

    +

    network_id

    network_id: string

    The ID of the blockchain network

    Memberof

    CreateWebhookRequest

    -

    notification_uri

    notification_uri: string

    The URL to which the notifications will be sent

    +

    notification_uri

    notification_uri: string

    The URL to which the notifications will be sent

    Memberof

    CreateWebhookRequest

    -

    Optional signature_header

    signature_header?: string

    The custom header to be used for x-webhook-signature header on callbacks, so developers can verify the requests are coming from Coinbase.

    +

    Optional signature_header

    signature_header?: string

    The custom header to be used for x-webhook-signature header on callbacks, so developers can verify the requests are coming from Coinbase.

    Memberof

    CreateWebhookRequest

    -

    Settings

    Member Visibility

    Theme

    On This Page

    event_filtersevent_typeevent_type_filternetwork_idnotification_urisignature_header
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    event_filtersevent_typeevent_type_filternetwork_idnotification_urisignature_header
    \ No newline at end of file diff --git a/docs/interfaces/client_api.DeploySmartContractRequest.html b/docs/interfaces/client_api.DeploySmartContractRequest.html index d3505487..208e3d9b 100644 --- a/docs/interfaces/client_api.DeploySmartContractRequest.html +++ b/docs/interfaces/client_api.DeploySmartContractRequest.html @@ -1,5 +1,5 @@ DeploySmartContractRequest | @coinbase/coinbase-sdk

    Interface DeploySmartContractRequest

    Export

    DeploySmartContractRequest

    -
    interface DeploySmartContractRequest {
        signed_payload: string;
    }

    Properties

    signed_payload +
    interface DeploySmartContractRequest {
        signed_payload: string;
    }

    Properties

    signed_payload

    Properties

    signed_payload

    signed_payload: string

    The hex-encoded signed payload of the contract deployment transaction.

    Memberof

    DeploySmartContractRequest

    -

    Settings

    Member Visibility

    Theme

    On This Page

    signed_payload
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    signed_payload
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ERC20TransferEvent.html b/docs/interfaces/client_api.ERC20TransferEvent.html index a88aaa67..fa7156a9 100644 --- a/docs/interfaces/client_api.ERC20TransferEvent.html +++ b/docs/interfaces/client_api.ERC20TransferEvent.html @@ -1,6 +1,6 @@ ERC20TransferEvent | @coinbase/coinbase-sdk

    Interface ERC20TransferEvent

    Represents an event triggered by an ERC-20 token transfer on the blockchain. Contains information about the transaction, block, and involved addresses.

    Export

    ERC20TransferEvent

    -
    interface ERC20TransferEvent {
        blockHash?: string;
        blockNumber?: number;
        blockTime?: string;
        contractAddress?: string;
        eventType?: string;
        from?: string;
        logIndex?: number;
        network?: string;
        to?: string;
        transactionHash?: string;
        transactionIndex?: number;
        value?: string;
        webhookId?: string;
    }

    Properties

    blockHash? +
    interface ERC20TransferEvent {
        blockHash?: string;
        blockNumber?: number;
        blockTime?: string;
        contractAddress?: string;
        eventType?: string;
        from?: string;
        logIndex?: number;
        network?: string;
        to?: string;
        transactionHash?: string;
        transactionIndex?: number;
        value?: string;
        webhookId?: string;
    }

    Properties

    blockHash? blockNumber? blockTime? contractAddress? @@ -15,28 +15,28 @@ webhookId?

    Properties

    Optional blockHash

    blockHash?: string

    Hash of the block containing the transaction.

    Memberof

    ERC20TransferEvent

    -

    Optional blockNumber

    blockNumber?: number

    Number of the block containing the transaction.

    +

    Optional blockNumber

    blockNumber?: number

    Number of the block containing the transaction.

    Memberof

    ERC20TransferEvent

    -

    Optional blockTime

    blockTime?: string

    Timestamp when the block was mined.

    +

    Optional blockTime

    blockTime?: string

    Timestamp when the block was mined.

    Memberof

    ERC20TransferEvent

    -

    Optional contractAddress

    contractAddress?: string

    Address of the ERC-20 token contract.

    +

    Optional contractAddress

    contractAddress?: string

    Address of the ERC-20 token contract.

    Memberof

    ERC20TransferEvent

    -

    Optional eventType

    eventType?: string

    Type of event, in this case, an ERC-20 token transfer.

    +

    Optional eventType

    eventType?: string

    Type of event, in this case, an ERC-20 token transfer.

    Memberof

    ERC20TransferEvent

    -

    Optional from

    from?: string

    Address of the sender in the token transfer.

    +

    Optional from

    from?: string

    Address of the sender in the token transfer.

    Memberof

    ERC20TransferEvent

    -

    Optional logIndex

    logIndex?: number

    Position of the event log within the transaction.

    +

    Optional logIndex

    logIndex?: number

    Position of the event log within the transaction.

    Memberof

    ERC20TransferEvent

    -

    Optional network

    network?: string

    Blockchain network where the event occurred.

    +

    Optional network

    network?: string

    Blockchain network where the event occurred.

    Memberof

    ERC20TransferEvent

    -

    Optional to

    to?: string

    Address of the recipient in the token transfer.

    +

    Optional to

    to?: string

    Address of the recipient in the token transfer.

    Memberof

    ERC20TransferEvent

    -

    Optional transactionHash

    transactionHash?: string

    Hash of the transaction that triggered the event.

    +

    Optional transactionHash

    transactionHash?: string

    Hash of the transaction that triggered the event.

    Memberof

    ERC20TransferEvent

    -

    Optional transactionIndex

    transactionIndex?: number

    Position of the transaction within the block.

    +

    Optional transactionIndex

    transactionIndex?: number

    Position of the transaction within the block.

    Memberof

    ERC20TransferEvent

    -

    Optional value

    value?: string

    Amount of tokens transferred, typically in the smallest unit (e.g., wei for Ethereum).

    +

    Optional value

    value?: string

    Amount of tokens transferred, typically in the smallest unit (e.g., wei for Ethereum).

    Memberof

    ERC20TransferEvent

    -

    Optional webhookId

    webhookId?: string

    Unique identifier for the webhook that triggered this event.

    +

    Optional webhookId

    webhookId?: string

    Unique identifier for the webhook that triggered this event.

    Memberof

    ERC20TransferEvent

    -

    Settings

    Member Visibility

    Theme

    On This Page

    blockHashblockNumberblockTimecontractAddresseventTypefromlogIndexnetworktotransactionHashtransactionIndexvaluewebhookId
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    blockHashblockNumberblockTimecontractAddresseventTypefromlogIndexnetworktotransactionHashtransactionIndexvaluewebhookId
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ERC721TransferEvent.html b/docs/interfaces/client_api.ERC721TransferEvent.html index ef1fdd0f..fdc7df49 100644 --- a/docs/interfaces/client_api.ERC721TransferEvent.html +++ b/docs/interfaces/client_api.ERC721TransferEvent.html @@ -1,6 +1,6 @@ ERC721TransferEvent | @coinbase/coinbase-sdk

    Interface ERC721TransferEvent

    Represents an event triggered by an ERC-721 token transfer on the blockchain. Contains information about the transaction, block, and involved addresses.

    Export

    ERC721TransferEvent

    -
    interface ERC721TransferEvent {
        blockHash?: string;
        blockNumber?: number;
        blockTime?: string;
        contractAddress?: string;
        eventType?: string;
        from?: string;
        logIndex?: number;
        network?: string;
        to?: string;
        tokenId?: string;
        transactionHash?: string;
        transactionIndex?: number;
        webhookId?: string;
    }

    Properties

    blockHash? +
    interface ERC721TransferEvent {
        blockHash?: string;
        blockNumber?: number;
        blockTime?: string;
        contractAddress?: string;
        eventType?: string;
        from?: string;
        logIndex?: number;
        network?: string;
        to?: string;
        tokenId?: string;
        transactionHash?: string;
        transactionIndex?: number;
        webhookId?: string;
    }

    Properties

    blockHash? blockNumber? blockTime? contractAddress? @@ -15,28 +15,28 @@ webhookId?

    Properties

    Optional blockHash

    blockHash?: string

    Hash of the block containing the transaction.

    Memberof

    ERC721TransferEvent

    -

    Optional blockNumber

    blockNumber?: number

    Number of the block containing the transaction.

    +

    Optional blockNumber

    blockNumber?: number

    Number of the block containing the transaction.

    Memberof

    ERC721TransferEvent

    -

    Optional blockTime

    blockTime?: string

    Timestamp when the block was mined.

    +

    Optional blockTime

    blockTime?: string

    Timestamp when the block was mined.

    Memberof

    ERC721TransferEvent

    -

    Optional contractAddress

    contractAddress?: string

    Address of the ERC-721 token contract.

    +

    Optional contractAddress

    contractAddress?: string

    Address of the ERC-721 token contract.

    Memberof

    ERC721TransferEvent

    -

    Optional eventType

    eventType?: string

    Type of event, in this case, an ERC-721 token transfer.

    +

    Optional eventType

    eventType?: string

    Type of event, in this case, an ERC-721 token transfer.

    Memberof

    ERC721TransferEvent

    -

    Optional from

    from?: string

    Address of the sender in the token transfer.

    +

    Optional from

    from?: string

    Address of the sender in the token transfer.

    Memberof

    ERC721TransferEvent

    -

    Optional logIndex

    logIndex?: number

    Position of the event log within the transaction.

    +

    Optional logIndex

    logIndex?: number

    Position of the event log within the transaction.

    Memberof

    ERC721TransferEvent

    -

    Optional network

    network?: string

    Blockchain network where the event occurred.

    +

    Optional network

    network?: string

    Blockchain network where the event occurred.

    Memberof

    ERC721TransferEvent

    -

    Optional to

    to?: string

    Address of the recipient in the token transfer.

    +

    Optional to

    to?: string

    Address of the recipient in the token transfer.

    Memberof

    ERC721TransferEvent

    -

    Optional tokenId

    tokenId?: string

    Unique identifier of the NFT being transferred.

    +

    Optional tokenId

    tokenId?: string

    Unique identifier of the NFT being transferred.

    Memberof

    ERC721TransferEvent

    -

    Optional transactionHash

    transactionHash?: string

    Hash of the transaction that triggered the event.

    +

    Optional transactionHash

    transactionHash?: string

    Hash of the transaction that triggered the event.

    Memberof

    ERC721TransferEvent

    -

    Optional transactionIndex

    transactionIndex?: number

    Position of the transaction within the block.

    +

    Optional transactionIndex

    transactionIndex?: number

    Position of the transaction within the block.

    Memberof

    ERC721TransferEvent

    -

    Optional webhookId

    webhookId?: string

    Unique identifier for the webhook that triggered this event.

    +

    Optional webhookId

    webhookId?: string

    Unique identifier for the webhook that triggered this event.

    Memberof

    ERC721TransferEvent

    -

    Settings

    Member Visibility

    Theme

    On This Page

    blockHashblockNumberblockTimecontractAddresseventTypefromlogIndexnetworktotokenIdtransactionHashtransactionIndexwebhookId
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    blockHashblockNumberblockTimecontractAddresseventTypefromlogIndexnetworktotokenIdtransactionHashtransactionIndexwebhookId
    \ No newline at end of file diff --git a/docs/interfaces/client_api.EthereumTransaction.html b/docs/interfaces/client_api.EthereumTransaction.html index fe7d433f..140d104e 100644 --- a/docs/interfaces/client_api.EthereumTransaction.html +++ b/docs/interfaces/client_api.EthereumTransaction.html @@ -1,5 +1,5 @@ EthereumTransaction | @coinbase/coinbase-sdk

    Interface EthereumTransaction

    Export

    EthereumTransaction

    -
    interface EthereumTransaction {
        block_timestamp?: string;
        flattened_traces?: EthereumTransactionFlattenedTrace[];
        from: string;
        gas?: number;
        gas_price?: number;
        hash?: string;
        index?: number;
        input?: string;
        max_fee_per_gas?: number;
        max_priority_fee_per_gas?: number;
        mint?: string;
        nonce?: number;
        priority_fee_per_gas?: number;
        to: string;
        transaction_access_list?: EthereumTransactionAccessList;
        type?: number;
        value?: string;
    }

    Properties

    block_timestamp? +
    interface EthereumTransaction {
        block_timestamp?: string;
        flattened_traces?: EthereumTransactionFlattenedTrace[];
        from: string;
        gas?: number;
        gas_price?: number;
        hash?: string;
        index?: number;
        input?: string;
        max_fee_per_gas?: number;
        max_priority_fee_per_gas?: number;
        mint?: string;
        nonce?: number;
        priority_fee_per_gas?: number;
        to: string;
        transaction_access_list?: EthereumTransactionAccessList;
        type?: number;
        value?: string;
    }

    Properties

    block_timestamp? flattened_traces? from gas? @@ -18,34 +18,34 @@ value?

    Properties

    Optional block_timestamp

    block_timestamp?: string

    The timestamp of the block in which the event was emitted

    Memberof

    EthereumTransaction

    -

    Optional flattened_traces

    flattened_traces?: EthereumTransactionFlattenedTrace[]

    Memberof

    EthereumTransaction

    -

    from

    from: string

    The onchain address of the sender.

    +

    Optional flattened_traces

    flattened_traces?: EthereumTransactionFlattenedTrace[]

    Memberof

    EthereumTransaction

    +

    from

    from: string

    The onchain address of the sender.

    Memberof

    EthereumTransaction

    -

    Optional gas

    gas?: number

    The amount of gas spent in the transaction.

    +

    Optional gas

    gas?: number

    The amount of gas spent in the transaction.

    Memberof

    EthereumTransaction

    -

    Optional gas_price

    gas_price?: number

    The price per gas spent in the transaction in atomic units of the native asset.

    +

    Optional gas_price

    gas_price?: number

    The price per gas spent in the transaction in atomic units of the native asset.

    Memberof

    EthereumTransaction

    -

    Optional hash

    hash?: string

    The hash of the transaction as a hexadecimal string, prefixed with 0x.

    +

    Optional hash

    hash?: string

    The hash of the transaction as a hexadecimal string, prefixed with 0x.

    Memberof

    EthereumTransaction

    -

    Optional index

    index?: number

    The index of the transaction in the block.

    +

    Optional index

    index?: number

    The index of the transaction in the block.

    Memberof

    EthereumTransaction

    -

    Optional input

    input?: string

    The input data of the transaction.

    +

    Optional input

    input?: string

    The input data of the transaction.

    Memberof

    EthereumTransaction

    -

    Optional max_fee_per_gas

    max_fee_per_gas?: number

    The max fee per gas as defined in EIP-1559. https://eips.ethereum.org/EIPS/eip-1559 for more details.

    +

    Optional max_fee_per_gas

    max_fee_per_gas?: number

    The max fee per gas as defined in EIP-1559. https://eips.ethereum.org/EIPS/eip-1559 for more details.

    Memberof

    EthereumTransaction

    -

    Optional max_priority_fee_per_gas

    max_priority_fee_per_gas?: number

    The max priority fee per gas as defined in EIP-1559. https://eips.ethereum.org/EIPS/eip-1559 for more details.

    +

    Optional max_priority_fee_per_gas

    max_priority_fee_per_gas?: number

    The max priority fee per gas as defined in EIP-1559. https://eips.ethereum.org/EIPS/eip-1559 for more details.

    Memberof

    EthereumTransaction

    -

    Optional mint

    mint?: string

    This is for handling optimism rollup specific EIP-2718 transaction type field.

    +

    Optional mint

    mint?: string

    This is for handling optimism rollup specific EIP-2718 transaction type field.

    Memberof

    EthereumTransaction

    -

    Optional nonce

    nonce?: number

    The nonce of the transaction in the source address.

    +

    Optional nonce

    nonce?: number

    The nonce of the transaction in the source address.

    Memberof

    EthereumTransaction

    -

    Optional priority_fee_per_gas

    priority_fee_per_gas?: number

    The confirmed priority fee per gas as defined in EIP-1559. https://eips.ethereum.org/EIPS/eip-1559 for more details.

    +

    Optional priority_fee_per_gas

    priority_fee_per_gas?: number

    The confirmed priority fee per gas as defined in EIP-1559. https://eips.ethereum.org/EIPS/eip-1559 for more details.

    Memberof

    EthereumTransaction

    -

    to

    to: string

    The onchain address of the receiver.

    +

    to

    to: string

    The onchain address of the receiver.

    Memberof

    EthereumTransaction

    -

    Optional transaction_access_list

    transaction_access_list?: EthereumTransactionAccessList

    Memberof

    EthereumTransaction

    -

    Optional type

    type?: number

    The EIP-2718 transaction type. See https://eips.ethereum.org/EIPS/eip-2718 for more details.

    +

    Optional transaction_access_list

    transaction_access_list?: EthereumTransactionAccessList

    Memberof

    EthereumTransaction

    +

    Optional type

    type?: number

    The EIP-2718 transaction type. See https://eips.ethereum.org/EIPS/eip-2718 for more details.

    Memberof

    EthereumTransaction

    -

    Optional value

    value?: string

    The value of the transaction in atomic units of the native asset.

    +

    Optional value

    value?: string

    The value of the transaction in atomic units of the native asset.

    Memberof

    EthereumTransaction

    -

    Settings

    Member Visibility

    Theme

    On This Page

    block_timestampflattened_tracesfromgasgas_pricehashindexinputmax_fee_per_gasmax_priority_fee_per_gasmintnoncepriority_fee_per_gastotransaction_access_listtypevalue
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    block_timestampflattened_tracesfromgasgas_pricehashindexinputmax_fee_per_gasmax_priority_fee_per_gasmintnoncepriority_fee_per_gastotransaction_access_listtypevalue
    \ No newline at end of file diff --git a/docs/interfaces/client_api.EthereumTransactionAccess.html b/docs/interfaces/client_api.EthereumTransactionAccess.html index 833d7587..d58b9ada 100644 --- a/docs/interfaces/client_api.EthereumTransactionAccess.html +++ b/docs/interfaces/client_api.EthereumTransactionAccess.html @@ -1,6 +1,6 @@ EthereumTransactionAccess | @coinbase/coinbase-sdk

    Interface EthereumTransactionAccess

    Export

    EthereumTransactionAccess

    -
    interface EthereumTransactionAccess {
        address?: string;
        storage_keys?: string[];
    }

    Properties

    address? +
    interface EthereumTransactionAccess {
        address?: string;
        storage_keys?: string[];
    }

    Properties

    address? storage_keys?

    Properties

    Optional address

    address?: string

    Memberof

    EthereumTransactionAccess

    -

    Optional storage_keys

    storage_keys?: string[]

    Memberof

    EthereumTransactionAccess

    -

    Settings

    Member Visibility

    Theme

    On This Page

    addressstorage_keys
    \ No newline at end of file +

    Optional storage_keys

    storage_keys?: string[]

    Memberof

    EthereumTransactionAccess

    +

    Settings

    Member Visibility

    Theme

    On This Page

    addressstorage_keys
    \ No newline at end of file diff --git a/docs/interfaces/client_api.EthereumTransactionAccessList.html b/docs/interfaces/client_api.EthereumTransactionAccessList.html index ddcdaf59..d545e002 100644 --- a/docs/interfaces/client_api.EthereumTransactionAccessList.html +++ b/docs/interfaces/client_api.EthereumTransactionAccessList.html @@ -1,4 +1,4 @@ EthereumTransactionAccessList | @coinbase/coinbase-sdk

    Interface EthereumTransactionAccessList

    Export

    EthereumTransactionAccessList

    -
    interface EthereumTransactionAccessList {
        access_list?: EthereumTransactionAccess[];
    }

    Properties

    access_list? +
    interface EthereumTransactionAccessList {
        access_list?: EthereumTransactionAccess[];
    }

    Properties

    access_list?

    Properties

    Optional access_list

    access_list?: EthereumTransactionAccess[]

    Memberof

    EthereumTransactionAccessList

    -

    Settings

    Member Visibility

    Theme

    On This Page

    access_list
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    access_list
    \ No newline at end of file diff --git a/docs/interfaces/client_api.EthereumTransactionFlattenedTrace.html b/docs/interfaces/client_api.EthereumTransactionFlattenedTrace.html index 48a33192..887af4b6 100644 --- a/docs/interfaces/client_api.EthereumTransactionFlattenedTrace.html +++ b/docs/interfaces/client_api.EthereumTransactionFlattenedTrace.html @@ -1,5 +1,5 @@ EthereumTransactionFlattenedTrace | @coinbase/coinbase-sdk

    Interface EthereumTransactionFlattenedTrace

    Export

    EthereumTransactionFlattenedTrace

    -
    interface EthereumTransactionFlattenedTrace {
        block_hash?: string;
        block_number?: number;
        call_type?: string;
        error?: string;
        from?: string;
        gas?: number;
        gas_used?: number;
        input?: string;
        output?: string;
        status?: number;
        sub_traces?: number;
        to?: string;
        trace_address?: number[];
        trace_id?: string;
        trace_type?: string;
        transaction_hash?: string;
        transaction_index?: number;
        type?: string;
        value?: string;
    }

    Properties

    block_hash? +
    interface EthereumTransactionFlattenedTrace {
        block_hash?: string;
        block_number?: number;
        call_type?: string;
        error?: string;
        from?: string;
        gas?: number;
        gas_used?: number;
        input?: string;
        output?: string;
        status?: number;
        sub_traces?: number;
        to?: string;
        trace_address?: number[];
        trace_id?: string;
        trace_type?: string;
        transaction_hash?: string;
        transaction_index?: number;
        type?: string;
        value?: string;
    }

    Properties

    block_hash? block_number? call_type? error? @@ -19,22 +19,22 @@ type? value?

    Properties

    Optional block_hash

    block_hash?: string

    Memberof

    EthereumTransactionFlattenedTrace

    -

    Optional block_number

    block_number?: number

    Memberof

    EthereumTransactionFlattenedTrace

    -

    Optional call_type

    call_type?: string

    Memberof

    EthereumTransactionFlattenedTrace

    -

    Optional error

    error?: string

    Memberof

    EthereumTransactionFlattenedTrace

    -

    Optional from

    from?: string

    Memberof

    EthereumTransactionFlattenedTrace

    -

    Optional gas

    gas?: number

    Memberof

    EthereumTransactionFlattenedTrace

    -

    Optional gas_used

    gas_used?: number

    Memberof

    EthereumTransactionFlattenedTrace

    -

    Optional input

    input?: string

    Memberof

    EthereumTransactionFlattenedTrace

    -

    Optional output

    output?: string

    Memberof

    EthereumTransactionFlattenedTrace

    -

    Optional status

    status?: number

    Memberof

    EthereumTransactionFlattenedTrace

    -

    Optional sub_traces

    sub_traces?: number

    Memberof

    EthereumTransactionFlattenedTrace

    -

    Optional to

    to?: string

    Memberof

    EthereumTransactionFlattenedTrace

    -

    Optional trace_address

    trace_address?: number[]

    Memberof

    EthereumTransactionFlattenedTrace

    -

    Optional trace_id

    trace_id?: string

    Memberof

    EthereumTransactionFlattenedTrace

    -

    Optional trace_type

    trace_type?: string

    Memberof

    EthereumTransactionFlattenedTrace

    -

    Optional transaction_hash

    transaction_hash?: string

    Memberof

    EthereumTransactionFlattenedTrace

    -

    Optional transaction_index

    transaction_index?: number

    Memberof

    EthereumTransactionFlattenedTrace

    -

    Optional type

    type?: string

    Memberof

    EthereumTransactionFlattenedTrace

    -

    Optional value

    value?: string

    Memberof

    EthereumTransactionFlattenedTrace

    -

    Settings

    Member Visibility

    Theme

    On This Page

    block_hashblock_numbercall_typeerrorfromgasgas_usedinputoutputstatussub_tracestotrace_addresstrace_idtrace_typetransaction_hashtransaction_indextypevalue
    \ No newline at end of file +

    Optional block_number

    block_number?: number

    Memberof

    EthereumTransactionFlattenedTrace

    +

    Optional call_type

    call_type?: string

    Memberof

    EthereumTransactionFlattenedTrace

    +

    Optional error

    error?: string

    Memberof

    EthereumTransactionFlattenedTrace

    +

    Optional from

    from?: string

    Memberof

    EthereumTransactionFlattenedTrace

    +

    Optional gas

    gas?: number

    Memberof

    EthereumTransactionFlattenedTrace

    +

    Optional gas_used

    gas_used?: number

    Memberof

    EthereumTransactionFlattenedTrace

    +

    Optional input

    input?: string

    Memberof

    EthereumTransactionFlattenedTrace

    +

    Optional output

    output?: string

    Memberof

    EthereumTransactionFlattenedTrace

    +

    Optional status

    status?: number

    Memberof

    EthereumTransactionFlattenedTrace

    +

    Optional sub_traces

    sub_traces?: number

    Memberof

    EthereumTransactionFlattenedTrace

    +

    Optional to

    to?: string

    Memberof

    EthereumTransactionFlattenedTrace

    +

    Optional trace_address

    trace_address?: number[]

    Memberof

    EthereumTransactionFlattenedTrace

    +

    Optional trace_id

    trace_id?: string

    Memberof

    EthereumTransactionFlattenedTrace

    +

    Optional trace_type

    trace_type?: string

    Memberof

    EthereumTransactionFlattenedTrace

    +

    Optional transaction_hash

    transaction_hash?: string

    Memberof

    EthereumTransactionFlattenedTrace

    +

    Optional transaction_index

    transaction_index?: number

    Memberof

    EthereumTransactionFlattenedTrace

    +

    Optional type

    type?: string

    Memberof

    EthereumTransactionFlattenedTrace

    +

    Optional value

    value?: string

    Memberof

    EthereumTransactionFlattenedTrace

    +

    Settings

    Member Visibility

    Theme

    On This Page

    block_hashblock_numbercall_typeerrorfromgasgas_usedinputoutputstatussub_tracestotrace_addresstrace_idtrace_typetransaction_hashtransaction_indextypevalue
    \ No newline at end of file diff --git a/docs/interfaces/client_api.EthereumValidatorMetadata.html b/docs/interfaces/client_api.EthereumValidatorMetadata.html index 16926592..5da89f77 100644 --- a/docs/interfaces/client_api.EthereumValidatorMetadata.html +++ b/docs/interfaces/client_api.EthereumValidatorMetadata.html @@ -1,6 +1,6 @@ EthereumValidatorMetadata | @coinbase/coinbase-sdk

    Interface EthereumValidatorMetadata

    An Ethereum validator.

    Export

    EthereumValidatorMetadata

    -
    interface EthereumValidatorMetadata {
        activationEpoch: string;
        balance: Balance;
        effective_balance: Balance;
        exitEpoch: string;
        index: string;
        public_key: string;
        slashed: boolean;
        withdrawableEpoch: string;
        withdrawal_address: string;
    }

    Properties

    activationEpoch +
    interface EthereumValidatorMetadata {
        activationEpoch: string;
        balance: Balance;
        effective_balance: Balance;
        exitEpoch: string;
        index: string;
        public_key: string;
        slashed: boolean;
        withdrawableEpoch: string;
        withdrawal_address: string;
    }

    Properties

    activationEpoch balance effective_balance exitEpoch @@ -11,18 +11,18 @@ withdrawal_address

    Properties

    activationEpoch

    activationEpoch: string

    The epoch at which the validator was activated.

    Memberof

    EthereumValidatorMetadata

    -

    balance

    balance: Balance

    Memberof

    EthereumValidatorMetadata

    -

    effective_balance

    effective_balance: Balance

    Memberof

    EthereumValidatorMetadata

    -

    exitEpoch

    exitEpoch: string

    The epoch at which the validator exited.

    +

    balance

    balance: Balance

    Memberof

    EthereumValidatorMetadata

    +

    effective_balance

    effective_balance: Balance

    Memberof

    EthereumValidatorMetadata

    +

    exitEpoch

    exitEpoch: string

    The epoch at which the validator exited.

    Memberof

    EthereumValidatorMetadata

    -

    index

    index: string

    The index of the validator in the validator set.

    +

    index

    index: string

    The index of the validator in the validator set.

    Memberof

    EthereumValidatorMetadata

    -

    public_key

    public_key: string

    The public key of the validator.

    +

    public_key

    public_key: string

    The public key of the validator.

    Memberof

    EthereumValidatorMetadata

    -

    slashed

    slashed: boolean

    Whether the validator has been slashed.

    +

    slashed

    slashed: boolean

    Whether the validator has been slashed.

    Memberof

    EthereumValidatorMetadata

    -

    withdrawableEpoch

    withdrawableEpoch: string

    The epoch at which the validator can withdraw.

    +

    withdrawableEpoch

    withdrawableEpoch: string

    The epoch at which the validator can withdraw.

    Memberof

    EthereumValidatorMetadata

    -

    withdrawal_address

    withdrawal_address: string

    The address to which the validator's rewards are sent.

    +

    withdrawal_address

    withdrawal_address: string

    The address to which the validator's rewards are sent.

    Memberof

    EthereumValidatorMetadata

    -

    Settings

    Member Visibility

    Theme

    On This Page

    activationEpochbalanceeffective_balanceexitEpochindexpublic_keyslashedwithdrawableEpochwithdrawal_address
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    activationEpochbalanceeffective_balanceexitEpochindexpublic_keyslashedwithdrawableEpochwithdrawal_address
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ExternalAddressesApiInterface.html b/docs/interfaces/client_api.ExternalAddressesApiInterface.html index c9e9192c..f5b3c8ec 100644 --- a/docs/interfaces/client_api.ExternalAddressesApiInterface.html +++ b/docs/interfaces/client_api.ExternalAddressesApiInterface.html @@ -1,6 +1,6 @@ ExternalAddressesApiInterface | @coinbase/coinbase-sdk

    Interface ExternalAddressesApiInterface

    ExternalAddressesApi - interface

    Export

    ExternalAddressesApi

    -
    interface ExternalAddressesApiInterface {
        getExternalAddressBalance(networkId, addressId, assetId, options?): AxiosPromise<Balance>;
        listExternalAddressBalances(networkId, addressId, page?, options?): AxiosPromise<AddressBalanceList>;
        requestExternalFaucetFunds(networkId, addressId, assetId?, options?): AxiosPromise<FaucetTransaction>;
    }

    Implemented by

    Methods

    getExternalAddressBalance +
    interface ExternalAddressesApiInterface {
        getExternalAddressBalance(networkId, addressId, assetId, options?): AxiosPromise<Balance>;
        listExternalAddressBalances(networkId, addressId, page?, options?): AxiosPromise<AddressBalanceList>;
        requestExternalFaucetFunds(networkId, addressId, assetId?, options?): AxiosPromise<FaucetTransaction>;
    }

    Implemented by

    Methods

    getExternalAddressBalance listExternalAddressBalances requestExternalFaucetFunds

    Methods

    getExternalAddressBalance

    • getExternalAddressBalance(networkId, addressId, assetId, options?): AxiosPromise<Balance>

    • Get the balance of an asset in an external address

      @@ -10,18 +10,18 @@
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<Balance>

    Summary

    Get the balance of an asset in an external address

    Throws

    Memberof

    ExternalAddressesApiInterface

    -

    listExternalAddressBalances

    listExternalAddressBalances

    • listExternalAddressBalances(networkId, addressId, page?, options?): AxiosPromise<AddressBalanceList>

    • List all of the balances of an external address

      Parameters

      • networkId: string

        The ID of the blockchain network

      • addressId: string

        The ID of the address to fetch the balance for

      • Optional page: string

        A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<AddressBalanceList>

      Summary

      Get the balances of an external address

      Throws

      Memberof

      ExternalAddressesApiInterface

      -

    requestExternalFaucetFunds

    requestExternalFaucetFunds

    • requestExternalFaucetFunds(networkId, addressId, assetId?, options?): AxiosPromise<FaucetTransaction>

    • Request faucet funds to be sent to external address.

      Parameters

      • networkId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The onchain address of the address that is being fetched.

      • Optional assetId: string

        The ID of the asset to transfer from the faucet.

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<FaucetTransaction>

      Summary

      Request faucet funds for external address.

      Throws

      Memberof

      ExternalAddressesApiInterface

      -

    Settings

    Member Visibility

    Theme

    On This Page

    getExternalAddressBalancelistExternalAddressBalancesrequestExternalFaucetFunds
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    getExternalAddressBalancelistExternalAddressBalancesrequestExternalFaucetFunds
    \ No newline at end of file diff --git a/docs/interfaces/client_api.FaucetTransaction.html b/docs/interfaces/client_api.FaucetTransaction.html index 8064b73a..fd95f827 100644 --- a/docs/interfaces/client_api.FaucetTransaction.html +++ b/docs/interfaces/client_api.FaucetTransaction.html @@ -1,9 +1,9 @@ FaucetTransaction | @coinbase/coinbase-sdk

    Interface FaucetTransaction

    The faucet transaction

    Export

    FaucetTransaction

    -
    interface FaucetTransaction {
        transaction_hash: string;
        transaction_link: string;
    }

    Properties

    transaction_hash +
    interface FaucetTransaction {
        transaction_hash: string;
        transaction_link: string;
    }

    Properties

    transaction_hash transaction_link

    Properties

    transaction_hash

    transaction_hash: string

    The transaction hash of the transaction the faucet created.

    Memberof

    FaucetTransaction

    -

    transaction_link

    transaction_link: string

    Link to the transaction on the blockchain explorer.

    +

    transaction_link

    transaction_link: string

    Link to the transaction on the blockchain explorer.

    Memberof

    FaucetTransaction

    -

    Settings

    Member Visibility

    Theme

    On This Page

    transaction_hashtransaction_link
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    transaction_hashtransaction_link
    \ No newline at end of file diff --git a/docs/interfaces/client_api.FeatureSet.html b/docs/interfaces/client_api.FeatureSet.html index 06bcf59f..8e79d2b5 100644 --- a/docs/interfaces/client_api.FeatureSet.html +++ b/docs/interfaces/client_api.FeatureSet.html @@ -1,5 +1,5 @@ FeatureSet | @coinbase/coinbase-sdk

    Interface FeatureSet

    Export

    FeatureSet

    -
    interface FeatureSet {
        faucet: boolean;
        gasless_send: boolean;
        server_signer: boolean;
        stake: boolean;
        trade: boolean;
        transfer: boolean;
    }

    Properties

    faucet +
    interface FeatureSet {
        faucet: boolean;
        gasless_send: boolean;
        server_signer: boolean;
        stake: boolean;
        trade: boolean;
        transfer: boolean;
    }

    Properties

    faucet gasless_send server_signer stake @@ -7,14 +7,14 @@ transfer

    Properties

    faucet

    faucet: boolean

    Whether the network supports a faucet

    Memberof

    FeatureSet

    -

    gasless_send

    gasless_send: boolean

    Whether the network supports gasless sends

    +

    gasless_send

    gasless_send: boolean

    Whether the network supports gasless sends

    Memberof

    FeatureSet

    -

    server_signer

    server_signer: boolean

    Whether the network supports Server-Signers

    +

    server_signer

    server_signer: boolean

    Whether the network supports Server-Signers

    Memberof

    FeatureSet

    -

    stake

    stake: boolean

    Whether the network supports staking

    +

    stake

    stake: boolean

    Whether the network supports staking

    Memberof

    FeatureSet

    -

    trade

    trade: boolean

    Whether the network supports trading

    +

    trade

    trade: boolean

    Whether the network supports trading

    Memberof

    FeatureSet

    -

    transfer

    transfer: boolean

    Whether the network supports transfers

    +

    transfer

    transfer: boolean

    Whether the network supports transfers

    Memberof

    FeatureSet

    -

    Settings

    Member Visibility

    Theme

    On This Page

    faucetgasless_sendserver_signerstaketradetransfer
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    faucetgasless_sendserver_signerstaketradetransfer
    \ No newline at end of file diff --git a/docs/interfaces/client_api.FetchHistoricalStakingBalances200Response.html b/docs/interfaces/client_api.FetchHistoricalStakingBalances200Response.html index 632bfbd8..66edb360 100644 --- a/docs/interfaces/client_api.FetchHistoricalStakingBalances200Response.html +++ b/docs/interfaces/client_api.FetchHistoricalStakingBalances200Response.html @@ -1,10 +1,10 @@ FetchHistoricalStakingBalances200Response | @coinbase/coinbase-sdk

    Interface FetchHistoricalStakingBalances200Response

    Export

    FetchHistoricalStakingBalances200Response

    -
    interface FetchHistoricalStakingBalances200Response {
        data: StakingBalance[];
        has_more: boolean;
        next_page: string;
    }

    Properties

    data +
    interface FetchHistoricalStakingBalances200Response {
        data: StakingBalance[];
        has_more: boolean;
        next_page: string;
    }

    Properties

    data has_more next_page

    Properties

    data

    data: StakingBalance[]

    Memberof

    FetchHistoricalStakingBalances200Response

    -

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    FetchHistoricalStakingBalances200Response

    -

    next_page

    next_page: string

    The page token to be used to fetch the next page.

    +

    next_page

    next_page: string

    The page token to be used to fetch the next page.

    Memberof

    FetchHistoricalStakingBalances200Response

    -

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_page
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_page
    \ No newline at end of file diff --git a/docs/interfaces/client_api.FetchStakingRewards200Response.html b/docs/interfaces/client_api.FetchStakingRewards200Response.html index 4f116bc1..c3da0289 100644 --- a/docs/interfaces/client_api.FetchStakingRewards200Response.html +++ b/docs/interfaces/client_api.FetchStakingRewards200Response.html @@ -1,10 +1,10 @@ FetchStakingRewards200Response | @coinbase/coinbase-sdk

    Interface FetchStakingRewards200Response

    Export

    FetchStakingRewards200Response

    -
    interface FetchStakingRewards200Response {
        data: StakingReward[];
        has_more: boolean;
        next_page: string;
    }

    Properties

    data +
    interface FetchStakingRewards200Response {
        data: StakingReward[];
        has_more: boolean;
        next_page: string;
    }

    Properties

    data has_more next_page

    Properties

    data

    data: StakingReward[]

    Memberof

    FetchStakingRewards200Response

    -

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    FetchStakingRewards200Response

    -

    next_page

    next_page: string

    The page token to be used to fetch the next page.

    +

    next_page

    next_page: string

    The page token to be used to fetch the next page.

    Memberof

    FetchStakingRewards200Response

    -

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_page
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_page
    \ No newline at end of file diff --git a/docs/interfaces/client_api.FetchStakingRewardsRequest.html b/docs/interfaces/client_api.FetchStakingRewardsRequest.html index e868f854..c6b766cc 100644 --- a/docs/interfaces/client_api.FetchStakingRewardsRequest.html +++ b/docs/interfaces/client_api.FetchStakingRewardsRequest.html @@ -1,5 +1,5 @@ FetchStakingRewardsRequest | @coinbase/coinbase-sdk

    Interface FetchStakingRewardsRequest

    Export

    FetchStakingRewardsRequest

    -
    interface FetchStakingRewardsRequest {
        address_ids: string[];
        asset_id: string;
        end_time: string;
        format: StakingRewardFormat;
        network_id: string;
        start_time: string;
    }

    Properties

    address_ids +
    interface FetchStakingRewardsRequest {
        address_ids: string[];
        asset_id: string;
        end_time: string;
        format: StakingRewardFormat;
        network_id: string;
        start_time: string;
    }

    Properties

    address_ids asset_id end_time format @@ -7,13 +7,13 @@ start_time

    Properties

    address_ids

    address_ids: string[]

    The onchain addresses for which the staking rewards are being fetched

    Memberof

    FetchStakingRewardsRequest

    -

    asset_id

    asset_id: string

    The ID of the asset for which the staking rewards are being fetched

    +

    asset_id

    asset_id: string

    The ID of the asset for which the staking rewards are being fetched

    Memberof

    FetchStakingRewardsRequest

    -

    end_time

    end_time: string

    The end time of this reward period

    +

    end_time

    end_time: string

    The end time of this reward period

    Memberof

    FetchStakingRewardsRequest

    -

    format

    format: StakingRewardFormat

    Memberof

    FetchStakingRewardsRequest

    -

    network_id

    network_id: string

    The ID of the blockchain network

    +

    format

    format: StakingRewardFormat

    Memberof

    FetchStakingRewardsRequest

    +

    network_id

    network_id: string

    The ID of the blockchain network

    Memberof

    FetchStakingRewardsRequest

    -

    start_time

    start_time: string

    The start time of this reward period

    +

    start_time

    start_time: string

    The start time of this reward period

    Memberof

    FetchStakingRewardsRequest

    -

    Settings

    Member Visibility

    Theme

    On This Page

    address_idsasset_idend_timeformatnetwork_idstart_time
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    address_idsasset_idend_timeformatnetwork_idstart_time
    \ No newline at end of file diff --git a/docs/interfaces/client_api.GetStakingContextRequest.html b/docs/interfaces/client_api.GetStakingContextRequest.html index 682fa3c5..f503752f 100644 --- a/docs/interfaces/client_api.GetStakingContextRequest.html +++ b/docs/interfaces/client_api.GetStakingContextRequest.html @@ -1,13 +1,13 @@ GetStakingContextRequest | @coinbase/coinbase-sdk

    Interface GetStakingContextRequest

    Export

    GetStakingContextRequest

    -
    interface GetStakingContextRequest {
        address_id: string;
        asset_id: string;
        network_id: string;
        options: {
            [key: string]: string;
        };
    }

    Properties

    address_id +
    interface GetStakingContextRequest {
        address_id: string;
        asset_id: string;
        network_id: string;
        options: {
            [key: string]: string;
        };
    }

    Properties

    address_id asset_id network_id options

    Properties

    address_id

    address_id: string

    The onchain address for which the staking context is being fetched

    Memberof

    GetStakingContextRequest

    -

    asset_id

    asset_id: string

    The ID of the asset being staked

    +

    asset_id

    asset_id: string

    The ID of the asset being staked

    Memberof

    GetStakingContextRequest

    -

    network_id

    network_id: string

    The ID of the blockchain network

    +

    network_id

    network_id: string

    The ID of the blockchain network

    Memberof

    GetStakingContextRequest

    -

    options

    options: {
        [key: string]: string;
    }

    Type declaration

    • [key: string]: string

    Memberof

    GetStakingContextRequest

    -

    Settings

    Member Visibility

    Theme

    On This Page

    address_idasset_idnetwork_idoptions
    \ No newline at end of file +

    options

    options: {
        [key: string]: string;
    }

    Type declaration

    • [key: string]: string

    Memberof

    GetStakingContextRequest

    +

    Settings

    Member Visibility

    Theme

    On This Page

    address_idasset_idnetwork_idoptions
    \ No newline at end of file diff --git a/docs/interfaces/client_api.HistoricalBalance.html b/docs/interfaces/client_api.HistoricalBalance.html index 404a6467..7a02a693 100644 --- a/docs/interfaces/client_api.HistoricalBalance.html +++ b/docs/interfaces/client_api.HistoricalBalance.html @@ -1,14 +1,14 @@ HistoricalBalance | @coinbase/coinbase-sdk

    Interface HistoricalBalance

    The balance of an asset onchain at a particular block

    Export

    HistoricalBalance

    -
    interface HistoricalBalance {
        amount: string;
        asset: Asset;
        block_hash: string;
        block_height: string;
    }

    Properties

    amount +
    interface HistoricalBalance {
        amount: string;
        asset: Asset;
        block_hash: string;
        block_height: string;
    }

    Properties

    amount asset block_hash block_height

    Properties

    amount

    amount: string

    The amount in the atomic units of the asset

    Memberof

    HistoricalBalance

    -

    asset

    asset: Asset

    Memberof

    HistoricalBalance

    -

    block_hash

    block_hash: string

    The hash of the block at which the balance was recorded

    +

    asset

    asset: Asset

    Memberof

    HistoricalBalance

    +

    block_hash

    block_hash: string

    The hash of the block at which the balance was recorded

    Memberof

    HistoricalBalance

    -

    block_height

    block_height: string

    The block height at which the balance was recorded

    +

    block_height

    block_height: string

    The block height at which the balance was recorded

    Memberof

    HistoricalBalance

    -

    Settings

    Member Visibility

    Theme

    On This Page

    amountassetblock_hashblock_height
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    amountassetblock_hashblock_height
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ModelError.html b/docs/interfaces/client_api.ModelError.html index 045c69dd..93ef9601 100644 --- a/docs/interfaces/client_api.ModelError.html +++ b/docs/interfaces/client_api.ModelError.html @@ -1,12 +1,12 @@ ModelError | @coinbase/coinbase-sdk

    Interface ModelError

    An error response from the Coinbase Developer Platform API

    Export

    ModelError

    -
    interface ModelError {
        code: string;
        correlation_id?: string;
        message: string;
    }

    Properties

    code +
    interface ModelError {
        code: string;
        correlation_id?: string;
        message: string;
    }

    Properties

    code correlation_id? message

    Properties

    code

    code: string

    A short string representing the reported error. Can be use to handle errors programmatically.

    Memberof

    ModelError

    -

    Optional correlation_id

    correlation_id?: string

    A unique identifier for the request that generated the error. This can be used to help debug issues with the API.

    +

    Optional correlation_id

    correlation_id?: string

    A unique identifier for the request that generated the error. This can be used to help debug issues with the API.

    Memberof

    ModelError

    -

    message

    message: string

    A human-readable message providing more details about the error.

    +

    message

    message: string

    A human-readable message providing more details about the error.

    Memberof

    ModelError

    -

    Settings

    Member Visibility

    Theme

    On This Page

    codecorrelation_idmessage
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    codecorrelation_idmessage
    \ No newline at end of file diff --git a/docs/interfaces/client_api.MultiTokenContractOptions.html b/docs/interfaces/client_api.MultiTokenContractOptions.html index e21f5ddf..1fca1916 100644 --- a/docs/interfaces/client_api.MultiTokenContractOptions.html +++ b/docs/interfaces/client_api.MultiTokenContractOptions.html @@ -1,6 +1,6 @@ MultiTokenContractOptions | @coinbase/coinbase-sdk

    Interface MultiTokenContractOptions

    Options for multi-token contract creation

    Export

    MultiTokenContractOptions

    -
    interface MultiTokenContractOptions {
        uri: string;
    }

    Properties

    uri +
    interface MultiTokenContractOptions {
        uri: string;
    }

    Properties

    uri

    Properties

    uri

    uri: string

    The URI for all token metadata

    Memberof

    MultiTokenContractOptions

    -

    Settings

    Member Visibility

    Theme

    On This Page

    uri
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    uri
    \ No newline at end of file diff --git a/docs/interfaces/client_api.NFTContractOptions.html b/docs/interfaces/client_api.NFTContractOptions.html index add8d4b5..abe4fd97 100644 --- a/docs/interfaces/client_api.NFTContractOptions.html +++ b/docs/interfaces/client_api.NFTContractOptions.html @@ -1,12 +1,12 @@ NFTContractOptions | @coinbase/coinbase-sdk

    Interface NFTContractOptions

    Options for NFT contract creation

    Export

    NFTContractOptions

    -
    interface NFTContractOptions {
        base_uri: string;
        name: string;
        symbol: string;
    }

    Properties

    base_uri +
    interface NFTContractOptions {
        base_uri: string;
        name: string;
        symbol: string;
    }

    Properties

    base_uri name symbol

    Properties

    base_uri

    base_uri: string

    The base URI for the NFT metadata

    Memberof

    NFTContractOptions

    -

    name

    name: string

    The name of the NFT

    +

    name

    name: string

    The name of the NFT

    Memberof

    NFTContractOptions

    -

    symbol

    symbol: string

    The symbol of the NFT

    +

    symbol

    symbol: string

    The symbol of the NFT

    Memberof

    NFTContractOptions

    -

    Settings

    Member Visibility

    Theme

    On This Page

    base_urinamesymbol
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    base_urinamesymbol
    \ No newline at end of file diff --git a/docs/interfaces/client_api.Network.html b/docs/interfaces/client_api.Network.html index 44b37ad4..f212cbdb 100644 --- a/docs/interfaces/client_api.Network.html +++ b/docs/interfaces/client_api.Network.html @@ -1,5 +1,5 @@ Network | @coinbase/coinbase-sdk

    Interface Network

    Export

    Network

    -
    interface Network {
        address_path_prefix?: string;
        chain_id: number;
        display_name: string;
        feature_set: FeatureSet;
        id: NetworkIdentifier;
        is_testnet: boolean;
        native_asset: Asset;
        protocol_family: NetworkProtocolFamilyEnum;
    }

    Properties

    address_path_prefix? +
    interface Network {
        address_path_prefix?: string;
        chain_id: number;
        display_name: string;
        feature_set: FeatureSet;
        id: NetworkIdentifier;
        is_testnet: boolean;
        native_asset: Asset;
        protocol_family: NetworkProtocolFamilyEnum;
    }

    Properties

    address_path_prefix? chain_id display_name feature_set @@ -9,15 +9,15 @@ protocol_family

    Properties

    Optional address_path_prefix

    address_path_prefix?: string

    The BIP44 path prefix for the network

    Memberof

    Network

    -

    chain_id

    chain_id: number

    The chain ID of the blockchain network

    +

    chain_id

    chain_id: number

    The chain ID of the blockchain network

    Memberof

    Network

    -

    display_name

    display_name: string

    The human-readable name of the blockchain network

    +

    display_name

    display_name: string

    The human-readable name of the blockchain network

    Memberof

    Network

    -

    feature_set

    feature_set: FeatureSet

    Memberof

    Network

    -

    id

    id: NetworkIdentifier

    Memberof

    Network

    -

    is_testnet

    is_testnet: boolean

    Whether the network is a testnet or not

    +

    feature_set

    feature_set: FeatureSet

    Memberof

    Network

    +

    id

    id: NetworkIdentifier

    Memberof

    Network

    +

    is_testnet

    is_testnet: boolean

    Whether the network is a testnet or not

    Memberof

    Network

    -

    native_asset

    native_asset: Asset

    Memberof

    Network

    -

    protocol_family

    protocol_family: NetworkProtocolFamilyEnum

    The protocol family of the blockchain network

    +

    native_asset

    native_asset: Asset

    Memberof

    Network

    +

    protocol_family

    protocol_family: NetworkProtocolFamilyEnum

    The protocol family of the blockchain network

    Memberof

    Network

    -

    Settings

    Member Visibility

    Theme

    On This Page

    address_path_prefixchain_iddisplay_namefeature_setidis_testnetnative_assetprotocol_family
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    address_path_prefixchain_iddisplay_namefeature_setidis_testnetnative_assetprotocol_family
    \ No newline at end of file diff --git a/docs/interfaces/client_api.NetworksApiInterface.html b/docs/interfaces/client_api.NetworksApiInterface.html index 771a62fa..e9b0bd61 100644 --- a/docs/interfaces/client_api.NetworksApiInterface.html +++ b/docs/interfaces/client_api.NetworksApiInterface.html @@ -1,9 +1,9 @@ NetworksApiInterface | @coinbase/coinbase-sdk

    Interface NetworksApiInterface

    NetworksApi - interface

    Export

    NetworksApi

    -
    interface NetworksApiInterface {
        getNetwork(networkId, options?): AxiosPromise<Network>;
    }

    Implemented by

    Methods

    getNetwork +
    interface NetworksApiInterface {
        getNetwork(networkId, options?): AxiosPromise<Network>;
    }

    Implemented by

    Methods

    getNetwork

    Methods

    getNetwork

    • getNetwork(networkId, options?): AxiosPromise<Network>

    • Get network

      Parameters

      • networkId: string

        The ID of the network to fetch.

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<Network>

      Summary

      Get network by ID

      Throws

      Memberof

      NetworksApiInterface

      -

    Settings

    Member Visibility

    Theme

    On This Page

    getNetwork
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    getNetwork
    \ No newline at end of file diff --git a/docs/interfaces/client_api.PayloadSignature.html b/docs/interfaces/client_api.PayloadSignature.html index da89a391..fb11b4a3 100644 --- a/docs/interfaces/client_api.PayloadSignature.html +++ b/docs/interfaces/client_api.PayloadSignature.html @@ -1,6 +1,6 @@ PayloadSignature | @coinbase/coinbase-sdk

    Interface PayloadSignature

    A payload signed by an address.

    Export

    PayloadSignature

    -
    interface PayloadSignature {
        address_id: string;
        payload_signature_id: string;
        signature?: string;
        status: PayloadSignatureStatusEnum;
        unsigned_payload: string;
        wallet_id: string;
    }

    Properties

    address_id +
    interface PayloadSignature {
        address_id: string;
        payload_signature_id: string;
        signature?: string;
        status: PayloadSignatureStatusEnum;
        unsigned_payload: string;
        wallet_id: string;
    }

    Properties

    address_id payload_signature_id signature? status @@ -8,14 +8,14 @@ wallet_id

    Properties

    address_id

    address_id: string

    The onchain address of the signer.

    Memberof

    PayloadSignature

    -

    payload_signature_id

    payload_signature_id: string

    The ID of the payload signature.

    +

    payload_signature_id

    payload_signature_id: string

    The ID of the payload signature.

    Memberof

    PayloadSignature

    -

    Optional signature

    signature?: string

    The signature of the payload.

    +

    Optional signature

    signature?: string

    The signature of the payload.

    Memberof

    PayloadSignature

    -

    status

    status: PayloadSignatureStatusEnum

    The status of the payload signature.

    +

    status

    status: PayloadSignatureStatusEnum

    The status of the payload signature.

    Memberof

    PayloadSignature

    -

    unsigned_payload

    unsigned_payload: string

    The unsigned payload. This is the payload that needs to be signed by the signer address.

    +

    unsigned_payload

    unsigned_payload: string

    The unsigned payload. This is the payload that needs to be signed by the signer address.

    Memberof

    PayloadSignature

    -

    wallet_id

    wallet_id: string

    The ID of the wallet that owns the address.

    +

    wallet_id

    wallet_id: string

    The ID of the wallet that owns the address.

    Memberof

    PayloadSignature

    -

    Settings

    Member Visibility

    Theme

    On This Page

    address_idpayload_signature_idsignaturestatusunsigned_payloadwallet_id
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    address_idpayload_signature_idsignaturestatusunsigned_payloadwallet_id
    \ No newline at end of file diff --git a/docs/interfaces/client_api.PayloadSignatureList.html b/docs/interfaces/client_api.PayloadSignatureList.html index ee3b78eb..c3a0d2b1 100644 --- a/docs/interfaces/client_api.PayloadSignatureList.html +++ b/docs/interfaces/client_api.PayloadSignatureList.html @@ -1,13 +1,13 @@ PayloadSignatureList | @coinbase/coinbase-sdk

    Interface PayloadSignatureList

    Export

    PayloadSignatureList

    -
    interface PayloadSignatureList {
        data: PayloadSignature[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data +
    interface PayloadSignatureList {
        data: PayloadSignature[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data has_more next_page total_count

    Properties

    data

    data: PayloadSignature[]

    Memberof

    PayloadSignatureList

    -

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    PayloadSignatureList

    -

    next_page

    next_page: string

    The page token to be used to fetch the next page.

    +

    next_page

    next_page: string

    The page token to be used to fetch the next page.

    Memberof

    PayloadSignatureList

    -

    total_count

    total_count: number

    The total number of payload signatures for the address.

    +

    total_count

    total_count: number

    The total number of payload signatures for the address.

    Memberof

    PayloadSignatureList

    -

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_pagetotal_count
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_pagetotal_count
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ReadContractRequest.html b/docs/interfaces/client_api.ReadContractRequest.html index 636ebda2..dc693c8f 100644 --- a/docs/interfaces/client_api.ReadContractRequest.html +++ b/docs/interfaces/client_api.ReadContractRequest.html @@ -1,11 +1,11 @@ ReadContractRequest | @coinbase/coinbase-sdk

    Interface ReadContractRequest

    Export

    ReadContractRequest

    -
    interface ReadContractRequest {
        abi?: string;
        args: string;
        method: string;
    }

    Properties

    abi? +
    interface ReadContractRequest {
        abi?: string;
        args: string;
        method: string;
    }

    Properties

    abi? args method

    Properties

    Optional abi

    abi?: string

    The JSON-encoded ABI of the contract method (optional, will use cached ABI if not provided)

    Memberof

    ReadContractRequest

    -

    args

    args: string

    The JSON-encoded arguments to pass to the contract method. The keys should be the argument names and the values should be the argument values.

    +

    args

    args: string

    The JSON-encoded arguments to pass to the contract method. The keys should be the argument names and the values should be the argument values.

    Memberof

    ReadContractRequest

    -

    method

    method: string

    The name of the contract method to call

    +

    method

    method: string

    The name of the contract method to call

    Memberof

    ReadContractRequest

    -

    Settings

    Member Visibility

    Theme

    On This Page

    abiargsmethod
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    abiargsmethod
    \ No newline at end of file diff --git a/docs/interfaces/client_api.SeedCreationEvent.html b/docs/interfaces/client_api.SeedCreationEvent.html index 17cb308f..f8f3c37e 100644 --- a/docs/interfaces/client_api.SeedCreationEvent.html +++ b/docs/interfaces/client_api.SeedCreationEvent.html @@ -1,9 +1,9 @@ SeedCreationEvent | @coinbase/coinbase-sdk

    Interface SeedCreationEvent

    An event representing a seed creation.

    Export

    SeedCreationEvent

    -
    interface SeedCreationEvent {
        wallet_id: string;
        wallet_user_id: string;
    }

    Properties

    wallet_id +
    interface SeedCreationEvent {
        wallet_id: string;
        wallet_user_id: string;
    }

    Properties

    wallet_id wallet_user_id

    Properties

    wallet_id

    wallet_id: string

    The ID of the wallet that the server-signer should create the seed for

    Memberof

    SeedCreationEvent

    -

    wallet_user_id

    wallet_user_id: string

    The ID of the user that the wallet belongs to

    +

    wallet_user_id

    wallet_user_id: string

    The ID of the user that the wallet belongs to

    Memberof

    SeedCreationEvent

    -

    Settings

    Member Visibility

    Theme

    On This Page

    wallet_idwallet_user_id
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    wallet_idwallet_user_id
    \ No newline at end of file diff --git a/docs/interfaces/client_api.SeedCreationEventResult.html b/docs/interfaces/client_api.SeedCreationEventResult.html index 3e68e831..8007eace 100644 --- a/docs/interfaces/client_api.SeedCreationEventResult.html +++ b/docs/interfaces/client_api.SeedCreationEventResult.html @@ -1,15 +1,15 @@ SeedCreationEventResult | @coinbase/coinbase-sdk

    Interface SeedCreationEventResult

    The result to a SeedCreationEvent.

    Export

    SeedCreationEventResult

    -
    interface SeedCreationEventResult {
        extended_public_key: string;
        seed_id: string;
        wallet_id: string;
        wallet_user_id: string;
    }

    Properties

    extended_public_key +
    interface SeedCreationEventResult {
        extended_public_key: string;
        seed_id: string;
        wallet_id: string;
        wallet_user_id: string;
    }

    Properties

    extended_public_key seed_id wallet_id wallet_user_id

    Properties

    extended_public_key

    extended_public_key: string

    The extended public key for the first master key derived from seed.

    Memberof

    SeedCreationEventResult

    -

    seed_id

    seed_id: string

    The ID of the seed in Server-Signer used to generate the extended public key.

    +

    seed_id

    seed_id: string

    The ID of the seed in Server-Signer used to generate the extended public key.

    Memberof

    SeedCreationEventResult

    -

    wallet_id

    wallet_id: string

    The ID of the wallet that the seed was created for

    +

    wallet_id

    wallet_id: string

    The ID of the wallet that the seed was created for

    Memberof

    SeedCreationEventResult

    -

    wallet_user_id

    wallet_user_id: string

    The ID of the user that the wallet belongs to

    +

    wallet_user_id

    wallet_user_id: string

    The ID of the user that the wallet belongs to

    Memberof

    SeedCreationEventResult

    -

    Settings

    Member Visibility

    Theme

    On This Page

    extended_public_keyseed_idwallet_idwallet_user_id
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    extended_public_keyseed_idwallet_idwallet_user_id
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ServerSigner.html b/docs/interfaces/client_api.ServerSigner.html index f934237f..cf8ba9dd 100644 --- a/docs/interfaces/client_api.ServerSigner.html +++ b/docs/interfaces/client_api.ServerSigner.html @@ -1,12 +1,12 @@ ServerSigner | @coinbase/coinbase-sdk

    Interface ServerSigner

    A Server-Signer assigned to sign transactions in a wallet.

    Export

    ServerSigner

    -
    interface ServerSigner {
        is_mpc: boolean;
        server_signer_id: string;
        wallets?: string[];
    }

    Properties

    is_mpc +
    interface ServerSigner {
        is_mpc: boolean;
        server_signer_id: string;
        wallets?: string[];
    }

    Properties

    is_mpc server_signer_id wallets?

    Properties

    is_mpc

    is_mpc: boolean

    Whether the Server-Signer uses MPC.

    Memberof

    ServerSigner

    -

    server_signer_id

    server_signer_id: string

    The ID of the server-signer

    +

    server_signer_id

    server_signer_id: string

    The ID of the server-signer

    Memberof

    ServerSigner

    -

    Optional wallets

    wallets?: string[]

    The IDs of the wallets that the server-signer can sign for

    +

    Optional wallets

    wallets?: string[]

    The IDs of the wallets that the server-signer can sign for

    Memberof

    ServerSigner

    -

    Settings

    Member Visibility

    Theme

    On This Page

    is_mpcserver_signer_idwallets
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    is_mpcserver_signer_idwallets
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ServerSignerEvent.html b/docs/interfaces/client_api.ServerSignerEvent.html index b2a74e51..2987a78c 100644 --- a/docs/interfaces/client_api.ServerSignerEvent.html +++ b/docs/interfaces/client_api.ServerSignerEvent.html @@ -1,8 +1,8 @@ ServerSignerEvent | @coinbase/coinbase-sdk

    Interface ServerSignerEvent

    An event that is waiting to be processed by a Server-Signer.

    Export

    ServerSignerEvent

    -
    interface ServerSignerEvent {
        event: ServerSignerEventEvent;
        server_signer_id: string;
    }

    Properties

    event +
    interface ServerSignerEvent {
        event: ServerSignerEventEvent;
        server_signer_id: string;
    }

    Properties

    event server_signer_id

    Properties

    event

    event: ServerSignerEventEvent

    Memberof

    ServerSignerEvent

    -

    server_signer_id

    server_signer_id: string

    The ID of the server-signer that the event is for

    +

    server_signer_id

    server_signer_id: string

    The ID of the server-signer that the event is for

    Memberof

    ServerSignerEvent

    -

    Settings

    Member Visibility

    Theme

    On This Page

    eventserver_signer_id
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    eventserver_signer_id
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ServerSignerEventList.html b/docs/interfaces/client_api.ServerSignerEventList.html index 5603abf8..9f65004c 100644 --- a/docs/interfaces/client_api.ServerSignerEventList.html +++ b/docs/interfaces/client_api.ServerSignerEventList.html @@ -1,13 +1,13 @@ ServerSignerEventList | @coinbase/coinbase-sdk

    Interface ServerSignerEventList

    Export

    ServerSignerEventList

    -
    interface ServerSignerEventList {
        data: ServerSignerEvent[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data +
    interface ServerSignerEventList {
        data: ServerSignerEvent[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data has_more next_page total_count

    Properties

    data

    data: ServerSignerEvent[]

    Memberof

    ServerSignerEventList

    -

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    ServerSignerEventList

    -

    next_page

    next_page: string

    The page token to be used to fetch the next page.

    +

    next_page

    next_page: string

    The page token to be used to fetch the next page.

    Memberof

    ServerSignerEventList

    -

    total_count

    total_count: number

    The total number of events for the server signer.

    +

    total_count

    total_count: number

    The total number of events for the server signer.

    Memberof

    ServerSignerEventList

    -

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_pagetotal_count
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_pagetotal_count
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ServerSignerList.html b/docs/interfaces/client_api.ServerSignerList.html index b069eb59..a000cb34 100644 --- a/docs/interfaces/client_api.ServerSignerList.html +++ b/docs/interfaces/client_api.ServerSignerList.html @@ -1,13 +1,13 @@ ServerSignerList | @coinbase/coinbase-sdk

    Interface ServerSignerList

    Export

    ServerSignerList

    -
    interface ServerSignerList {
        data: ServerSigner[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data +
    interface ServerSignerList {
        data: ServerSigner[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data has_more next_page total_count

    Properties

    data

    data: ServerSigner[]

    Memberof

    ServerSignerList

    -

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    ServerSignerList

    -

    next_page

    next_page: string

    The page token to be used to fetch the next page.

    +

    next_page

    next_page: string

    The page token to be used to fetch the next page.

    Memberof

    ServerSignerList

    -

    total_count

    total_count: number

    The total number of server-signers for the project.

    +

    total_count

    total_count: number

    The total number of server-signers for the project.

    Memberof

    ServerSignerList

    -

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_pagetotal_count
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_pagetotal_count
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ServerSignersApiInterface.html b/docs/interfaces/client_api.ServerSignersApiInterface.html index 8b0e1c97..f9b4047e 100644 --- a/docs/interfaces/client_api.ServerSignersApiInterface.html +++ b/docs/interfaces/client_api.ServerSignersApiInterface.html @@ -1,6 +1,6 @@ ServerSignersApiInterface | @coinbase/coinbase-sdk

    Interface ServerSignersApiInterface

    ServerSignersApi - interface

    Export

    ServerSignersApi

    -
    interface ServerSignersApiInterface {
        createServerSigner(createServerSignerRequest?, options?): AxiosPromise<ServerSigner>;
        getServerSigner(serverSignerId, options?): AxiosPromise<ServerSigner>;
        listServerSignerEvents(serverSignerId, limit?, page?, options?): AxiosPromise<ServerSignerEventList>;
        listServerSigners(limit?, page?, options?): AxiosPromise<ServerSignerList>;
        submitServerSignerSeedEventResult(serverSignerId, seedCreationEventResult?, options?): AxiosPromise<SeedCreationEventResult>;
        submitServerSignerSignatureEventResult(serverSignerId, signatureCreationEventResult?, options?): AxiosPromise<SignatureCreationEventResult>;
    }

    Implemented by

    Methods

    createServerSigner +
    interface ServerSignersApiInterface {
        createServerSigner(createServerSignerRequest?, options?): AxiosPromise<ServerSigner>;
        getServerSigner(serverSignerId, options?): AxiosPromise<ServerSigner>;
        listServerSignerEvents(serverSignerId, limit?, page?, options?): AxiosPromise<ServerSignerEventList>;
        listServerSigners(limit?, page?, options?): AxiosPromise<ServerSignerList>;
        submitServerSignerSeedEventResult(serverSignerId, seedCreationEventResult?, options?): AxiosPromise<SeedCreationEventResult>;
        submitServerSignerSignatureEventResult(serverSignerId, signatureCreationEventResult?, options?): AxiosPromise<SignatureCreationEventResult>;
    }

    Implemented by

    Methods

    createServerSigner getServerSigner listServerSignerEvents listServerSigners @@ -10,32 +10,32 @@

    Parameters

    • Optional createServerSignerRequest: CreateServerSignerRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ServerSigner>

    Summary

    Create a new Server-Signer

    Throws

    Memberof

    ServerSignersApiInterface

    -

    getServerSigner

    getServerSigner

    • getServerSigner(serverSignerId, options?): AxiosPromise<ServerSigner>

    • Get a server signer by ID

      Parameters

      • serverSignerId: string

        The ID of the server signer to fetch

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<ServerSigner>

      Summary

      Get a server signer by ID

      Throws

      Memberof

      ServerSignersApiInterface

      -

    listServerSignerEvents

    listServerSignerEvents

    • listServerSignerEvents(serverSignerId, limit?, page?, options?): AxiosPromise<ServerSignerEventList>

    • List events for a server signer

      Parameters

      • serverSignerId: string

        The ID of the server signer to fetch events for

      • Optional limit: number

        A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

      • Optional page: string

        A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<ServerSignerEventList>

      Summary

      List events for a server signer

      Deprecated

      Throws

      Memberof

      ServerSignersApiInterface

      -

    listServerSigners

    listServerSigners

    • listServerSigners(limit?, page?, options?): AxiosPromise<ServerSignerList>

    • List server signers for the current project

      Parameters

      • Optional limit: number

        A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

      • Optional page: string

        A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<ServerSignerList>

      Summary

      List server signers for the current project

      Throws

      Memberof

      ServerSignersApiInterface

      -

    submitServerSignerSeedEventResult

    submitServerSignerSeedEventResult

    • submitServerSignerSeedEventResult(serverSignerId, seedCreationEventResult?, options?): AxiosPromise<SeedCreationEventResult>

    • Submit the result of a server signer event

      Parameters

      • serverSignerId: string

        The ID of the server signer to submit the event result for

      • Optional seedCreationEventResult: SeedCreationEventResult
      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<SeedCreationEventResult>

      Summary

      Submit the result of a server signer event

      Throws

      Memberof

      ServerSignersApiInterface

      -

    submitServerSignerSignatureEventResult

    submitServerSignerSignatureEventResult

    • submitServerSignerSignatureEventResult(serverSignerId, signatureCreationEventResult?, options?): AxiosPromise<SignatureCreationEventResult>

    • Submit the result of a server signer event

      Parameters

      • serverSignerId: string

        The ID of the server signer to submit the event result for

      • Optional signatureCreationEventResult: SignatureCreationEventResult
      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<SignatureCreationEventResult>

      Summary

      Submit the result of a server signer event

      Throws

      Memberof

      ServerSignersApiInterface

      -

    Settings

    Member Visibility

    Theme

    On This Page

    createServerSignergetServerSignerlistServerSignerEventslistServerSignerssubmitServerSignerSeedEventResultsubmitServerSignerSignatureEventResult
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    createServerSignergetServerSignerlistServerSignerEventslistServerSignerssubmitServerSignerSeedEventResultsubmitServerSignerSignatureEventResult
    \ No newline at end of file diff --git a/docs/interfaces/client_api.SignatureCreationEvent.html b/docs/interfaces/client_api.SignatureCreationEvent.html index ea416563..a30f1b63 100644 --- a/docs/interfaces/client_api.SignatureCreationEvent.html +++ b/docs/interfaces/client_api.SignatureCreationEvent.html @@ -1,6 +1,6 @@ SignatureCreationEvent | @coinbase/coinbase-sdk

    Interface SignatureCreationEvent

    An event representing a signature creation.

    Export

    SignatureCreationEvent

    -
    interface SignatureCreationEvent {
        address_id: string;
        address_index: number;
        seed_id: string;
        signing_payload: string;
        transaction_id: string;
        transaction_type: "transfer";
        wallet_id: string;
        wallet_user_id: string;
    }

    Properties

    address_id +
    interface SignatureCreationEvent {
        address_id: string;
        address_index: number;
        seed_id: string;
        signing_payload: string;
        transaction_id: string;
        transaction_type: "transfer";
        wallet_id: string;
        wallet_user_id: string;
    }

    Properties

    address_id address_index seed_id signing_payload @@ -10,17 +10,17 @@ wallet_user_id

    Properties

    address_id

    address_id: string

    The ID of the address the transfer belongs to

    Memberof

    SignatureCreationEvent

    -

    address_index

    address_index: number

    The index of the address that the server-signer should sign with

    +

    address_index

    address_index: number

    The index of the address that the server-signer should sign with

    Memberof

    SignatureCreationEvent

    -

    seed_id

    seed_id: string

    The ID of the seed that the server-signer should create the signature for

    +

    seed_id

    seed_id: string

    The ID of the seed that the server-signer should create the signature for

    Memberof

    SignatureCreationEvent

    -

    signing_payload

    signing_payload: string

    The payload that the server-signer should sign

    +

    signing_payload

    signing_payload: string

    The payload that the server-signer should sign

    Memberof

    SignatureCreationEvent

    -

    transaction_id

    transaction_id: string

    The ID of the transaction that the server-signer should sign

    +

    transaction_id

    transaction_id: string

    The ID of the transaction that the server-signer should sign

    Memberof

    SignatureCreationEvent

    -

    transaction_type

    transaction_type: "transfer"

    Memberof

    SignatureCreationEvent

    -

    wallet_id

    wallet_id: string

    The ID of the wallet the signature is for

    +

    transaction_type

    transaction_type: "transfer"

    Memberof

    SignatureCreationEvent

    +

    wallet_id

    wallet_id: string

    The ID of the wallet the signature is for

    Memberof

    SignatureCreationEvent

    -

    wallet_user_id

    wallet_user_id: string

    The ID of the user that the wallet belongs to

    +

    wallet_user_id

    wallet_user_id: string

    The ID of the user that the wallet belongs to

    Memberof

    SignatureCreationEvent

    -

    Settings

    Member Visibility

    Theme

    On This Page

    address_idaddress_indexseed_idsigning_payloadtransaction_idtransaction_typewallet_idwallet_user_id
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    address_idaddress_indexseed_idsigning_payloadtransaction_idtransaction_typewallet_idwallet_user_id
    \ No newline at end of file diff --git a/docs/interfaces/client_api.SignatureCreationEventResult.html b/docs/interfaces/client_api.SignatureCreationEventResult.html index 6f3637e3..db268f5b 100644 --- a/docs/interfaces/client_api.SignatureCreationEventResult.html +++ b/docs/interfaces/client_api.SignatureCreationEventResult.html @@ -1,6 +1,6 @@ SignatureCreationEventResult | @coinbase/coinbase-sdk

    Interface SignatureCreationEventResult

    The result to a SignatureCreationEvent.

    Export

    SignatureCreationEventResult

    -
    interface SignatureCreationEventResult {
        address_id: string;
        signature: string;
        transaction_id: string;
        transaction_type: "transfer";
        wallet_id: string;
        wallet_user_id: string;
    }

    Properties

    address_id +
    interface SignatureCreationEventResult {
        address_id: string;
        signature: string;
        transaction_id: string;
        transaction_type: "transfer";
        wallet_id: string;
        wallet_user_id: string;
    }

    Properties

    address_id signature transaction_id transaction_type @@ -8,13 +8,13 @@ wallet_user_id

    Properties

    address_id

    address_id: string

    The ID of the address the transfer belongs to

    Memberof

    SignatureCreationEventResult

    -

    signature

    signature: string

    The signature created by the server-signer.

    +

    signature

    signature: string

    The signature created by the server-signer.

    Memberof

    SignatureCreationEventResult

    -

    transaction_id

    transaction_id: string

    The ID of the transaction that the Server-Signer has signed for

    +

    transaction_id

    transaction_id: string

    The ID of the transaction that the Server-Signer has signed for

    Memberof

    SignatureCreationEventResult

    -

    transaction_type

    transaction_type: "transfer"

    Memberof

    SignatureCreationEventResult

    -

    wallet_id

    wallet_id: string

    The ID of the wallet that the event was created for.

    +

    transaction_type

    transaction_type: "transfer"

    Memberof

    SignatureCreationEventResult

    +

    wallet_id

    wallet_id: string

    The ID of the wallet that the event was created for.

    Memberof

    SignatureCreationEventResult

    -

    wallet_user_id

    wallet_user_id: string

    The ID of the user that the wallet belongs to

    +

    wallet_user_id

    wallet_user_id: string

    The ID of the user that the wallet belongs to

    Memberof

    SignatureCreationEventResult

    -

    Settings

    Member Visibility

    Theme

    On This Page

    address_idsignaturetransaction_idtransaction_typewallet_idwallet_user_id
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    address_idsignaturetransaction_idtransaction_typewallet_idwallet_user_id
    \ No newline at end of file diff --git a/docs/interfaces/client_api.SignedVoluntaryExitMessageMetadata.html b/docs/interfaces/client_api.SignedVoluntaryExitMessageMetadata.html index 65511eb7..2b170735 100644 --- a/docs/interfaces/client_api.SignedVoluntaryExitMessageMetadata.html +++ b/docs/interfaces/client_api.SignedVoluntaryExitMessageMetadata.html @@ -1,12 +1,12 @@ SignedVoluntaryExitMessageMetadata | @coinbase/coinbase-sdk

    Interface SignedVoluntaryExitMessageMetadata

    Signed voluntary exit message metadata to be provided to beacon chain to exit a validator.

    Export

    SignedVoluntaryExitMessageMetadata

    -
    interface SignedVoluntaryExitMessageMetadata {
        fork: string;
        signed_voluntary_exit: string;
        validator_pub_key: string;
    }

    Properties

    fork +
    interface SignedVoluntaryExitMessageMetadata {
        fork: string;
        signed_voluntary_exit: string;
        validator_pub_key: string;
    }

    Properties

    fork signed_voluntary_exit validator_pub_key

    Properties

    fork

    fork: string

    The current fork version of the Ethereum beacon chain.

    Memberof

    SignedVoluntaryExitMessageMetadata

    -

    signed_voluntary_exit

    signed_voluntary_exit: string

    A base64 encoded version of a json string representing a voluntary exit message.

    +

    signed_voluntary_exit

    signed_voluntary_exit: string

    A base64 encoded version of a json string representing a voluntary exit message.

    Memberof

    SignedVoluntaryExitMessageMetadata

    -

    validator_pub_key

    validator_pub_key: string

    The public key of the validator associated with the exit message.

    +

    validator_pub_key

    validator_pub_key: string

    The public key of the validator associated with the exit message.

    Memberof

    SignedVoluntaryExitMessageMetadata

    -

    Settings

    Member Visibility

    Theme

    On This Page

    forksigned_voluntary_exitvalidator_pub_key
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    forksigned_voluntary_exitvalidator_pub_key
    \ No newline at end of file diff --git a/docs/interfaces/client_api.SmartContract.html b/docs/interfaces/client_api.SmartContract.html index 53392445..7f8d620f 100644 --- a/docs/interfaces/client_api.SmartContract.html +++ b/docs/interfaces/client_api.SmartContract.html @@ -1,6 +1,6 @@ SmartContract | @coinbase/coinbase-sdk

    Interface SmartContract

    Represents a smart contract on the blockchain

    Export

    SmartContract

    -
    interface SmartContract {
        abi: string;
        contract_address: string;
        deployer_address: string;
        network_id: string;
        options: SmartContractOptions;
        smart_contract_id: string;
        transaction: Transaction;
        type: SmartContractType;
        wallet_id: string;
    }

    Properties

    abi +
    interface SmartContract {
        abi: string;
        contract_address: string;
        deployer_address: string;
        network_id: string;
        options: SmartContractOptions;
        smart_contract_id: string;
        transaction: Transaction;
        type: SmartContractType;
        wallet_id: string;
    }

    Properties

    abi contract_address deployer_address network_id @@ -11,17 +11,17 @@ wallet_id

    Properties

    abi

    abi: string

    The JSON-encoded ABI of the contract

    Memberof

    SmartContract

    -

    contract_address

    contract_address: string

    The EVM address of the smart contract

    +

    contract_address

    contract_address: string

    The EVM address of the smart contract

    Memberof

    SmartContract

    -

    deployer_address

    deployer_address: string

    The EVM address of the account that deployed the smart contract

    +

    deployer_address

    deployer_address: string

    The EVM address of the account that deployed the smart contract

    Memberof

    SmartContract

    -

    network_id

    network_id: string

    The name of the blockchain network

    +

    network_id

    network_id: string

    The name of the blockchain network

    Memberof

    SmartContract

    -

    options

    options: SmartContractOptions

    Memberof

    SmartContract

    -

    smart_contract_id

    smart_contract_id: string

    The unique identifier of the smart contract

    +

    options

    options: SmartContractOptions

    Memberof

    SmartContract

    +

    smart_contract_id

    smart_contract_id: string

    The unique identifier of the smart contract

    Memberof

    SmartContract

    -

    transaction

    transaction: Transaction

    Memberof

    SmartContract

    -

    type

    type: SmartContractType

    Memberof

    SmartContract

    -

    wallet_id

    wallet_id: string

    The ID of the wallet that deployed the smart contract

    +

    transaction

    transaction: Transaction

    Memberof

    SmartContract

    +

    type

    type: SmartContractType

    Memberof

    SmartContract

    +

    wallet_id

    wallet_id: string

    The ID of the wallet that deployed the smart contract

    Memberof

    SmartContract

    -

    Settings

    Member Visibility

    Theme

    On This Page

    abicontract_addressdeployer_addressnetwork_idoptionssmart_contract_idtransactiontypewallet_id
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    abicontract_addressdeployer_addressnetwork_idoptionssmart_contract_idtransactiontypewallet_id
    \ No newline at end of file diff --git a/docs/interfaces/client_api.SmartContractList.html b/docs/interfaces/client_api.SmartContractList.html index da525bb7..c35b1697 100644 --- a/docs/interfaces/client_api.SmartContractList.html +++ b/docs/interfaces/client_api.SmartContractList.html @@ -1,10 +1,10 @@ SmartContractList | @coinbase/coinbase-sdk

    Interface SmartContractList

    Export

    SmartContractList

    -
    interface SmartContractList {
        data: SmartContract[];
        has_more: boolean;
        next_page: string;
    }

    Properties

    data +
    interface SmartContractList {
        data: SmartContract[];
        has_more: boolean;
        next_page: string;
    }

    Properties

    data has_more next_page

    Properties

    data

    data: SmartContract[]

    Memberof

    SmartContractList

    -

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    SmartContractList

    -

    next_page

    next_page: string

    The page token to be used to fetch the next page.

    +

    next_page

    next_page: string

    The page token to be used to fetch the next page.

    Memberof

    SmartContractList

    -

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_page
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_page
    \ No newline at end of file diff --git a/docs/interfaces/client_api.SmartContractsApiInterface.html b/docs/interfaces/client_api.SmartContractsApiInterface.html index 430012db..dfe78f4a 100644 --- a/docs/interfaces/client_api.SmartContractsApiInterface.html +++ b/docs/interfaces/client_api.SmartContractsApiInterface.html @@ -1,6 +1,6 @@ SmartContractsApiInterface | @coinbase/coinbase-sdk

    Interface SmartContractsApiInterface

    SmartContractsApi - interface

    Export

    SmartContractsApi

    -
    interface SmartContractsApiInterface {
        createSmartContract(walletId, addressId, createSmartContractRequest, options?): AxiosPromise<SmartContract>;
        deploySmartContract(walletId, addressId, smartContractId, deploySmartContractRequest, options?): AxiosPromise<SmartContract>;
        getSmartContract(walletId, addressId, smartContractId, options?): AxiosPromise<SmartContract>;
        listSmartContracts(walletId, addressId, options?): AxiosPromise<SmartContractList>;
        readContract(networkId, contractAddress, readContractRequest, options?): AxiosPromise<SolidityValue>;
    }

    Implemented by

    Methods

    createSmartContract +
    interface SmartContractsApiInterface {
        createSmartContract(walletId, addressId, createSmartContractRequest, options?): AxiosPromise<SmartContract>;
        deploySmartContract(walletId, addressId, smartContractId, deploySmartContractRequest, options?): AxiosPromise<SmartContract>;
        getSmartContract(walletId, addressId, smartContractId, options?): AxiosPromise<SmartContract>;
        listSmartContracts(walletId, addressId, options?): AxiosPromise<SmartContractList>;
        readContract(networkId, contractAddress, readContractRequest, options?): AxiosPromise<SolidityValue>;
    }

    Implemented by

    Methods

    createSmartContract deploySmartContract getSmartContract listSmartContracts @@ -11,28 +11,28 @@
  • createSmartContractRequest: CreateSmartContractRequest
  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns AxiosPromise<SmartContract>

    Summary

    Create a new smart contract

    Throws

    Memberof

    SmartContractsApiInterface

    -

    deploySmartContract

    • deploySmartContract(walletId, addressId, smartContractId, deploySmartContractRequest, options?): AxiosPromise<SmartContract>

    • Deploys a smart contract, by broadcasting the transaction to the network.

      +

    deploySmartContract

    • deploySmartContract(walletId, addressId, smartContractId, deploySmartContractRequest, options?): AxiosPromise<SmartContract>

    • Deploys a smart contract, by broadcasting the transaction to the network.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The ID of the address to broadcast the transaction from.

      • smartContractId: string

        The UUID of the smart contract to broadcast the transaction to.

      • deploySmartContractRequest: DeploySmartContractRequest
      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<SmartContract>

      Summary

      Deploy a smart contract

      Throws

      Memberof

      SmartContractsApiInterface

      -

    getSmartContract

    • getSmartContract(walletId, addressId, smartContractId, options?): AxiosPromise<SmartContract>

    • Get a specific smart contract deployed by address.

      +

    getSmartContract

    • getSmartContract(walletId, addressId, smartContractId, options?): AxiosPromise<SmartContract>

    • Get a specific smart contract deployed by address.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The ID of the address to fetch the smart contract for.

      • smartContractId: string

        The UUID of the smart contract to fetch.

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<SmartContract>

      Summary

      Get a specific smart contract deployed by address

      Throws

      Memberof

      SmartContractsApiInterface

      -

    listSmartContracts

    listSmartContracts

    • listSmartContracts(walletId, addressId, options?): AxiosPromise<SmartContractList>

    • List all smart contracts deployed by address.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The ID of the address to fetch the smart contracts for.

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<SmartContractList>

      Summary

      List smart contracts deployed by address

      Throws

      Memberof

      SmartContractsApiInterface

      -

    readContract

    • readContract(networkId, contractAddress, readContractRequest, options?): AxiosPromise<SolidityValue>

    • Perform a read operation on a smart contract without creating a transaction

      +

    readContract

    • readContract(networkId, contractAddress, readContractRequest, options?): AxiosPromise<SolidityValue>

    • Perform a read operation on a smart contract without creating a transaction

      Parameters

      • networkId: string
      • contractAddress: string
      • readContractRequest: ReadContractRequest
      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<SolidityValue>

      Summary

      Read data from a smart contract

      Throws

      Memberof

      SmartContractsApiInterface

      -

    Settings

    Member Visibility

    Theme

    On This Page

    createSmartContractdeploySmartContractgetSmartContractlistSmartContractsreadContract
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    createSmartContractdeploySmartContractgetSmartContractlistSmartContractsreadContract
    \ No newline at end of file diff --git a/docs/interfaces/client_api.SolidityValue.html b/docs/interfaces/client_api.SolidityValue.html index ff009a52..381d9d42 100644 --- a/docs/interfaces/client_api.SolidityValue.html +++ b/docs/interfaces/client_api.SolidityValue.html @@ -1,13 +1,13 @@ SolidityValue | @coinbase/coinbase-sdk

    Interface SolidityValue

    Export

    SolidityValue

    -
    interface SolidityValue {
        name?: string;
        type: SolidityValueTypeEnum;
        value?: string;
        values?: SolidityValue[];
    }

    Properties

    name? +
    interface SolidityValue {
        name?: string;
        type: SolidityValueTypeEnum;
        value?: string;
        values?: SolidityValue[];
    }

    Properties

    name? type value? values?

    Properties

    Optional name

    name?: string

    The field name for tuple types. Not used for other types.

    Memberof

    SolidityValue

    -

    type

    type: SolidityValueTypeEnum

    Memberof

    SolidityValue

    -

    Optional value

    value?: string

    The value as a string for simple types. Not used for complex types (array, tuple).

    +

    type

    type: SolidityValueTypeEnum

    Memberof

    SolidityValue

    +

    Optional value

    value?: string

    The value as a string for simple types. Not used for complex types (array, tuple).

    Memberof

    SolidityValue

    -

    Optional values

    values?: SolidityValue[]

    For array and tuple types, the components of the value

    +

    Optional values

    values?: SolidityValue[]

    For array and tuple types, the components of the value

    Memberof

    SolidityValue

    -

    Settings

    Member Visibility

    Theme

    On This Page

    nametypevaluevalues
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    nametypevaluevalues
    \ No newline at end of file diff --git a/docs/interfaces/client_api.SponsoredSend.html b/docs/interfaces/client_api.SponsoredSend.html index 0375793e..dd67fb33 100644 --- a/docs/interfaces/client_api.SponsoredSend.html +++ b/docs/interfaces/client_api.SponsoredSend.html @@ -1,6 +1,6 @@ SponsoredSend | @coinbase/coinbase-sdk

    Interface SponsoredSend

    An onchain sponsored gasless send.

    Export

    SponsoredSend

    -
    interface SponsoredSend {
        raw_typed_data: string;
        signature?: string;
        status: SponsoredSendStatusEnum;
        to_address_id: string;
        transaction_hash?: string;
        transaction_link?: string;
        typed_data_hash: string;
    }

    Properties

    raw_typed_data +
    interface SponsoredSend {
        raw_typed_data: string;
        signature?: string;
        status: SponsoredSendStatusEnum;
        to_address_id: string;
        transaction_hash?: string;
        transaction_link?: string;
        typed_data_hash: string;
    }

    Properties

    raw_typed_data signature? status to_address_id @@ -9,16 +9,16 @@ typed_data_hash

    Properties

    raw_typed_data

    raw_typed_data: string

    The raw typed data for the sponsored send

    Memberof

    SponsoredSend

    -

    Optional signature

    signature?: string

    The signed hash of the sponsored send typed data.

    +

    Optional signature

    signature?: string

    The signed hash of the sponsored send typed data.

    Memberof

    SponsoredSend

    -

    status

    status: SponsoredSendStatusEnum

    The status of the sponsored send

    +

    status

    status: SponsoredSendStatusEnum

    The status of the sponsored send

    Memberof

    SponsoredSend

    -

    to_address_id

    to_address_id: string

    The onchain address of the recipient

    +

    to_address_id

    to_address_id: string

    The onchain address of the recipient

    Memberof

    SponsoredSend

    -

    Optional transaction_hash

    transaction_hash?: string

    The hash of the onchain sponsored send transaction

    +

    Optional transaction_hash

    transaction_hash?: string

    The hash of the onchain sponsored send transaction

    Memberof

    SponsoredSend

    -

    Optional transaction_link

    transaction_link?: string

    The link to view the transaction on a block explorer. This is optional and may not be present for all transactions.

    +

    Optional transaction_link

    transaction_link?: string

    The link to view the transaction on a block explorer. This is optional and may not be present for all transactions.

    Memberof

    SponsoredSend

    -

    typed_data_hash

    typed_data_hash: string

    The typed data hash for the sponsored send. This is the typed data hash that needs to be signed by the sender.

    +

    typed_data_hash

    typed_data_hash: string

    The typed data hash for the sponsored send. This is the typed data hash that needs to be signed by the sender.

    Memberof

    SponsoredSend

    -

    Settings

    Member Visibility

    Theme

    On This Page

    raw_typed_datasignaturestatusto_address_idtransaction_hashtransaction_linktyped_data_hash
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    raw_typed_datasignaturestatusto_address_idtransaction_hashtransaction_linktyped_data_hash
    \ No newline at end of file diff --git a/docs/interfaces/client_api.StakeApiInterface.html b/docs/interfaces/client_api.StakeApiInterface.html index 0272d86f..744b2396 100644 --- a/docs/interfaces/client_api.StakeApiInterface.html +++ b/docs/interfaces/client_api.StakeApiInterface.html @@ -1,6 +1,6 @@ StakeApiInterface | @coinbase/coinbase-sdk

    Interface StakeApiInterface

    StakeApi - interface

    Export

    StakeApi

    -
    interface StakeApiInterface {
        buildStakingOperation(buildStakingOperationRequest, options?): AxiosPromise<StakingOperation>;
        fetchHistoricalStakingBalances(networkId, assetId, addressId, startTime, endTime, limit?, page?, options?): AxiosPromise<FetchHistoricalStakingBalances200Response>;
        fetchStakingRewards(fetchStakingRewardsRequest, limit?, page?, options?): AxiosPromise<FetchStakingRewards200Response>;
        getExternalStakingOperation(networkId, addressId, stakingOperationId, options?): AxiosPromise<StakingOperation>;
        getStakingContext(getStakingContextRequest, options?): AxiosPromise<StakingContext>;
    }

    Implemented by

    Methods

    buildStakingOperation +
    interface StakeApiInterface {
        buildStakingOperation(buildStakingOperationRequest, options?): AxiosPromise<StakingOperation>;
        fetchHistoricalStakingBalances(networkId, assetId, addressId, startTime, endTime, limit?, page?, options?): AxiosPromise<FetchHistoricalStakingBalances200Response>;
        fetchStakingRewards(fetchStakingRewardsRequest, limit?, page?, options?): AxiosPromise<FetchStakingRewards200Response>;
        getExternalStakingOperation(networkId, addressId, stakingOperationId, options?): AxiosPromise<StakingOperation>;
        getStakingContext(getStakingContextRequest, options?): AxiosPromise<StakingContext>;
    }

    Implemented by

    Methods

    buildStakingOperation fetchHistoricalStakingBalances fetchStakingRewards getExternalStakingOperation @@ -9,7 +9,7 @@

    Parameters

    Returns AxiosPromise<StakingOperation>

    Summary

    Build a new staking operation

    Throws

    Memberof

    StakeApiInterface

    -

    fetchHistoricalStakingBalances

    fetchHistoricalStakingBalances

    • fetchHistoricalStakingBalances(networkId, assetId, addressId, startTime, endTime, limit?, page?, options?): AxiosPromise<FetchHistoricalStakingBalances200Response>

    • Fetch historical staking balances for given address.

      Parameters

      • networkId: string

        The ID of the blockchain network.

      • assetId: string

        The ID of the asset for which the historical staking balances are being fetched.

      • addressId: string

        The onchain address for which the historical staking balances are being fetched.

        @@ -20,21 +20,21 @@

        Throws

        Memberof

        StakeApiInterface

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<FetchHistoricalStakingBalances200Response>

      Summary

      Fetch historical staking balances

      Throws

      Memberof

      StakeApiInterface

      -

    fetchStakingRewards

    fetchStakingRewards

    • fetchStakingRewards(fetchStakingRewardsRequest, limit?, page?, options?): AxiosPromise<FetchStakingRewards200Response>

    • Fetch staking rewards for a list of addresses

      Parameters

      • fetchStakingRewardsRequest: FetchStakingRewardsRequest
      • Optional limit: number

        A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 50.

      • Optional page: string

        A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<FetchStakingRewards200Response>

      Summary

      Fetch staking rewards

      Throws

      Memberof

      StakeApiInterface

      -

    getExternalStakingOperation

    getExternalStakingOperation

    • getExternalStakingOperation(networkId, addressId, stakingOperationId, options?): AxiosPromise<StakingOperation>

    • Get the latest state of a staking operation

      Parameters

      • networkId: string

        The ID of the blockchain network

      • addressId: string

        The ID of the address to fetch the staking operation for

      • stakingOperationId: string

        The ID of the staking operation

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<StakingOperation>

      Summary

      Get the latest state of a staking operation

      Throws

      Memberof

      StakeApiInterface

      -

    getStakingContext

    getStakingContext

    • getStakingContext(getStakingContextRequest, options?): AxiosPromise<StakingContext>

    • Get staking context for an address

      Parameters

      Returns AxiosPromise<StakingContext>

      Summary

      Get staking context

      Throws

      Memberof

      StakeApiInterface

      -

    Settings

    Member Visibility

    Theme

    On This Page

    buildStakingOperationfetchHistoricalStakingBalancesfetchStakingRewardsgetExternalStakingOperationgetStakingContext
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    buildStakingOperationfetchHistoricalStakingBalancesfetchStakingRewardsgetExternalStakingOperationgetStakingContext
    \ No newline at end of file diff --git a/docs/interfaces/client_api.StakingBalance.html b/docs/interfaces/client_api.StakingBalance.html index b468462b..7dc79ba8 100644 --- a/docs/interfaces/client_api.StakingBalance.html +++ b/docs/interfaces/client_api.StakingBalance.html @@ -1,16 +1,16 @@ StakingBalance | @coinbase/coinbase-sdk

    Interface StakingBalance

    The staking balances for an address.

    Export

    StakingBalance

    -
    interface StakingBalance {
        address: string;
        bonded_stake: Balance;
        date: string;
        participant_type: string;
        unbonded_balance: Balance;
    }

    Properties

    address +
    interface StakingBalance {
        address: string;
        bonded_stake: Balance;
        date: string;
        participant_type: string;
        unbonded_balance: Balance;
    }

    Properties

    address bonded_stake date participant_type unbonded_balance

    Properties

    address

    address: string

    The onchain address for which the staking balances are being fetched.

    Memberof

    StakingBalance

    -

    bonded_stake

    bonded_stake: Balance

    Memberof

    StakingBalance

    -

    date

    date: string

    The timestamp of the staking balance in UTC.

    +

    bonded_stake

    bonded_stake: Balance

    Memberof

    StakingBalance

    +

    date

    date: string

    The timestamp of the staking balance in UTC.

    Memberof

    StakingBalance

    -

    participant_type

    participant_type: string

    The type of staking participation.

    +

    participant_type

    participant_type: string

    The type of staking participation.

    Memberof

    StakingBalance

    -

    unbonded_balance

    unbonded_balance: Balance

    Memberof

    StakingBalance

    -

    Settings

    Member Visibility

    Theme

    On This Page

    addressbonded_stakedateparticipant_typeunbonded_balance
    \ No newline at end of file +

    unbonded_balance

    unbonded_balance: Balance

    Memberof

    StakingBalance

    +

    Settings

    Member Visibility

    Theme

    On This Page

    addressbonded_stakedateparticipant_typeunbonded_balance
    \ No newline at end of file diff --git a/docs/interfaces/client_api.StakingContext.html b/docs/interfaces/client_api.StakingContext.html index ad20536e..21bb19de 100644 --- a/docs/interfaces/client_api.StakingContext.html +++ b/docs/interfaces/client_api.StakingContext.html @@ -1,5 +1,5 @@ StakingContext | @coinbase/coinbase-sdk

    Interface StakingContext

    Context needed to perform a staking operation

    Export

    StakingContext

    -
    interface StakingContext {
        context: StakingContextContext;
    }

    Properties

    context +
    interface StakingContext {
        context: StakingContextContext;
    }

    Properties

    context

    Properties

    context

    context: StakingContextContext

    Memberof

    StakingContext

    -

    Settings

    Member Visibility

    Theme

    On This Page

    context
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    context
    \ No newline at end of file diff --git a/docs/interfaces/client_api.StakingContextContext.html b/docs/interfaces/client_api.StakingContextContext.html index 32b7ec6d..7e5dbd1d 100644 --- a/docs/interfaces/client_api.StakingContextContext.html +++ b/docs/interfaces/client_api.StakingContextContext.html @@ -1,8 +1,8 @@ StakingContextContext | @coinbase/coinbase-sdk

    Interface StakingContextContext

    Export

    StakingContextContext

    -
    interface StakingContextContext {
        claimable_balance: Balance;
        stakeable_balance: Balance;
        unstakeable_balance: Balance;
    }

    Properties

    claimable_balance +
    interface StakingContextContext {
        claimable_balance: Balance;
        stakeable_balance: Balance;
        unstakeable_balance: Balance;
    }

    Properties

    claimable_balance stakeable_balance unstakeable_balance

    Properties

    claimable_balance

    claimable_balance: Balance

    Memberof

    StakingContextContext

    -

    stakeable_balance

    stakeable_balance: Balance

    Memberof

    StakingContextContext

    -

    unstakeable_balance

    unstakeable_balance: Balance

    Memberof

    StakingContextContext

    -

    Settings

    Member Visibility

    Theme

    On This Page

    claimable_balancestakeable_balanceunstakeable_balance
    \ No newline at end of file +

    stakeable_balance

    stakeable_balance: Balance

    Memberof

    StakingContextContext

    +

    unstakeable_balance

    unstakeable_balance: Balance

    Memberof

    StakingContextContext

    +

    Settings

    Member Visibility

    Theme

    On This Page

    claimable_balancestakeable_balanceunstakeable_balance
    \ No newline at end of file diff --git a/docs/interfaces/client_api.StakingOperation.html b/docs/interfaces/client_api.StakingOperation.html index 0f281410..d0e81082 100644 --- a/docs/interfaces/client_api.StakingOperation.html +++ b/docs/interfaces/client_api.StakingOperation.html @@ -1,6 +1,6 @@ StakingOperation | @coinbase/coinbase-sdk

    Interface StakingOperation

    A list of onchain transactions to help realize a staking action.

    Export

    StakingOperation

    -
    interface StakingOperation {
        address_id: string;
        id: string;
        metadata?: StakingOperationMetadata;
        network_id: string;
        status: StakingOperationStatusEnum;
        transactions: Transaction[];
        wallet_id?: string;
    }

    Properties

    address_id +
    interface StakingOperation {
        address_id: string;
        id: string;
        metadata?: StakingOperationMetadata;
        network_id: string;
        status: StakingOperationStatusEnum;
        transactions: Transaction[];
        wallet_id?: string;
    }

    Properties

    address_id id metadata? network_id @@ -9,15 +9,15 @@ wallet_id?

    Properties

    address_id

    address_id: string

    The onchain address orchestrating the staking operation.

    Memberof

    StakingOperation

    -

    id

    id: string

    The unique ID of the staking operation.

    +

    id

    id: string

    The unique ID of the staking operation.

    Memberof

    StakingOperation

    -

    Optional metadata

    metadata?: StakingOperationMetadata

    Memberof

    StakingOperation

    -

    network_id

    network_id: string

    The ID of the blockchain network.

    +

    Optional metadata

    metadata?: StakingOperationMetadata

    Memberof

    StakingOperation

    +

    network_id

    network_id: string

    The ID of the blockchain network.

    Memberof

    StakingOperation

    -

    status

    status: StakingOperationStatusEnum

    The status of the staking operation.

    +

    status

    status: StakingOperationStatusEnum

    The status of the staking operation.

    Memberof

    StakingOperation

    -

    transactions

    transactions: Transaction[]

    The transaction(s) that will execute the staking operation onchain.

    +

    transactions

    transactions: Transaction[]

    The transaction(s) that will execute the staking operation onchain.

    Memberof

    StakingOperation

    -

    Optional wallet_id

    wallet_id?: string

    The ID of the wallet that owns the address.

    +

    Optional wallet_id

    wallet_id?: string

    The ID of the wallet that owns the address.

    Memberof

    StakingOperation

    -

    Settings

    Member Visibility

    Theme

    On This Page

    address_ididmetadatanetwork_idstatustransactionswallet_id
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    address_ididmetadatanetwork_idstatustransactionswallet_id
    \ No newline at end of file diff --git a/docs/interfaces/client_api.StakingReward.html b/docs/interfaces/client_api.StakingReward.html index 6f002259..58d5d19a 100644 --- a/docs/interfaces/client_api.StakingReward.html +++ b/docs/interfaces/client_api.StakingReward.html @@ -1,6 +1,6 @@ StakingReward | @coinbase/coinbase-sdk

    Interface StakingReward

    The staking rewards for an address.

    Export

    StakingReward

    -
    interface StakingReward {
        address_id: string;
        amount: string;
        date: string;
        format: StakingRewardFormat;
        state: StakingRewardStateEnum;
        usd_value: StakingRewardUSDValue;
    }

    Properties

    address_id +
    interface StakingReward {
        address_id: string;
        amount: string;
        date: string;
        format: StakingRewardFormat;
        state: StakingRewardStateEnum;
        usd_value: StakingRewardUSDValue;
    }

    Properties

    address_id amount date format @@ -8,12 +8,12 @@ usd_value

    Properties

    address_id

    address_id: string

    The onchain address for which the staking rewards are being fetched.

    Memberof

    StakingReward

    -

    amount

    amount: string

    The reward amount in requested "format". Default is USD.

    +

    amount

    amount: string

    The reward amount in requested "format". Default is USD.

    Memberof

    StakingReward

    -

    date

    date: string

    The timestamp of the reward in UTC.

    +

    date

    date: string

    The timestamp of the reward in UTC.

    Memberof

    StakingReward

    -

    format

    format: StakingRewardFormat

    Memberof

    StakingReward

    -

    state

    state: StakingRewardStateEnum

    The state of the reward.

    +

    format

    format: StakingRewardFormat

    Memberof

    StakingReward

    +

    state

    state: StakingRewardStateEnum

    The state of the reward.

    Memberof

    StakingReward

    -

    usd_value

    usd_value: StakingRewardUSDValue

    Memberof

    StakingReward

    -

    Settings

    Member Visibility

    Theme

    On This Page

    address_idamountdateformatstateusd_value
    \ No newline at end of file +

    usd_value

    usd_value: StakingRewardUSDValue

    Memberof

    StakingReward

    +

    Settings

    Member Visibility

    Theme

    On This Page

    address_idamountdateformatstateusd_value
    \ No newline at end of file diff --git a/docs/interfaces/client_api.StakingRewardUSDValue.html b/docs/interfaces/client_api.StakingRewardUSDValue.html index 1b47bd6b..6e8f7293 100644 --- a/docs/interfaces/client_api.StakingRewardUSDValue.html +++ b/docs/interfaces/client_api.StakingRewardUSDValue.html @@ -1,12 +1,12 @@ StakingRewardUSDValue | @coinbase/coinbase-sdk

    Interface StakingRewardUSDValue

    The USD value of the reward

    Export

    StakingRewardUSDValue

    -
    interface StakingRewardUSDValue {
        amount: string;
        conversion_price: string;
        conversion_time: string;
    }

    Properties

    amount +
    interface StakingRewardUSDValue {
        amount: string;
        conversion_price: string;
        conversion_time: string;
    }

    Properties

    amount conversion_price conversion_time

    Properties

    amount

    amount: string

    The value of the reward in USD

    Memberof

    StakingRewardUSDValue

    -

    conversion_price

    conversion_price: string

    The conversion price from native currency to USD

    +

    conversion_price

    conversion_price: string

    The conversion price from native currency to USD

    Memberof

    StakingRewardUSDValue

    -

    conversion_time

    conversion_time: string

    The time of the conversion in UTC.

    +

    conversion_time

    conversion_time: string

    The time of the conversion in UTC.

    Memberof

    StakingRewardUSDValue

    -

    Settings

    Member Visibility

    Theme

    On This Page

    amountconversion_priceconversion_time
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    amountconversion_priceconversion_time
    \ No newline at end of file diff --git a/docs/interfaces/client_api.TokenContractOptions.html b/docs/interfaces/client_api.TokenContractOptions.html index 9aac510c..5676d8b6 100644 --- a/docs/interfaces/client_api.TokenContractOptions.html +++ b/docs/interfaces/client_api.TokenContractOptions.html @@ -1,12 +1,12 @@ TokenContractOptions | @coinbase/coinbase-sdk

    Interface TokenContractOptions

    Options for token contract creation

    Export

    TokenContractOptions

    -
    interface TokenContractOptions {
        name: string;
        symbol: string;
        total_supply: string;
    }

    Properties

    name +
    interface TokenContractOptions {
        name: string;
        symbol: string;
        total_supply: string;
    }

    Properties

    name symbol total_supply

    Properties

    name

    name: string

    The name of the token

    Memberof

    TokenContractOptions

    -

    symbol

    symbol: string

    The symbol of the token

    +

    symbol

    symbol: string

    The symbol of the token

    Memberof

    TokenContractOptions

    -

    total_supply

    total_supply: string

    The total supply of the token denominated in the whole amount of the token.

    +

    total_supply

    total_supply: string

    The total supply of the token denominated in the whole amount of the token.

    Memberof

    TokenContractOptions

    -

    Settings

    Member Visibility

    Theme

    On This Page

    namesymboltotal_supply
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    namesymboltotal_supply
    \ No newline at end of file diff --git a/docs/interfaces/client_api.Trade.html b/docs/interfaces/client_api.Trade.html index 310088d1..010e1a86 100644 --- a/docs/interfaces/client_api.Trade.html +++ b/docs/interfaces/client_api.Trade.html @@ -1,6 +1,6 @@ Trade | @coinbase/coinbase-sdk

    Interface Trade

    A trade of an asset to another asset

    Export

    Trade

    -
    interface Trade {
        address_id: string;
        approve_transaction?: Transaction;
        from_amount: string;
        from_asset: Asset;
        network_id: string;
        to_amount: string;
        to_asset: Asset;
        trade_id: string;
        transaction: Transaction;
        wallet_id: string;
    }

    Properties

    address_id +
    interface Trade {
        address_id: string;
        approve_transaction?: Transaction;
        from_amount: string;
        from_asset: Asset;
        network_id: string;
        to_amount: string;
        to_asset: Asset;
        trade_id: string;
        transaction: Transaction;
        wallet_id: string;
    }

    Properties

    address_id approve_transaction? from_amount from_asset @@ -12,18 +12,18 @@ wallet_id

    Properties

    address_id

    address_id: string

    The onchain address of the sender

    Memberof

    Trade

    -

    Optional approve_transaction

    approve_transaction?: Transaction

    Memberof

    Trade

    -

    from_amount

    from_amount: string

    The amount of the from asset to be traded (in atomic units of the from asset)

    +

    Optional approve_transaction

    approve_transaction?: Transaction

    Memberof

    Trade

    +

    from_amount

    from_amount: string

    The amount of the from asset to be traded (in atomic units of the from asset)

    Memberof

    Trade

    -

    from_asset

    from_asset: Asset

    Memberof

    Trade

    -

    network_id

    network_id: string

    The ID of the blockchain network

    +

    from_asset

    from_asset: Asset

    Memberof

    Trade

    +

    network_id

    network_id: string

    The ID of the blockchain network

    Memberof

    Trade

    -

    to_amount

    to_amount: string

    The amount of the to asset that will be received (in atomic units of the to asset)

    +

    to_amount

    to_amount: string

    The amount of the to asset that will be received (in atomic units of the to asset)

    Memberof

    Trade

    -

    to_asset

    to_asset: Asset

    Memberof

    Trade

    -

    trade_id

    trade_id: string

    The ID of the trade

    +

    to_asset

    to_asset: Asset

    Memberof

    Trade

    +

    trade_id

    trade_id: string

    The ID of the trade

    Memberof

    Trade

    -

    transaction

    transaction: Transaction

    Memberof

    Trade

    -

    wallet_id

    wallet_id: string

    The ID of the wallet that owns the from address

    +

    transaction

    transaction: Transaction

    Memberof

    Trade

    +

    wallet_id

    wallet_id: string

    The ID of the wallet that owns the from address

    Memberof

    Trade

    -

    Settings

    Member Visibility

    Theme

    On This Page

    address_idapprove_transactionfrom_amountfrom_assetnetwork_idto_amountto_assettrade_idtransactionwallet_id
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    address_idapprove_transactionfrom_amountfrom_assetnetwork_idto_amountto_assettrade_idtransactionwallet_id
    \ No newline at end of file diff --git a/docs/interfaces/client_api.TradeList.html b/docs/interfaces/client_api.TradeList.html index c0640bba..8fbb5fc0 100644 --- a/docs/interfaces/client_api.TradeList.html +++ b/docs/interfaces/client_api.TradeList.html @@ -1,13 +1,13 @@ TradeList | @coinbase/coinbase-sdk

    Interface TradeList

    Export

    TradeList

    -
    interface TradeList {
        data: Trade[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data +
    interface TradeList {
        data: Trade[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data has_more next_page total_count

    Properties

    data

    data: Trade[]

    Memberof

    TradeList

    -

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    TradeList

    -

    next_page

    next_page: string

    The page token to be used to fetch the next page.

    +

    next_page

    next_page: string

    The page token to be used to fetch the next page.

    Memberof

    TradeList

    -

    total_count

    total_count: number

    The total number of trades for the address in the wallet.

    +

    total_count

    total_count: number

    The total number of trades for the address in the wallet.

    Memberof

    TradeList

    -

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_pagetotal_count
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_pagetotal_count
    \ No newline at end of file diff --git a/docs/interfaces/client_api.TradesApiInterface.html b/docs/interfaces/client_api.TradesApiInterface.html index 12d7a4a7..2db67ce9 100644 --- a/docs/interfaces/client_api.TradesApiInterface.html +++ b/docs/interfaces/client_api.TradesApiInterface.html @@ -1,6 +1,6 @@ TradesApiInterface | @coinbase/coinbase-sdk

    Interface TradesApiInterface

    TradesApi - interface

    Export

    TradesApi

    -
    interface TradesApiInterface {
        broadcastTrade(walletId, addressId, tradeId, broadcastTradeRequest, options?): AxiosPromise<Trade>;
        createTrade(walletId, addressId, createTradeRequest, options?): AxiosPromise<Trade>;
        getTrade(walletId, addressId, tradeId, options?): AxiosPromise<Trade>;
        listTrades(walletId, addressId, limit?, page?, options?): AxiosPromise<TradeList>;
    }

    Implemented by

    Methods

    broadcastTrade +
    interface TradesApiInterface {
        broadcastTrade(walletId, addressId, tradeId, broadcastTradeRequest, options?): AxiosPromise<Trade>;
        createTrade(walletId, addressId, createTradeRequest, options?): AxiosPromise<Trade>;
        getTrade(walletId, addressId, tradeId, options?): AxiosPromise<Trade>;
        listTrades(walletId, addressId, limit?, page?, options?): AxiosPromise<TradeList>;
    }

    Implemented by

    Methods

    broadcastTrade createTrade getTrade listTrades @@ -11,20 +11,20 @@
  • broadcastTradeRequest: BroadcastTradeRequest
  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns AxiosPromise<Trade>

    Summary

    Broadcast a trade

    Throws

    Memberof

    TradesApiInterface

    -

    createTrade

    • createTrade(walletId, addressId, createTradeRequest, options?): AxiosPromise<Trade>

    • Create a new trade

      +

    createTrade

    • createTrade(walletId, addressId, createTradeRequest, options?): AxiosPromise<Trade>

    • Create a new trade

      Parameters

      • walletId: string

        The ID of the wallet the source address belongs to

      • addressId: string

        The ID of the address to conduct the trade from

      • createTradeRequest: CreateTradeRequest
      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<Trade>

      Summary

      Create a new trade for an address

      Throws

      Memberof

      TradesApiInterface

      -

    getTrade

    getTrade

    • getTrade(walletId, addressId, tradeId, options?): AxiosPromise<Trade>

    • Get a trade by ID

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to

      • addressId: string

        The ID of the address the trade belongs to

      • tradeId: string

        The ID of the trade to fetch

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<Trade>

      Summary

      Get a trade by ID

      Throws

      Memberof

      TradesApiInterface

      -

    listTrades

    listTrades

    • listTrades(walletId, addressId, limit?, page?, options?): AxiosPromise<TradeList>

    • List trades for an address.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to

      • addressId: string

        The ID of the address to list trades for

      • Optional limit: number

        A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

        @@ -32,4 +32,4 @@

        Throws

        Memberof

        TradesApiInterface

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<TradeList>

      Summary

      List trades for an address.

      Throws

      Memberof

      TradesApiInterface

      -

    Settings

    Member Visibility

    Theme

    On This Page

    broadcastTradecreateTradegetTradelistTrades
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    broadcastTradecreateTradegetTradelistTrades
    \ No newline at end of file diff --git a/docs/interfaces/client_api.Transaction.html b/docs/interfaces/client_api.Transaction.html index 52fea512..4d713145 100644 --- a/docs/interfaces/client_api.Transaction.html +++ b/docs/interfaces/client_api.Transaction.html @@ -1,6 +1,6 @@ Transaction | @coinbase/coinbase-sdk

    Interface Transaction

    An onchain transaction.

    Export

    Transaction

    -
    interface Transaction {
        block_hash?: string;
        block_height?: string;
        content?: EthereumTransaction;
        from_address_id: string;
        network_id: string;
        signed_payload?: string;
        status: TransactionStatusEnum;
        to_address_id?: string;
        transaction_hash?: string;
        transaction_link?: string;
        unsigned_payload: string;
    }

    Properties

    block_hash? +
    interface Transaction {
        block_hash?: string;
        block_height?: string;
        content?: EthereumTransaction;
        from_address_id: string;
        network_id: string;
        signed_payload?: string;
        status: TransactionStatusEnum;
        to_address_id?: string;
        transaction_hash?: string;
        transaction_link?: string;
        unsigned_payload: string;
    }

    Properties

    block_hash? block_height? content? from_address_id @@ -13,23 +13,23 @@ unsigned_payload

    Properties

    Optional block_hash

    block_hash?: string

    The hash of the block at which the transaction was recorded.

    Memberof

    Transaction

    -

    Optional block_height

    block_height?: string

    The block height at which the transaction was recorded.

    +

    Optional block_height

    block_height?: string

    The block height at which the transaction was recorded.

    Memberof

    Transaction

    -

    Optional content

    content?: EthereumTransaction

    Memberof

    Transaction

    -

    from_address_id

    from_address_id: string

    The onchain address of the sender.

    +

    Optional content

    content?: EthereumTransaction

    Memberof

    Transaction

    +

    from_address_id

    from_address_id: string

    The onchain address of the sender.

    Memberof

    Transaction

    -

    network_id

    network_id: string

    The ID of the blockchain network.

    +

    network_id

    network_id: string

    The ID of the blockchain network.

    Memberof

    Transaction

    -

    Optional signed_payload

    signed_payload?: string

    The signed payload of the transaction. This is the payload that has been signed by the sender.

    +

    Optional signed_payload

    signed_payload?: string

    The signed payload of the transaction. This is the payload that has been signed by the sender.

    Memberof

    Transaction

    -

    status

    status: TransactionStatusEnum

    The status of the transaction.

    +

    status

    status: TransactionStatusEnum

    The status of the transaction.

    Memberof

    Transaction

    -

    Optional to_address_id

    to_address_id?: string

    The onchain address of the recipient.

    +

    Optional to_address_id

    to_address_id?: string

    The onchain address of the recipient.

    Memberof

    Transaction

    -

    Optional transaction_hash

    transaction_hash?: string

    The hash of the transaction.

    +

    Optional transaction_hash

    transaction_hash?: string

    The hash of the transaction.

    Memberof

    Transaction

    -

    Optional transaction_link

    transaction_link?: string

    The link to view the transaction on a block explorer. This is optional and may not be present for all transactions.

    +

    Optional transaction_link

    transaction_link?: string

    The link to view the transaction on a block explorer. This is optional and may not be present for all transactions.

    Memberof

    Transaction

    -

    unsigned_payload

    unsigned_payload: string

    The unsigned payload of the transaction. This is the payload that needs to be signed by the sender.

    +

    unsigned_payload

    unsigned_payload: string

    The unsigned payload of the transaction. This is the payload that needs to be signed by the sender.

    Memberof

    Transaction

    -

    Settings

    Member Visibility

    Theme

    On This Page

    block_hashblock_heightcontentfrom_address_idnetwork_idsigned_payloadstatusto_address_idtransaction_hashtransaction_linkunsigned_payload
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    block_hashblock_heightcontentfrom_address_idnetwork_idsigned_payloadstatusto_address_idtransaction_hashtransaction_linkunsigned_payload
    \ No newline at end of file diff --git a/docs/interfaces/client_api.TransactionHistoryApiInterface.html b/docs/interfaces/client_api.TransactionHistoryApiInterface.html index 655d236a..8578758f 100644 --- a/docs/interfaces/client_api.TransactionHistoryApiInterface.html +++ b/docs/interfaces/client_api.TransactionHistoryApiInterface.html @@ -1,6 +1,6 @@ TransactionHistoryApiInterface | @coinbase/coinbase-sdk

    Interface TransactionHistoryApiInterface

    TransactionHistoryApi - interface

    Export

    TransactionHistoryApi

    -
    interface TransactionHistoryApiInterface {
        listAddressTransactions(networkId, addressId, limit?, page?, options?): AxiosPromise<AddressTransactionList>;
    }

    Implemented by

    Methods

    listAddressTransactions +
    interface TransactionHistoryApiInterface {
        listAddressTransactions(networkId, addressId, limit?, page?, options?): AxiosPromise<AddressTransactionList>;
    }

    Implemented by

    Methods

    listAddressTransactions

    Methods

    listAddressTransactions

    • listAddressTransactions(networkId, addressId, limit?, page?, options?): AxiosPromise<AddressTransactionList>

    • List all transactions that interact with the address.

      Parameters

      • networkId: string

        The ID of the blockchain network

      • addressId: string

        The ID of the address to fetch the transactions for.

        @@ -9,4 +9,4 @@
      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<AddressTransactionList>

      Summary

      List transactions for an address.

      Throws

      Memberof

      TransactionHistoryApiInterface

      -

    Settings

    Member Visibility

    Theme

    On This Page

    listAddressTransactions
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    listAddressTransactions
    \ No newline at end of file diff --git a/docs/interfaces/client_api.Transfer.html b/docs/interfaces/client_api.Transfer.html index c3339a0b..b758bced 100644 --- a/docs/interfaces/client_api.Transfer.html +++ b/docs/interfaces/client_api.Transfer.html @@ -1,6 +1,6 @@ Transfer | @coinbase/coinbase-sdk

    Interface Transfer

    A transfer of an asset from one address to another

    Export

    Transfer

    -
    interface Transfer {
        address_id: string;
        amount: string;
        asset: Asset;
        asset_id: string;
        destination: string;
        gasless: boolean;
        network_id: string;
        signed_payload?: string;
        sponsored_send?: SponsoredSend;
        status?: TransferStatusEnum;
        transaction?: Transaction;
        transaction_hash?: string;
        transfer_id: string;
        unsigned_payload?: string;
        wallet_id: string;
    }

    Properties

    address_id +
    interface Transfer {
        address_id: string;
        amount: string;
        asset: Asset;
        asset_id: string;
        destination: string;
        gasless: boolean;
        network_id: string;
        signed_payload?: string;
        sponsored_send?: SponsoredSend;
        status?: TransferStatusEnum;
        transaction?: Transaction;
        transaction_hash?: string;
        transfer_id: string;
        unsigned_payload?: string;
        wallet_id: string;
    }

    Properties

    address_id amount asset asset_id @@ -17,29 +17,29 @@ wallet_id

    Properties

    address_id

    address_id: string

    The onchain address of the sender

    Memberof

    Transfer

    -

    amount

    amount: string

    The amount in the atomic units of the asset

    +

    amount

    amount: string

    The amount in the atomic units of the asset

    Memberof

    Transfer

    -

    asset

    asset: Asset

    Memberof

    Transfer

    -

    asset_id

    asset_id: string

    The ID of the asset being transferred

    +

    asset

    asset: Asset

    Memberof

    Transfer

    +

    asset_id

    asset_id: string

    The ID of the asset being transferred

    Memberof

    Transfer

    -

    destination

    destination: string

    The onchain address of the recipient

    +

    destination

    destination: string

    The onchain address of the recipient

    Memberof

    Transfer

    -

    gasless

    gasless: boolean

    Whether the transfer uses sponsored gas

    +

    gasless

    gasless: boolean

    Whether the transfer uses sponsored gas

    Memberof

    Transfer

    -

    network_id

    network_id: string

    The ID of the blockchain network

    +

    network_id

    network_id: string

    The ID of the blockchain network

    Memberof

    Transfer

    -

    Optional signed_payload

    signed_payload?: string

    The signed payload of the transfer. This is the payload that has been signed by the sender.

    +

    Optional signed_payload

    signed_payload?: string

    The signed payload of the transfer. This is the payload that has been signed by the sender.

    Memberof

    Transfer

    -

    Optional sponsored_send

    sponsored_send?: SponsoredSend

    Memberof

    Transfer

    -

    Optional status

    status?: TransferStatusEnum

    The status of the transfer

    +

    Optional sponsored_send

    sponsored_send?: SponsoredSend

    Memberof

    Transfer

    +

    Optional status

    status?: TransferStatusEnum

    The status of the transfer

    Memberof

    Transfer

    -

    Optional transaction

    transaction?: Transaction

    Memberof

    Transfer

    -

    Optional transaction_hash

    transaction_hash?: string

    The hash of the transfer transaction

    +

    Optional transaction

    transaction?: Transaction

    Memberof

    Transfer

    +

    Optional transaction_hash

    transaction_hash?: string

    The hash of the transfer transaction

    Memberof

    Transfer

    -

    transfer_id

    transfer_id: string

    The ID of the transfer

    +

    transfer_id

    transfer_id: string

    The ID of the transfer

    Memberof

    Transfer

    -

    Optional unsigned_payload

    unsigned_payload?: string

    The unsigned payload of the transfer. This is the payload that needs to be signed by the sender.

    +

    Optional unsigned_payload

    unsigned_payload?: string

    The unsigned payload of the transfer. This is the payload that needs to be signed by the sender.

    Memberof

    Transfer

    -

    wallet_id

    wallet_id: string

    The ID of the wallet that owns the from address

    +

    wallet_id

    wallet_id: string

    The ID of the wallet that owns the from address

    Memberof

    Transfer

    -

    Settings

    Member Visibility

    Theme

    On This Page

    address_idamountassetasset_iddestinationgaslessnetwork_idsigned_payloadsponsored_sendstatustransactiontransaction_hashtransfer_idunsigned_payloadwallet_id
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    address_idamountassetasset_iddestinationgaslessnetwork_idsigned_payloadsponsored_sendstatustransactiontransaction_hashtransfer_idunsigned_payloadwallet_id
    \ No newline at end of file diff --git a/docs/interfaces/client_api.TransferList.html b/docs/interfaces/client_api.TransferList.html index fca48e71..9e448a7f 100644 --- a/docs/interfaces/client_api.TransferList.html +++ b/docs/interfaces/client_api.TransferList.html @@ -1,13 +1,13 @@ TransferList | @coinbase/coinbase-sdk

    Interface TransferList

    Export

    TransferList

    -
    interface TransferList {
        data: Transfer[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data +
    interface TransferList {
        data: Transfer[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data has_more next_page total_count

    Properties

    data

    data: Transfer[]

    Memberof

    TransferList

    -

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    TransferList

    -

    next_page

    next_page: string

    The page token to be used to fetch the next page.

    +

    next_page

    next_page: string

    The page token to be used to fetch the next page.

    Memberof

    TransferList

    -

    total_count

    total_count: number

    The total number of transfers for the address in the wallet.

    +

    total_count

    total_count: number

    The total number of transfers for the address in the wallet.

    Memberof

    TransferList

    -

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_pagetotal_count
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_pagetotal_count
    \ No newline at end of file diff --git a/docs/interfaces/client_api.TransfersApiInterface.html b/docs/interfaces/client_api.TransfersApiInterface.html index 063442aa..1d23229e 100644 --- a/docs/interfaces/client_api.TransfersApiInterface.html +++ b/docs/interfaces/client_api.TransfersApiInterface.html @@ -1,6 +1,6 @@ TransfersApiInterface | @coinbase/coinbase-sdk

    Interface TransfersApiInterface

    TransfersApi - interface

    Export

    TransfersApi

    -
    interface TransfersApiInterface {
        broadcastTransfer(walletId, addressId, transferId, broadcastTransferRequest, options?): AxiosPromise<Transfer>;
        createTransfer(walletId, addressId, createTransferRequest, options?): AxiosPromise<Transfer>;
        getTransfer(walletId, addressId, transferId, options?): AxiosPromise<Transfer>;
        listTransfers(walletId, addressId, limit?, page?, options?): AxiosPromise<TransferList>;
    }

    Implemented by

    Methods

    broadcastTransfer +
    interface TransfersApiInterface {
        broadcastTransfer(walletId, addressId, transferId, broadcastTransferRequest, options?): AxiosPromise<Transfer>;
        createTransfer(walletId, addressId, createTransferRequest, options?): AxiosPromise<Transfer>;
        getTransfer(walletId, addressId, transferId, options?): AxiosPromise<Transfer>;
        listTransfers(walletId, addressId, limit?, page?, options?): AxiosPromise<TransferList>;
    }

    Implemented by

    Methods

    broadcastTransfer createTransfer getTransfer listTransfers @@ -11,20 +11,20 @@
  • broadcastTransferRequest: BroadcastTransferRequest
  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns AxiosPromise<Transfer>

    Summary

    Broadcast a transfer

    Throws

    Memberof

    TransfersApiInterface

    -

    createTransfer

    createTransfer

    • createTransfer(walletId, addressId, createTransferRequest, options?): AxiosPromise<Transfer>

    • Create a new transfer

      Parameters

      • walletId: string

        The ID of the wallet the source address belongs to

      • addressId: string

        The ID of the address to transfer from

      • createTransferRequest: CreateTransferRequest
      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<Transfer>

      Summary

      Create a new transfer for an address

      Throws

      Memberof

      TransfersApiInterface

      -

    getTransfer

    getTransfer

    • getTransfer(walletId, addressId, transferId, options?): AxiosPromise<Transfer>

    • Get a transfer by ID

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to

      • addressId: string

        The ID of the address the transfer belongs to

      • transferId: string

        The ID of the transfer to fetch

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<Transfer>

      Summary

      Get a transfer by ID

      Throws

      Memberof

      TransfersApiInterface

      -

    listTransfers

    listTransfers

    • listTransfers(walletId, addressId, limit?, page?, options?): AxiosPromise<TransferList>

    • List transfers for an address.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to

      • addressId: string

        The ID of the address to list transfers for

      • Optional limit: number

        A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

        @@ -32,4 +32,4 @@

        Throws

        Memberof

        TransfersApiInterface

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<TransferList>

      Summary

      List transfers for an address.

      Throws

      Memberof

      TransfersApiInterface

      -

    Settings

    Member Visibility

    Theme

    On This Page

    broadcastTransfercreateTransfergetTransferlistTransfers
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    broadcastTransfercreateTransfergetTransferlistTransfers
    \ No newline at end of file diff --git a/docs/interfaces/client_api.UpdateWebhookRequest.html b/docs/interfaces/client_api.UpdateWebhookRequest.html index 7892d11d..2eb6a0ff 100644 --- a/docs/interfaces/client_api.UpdateWebhookRequest.html +++ b/docs/interfaces/client_api.UpdateWebhookRequest.html @@ -1,10 +1,10 @@ UpdateWebhookRequest | @coinbase/coinbase-sdk

    Interface UpdateWebhookRequest

    Export

    UpdateWebhookRequest

    -
    interface UpdateWebhookRequest {
        event_filters?: WebhookEventFilter[];
        event_type_filter?: WebhookWalletActivityFilter;
        notification_uri?: string;
    }

    Properties

    event_filters? +
    interface UpdateWebhookRequest {
        event_filters?: WebhookEventFilter[];
        event_type_filter?: WebhookWalletActivityFilter;
        notification_uri?: string;
    }

    Properties

    event_filters? event_type_filter? notification_uri?

    Properties

    Optional event_filters

    event_filters?: WebhookEventFilter[]

    Webhook will monitor all events that matches any one of the event filters.

    Memberof

    UpdateWebhookRequest

    -

    Optional event_type_filter

    event_type_filter?: WebhookWalletActivityFilter

    Memberof

    UpdateWebhookRequest

    -

    Optional notification_uri

    notification_uri?: string

    The Webhook uri that updates to

    +

    Optional event_type_filter

    event_type_filter?: WebhookWalletActivityFilter

    Memberof

    UpdateWebhookRequest

    +

    Optional notification_uri

    notification_uri?: string

    The Webhook uri that updates to

    Memberof

    UpdateWebhookRequest

    -

    Settings

    Member Visibility

    Theme

    On This Page

    event_filtersevent_type_filternotification_uri
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    event_filtersevent_type_filternotification_uri
    \ No newline at end of file diff --git a/docs/interfaces/client_api.User.html b/docs/interfaces/client_api.User.html index 678db60f..f1ae9649 100644 --- a/docs/interfaces/client_api.User.html +++ b/docs/interfaces/client_api.User.html @@ -1,7 +1,7 @@ User | @coinbase/coinbase-sdk

    Interface User

    Export

    User

    -
    interface User {
        display_name?: string;
        id: string;
    }

    Properties

    display_name? +
    interface User {
        display_name?: string;
        id: string;
    }

    Properties

    display_name? id

    Properties

    Optional display_name

    display_name?: string

    Memberof

    User

    -

    id

    id: string

    The ID of the user

    +

    id

    id: string

    The ID of the user

    Memberof

    User

    -

    Settings

    Member Visibility

    Theme

    On This Page

    display_nameid
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    display_nameid
    \ No newline at end of file diff --git a/docs/interfaces/client_api.UsersApiInterface.html b/docs/interfaces/client_api.UsersApiInterface.html index 65b21b62..a9fdb6ca 100644 --- a/docs/interfaces/client_api.UsersApiInterface.html +++ b/docs/interfaces/client_api.UsersApiInterface.html @@ -1,8 +1,8 @@ UsersApiInterface | @coinbase/coinbase-sdk

    Interface UsersApiInterface

    UsersApi - interface

    Export

    UsersApi

    -
    interface UsersApiInterface {
        getCurrentUser(options?): AxiosPromise<User>;
    }

    Implemented by

    Methods

    getCurrentUser +
    interface UsersApiInterface {
        getCurrentUser(options?): AxiosPromise<User>;
    }

    Implemented by

    Methods

    getCurrentUser

    Methods

    getCurrentUser

    • getCurrentUser(options?): AxiosPromise<User>

    • Get current user

      Parameters

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<User>

      Summary

      Get current user

      Throws

      Memberof

      UsersApiInterface

      -

    Settings

    Member Visibility

    Theme

    On This Page

    getCurrentUser
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    getCurrentUser
    \ No newline at end of file diff --git a/docs/interfaces/client_api.Validator.html b/docs/interfaces/client_api.Validator.html index 65e3f52f..074e7d0c 100644 --- a/docs/interfaces/client_api.Validator.html +++ b/docs/interfaces/client_api.Validator.html @@ -1,16 +1,16 @@ Validator | @coinbase/coinbase-sdk

    Interface Validator

    A validator onchain.

    Export

    Validator

    -
    interface Validator {
        asset_id: string;
        details?: EthereumValidatorMetadata;
        network_id: string;
        status: ValidatorStatus;
        validator_id: string;
    }

    Properties

    asset_id +
    interface Validator {
        asset_id: string;
        details?: EthereumValidatorMetadata;
        network_id: string;
        status: ValidatorStatus;
        validator_id: string;
    }

    Properties

    asset_id details? network_id status validator_id

    Properties

    asset_id

    asset_id: string

    The ID of the asset that the validator helps stake.

    Memberof

    Validator

    -

    Optional details

    details?: EthereumValidatorMetadata

    Memberof

    Validator

    -

    network_id

    network_id: string

    The ID of the blockchain network to which the Validator belongs.

    +

    Optional details

    details?: EthereumValidatorMetadata

    Memberof

    Validator

    +

    network_id

    network_id: string

    The ID of the blockchain network to which the Validator belongs.

    Memberof

    Validator

    -

    status

    status: ValidatorStatus

    Memberof

    Validator

    -

    validator_id

    validator_id: string

    The publicly identifiable unique id of the validator. This can be the public key for Ethereum validators and maybe an address for some other network.

    +

    status

    status: ValidatorStatus

    Memberof

    Validator

    +

    validator_id

    validator_id: string

    The publicly identifiable unique id of the validator. This can be the public key for Ethereum validators and maybe an address for some other network.

    Memberof

    Validator

    -

    Settings

    Member Visibility

    Theme

    On This Page

    asset_iddetailsnetwork_idstatusvalidator_id
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    asset_iddetailsnetwork_idstatusvalidator_id
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ValidatorList.html b/docs/interfaces/client_api.ValidatorList.html index 5ae68d13..6692ad86 100644 --- a/docs/interfaces/client_api.ValidatorList.html +++ b/docs/interfaces/client_api.ValidatorList.html @@ -1,10 +1,10 @@ ValidatorList | @coinbase/coinbase-sdk

    Interface ValidatorList

    Export

    ValidatorList

    -
    interface ValidatorList {
        data: Validator[];
        has_more: boolean;
        next_page: string;
    }

    Properties

    data +
    interface ValidatorList {
        data: Validator[];
        has_more: boolean;
        next_page: string;
    }

    Properties

    data has_more next_page

    Properties

    data

    data: Validator[]

    Memberof

    ValidatorList

    -

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    ValidatorList

    -

    next_page

    next_page: string

    The page token to be used to fetch the next page.

    +

    next_page

    next_page: string

    The page token to be used to fetch the next page.

    Memberof

    ValidatorList

    -

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_page
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_page
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ValidatorsApiInterface.html b/docs/interfaces/client_api.ValidatorsApiInterface.html index f3690bac..0e75d8e3 100644 --- a/docs/interfaces/client_api.ValidatorsApiInterface.html +++ b/docs/interfaces/client_api.ValidatorsApiInterface.html @@ -1,6 +1,6 @@ ValidatorsApiInterface | @coinbase/coinbase-sdk

    Interface ValidatorsApiInterface

    ValidatorsApi - interface

    Export

    ValidatorsApi

    -
    interface ValidatorsApiInterface {
        getValidator(networkId, assetId, validatorId, options?): AxiosPromise<Validator>;
        listValidators(networkId, assetId, status?, limit?, page?, options?): AxiosPromise<ValidatorList>;
    }

    Implemented by

    Methods

    getValidator +
    interface ValidatorsApiInterface {
        getValidator(networkId, assetId, validatorId, options?): AxiosPromise<Validator>;
        listValidators(networkId, assetId, status?, limit?, page?, options?): AxiosPromise<ValidatorList>;
    }

    Implemented by

    Methods

    getValidator listValidators

    Methods

    getValidator

    • getValidator(networkId, assetId, validatorId, options?): AxiosPromise<Validator>

    • Get a validator belonging to the user for a given network, asset and id.

      Parameters

      • networkId: string

        The ID of the blockchain network.

        @@ -9,7 +9,7 @@
      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<Validator>

      Summary

      Get a validator belonging to the CDP project

      Throws

      Memberof

      ValidatorsApiInterface

      -

    listValidators

    • listValidators(networkId, assetId, status?, limit?, page?, options?): AxiosPromise<ValidatorList>

    • List validators belonging to the user for a given network and asset.

      +

    listValidators

    • listValidators(networkId, assetId, status?, limit?, page?, options?): AxiosPromise<ValidatorList>

    • List validators belonging to the user for a given network and asset.

      Parameters

      • networkId: string

        The ID of the blockchain network.

      • assetId: string

        The symbol of the asset to get the validators for.

      • Optional status: ValidatorStatus

        A filter to list validators based on a status.

        @@ -18,4 +18,4 @@

        Throws

        Memberof

        ValidatorsApiInterface

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<ValidatorList>

      Summary

      List validators belonging to the CDP project

      Throws

      Memberof

      ValidatorsApiInterface

      -

    Settings

    Member Visibility

    Theme

    On This Page

    getValidatorlistValidators
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    getValidatorlistValidators
    \ No newline at end of file diff --git a/docs/interfaces/client_api.Wallet.html b/docs/interfaces/client_api.Wallet.html index 0af2e6d2..b49b6399 100644 --- a/docs/interfaces/client_api.Wallet.html +++ b/docs/interfaces/client_api.Wallet.html @@ -1,15 +1,15 @@ Wallet | @coinbase/coinbase-sdk

    Interface Wallet

    Export

    Wallet

    -
    interface Wallet {
        default_address?: Address;
        feature_set: FeatureSet;
        id: string;
        network_id: string;
        server_signer_status?: WalletServerSignerStatusEnum;
    }

    Properties

    default_address? +
    interface Wallet {
        default_address?: Address;
        feature_set: FeatureSet;
        id: string;
        network_id: string;
        server_signer_status?: WalletServerSignerStatusEnum;
    }

    Properties

    default_address? feature_set id network_id server_signer_status?

    Properties

    Optional default_address

    default_address?: Address

    Memberof

    Wallet

    -

    feature_set

    feature_set: FeatureSet

    Memberof

    Wallet

    -

    id

    id: string

    The server-assigned ID for the wallet.

    +

    feature_set

    feature_set: FeatureSet

    Memberof

    Wallet

    +

    id

    id: string

    The server-assigned ID for the wallet.

    Memberof

    Wallet

    -

    network_id

    network_id: string

    The ID of the blockchain network

    +

    network_id

    network_id: string

    The ID of the blockchain network

    Memberof

    Wallet

    -

    Optional server_signer_status

    server_signer_status?: WalletServerSignerStatusEnum

    The status of the Server-Signer for the wallet if present.

    +

    Optional server_signer_status

    server_signer_status?: WalletServerSignerStatusEnum

    The status of the Server-Signer for the wallet if present.

    Memberof

    Wallet

    -

    Settings

    Member Visibility

    Theme

    On This Page

    default_addressfeature_setidnetwork_idserver_signer_status
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    default_addressfeature_setidnetwork_idserver_signer_status
    \ No newline at end of file diff --git a/docs/interfaces/client_api.WalletList.html b/docs/interfaces/client_api.WalletList.html index a8605cb6..93d317cf 100644 --- a/docs/interfaces/client_api.WalletList.html +++ b/docs/interfaces/client_api.WalletList.html @@ -1,14 +1,14 @@ WalletList | @coinbase/coinbase-sdk

    Interface WalletList

    Paginated list of wallets

    Export

    WalletList

    -
    interface WalletList {
        data: Wallet[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data +
    interface WalletList {
        data: Wallet[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data has_more next_page total_count

    Properties

    data

    data: Wallet[]

    Memberof

    WalletList

    -

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +

    has_more

    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    WalletList

    -

    next_page

    next_page: string

    The page token to be used to fetch the next page.

    +

    next_page

    next_page: string

    The page token to be used to fetch the next page.

    Memberof

    WalletList

    -

    total_count

    total_count: number

    The total number of wallets

    +

    total_count

    total_count: number

    The total number of wallets

    Memberof

    WalletList

    -

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_pagetotal_count
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_pagetotal_count
    \ No newline at end of file diff --git a/docs/interfaces/client_api.WalletStakeApiInterface.html b/docs/interfaces/client_api.WalletStakeApiInterface.html index 695772c7..74cbb73d 100644 --- a/docs/interfaces/client_api.WalletStakeApiInterface.html +++ b/docs/interfaces/client_api.WalletStakeApiInterface.html @@ -1,6 +1,6 @@ WalletStakeApiInterface | @coinbase/coinbase-sdk

    Interface WalletStakeApiInterface

    WalletStakeApi - interface

    Export

    WalletStakeApi

    -
    interface WalletStakeApiInterface {
        broadcastStakingOperation(walletId, addressId, stakingOperationId, broadcastStakingOperationRequest, options?): AxiosPromise<StakingOperation>;
        createStakingOperation(walletId, addressId, createStakingOperationRequest, options?): AxiosPromise<StakingOperation>;
        getStakingOperation(walletId, addressId, stakingOperationId, options?): AxiosPromise<StakingOperation>;
    }

    Implemented by

    Methods

    broadcastStakingOperation +
    interface WalletStakeApiInterface {
        broadcastStakingOperation(walletId, addressId, stakingOperationId, broadcastStakingOperationRequest, options?): AxiosPromise<StakingOperation>;
        createStakingOperation(walletId, addressId, createStakingOperationRequest, options?): AxiosPromise<StakingOperation>;
        getStakingOperation(walletId, addressId, stakingOperationId, options?): AxiosPromise<StakingOperation>;
    }

    Implemented by

    Methods

    broadcastStakingOperation createStakingOperation getStakingOperation

    Methods

    broadcastStakingOperation

    • broadcastStakingOperation(walletId, addressId, stakingOperationId, broadcastStakingOperationRequest, options?): AxiosPromise<StakingOperation>

    • Broadcast a staking operation.

      @@ -10,17 +10,17 @@
    • broadcastStakingOperationRequest: BroadcastStakingOperationRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<StakingOperation>

    Summary

    Broadcast a staking operation

    Throws

    Memberof

    WalletStakeApiInterface

    -

    createStakingOperation

    createStakingOperation

    • createStakingOperation(walletId, addressId, createStakingOperationRequest, options?): AxiosPromise<StakingOperation>

    • Create a new staking operation.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The ID of the address to create the staking operation for.

      • createStakingOperationRequest: CreateStakingOperationRequest
      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<StakingOperation>

      Summary

      Create a new staking operation for an address

      Throws

      Memberof

      WalletStakeApiInterface

      -

    getStakingOperation

    getStakingOperation

    • getStakingOperation(walletId, addressId, stakingOperationId, options?): AxiosPromise<StakingOperation>

    • Get the latest state of a staking operation.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to

      • addressId: string

        The ID of the address to fetch the staking operation for.

      • stakingOperationId: string

        The ID of the staking operation.

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<StakingOperation>

      Summary

      Get the latest state of a staking operation

      Throws

      Memberof

      WalletStakeApiInterface

      -

    Settings

    Member Visibility

    Theme

    On This Page

    broadcastStakingOperationcreateStakingOperationgetStakingOperation
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    broadcastStakingOperationcreateStakingOperationgetStakingOperation
    \ No newline at end of file diff --git a/docs/interfaces/client_api.WalletsApiInterface.html b/docs/interfaces/client_api.WalletsApiInterface.html index d3cfb871..3155be98 100644 --- a/docs/interfaces/client_api.WalletsApiInterface.html +++ b/docs/interfaces/client_api.WalletsApiInterface.html @@ -1,6 +1,6 @@ WalletsApiInterface | @coinbase/coinbase-sdk

    Interface WalletsApiInterface

    WalletsApi - interface

    Export

    WalletsApi

    -
    interface WalletsApiInterface {
        createWallet(createWalletRequest?, options?): AxiosPromise<Wallet>;
        getWallet(walletId, options?): AxiosPromise<Wallet>;
        getWalletBalance(walletId, assetId, options?): AxiosPromise<Balance>;
        listWalletBalances(walletId, options?): AxiosPromise<AddressBalanceList>;
        listWallets(limit?, page?, options?): AxiosPromise<WalletList>;
    }

    Implemented by

    Methods

    createWallet +
    interface WalletsApiInterface {
        createWallet(createWalletRequest?, options?): AxiosPromise<Wallet>;
        getWallet(walletId, options?): AxiosPromise<Wallet>;
        getWalletBalance(walletId, assetId, options?): AxiosPromise<Balance>;
        listWalletBalances(walletId, options?): AxiosPromise<AddressBalanceList>;
        listWallets(limit?, page?, options?): AxiosPromise<WalletList>;
    }

    Implemented by

    Methods

    createWallet getWallet getWalletBalance listWalletBalances @@ -9,26 +9,26 @@

    Parameters

    • Optional createWalletRequest: CreateWalletRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<Wallet>

    Summary

    Create a new wallet

    Throws

    Memberof

    WalletsApiInterface

    -

    getWallet

    getWallet

    • getWallet(walletId, options?): AxiosPromise<Wallet>

    • Get wallet

      Parameters

      • walletId: string

        The ID of the wallet to fetch

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<Wallet>

      Summary

      Get wallet by ID

      Throws

      Memberof

      WalletsApiInterface

      -

    getWalletBalance

    • getWalletBalance(walletId, assetId, options?): AxiosPromise<Balance>

    • Get the aggregated balance of an asset across all of the addresses in the wallet.

      +

    getWalletBalance

    • getWalletBalance(walletId, assetId, options?): AxiosPromise<Balance>

    • Get the aggregated balance of an asset across all of the addresses in the wallet.

      Parameters

      • walletId: string

        The ID of the wallet to fetch the balance for

      • assetId: string

        The symbol of the asset to fetch the balance for

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<Balance>

      Summary

      Get the balance of an asset in the wallet

      Throws

      Memberof

      WalletsApiInterface

      -

    listWalletBalances

    listWalletBalances

    • listWalletBalances(walletId, options?): AxiosPromise<AddressBalanceList>

    • List the balances of all of the addresses in the wallet aggregated by asset.

      Parameters

      • walletId: string

        The ID of the wallet to fetch the balances for

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<AddressBalanceList>

      Summary

      List wallet balances

      Throws

      Memberof

      WalletsApiInterface

      -

    listWallets

    listWallets

    • listWallets(limit?, page?, options?): AxiosPromise<WalletList>

    • List wallets belonging to the user.

      Parameters

      • Optional limit: number

        A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

      • Optional page: string

        A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<WalletList>

      Summary

      List wallets

      Throws

      Memberof

      WalletsApiInterface

      -

    Settings

    Member Visibility

    Theme

    On This Page

    createWalletgetWalletgetWalletBalancelistWalletBalanceslistWallets
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    createWalletgetWalletgetWalletBalancelistWalletBalanceslistWallets
    \ No newline at end of file diff --git a/docs/interfaces/client_api.Webhook.html b/docs/interfaces/client_api.Webhook.html index fd679e22..8ac14253 100644 --- a/docs/interfaces/client_api.Webhook.html +++ b/docs/interfaces/client_api.Webhook.html @@ -1,6 +1,6 @@ Webhook | @coinbase/coinbase-sdk

    Interface Webhook

    Webhook that is used for getting notifications when monitored events occur.

    Export

    Webhook

    -
    interface Webhook {
        created_at?: string;
        event_filters?: WebhookEventFilter[];
        event_type?: WebhookEventType;
        event_type_filter?: WebhookWalletActivityFilter;
        id?: string;
        network_id?: string;
        notification_uri?: string;
        signature_header?: string;
        updated_at?: string;
    }

    Properties

    created_at? +
    interface Webhook {
        created_at?: string;
        event_filters?: WebhookEventFilter[];
        event_type?: WebhookEventType;
        event_type_filter?: WebhookWalletActivityFilter;
        id?: string;
        network_id?: string;
        notification_uri?: string;
        signature_header?: string;
        updated_at?: string;
    }

    Properties

    created_at? event_filters? event_type? event_type_filter? @@ -11,18 +11,18 @@ updated_at?

    Properties

    Optional created_at

    created_at?: string

    The date and time the webhook was created.

    Memberof

    Webhook

    -

    Optional event_filters

    event_filters?: WebhookEventFilter[]

    Webhook will monitor all events that matches any one of the event filters.

    +

    Optional event_filters

    event_filters?: WebhookEventFilter[]

    Webhook will monitor all events that matches any one of the event filters.

    Memberof

    Webhook

    -

    Optional event_type

    event_type?: WebhookEventType

    Memberof

    Webhook

    -

    Optional event_type_filter

    event_type_filter?: WebhookWalletActivityFilter

    Memberof

    Webhook

    -

    Optional id

    id?: string

    Identifier of the webhook.

    +

    Optional event_type

    event_type?: WebhookEventType

    Memberof

    Webhook

    +

    Optional event_type_filter

    event_type_filter?: WebhookWalletActivityFilter

    Memberof

    Webhook

    +

    Optional id

    id?: string

    Identifier of the webhook.

    Memberof

    Webhook

    -

    Optional network_id

    network_id?: string

    The ID of the blockchain network

    +

    Optional network_id

    network_id?: string

    The ID of the blockchain network

    Memberof

    Webhook

    -

    Optional notification_uri

    notification_uri?: string

    The URL to which the notifications will be sent.

    +

    Optional notification_uri

    notification_uri?: string

    The URL to which the notifications will be sent.

    Memberof

    Webhook

    -

    Optional signature_header

    signature_header?: string

    The header that will contain the signature of the webhook payload.

    +

    Optional signature_header

    signature_header?: string

    The header that will contain the signature of the webhook payload.

    Memberof

    Webhook

    -

    Optional updated_at

    updated_at?: string

    The date and time the webhook was last updated.

    +

    Optional updated_at

    updated_at?: string

    The date and time the webhook was last updated.

    Memberof

    Webhook

    -

    Settings

    Member Visibility

    Theme

    On This Page

    created_atevent_filtersevent_typeevent_type_filteridnetwork_idnotification_urisignature_headerupdated_at
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    created_atevent_filtersevent_typeevent_type_filteridnetwork_idnotification_urisignature_headerupdated_at
    \ No newline at end of file diff --git a/docs/interfaces/client_api.WebhookEventFilter.html b/docs/interfaces/client_api.WebhookEventFilter.html index 1216cb18..1baa8c37 100644 --- a/docs/interfaces/client_api.WebhookEventFilter.html +++ b/docs/interfaces/client_api.WebhookEventFilter.html @@ -1,12 +1,12 @@ WebhookEventFilter | @coinbase/coinbase-sdk

    Interface WebhookEventFilter

    The event_filter parameter specifies the criteria to filter events from the blockchain. It allows filtering events by contract address, sender address and receiver address. For a single event filter, not all of the properties need to be presented.

    Export

    WebhookEventFilter

    -
    interface WebhookEventFilter {
        contract_address?: string;
        from_address?: string;
        to_address?: string;
    }

    Properties

    contract_address? +
    interface WebhookEventFilter {
        contract_address?: string;
        from_address?: string;
        to_address?: string;
    }

    Properties

    contract_address? from_address? to_address?

    Properties

    Optional contract_address

    contract_address?: string

    The onchain contract address of the token for which the events should be tracked.

    Memberof

    WebhookEventFilter

    -

    Optional from_address

    from_address?: string

    The onchain address of the sender. Set this filter to track all transfer events originating from your address.

    +

    Optional from_address

    from_address?: string

    The onchain address of the sender. Set this filter to track all transfer events originating from your address.

    Memberof

    WebhookEventFilter

    -

    Optional to_address

    to_address?: string

    The onchain address of the receiver. Set this filter to track all transfer events sent to your address.

    +

    Optional to_address

    to_address?: string

    The onchain address of the receiver. Set this filter to track all transfer events sent to your address.

    Memberof

    WebhookEventFilter

    -

    Settings

    Member Visibility

    Theme

    On This Page

    contract_addressfrom_addressto_address
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    contract_addressfrom_addressto_address
    \ No newline at end of file diff --git a/docs/interfaces/client_api.WebhookList.html b/docs/interfaces/client_api.WebhookList.html index 6274b7c3..1267f815 100644 --- a/docs/interfaces/client_api.WebhookList.html +++ b/docs/interfaces/client_api.WebhookList.html @@ -1,10 +1,10 @@ WebhookList | @coinbase/coinbase-sdk

    Interface WebhookList

    Export

    WebhookList

    -
    interface WebhookList {
        data: Webhook[];
        has_more?: boolean;
        next_page?: string;
    }

    Properties

    data +
    interface WebhookList {
        data: Webhook[];
        has_more?: boolean;
        next_page?: string;
    }

    Properties

    data has_more? next_page?

    Properties

    data

    data: Webhook[]

    Memberof

    WebhookList

    -

    Optional has_more

    has_more?: boolean

    True if this list has another page of items after this one that can be fetched.

    +

    Optional has_more

    has_more?: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    WebhookList

    -

    Optional next_page

    next_page?: string

    The page token to be used to fetch the next page.

    +

    Optional next_page

    next_page?: string

    The page token to be used to fetch the next page.

    Memberof

    WebhookList

    -

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_page
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    datahas_morenext_page
    \ No newline at end of file diff --git a/docs/interfaces/client_api.WebhookWalletActivityFilter.html b/docs/interfaces/client_api.WebhookWalletActivityFilter.html index 45ad9ff5..601806d3 100644 --- a/docs/interfaces/client_api.WebhookWalletActivityFilter.html +++ b/docs/interfaces/client_api.WebhookWalletActivityFilter.html @@ -1,9 +1,9 @@ WebhookWalletActivityFilter | @coinbase/coinbase-sdk

    Interface WebhookWalletActivityFilter

    Filter for wallet activity events. This filter allows the client to specify one or more wallet addresses to monitor for activities such as transactions, transfers, or other types of events that are associated with the specified addresses.

    Export

    WebhookWalletActivityFilter

    -
    interface WebhookWalletActivityFilter {
        addresses?: string[];
        wallet_id?: string;
    }

    Properties

    addresses? +
    interface WebhookWalletActivityFilter {
        addresses?: string[];
        wallet_id?: string;
    }

    Properties

    addresses? wallet_id?

    Properties

    Optional addresses

    addresses?: string[]

    A list of wallet addresses to filter on.

    Memberof

    WebhookWalletActivityFilter

    -

    Optional wallet_id

    wallet_id?: string

    The ID of the wallet that owns the webhook.

    +

    Optional wallet_id

    wallet_id?: string

    The ID of the wallet that owns the webhook.

    Memberof

    WebhookWalletActivityFilter

    -

    Settings

    Member Visibility

    Theme

    On This Page

    addresseswallet_id
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    addresseswallet_id
    \ No newline at end of file diff --git a/docs/interfaces/client_api.WebhooksApiInterface.html b/docs/interfaces/client_api.WebhooksApiInterface.html index ed5cfe81..a1cc260e 100644 --- a/docs/interfaces/client_api.WebhooksApiInterface.html +++ b/docs/interfaces/client_api.WebhooksApiInterface.html @@ -1,6 +1,6 @@ WebhooksApiInterface | @coinbase/coinbase-sdk

    Interface WebhooksApiInterface

    WebhooksApi - interface

    Export

    WebhooksApi

    -
    interface WebhooksApiInterface {
        createWalletWebhook(walletId, createWalletWebhookRequest?, options?): AxiosPromise<Webhook>;
        createWebhook(createWebhookRequest?, options?): AxiosPromise<Webhook>;
        deleteWebhook(webhookId, options?): AxiosPromise<void>;
        listWebhooks(limit?, page?, options?): AxiosPromise<WebhookList>;
        updateWebhook(webhookId, updateWebhookRequest?, options?): AxiosPromise<Webhook>;
    }

    Implemented by

    Methods

    createWalletWebhook +
    interface WebhooksApiInterface {
        createWalletWebhook(walletId, createWalletWebhookRequest?, options?): AxiosPromise<Webhook>;
        createWebhook(createWebhookRequest?, options?): AxiosPromise<Webhook>;
        deleteWebhook(webhookId, options?): AxiosPromise<void>;
        listWebhooks(limit?, page?, options?): AxiosPromise<WebhookList>;
        updateWebhook(webhookId, updateWebhookRequest?, options?): AxiosPromise<Webhook>;
    }

    Implemented by

    Methods

    createWalletWebhook createWebhook deleteWebhook listWebhooks @@ -10,24 +10,24 @@
  • Optional createWalletWebhookRequest: CreateWalletWebhookRequest
  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns AxiosPromise<Webhook>

    Summary

    Create a new webhook scoped to a wallet

    Throws

    Memberof

    WebhooksApiInterface

    -

    createWebhook

    createWebhook

    • createWebhook(createWebhookRequest?, options?): AxiosPromise<Webhook>

    • Create a new webhook

      Parameters

      • Optional createWebhookRequest: CreateWebhookRequest
      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<Webhook>

      Summary

      Create a new webhook

      Throws

      Memberof

      WebhooksApiInterface

      -

    deleteWebhook

    deleteWebhook

    • deleteWebhook(webhookId, options?): AxiosPromise<void>

    • Delete a webhook

      Parameters

      • webhookId: string

        The Webhook uuid that needs to be deleted

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<void>

      Summary

      Delete a webhook

      Throws

      Memberof

      WebhooksApiInterface

      -

    listWebhooks

    listWebhooks

    • listWebhooks(limit?, page?, options?): AxiosPromise<WebhookList>

    • List webhooks, optionally filtered by event type.

      Parameters

      • Optional limit: number

        A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

      • Optional page: string

        A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<WebhookList>

      Summary

      List webhooks

      Throws

      Memberof

      WebhooksApiInterface

      -

    updateWebhook

    updateWebhook

    • updateWebhook(webhookId, updateWebhookRequest?, options?): AxiosPromise<Webhook>

    • Update a webhook

      Parameters

      • webhookId: string

        The Webhook id that needs to be updated

      • Optional updateWebhookRequest: UpdateWebhookRequest
      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<Webhook>

      Summary

      Update a webhook

      Throws

      Memberof

      WebhooksApiInterface

      -

    Settings

    Member Visibility

    Theme

    On This Page

    createWalletWebhookcreateWebhookdeleteWebhooklistWebhooksupdateWebhook
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    createWalletWebhookcreateWebhookdeleteWebhooklistWebhooksupdateWebhook
    \ No newline at end of file diff --git a/docs/interfaces/client_base.RequestArgs.html b/docs/interfaces/client_base.RequestArgs.html index d8266850..d904f220 100644 --- a/docs/interfaces/client_base.RequestArgs.html +++ b/docs/interfaces/client_base.RequestArgs.html @@ -1,4 +1,4 @@ RequestArgs | @coinbase/coinbase-sdk

    Interface RequestArgs

    Export

    RequestArgs

    -
    interface RequestArgs {
        options: RawAxiosRequestConfig;
        url: string;
    }

    Properties

    options +
    interface RequestArgs {
        options: RawAxiosRequestConfig;
        url: string;
    }

    Properties

    options url -

    Properties

    options

    options: RawAxiosRequestConfig

    url

    url: string

    Settings

    Member Visibility

    Theme

    On This Page

    optionsurl
    \ No newline at end of file +

    Properties

    options

    options: RawAxiosRequestConfig

    url

    url: string

    Settings

    Member Visibility

    Theme

    On This Page

    optionsurl
    \ No newline at end of file diff --git a/docs/interfaces/client_configuration.ConfigurationParameters.html b/docs/interfaces/client_configuration.ConfigurationParameters.html index 7fcaf812..c7bc0d82 100644 --- a/docs/interfaces/client_configuration.ConfigurationParameters.html +++ b/docs/interfaces/client_configuration.ConfigurationParameters.html @@ -4,7 +4,7 @@

    NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

    -
    interface ConfigurationParameters {
        accessToken?: string | Promise<string> | ((name?, scopes?) => string) | ((name?, scopes?) => Promise<string>);
        apiKey?: string | Promise<string> | ((name) => string) | ((name) => Promise<string>);
        baseOptions?: any;
        basePath?: string;
        formDataCtor?: (new () => any);
        password?: string;
        serverIndex?: number;
        username?: string;
    }

    Properties

    accessToken? +
    interface ConfigurationParameters {
        accessToken?: string | Promise<string> | ((name?, scopes?) => string) | ((name?, scopes?) => Promise<string>);
        apiKey?: string | Promise<string> | ((name) => string) | ((name) => Promise<string>);
        baseOptions?: any;
        basePath?: string;
        formDataCtor?: (new () => any);
        password?: string;
        serverIndex?: number;
        username?: string;
    }

    Properties

    accessToken? apiKey? baseOptions? basePath? @@ -12,4 +12,4 @@ password? serverIndex? username? -

    Properties

    Optional accessToken

    accessToken?: string | Promise<string> | ((name?, scopes?) => string) | ((name?, scopes?) => Promise<string>)

    Type declaration

      • (name?, scopes?): string

      • Parameters

        • Optional name: string
        • Optional scopes: string[]

        Returns string

    Type declaration

      • (name?, scopes?): Promise<string>

      • Parameters

        • Optional name: string
        • Optional scopes: string[]

        Returns Promise<string>

    Optional apiKey

    apiKey?: string | Promise<string> | ((name) => string) | ((name) => Promise<string>)

    Type declaration

      • (name): string

      • Parameters

        • name: string

        Returns string

    Type declaration

      • (name): Promise<string>

      • Parameters

        • name: string

        Returns Promise<string>

    Optional baseOptions

    baseOptions?: any

    Optional basePath

    basePath?: string

    Optional formDataCtor

    formDataCtor?: (new () => any)

    Type declaration

      • new (): any

      • Returns any

    Optional password

    password?: string

    Optional serverIndex

    serverIndex?: number

    Optional username

    username?: string

    Settings

    Member Visibility

    Theme

    On This Page

    accessTokenapiKeybaseOptionsbasePathformDataCtorpasswordserverIndexusername
    \ No newline at end of file +

    Properties

    Optional accessToken

    accessToken?: string | Promise<string> | ((name?, scopes?) => string) | ((name?, scopes?) => Promise<string>)

    Type declaration

      • (name?, scopes?): string

      • Parameters

        • Optional name: string
        • Optional scopes: string[]

        Returns string

    Type declaration

      • (name?, scopes?): Promise<string>

      • Parameters

        • Optional name: string
        • Optional scopes: string[]

        Returns Promise<string>

    Optional apiKey

    apiKey?: string | Promise<string> | ((name) => string) | ((name) => Promise<string>)

    Type declaration

      • (name): string

      • Parameters

        • name: string

        Returns string

    Type declaration

      • (name): Promise<string>

      • Parameters

        • name: string

        Returns Promise<string>

    Optional baseOptions

    baseOptions?: any

    Optional basePath

    basePath?: string

    Optional formDataCtor

    formDataCtor?: (new () => any)

    Type declaration

      • new (): any

      • Returns any

    Optional password

    password?: string

    Optional serverIndex

    serverIndex?: number

    Optional username

    username?: string

    Settings

    Member Visibility

    Theme

    On This Page

    accessTokenapiKeybaseOptionsbasePathformDataCtorpasswordserverIndexusername
    \ No newline at end of file diff --git a/docs/interfaces/coinbase_types.BalanceHistoryApiClient.html b/docs/interfaces/coinbase_types.BalanceHistoryApiClient.html index 76f092b9..21129f07 100644 --- a/docs/interfaces/coinbase_types.BalanceHistoryApiClient.html +++ b/docs/interfaces/coinbase_types.BalanceHistoryApiClient.html @@ -1,4 +1,4 @@ -BalanceHistoryApiClient | @coinbase/coinbase-sdk

    Interface BalanceHistoryApiClient

    interface BalanceHistoryApiClient {
        listAddressHistoricalBalance(networkId, addressId, assetId, limit?, page?, options?): AxiosPromise<AddressHistoricalBalanceList>;
    }

    Methods

    listAddressHistoricalBalance +BalanceHistoryApiClient | @coinbase/coinbase-sdk

    Interface BalanceHistoryApiClient

    interface BalanceHistoryApiClient {
        listAddressHistoricalBalance(networkId, addressId, assetId, limit?, page?, options?): AxiosPromise<AddressHistoricalBalanceList>;
    }

    Methods

    listAddressHistoricalBalance

    Methods

    listAddressHistoricalBalance

    • listAddressHistoricalBalance(networkId, addressId, assetId, limit?, page?, options?): AxiosPromise<AddressHistoricalBalanceList>

    • List the historical balance of an asset in a specific address.

      Parameters

      • networkId: string

        The ID of the blockchain network

      • addressId: string

        The ID of the address to fetch the historical balance for.

        @@ -7,4 +7,4 @@
      • Optional page: string

        A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<AddressHistoricalBalanceList>

      Summary

      Get address balance history for asset

      -

      Throws

    Settings

    Member Visibility

    Theme

    On This Page

    listAddressHistoricalBalance
    \ No newline at end of file +

    Throws

    Settings

    Member Visibility

    Theme

    On This Page

    listAddressHistoricalBalance
    \ No newline at end of file diff --git a/docs/interfaces/coinbase_types.PaginationResponse.html b/docs/interfaces/coinbase_types.PaginationResponse.html index 5a515d70..33eef7c3 100644 --- a/docs/interfaces/coinbase_types.PaginationResponse.html +++ b/docs/interfaces/coinbase_types.PaginationResponse.html @@ -1,5 +1,5 @@ PaginationResponse | @coinbase/coinbase-sdk

    Interface PaginationResponse<T>

    Paginated list response.

    -
    interface PaginationResponse<T> {
        data: T[];
        hasMore: boolean;
        nextPage: undefined | string;
    }

    Type Parameters

    • T

    Properties

    data +
    interface PaginationResponse<T> {
        data: T[];
        hasMore: boolean;
        nextPage: undefined | string;
    }

    Type Parameters

    • T

    Properties

    data hasMore nextPage -

    Properties

    data

    data: T[]

    hasMore

    hasMore: boolean

    nextPage

    nextPage: undefined | string

    Settings

    Member Visibility

    Theme

    On This Page

    datahasMorenextPage
    \ No newline at end of file +

    Properties

    data

    data: T[]

    hasMore

    hasMore: boolean

    nextPage

    nextPage: undefined | string

    Settings

    Member Visibility

    Theme

    On This Page

    datahasMorenextPage
    \ No newline at end of file diff --git a/docs/interfaces/coinbase_types.SmartContractAPIClient.html b/docs/interfaces/coinbase_types.SmartContractAPIClient.html index 5da96730..3d765dfe 100644 --- a/docs/interfaces/coinbase_types.SmartContractAPIClient.html +++ b/docs/interfaces/coinbase_types.SmartContractAPIClient.html @@ -1,4 +1,4 @@ -SmartContractAPIClient | @coinbase/coinbase-sdk

    Interface SmartContractAPIClient

    interface SmartContractAPIClient {
        createSmartContract(walletId, addressId, createSmartContractRequest, options?): AxiosPromise<SmartContract>;
        deploySmartContract(walletId, addressId, smartContractId, deploySmartContractRequest, options?): AxiosPromise<SmartContract>;
        getSmartContract(walletId, addressId, smartContractId, options?): AxiosPromise<SmartContract>;
        listSmartContracts(walletId, addressId, options?): AxiosPromise<SmartContractList>;
        readContract(networkId, contractAddress, readContractRequest): AxiosPromise<SolidityValue>;
    }

    Methods

    createSmartContract +SmartContractAPIClient | @coinbase/coinbase-sdk

    Interface SmartContractAPIClient

    interface SmartContractAPIClient {
        createSmartContract(walletId, addressId, createSmartContractRequest, options?): AxiosPromise<SmartContract>;
        deploySmartContract(walletId, addressId, smartContractId, deploySmartContractRequest, options?): AxiosPromise<SmartContract>;
        getSmartContract(walletId, addressId, smartContractId, options?): AxiosPromise<SmartContract>;
        listSmartContracts(walletId, addressId, options?): AxiosPromise<SmartContractList>;
        readContract(networkId, contractAddress, readContractRequest): AxiosPromise<SolidityValue>;
    }

    Methods

    createSmartContract deploySmartContract getSmartContract listSmartContracts @@ -9,26 +9,26 @@
  • createSmartContractRequest: CreateSmartContractRequest

    The request body containing the smart contract details.

  • Optional options: RawAxiosRequestConfig

    Axios request options.

    • Returns AxiosPromise<SmartContract>

    Throws

    If the request fails.

    -

    deploySmartContract

    deploySmartContract

    • deploySmartContract(walletId, addressId, smartContractId, deploySmartContractRequest, options?): AxiosPromise<SmartContract>

    • Deploys a Smart Contract.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The ID of the address the smart contract belongs to.

      • smartContractId: string

        The ID of the smart contract to deploy.

      • deploySmartContractRequest: DeploySmartContractRequest

        The request body containing deployment details.

      • Optional options: RawAxiosRequestConfig

        Axios request options.

      Returns AxiosPromise<SmartContract>

      Throws

      If the request fails.

      -

    getSmartContract

    getSmartContract

    • getSmartContract(walletId, addressId, smartContractId, options?): AxiosPromise<SmartContract>

    • Gets a specific Smart Contract.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The ID of the address the smart contract belongs to.

      • smartContractId: string

        The ID of the smart contract to retrieve.

      • Optional options: RawAxiosRequestConfig

        Axios request options.

      Returns AxiosPromise<SmartContract>

      Throws

      If the request fails.

      -

    listSmartContracts

    listSmartContracts

    • listSmartContracts(walletId, addressId, options?): AxiosPromise<SmartContractList>

    • List smart contracts belonging to the user for a given wallet and address.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The ID of the address to list smart contracts for.

      • Optional options: RawAxiosRequestConfig

        Axios request options.

      Returns AxiosPromise<SmartContractList>

      Summary

      List smart contracts belonging to the CDP project

      Throws

      If the request fails.

      -

    readContract

    readContract

    • readContract(networkId, contractAddress, readContractRequest): AxiosPromise<SolidityValue>

    • Read a contract

      Parameters

      • networkId: string

        Unique identifier for the blockchain network

      • contractAddress: string

        EVM address of the smart contract (42 characters, including '0x', in lowercase)

      • readContractRequest: ReadContractRequest

        The request body containing the method, args, and optionally the ABI

        @@ -36,4 +36,4 @@

        Throws

        If the request fails.

      • A promise resolving to the contract read result

      Throws

      If the request fails

      -

    Settings

    Member Visibility

    Theme

    On This Page

    createSmartContractdeploySmartContractgetSmartContractlistSmartContractsreadContract
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    createSmartContractdeploySmartContractgetSmartContractlistSmartContractsreadContract
    \ No newline at end of file diff --git a/docs/interfaces/coinbase_types.TransactionHistoryApiClient.html b/docs/interfaces/coinbase_types.TransactionHistoryApiClient.html index f3758132..496b3699 100644 --- a/docs/interfaces/coinbase_types.TransactionHistoryApiClient.html +++ b/docs/interfaces/coinbase_types.TransactionHistoryApiClient.html @@ -1,4 +1,4 @@ -TransactionHistoryApiClient | @coinbase/coinbase-sdk

    Interface TransactionHistoryApiClient

    interface TransactionHistoryApiClient {
        listAddressTransactions(networkId, addressId, limit?, page?, options?): AxiosPromise<AddressTransactionList>;
    }

    Methods

    listAddressTransactions +TransactionHistoryApiClient | @coinbase/coinbase-sdk

    Interface TransactionHistoryApiClient

    interface TransactionHistoryApiClient {
        listAddressTransactions(networkId, addressId, limit?, page?, options?): AxiosPromise<AddressTransactionList>;
    }

    Methods

    listAddressTransactions

    Methods

    listAddressTransactions

    • listAddressTransactions(networkId, addressId, limit?, page?, options?): AxiosPromise<AddressTransactionList>

    • List the transactions of a specific address.

      Parameters

      • networkId: string

        The ID of the blockchain network

      • addressId: string

        The ID of the address to fetch transactions for.

        @@ -6,4 +6,4 @@
      • Optional page: string

        A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<AddressTransactionList>

      Summary

      Get address transactions

      -

      Throws

    Settings

    Member Visibility

    Theme

    On This Page

    listAddressTransactions
    \ No newline at end of file +

    Throws

    Settings

    Member Visibility

    Theme

    On This Page

    listAddressTransactions
    \ No newline at end of file diff --git a/docs/interfaces/coinbase_types.WebhookApiClient.html b/docs/interfaces/coinbase_types.WebhookApiClient.html index 900ce060..ed7cb228 100644 --- a/docs/interfaces/coinbase_types.WebhookApiClient.html +++ b/docs/interfaces/coinbase_types.WebhookApiClient.html @@ -1,4 +1,4 @@ -WebhookApiClient | @coinbase/coinbase-sdk

    Interface WebhookApiClient

    interface WebhookApiClient {
        createWalletWebhook(walletId?, createWalletWebhookRequest?, options?): AxiosPromise<Webhook>;
        createWebhook(createWebhookRequest?, options?): AxiosPromise<Webhook>;
        deleteWebhook(webhookId, options?): AxiosPromise<void>;
        listWebhooks(limit?, page?, options?): AxiosPromise<WebhookList>;
        updateWebhook(webhookId, updateWebhookRequest?, options?): AxiosPromise<Webhook>;
    }

    Methods

    createWalletWebhook +WebhookApiClient | @coinbase/coinbase-sdk

    Interface WebhookApiClient

    interface WebhookApiClient {
        createWalletWebhook(walletId?, createWalletWebhookRequest?, options?): AxiosPromise<Webhook>;
        createWebhook(createWebhookRequest?, options?): AxiosPromise<Webhook>;
        deleteWebhook(webhookId, options?): AxiosPromise<void>;
        listWebhooks(limit?, page?, options?): AxiosPromise<WebhookList>;
        updateWebhook(webhookId, updateWebhookRequest?, options?): AxiosPromise<Webhook>;
    }

    Methods

    createWalletWebhook createWebhook deleteWebhook listWebhooks @@ -6,20 +6,20 @@

    Methods

    createWalletWebhook

    • createWalletWebhook(walletId?, createWalletWebhookRequest?, options?): AxiosPromise<Webhook>

    • Create a new webhook for a wallet

      Parameters

      • Optional walletId: string
      • Optional createWalletWebhookRequest: CreateWalletWebhookRequest
      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<Webhook>

      Summary

      Create a new webhook for a wallet

      -

      Throws

    createWebhook

    createWebhook

    • createWebhook(createWebhookRequest?, options?): AxiosPromise<Webhook>

    • Create a new webhook

      Parameters

      • Optional createWebhookRequest: CreateWebhookRequest
      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<Webhook>

      Summary

      Create a new webhook

      -

      Throws

    deleteWebhook

    deleteWebhook

    • deleteWebhook(webhookId, options?): AxiosPromise<void>

    • Delete a webhook

      Parameters

      • webhookId: string

        The Webhook uuid that needs to be deleted

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<void>

      Summary

      Delete a webhook

      -

      Throws

    listWebhooks

    listWebhooks

    • listWebhooks(limit?, page?, options?): AxiosPromise<WebhookList>

    • List webhooks, optionally filtered by event type.

      Parameters

      • Optional limit: number

        A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

      • Optional page: string

        A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<WebhookList>

      Summary

      List webhooks

      -

      Throws

    updateWebhook

    updateWebhook

    • updateWebhook(webhookId, updateWebhookRequest?, options?): AxiosPromise<Webhook>

    • Update a webhook

      Parameters

      • webhookId: string

        The Webhook id that needs to be updated

      • Optional updateWebhookRequest: UpdateWebhookRequest
      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<Webhook>

      Summary

      Update a webhook

      -

      Throws

    Settings

    Member Visibility

    Theme

    On This Page

    createWalletWebhookcreateWebhookdeleteWebhooklistWebhooksupdateWebhook
    \ No newline at end of file +

    Throws

    Settings

    Member Visibility

    Theme

    On This Page

    createWalletWebhookcreateWebhookdeleteWebhooklistWebhooksupdateWebhook
    \ No newline at end of file diff --git a/docs/modules/client.html b/docs/modules/client.html index f660ef23..35e9da11 100644 --- a/docs/modules/client.html +++ b/docs/modules/client.html @@ -1,4 +1,4 @@ -client | @coinbase/coinbase-sdk

    Module client

    References

    Address +client | @coinbase/coinbase-sdk

    Module client

    References

    Address AddressBalanceList AddressHistoricalBalanceList AddressList diff --git a/docs/modules/client_api.html b/docs/modules/client_api.html index dcfa9e47..fd9bb67f 100644 --- a/docs/modules/client_api.html +++ b/docs/modules/client_api.html @@ -1,4 +1,4 @@ -client/api | @coinbase/coinbase-sdk

    Module client/api

    Index

    Enumerations

    NetworkIdentifier +client/api | @coinbase/coinbase-sdk

    Module client/api

    Index

    Enumerations

    NetworkIdentifier SmartContractType StakingRewardFormat TransactionType diff --git a/docs/modules/client_base.html b/docs/modules/client_base.html index 564e5f27..de77c3cc 100644 --- a/docs/modules/client_base.html +++ b/docs/modules/client_base.html @@ -1,4 +1,4 @@ -client/base | @coinbase/coinbase-sdk

    Module client/base

    Index

    Classes

    BaseAPI +client/base | @coinbase/coinbase-sdk

    Module client/base

    Index

    Classes

    BaseAPI RequiredError

    Interfaces

    RequestArgs

    Variables

    BASE_PATH diff --git a/docs/modules/client_common.html b/docs/modules/client_common.html index b397fa01..af0f6563 100644 --- a/docs/modules/client_common.html +++ b/docs/modules/client_common.html @@ -1,4 +1,4 @@ -client/common | @coinbase/coinbase-sdk

    Module client/common

    Index

    Variables

    DUMMY_BASE_URL +client/common | @coinbase/coinbase-sdk

    Module client/common

    Index

    Variables

    DUMMY_BASE_URL

    Functions

    assertParamExists createRequestFunction serializeDataIfNeeded diff --git a/docs/modules/client_configuration.html b/docs/modules/client_configuration.html index 2ad80ad9..b064d155 100644 --- a/docs/modules/client_configuration.html +++ b/docs/modules/client_configuration.html @@ -1,3 +1,3 @@ -client/configuration | @coinbase/coinbase-sdk

    Module client/configuration

    Index

    Classes

    Configuration +client/configuration | @coinbase/coinbase-sdk

    Module client/configuration

    Index

    Classes

    Configuration

    Interfaces

    ConfigurationParameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/coinbase_address.html b/docs/modules/coinbase_address.html index 43bcac04..4fc02a9d 100644 --- a/docs/modules/coinbase_address.html +++ b/docs/modules/coinbase_address.html @@ -1,2 +1,2 @@ -coinbase/address | @coinbase/coinbase-sdk

    Module coinbase/address

    Index

    Classes

    Address +coinbase/address | @coinbase/coinbase-sdk

    Module coinbase/address

    Index

    Classes

    Address

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/coinbase_address_external_address.html b/docs/modules/coinbase_address_external_address.html index 62c7a1d1..8a24745f 100644 --- a/docs/modules/coinbase_address_external_address.html +++ b/docs/modules/coinbase_address_external_address.html @@ -1,2 +1,2 @@ -coinbase/address/external_address | @coinbase/coinbase-sdk

    Module coinbase/address/external_address

    Index

    Classes

    ExternalAddress +coinbase/address/external_address | @coinbase/coinbase-sdk

    Module coinbase/address/external_address

    Index

    Classes

    ExternalAddress

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/coinbase_address_wallet_address.html b/docs/modules/coinbase_address_wallet_address.html index de2b07b4..6ee42ea7 100644 --- a/docs/modules/coinbase_address_wallet_address.html +++ b/docs/modules/coinbase_address_wallet_address.html @@ -1,2 +1,2 @@ -coinbase/address/wallet_address | @coinbase/coinbase-sdk

    Module coinbase/address/wallet_address

    Index

    Classes

    WalletAddress +coinbase/address/wallet_address | @coinbase/coinbase-sdk

    Module coinbase/address/wallet_address

    Index

    Classes

    WalletAddress

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/coinbase_api_error.html b/docs/modules/coinbase_api_error.html index 01e0c11f..eebb4edc 100644 --- a/docs/modules/coinbase_api_error.html +++ b/docs/modules/coinbase_api_error.html @@ -1,4 +1,4 @@ -coinbase/api_error | @coinbase/coinbase-sdk

    Module coinbase/api_error

    Index

    Classes

    APIError +coinbase/api_error | @coinbase/coinbase-sdk

    Module coinbase/api_error

    Index

    Classes

    APIError AlreadyExistsError FaucetLimitReachedError InternalError diff --git a/docs/modules/coinbase_asset.html b/docs/modules/coinbase_asset.html index e9e7fdb5..ad846d39 100644 --- a/docs/modules/coinbase_asset.html +++ b/docs/modules/coinbase_asset.html @@ -1,2 +1,2 @@ -coinbase/asset | @coinbase/coinbase-sdk

    Module coinbase/asset

    Index

    Classes

    Asset +coinbase/asset | @coinbase/coinbase-sdk

    Module coinbase/asset

    Index

    Classes

    Asset

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/coinbase_authenticator.html b/docs/modules/coinbase_authenticator.html index 92a4fdae..a647aee1 100644 --- a/docs/modules/coinbase_authenticator.html +++ b/docs/modules/coinbase_authenticator.html @@ -1,2 +1,2 @@ -coinbase/authenticator | @coinbase/coinbase-sdk

    Module coinbase/authenticator

    Index

    Classes

    CoinbaseAuthenticator +coinbase/authenticator | @coinbase/coinbase-sdk

    Module coinbase/authenticator

    Index

    Classes

    CoinbaseAuthenticator

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/coinbase_balance.html b/docs/modules/coinbase_balance.html index 25bebf0d..075b1ea1 100644 --- a/docs/modules/coinbase_balance.html +++ b/docs/modules/coinbase_balance.html @@ -1,2 +1,2 @@ -coinbase/balance | @coinbase/coinbase-sdk

    Module coinbase/balance

    Index

    Classes

    Balance +coinbase/balance | @coinbase/coinbase-sdk

    Module coinbase/balance

    Index

    Classes

    Balance

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/coinbase_balance_map.html b/docs/modules/coinbase_balance_map.html index d9d7c39a..a0b2cf0d 100644 --- a/docs/modules/coinbase_balance_map.html +++ b/docs/modules/coinbase_balance_map.html @@ -1,2 +1,2 @@ -coinbase/balance_map | @coinbase/coinbase-sdk

    Module coinbase/balance_map

    Index

    Classes

    BalanceMap +coinbase/balance_map | @coinbase/coinbase-sdk

    Module coinbase/balance_map

    Index

    Classes

    BalanceMap

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/coinbase_coinbase.html b/docs/modules/coinbase_coinbase.html index e26477e1..b97460ed 100644 --- a/docs/modules/coinbase_coinbase.html +++ b/docs/modules/coinbase_coinbase.html @@ -1,2 +1,2 @@ -coinbase/coinbase | @coinbase/coinbase-sdk

    Module coinbase/coinbase

    Index

    Classes

    Coinbase +coinbase/coinbase | @coinbase/coinbase-sdk

    Module coinbase/coinbase

    Index

    Classes

    Coinbase

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/coinbase_constants.html b/docs/modules/coinbase_constants.html index 05f4db4c..80edd02a 100644 --- a/docs/modules/coinbase_constants.html +++ b/docs/modules/coinbase_constants.html @@ -1,2 +1,2 @@ -coinbase/constants | @coinbase/coinbase-sdk

    Module coinbase/constants

    Index

    Variables

    GWEI_DECIMALS +coinbase/constants | @coinbase/coinbase-sdk

    Module coinbase/constants

    Index

    Variables

    GWEI_DECIMALS

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/coinbase_contract_event.html b/docs/modules/coinbase_contract_event.html index 2e69fbfe..e580474f 100644 --- a/docs/modules/coinbase_contract_event.html +++ b/docs/modules/coinbase_contract_event.html @@ -1,2 +1,2 @@ -coinbase/contract_event | @coinbase/coinbase-sdk

    Module coinbase/contract_event

    Index

    Classes

    ContractEvent +coinbase/contract_event | @coinbase/coinbase-sdk

    Module coinbase/contract_event

    Index

    Classes

    ContractEvent

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/coinbase_contract_invocation.html b/docs/modules/coinbase_contract_invocation.html index bed65abb..ebf0fc6e 100644 --- a/docs/modules/coinbase_contract_invocation.html +++ b/docs/modules/coinbase_contract_invocation.html @@ -1,2 +1,2 @@ -coinbase/contract_invocation | @coinbase/coinbase-sdk

    Module coinbase/contract_invocation

    Index

    Classes

    ContractInvocation +coinbase/contract_invocation | @coinbase/coinbase-sdk

    Module coinbase/contract_invocation

    Index

    Classes

    ContractInvocation

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/coinbase_errors.html b/docs/modules/coinbase_errors.html index 6defe241..d607ca31 100644 --- a/docs/modules/coinbase_errors.html +++ b/docs/modules/coinbase_errors.html @@ -1,4 +1,4 @@ -coinbase/errors | @coinbase/coinbase-sdk

    Module coinbase/errors

    Index

    Classes

    AlreadySignedError +coinbase/errors | @coinbase/coinbase-sdk

    Module coinbase/errors

    Index

    Classes

    AlreadySignedError ArgumentError InvalidAPIKeyFormatError InvalidConfigurationError diff --git a/docs/modules/coinbase_faucet_transaction.html b/docs/modules/coinbase_faucet_transaction.html index de65b653..228ca5b8 100644 --- a/docs/modules/coinbase_faucet_transaction.html +++ b/docs/modules/coinbase_faucet_transaction.html @@ -1,2 +1,2 @@ -coinbase/faucet_transaction | @coinbase/coinbase-sdk

    Module coinbase/faucet_transaction

    Index

    Classes

    FaucetTransaction +coinbase/faucet_transaction | @coinbase/coinbase-sdk

    Module coinbase/faucet_transaction

    Index

    Classes

    FaucetTransaction

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/coinbase_hash.html b/docs/modules/coinbase_hash.html index b2b4e46d..2f2fb118 100644 --- a/docs/modules/coinbase_hash.html +++ b/docs/modules/coinbase_hash.html @@ -1,3 +1,3 @@ -coinbase/hash | @coinbase/coinbase-sdk

    Module coinbase/hash

    Index

    Functions

    hashMessage +coinbase/hash | @coinbase/coinbase-sdk

    Module coinbase/hash

    Index

    Functions

    hashMessage hashTypedDataMessage

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/coinbase_historical_balance.html b/docs/modules/coinbase_historical_balance.html index 9b7ae67c..ac166b02 100644 --- a/docs/modules/coinbase_historical_balance.html +++ b/docs/modules/coinbase_historical_balance.html @@ -1,2 +1,2 @@ -coinbase/historical_balance | @coinbase/coinbase-sdk

    Module coinbase/historical_balance

    Index

    Classes

    HistoricalBalance +coinbase/historical_balance | @coinbase/coinbase-sdk

    Module coinbase/historical_balance

    Index

    Classes

    HistoricalBalance

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/coinbase_payload_signature.html b/docs/modules/coinbase_payload_signature.html index 8b545eac..4460bb28 100644 --- a/docs/modules/coinbase_payload_signature.html +++ b/docs/modules/coinbase_payload_signature.html @@ -1,2 +1,2 @@ -coinbase/payload_signature | @coinbase/coinbase-sdk

    Module coinbase/payload_signature

    Index

    Classes

    PayloadSignature +coinbase/payload_signature | @coinbase/coinbase-sdk

    Module coinbase/payload_signature

    Index

    Classes

    PayloadSignature

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/coinbase_read_contract.html b/docs/modules/coinbase_read_contract.html index f558a9c9..77beab6d 100644 --- a/docs/modules/coinbase_read_contract.html +++ b/docs/modules/coinbase_read_contract.html @@ -1,2 +1,2 @@ -coinbase/read_contract | @coinbase/coinbase-sdk

    Module coinbase/read_contract

    Index

    Functions

    readContract +coinbase/read_contract | @coinbase/coinbase-sdk

    Module coinbase/read_contract

    Index

    Functions

    readContract

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/coinbase_server_signer.html b/docs/modules/coinbase_server_signer.html index 12b83da9..1f706be7 100644 --- a/docs/modules/coinbase_server_signer.html +++ b/docs/modules/coinbase_server_signer.html @@ -1,2 +1,2 @@ -coinbase/server_signer | @coinbase/coinbase-sdk

    Module coinbase/server_signer

    Index

    Classes

    ServerSigner +coinbase/server_signer | @coinbase/coinbase-sdk

    Module coinbase/server_signer

    Index

    Classes

    ServerSigner

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/coinbase_smart_contract.html b/docs/modules/coinbase_smart_contract.html index 937d10af..61643237 100644 --- a/docs/modules/coinbase_smart_contract.html +++ b/docs/modules/coinbase_smart_contract.html @@ -1,2 +1,2 @@ -coinbase/smart_contract | @coinbase/coinbase-sdk

    Module coinbase/smart_contract

    Index

    Classes

    SmartContract +coinbase/smart_contract | @coinbase/coinbase-sdk

    Module coinbase/smart_contract

    Index

    Classes

    SmartContract

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/coinbase_sponsored_send.html b/docs/modules/coinbase_sponsored_send.html index a9e085de..581c6bc3 100644 --- a/docs/modules/coinbase_sponsored_send.html +++ b/docs/modules/coinbase_sponsored_send.html @@ -1,2 +1,2 @@ -coinbase/sponsored_send | @coinbase/coinbase-sdk

    Module coinbase/sponsored_send

    Index

    Classes

    SponsoredSend +coinbase/sponsored_send | @coinbase/coinbase-sdk

    Module coinbase/sponsored_send

    Index

    Classes

    SponsoredSend

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/coinbase_staking_balance.html b/docs/modules/coinbase_staking_balance.html index b58ffb4d..4466c279 100644 --- a/docs/modules/coinbase_staking_balance.html +++ b/docs/modules/coinbase_staking_balance.html @@ -1,2 +1,2 @@ -coinbase/staking_balance | @coinbase/coinbase-sdk

    Module coinbase/staking_balance

    Index

    Classes

    StakingBalance +coinbase/staking_balance | @coinbase/coinbase-sdk

    Module coinbase/staking_balance

    Index

    Classes

    StakingBalance

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/coinbase_staking_operation.html b/docs/modules/coinbase_staking_operation.html index da1ecc62..da29af1c 100644 --- a/docs/modules/coinbase_staking_operation.html +++ b/docs/modules/coinbase_staking_operation.html @@ -1,2 +1,2 @@ -coinbase/staking_operation | @coinbase/coinbase-sdk

    Module coinbase/staking_operation

    Index

    Classes

    StakingOperation +coinbase/staking_operation | @coinbase/coinbase-sdk

    Module coinbase/staking_operation

    Index

    Classes

    StakingOperation

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/coinbase_staking_reward.html b/docs/modules/coinbase_staking_reward.html index 23654ebe..3b42fa65 100644 --- a/docs/modules/coinbase_staking_reward.html +++ b/docs/modules/coinbase_staking_reward.html @@ -1,2 +1,2 @@ -coinbase/staking_reward | @coinbase/coinbase-sdk

    Module coinbase/staking_reward

    Index

    Classes

    StakingReward +coinbase/staking_reward | @coinbase/coinbase-sdk

    Module coinbase/staking_reward

    Index

    Classes

    StakingReward

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/coinbase_trade.html b/docs/modules/coinbase_trade.html index a7381b32..cf0937c7 100644 --- a/docs/modules/coinbase_trade.html +++ b/docs/modules/coinbase_trade.html @@ -1,2 +1,2 @@ -coinbase/trade | @coinbase/coinbase-sdk

    Module coinbase/trade

    Index

    Classes

    Trade +coinbase/trade | @coinbase/coinbase-sdk

    Module coinbase/trade

    Index

    Classes

    Trade

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/coinbase_transaction.html b/docs/modules/coinbase_transaction.html index a77f6c29..51693e93 100644 --- a/docs/modules/coinbase_transaction.html +++ b/docs/modules/coinbase_transaction.html @@ -1,2 +1,2 @@ -coinbase/transaction | @coinbase/coinbase-sdk

    Module coinbase/transaction

    Index

    Classes

    Transaction +coinbase/transaction | @coinbase/coinbase-sdk

    Module coinbase/transaction

    Index

    Classes

    Transaction

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/coinbase_transfer.html b/docs/modules/coinbase_transfer.html index 646066c3..eb5c1143 100644 --- a/docs/modules/coinbase_transfer.html +++ b/docs/modules/coinbase_transfer.html @@ -1,2 +1,2 @@ -coinbase/transfer | @coinbase/coinbase-sdk

    Module coinbase/transfer

    Index

    Classes

    Transfer +coinbase/transfer | @coinbase/coinbase-sdk

    Module coinbase/transfer

    Index

    Classes

    Transfer

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/coinbase_types.html b/docs/modules/coinbase_types.html index cf5184f2..84b025bf 100644 --- a/docs/modules/coinbase_types.html +++ b/docs/modules/coinbase_types.html @@ -1,4 +1,4 @@ -coinbase/types | @coinbase/coinbase-sdk

    Module coinbase/types

    Index

    Enumerations

    PayloadSignatureStatus +coinbase/types | @coinbase/coinbase-sdk

    Module coinbase/types

    Index

    Enumerations

    PayloadSignatureStatus ServerSignerStatus SmartContractType SponsoredSendStatus diff --git a/docs/modules/coinbase_types_contract.html b/docs/modules/coinbase_types_contract.html index 0cda012c..0d6b1082 100644 --- a/docs/modules/coinbase_types_contract.html +++ b/docs/modules/coinbase_types_contract.html @@ -1,2 +1,2 @@ -coinbase/types/contract | @coinbase/coinbase-sdk

    Module coinbase/types/contract

    Index

    Type Aliases

    ContractFunctionReturnType +coinbase/types/contract | @coinbase/coinbase-sdk

    Module coinbase/types/contract

    Index

    Type Aliases

    ContractFunctionReturnType

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/coinbase_utils.html b/docs/modules/coinbase_utils.html index 357e2586..07a398b3 100644 --- a/docs/modules/coinbase_utils.html +++ b/docs/modules/coinbase_utils.html @@ -1,4 +1,4 @@ -coinbase/utils | @coinbase/coinbase-sdk

    Module coinbase/utils

    Index

    Functions

    convertStringToHex +coinbase/utils | @coinbase/coinbase-sdk

    Module coinbase/utils

    Index

    Functions

    convertStringToHex delay formatDate getWeekBackDate diff --git a/docs/modules/coinbase_validator.html b/docs/modules/coinbase_validator.html index 2a72c02d..da2a6a94 100644 --- a/docs/modules/coinbase_validator.html +++ b/docs/modules/coinbase_validator.html @@ -1,2 +1,2 @@ -coinbase/validator | @coinbase/coinbase-sdk

    Module coinbase/validator

    Index

    Classes

    Validator +coinbase/validator | @coinbase/coinbase-sdk

    Module coinbase/validator

    Index

    Classes

    Validator

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/coinbase_wallet.html b/docs/modules/coinbase_wallet.html index 9ea82d94..6e4a15ea 100644 --- a/docs/modules/coinbase_wallet.html +++ b/docs/modules/coinbase_wallet.html @@ -1,2 +1,2 @@ -coinbase/wallet | @coinbase/coinbase-sdk

    Module coinbase/wallet

    Index

    Classes

    Wallet +coinbase/wallet | @coinbase/coinbase-sdk

    Module coinbase/wallet

    Index

    Classes

    Wallet

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/coinbase_webhook.html b/docs/modules/coinbase_webhook.html index b7b57eb8..c155b3b2 100644 --- a/docs/modules/coinbase_webhook.html +++ b/docs/modules/coinbase_webhook.html @@ -1,2 +1,2 @@ -coinbase/webhook | @coinbase/coinbase-sdk

    Module coinbase/webhook

    Index

    Classes

    Webhook +coinbase/webhook | @coinbase/coinbase-sdk

    Module coinbase/webhook

    Index

    Classes

    Webhook

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/index.html b/docs/modules/index.html index a6c72512..2e314a2b 100644 --- a/docs/modules/index.html +++ b/docs/modules/index.html @@ -1,4 +1,4 @@ -index | @coinbase/coinbase-sdk

    Module index

    References

    APIError +index | @coinbase/coinbase-sdk

    Module index

    References

    APIError Address AddressAPIClient AlreadyExistsError diff --git a/docs/types/client_api.NetworkProtocolFamilyEnum.html b/docs/types/client_api.NetworkProtocolFamilyEnum.html index e80ed4a3..3dc2da57 100644 --- a/docs/types/client_api.NetworkProtocolFamilyEnum.html +++ b/docs/types/client_api.NetworkProtocolFamilyEnum.html @@ -1 +1 @@ -NetworkProtocolFamilyEnum | @coinbase/coinbase-sdk

    Type alias NetworkProtocolFamilyEnum

    NetworkProtocolFamilyEnum: typeof NetworkProtocolFamilyEnum[keyof typeof NetworkProtocolFamilyEnum]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +NetworkProtocolFamilyEnum | @coinbase/coinbase-sdk

    Type alias NetworkProtocolFamilyEnum

    NetworkProtocolFamilyEnum: typeof NetworkProtocolFamilyEnum[keyof typeof NetworkProtocolFamilyEnum]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/client_api.PayloadSignatureStatusEnum.html b/docs/types/client_api.PayloadSignatureStatusEnum.html index a201d3ff..0ebf38ae 100644 --- a/docs/types/client_api.PayloadSignatureStatusEnum.html +++ b/docs/types/client_api.PayloadSignatureStatusEnum.html @@ -1 +1 @@ -PayloadSignatureStatusEnum | @coinbase/coinbase-sdk

    Type alias PayloadSignatureStatusEnum

    PayloadSignatureStatusEnum: typeof PayloadSignatureStatusEnum[keyof typeof PayloadSignatureStatusEnum]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +PayloadSignatureStatusEnum | @coinbase/coinbase-sdk

    Type alias PayloadSignatureStatusEnum

    PayloadSignatureStatusEnum: typeof PayloadSignatureStatusEnum[keyof typeof PayloadSignatureStatusEnum]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/client_api.ServerSignerEventEvent.html b/docs/types/client_api.ServerSignerEventEvent.html index b8ccc308..97f5a7a1 100644 --- a/docs/types/client_api.ServerSignerEventEvent.html +++ b/docs/types/client_api.ServerSignerEventEvent.html @@ -1 +1 @@ -ServerSignerEventEvent | @coinbase/coinbase-sdk

    Type alias ServerSignerEventEvent

    ServerSignerEventEvent: SeedCreationEvent | SignatureCreationEvent

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ServerSignerEventEvent | @coinbase/coinbase-sdk

    Type alias ServerSignerEventEvent

    ServerSignerEventEvent: SeedCreationEvent | SignatureCreationEvent

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/client_api.SmartContractOptions.html b/docs/types/client_api.SmartContractOptions.html index e0e837dc..10aeebb5 100644 --- a/docs/types/client_api.SmartContractOptions.html +++ b/docs/types/client_api.SmartContractOptions.html @@ -1 +1 @@ -SmartContractOptions | @coinbase/coinbase-sdk

    Type alias SmartContractOptions

    SmartContractOptions: MultiTokenContractOptions | NFTContractOptions | TokenContractOptions

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +SmartContractOptions | @coinbase/coinbase-sdk

    Type alias SmartContractOptions

    SmartContractOptions: MultiTokenContractOptions | NFTContractOptions | TokenContractOptions

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/client_api.SolidityValueTypeEnum.html b/docs/types/client_api.SolidityValueTypeEnum.html index 9639140c..27a08ac6 100644 --- a/docs/types/client_api.SolidityValueTypeEnum.html +++ b/docs/types/client_api.SolidityValueTypeEnum.html @@ -1 +1 @@ -SolidityValueTypeEnum | @coinbase/coinbase-sdk

    Type alias SolidityValueTypeEnum

    SolidityValueTypeEnum: typeof SolidityValueTypeEnum[keyof typeof SolidityValueTypeEnum]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +SolidityValueTypeEnum | @coinbase/coinbase-sdk

    Type alias SolidityValueTypeEnum

    SolidityValueTypeEnum: typeof SolidityValueTypeEnum[keyof typeof SolidityValueTypeEnum]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/client_api.SponsoredSendStatusEnum.html b/docs/types/client_api.SponsoredSendStatusEnum.html index f6e50412..63fc9fd9 100644 --- a/docs/types/client_api.SponsoredSendStatusEnum.html +++ b/docs/types/client_api.SponsoredSendStatusEnum.html @@ -1 +1 @@ -SponsoredSendStatusEnum | @coinbase/coinbase-sdk

    Type alias SponsoredSendStatusEnum

    SponsoredSendStatusEnum: typeof SponsoredSendStatusEnum[keyof typeof SponsoredSendStatusEnum]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +SponsoredSendStatusEnum | @coinbase/coinbase-sdk

    Type alias SponsoredSendStatusEnum

    SponsoredSendStatusEnum: typeof SponsoredSendStatusEnum[keyof typeof SponsoredSendStatusEnum]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/client_api.StakingOperationMetadata.html b/docs/types/client_api.StakingOperationMetadata.html index e42b1b9e..bea72508 100644 --- a/docs/types/client_api.StakingOperationMetadata.html +++ b/docs/types/client_api.StakingOperationMetadata.html @@ -1 +1 @@ -StakingOperationMetadata | @coinbase/coinbase-sdk

    Type alias StakingOperationMetadata

    StakingOperationMetadata: SignedVoluntaryExitMessageMetadata[]

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +StakingOperationMetadata | @coinbase/coinbase-sdk

    Type alias StakingOperationMetadata

    StakingOperationMetadata: SignedVoluntaryExitMessageMetadata[]

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/client_api.StakingOperationStatusEnum.html b/docs/types/client_api.StakingOperationStatusEnum.html index f40e3ec6..232f14c2 100644 --- a/docs/types/client_api.StakingOperationStatusEnum.html +++ b/docs/types/client_api.StakingOperationStatusEnum.html @@ -1 +1 @@ -StakingOperationStatusEnum | @coinbase/coinbase-sdk

    Type alias StakingOperationStatusEnum

    StakingOperationStatusEnum: typeof StakingOperationStatusEnum[keyof typeof StakingOperationStatusEnum]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +StakingOperationStatusEnum | @coinbase/coinbase-sdk

    Type alias StakingOperationStatusEnum

    StakingOperationStatusEnum: typeof StakingOperationStatusEnum[keyof typeof StakingOperationStatusEnum]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/client_api.StakingRewardStateEnum.html b/docs/types/client_api.StakingRewardStateEnum.html index 5fcc88a0..d67708f2 100644 --- a/docs/types/client_api.StakingRewardStateEnum.html +++ b/docs/types/client_api.StakingRewardStateEnum.html @@ -1 +1 @@ -StakingRewardStateEnum | @coinbase/coinbase-sdk

    Type alias StakingRewardStateEnum

    StakingRewardStateEnum: typeof StakingRewardStateEnum[keyof typeof StakingRewardStateEnum]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +StakingRewardStateEnum | @coinbase/coinbase-sdk

    Type alias StakingRewardStateEnum

    StakingRewardStateEnum: typeof StakingRewardStateEnum[keyof typeof StakingRewardStateEnum]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/client_api.TransactionContent.html b/docs/types/client_api.TransactionContent.html index b80fb3c9..93151455 100644 --- a/docs/types/client_api.TransactionContent.html +++ b/docs/types/client_api.TransactionContent.html @@ -1 +1 @@ -TransactionContent | @coinbase/coinbase-sdk

    Type alias TransactionContent

    TransactionContent: EthereumTransaction

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +TransactionContent | @coinbase/coinbase-sdk

    Type alias TransactionContent

    TransactionContent: EthereumTransaction

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/client_api.TransactionStatusEnum.html b/docs/types/client_api.TransactionStatusEnum.html index 8e7dc6e3..f5be87cd 100644 --- a/docs/types/client_api.TransactionStatusEnum.html +++ b/docs/types/client_api.TransactionStatusEnum.html @@ -1 +1 @@ -TransactionStatusEnum | @coinbase/coinbase-sdk

    Type alias TransactionStatusEnum

    TransactionStatusEnum: typeof TransactionStatusEnum[keyof typeof TransactionStatusEnum]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +TransactionStatusEnum | @coinbase/coinbase-sdk

    Type alias TransactionStatusEnum

    TransactionStatusEnum: typeof TransactionStatusEnum[keyof typeof TransactionStatusEnum]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/client_api.TransferStatusEnum.html b/docs/types/client_api.TransferStatusEnum.html index ab1bce3f..d2354c7f 100644 --- a/docs/types/client_api.TransferStatusEnum.html +++ b/docs/types/client_api.TransferStatusEnum.html @@ -1 +1 @@ -TransferStatusEnum | @coinbase/coinbase-sdk

    Type alias TransferStatusEnum

    TransferStatusEnum: typeof TransferStatusEnum[keyof typeof TransferStatusEnum]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +TransferStatusEnum | @coinbase/coinbase-sdk

    Type alias TransferStatusEnum

    TransferStatusEnum: typeof TransferStatusEnum[keyof typeof TransferStatusEnum]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/client_api.ValidatorDetails.html b/docs/types/client_api.ValidatorDetails.html index f3b61e9c..06c40e1a 100644 --- a/docs/types/client_api.ValidatorDetails.html +++ b/docs/types/client_api.ValidatorDetails.html @@ -1 +1 @@ -ValidatorDetails | @coinbase/coinbase-sdk

    Type alias ValidatorDetails

    ValidatorDetails: EthereumValidatorMetadata

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ValidatorDetails | @coinbase/coinbase-sdk

    Type alias ValidatorDetails

    ValidatorDetails: EthereumValidatorMetadata

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/client_api.WalletServerSignerStatusEnum.html b/docs/types/client_api.WalletServerSignerStatusEnum.html index 588aa564..0638a38f 100644 --- a/docs/types/client_api.WalletServerSignerStatusEnum.html +++ b/docs/types/client_api.WalletServerSignerStatusEnum.html @@ -1 +1 @@ -WalletServerSignerStatusEnum | @coinbase/coinbase-sdk

    Type alias WalletServerSignerStatusEnum

    WalletServerSignerStatusEnum: typeof WalletServerSignerStatusEnum[keyof typeof WalletServerSignerStatusEnum]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +WalletServerSignerStatusEnum | @coinbase/coinbase-sdk

    Type alias WalletServerSignerStatusEnum

    WalletServerSignerStatusEnum: typeof WalletServerSignerStatusEnum[keyof typeof WalletServerSignerStatusEnum]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/client_api.WebhookEventTypeFilter.html b/docs/types/client_api.WebhookEventTypeFilter.html index a5eb1da8..a6fc3eb7 100644 --- a/docs/types/client_api.WebhookEventTypeFilter.html +++ b/docs/types/client_api.WebhookEventTypeFilter.html @@ -1 +1 @@ -WebhookEventTypeFilter | @coinbase/coinbase-sdk

    Type alias WebhookEventTypeFilter

    WebhookEventTypeFilter: WebhookWalletActivityFilter

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +WebhookEventTypeFilter | @coinbase/coinbase-sdk

    Type alias WebhookEventTypeFilter

    WebhookEventTypeFilter: WebhookWalletActivityFilter

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.AddressAPIClient.html b/docs/types/coinbase_types.AddressAPIClient.html index 05e1c5d1..17c9c188 100644 --- a/docs/types/coinbase_types.AddressAPIClient.html +++ b/docs/types/coinbase_types.AddressAPIClient.html @@ -4,47 +4,47 @@
  • Optional createAddressRequest: CreateAddressRequest

    The address creation request.

  • Optional options: AxiosRequestConfig<any>

    Axios request options.

    • Returns AxiosPromise<Address>

    Throws

    If the request fails.

    -
  • createPayloadSignature:function
  • createPayloadSignature:function
    • createPayloadSignature(walletId, addressid, createPayloadSignatureRequest?, options?): AxiosPromise<PayloadSignature>

    • Create a new payload signature with an address.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressid: string
      • Optional createPayloadSignatureRequest: CreatePayloadSignatureRequest
      • Optional options: AxiosRequestConfig<any>

        Axios request options.

      Returns AxiosPromise<PayloadSignature>

      Throws

      If the request fails.

      -
  • getAddress:function
  • getAddress:function
    • getAddress(walletId, addressId, options?): AxiosPromise<Address>

    • Get address by onchain address.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The onchain address of the address that is being fetched.

      • Optional options: AxiosRequestConfig<any>

        Axios request options.

      Returns AxiosPromise<Address>

      Throws

      If the request fails.

      -
  • getAddressBalance:function
  • getAddressBalance:function
    • getAddressBalance(walletId, addressId, assetId, options?): AxiosPromise<Balance>

    • Get address balance

      Parameters

      • walletId: string

        The ID of the wallet to fetch the balance for.

      • addressId: string

        The onchain address of the address that is being fetched.

      • assetId: string

        The symbol of the asset to fetch the balance for.

      • Optional options: AxiosRequestConfig<any>

        Axios request options.

        -

      Returns AxiosPromise<Balance>

      Throws

  • getPayloadSignature:function
    • getPayloadSignature(walletId, addressid, payloadSignatureId, options?): AxiosPromise<PayloadSignature>

    • Get payload signature by the specified payload signature ID.

      +

    • Returns AxiosPromise<Balance>

    Throws

  • getPayloadSignature:function
    • getPayloadSignature(walletId, addressid, payloadSignatureId, options?): AxiosPromise<PayloadSignature>

    • Get payload signature by the specified payload signature ID.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressid: string
      • payloadSignatureId: string

        The ID of the payload signature to fetch.

      • Optional options: AxiosRequestConfig<any>

        Axios request options.

      Returns AxiosPromise<PayloadSignature>

      Throws

      If the request fails.

      -
  • listAddressBalances:function
  • listAddressBalances:function
    • listAddressBalances(walletId, addressId, page?, options?): AxiosPromise<AddressBalanceList>

    • Lists address balances

      Parameters

      • walletId: string

        The ID of the wallet to fetch the balances for.

      • addressId: string

        The onchain address of the address that is being fetched.

      • Optional page: string

        A cursor for pagination across multiple pages of results. Do not include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

      • Optional options: AxiosRequestConfig<any>

        Override http request option.

        -

      Returns AxiosPromise<AddressBalanceList>

      Throws

  • listAddresses:function
    • listAddresses(walletId, limit?, page?, options?): AxiosPromise<AddressList>

    • Lists addresses.

      +

    • Returns AxiosPromise<AddressBalanceList>

    Throws

  • listAddresses:function
    • listAddresses(walletId, limit?, page?, options?): AxiosPromise<AddressList>

    • Lists addresses.

      Parameters

      • walletId: string

        The ID of the wallet the addresses belong to.

      • Optional limit: number

        The maximum number of addresses to return.

      • Optional page: string

        A cursor for pagination across multiple pages of results. Do not include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

      • Optional options: AxiosRequestConfig<any>

        Override http request option.

      Returns AxiosPromise<AddressList>

      Throws

      If the request fails.

      -
  • listPayloadSignatures:function
  • listPayloadSignatures:function
    • listPayloadSignatures(walletId, addressid, limit?, page?, options?): AxiosPromise<PayloadSignatureList>

    • List payload signatures for the specified address.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressid: string
      • Optional limit: number

        A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

      • Optional page: string

        A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

      • Optional options: AxiosRequestConfig<any>

        Axios request options.

      Returns AxiosPromise<PayloadSignatureList>

      Throws

      If the request fails.

      -
  • requestFaucetFunds:function
  • requestFaucetFunds:function
    • requestFaucetFunds(walletId, addressId): AxiosPromise<FaucetTransaction>

    • Requests faucet funds for the address.

      Parameters

      • walletId: string

        The wallet ID.

      • addressId: string

        The address ID.

      Returns AxiosPromise<FaucetTransaction>

      The transaction hash.

      Throws

      If the request fails.

      -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.Amount.html b/docs/types/coinbase_types.Amount.html index bd3932df..4cb1de92 100644 --- a/docs/types/coinbase_types.Amount.html +++ b/docs/types/coinbase_types.Amount.html @@ -1,2 +1,2 @@ Amount | @coinbase/coinbase-sdk

    Type alias Amount

    Amount: number | bigint | Decimal

    Amount type definition.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.ApiClients.html b/docs/types/coinbase_types.ApiClients.html index abf23855..9da743eb 100644 --- a/docs/types/coinbase_types.ApiClients.html +++ b/docs/types/coinbase_types.ApiClients.html @@ -1,3 +1,3 @@ ApiClients | @coinbase/coinbase-sdk

    Type alias ApiClients

    ApiClients: {
        address?: AddressAPIClient;
        asset?: AssetAPIClient;
        balanceHistory?: BalanceHistoryApiClient;
        contractEvent?: ExternalSmartContractAPIClient;
        contractInvocation?: ContractInvocationAPIClient;
        externalAddress?: ExternalAddressAPIClient;
        serverSigner?: ServerSignerAPIClient;
        smartContract?: SmartContractAPIClient;
        stake?: StakeAPIClient;
        trade?: TradeApiClients;
        transactionHistory?: TransactionHistoryApiClient;
        transfer?: TransferAPIClient;
        validator?: ValidatorAPIClient;
        wallet?: WalletAPIClient;
        walletStake?: WalletStakeAPIClient;
        webhook?: WebhookApiClient;
    }

    API clients type definition for the Coinbase SDK. Represents the set of API clients available in the SDK.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.AssetAPIClient.html b/docs/types/coinbase_types.AssetAPIClient.html index a9fd19e3..64f96a5b 100644 --- a/docs/types/coinbase_types.AssetAPIClient.html +++ b/docs/types/coinbase_types.AssetAPIClient.html @@ -4,4 +4,4 @@
  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns AxiosPromise<Asset>

    Summary

    Get the asset for the specified asset ID.

    Throws

    If the required parameter is not provided.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.CoinbaseConfigureFromJsonOptions.html b/docs/types/coinbase_types.CoinbaseConfigureFromJsonOptions.html index f2e0d607..03c95981 100644 --- a/docs/types/coinbase_types.CoinbaseConfigureFromJsonOptions.html +++ b/docs/types/coinbase_types.CoinbaseConfigureFromJsonOptions.html @@ -3,4 +3,4 @@
  • Optional debugging?: boolean

    If true, logs API requests and responses to the console.

  • Optional filePath?: string

    The path to the JSON file containing the API key and private key.

  • Optional useServerSigner?: boolean

    Whether to use a Server-Signer or not.

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.CoinbaseOptions.html b/docs/types/coinbase_types.CoinbaseOptions.html index 0d6ba542..be9a10b9 100644 --- a/docs/types/coinbase_types.CoinbaseOptions.html +++ b/docs/types/coinbase_types.CoinbaseOptions.html @@ -5,4 +5,4 @@
  • Optional maxNetworkRetries?: number

    The maximum number of network retries for the API GET requests.

  • privateKey: string

    The private key associated with the API key.

  • Optional useServerSigner?: boolean

    Whether to use a Server-Signer or not.

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.ContractInvocationAPIClient.html b/docs/types/coinbase_types.ContractInvocationAPIClient.html index 84a50a6e..4859e51c 100644 --- a/docs/types/coinbase_types.ContractInvocationAPIClient.html +++ b/docs/types/coinbase_types.ContractInvocationAPIClient.html @@ -9,7 +9,7 @@
  • A promise resolving to the ContractInvocation model.

    • Throws

    If the request fails.

    -
  • createContractInvocation:function
  • createContractInvocation:function
    • createContractInvocation(walletId, addressId, createContractInvocationRequest, options?): AxiosPromise<ContractInvocation>

    • Creates a Contract Invocation.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The ID of the address the contract invocation belongs to.

      • createContractInvocationRequest: CreateContractInvocationRequest

        The request body.

        @@ -18,7 +18,7 @@
      • A promise resolving to the ContractInvocation model.

      Throws

      If the request fails.

      -
  • getContractInvocation:function
  • getContractInvocation:function
    • getContractInvocation(walletId, addressId, contractInvocationId, options?): AxiosPromise<ContractInvocation>

    • Retrieves a Contract Invocation.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The ID of the address the contract invocation belongs to.

      • contractInvocationId: string

        The ID of the contract invocation to retrieve.

        @@ -27,7 +27,7 @@
      • A promise resolving to the ContractInvocation model.

      Throws

      If the request fails.

      -
  • listContractInvocations:function
  • listContractInvocations:function
    • listContractInvocations(walletId, addressId, limit?, page?, options?): AxiosPromise<ContractInvocationList>

    • Lists Contract Invocations.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The ID of the address the contract invocations belong to.

      • Optional limit: number

        The maximum number of contract invocations to return.

        @@ -37,4 +37,4 @@
      • A promise resolving to the ContractInvocation list.

      Throws

      If the request fails.

      -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.CreateContractInvocationOptions.html b/docs/types/coinbase_types.CreateContractInvocationOptions.html index c2c64ec0..fc954ec8 100644 --- a/docs/types/coinbase_types.CreateContractInvocationOptions.html +++ b/docs/types/coinbase_types.CreateContractInvocationOptions.html @@ -1,2 +1,2 @@ CreateContractInvocationOptions | @coinbase/coinbase-sdk

    Type alias CreateContractInvocationOptions

    CreateContractInvocationOptions: {
        abi?: object;
        amount?: Amount;
        args: object;
        assetId?: string;
        contractAddress: string;
        method: string;
    }

    Options for creating a Contract Invocation.

    -

    Type declaration

    • Optional abi?: object
    • Optional amount?: Amount
    • args: object
    • Optional assetId?: string
    • contractAddress: string
    • method: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    • Optional abi?: object
    • Optional amount?: Amount
    • args: object
    • Optional assetId?: string
    • contractAddress: string
    • method: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.CreateERC1155Options.html b/docs/types/coinbase_types.CreateERC1155Options.html index 07e9bc2d..e47449bb 100644 --- a/docs/types/coinbase_types.CreateERC1155Options.html +++ b/docs/types/coinbase_types.CreateERC1155Options.html @@ -1,2 +1,2 @@ CreateERC1155Options | @coinbase/coinbase-sdk

    Type alias CreateERC1155Options

    CreateERC1155Options: {
        uri: string;
    }

    Options for creating a ERC1155.

    -

    Type declaration

    • uri: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    • uri: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.CreateERC20Options.html b/docs/types/coinbase_types.CreateERC20Options.html index 0039aa2f..53e8f7c4 100644 --- a/docs/types/coinbase_types.CreateERC20Options.html +++ b/docs/types/coinbase_types.CreateERC20Options.html @@ -1,2 +1,2 @@ CreateERC20Options | @coinbase/coinbase-sdk

    Type alias CreateERC20Options

    CreateERC20Options: {
        name: string;
        symbol: string;
        totalSupply: Amount;
    }

    Options for creating a ERC20.

    -

    Type declaration

    • name: string
    • symbol: string
    • totalSupply: Amount

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    • name: string
    • symbol: string
    • totalSupply: Amount

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.CreateERC721Options.html b/docs/types/coinbase_types.CreateERC721Options.html index c5698f4e..fa5979f7 100644 --- a/docs/types/coinbase_types.CreateERC721Options.html +++ b/docs/types/coinbase_types.CreateERC721Options.html @@ -1,2 +1,2 @@ CreateERC721Options | @coinbase/coinbase-sdk

    Type alias CreateERC721Options

    CreateERC721Options: {
        baseURI: string;
        name: string;
        symbol: string;
    }

    Options for creating a ERC721.

    -

    Type declaration

    • baseURI: string
    • name: string
    • symbol: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    • baseURI: string
    • name: string
    • symbol: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.CreateTradeOptions.html b/docs/types/coinbase_types.CreateTradeOptions.html index 12428c8d..21c70d9a 100644 --- a/docs/types/coinbase_types.CreateTradeOptions.html +++ b/docs/types/coinbase_types.CreateTradeOptions.html @@ -1,2 +1,2 @@ CreateTradeOptions | @coinbase/coinbase-sdk

    Type alias CreateTradeOptions

    CreateTradeOptions: {
        amount: Amount;
        fromAssetId: string;
        toAssetId: string;
    }

    Options for creating a Trade.

    -

    Type declaration

    • amount: Amount
    • fromAssetId: string
    • toAssetId: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    • amount: Amount
    • fromAssetId: string
    • toAssetId: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.CreateTransferOptions.html b/docs/types/coinbase_types.CreateTransferOptions.html index 66f001e8..10add06a 100644 --- a/docs/types/coinbase_types.CreateTransferOptions.html +++ b/docs/types/coinbase_types.CreateTransferOptions.html @@ -1,2 +1,2 @@ CreateTransferOptions | @coinbase/coinbase-sdk

    Type alias CreateTransferOptions

    CreateTransferOptions: {
        amount: Amount;
        assetId: string;
        destination: Destination;
        gasless?: boolean;
    }

    Options for creating a Transfer.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.CreateWebhookOptions.html b/docs/types/coinbase_types.CreateWebhookOptions.html index 9c8c18f3..1da7133e 100644 --- a/docs/types/coinbase_types.CreateWebhookOptions.html +++ b/docs/types/coinbase_types.CreateWebhookOptions.html @@ -1,2 +1,2 @@ CreateWebhookOptions | @coinbase/coinbase-sdk

    Type alias CreateWebhookOptions

    CreateWebhookOptions: {
        eventFilters?: WebhookEventFilter[];
        eventType: WebhookEventType;
        eventTypeFilter?: WebhookEventTypeFilter;
        networkId: string;
        notificationUri: string;
        signatureHeader?: string;
    }

    Options for creating a Webhook.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.Destination.html b/docs/types/coinbase_types.Destination.html index 3eb0bd45..70dfeba4 100644 --- a/docs/types/coinbase_types.Destination.html +++ b/docs/types/coinbase_types.Destination.html @@ -1,2 +1,2 @@ Destination | @coinbase/coinbase-sdk

    Type alias Destination

    Destination: string | Address | Wallet

    Destination type definition.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.ExternalAddressAPIClient.html b/docs/types/coinbase_types.ExternalAddressAPIClient.html index efb1013a..18f5b40a 100644 --- a/docs/types/coinbase_types.ExternalAddressAPIClient.html +++ b/docs/types/coinbase_types.ExternalAddressAPIClient.html @@ -5,15 +5,15 @@
  • assetId: string

    The ID of the asset to fetch the balance for

  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns AxiosPromise<Balance>

    Throws

    If the request fails.

    -
  • listExternalAddressBalances:function
  • listExternalAddressBalances:function
    • listExternalAddressBalances(networkId, addressId, page?, options?): AxiosPromise<AddressBalanceList>

    • List all of the balances of an external address

      Parameters

      • networkId: string

        The ID of the blockchain network

      • addressId: string

        The ID of the address to fetch the balance for

      • Optional page: string

        A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<AddressBalanceList>

      Throws

      If the request fails.

      -
  • requestExternalFaucetFunds:function
  • requestExternalFaucetFunds:function
    • requestExternalFaucetFunds(networkId, addressId, assetId?, options?): AxiosPromise<FaucetTransaction>

    • Request faucet funds to be sent to external address.

      Parameters

      • networkId: string

        The ID of the blockchain network

      • addressId: string

        The onchain address of the address that is being fetched.

      • Optional assetId: string
      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<FaucetTransaction>

      Throws

      If the request fails.

      -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.ExternalSmartContractAPIClient.html b/docs/types/coinbase_types.ExternalSmartContractAPIClient.html index 53ca739b..d4f42691 100644 --- a/docs/types/coinbase_types.ExternalSmartContractAPIClient.html +++ b/docs/types/coinbase_types.ExternalSmartContractAPIClient.html @@ -9,4 +9,4 @@
  • toBlockHeight: number

    Upper bound of the block range to query (inclusive)

  • Optional nextPage: string

    Pagination token for retrieving the next set of results

    • Returns AxiosPromise<ContractEventList>

    Throws

    If the request fails.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.ListHistoricalBalancesOptions.html b/docs/types/coinbase_types.ListHistoricalBalancesOptions.html index dcdef42e..c4cf4a7c 100644 --- a/docs/types/coinbase_types.ListHistoricalBalancesOptions.html +++ b/docs/types/coinbase_types.ListHistoricalBalancesOptions.html @@ -1,2 +1,2 @@ ListHistoricalBalancesOptions | @coinbase/coinbase-sdk

    Type alias ListHistoricalBalancesOptions

    ListHistoricalBalancesOptions: {
        assetId: string;
        limit?: number;
        page?: string;
    }

    Options for listing historical balances of an address.

    -

    Type declaration

    • assetId: string
    • Optional limit?: number
    • Optional page?: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    • assetId: string
    • Optional limit?: number
    • Optional page?: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.ListHistoricalBalancesResult.html b/docs/types/coinbase_types.ListHistoricalBalancesResult.html index 8c009593..4d35a7d2 100644 --- a/docs/types/coinbase_types.ListHistoricalBalancesResult.html +++ b/docs/types/coinbase_types.ListHistoricalBalancesResult.html @@ -1,2 +1,2 @@ ListHistoricalBalancesResult | @coinbase/coinbase-sdk

    Type alias ListHistoricalBalancesResult

    ListHistoricalBalancesResult: {
        historicalBalances: HistoricalBalance[];
        nextPageToken: string;
    }

    Result of ListHistoricalBalances.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.ListTransactionsOptions.html b/docs/types/coinbase_types.ListTransactionsOptions.html index 48e24249..330e23b9 100644 --- a/docs/types/coinbase_types.ListTransactionsOptions.html +++ b/docs/types/coinbase_types.ListTransactionsOptions.html @@ -1,2 +1,2 @@ ListTransactionsOptions | @coinbase/coinbase-sdk

    Type alias ListTransactionsOptions

    ListTransactionsOptions: {
        limit?: number;
        page?: string;
    }

    Options for listing transactions of an address.

    -

    Type declaration

    • Optional limit?: number
    • Optional page?: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    • Optional limit?: number
    • Optional page?: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.ListTransactionsResult.html b/docs/types/coinbase_types.ListTransactionsResult.html index 37fe717d..93e4f38c 100644 --- a/docs/types/coinbase_types.ListTransactionsResult.html +++ b/docs/types/coinbase_types.ListTransactionsResult.html @@ -1,2 +1,2 @@ ListTransactionsResult | @coinbase/coinbase-sdk

    Type alias ListTransactionsResult

    ListTransactionsResult: {
        nextPageToken: string;
        transactions: Transaction[];
    }

    Result of ListTransactions.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.MultiTokenContractOptions.html b/docs/types/coinbase_types.MultiTokenContractOptions.html index e91e44c3..0a82d6f5 100644 --- a/docs/types/coinbase_types.MultiTokenContractOptions.html +++ b/docs/types/coinbase_types.MultiTokenContractOptions.html @@ -1,2 +1,2 @@ MultiTokenContractOptions | @coinbase/coinbase-sdk

    Type alias MultiTokenContractOptions

    MultiTokenContractOptions: {
        uri: string;
    }

    Multi-Token Contract Options

    -

    Type declaration

    • uri: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    • uri: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.NFTContractOptions.html b/docs/types/coinbase_types.NFTContractOptions.html index fc3be0e2..f2c147cc 100644 --- a/docs/types/coinbase_types.NFTContractOptions.html +++ b/docs/types/coinbase_types.NFTContractOptions.html @@ -1,2 +1,2 @@ NFTContractOptions | @coinbase/coinbase-sdk

    Type alias NFTContractOptions

    NFTContractOptions: {
        baseURI: string;
        name: string;
        symbol: string;
    }

    NFT Contract Options

    -

    Type declaration

    • baseURI: string
    • name: string
    • symbol: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    • baseURI: string
    • name: string
    • symbol: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.PaginationOptions.html b/docs/types/coinbase_types.PaginationOptions.html index c2caccc0..750418bf 100644 --- a/docs/types/coinbase_types.PaginationOptions.html +++ b/docs/types/coinbase_types.PaginationOptions.html @@ -1,2 +1,2 @@ PaginationOptions | @coinbase/coinbase-sdk

    Type alias PaginationOptions

    PaginationOptions: {
        limit?: number;
        page?: string;
    }

    Options for pagination on list methods.

    -

    Type declaration

    • Optional limit?: number
    • Optional page?: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    • Optional limit?: number
    • Optional page?: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.SeedData.html b/docs/types/coinbase_types.SeedData.html index fa8a8538..0b4897e3 100644 --- a/docs/types/coinbase_types.SeedData.html +++ b/docs/types/coinbase_types.SeedData.html @@ -1,2 +1,2 @@ SeedData | @coinbase/coinbase-sdk

    Type alias SeedData

    SeedData: {
        authTag: string;
        encrypted: boolean;
        iv: string;
        seed: string;
    }

    The Seed Data type definition.

    -

    Type declaration

    • authTag: string
    • encrypted: boolean
    • iv: string
    • seed: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    • authTag: string
    • encrypted: boolean
    • iv: string
    • seed: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.ServerSignerAPIClient.html b/docs/types/coinbase_types.ServerSignerAPIClient.html index 1cedccb8..c0bf8bed 100644 --- a/docs/types/coinbase_types.ServerSignerAPIClient.html +++ b/docs/types/coinbase_types.ServerSignerAPIClient.html @@ -7,4 +7,4 @@
  • A promise resolving to the Server-Signer list.

    • Throws

    If the request fails.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.SmartContractOptions.html b/docs/types/coinbase_types.SmartContractOptions.html index 2c3c790a..b1729351 100644 --- a/docs/types/coinbase_types.SmartContractOptions.html +++ b/docs/types/coinbase_types.SmartContractOptions.html @@ -1,2 +1,2 @@ SmartContractOptions | @coinbase/coinbase-sdk

    Type alias SmartContractOptions

    SmartContractOptions: NFTContractOptions | TokenContractOptions | MultiTokenContractOptions

    Smart Contract Options

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.StakeAPIClient.html b/docs/types/coinbase_types.StakeAPIClient.html index c516142d..9952f9b1 100644 --- a/docs/types/coinbase_types.StakeAPIClient.html +++ b/docs/types/coinbase_types.StakeAPIClient.html @@ -2,7 +2,7 @@

    Parameters

    • buildStakingOperationRequest: BuildStakingOperationRequest

      The request to build a staking operation.

    • Optional options: AxiosRequestConfig<any>

      Axios request options.

    Returns AxiosPromise<StakingOperation>

    Throws

    If the request fails.

    -
  • fetchHistoricalStakingBalances:function
  • fetchHistoricalStakingBalances:function
    • fetchHistoricalStakingBalances(networkId, assetId, addressId, startTime, endTime, limit?, page?, options?): AxiosPromise<FetchHistoricalStakingBalances200Response>

    • Get the staking balances for an address.

      Parameters

      • networkId: string

        The ID of the blockchain network.

      • assetId: string

        The ID of the asset to fetch the staking balances for.

      • addressId: string

        The onchain address to fetch the staking balances for.

        @@ -11,19 +11,19 @@
      • Optional limit: number

        The amount of records to return in a single call.

      • Optional page: string

        The batch of records for a given section in the response.

      • Optional options: AxiosRequestConfig<any>

        Axios request options.

        -

      Returns AxiosPromise<FetchHistoricalStakingBalances200Response>

  • fetchStakingRewards:function
    • fetchStakingRewards(fetchStakingRewardsRequest, limit?, page?, options?): AxiosPromise<FetchStakingRewards200Response>

    • Get the staking rewards for an address.

      +

    • Returns AxiosPromise<FetchHistoricalStakingBalances200Response>

  • fetchStakingRewards:function
    • fetchStakingRewards(fetchStakingRewardsRequest, limit?, page?, options?): AxiosPromise<FetchStakingRewards200Response>

    • Get the staking rewards for an address.

      Parameters

      • fetchStakingRewardsRequest: FetchStakingRewardsRequest

        The request to get the staking rewards for an address.

      • Optional limit: number

        The amount of records to return in a single call.

      • Optional page: string

        The batch of records for a given section in the response.

      • Optional options: AxiosRequestConfig<any>

        Axios request options.

        -

      Returns AxiosPromise<FetchStakingRewards200Response>

  • getExternalStakingOperation:function
    • getExternalStakingOperation(networkId, addressId, stakingOperationID, options?): AxiosPromise<StakingOperation>

    • Get a staking operation.

      +

    • Returns AxiosPromise<FetchStakingRewards200Response>

  • getExternalStakingOperation:function
    • getExternalStakingOperation(networkId, addressId, stakingOperationID, options?): AxiosPromise<StakingOperation>

    • Get a staking operation.

      Parameters

      • networkId: string

        The ID of the blockchain network

      • addressId: string

        The ID of the address the staking operation corresponds to.

      • stakingOperationID: string

        The ID of the staking operation to fetch.

      • Optional options: AxiosRequestConfig<any>

        Axios request options.

      Returns AxiosPromise<StakingOperation>

      Throws

      If the request fails.

      -
  • getStakingContext:function
  • getStakingContext:function
    • getStakingContext(getStakingContextRequest, options?): AxiosPromise<StakingContext>

    • Get staking context for an address.

      Parameters

      • getStakingContextRequest: GetStakingContextRequest

        The request to get the staking context for an address.

      • Optional options: AxiosRequestConfig<any>

        Axios request options.

      Returns AxiosPromise<StakingContext>

      Throws

      If the request fails.

      -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.TokenContractOptions.html b/docs/types/coinbase_types.TokenContractOptions.html index ef80eb8a..b938b295 100644 --- a/docs/types/coinbase_types.TokenContractOptions.html +++ b/docs/types/coinbase_types.TokenContractOptions.html @@ -1,2 +1,2 @@ TokenContractOptions | @coinbase/coinbase-sdk

    Type alias TokenContractOptions

    TokenContractOptions: {
        name: string;
        symbol: string;
        totalSupply: string;
    }

    Token Contract Options

    -

    Type declaration

    • name: string
    • symbol: string
    • totalSupply: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    • name: string
    • symbol: string
    • totalSupply: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.TradeApiClients.html b/docs/types/coinbase_types.TradeApiClients.html index 47d564be..85a7dcb5 100644 --- a/docs/types/coinbase_types.TradeApiClients.html +++ b/docs/types/coinbase_types.TradeApiClients.html @@ -5,23 +5,23 @@
  • broadcastTradeRequest: BroadcastTradeRequest

    The request body.

  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns AxiosPromise<Trade>

    Throws

    If the required parameter is not provided.

    -
  • createTrade:function
  • createTrade:function
    • createTrade(walletId, addressId, createTradeRequest, options?): AxiosPromise<Trade>

    • Create a new trade.

      Parameters

      • walletId: string

        The ID of the wallet the source address belongs to.

      • addressId: string

        The ID of the address to conduct the trade from.

      • createTradeRequest: CreateTradeRequest

        The request body.

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<Trade>

      Throws

      If the required parameter is not provided.

      -
  • getTrade:function
  • getTrade:function
    • getTrade(walletId, addressId, tradeId, options?): AxiosPromise<Trade>

    • Get a trade by ID.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The ID of the address the trade belongs to.

      • tradeId: string

        The ID of the trade to fetch.

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<Trade>

      Throws

      If the required parameter is not provided.

      -
  • listTrades:function
  • listTrades:function
    • listTrades(walletId, addressId, limit?, page?, options?): AxiosPromise<TradeList>

    • List trades for an address.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The ID of the address to list trades for.

      • Optional limit: number

        A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

      • Optional page: string

        A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<TradeList>

      Throws

      If the required parameter is not provided.

      -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.TransferAPIClient.html b/docs/types/coinbase_types.TransferAPIClient.html index 8e907b03..8bc17c41 100644 --- a/docs/types/coinbase_types.TransferAPIClient.html +++ b/docs/types/coinbase_types.TransferAPIClient.html @@ -9,7 +9,7 @@
  • A promise resolving to the Transfer model.

    • Throws

    If the request fails.

    -
  • createTransfer:function
  • createTransfer:function
    • createTransfer(walletId, addressId, createTransferRequest, options?): AxiosPromise<Transfer>

    • Creates a Transfer.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The ID of the address the transfer belongs to.

      • createTransferRequest: CreateTransferRequest

        The request body.

        @@ -18,7 +18,7 @@
      • A promise resolving to the Transfer model.

      Throws

      If the request fails.

      -
  • getTransfer:function
  • getTransfer:function
    • getTransfer(walletId, addressId, transferId, options?): AxiosPromise<Transfer>

    • Retrieves a Transfer.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The ID of the address the transfer belongs to.

      • transferId: string

        The ID of the transfer to retrieve.

        @@ -27,7 +27,7 @@
      • A promise resolving to the Transfer model.

      Throws

      If the request fails.

      -
  • listTransfers:function
  • listTransfers:function
    • listTransfers(walletId, addressId, limit?, page?, options?): AxiosPromise<TransferList>

    • Lists Transfers.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The ID of the address the transfers belong to.

      • Optional limit: number

        The maximum number of transfers to return.

        @@ -37,4 +37,4 @@
      • A promise resolving to the Transfer list.

      Throws

      If the request fails.

      -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.TypedDataDomain.html b/docs/types/coinbase_types.TypedDataDomain.html index f3aec64a..225c31a7 100644 --- a/docs/types/coinbase_types.TypedDataDomain.html +++ b/docs/types/coinbase_types.TypedDataDomain.html @@ -4,4 +4,4 @@
  • Optional salt?: string

    A salt used for purposes decided by the specific domain as a data hex string.

  • Optional verifyingContract?: string

    The the address of the contract that will verify the signature.

  • Optional version?: string

    The major version of the signing domain.

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.TypedDataField.html b/docs/types/coinbase_types.TypedDataField.html index 39e8cf16..1f122a63 100644 --- a/docs/types/coinbase_types.TypedDataField.html +++ b/docs/types/coinbase_types.TypedDataField.html @@ -1,4 +1,4 @@ TypedDataField | @coinbase/coinbase-sdk

    Type alias TypedDataField

    TypedDataField: {
        name: string;
        type: string;
    }

    A specific field of a structured EIP-712 type.

    Type declaration

    • name: string

      The field name.

    • type: string

      The type of the field.

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.UpdateWebhookOptions.html b/docs/types/coinbase_types.UpdateWebhookOptions.html index a6db40cc..575390f8 100644 --- a/docs/types/coinbase_types.UpdateWebhookOptions.html +++ b/docs/types/coinbase_types.UpdateWebhookOptions.html @@ -1,2 +1,2 @@ UpdateWebhookOptions | @coinbase/coinbase-sdk

    Type alias UpdateWebhookOptions

    UpdateWebhookOptions: {
        eventFilters?: WebhookEventFilter[];
        eventTypeFilter?: {
            addresses: string[];
        };
        notificationUri?: string;
    }

    Options for updating a Webhook.

    -

    Type declaration

    • Optional eventFilters?: WebhookEventFilter[]
    • Optional eventTypeFilter?: {
          addresses: string[];
      }
      • addresses: string[]
    • Optional notificationUri?: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.ValidatorAPIClient.html b/docs/types/coinbase_types.ValidatorAPIClient.html index e7907500..512424a7 100644 --- a/docs/types/coinbase_types.ValidatorAPIClient.html +++ b/docs/types/coinbase_types.ValidatorAPIClient.html @@ -3,11 +3,11 @@
  • assetId: string

    The ID of the asset to fetch the validator for.

  • id: string

    The unique publicly identifiable id of the validator for which to fetch the data.

  • Optional options: RawAxiosRequestConfig

    Axios request options.

    -

    • Returns AxiosPromise<Validator>

  • listValidators:function

    Returns AxiosPromise<Validator>

  • listValidators:function

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns AxiosPromise<ValidatorList>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.WalletAPIClient.html b/docs/types/coinbase_types.WalletAPIClient.html index ab285e77..257084de 100644 --- a/docs/types/coinbase_types.WalletAPIClient.html +++ b/docs/types/coinbase_types.WalletAPIClient.html @@ -12,20 +12,20 @@
  • Optional options: RawAxiosRequestConfig

    Override http request option.

    • Returns AxiosPromise<Balance>

    Throws

    If the required parameter is not provided.

    Throws

    If the request fails.

    -
  • listWalletBalances:function
  • listWalletBalances:function
  • listWallets:function
  • listWallets:function

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.WalletCreateOptions.html b/docs/types/coinbase_types.WalletCreateOptions.html index ae481e64..afe1f48e 100644 --- a/docs/types/coinbase_types.WalletCreateOptions.html +++ b/docs/types/coinbase_types.WalletCreateOptions.html @@ -1,2 +1,2 @@ WalletCreateOptions | @coinbase/coinbase-sdk

    Type alias WalletCreateOptions

    WalletCreateOptions: {
        intervalSeconds?: number;
        networkId?: string;
        timeoutSeconds?: number;
    }

    Options for creating a Wallet.

    -

    Type declaration

    • Optional intervalSeconds?: number
    • Optional networkId?: string
    • Optional timeoutSeconds?: number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.WalletData.html b/docs/types/coinbase_types.WalletData.html index 2ce3f21f..1789c656 100644 --- a/docs/types/coinbase_types.WalletData.html +++ b/docs/types/coinbase_types.WalletData.html @@ -1,3 +1,3 @@ WalletData | @coinbase/coinbase-sdk

    Type alias WalletData

    WalletData: {
        seed: string;
        walletId: string;
    }

    The Wallet Data type definition. The data required to recreate a Wallet.

    -

    Type declaration

    • seed: string
    • walletId: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types.WalletStakeAPIClient.html b/docs/types/coinbase_types.WalletStakeAPIClient.html index 345b7338..82b620b2 100644 --- a/docs/types/coinbase_types.WalletStakeAPIClient.html +++ b/docs/types/coinbase_types.WalletStakeAPIClient.html @@ -1 +1 @@ -WalletStakeAPIClient | @coinbase/coinbase-sdk

    Type alias WalletStakeAPIClient

    WalletStakeAPIClient: {
        broadcastStakingOperation(walletId, addressId, stakingOperationId, broadcastStakingOperationRequest, options?): AxiosPromise<StakingOperation>;
        createStakingOperation(walletId, addressId, createStakingOperationRequest, options?): AxiosPromise<StakingOperation>;
        getStakingOperation(walletId, addressId, stakingOperationId, options?): AxiosPromise<StakingOperation>;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +WalletStakeAPIClient | @coinbase/coinbase-sdk

    Type alias WalletStakeAPIClient

    WalletStakeAPIClient: {
        broadcastStakingOperation(walletId, addressId, stakingOperationId, broadcastStakingOperationRequest, options?): AxiosPromise<StakingOperation>;
        createStakingOperation(walletId, addressId, createStakingOperationRequest, options?): AxiosPromise<StakingOperation>;
        getStakingOperation(walletId, addressId, stakingOperationId, options?): AxiosPromise<StakingOperation>;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/coinbase_types_contract.ContractFunctionReturnType.html b/docs/types/coinbase_types_contract.ContractFunctionReturnType.html index 2930cc74..eeeab987 100644 --- a/docs/types/coinbase_types_contract.ContractFunctionReturnType.html +++ b/docs/types/coinbase_types_contract.ContractFunctionReturnType.html @@ -1,4 +1,4 @@ -ContractFunctionReturnType | @coinbase/coinbase-sdk

    Type alias ContractFunctionReturnType<TAbi, TFunctionName, TArgs>

    ContractFunctionReturnType<TAbi, TFunctionName, TArgs>: MatchArgsToFunction<TAbi, TFunctionName, TArgs> extends infer TFunction
        ? TFunction extends AbiFunction
            ? AbiParametersToPrimitiveTypes<TFunction["outputs"]> extends infer TOutputs
                ? TOutputs extends readonly []
                    ? void
                    : TOutputs extends readonly [infer TOutput]
                        ? TOutput
                        : TOutputs
                : never
            : unknown
        : unknown

    Determines the return type of a contract function based on the ABI, function name, and arguments.

    +ContractFunctionReturnType | @coinbase/coinbase-sdk

    Type alias ContractFunctionReturnType<TAbi, TFunctionName, TArgs>

    ContractFunctionReturnType<TAbi, TFunctionName, TArgs>: MatchArgsToFunction<TAbi, TFunctionName, TArgs> extends infer TFunction
        ? TFunction extends AbiFunction
            ? AbiParametersToPrimitiveTypes<TFunction["outputs"]> extends infer TOutputs
                ? TOutputs extends readonly []
                    ? void
                    : TOutputs extends readonly [infer TOutput]
                        ? TOutput
                        : TOutputs
                : any
            : any
        : any

    Determines the return type of a contract function based on the ABI, function name, and arguments.

    Type Parameters

    • TAbi extends Abi

      The ABI of the contract

    • TFunctionName extends ContractFunctionName<TAbi, "view" | "pure">

      The name of the function to call

    • TArgs extends Record<string, string> = {}

      The arguments to pass to the function (optional)

      @@ -9,4 +9,4 @@
    • A tuple of output types if there are multiple outputs
    • unknown if the function or its return type cannot be determined
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/variables/client_api.NetworkProtocolFamilyEnum-1.html b/docs/variables/client_api.NetworkProtocolFamilyEnum-1.html index 9e5d9127..c4a5902a 100644 --- a/docs/variables/client_api.NetworkProtocolFamilyEnum-1.html +++ b/docs/variables/client_api.NetworkProtocolFamilyEnum-1.html @@ -1 +1 @@ -NetworkProtocolFamilyEnum | @coinbase/coinbase-sdk

    Variable NetworkProtocolFamilyEnumConst

    NetworkProtocolFamilyEnum: {
        Evm: "evm";
        Solana: "solana";
    } = ...

    Type declaration

    • Readonly Evm: "evm"
    • Readonly Solana: "solana"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +NetworkProtocolFamilyEnum | @coinbase/coinbase-sdk

    Variable NetworkProtocolFamilyEnumConst

    NetworkProtocolFamilyEnum: {
        Evm: "evm";
        Solana: "solana";
    } = ...

    Type declaration

    • Readonly Evm: "evm"
    • Readonly Solana: "solana"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/variables/client_api.PayloadSignatureStatusEnum-1.html b/docs/variables/client_api.PayloadSignatureStatusEnum-1.html index 0a0c4802..b21c42e0 100644 --- a/docs/variables/client_api.PayloadSignatureStatusEnum-1.html +++ b/docs/variables/client_api.PayloadSignatureStatusEnum-1.html @@ -1 +1 @@ -PayloadSignatureStatusEnum | @coinbase/coinbase-sdk

    Variable PayloadSignatureStatusEnumConst

    PayloadSignatureStatusEnum: {
        Failed: "failed";
        Pending: "pending";
        Signed: "signed";
    } = ...

    Type declaration

    • Readonly Failed: "failed"
    • Readonly Pending: "pending"
    • Readonly Signed: "signed"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +PayloadSignatureStatusEnum | @coinbase/coinbase-sdk

    Variable PayloadSignatureStatusEnumConst

    PayloadSignatureStatusEnum: {
        Failed: "failed";
        Pending: "pending";
        Signed: "signed";
    } = ...

    Type declaration

    • Readonly Failed: "failed"
    • Readonly Pending: "pending"
    • Readonly Signed: "signed"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/variables/client_api.SolidityValueTypeEnum-1.html b/docs/variables/client_api.SolidityValueTypeEnum-1.html index b24f290d..a534896a 100644 --- a/docs/variables/client_api.SolidityValueTypeEnum-1.html +++ b/docs/variables/client_api.SolidityValueTypeEnum-1.html @@ -1 +1 @@ -SolidityValueTypeEnum | @coinbase/coinbase-sdk

    Variable SolidityValueTypeEnumConst

    SolidityValueTypeEnum: {
        Address: "address";
        Array: "array";
        Bool: "bool";
        Bytes: "bytes";
        Bytes1: "bytes1";
        Bytes10: "bytes10";
        Bytes11: "bytes11";
        Bytes12: "bytes12";
        Bytes13: "bytes13";
        Bytes14: "bytes14";
        Bytes15: "bytes15";
        Bytes16: "bytes16";
        Bytes17: "bytes17";
        Bytes18: "bytes18";
        Bytes19: "bytes19";
        Bytes2: "bytes2";
        Bytes20: "bytes20";
        Bytes21: "bytes21";
        Bytes22: "bytes22";
        Bytes23: "bytes23";
        Bytes24: "bytes24";
        Bytes25: "bytes25";
        Bytes26: "bytes26";
        Bytes27: "bytes27";
        Bytes28: "bytes28";
        Bytes29: "bytes29";
        Bytes3: "bytes3";
        Bytes30: "bytes30";
        Bytes31: "bytes31";
        Bytes32: "bytes32";
        Bytes4: "bytes4";
        Bytes5: "bytes5";
        Bytes6: "bytes6";
        Bytes7: "bytes7";
        Bytes8: "bytes8";
        Bytes9: "bytes9";
        Int128: "int128";
        Int16: "int16";
        Int256: "int256";
        Int32: "int32";
        Int64: "int64";
        Int8: "int8";
        String: "string";
        Tuple: "tuple";
        Uint128: "uint128";
        Uint16: "uint16";
        Uint256: "uint256";
        Uint32: "uint32";
        Uint64: "uint64";
        Uint8: "uint8";
    } = ...

    Type declaration

    • Readonly Address: "address"
    • Readonly Array: "array"
    • Readonly Bool: "bool"
    • Readonly Bytes: "bytes"
    • Readonly Bytes1: "bytes1"
    • Readonly Bytes10: "bytes10"
    • Readonly Bytes11: "bytes11"
    • Readonly Bytes12: "bytes12"
    • Readonly Bytes13: "bytes13"
    • Readonly Bytes14: "bytes14"
    • Readonly Bytes15: "bytes15"
    • Readonly Bytes16: "bytes16"
    • Readonly Bytes17: "bytes17"
    • Readonly Bytes18: "bytes18"
    • Readonly Bytes19: "bytes19"
    • Readonly Bytes2: "bytes2"
    • Readonly Bytes20: "bytes20"
    • Readonly Bytes21: "bytes21"
    • Readonly Bytes22: "bytes22"
    • Readonly Bytes23: "bytes23"
    • Readonly Bytes24: "bytes24"
    • Readonly Bytes25: "bytes25"
    • Readonly Bytes26: "bytes26"
    • Readonly Bytes27: "bytes27"
    • Readonly Bytes28: "bytes28"
    • Readonly Bytes29: "bytes29"
    • Readonly Bytes3: "bytes3"
    • Readonly Bytes30: "bytes30"
    • Readonly Bytes31: "bytes31"
    • Readonly Bytes32: "bytes32"
    • Readonly Bytes4: "bytes4"
    • Readonly Bytes5: "bytes5"
    • Readonly Bytes6: "bytes6"
    • Readonly Bytes7: "bytes7"
    • Readonly Bytes8: "bytes8"
    • Readonly Bytes9: "bytes9"
    • Readonly Int128: "int128"
    • Readonly Int16: "int16"
    • Readonly Int256: "int256"
    • Readonly Int32: "int32"
    • Readonly Int64: "int64"
    • Readonly Int8: "int8"
    • Readonly String: "string"
    • Readonly Tuple: "tuple"
    • Readonly Uint128: "uint128"
    • Readonly Uint16: "uint16"
    • Readonly Uint256: "uint256"
    • Readonly Uint32: "uint32"
    • Readonly Uint64: "uint64"
    • Readonly Uint8: "uint8"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +SolidityValueTypeEnum | @coinbase/coinbase-sdk

    Variable SolidityValueTypeEnumConst

    SolidityValueTypeEnum: {
        Address: "address";
        Array: "array";
        Bool: "bool";
        Bytes: "bytes";
        Bytes1: "bytes1";
        Bytes10: "bytes10";
        Bytes11: "bytes11";
        Bytes12: "bytes12";
        Bytes13: "bytes13";
        Bytes14: "bytes14";
        Bytes15: "bytes15";
        Bytes16: "bytes16";
        Bytes17: "bytes17";
        Bytes18: "bytes18";
        Bytes19: "bytes19";
        Bytes2: "bytes2";
        Bytes20: "bytes20";
        Bytes21: "bytes21";
        Bytes22: "bytes22";
        Bytes23: "bytes23";
        Bytes24: "bytes24";
        Bytes25: "bytes25";
        Bytes26: "bytes26";
        Bytes27: "bytes27";
        Bytes28: "bytes28";
        Bytes29: "bytes29";
        Bytes3: "bytes3";
        Bytes30: "bytes30";
        Bytes31: "bytes31";
        Bytes32: "bytes32";
        Bytes4: "bytes4";
        Bytes5: "bytes5";
        Bytes6: "bytes6";
        Bytes7: "bytes7";
        Bytes8: "bytes8";
        Bytes9: "bytes9";
        Int128: "int128";
        Int16: "int16";
        Int256: "int256";
        Int32: "int32";
        Int64: "int64";
        Int8: "int8";
        String: "string";
        Tuple: "tuple";
        Uint128: "uint128";
        Uint16: "uint16";
        Uint256: "uint256";
        Uint32: "uint32";
        Uint64: "uint64";
        Uint8: "uint8";
    } = ...

    Type declaration

    • Readonly Address: "address"
    • Readonly Array: "array"
    • Readonly Bool: "bool"
    • Readonly Bytes: "bytes"
    • Readonly Bytes1: "bytes1"
    • Readonly Bytes10: "bytes10"
    • Readonly Bytes11: "bytes11"
    • Readonly Bytes12: "bytes12"
    • Readonly Bytes13: "bytes13"
    • Readonly Bytes14: "bytes14"
    • Readonly Bytes15: "bytes15"
    • Readonly Bytes16: "bytes16"
    • Readonly Bytes17: "bytes17"
    • Readonly Bytes18: "bytes18"
    • Readonly Bytes19: "bytes19"
    • Readonly Bytes2: "bytes2"
    • Readonly Bytes20: "bytes20"
    • Readonly Bytes21: "bytes21"
    • Readonly Bytes22: "bytes22"
    • Readonly Bytes23: "bytes23"
    • Readonly Bytes24: "bytes24"
    • Readonly Bytes25: "bytes25"
    • Readonly Bytes26: "bytes26"
    • Readonly Bytes27: "bytes27"
    • Readonly Bytes28: "bytes28"
    • Readonly Bytes29: "bytes29"
    • Readonly Bytes3: "bytes3"
    • Readonly Bytes30: "bytes30"
    • Readonly Bytes31: "bytes31"
    • Readonly Bytes32: "bytes32"
    • Readonly Bytes4: "bytes4"
    • Readonly Bytes5: "bytes5"
    • Readonly Bytes6: "bytes6"
    • Readonly Bytes7: "bytes7"
    • Readonly Bytes8: "bytes8"
    • Readonly Bytes9: "bytes9"
    • Readonly Int128: "int128"
    • Readonly Int16: "int16"
    • Readonly Int256: "int256"
    • Readonly Int32: "int32"
    • Readonly Int64: "int64"
    • Readonly Int8: "int8"
    • Readonly String: "string"
    • Readonly Tuple: "tuple"
    • Readonly Uint128: "uint128"
    • Readonly Uint16: "uint16"
    • Readonly Uint256: "uint256"
    • Readonly Uint32: "uint32"
    • Readonly Uint64: "uint64"
    • Readonly Uint8: "uint8"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/variables/client_api.SponsoredSendStatusEnum-1.html b/docs/variables/client_api.SponsoredSendStatusEnum-1.html index 877012ef..ce968820 100644 --- a/docs/variables/client_api.SponsoredSendStatusEnum-1.html +++ b/docs/variables/client_api.SponsoredSendStatusEnum-1.html @@ -1 +1 @@ -SponsoredSendStatusEnum | @coinbase/coinbase-sdk

    Variable SponsoredSendStatusEnumConst

    SponsoredSendStatusEnum: {
        Complete: "complete";
        Failed: "failed";
        Pending: "pending";
        Signed: "signed";
        Submitted: "submitted";
    } = ...

    Type declaration

    • Readonly Complete: "complete"
    • Readonly Failed: "failed"
    • Readonly Pending: "pending"
    • Readonly Signed: "signed"
    • Readonly Submitted: "submitted"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +SponsoredSendStatusEnum | @coinbase/coinbase-sdk

    Variable SponsoredSendStatusEnumConst

    SponsoredSendStatusEnum: {
        Complete: "complete";
        Failed: "failed";
        Pending: "pending";
        Signed: "signed";
        Submitted: "submitted";
    } = ...

    Type declaration

    • Readonly Complete: "complete"
    • Readonly Failed: "failed"
    • Readonly Pending: "pending"
    • Readonly Signed: "signed"
    • Readonly Submitted: "submitted"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/variables/client_api.StakingOperationStatusEnum-1.html b/docs/variables/client_api.StakingOperationStatusEnum-1.html index 8694edf0..930afd22 100644 --- a/docs/variables/client_api.StakingOperationStatusEnum-1.html +++ b/docs/variables/client_api.StakingOperationStatusEnum-1.html @@ -1 +1 @@ -StakingOperationStatusEnum | @coinbase/coinbase-sdk

    Variable StakingOperationStatusEnumConst

    StakingOperationStatusEnum: {
        Complete: "complete";
        Failed: "failed";
        Initialized: "initialized";
        Unspecified: "unspecified";
    } = ...

    Type declaration

    • Readonly Complete: "complete"
    • Readonly Failed: "failed"
    • Readonly Initialized: "initialized"
    • Readonly Unspecified: "unspecified"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +StakingOperationStatusEnum | @coinbase/coinbase-sdk

    Variable StakingOperationStatusEnumConst

    StakingOperationStatusEnum: {
        Complete: "complete";
        Failed: "failed";
        Initialized: "initialized";
        Unspecified: "unspecified";
    } = ...

    Type declaration

    • Readonly Complete: "complete"
    • Readonly Failed: "failed"
    • Readonly Initialized: "initialized"
    • Readonly Unspecified: "unspecified"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/variables/client_api.StakingRewardStateEnum-1.html b/docs/variables/client_api.StakingRewardStateEnum-1.html index bbaa73f2..913ac9f4 100644 --- a/docs/variables/client_api.StakingRewardStateEnum-1.html +++ b/docs/variables/client_api.StakingRewardStateEnum-1.html @@ -1 +1 @@ -StakingRewardStateEnum | @coinbase/coinbase-sdk

    Variable StakingRewardStateEnumConst

    StakingRewardStateEnum: {
        Distributed: "distributed";
        Pending: "pending";
    } = ...

    Type declaration

    • Readonly Distributed: "distributed"
    • Readonly Pending: "pending"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +StakingRewardStateEnum | @coinbase/coinbase-sdk

    Variable StakingRewardStateEnumConst

    StakingRewardStateEnum: {
        Distributed: "distributed";
        Pending: "pending";
    } = ...

    Type declaration

    • Readonly Distributed: "distributed"
    • Readonly Pending: "pending"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/variables/client_api.TransactionStatusEnum-1.html b/docs/variables/client_api.TransactionStatusEnum-1.html index 30a21b30..c5b154ff 100644 --- a/docs/variables/client_api.TransactionStatusEnum-1.html +++ b/docs/variables/client_api.TransactionStatusEnum-1.html @@ -1 +1 @@ -TransactionStatusEnum | @coinbase/coinbase-sdk

    Variable TransactionStatusEnumConst

    TransactionStatusEnum: {
        Broadcast: "broadcast";
        Complete: "complete";
        Failed: "failed";
        Pending: "pending";
        Signed: "signed";
        Unspecified: "unspecified";
    } = ...

    Type declaration

    • Readonly Broadcast: "broadcast"
    • Readonly Complete: "complete"
    • Readonly Failed: "failed"
    • Readonly Pending: "pending"
    • Readonly Signed: "signed"
    • Readonly Unspecified: "unspecified"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +TransactionStatusEnum | @coinbase/coinbase-sdk

    Variable TransactionStatusEnumConst

    TransactionStatusEnum: {
        Broadcast: "broadcast";
        Complete: "complete";
        Failed: "failed";
        Pending: "pending";
        Signed: "signed";
        Unspecified: "unspecified";
    } = ...

    Type declaration

    • Readonly Broadcast: "broadcast"
    • Readonly Complete: "complete"
    • Readonly Failed: "failed"
    • Readonly Pending: "pending"
    • Readonly Signed: "signed"
    • Readonly Unspecified: "unspecified"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/variables/client_api.TransferStatusEnum-1.html b/docs/variables/client_api.TransferStatusEnum-1.html index e0fc7b3b..6fc9cf98 100644 --- a/docs/variables/client_api.TransferStatusEnum-1.html +++ b/docs/variables/client_api.TransferStatusEnum-1.html @@ -1 +1 @@ -TransferStatusEnum | @coinbase/coinbase-sdk

    Variable TransferStatusEnumConst

    TransferStatusEnum: {
        Broadcast: "broadcast";
        Complete: "complete";
        Failed: "failed";
        Pending: "pending";
    } = ...

    Type declaration

    • Readonly Broadcast: "broadcast"
    • Readonly Complete: "complete"
    • Readonly Failed: "failed"
    • Readonly Pending: "pending"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +TransferStatusEnum | @coinbase/coinbase-sdk

    Variable TransferStatusEnumConst

    TransferStatusEnum: {
        Broadcast: "broadcast";
        Complete: "complete";
        Failed: "failed";
        Pending: "pending";
    } = ...

    Type declaration

    • Readonly Broadcast: "broadcast"
    • Readonly Complete: "complete"
    • Readonly Failed: "failed"
    • Readonly Pending: "pending"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/variables/client_api.WalletServerSignerStatusEnum-1.html b/docs/variables/client_api.WalletServerSignerStatusEnum-1.html index 3a701830..b56ace76 100644 --- a/docs/variables/client_api.WalletServerSignerStatusEnum-1.html +++ b/docs/variables/client_api.WalletServerSignerStatusEnum-1.html @@ -1 +1 @@ -WalletServerSignerStatusEnum | @coinbase/coinbase-sdk

    Variable WalletServerSignerStatusEnumConst

    WalletServerSignerStatusEnum: {
        ActiveSeed: "active_seed";
        PendingSeedCreation: "pending_seed_creation";
    } = ...

    Type declaration

    • Readonly ActiveSeed: "active_seed"
    • Readonly PendingSeedCreation: "pending_seed_creation"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +WalletServerSignerStatusEnum | @coinbase/coinbase-sdk

    Variable WalletServerSignerStatusEnumConst

    WalletServerSignerStatusEnum: {
        ActiveSeed: "active_seed";
        PendingSeedCreation: "pending_seed_creation";
    } = ...

    Type declaration

    • Readonly ActiveSeed: "active_seed"
    • Readonly PendingSeedCreation: "pending_seed_creation"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/variables/client_base.BASE_PATH.html b/docs/variables/client_base.BASE_PATH.html index abcd001c..92de27f8 100644 --- a/docs/variables/client_base.BASE_PATH.html +++ b/docs/variables/client_base.BASE_PATH.html @@ -1 +1 @@ -BASE_PATH | @coinbase/coinbase-sdk

    Variable BASE_PATHConst

    BASE_PATH: string = ...

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +BASE_PATH | @coinbase/coinbase-sdk

    Variable BASE_PATHConst

    BASE_PATH: string = ...

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/variables/client_base.COLLECTION_FORMATS.html b/docs/variables/client_base.COLLECTION_FORMATS.html index 7ef5705b..bee65e09 100644 --- a/docs/variables/client_base.COLLECTION_FORMATS.html +++ b/docs/variables/client_base.COLLECTION_FORMATS.html @@ -1 +1 @@ -COLLECTION_FORMATS | @coinbase/coinbase-sdk

    Variable COLLECTION_FORMATSConst

    COLLECTION_FORMATS: {
        csv: string;
        pipes: string;
        ssv: string;
        tsv: string;
    } = ...

    Type declaration

    • csv: string
    • pipes: string
    • ssv: string
    • tsv: string

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +COLLECTION_FORMATS | @coinbase/coinbase-sdk

    Variable COLLECTION_FORMATSConst

    COLLECTION_FORMATS: {
        csv: string;
        pipes: string;
        ssv: string;
        tsv: string;
    } = ...

    Type declaration

    • csv: string
    • pipes: string
    • ssv: string
    • tsv: string

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/variables/client_base.operationServerMap.html b/docs/variables/client_base.operationServerMap.html index 9511b82a..c79356fb 100644 --- a/docs/variables/client_base.operationServerMap.html +++ b/docs/variables/client_base.operationServerMap.html @@ -1 +1 @@ -operationServerMap | @coinbase/coinbase-sdk

    Variable operationServerMapConst

    operationServerMap: ServerMap = {}

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +operationServerMap | @coinbase/coinbase-sdk

    Variable operationServerMapConst

    operationServerMap: ServerMap = {}

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/variables/client_common.DUMMY_BASE_URL.html b/docs/variables/client_common.DUMMY_BASE_URL.html index 8be945fe..acf97923 100644 --- a/docs/variables/client_common.DUMMY_BASE_URL.html +++ b/docs/variables/client_common.DUMMY_BASE_URL.html @@ -1 +1 @@ -DUMMY_BASE_URL | @coinbase/coinbase-sdk

    Variable DUMMY_BASE_URLConst

    DUMMY_BASE_URL: "https://example.com" = 'https://example.com'

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +DUMMY_BASE_URL | @coinbase/coinbase-sdk

    Variable DUMMY_BASE_URLConst

    DUMMY_BASE_URL: "https://example.com" = 'https://example.com'

    Export

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/variables/coinbase_constants.GWEI_DECIMALS.html b/docs/variables/coinbase_constants.GWEI_DECIMALS.html index 5731e829..4a357b5b 100644 --- a/docs/variables/coinbase_constants.GWEI_DECIMALS.html +++ b/docs/variables/coinbase_constants.GWEI_DECIMALS.html @@ -1 +1 @@ -GWEI_DECIMALS | @coinbase/coinbase-sdk

    Variable GWEI_DECIMALSConst

    GWEI_DECIMALS: 9 = 9

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +GWEI_DECIMALS | @coinbase/coinbase-sdk

    Variable GWEI_DECIMALSConst

    GWEI_DECIMALS: 9 = 9

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/package.json b/package.json index fc3c4760..81255375 100644 --- a/package.json +++ b/package.json @@ -4,7 +4,7 @@ "license": "ISC", "description": "Coinbase Platform SDK", "repository": "https://github.com/coinbase/coinbase-sdk-nodejs", - "version": "0.9.0", + "version": "0.9.1", "main": "dist/index.js", "types": "dist/index.d.ts", "scripts": { diff --git a/quickstart-template/package.json b/quickstart-template/package.json index 1fa4b042..43884c1d 100644 --- a/quickstart-template/package.json +++ b/quickstart-template/package.json @@ -22,7 +22,7 @@ "dependencies": { "@solana/web3.js": "^2.0.0-rc.1", "bs58": "^6.0.0", - "@coinbase/coinbase-sdk": "^0.9.0", + "@coinbase/coinbase-sdk": "^0.9.1", "csv-parse": "^5.5.6", "csv-writer": "^1.6.0", "viem": "^2.21.6" diff --git a/src/coinbase/read_contract.ts b/src/coinbase/read_contract.ts index 4cf3fb79..6e5691cb 100644 --- a/src/coinbase/read_contract.ts +++ b/src/coinbase/read_contract.ts @@ -1,3 +1,4 @@ +/* eslint-disable @typescript-eslint/no-explicit-any */ import type { Abi } from "abitype"; import { Coinbase } from "./coinbase"; import { ContractFunctionName } from "viem"; @@ -109,12 +110,12 @@ function parseSolidityValue(solidityValue: SolidityValue): T { * @param {TFunctionName} params.method - The contract method to call. * @param {TArgs} params.args - The arguments for the contract method. * @param {TAbi} [params.abi] - The contract ABI (optional). - * @returns {Promise} The result of the contract call. + * @returns {Promise} The result of the contract call. */ export async function readContract< TAbi extends Abi | undefined, TFunctionName extends TAbi extends Abi ? ContractFunctionName : string, - TArgs extends Record, + TArgs extends Record, >(params: { networkId: string; contractAddress: `0x${string}`; @@ -128,7 +129,7 @@ export async function readContract< Extract>, TArgs > - : unknown + : any > { const response = await Coinbase.apiClients.smartContract!.readContract( params.networkId, @@ -147,6 +148,6 @@ export async function readContract< Extract>, TArgs > - : unknown + : any >(response.data); } diff --git a/src/coinbase/types/contract.ts b/src/coinbase/types/contract.ts index dce02174..4b739d19 100644 --- a/src/coinbase/types/contract.ts +++ b/src/coinbase/types/contract.ts @@ -12,7 +12,7 @@ import { ContractFunctionName } from "viem"; * Each parameter name becomes a key in the resulting dictionary, with a string value. */ type AbiParametersToDictionary = { - [K in T[number]["name"] as K extends string ? K : never]: string; + [K in T[number]["name"] as K extends string ? K : any]: string; }; /** @@ -38,9 +38,9 @@ type MatchArgsToFunction< ? TFunctions extends AbiFunction ? MatchesParams> extends true ? TFunctions - : never - : never - : never; + : any + : any + : any; /** * Determines the return type of a contract function based on the ABI, function name, and arguments. @@ -68,6 +68,6 @@ export type ContractFunctionReturnType< : TOutputs extends readonly [infer TOutput] ? TOutput : TOutputs - : never - : unknown - : unknown; + : any + : any + : any;