From b3a89439e2c585effe1cb439de4ff84936cd2854 Mon Sep 17 00:00:00 2001 From: John Peterson Date: Fri, 31 May 2024 01:00:08 -0400 Subject: [PATCH 1/9] [PSDK-187] Server Signer Support --- src/client/api.ts | 3175 +++++++++++++++++++++++++++++++------- src/client/common.ts | 5 +- src/coinbase/address.ts | 38 +- src/coinbase/coinbase.ts | 14 +- src/coinbase/transfer.ts | 42 +- src/coinbase/types.ts | 16 +- src/coinbase/wallet.ts | 78 +- 7 files changed, 2777 insertions(+), 591 deletions(-) diff --git a/src/client/api.ts b/src/client/api.ts index 3986d439..93f5bc40 100644 --- a/src/client/api.ts +++ b/src/client/api.ts @@ -176,6 +176,19 @@ export interface Balance { */ asset: Asset; } +/** + * + * @export + * @interface BroadcastTradeRequest + */ +export interface BroadcastTradeRequest { + /** + * The hex-encoded signed payload of the trade + * @type {string} + * @memberof BroadcastTradeRequest + */ + signed_payload: string; +} /** * * @export @@ -200,13 +213,57 @@ export interface CreateAddressRequest { * @type {string} * @memberof CreateAddressRequest */ - public_key: string; + public_key?: 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. * @type {string} * @memberof CreateAddressRequest */ - attestation: string; + attestation?: string; +} +/** + * + * @export + * @interface CreateServerSignerRequest + */ +export interface CreateServerSignerRequest { + /** + * The ID of the server signer + * @type {string} + * @memberof CreateServerSignerRequest + */ + server_signer_id: string; + /** + * The enrollment data of the server signer. This will be the base64 encoded server-signer-id. + * @type {string} + * @memberof CreateServerSignerRequest + */ + enrollment_data: string; +} +/** + * + * @export + * @interface CreateTradeRequest + */ +export interface CreateTradeRequest { + /** + * The amount to trade + * @type {string} + * @memberof CreateTradeRequest + */ + amount: string; + /** + * The ID of the asset to trade + * @type {string} + * @memberof CreateTradeRequest + */ + from_asset_id: string; + /** + * The ID of the asset to receive from the trade + * @type {string} + * @memberof CreateTradeRequest + */ + to_asset_id: string; } /** * @@ -247,10 +304,29 @@ export interface CreateTransferRequest { export interface CreateWalletRequest { /** * - * @type {Wallet} + * @type {CreateWalletRequestWallet} * @memberof CreateWalletRequest */ - wallet: Wallet; + wallet: CreateWalletRequestWallet; +} +/** + * Parameters for configuring a wallet + * @export + * @interface CreateWalletRequestWallet + */ +export interface CreateWalletRequestWallet { + /** + * The ID of the blockchain network + * @type {string} + * @memberof CreateWalletRequestWallet + */ + network_id: string; + /** + * 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. + * @type {boolean} + * @memberof CreateWalletRequestWallet + */ + use_server_signer?: boolean; } /** * @@ -285,237 +361,1457 @@ export interface ModelError { message: string; } /** - * A transfer of an asset from one address to another + * An event representing a seed creation. * @export - * @interface Transfer + * @interface SeedCreationEvent */ -export interface Transfer { - /** - * The ID of the blockchain network - * @type {string} - * @memberof Transfer - */ - network_id: string; +export interface SeedCreationEvent { /** - * The ID of the wallet that owns the from address + * The ID of the wallet that the server-signer should create the seed for * @type {string} - * @memberof Transfer + * @memberof SeedCreationEvent */ wallet_id: string; /** - * The onchain address of the sender + * The ID of the user that the wallet belongs to * @type {string} - * @memberof Transfer + * @memberof SeedCreationEvent */ - address_id: string; + wallet_user_id: string; +} +/** + * The result to a SeedCreationEvent. + * @export + * @interface SeedCreationEventResult + */ +export interface SeedCreationEventResult { /** - * The onchain address of the recipient + * The ID of the wallet that the seed was created for * @type {string} - * @memberof Transfer + * @memberof SeedCreationEventResult */ - destination: string; + wallet_id: string; /** - * The amount in the atomic units of the asset + * The ID of the user that the wallet belongs to * @type {string} - * @memberof Transfer + * @memberof SeedCreationEventResult */ - amount: string; + wallet_user_id: string; /** - * The ID of the asset being transferred + * The extended public key for the first master key derived from seed. * @type {string} - * @memberof Transfer + * @memberof SeedCreationEventResult */ - asset_id: string; + extended_public_key: string; /** - * The ID of the transfer + * The ID of the seed in Server-Signer used to generate the extended public key. * @type {string} - * @memberof Transfer + * @memberof SeedCreationEventResult */ - transfer_id: string; + seed_id: string; +} +/** + * A Server-Signer assigned to sign transactions in a wallet. + * @export + * @interface ServerSigner + */ +export interface ServerSigner { /** - * The unsigned payload of the transfer. This is the payload that needs to be signed by the sender. + * The ID of the server-signer * @type {string} - * @memberof Transfer + * @memberof ServerSigner */ - unsigned_payload: string; + server_signer_id: string; /** - * The signed payload of the transfer. This is the payload that has been signed by the sender. - * @type {string} - * @memberof Transfer + * The IDs of the wallets that the server-signer can sign for + * @type {Array} + * @memberof ServerSigner */ - signed_payload?: string; + wallets?: Array; +} +/** + * An event that is waiting to be processed by a Server-Signer. + * @export + * @interface ServerSignerEvent + */ +export interface ServerSignerEvent { /** - * The hash of the transfer transaction + * The ID of the server-signer that the event is for * @type {string} - * @memberof Transfer + * @memberof ServerSignerEvent */ - transaction_hash?: string; + server_signer_id: string; /** - * The status of the transfer - * @type {string} - * @memberof Transfer + * + * @type {ServerSignerEventEvent} + * @memberof ServerSignerEvent */ - status: TransferStatusEnum; + event: ServerSignerEventEvent; } - -export const TransferStatusEnum = { - Pending: "pending", - Broadcast: "broadcast", - Complete: "complete", - Failed: "failed", -} as const; - -export type TransferStatusEnum = (typeof TransferStatusEnum)[keyof typeof TransferStatusEnum]; +/** + * @type ServerSignerEventEvent + * @export + */ +export type ServerSignerEventEvent = SeedCreationEvent | SignatureCreationEvent; /** * * @export - * @interface TransferList + * @interface ServerSignerEventList */ -export interface TransferList { +export interface ServerSignerEventList { /** * - * @type {Array} - * @memberof TransferList + * @type {Array} + * @memberof ServerSignerEventList */ - data: Array; + data: Array; /** * True if this list has another page of items after this one that can be fetched. * @type {boolean} - * @memberof TransferList + * @memberof ServerSignerEventList */ has_more: boolean; /** * The page token to be used to fetch the next page. * @type {string} - * @memberof TransferList + * @memberof ServerSignerEventList */ next_page: string; /** - * The total number of transfers for the address in the wallet. + * The total number of events for the server signer. * @type {number} - * @memberof TransferList + * @memberof ServerSignerEventList */ total_count: number; } /** - * + * An event representing a signature creation. * @export - * @interface User + * @interface SignatureCreationEvent */ -export interface User { +export interface SignatureCreationEvent { /** - * The ID of the user + * The ID of the seed that the server-signer should create the signature for * @type {string} - * @memberof User + * @memberof SignatureCreationEvent */ - id: string; + seed_id: string; + /** + * The ID of the wallet the signature is for + * @type {string} + * @memberof SignatureCreationEvent + */ + wallet_id: string; + /** + * The ID of the user that the wallet belongs to + * @type {string} + * @memberof SignatureCreationEvent + */ + wallet_user_id: string; + /** + * The ID of the address the transfer belongs to + * @type {string} + * @memberof SignatureCreationEvent + */ + address_id: string; + /** + * The index of the address that the server-signer should sign with + * @type {number} + * @memberof SignatureCreationEvent + */ + address_index: number; + /** + * The payload that the server-signer should sign + * @type {string} + * @memberof SignatureCreationEvent + */ + signing_payload: string; /** * + * @type {TransactionType} + * @memberof SignatureCreationEvent + */ + transaction_type: TransactionType; + /** + * The ID of the transaction that the server-signer should sign * @type {string} - * @memberof User + * @memberof SignatureCreationEvent */ - display_name?: string; + transaction_id: string; } + /** - * + * The result to a SignatureCreationEvent. * @export - * @interface Wallet + * @interface SignatureCreationEventResult */ -export interface Wallet { +export interface SignatureCreationEventResult { /** - * The server-assigned ID for the wallet. + * The ID of the wallet that the event was created for. * @type {string} - * @memberof Wallet + * @memberof SignatureCreationEventResult + */ + wallet_id: string; + /** + * The ID of the user that the wallet belongs to + * @type {string} + * @memberof SignatureCreationEventResult */ - id?: string; + wallet_user_id: string; + /** + * The ID of the address the transfer belongs to + * @type {string} + * @memberof SignatureCreationEventResult + */ + address_id: string; + /** + * + * @type {TransactionType} + * @memberof SignatureCreationEventResult + */ + transaction_type: TransactionType; + /** + * The ID of the transaction that the Server-Signer has signed for + * @type {string} + * @memberof SignatureCreationEventResult + */ + transaction_id: string; + /** + * The signature created by the server-signer. + * @type {string} + * @memberof SignatureCreationEventResult + */ + signature: string; +} + +/** + * A trade of an asset to another asset + * @export + * @interface Trade + */ +export interface Trade { /** * The ID of the blockchain network * @type {string} - * @memberof Wallet + * @memberof Trade */ network_id: string; + /** + * The ID of the wallet that owns the from address + * @type {string} + * @memberof Trade + */ + wallet_id: string; + /** + * The onchain address of the sender + * @type {string} + * @memberof Trade + */ + address_id: string; + /** + * The ID of the trade + * @type {string} + * @memberof Trade + */ + trade_id: string; + /** + * The amount of the from asset to be traded (in atomic units of the from asset) + * @type {string} + * @memberof Trade + */ + from_amount: string; /** * - * @type {Address} - * @memberof Wallet + * @type {Asset} + * @memberof Trade */ - default_address?: Address; + from_asset: Asset; + /** + * The amount of the to asset that will be received (in atomic units of the to asset) + * @type {string} + * @memberof Trade + */ + to_amount: string; + /** + * + * @type {Asset} + * @memberof Trade + */ + to_asset: Asset; + /** + * + * @type {Transaction} + * @memberof Trade + */ + transaction: Transaction; } /** - * Paginated list of wallets + * * @export - * @interface WalletList + * @interface TradeList */ -export interface WalletList { +export interface TradeList { /** * - * @type {Array} - * @memberof WalletList + * @type {Array} + * @memberof TradeList */ - data: Array; + data: Array; /** * True if this list has another page of items after this one that can be fetched. * @type {boolean} - * @memberof WalletList + * @memberof TradeList */ has_more: boolean; /** * The page token to be used to fetch the next page. * @type {string} - * @memberof WalletList + * @memberof TradeList */ next_page: string; /** - * The total number of wallets + * The total number of trades for the address in the wallet. * @type {number} - * @memberof WalletList + * @memberof TradeList */ total_count: number; } - /** - * AddressesApi - axios parameter creator + * An onchain transaction. * @export + * @interface Transaction */ -export const AddressesApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a new address scoped to the wallet. - * @summary Create a new address - * @param {string} walletId The ID of the wallet to create the address in. - * @param {CreateAddressRequest} [createAddressRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createAddress: async ( - walletId: string, - createAddressRequest?: CreateAddressRequest, - options: RawAxiosRequestConfig = {}, - ): Promise => { - // verify required parameter 'walletId' is not null or undefined - assertParamExists("createAddress", "walletId", walletId); - const localVarPath = `/v1/wallets/{wallet_id}/addresses`.replace( - `{${"wallet_id"}}`, - encodeURIComponent(String(walletId)), - ); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { - method: "POST", - ...baseOptions, - ...options, - }; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - localVarHeaderParameter["Content-Type"] = "application/json"; - +export interface Transaction { + /** + * The ID of the blockchain network + * @type {string} + * @memberof Transaction + */ + network_id: string; + /** + * The onchain address of the sender + * @type {string} + * @memberof Transaction + */ + from_address_id: string; + /** + * The unsigned payload of the transaction. This is the payload that needs to be signed by the sender. + * @type {string} + * @memberof Transaction + */ + unsigned_payload: string; + /** + * The signed payload of the transaction. This is the payload that has been signed by the sender. + * @type {string} + * @memberof Transaction + */ + signed_payload?: string; + /** + * The hash of the transaction + * @type {string} + * @memberof Transaction + */ + transaction_hash?: string; + /** + * The status of the transaction + * @type {string} + * @memberof Transaction + */ + status: TransactionStatusEnum; +} + +export const TransactionStatusEnum = { + Pending: "pending", + Broadcast: "broadcast", + Complete: "complete", + Failed: "failed", +} as const; + +export type TransactionStatusEnum = + (typeof TransactionStatusEnum)[keyof typeof TransactionStatusEnum]; + +/** + * + * @export + * @enum {string} + */ + +export const TransactionType = { + Transfer: "transfer", +} as const; + +export type TransactionType = (typeof TransactionType)[keyof typeof TransactionType]; + +/** + * A transfer of an asset from one address to another + * @export + * @interface Transfer + */ +export interface Transfer { + /** + * The ID of the blockchain network + * @type {string} + * @memberof Transfer + */ + network_id: string; + /** + * The ID of the wallet that owns the from address + * @type {string} + * @memberof Transfer + */ + wallet_id: string; + /** + * The onchain address of the sender + * @type {string} + * @memberof Transfer + */ + address_id: string; + /** + * The onchain address of the recipient + * @type {string} + * @memberof Transfer + */ + destination: string; + /** + * The amount in the atomic units of the asset + * @type {string} + * @memberof Transfer + */ + amount: string; + /** + * The ID of the asset being transferred + * @type {string} + * @memberof Transfer + */ + asset_id: string; + /** + * The ID of the transfer + * @type {string} + * @memberof Transfer + */ + transfer_id: string; + /** + * The unsigned payload of the transfer. This is the payload that needs to be signed by the sender. + * @type {string} + * @memberof Transfer + */ + unsigned_payload: string; + /** + * The signed payload of the transfer. This is the payload that has been signed by the sender. + * @type {string} + * @memberof Transfer + */ + signed_payload?: string; + /** + * The hash of the transfer transaction + * @type {string} + * @memberof Transfer + */ + transaction_hash?: string; + /** + * The status of the transfer + * @type {string} + * @memberof Transfer + */ + status: TransferStatusEnum; +} + +export const TransferStatusEnum = { + Pending: "pending", + Broadcast: "broadcast", + Complete: "complete", + Failed: "failed", +} as const; + +export type TransferStatusEnum = (typeof TransferStatusEnum)[keyof typeof TransferStatusEnum]; + +/** + * + * @export + * @interface TransferList + */ +export interface TransferList { + /** + * + * @type {Array} + * @memberof TransferList + */ + data: Array; + /** + * True if this list has another page of items after this one that can be fetched. + * @type {boolean} + * @memberof TransferList + */ + has_more: boolean; + /** + * The page token to be used to fetch the next page. + * @type {string} + * @memberof TransferList + */ + next_page: string; + /** + * The total number of transfers for the address in the wallet. + * @type {number} + * @memberof TransferList + */ + total_count: number; +} +/** + * + * @export + * @interface User + */ +export interface User { + /** + * The ID of the user + * @type {string} + * @memberof User + */ + id: string; + /** + * + * @type {string} + * @memberof User + */ + display_name?: string; +} +/** + * + * @export + * @interface Wallet + */ +export interface Wallet { + /** + * The server-assigned ID for the wallet. + * @type {string} + * @memberof Wallet + */ + id: string; + /** + * The ID of the blockchain network + * @type {string} + * @memberof Wallet + */ + network_id: string; + /** + * + * @type {Address} + * @memberof Wallet + */ + default_address?: Address; + /** + * The status of the Server-Signer for the wallet if present. + * @type {string} + * @memberof Wallet + */ + server_signer_status?: WalletServerSignerStatusEnum; +} + +export const WalletServerSignerStatusEnum = { + PendingSeedCreation: "pending_seed_creation", + ActiveSeed: "active_seed", +} as const; + +export type WalletServerSignerStatusEnum = + (typeof WalletServerSignerStatusEnum)[keyof typeof WalletServerSignerStatusEnum]; + +/** + * Paginated list of wallets + * @export + * @interface WalletList + */ +export interface WalletList { + /** + * + * @type {Array} + * @memberof WalletList + */ + data: Array; + /** + * True if this list has another page of items after this one that can be fetched. + * @type {boolean} + * @memberof WalletList + */ + has_more: boolean; + /** + * The page token to be used to fetch the next page. + * @type {string} + * @memberof WalletList + */ + next_page: string; + /** + * The total number of wallets + * @type {number} + * @memberof WalletList + */ + total_count: number; +} + +/** + * AddressesApi - axios parameter creator + * @export + */ +export const AddressesApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Create a new address scoped to the wallet. + * @summary Create a new address + * @param {string} walletId The ID of the wallet to create the address in. + * @param {CreateAddressRequest} [createAddressRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createAddress: async ( + walletId: string, + createAddressRequest?: CreateAddressRequest, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'walletId' is not null or undefined + assertParamExists("createAddress", "walletId", walletId); + const localVarPath = `/v1/wallets/{wallet_id}/addresses`.replace( + `{${"wallet_id"}}`, + encodeURIComponent(String(walletId)), + ); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: "POST", ...baseOptions, ...options }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + localVarHeaderParameter["Content-Type"] = "application/json"; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + localVarRequestOptions.data = serializeDataIfNeeded( + createAddressRequest, + localVarRequestOptions, + configuration, + ); + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get address + * @summary Get address by onchain address + * @param {string} walletId The ID of the wallet the address belongs to. + * @param {string} addressId The onchain address of the address that is being fetched. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getAddress: async ( + walletId: string, + addressId: string, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'walletId' is not null or undefined + assertParamExists("getAddress", "walletId", walletId); + // verify required parameter 'addressId' is not null or undefined + assertParamExists("getAddress", "addressId", addressId); + const localVarPath = `/v1/wallets/{wallet_id}/addresses/{address_id}` + .replace(`{${"wallet_id"}}`, encodeURIComponent(String(walletId))) + .replace(`{${"address_id"}}`, encodeURIComponent(String(addressId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: "GET", ...baseOptions, ...options }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get address balance + * @summary Get address balance for asset + * @param {string} walletId The ID of the wallet to fetch the balance for + * @param {string} addressId The onchain address of the address that is being fetched. + * @param {string} assetId The symbol of the asset to fetch the balance for + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getAddressBalance: async ( + walletId: string, + addressId: string, + assetId: string, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'walletId' is not null or undefined + assertParamExists("getAddressBalance", "walletId", walletId); + // verify required parameter 'addressId' is not null or undefined + assertParamExists("getAddressBalance", "addressId", addressId); + // verify required parameter 'assetId' is not null or undefined + assertParamExists("getAddressBalance", "assetId", assetId); + const localVarPath = `/v1/wallets/{wallet_id}/addresses/{address_id}/balances/{asset_id}` + .replace(`{${"wallet_id"}}`, encodeURIComponent(String(walletId))) + .replace(`{${"address_id"}}`, encodeURIComponent(String(addressId))) + .replace(`{${"asset_id"}}`, encodeURIComponent(String(assetId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: "GET", ...baseOptions, ...options }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get address balances + * @summary Get all balances for address + * @param {string} walletId The ID of the wallet to fetch the balances for + * @param {string} addressId The onchain address of the address that is being fetched. + * @param {string} [page] 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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listAddressBalances: async ( + walletId: string, + addressId: string, + page?: string, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'walletId' is not null or undefined + assertParamExists("listAddressBalances", "walletId", walletId); + // verify required parameter 'addressId' is not null or undefined + assertParamExists("listAddressBalances", "addressId", addressId); + const localVarPath = `/v1/wallets/{wallet_id}/addresses/{address_id}/balances` + .replace(`{${"wallet_id"}}`, encodeURIComponent(String(walletId))) + .replace(`{${"address_id"}}`, encodeURIComponent(String(addressId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: "GET", ...baseOptions, ...options }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (page !== undefined) { + localVarQueryParameter["page"] = page; + } + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * List addresses in the wallet. + * @summary List addresses in a wallet. + * @param {string} walletId The ID of the wallet whose addresses to fetch + * @param {number} [limit] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + * @param {string} [page] 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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listAddresses: async ( + walletId: string, + limit?: number, + page?: string, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'walletId' is not null or undefined + assertParamExists("listAddresses", "walletId", walletId); + const localVarPath = `/v1/wallets/{wallet_id}/addresses`.replace( + `{${"wallet_id"}}`, + encodeURIComponent(String(walletId)), + ); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: "GET", ...baseOptions, ...options }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit; + } + + if (page !== undefined) { + localVarQueryParameter["page"] = page; + } + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Request faucet funds to be sent to onchain address. + * @summary Request faucet funds for onchain address. + * @param {string} walletId The ID of the wallet the address belongs to. + * @param {string} addressId The onchain address of the address that is being fetched. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + requestFaucetFunds: async ( + walletId: string, + addressId: string, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'walletId' is not null or undefined + assertParamExists("requestFaucetFunds", "walletId", walletId); + // verify required parameter 'addressId' is not null or undefined + assertParamExists("requestFaucetFunds", "addressId", addressId); + const localVarPath = `/v1/wallets/{wallet_id}/addresses/{address_id}/faucet` + .replace(`{${"wallet_id"}}`, encodeURIComponent(String(walletId))) + .replace(`{${"address_id"}}`, encodeURIComponent(String(addressId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: "POST", ...baseOptions, ...options }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + }; +}; + +/** + * AddressesApi - functional programming interface + * @export + */ +export const AddressesApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = AddressesApiAxiosParamCreator(configuration); + return { + /** + * Create a new address scoped to the wallet. + * @summary Create a new address + * @param {string} walletId The ID of the wallet to create the address in. + * @param {CreateAddressRequest} [createAddressRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async createAddress( + walletId: string, + createAddressRequest?: CreateAddressRequest, + options?: RawAxiosRequestConfig, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise
> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createAddress( + walletId, + createAddressRequest, + options, + ); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = + operationServerMap["AddressesApi.createAddress"]?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get address + * @summary Get address by onchain address + * @param {string} walletId The ID of the wallet the address belongs to. + * @param {string} addressId The onchain address of the address that is being fetched. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getAddress( + walletId: string, + addressId: string, + options?: RawAxiosRequestConfig, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise
> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAddress( + walletId, + addressId, + options, + ); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = + operationServerMap["AddressesApi.getAddress"]?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get address balance + * @summary Get address balance for asset + * @param {string} walletId The ID of the wallet to fetch the balance for + * @param {string} addressId The onchain address of the address that is being fetched. + * @param {string} assetId The symbol of the asset to fetch the balance for + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getAddressBalance( + walletId: string, + addressId: string, + assetId: string, + options?: RawAxiosRequestConfig, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAddressBalance( + walletId, + addressId, + assetId, + options, + ); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = + operationServerMap["AddressesApi.getAddressBalance"]?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get address balances + * @summary Get all balances for address + * @param {string} walletId The ID of the wallet to fetch the balances for + * @param {string} addressId The onchain address of the address that is being fetched. + * @param {string} [page] 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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async listAddressBalances( + walletId: string, + addressId: string, + page?: string, + options?: RawAxiosRequestConfig, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listAddressBalances( + walletId, + addressId, + page, + options, + ); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = + operationServerMap["AddressesApi.listAddressBalances"]?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, localVarOperationServerBasePath || basePath); + }, + /** + * List addresses in the wallet. + * @summary List addresses in a wallet. + * @param {string} walletId The ID of the wallet whose addresses to fetch + * @param {number} [limit] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + * @param {string} [page] 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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async listAddresses( + walletId: string, + limit?: number, + page?: string, + options?: RawAxiosRequestConfig, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listAddresses( + walletId, + limit, + page, + options, + ); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = + operationServerMap["AddressesApi.listAddresses"]?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Request faucet funds to be sent to onchain address. + * @summary Request faucet funds for onchain address. + * @param {string} walletId The ID of the wallet the address belongs to. + * @param {string} addressId The onchain address of the address that is being fetched. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async requestFaucetFunds( + walletId: string, + addressId: string, + options?: RawAxiosRequestConfig, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.requestFaucetFunds( + walletId, + addressId, + options, + ); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = + operationServerMap["AddressesApi.requestFaucetFunds"]?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, localVarOperationServerBasePath || basePath); + }, + }; +}; + +/** + * AddressesApi - factory interface + * @export + */ +export const AddressesApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = AddressesApiFp(configuration); + return { + /** + * Create a new address scoped to the wallet. + * @summary Create a new address + * @param {string} walletId The ID of the wallet to create the address in. + * @param {CreateAddressRequest} [createAddressRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createAddress( + walletId: string, + createAddressRequest?: CreateAddressRequest, + options?: any, + ): AxiosPromise
{ + return localVarFp + .createAddress(walletId, createAddressRequest, options) + .then(request => request(axios, basePath)); + }, + /** + * Get address + * @summary Get address by onchain address + * @param {string} walletId The ID of the wallet the address belongs to. + * @param {string} addressId The onchain address of the address that is being fetched. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getAddress(walletId: string, addressId: string, options?: any): AxiosPromise
{ + return localVarFp + .getAddress(walletId, addressId, options) + .then(request => request(axios, basePath)); + }, + /** + * Get address balance + * @summary Get address balance for asset + * @param {string} walletId The ID of the wallet to fetch the balance for + * @param {string} addressId The onchain address of the address that is being fetched. + * @param {string} assetId The symbol of the asset to fetch the balance for + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getAddressBalance( + walletId: string, + addressId: string, + assetId: string, + options?: any, + ): AxiosPromise { + return localVarFp + .getAddressBalance(walletId, addressId, assetId, options) + .then(request => request(axios, basePath)); + }, + /** + * Get address balances + * @summary Get all balances for address + * @param {string} walletId The ID of the wallet to fetch the balances for + * @param {string} addressId The onchain address of the address that is being fetched. + * @param {string} [page] 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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listAddressBalances( + walletId: string, + addressId: string, + page?: string, + options?: any, + ): AxiosPromise { + return localVarFp + .listAddressBalances(walletId, addressId, page, options) + .then(request => request(axios, basePath)); + }, + /** + * List addresses in the wallet. + * @summary List addresses in a wallet. + * @param {string} walletId The ID of the wallet whose addresses to fetch + * @param {number} [limit] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + * @param {string} [page] 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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listAddresses( + walletId: string, + limit?: number, + page?: string, + options?: any, + ): AxiosPromise { + return localVarFp + .listAddresses(walletId, limit, page, options) + .then(request => request(axios, basePath)); + }, + /** + * Request faucet funds to be sent to onchain address. + * @summary Request faucet funds for onchain address. + * @param {string} walletId The ID of the wallet the address belongs to. + * @param {string} addressId The onchain address of the address that is being fetched. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + requestFaucetFunds( + walletId: string, + addressId: string, + options?: any, + ): AxiosPromise { + return localVarFp + .requestFaucetFunds(walletId, addressId, options) + .then(request => request(axios, basePath)); + }, + }; +}; + +/** + * AddressesApi - interface + * @export + * @interface AddressesApi + */ +export interface AddressesApiInterface { + /** + * Create a new address scoped to the wallet. + * @summary Create a new address + * @param {string} walletId The ID of the wallet to create the address in. + * @param {CreateAddressRequest} [createAddressRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof AddressesApiInterface + */ + createAddress( + walletId: string, + createAddressRequest?: CreateAddressRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise
; + + /** + * Get address + * @summary Get address by onchain address + * @param {string} walletId The ID of the wallet the address belongs to. + * @param {string} addressId The onchain address of the address that is being fetched. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof AddressesApiInterface + */ + getAddress( + walletId: string, + addressId: string, + options?: RawAxiosRequestConfig, + ): AxiosPromise
; + + /** + * Get address balance + * @summary Get address balance for asset + * @param {string} walletId The ID of the wallet to fetch the balance for + * @param {string} addressId The onchain address of the address that is being fetched. + * @param {string} assetId The symbol of the asset to fetch the balance for + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof AddressesApiInterface + */ + getAddressBalance( + walletId: string, + addressId: string, + assetId: string, + options?: RawAxiosRequestConfig, + ): AxiosPromise; + + /** + * Get address balances + * @summary Get all balances for address + * @param {string} walletId The ID of the wallet to fetch the balances for + * @param {string} addressId The onchain address of the address that is being fetched. + * @param {string} [page] 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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof AddressesApiInterface + */ + listAddressBalances( + walletId: string, + addressId: string, + page?: string, + options?: RawAxiosRequestConfig, + ): AxiosPromise; + + /** + * List addresses in the wallet. + * @summary List addresses in a wallet. + * @param {string} walletId The ID of the wallet whose addresses to fetch + * @param {number} [limit] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + * @param {string} [page] 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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof AddressesApiInterface + */ + listAddresses( + walletId: string, + limit?: number, + page?: string, + options?: RawAxiosRequestConfig, + ): AxiosPromise; + + /** + * Request faucet funds to be sent to onchain address. + * @summary Request faucet funds for onchain address. + * @param {string} walletId The ID of the wallet the address belongs to. + * @param {string} addressId The onchain address of the address that is being fetched. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof AddressesApiInterface + */ + requestFaucetFunds( + walletId: string, + addressId: string, + options?: RawAxiosRequestConfig, + ): AxiosPromise; +} + +/** + * AddressesApi - object-oriented interface + * @export + * @class AddressesApi + * @extends {BaseAPI} + */ +export class AddressesApi extends BaseAPI implements AddressesApiInterface { + /** + * Create a new address scoped to the wallet. + * @summary Create a new address + * @param {string} walletId The ID of the wallet to create the address in. + * @param {CreateAddressRequest} [createAddressRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof AddressesApi + */ + public createAddress( + walletId: string, + createAddressRequest?: CreateAddressRequest, + options?: RawAxiosRequestConfig, + ) { + return AddressesApiFp(this.configuration) + .createAddress(walletId, createAddressRequest, options) + .then(request => request(this.axios, this.basePath)); + } + + /** + * Get address + * @summary Get address by onchain address + * @param {string} walletId The ID of the wallet the address belongs to. + * @param {string} addressId The onchain address of the address that is being fetched. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof AddressesApi + */ + public getAddress(walletId: string, addressId: string, options?: RawAxiosRequestConfig) { + return AddressesApiFp(this.configuration) + .getAddress(walletId, addressId, options) + .then(request => request(this.axios, this.basePath)); + } + + /** + * Get address balance + * @summary Get address balance for asset + * @param {string} walletId The ID of the wallet to fetch the balance for + * @param {string} addressId The onchain address of the address that is being fetched. + * @param {string} assetId The symbol of the asset to fetch the balance for + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof AddressesApi + */ + public getAddressBalance( + walletId: string, + addressId: string, + assetId: string, + options?: RawAxiosRequestConfig, + ) { + return AddressesApiFp(this.configuration) + .getAddressBalance(walletId, addressId, assetId, options) + .then(request => request(this.axios, this.basePath)); + } + + /** + * Get address balances + * @summary Get all balances for address + * @param {string} walletId The ID of the wallet to fetch the balances for + * @param {string} addressId The onchain address of the address that is being fetched. + * @param {string} [page] 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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof AddressesApi + */ + public listAddressBalances( + walletId: string, + addressId: string, + page?: string, + options?: RawAxiosRequestConfig, + ) { + return AddressesApiFp(this.configuration) + .listAddressBalances(walletId, addressId, page, options) + .then(request => request(this.axios, this.basePath)); + } + + /** + * List addresses in the wallet. + * @summary List addresses in a wallet. + * @param {string} walletId The ID of the wallet whose addresses to fetch + * @param {number} [limit] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + * @param {string} [page] 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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof AddressesApi + */ + public listAddresses( + walletId: string, + limit?: number, + page?: string, + options?: RawAxiosRequestConfig, + ) { + return AddressesApiFp(this.configuration) + .listAddresses(walletId, limit, page, options) + .then(request => request(this.axios, this.basePath)); + } + + /** + * Request faucet funds to be sent to onchain address. + * @summary Request faucet funds for onchain address. + * @param {string} walletId The ID of the wallet the address belongs to. + * @param {string} addressId The onchain address of the address that is being fetched. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof AddressesApi + */ + public requestFaucetFunds(walletId: string, addressId: string, options?: RawAxiosRequestConfig) { + return AddressesApiFp(this.configuration) + .requestFaucetFunds(walletId, addressId, options) + .then(request => request(this.axios, this.basePath)); + } +} + +/** + * ServerSignersApi - axios parameter creator + * @export + */ +export const ServerSignersApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Create a new Server-Signer + * @summary Create a new Server-Signer + * @param {CreateServerSignerRequest} [createServerSignerRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createServerSigner: async ( + createServerSignerRequest?: CreateServerSignerRequest, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/v1/server_signers`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: "POST", ...baseOptions, ...options }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + localVarHeaderParameter["Content-Type"] = "application/json"; + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { @@ -524,89 +1820,774 @@ export const AddressesApiAxiosParamCreator = function (configuration?: Configura ...options.headers, }; localVarRequestOptions.data = serializeDataIfNeeded( - createAddressRequest, + createServerSignerRequest, + localVarRequestOptions, + configuration, + ); + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get a server signer by ID + * @summary Get a server signer by ID + * @param {string} serverSignerId The ID of the server signer to fetch + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getServerSigner: async ( + serverSignerId: string, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'serverSignerId' is not null or undefined + assertParamExists("getServerSigner", "serverSignerId", serverSignerId); + const localVarPath = `/v1/server_signers/{server_signer_id}`.replace( + `{${"server_signer_id"}}`, + encodeURIComponent(String(serverSignerId)), + ); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: "GET", ...baseOptions, ...options }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * List events for a server signer + * @summary List events for a server signer + * @param {string} serverSignerId The ID of the server signer to fetch events for + * @param {number} [limit] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + * @param {string} [page] 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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listServerSignerEvents: async ( + serverSignerId: string, + limit?: number, + page?: string, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'serverSignerId' is not null or undefined + assertParamExists("listServerSignerEvents", "serverSignerId", serverSignerId); + const localVarPath = `/v1/server_signers/{server_signer_id}/events`.replace( + `{${"server_signer_id"}}`, + encodeURIComponent(String(serverSignerId)), + ); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: "GET", ...baseOptions, ...options }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit; + } + + if (page !== undefined) { + localVarQueryParameter["page"] = page; + } + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * List server signers for the current project + * @summary List server signers for the current project + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listServerSigners: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/v1/server_signers`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: "GET", ...baseOptions, ...options }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Submit the result of a server signer event + * @summary Submit the result of a server signer event + * @param {string} serverSignerId The ID of the server signer to submit the event result for + * @param {SeedCreationEventResult} [seedCreationEventResult] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + submitServerSignerSeedEventResult: async ( + serverSignerId: string, + seedCreationEventResult?: SeedCreationEventResult, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'serverSignerId' is not null or undefined + assertParamExists("submitServerSignerSeedEventResult", "serverSignerId", serverSignerId); + const localVarPath = `/v1/server_signers/{server_signer_id}/seed_event_result`.replace( + `{${"server_signer_id"}}`, + encodeURIComponent(String(serverSignerId)), + ); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: "POST", ...baseOptions, ...options }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + localVarHeaderParameter["Content-Type"] = "application/json"; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + localVarRequestOptions.data = serializeDataIfNeeded( + seedCreationEventResult, + localVarRequestOptions, + configuration, + ); + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Submit the result of a server signer event + * @summary Submit the result of a server signer event + * @param {string} serverSignerId The ID of the server signer to submit the event result for + * @param {SignatureCreationEventResult} [signatureCreationEventResult] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + submitServerSignerSignatureEventResult: async ( + serverSignerId: string, + signatureCreationEventResult?: SignatureCreationEventResult, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'serverSignerId' is not null or undefined + assertParamExists("submitServerSignerSignatureEventResult", "serverSignerId", serverSignerId); + const localVarPath = `/v1/server_signers/{server_signer_id}/signature_event_result`.replace( + `{${"server_signer_id"}}`, + encodeURIComponent(String(serverSignerId)), + ); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: "POST", ...baseOptions, ...options }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + localVarHeaderParameter["Content-Type"] = "application/json"; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + localVarRequestOptions.data = serializeDataIfNeeded( + signatureCreationEventResult, localVarRequestOptions, configuration, ); - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + }; +}; + +/** + * ServerSignersApi - functional programming interface + * @export + */ +export const ServerSignersApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = ServerSignersApiAxiosParamCreator(configuration); + return { + /** + * Create a new Server-Signer + * @summary Create a new Server-Signer + * @param {CreateServerSignerRequest} [createServerSignerRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async createServerSigner( + createServerSignerRequest?: CreateServerSignerRequest, + options?: RawAxiosRequestConfig, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createServerSigner( + createServerSignerRequest, + options, + ); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = + operationServerMap["ServerSignersApi.createServerSigner"]?.[localVarOperationServerIndex] + ?.url; + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get a server signer by ID + * @summary Get a server signer by ID + * @param {string} serverSignerId The ID of the server signer to fetch + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getServerSigner( + serverSignerId: string, + options?: RawAxiosRequestConfig, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getServerSigner( + serverSignerId, + options, + ); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = + operationServerMap["ServerSignersApi.getServerSigner"]?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, localVarOperationServerBasePath || basePath); + }, + /** + * List events for a server signer + * @summary List events for a server signer + * @param {string} serverSignerId The ID of the server signer to fetch events for + * @param {number} [limit] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + * @param {string} [page] 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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async listServerSignerEvents( + serverSignerId: string, + limit?: number, + page?: string, + options?: RawAxiosRequestConfig, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listServerSignerEvents( + serverSignerId, + limit, + page, + options, + ); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = + operationServerMap["ServerSignersApi.listServerSignerEvents"]?.[ + localVarOperationServerIndex + ]?.url; + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, localVarOperationServerBasePath || basePath); + }, + /** + * List server signers for the current project + * @summary List server signers for the current project + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async listServerSigners( + options?: RawAxiosRequestConfig, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listServerSigners(options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = + operationServerMap["ServerSignersApi.listServerSigners"]?.[localVarOperationServerIndex] + ?.url; + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Submit the result of a server signer event + * @summary Submit the result of a server signer event + * @param {string} serverSignerId The ID of the server signer to submit the event result for + * @param {SeedCreationEventResult} [seedCreationEventResult] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async submitServerSignerSeedEventResult( + serverSignerId: string, + seedCreationEventResult?: SeedCreationEventResult, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.submitServerSignerSeedEventResult( + serverSignerId, + seedCreationEventResult, + options, + ); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = + operationServerMap["ServerSignersApi.submitServerSignerSeedEventResult"]?.[ + localVarOperationServerIndex + ]?.url; + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Submit the result of a server signer event + * @summary Submit the result of a server signer event + * @param {string} serverSignerId The ID of the server signer to submit the event result for + * @param {SignatureCreationEventResult} [signatureCreationEventResult] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async submitServerSignerSignatureEventResult( + serverSignerId: string, + signatureCreationEventResult?: SignatureCreationEventResult, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.submitServerSignerSignatureEventResult( + serverSignerId, + signatureCreationEventResult, + options, + ); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = + operationServerMap["ServerSignersApi.submitServerSignerSignatureEventResult"]?.[ + localVarOperationServerIndex + ]?.url; + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, localVarOperationServerBasePath || basePath); + }, + }; +}; + +/** + * ServerSignersApi - factory interface + * @export + */ +export const ServerSignersApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = ServerSignersApiFp(configuration); + return { + /** + * Create a new Server-Signer + * @summary Create a new Server-Signer + * @param {CreateServerSignerRequest} [createServerSignerRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createServerSigner( + createServerSignerRequest?: CreateServerSignerRequest, + options?: any, + ): AxiosPromise { + return localVarFp + .createServerSigner(createServerSignerRequest, options) + .then(request => request(axios, basePath)); }, /** - * Get address - * @summary Get address by onchain address - * @param {string} walletId The ID of the wallet the address belongs to. - * @param {string} addressId The onchain address of the address that is being fetched. + * Get a server signer by ID + * @summary Get a server signer by ID + * @param {string} serverSignerId The ID of the server signer to fetch * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getAddress: async ( - walletId: string, - addressId: string, - options: RawAxiosRequestConfig = {}, - ): Promise => { - // verify required parameter 'walletId' is not null or undefined - assertParamExists("getAddress", "walletId", walletId); - // verify required parameter 'addressId' is not null or undefined - assertParamExists("getAddress", "addressId", addressId); - const localVarPath = `/v1/wallets/{wallet_id}/addresses/{address_id}` - .replace(`{${"wallet_id"}}`, encodeURIComponent(String(walletId))) - .replace(`{${"address_id"}}`, encodeURIComponent(String(addressId))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } + getServerSigner(serverSignerId: string, options?: any): AxiosPromise { + return localVarFp + .getServerSigner(serverSignerId, options) + .then(request => request(axios, basePath)); + }, + /** + * List events for a server signer + * @summary List events for a server signer + * @param {string} serverSignerId The ID of the server signer to fetch events for + * @param {number} [limit] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + * @param {string} [page] 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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listServerSignerEvents( + serverSignerId: string, + limit?: number, + page?: string, + options?: any, + ): AxiosPromise { + return localVarFp + .listServerSignerEvents(serverSignerId, limit, page, options) + .then(request => request(axios, basePath)); + }, + /** + * List server signers for the current project + * @summary List server signers for the current project + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listServerSigners(options?: any): AxiosPromise { + return localVarFp.listServerSigners(options).then(request => request(axios, basePath)); + }, + /** + * Submit the result of a server signer event + * @summary Submit the result of a server signer event + * @param {string} serverSignerId The ID of the server signer to submit the event result for + * @param {SeedCreationEventResult} [seedCreationEventResult] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + submitServerSignerSeedEventResult( + serverSignerId: string, + seedCreationEventResult?: SeedCreationEventResult, + options?: any, + ): AxiosPromise { + return localVarFp + .submitServerSignerSeedEventResult(serverSignerId, seedCreationEventResult, options) + .then(request => request(axios, basePath)); + }, + /** + * Submit the result of a server signer event + * @summary Submit the result of a server signer event + * @param {string} serverSignerId The ID of the server signer to submit the event result for + * @param {SignatureCreationEventResult} [signatureCreationEventResult] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + submitServerSignerSignatureEventResult( + serverSignerId: string, + signatureCreationEventResult?: SignatureCreationEventResult, + options?: any, + ): AxiosPromise { + return localVarFp + .submitServerSignerSignatureEventResult( + serverSignerId, + signatureCreationEventResult, + options, + ) + .then(request => request(axios, basePath)); + }, + }; +}; - const localVarRequestOptions = { - method: "GET", - ...baseOptions, - ...options, - }; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; +/** + * ServerSignersApi - interface + * @export + * @interface ServerSignersApi + */ +export interface ServerSignersApiInterface { + /** + * Create a new Server-Signer + * @summary Create a new Server-Signer + * @param {CreateServerSignerRequest} [createServerSignerRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ServerSignersApiInterface + */ + createServerSigner( + createServerSignerRequest?: CreateServerSignerRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise; - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = { - ...localVarHeaderParameter, - ...headersFromBaseOptions, - ...options.headers, - }; + /** + * Get a server signer by ID + * @summary Get a server signer by ID + * @param {string} serverSignerId The ID of the server signer to fetch + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ServerSignersApiInterface + */ + getServerSigner( + serverSignerId: string, + options?: RawAxiosRequestConfig, + ): AxiosPromise; - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, + /** + * List events for a server signer + * @summary List events for a server signer + * @param {string} serverSignerId The ID of the server signer to fetch events for + * @param {number} [limit] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + * @param {string} [page] 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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ServerSignersApiInterface + */ + listServerSignerEvents( + serverSignerId: string, + limit?: number, + page?: string, + options?: RawAxiosRequestConfig, + ): AxiosPromise; + + /** + * List server signers for the current project + * @summary List server signers for the current project + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ServerSignersApiInterface + */ + listServerSigners(options?: RawAxiosRequestConfig): AxiosPromise; + + /** + * Submit the result of a server signer event + * @summary Submit the result of a server signer event + * @param {string} serverSignerId The ID of the server signer to submit the event result for + * @param {SeedCreationEventResult} [seedCreationEventResult] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ServerSignersApiInterface + */ + submitServerSignerSeedEventResult( + serverSignerId: string, + seedCreationEventResult?: SeedCreationEventResult, + options?: RawAxiosRequestConfig, + ): AxiosPromise; + + /** + * Submit the result of a server signer event + * @summary Submit the result of a server signer event + * @param {string} serverSignerId The ID of the server signer to submit the event result for + * @param {SignatureCreationEventResult} [signatureCreationEventResult] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ServerSignersApiInterface + */ + submitServerSignerSignatureEventResult( + serverSignerId: string, + signatureCreationEventResult?: SignatureCreationEventResult, + options?: RawAxiosRequestConfig, + ): AxiosPromise; +} + +/** + * ServerSignersApi - object-oriented interface + * @export + * @class ServerSignersApi + * @extends {BaseAPI} + */ +export class ServerSignersApi extends BaseAPI implements ServerSignersApiInterface { + /** + * Create a new Server-Signer + * @summary Create a new Server-Signer + * @param {CreateServerSignerRequest} [createServerSignerRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ServerSignersApi + */ + public createServerSigner( + createServerSignerRequest?: CreateServerSignerRequest, + options?: RawAxiosRequestConfig, + ) { + return ServerSignersApiFp(this.configuration) + .createServerSigner(createServerSignerRequest, options) + .then(request => request(this.axios, this.basePath)); + } + + /** + * Get a server signer by ID + * @summary Get a server signer by ID + * @param {string} serverSignerId The ID of the server signer to fetch + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ServerSignersApi + */ + public getServerSigner(serverSignerId: string, options?: RawAxiosRequestConfig) { + return ServerSignersApiFp(this.configuration) + .getServerSigner(serverSignerId, options) + .then(request => request(this.axios, this.basePath)); + } + + /** + * List events for a server signer + * @summary List events for a server signer + * @param {string} serverSignerId The ID of the server signer to fetch events for + * @param {number} [limit] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + * @param {string} [page] 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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ServerSignersApi + */ + public listServerSignerEvents( + serverSignerId: string, + limit?: number, + page?: string, + options?: RawAxiosRequestConfig, + ) { + return ServerSignersApiFp(this.configuration) + .listServerSignerEvents(serverSignerId, limit, page, options) + .then(request => request(this.axios, this.basePath)); + } + + /** + * List server signers for the current project + * @summary List server signers for the current project + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ServerSignersApi + */ + public listServerSigners(options?: RawAxiosRequestConfig) { + return ServerSignersApiFp(this.configuration) + .listServerSigners(options) + .then(request => request(this.axios, this.basePath)); + } + + /** + * Submit the result of a server signer event + * @summary Submit the result of a server signer event + * @param {string} serverSignerId The ID of the server signer to submit the event result for + * @param {SeedCreationEventResult} [seedCreationEventResult] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ServerSignersApi + */ + public submitServerSignerSeedEventResult( + serverSignerId: string, + seedCreationEventResult?: SeedCreationEventResult, + options?: RawAxiosRequestConfig, + ) { + return ServerSignersApiFp(this.configuration) + .submitServerSignerSeedEventResult(serverSignerId, seedCreationEventResult, options) + .then(request => request(this.axios, this.basePath)); + } + + /** + * Submit the result of a server signer event + * @summary Submit the result of a server signer event + * @param {string} serverSignerId The ID of the server signer to submit the event result for + * @param {SignatureCreationEventResult} [signatureCreationEventResult] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ServerSignersApi + */ + public submitServerSignerSignatureEventResult( + serverSignerId: string, + signatureCreationEventResult?: SignatureCreationEventResult, + options?: RawAxiosRequestConfig, + ) { + return ServerSignersApiFp(this.configuration) + .submitServerSignerSignatureEventResult(serverSignerId, signatureCreationEventResult, options) + .then(request => request(this.axios, this.basePath)); + } +} + +/** + * TradesApi - axios parameter creator + * @export + */ +export const TradesApiAxiosParamCreator = function (configuration?: Configuration) { + return { /** - * Get address balance - * @summary Get address balance for asset - * @param {string} walletId The ID of the wallet to fetch the balance for - * @param {string} addressId The onchain address of the address that is being fetched. - * @param {string} assetId The symbol of the asset to fetch the balance for + * Broadcast a trade + * @summary Broadcast a trade + * @param {string} walletId The ID of the wallet the address belongs to + * @param {string} addressId The ID of the address the trade belongs to + * @param {string} tradeId The ID of the trade to broadcast + * @param {BroadcastTradeRequest} broadcastTradeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getAddressBalance: async ( + broadcastTrade: async ( walletId: string, addressId: string, - assetId: string, - options: RawAxiosRequestConfig = {}, - ): Promise => { - // verify required parameter 'walletId' is not null or undefined - assertParamExists("getAddressBalance", "walletId", walletId); - // verify required parameter 'addressId' is not null or undefined - assertParamExists("getAddressBalance", "addressId", addressId); - // verify required parameter 'assetId' is not null or undefined - assertParamExists("getAddressBalance", "assetId", assetId); - const localVarPath = `/v1/wallets/{wallet_id}/addresses/{address_id}/balances/{asset_id}` - .replace(`{${"wallet_id"}}`, encodeURIComponent(String(walletId))) - .replace(`{${"address_id"}}`, encodeURIComponent(String(addressId))) - .replace(`{${"asset_id"}}`, encodeURIComponent(String(assetId))); + tradeId: string, + broadcastTradeRequest: BroadcastTradeRequest, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'walletId' is not null or undefined + assertParamExists("broadcastTrade", "walletId", walletId); + // verify required parameter 'addressId' is not null or undefined + assertParamExists("broadcastTrade", "addressId", addressId); + // verify required parameter 'tradeId' is not null or undefined + assertParamExists("broadcastTrade", "tradeId", tradeId); + // verify required parameter 'broadcastTradeRequest' is not null or undefined + assertParamExists("broadcastTrade", "broadcastTradeRequest", broadcastTradeRequest); + const localVarPath = + `/v1/wallets/{wallet_id}/addresses/{address_id}/trades/{trade_id}/broadcast` + .replace(`{${"wallet_id"}}`, encodeURIComponent(String(walletId))) + .replace(`{${"address_id"}}`, encodeURIComponent(String(addressId))) + .replace(`{${"trade_id"}}`, encodeURIComponent(String(tradeId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -614,14 +2595,12 @@ export const AddressesApiAxiosParamCreator = function (configuration?: Configura baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { - method: "GET", - ...baseOptions, - ...options, - }; + const localVarRequestOptions = { method: "POST", ...baseOptions, ...options }; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; + localVarHeaderParameter["Content-Type"] = "application/json"; + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { @@ -629,6 +2608,11 @@ export const AddressesApiAxiosParamCreator = function (configuration?: Configura ...headersFromBaseOptions, ...options.headers, }; + localVarRequestOptions.data = serializeDataIfNeeded( + broadcastTradeRequest, + localVarRequestOptions, + configuration, + ); return { url: toPathString(localVarUrlObj), @@ -636,25 +2620,27 @@ export const AddressesApiAxiosParamCreator = function (configuration?: Configura }; }, /** - * Get address balances - * @summary Get all balances for address - * @param {string} walletId The ID of the wallet to fetch the balances for - * @param {string} addressId The onchain address of the address that is being fetched. - * @param {string} [page] 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. + * Create a new trade + * @summary Create a new trade for an address + * @param {string} walletId The ID of the wallet the source address belongs to + * @param {string} addressId The ID of the address to conduct the trade from + * @param {CreateTradeRequest} createTradeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - listAddressBalances: async ( + createTrade: async ( walletId: string, addressId: string, - page?: string, + createTradeRequest: CreateTradeRequest, options: RawAxiosRequestConfig = {}, ): Promise => { // verify required parameter 'walletId' is not null or undefined - assertParamExists("listAddressBalances", "walletId", walletId); + assertParamExists("createTrade", "walletId", walletId); // verify required parameter 'addressId' is not null or undefined - assertParamExists("listAddressBalances", "addressId", addressId); - const localVarPath = `/v1/wallets/{wallet_id}/addresses/{address_id}/balances` + assertParamExists("createTrade", "addressId", addressId); + // verify required parameter 'createTradeRequest' is not null or undefined + assertParamExists("createTrade", "createTradeRequest", createTradeRequest); + const localVarPath = `/v1/wallets/{wallet_id}/addresses/{address_id}/trades` .replace(`{${"wallet_id"}}`, encodeURIComponent(String(walletId))) .replace(`{${"address_id"}}`, encodeURIComponent(String(addressId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. @@ -664,17 +2650,11 @@ export const AddressesApiAxiosParamCreator = function (configuration?: Configura baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { - method: "GET", - ...baseOptions, - ...options, - }; + const localVarRequestOptions = { method: "POST", ...baseOptions, ...options }; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - if (page !== undefined) { - localVarQueryParameter["page"] = page; - } + localVarHeaderParameter["Content-Type"] = "application/json"; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -683,6 +2663,11 @@ export const AddressesApiAxiosParamCreator = function (configuration?: Configura ...headersFromBaseOptions, ...options.headers, }; + localVarRequestOptions.data = serializeDataIfNeeded( + createTradeRequest, + localVarRequestOptions, + configuration, + ); return { url: toPathString(localVarUrlObj), @@ -690,26 +2675,30 @@ export const AddressesApiAxiosParamCreator = function (configuration?: Configura }; }, /** - * List addresses in the wallet. - * @summary List addresses in a wallet. - * @param {string} walletId The ID of the wallet whose addresses to fetch - * @param {number} [limit] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. - * @param {string} [page] 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. + * Get a trade by ID + * @summary Get a trade by ID + * @param {string} walletId The ID of the wallet the address belongs to + * @param {string} addressId The ID of the address the trade belongs to + * @param {string} tradeId The ID of the trade to fetch * @param {*} [options] Override http request option. * @throws {RequiredError} */ - listAddresses: async ( + getTrade: async ( walletId: string, - limit?: number, - page?: string, + addressId: string, + tradeId: string, options: RawAxiosRequestConfig = {}, ): Promise => { // verify required parameter 'walletId' is not null or undefined - assertParamExists("listAddresses", "walletId", walletId); - const localVarPath = `/v1/wallets/{wallet_id}/addresses`.replace( - `{${"wallet_id"}}`, - encodeURIComponent(String(walletId)), - ); + assertParamExists("getTrade", "walletId", walletId); + // verify required parameter 'addressId' is not null or undefined + assertParamExists("getTrade", "addressId", addressId); + // verify required parameter 'tradeId' is not null or undefined + assertParamExists("getTrade", "tradeId", tradeId); + const localVarPath = `/v1/wallets/{wallet_id}/addresses/{address_id}/trades/{trade_id}` + .replace(`{${"wallet_id"}}`, encodeURIComponent(String(walletId))) + .replace(`{${"address_id"}}`, encodeURIComponent(String(addressId))) + .replace(`{${"trade_id"}}`, encodeURIComponent(String(tradeId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -717,22 +2706,10 @@ export const AddressesApiAxiosParamCreator = function (configuration?: Configura baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { - method: "GET", - ...baseOptions, - ...options, - }; + const localVarRequestOptions = { method: "GET", ...baseOptions, ...options }; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - if (limit !== undefined) { - localVarQueryParameter["limit"] = limit; - } - - if (page !== undefined) { - localVarQueryParameter["page"] = page; - } - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { @@ -747,23 +2724,27 @@ export const AddressesApiAxiosParamCreator = function (configuration?: Configura }; }, /** - * Request faucet funds to be sent to onchain address. - * @summary Request faucet funds for onchain address. - * @param {string} walletId The ID of the wallet the address belongs to. - * @param {string} addressId The onchain address of the address that is being fetched. + * List trades for an address. + * @summary List trades for an address. + * @param {string} walletId The ID of the wallet the address belongs to + * @param {string} addressId The ID of the address to list trades for + * @param {number} [limit] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + * @param {string} [page] 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. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - requestFaucetFunds: async ( + listTrades: async ( walletId: string, addressId: string, + limit?: number, + page?: string, options: RawAxiosRequestConfig = {}, ): Promise => { // verify required parameter 'walletId' is not null or undefined - assertParamExists("requestFaucetFunds", "walletId", walletId); + assertParamExists("listTrades", "walletId", walletId); // verify required parameter 'addressId' is not null or undefined - assertParamExists("requestFaucetFunds", "addressId", addressId); - const localVarPath = `/v1/wallets/{wallet_id}/addresses/{address_id}/faucet` + assertParamExists("listTrades", "addressId", addressId); + const localVarPath = `/v1/wallets/{wallet_id}/addresses/{address_id}/trades` .replace(`{${"wallet_id"}}`, encodeURIComponent(String(walletId))) .replace(`{${"address_id"}}`, encodeURIComponent(String(addressId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. @@ -773,14 +2754,18 @@ export const AddressesApiAxiosParamCreator = function (configuration?: Configura baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { - method: "POST", - ...baseOptions, - ...options, - }; + const localVarRequestOptions = { method: "GET", ...baseOptions, ...options }; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit; + } + + if (page !== undefined) { + localVarQueryParameter["page"] = page; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { @@ -798,62 +2783,39 @@ export const AddressesApiAxiosParamCreator = function (configuration?: Configura }; /** - * AddressesApi - functional programming interface + * TradesApi - functional programming interface * @export */ -export const AddressesApiFp = function (configuration?: Configuration) { - const localVarAxiosParamCreator = AddressesApiAxiosParamCreator(configuration); +export const TradesApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = TradesApiAxiosParamCreator(configuration); return { /** - * Create a new address scoped to the wallet. - * @summary Create a new address - * @param {string} walletId The ID of the wallet to create the address in. - * @param {CreateAddressRequest} [createAddressRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async createAddress( - walletId: string, - createAddressRequest?: CreateAddressRequest, - options?: RawAxiosRequestConfig, - ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise
> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAddress( - walletId, - createAddressRequest, - options, - ); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = - operationServerMap["AddressesApi.createAddress"]?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => - createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration, - )(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get address - * @summary Get address by onchain address - * @param {string} walletId The ID of the wallet the address belongs to. - * @param {string} addressId The onchain address of the address that is being fetched. + * Broadcast a trade + * @summary Broadcast a trade + * @param {string} walletId The ID of the wallet the address belongs to + * @param {string} addressId The ID of the address the trade belongs to + * @param {string} tradeId The ID of the trade to broadcast + * @param {BroadcastTradeRequest} broadcastTradeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getAddress( + async broadcastTrade( walletId: string, addressId: string, + tradeId: string, + broadcastTradeRequest: BroadcastTradeRequest, options?: RawAxiosRequestConfig, - ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise
> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAddress( + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.broadcastTrade( walletId, addressId, + tradeId, + broadcastTradeRequest, options, ); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = - operationServerMap["AddressesApi.getAddress"]?.[localVarOperationServerIndex]?.url; + operationServerMap["TradesApi.broadcastTrade"]?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction( localVarAxiosArgs, @@ -863,29 +2825,29 @@ export const AddressesApiFp = function (configuration?: Configuration) { )(axios, localVarOperationServerBasePath || basePath); }, /** - * Get address balance - * @summary Get address balance for asset - * @param {string} walletId The ID of the wallet to fetch the balance for - * @param {string} addressId The onchain address of the address that is being fetched. - * @param {string} assetId The symbol of the asset to fetch the balance for + * Create a new trade + * @summary Create a new trade for an address + * @param {string} walletId The ID of the wallet the source address belongs to + * @param {string} addressId The ID of the address to conduct the trade from + * @param {CreateTradeRequest} createTradeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getAddressBalance( + async createTrade( walletId: string, addressId: string, - assetId: string, + createTradeRequest: CreateTradeRequest, options?: RawAxiosRequestConfig, - ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAddressBalance( + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createTrade( walletId, addressId, - assetId, + createTradeRequest, options, ); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = - operationServerMap["AddressesApi.getAddressBalance"]?.[localVarOperationServerIndex]?.url; + operationServerMap["TradesApi.createTrade"]?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction( localVarAxiosArgs, @@ -895,29 +2857,29 @@ export const AddressesApiFp = function (configuration?: Configuration) { )(axios, localVarOperationServerBasePath || basePath); }, /** - * Get address balances - * @summary Get all balances for address - * @param {string} walletId The ID of the wallet to fetch the balances for - * @param {string} addressId The onchain address of the address that is being fetched. - * @param {string} [page] 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. + * Get a trade by ID + * @summary Get a trade by ID + * @param {string} walletId The ID of the wallet the address belongs to + * @param {string} addressId The ID of the address the trade belongs to + * @param {string} tradeId The ID of the trade to fetch * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async listAddressBalances( + async getTrade( walletId: string, addressId: string, - page?: string, + tradeId: string, options?: RawAxiosRequestConfig, - ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAddressBalances( + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTrade( walletId, addressId, - page, + tradeId, options, ); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = - operationServerMap["AddressesApi.listAddressBalances"]?.[localVarOperationServerIndex]?.url; + operationServerMap["TradesApi.getTrade"]?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction( localVarAxiosArgs, @@ -927,58 +2889,32 @@ export const AddressesApiFp = function (configuration?: Configuration) { )(axios, localVarOperationServerBasePath || basePath); }, /** - * List addresses in the wallet. - * @summary List addresses in a wallet. - * @param {string} walletId The ID of the wallet whose addresses to fetch + * List trades for an address. + * @summary List trades for an address. + * @param {string} walletId The ID of the wallet the address belongs to + * @param {string} addressId The ID of the address to list trades for * @param {number} [limit] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. * @param {string} [page] 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. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async listAddresses( + async listTrades( walletId: string, + addressId: string, limit?: number, page?: string, options?: RawAxiosRequestConfig, - ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAddresses( + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listTrades( walletId, + addressId, limit, page, options, ); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = - operationServerMap["AddressesApi.listAddresses"]?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => - createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration, - )(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Request faucet funds to be sent to onchain address. - * @summary Request faucet funds for onchain address. - * @param {string} walletId The ID of the wallet the address belongs to. - * @param {string} addressId The onchain address of the address that is being fetched. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async requestFaucetFunds( - walletId: string, - addressId: string, - options?: RawAxiosRequestConfig, - ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.requestFaucetFunds( - walletId, - addressId, - options, - ); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = - operationServerMap["AddressesApi.requestFaucetFunds"]?.[localVarOperationServerIndex]?.url; + operationServerMap["TradesApi.listTrades"]?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction( localVarAxiosArgs, @@ -991,239 +2927,270 @@ export const AddressesApiFp = function (configuration?: Configuration) { }; /** - * AddressesApi - factory interface + * TradesApi - factory interface * @export */ -export const AddressesApiFactory = function ( +export const TradesApiFactory = function ( configuration?: Configuration, basePath?: string, axios?: AxiosInstance, ) { - const localVarFp = AddressesApiFp(configuration); + const localVarFp = TradesApiFp(configuration); return { /** - * Create a new address scoped to the wallet. - * @summary Create a new address - * @param {string} walletId The ID of the wallet to create the address in. - * @param {CreateAddressRequest} [createAddressRequest] + * Broadcast a trade + * @summary Broadcast a trade + * @param {string} walletId The ID of the wallet the address belongs to + * @param {string} addressId The ID of the address the trade belongs to + * @param {string} tradeId The ID of the trade to broadcast + * @param {BroadcastTradeRequest} broadcastTradeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - createAddress( + broadcastTrade( walletId: string, - createAddressRequest?: CreateAddressRequest, + addressId: string, + tradeId: string, + broadcastTradeRequest: BroadcastTradeRequest, options?: any, - ): AxiosPromise
{ - return localVarFp - .createAddress(walletId, createAddressRequest, options) - .then(request => request(axios, basePath)); - }, - /** - * Get address - * @summary Get address by onchain address - * @param {string} walletId The ID of the wallet the address belongs to. - * @param {string} addressId The onchain address of the address that is being fetched. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getAddress(walletId: string, addressId: string, options?: any): AxiosPromise
{ + ): AxiosPromise { return localVarFp - .getAddress(walletId, addressId, options) + .broadcastTrade(walletId, addressId, tradeId, broadcastTradeRequest, options) .then(request => request(axios, basePath)); }, /** - * Get address balance - * @summary Get address balance for asset - * @param {string} walletId The ID of the wallet to fetch the balance for - * @param {string} addressId The onchain address of the address that is being fetched. - * @param {string} assetId The symbol of the asset to fetch the balance for + * Create a new trade + * @summary Create a new trade for an address + * @param {string} walletId The ID of the wallet the source address belongs to + * @param {string} addressId The ID of the address to conduct the trade from + * @param {CreateTradeRequest} createTradeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getAddressBalance( + createTrade( walletId: string, addressId: string, - assetId: string, + createTradeRequest: CreateTradeRequest, options?: any, - ): AxiosPromise { + ): AxiosPromise { return localVarFp - .getAddressBalance(walletId, addressId, assetId, options) + .createTrade(walletId, addressId, createTradeRequest, options) .then(request => request(axios, basePath)); }, /** - * Get address balances - * @summary Get all balances for address - * @param {string} walletId The ID of the wallet to fetch the balances for - * @param {string} addressId The onchain address of the address that is being fetched. - * @param {string} [page] 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. + * Get a trade by ID + * @summary Get a trade by ID + * @param {string} walletId The ID of the wallet the address belongs to + * @param {string} addressId The ID of the address the trade belongs to + * @param {string} tradeId The ID of the trade to fetch * @param {*} [options] Override http request option. * @throws {RequiredError} */ - listAddressBalances( + getTrade( walletId: string, addressId: string, - page?: string, + tradeId: string, options?: any, - ): AxiosPromise { + ): AxiosPromise { return localVarFp - .listAddressBalances(walletId, addressId, page, options) + .getTrade(walletId, addressId, tradeId, options) .then(request => request(axios, basePath)); }, /** - * List addresses in the wallet. - * @summary List addresses in a wallet. - * @param {string} walletId The ID of the wallet whose addresses to fetch + * List trades for an address. + * @summary List trades for an address. + * @param {string} walletId The ID of the wallet the address belongs to + * @param {string} addressId The ID of the address to list trades for * @param {number} [limit] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. - * @param {string} [page] 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. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - listAddresses( - walletId: string, - limit?: number, - page?: string, - options?: any, - ): AxiosPromise { - return localVarFp - .listAddresses(walletId, limit, page, options) - .then(request => request(axios, basePath)); - }, - /** - * Request faucet funds to be sent to onchain address. - * @summary Request faucet funds for onchain address. - * @param {string} walletId The ID of the wallet the address belongs to. - * @param {string} addressId The onchain address of the address that is being fetched. + * @param {string} [page] 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. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - requestFaucetFunds( + listTrades( walletId: string, addressId: string, + limit?: number, + page?: string, options?: any, - ): AxiosPromise { + ): AxiosPromise { return localVarFp - .requestFaucetFunds(walletId, addressId, options) + .listTrades(walletId, addressId, limit, page, options) .then(request => request(axios, basePath)); }, }; }; /** - * AddressesApi - object-oriented interface + * TradesApi - interface * @export - * @class AddressesApi - * @extends {BaseAPI} + * @interface TradesApi */ -export class AddressesApi extends BaseAPI { +export interface TradesApiInterface { /** - * Create a new address scoped to the wallet. - * @summary Create a new address - * @param {string} walletId The ID of the wallet to create the address in. - * @param {CreateAddressRequest} [createAddressRequest] + * Broadcast a trade + * @summary Broadcast a trade + * @param {string} walletId The ID of the wallet the address belongs to + * @param {string} addressId The ID of the address the trade belongs to + * @param {string} tradeId The ID of the trade to broadcast + * @param {BroadcastTradeRequest} broadcastTradeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof AddressesApi + * @memberof TradesApiInterface */ - public createAddress( + broadcastTrade( walletId: string, - createAddressRequest?: CreateAddressRequest, + addressId: string, + tradeId: string, + broadcastTradeRequest: BroadcastTradeRequest, options?: RawAxiosRequestConfig, - ) { - return AddressesApiFp(this.configuration) - .createAddress(walletId, createAddressRequest, options) - .then(request => request(this.axios, this.basePath)); - } + ): AxiosPromise; /** - * Get address - * @summary Get address by onchain address - * @param {string} walletId The ID of the wallet the address belongs to. - * @param {string} addressId The onchain address of the address that is being fetched. + * Create a new trade + * @summary Create a new trade for an address + * @param {string} walletId The ID of the wallet the source address belongs to + * @param {string} addressId The ID of the address to conduct the trade from + * @param {CreateTradeRequest} createTradeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof AddressesApi + * @memberof TradesApiInterface */ - public getAddress(walletId: string, addressId: string, options?: RawAxiosRequestConfig) { - return AddressesApiFp(this.configuration) - .getAddress(walletId, addressId, options) - .then(request => request(this.axios, this.basePath)); - } + createTrade( + walletId: string, + addressId: string, + createTradeRequest: CreateTradeRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise; /** - * Get address balance - * @summary Get address balance for asset - * @param {string} walletId The ID of the wallet to fetch the balance for - * @param {string} addressId The onchain address of the address that is being fetched. - * @param {string} assetId The symbol of the asset to fetch the balance for + * Get a trade by ID + * @summary Get a trade by ID + * @param {string} walletId The ID of the wallet the address belongs to + * @param {string} addressId The ID of the address the trade belongs to + * @param {string} tradeId The ID of the trade to fetch * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof AddressesApi + * @memberof TradesApiInterface */ - public getAddressBalance( + getTrade( walletId: string, addressId: string, - assetId: string, + tradeId: string, + options?: RawAxiosRequestConfig, + ): AxiosPromise; + + /** + * List trades for an address. + * @summary List trades for an address. + * @param {string} walletId The ID of the wallet the address belongs to + * @param {string} addressId The ID of the address to list trades for + * @param {number} [limit] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + * @param {string} [page] 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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TradesApiInterface + */ + listTrades( + walletId: string, + addressId: string, + limit?: number, + page?: string, + options?: RawAxiosRequestConfig, + ): AxiosPromise; +} + +/** + * TradesApi - object-oriented interface + * @export + * @class TradesApi + * @extends {BaseAPI} + */ +export class TradesApi extends BaseAPI implements TradesApiInterface { + /** + * Broadcast a trade + * @summary Broadcast a trade + * @param {string} walletId The ID of the wallet the address belongs to + * @param {string} addressId The ID of the address the trade belongs to + * @param {string} tradeId The ID of the trade to broadcast + * @param {BroadcastTradeRequest} broadcastTradeRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TradesApi + */ + public broadcastTrade( + walletId: string, + addressId: string, + tradeId: string, + broadcastTradeRequest: BroadcastTradeRequest, options?: RawAxiosRequestConfig, ) { - return AddressesApiFp(this.configuration) - .getAddressBalance(walletId, addressId, assetId, options) + return TradesApiFp(this.configuration) + .broadcastTrade(walletId, addressId, tradeId, broadcastTradeRequest, options) .then(request => request(this.axios, this.basePath)); } /** - * Get address balances - * @summary Get all balances for address - * @param {string} walletId The ID of the wallet to fetch the balances for - * @param {string} addressId The onchain address of the address that is being fetched. - * @param {string} [page] 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. + * Create a new trade + * @summary Create a new trade for an address + * @param {string} walletId The ID of the wallet the source address belongs to + * @param {string} addressId The ID of the address to conduct the trade from + * @param {CreateTradeRequest} createTradeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof AddressesApi + * @memberof TradesApi */ - public listAddressBalances( + public createTrade( walletId: string, addressId: string, - page?: string, + createTradeRequest: CreateTradeRequest, options?: RawAxiosRequestConfig, ) { - return AddressesApiFp(this.configuration) - .listAddressBalances(walletId, addressId, page, options) + return TradesApiFp(this.configuration) + .createTrade(walletId, addressId, createTradeRequest, options) .then(request => request(this.axios, this.basePath)); } /** - * List addresses in the wallet. - * @summary List addresses in a wallet. - * @param {string} walletId The ID of the wallet whose addresses to fetch - * @param {number} [limit] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. - * @param {string} [page] 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. + * Get a trade by ID + * @summary Get a trade by ID + * @param {string} walletId The ID of the wallet the address belongs to + * @param {string} addressId The ID of the address the trade belongs to + * @param {string} tradeId The ID of the trade to fetch * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof AddressesApi + * @memberof TradesApi */ - public listAddresses( + public getTrade( walletId: string, - limit?: number, - page?: string, + addressId: string, + tradeId: string, options?: RawAxiosRequestConfig, ) { - return AddressesApiFp(this.configuration) - .listAddresses(walletId, limit, page, options) + return TradesApiFp(this.configuration) + .getTrade(walletId, addressId, tradeId, options) .then(request => request(this.axios, this.basePath)); } /** - * Request faucet funds to be sent to onchain address. - * @summary Request faucet funds for onchain address. - * @param {string} walletId The ID of the wallet the address belongs to. - * @param {string} addressId The onchain address of the address that is being fetched. + * List trades for an address. + * @summary List trades for an address. + * @param {string} walletId The ID of the wallet the address belongs to + * @param {string} addressId The ID of the address to list trades for + * @param {number} [limit] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + * @param {string} [page] 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. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof AddressesApi + * @memberof TradesApi */ - public requestFaucetFunds(walletId: string, addressId: string, options?: RawAxiosRequestConfig) { - return AddressesApiFp(this.configuration) - .requestFaucetFunds(walletId, addressId, options) + public listTrades( + walletId: string, + addressId: string, + limit?: number, + page?: string, + options?: RawAxiosRequestConfig, + ) { + return TradesApiFp(this.configuration) + .listTrades(walletId, addressId, limit, page, options) .then(request => request(this.axios, this.basePath)); } } @@ -1271,11 +3238,7 @@ export const TransfersApiAxiosParamCreator = function (configuration?: Configura baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { - method: "POST", - ...baseOptions, - ...options, - }; + const localVarRequestOptions = { method: "POST", ...baseOptions, ...options }; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -1330,11 +3293,7 @@ export const TransfersApiAxiosParamCreator = function (configuration?: Configura baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { - method: "POST", - ...baseOptions, - ...options, - }; + const localVarRequestOptions = { method: "POST", ...baseOptions, ...options }; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -1390,11 +3349,7 @@ export const TransfersApiAxiosParamCreator = function (configuration?: Configura baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { - method: "GET", - ...baseOptions, - ...options, - }; + const localVarRequestOptions = { method: "GET", ...baseOptions, ...options }; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -1442,11 +3397,7 @@ export const TransfersApiAxiosParamCreator = function (configuration?: Configura baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { - method: "GET", - ...baseOptions, - ...options, - }; + const localVarRequestOptions = { method: "GET", ...baseOptions, ...options }; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -1712,13 +3663,92 @@ export const TransfersApiFactory = function ( }; }; +/** + * TransfersApi - interface + * @export + * @interface TransfersApi + */ +export interface TransfersApiInterface { + /** + * Broadcast a transfer + * @summary Broadcast a transfer + * @param {string} walletId The ID of the wallet the address belongs to + * @param {string} addressId The ID of the address the transfer belongs to + * @param {string} transferId The ID of the transfer to broadcast + * @param {BroadcastTransferRequest} broadcastTransferRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TransfersApiInterface + */ + broadcastTransfer( + walletId: string, + addressId: string, + transferId: string, + broadcastTransferRequest: BroadcastTransferRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise; + + /** + * Create a new transfer + * @summary Create a new transfer for an address + * @param {string} walletId The ID of the wallet the source address belongs to + * @param {string} addressId The ID of the address to transfer from + * @param {CreateTransferRequest} createTransferRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TransfersApiInterface + */ + createTransfer( + walletId: string, + addressId: string, + createTransferRequest: CreateTransferRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise; + + /** + * Get a transfer by ID + * @summary Get a transfer by ID + * @param {string} walletId The ID of the wallet the address belongs to + * @param {string} addressId The ID of the address the transfer belongs to + * @param {string} transferId The ID of the transfer to fetch + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TransfersApiInterface + */ + getTransfer( + walletId: string, + addressId: string, + transferId: string, + options?: RawAxiosRequestConfig, + ): AxiosPromise; + + /** + * List transfers for an address. + * @summary List transfers for an address. + * @param {string} walletId The ID of the wallet the address belongs to + * @param {string} addressId The ID of the address to list transfers for + * @param {number} [limit] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + * @param {string} [page] 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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TransfersApiInterface + */ + listTransfers( + walletId: string, + addressId: string, + limit?: number, + page?: string, + options?: RawAxiosRequestConfig, + ): AxiosPromise; +} + /** * TransfersApi - object-oriented interface * @export * @class TransfersApi * @extends {BaseAPI} */ -export class TransfersApi extends BaseAPI { +export class TransfersApi extends BaseAPI implements TransfersApiInterface { /** * Broadcast a transfer * @summary Broadcast a transfer @@ -1829,11 +3859,7 @@ export const UsersApiAxiosParamCreator = function (configuration?: Configuration baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { - method: "GET", - ...baseOptions, - ...options, - }; + const localVarRequestOptions = { method: "GET", ...baseOptions, ...options }; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -1907,13 +3933,29 @@ export const UsersApiFactory = function ( }; }; +/** + * UsersApi - interface + * @export + * @interface UsersApi + */ +export interface UsersApiInterface { + /** + * Get current user + * @summary Get current user + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UsersApiInterface + */ + getCurrentUser(options?: RawAxiosRequestConfig): AxiosPromise; +} + /** * UsersApi - object-oriented interface * @export * @class UsersApi * @extends {BaseAPI} */ -export class UsersApi extends BaseAPI { +export class UsersApi extends BaseAPI implements UsersApiInterface { /** * Get current user * @summary Get current user @@ -1953,11 +3995,7 @@ export const WalletsApiAxiosParamCreator = function (configuration?: Configurati baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { - method: "POST", - ...baseOptions, - ...options, - }; + const localVarRequestOptions = { method: "POST", ...baseOptions, ...options }; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -2005,11 +4043,7 @@ export const WalletsApiAxiosParamCreator = function (configuration?: Configurati baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { - method: "GET", - ...baseOptions, - ...options, - }; + const localVarRequestOptions = { method: "GET", ...baseOptions, ...options }; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -2053,11 +4087,7 @@ export const WalletsApiAxiosParamCreator = function (configuration?: Configurati baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { - method: "GET", - ...baseOptions, - ...options, - }; + const localVarRequestOptions = { method: "GET", ...baseOptions, ...options }; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -2098,11 +4128,7 @@ export const WalletsApiAxiosParamCreator = function (configuration?: Configurati baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { - method: "GET", - ...baseOptions, - ...options, - }; + const localVarRequestOptions = { method: "GET", ...baseOptions, ...options }; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -2140,11 +4166,7 @@ export const WalletsApiAxiosParamCreator = function (configuration?: Configurati baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { - method: "GET", - ...baseOptions, - ...options, - }; + const localVarRequestOptions = { method: "GET", ...baseOptions, ...options }; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -2383,13 +4405,86 @@ export const WalletsApiFactory = function ( }; }; +/** + * WalletsApi - interface + * @export + * @interface WalletsApi + */ +export interface WalletsApiInterface { + /** + * Create a new wallet scoped to the user. + * @summary Create a new wallet + * @param {CreateWalletRequest} [createWalletRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WalletsApiInterface + */ + createWallet( + createWalletRequest?: CreateWalletRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise; + + /** + * Get wallet + * @summary Get wallet by ID + * @param {string} walletId The ID of the wallet to fetch + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WalletsApiInterface + */ + getWallet(walletId: string, options?: RawAxiosRequestConfig): AxiosPromise; + + /** + * Get the aggregated balance of an asset across all of the addresses in the wallet. + * @summary Get the balance of an asset in the wallet + * @param {string} walletId The ID of the wallet to fetch the balance for + * @param {string} assetId The symbol of the asset to fetch the balance for + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WalletsApiInterface + */ + getWalletBalance( + walletId: string, + assetId: string, + options?: RawAxiosRequestConfig, + ): AxiosPromise; + + /** + * List the balances of all of the addresses in the wallet aggregated by asset. + * @summary List wallet balances + * @param {string} walletId The ID of the wallet to fetch the balances for + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WalletsApiInterface + */ + listWalletBalances( + walletId: string, + options?: RawAxiosRequestConfig, + ): AxiosPromise; + + /** + * List wallets belonging to the user. + * @summary List wallets + * @param {number} [limit] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + * @param {string} [page] 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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WalletsApiInterface + */ + listWallets( + limit?: number, + page?: string, + options?: RawAxiosRequestConfig, + ): AxiosPromise; +} + /** * WalletsApi - object-oriented interface * @export * @class WalletsApi * @extends {BaseAPI} */ -export class WalletsApi extends BaseAPI { +export class WalletsApi extends BaseAPI implements WalletsApiInterface { /** * Create a new wallet scoped to the user. * @summary Create a new wallet diff --git a/src/client/common.ts b/src/client/common.ts index dafa34a3..33f7c8af 100644 --- a/src/client/common.ts +++ b/src/client/common.ts @@ -65,10 +65,7 @@ export const setApiKeyToObject = async function ( */ export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { if (configuration && (configuration.username || configuration.password)) { - object["auth"] = { - username: configuration.username, - password: configuration.password, - }; + object["auth"] = { username: configuration.username, password: configuration.password }; } }; diff --git a/src/coinbase/address.ts b/src/coinbase/address.ts index 827ef542..e8939e1b 100644 --- a/src/coinbase/address.ts +++ b/src/coinbase/address.ts @@ -162,7 +162,7 @@ export class Address { intervalSeconds = 0.2, timeoutSeconds = 10, ): Promise { - if (!this.key) { + if (!Coinbase.useServerSigner && !this.key) { throw new InternalError("Cannot transfer from address without private key loaded"); } let normalizedAmount = new Decimal(amount.toString()); @@ -218,29 +218,33 @@ export class Address { createTransferRequest, ); - const transfer = Transfer.fromModel(response.data); - const transaction = transfer.getTransaction(); - let signedPayload = await this.key.signTransaction(transaction); - signedPayload = signedPayload.slice(2); + let transfer = Transfer.fromModel(response.data); - const broadcastTransferRequest = { - signed_payload: signedPayload, - }; + if (!Coinbase.useServerSigner) { + const transaction = transfer.getTransaction(); + let signedPayload = await this.key!.signTransaction(transaction); + signedPayload = signedPayload.slice(2); - response = await Coinbase.apiClients.transfer!.broadcastTransfer( - this.getWalletId(), - this.getId(), - transfer.getId(), - broadcastTransferRequest, - ); + const broadcastTransferRequest = { + signed_payload: signedPayload, + }; - const updatedTransfer = Transfer.fromModel(response.data); + response = await Coinbase.apiClients.transfer!.broadcastTransfer( + this.getWalletId(), + this.getId(), + transfer.getId(), + broadcastTransferRequest, + ); + + transfer = Transfer.fromModel(response.data); + } const startTime = Date.now(); while (Date.now() - startTime < timeoutSeconds * 1000) { - const status = await updatedTransfer.getStatus(); + await transfer.reload(); + const status = transfer.getStatus(); if (status === TransferStatus.COMPLETE || status === TransferStatus.FAILED) { - return updatedTransfer; + return transfer; } await delay(intervalSeconds); } diff --git a/src/coinbase/coinbase.ts b/src/coinbase/coinbase.ts index f5c085b2..cf7401ba 100644 --- a/src/coinbase/coinbase.ts +++ b/src/coinbase/coinbase.ts @@ -52,12 +52,20 @@ export class Coinbase { */ static apiKeyPrivateKey: string; + /** + * Whether to use server signer or not. + * + * @constant + */ + static useServerSigner: boolean; + /** * Initializes the Coinbase SDK. * * @class * @param apiKeyName - The API key name. * @param privateKey - The private key associated with the API key. + * @param useServerSigner - Whether to use server signer or not. * @param debugging - If true, logs API requests and responses to the console. * @param basePath - The base path for the API. * @throws {InternalError} If the configuration is invalid. @@ -66,6 +74,7 @@ export class Coinbase { constructor( apiKeyName: string, privateKey: string, + useServerSigner: boolean = false, debugging = false, basePath: string = BASE_PATH, ) { @@ -94,12 +103,14 @@ export class Coinbase { "https://sepolia.base.org", ); Coinbase.apiKeyPrivateKey = privateKey; + Coinbase.useServerSigner = useServerSigner; } /** * Reads the API key and private key from a JSON file and initializes the Coinbase SDK. * * @param filePath - The path to the JSON file containing the API key and private key. + * @param useServerSigner - Whether to use server signer or not. * @param debugging - If true, logs API requests and responses to the console. * @param basePath - The base path for the API. * @returns A new instance of the Coinbase SDK. @@ -109,6 +120,7 @@ export class Coinbase { */ static configureFromJson( filePath: string = "coinbase_cloud_api_key.json", + useServerSigner: boolean = false, debugging: boolean = false, basePath: string = BASE_PATH, ): Coinbase { @@ -123,7 +135,7 @@ export class Coinbase { throw new InvalidAPIKeyFormat("Invalid configuration: missing configuration values"); } - return new Coinbase(config.name, config.privateKey, debugging, basePath); + return new Coinbase(config.name, config.privateKey, useServerSigner, debugging, basePath); } catch (e) { if (e instanceof SyntaxError) { throw new InvalidAPIKeyFormat("Not able to parse the configuration file"); diff --git a/src/coinbase/transfer.ts b/src/coinbase/transfer.ts index f0bbafd2..c1ffe2ee 100644 --- a/src/coinbase/transfer.ts +++ b/src/coinbase/transfer.ts @@ -188,18 +188,19 @@ export class Transfer { * * @returns The Status of the Transfer. */ - public async getStatus(): Promise { - const transactionHash = this.getTransactionHash(); - if (!transactionHash) return TransferStatus.PENDING; - - const onchainTransaction = - await Coinbase.apiClients.baseSepoliaProvider!.getTransaction(transactionHash); - if (!onchainTransaction) return TransferStatus.PENDING; - if (!onchainTransaction.blockHash) return TransferStatus.BROADCAST; - - const transactionReceipt = - await Coinbase.apiClients.baseSepoliaProvider!.getTransactionReceipt(transactionHash); - return transactionReceipt?.status ? TransferStatus.COMPLETE : TransferStatus.FAILED; + public getStatus(): TransferStatus | undefined { + switch (this.model.status) { + case TransferStatus.PENDING: + return TransferStatus.PENDING; + case TransferStatus.BROADCAST: + return TransferStatus.BROADCAST; + case TransferStatus.COMPLETE: + return TransferStatus.COMPLETE; + case TransferStatus.FAILED: + return TransferStatus.FAILED; + default: + return undefined; + } } /** @@ -211,18 +212,31 @@ export class Transfer { return `https://sepolia.basescan.org/tx/${this.getTransactionHash()}`; } + /** + * Reloads the Transfer model with the latest data from the server. + * + * @throws {APIError} if the API request to get a Transfer fails. + */ + public async reload(): Promise { + const result = await Coinbase.apiClients.transfer!.getTransfer( + this.getWalletId(), + this.getFromAddressId(), + this.getId(), + ); + this.model = result?.data; + } + /** * Returns a string representation of the Transfer. * * @returns The string representation of the Transfer. */ public async toString(): Promise { - const status = await this.getStatus(); return ( `Transfer{transferId: '${this.getId()}', networkId: '${this.getNetworkId()}', ` + `fromAddressId: '${this.getFromAddressId()}', destinationAddressId: '${this.getDestinationAddressId()}', ` + `assetId: '${this.getAssetId()}', amount: '${this.getAmount()}', transactionHash: '${this.getTransactionHash()}', ` + - `transactionLink: '${this.getTransactionLink()}', status: '${status}'}` + `transactionLink: '${this.getTransactionLink()}', status: '${this.getStatus()}'}` ); } } diff --git a/src/coinbase/types.ts b/src/coinbase/types.ts index c983ad6d..24e5ad2c 100644 --- a/src/coinbase/types.ts +++ b/src/coinbase/types.ts @@ -305,10 +305,10 @@ export type ApiClients = { * Transfer status type definition. */ export enum TransferStatus { - PENDING = "PENDING", - BROADCAST = "BROADCAST", - COMPLETE = "COMPLETE", - FAILED = "FAILED", + PENDING = "pending", + BROADCAST = "broadcast", + COMPLETE = "complete", + FAILED = "failed", } /** @@ -339,3 +339,11 @@ export type Amount = number | bigint | Decimal; * Destination type definition. */ export type Destination = string | Address | Wallet; + +/** + * ServerSigner status type definition. + */ +export enum ServerSignerStatus { + PENDING = "pending_seed_creation", + ACTIVE = "active_seed", +} diff --git a/src/coinbase/wallet.ts b/src/coinbase/wallet.ts index 48a1222d..bbe1a5c4 100644 --- a/src/coinbase/wallet.ts +++ b/src/coinbase/wallet.ts @@ -9,8 +9,8 @@ import { Address } from "./address"; import { Coinbase } from "./coinbase"; import { ArgumentError, InternalError } from "./errors"; import { Transfer } from "./transfer"; -import { Amount, Destination, SeedData, WalletData } from "./types"; -import { convertStringToHex } from "./utils"; +import { Amount, Destination, SeedData, WalletData, ServerSignerStatus } from "./types"; +import { convertStringToHex, delay } from "./utils"; import { FaucetTransaction } from "./faucet_transaction"; import { BalanceMap } from "./balance_map"; import Decimal from "decimal.js"; @@ -69,17 +69,47 @@ export class Wallet { const result = await Coinbase.apiClients.wallet!.createWallet({ wallet: { network_id: Coinbase.networkList.BaseSepolia, + use_server_signer: Coinbase.useServerSigner, }, }); const wallet = await Wallet.init(result.data, undefined, []); + if (Coinbase.useServerSigner) { + await wallet.waitForSigner(wallet.getId()!); + } + await wallet.createAddress(); await wallet.reload(); return wallet; } + /** + * Waits until the ServerSigner has created a seed for the Wallet. + * + * @param walletId - The ID of the Wallet that is awaiting seed creation. + * @param intervalSeconds - The interval at which to poll the CDPService, in seconds. + * @param timeoutSeconds - The maximum amount of time to wait for the ServerSigner to create a seed, in seconds. + * @throws {APIError} if the API request to get a Wallet fails. + * @throws {Error} if the ServerSigner times out. + */ + private async waitForSigner( + walletId: string, + intervalSeconds = 0.2, + timeoutSeconds = 20, + ): Promise { + const startTime = Date.now(); + while (Date.now() - startTime < timeoutSeconds * 1000) { + const response = await Coinbase.apiClients.wallet!.getWallet(walletId); + if (response?.data.server_signer_status === ServerSignerStatus.ACTIVE) { + return; + } + await delay(intervalSeconds); + } + throw new Error("Wallet creation timed out. Check status of your Server-Signer"); + } + /** * Returns a new Wallet object. Do not use this method directly. Instead, use User.createWallet or User.importWallet. * @@ -100,6 +130,10 @@ export class Wallet { ): Promise { this.validateSeedAndAddressModels(seed, addressModels); + if (Coinbase.useServerSigner) { + return new Wallet(model, undefined, undefined, addressModels); + } + const seedAndMaster = this.getSeedAndMasterKey(seed); const wallet = new Wallet(model, seedAndMaster.master, seedAndMaster.seed, addressModels); wallet.deriveAddresses(addressModels); @@ -111,6 +145,7 @@ export class Wallet { * Exports the Wallet's data to a WalletData object. * * @returns The Wallet's data. + * @throws {APIError} - If the request fails. */ public export(): WalletData { if (!this.seed) { @@ -140,15 +175,18 @@ export class Wallet { * @throws {APIError} - If the address creation fails. */ public async createAddress(): Promise
{ - const hdKey = this.deriveKey(); - const attestation = this.createAttestation(hdKey); - const publicKey = convertStringToHex(hdKey.publicKey!); - const key = new ethers.Wallet(convertStringToHex(hdKey.privateKey!)); - - const payload = { - public_key: publicKey, - attestation: attestation, - }; + let payload, key; + if (!Coinbase.useServerSigner) { + const hdKey = this.deriveKey(); + const attestation = this.createAttestation(hdKey); + const publicKey = convertStringToHex(hdKey.publicKey!); + key = new ethers.Wallet(convertStringToHex(hdKey.privateKey!)); + + payload = { + public_key: publicKey, + attestation: attestation, + }; + } const response = await Coinbase.apiClients.address!.createAddress(this.model.id!, payload); this.cacheAddress(response!.data, key); @@ -188,6 +226,8 @@ export class Wallet { /** * Reloads the Wallet model with the latest data from the server. + * + * @throws {APIError} if the API request to get a Wallet fails. */ private async reload(): Promise { const result = await Coinbase.apiClients.wallet!.getWallet(this.model.id!); @@ -325,6 +365,22 @@ export class Wallet { return this.model.network_id; } + /** + * Returns the ServerSigner Status of the Wallet. + * + * @returns the ServerSigner Status. + */ + public getServerSignerStatus(): ServerSignerStatus | undefined { + switch (this.model.server_signer_status) { + case ServerSignerStatus.PENDING: + return ServerSignerStatus.PENDING; + case ServerSignerStatus.ACTIVE: + return ServerSignerStatus.ACTIVE; + default: + return undefined; + } + } + /** * Returns the wallet ID. * From 4abe5d93c334d722dbdb95b773c1dd46b3f2785a Mon Sep 17 00:00:00 2001 From: John Peterson Date: Sat, 1 Jun 2024 19:21:20 -0400 Subject: [PATCH 2/9] tests --- src/coinbase/tests/address_test.ts | 47 ++++++++++----- src/coinbase/tests/transfer_test.ts | 76 +++++++++++++----------- src/coinbase/tests/wallet_test.ts | 91 ++++++++++++++++++++++++----- src/coinbase/wallet.ts | 6 +- 4 files changed, 156 insertions(+), 64 deletions(-) diff --git a/src/coinbase/tests/address_test.ts b/src/coinbase/tests/address_test.ts index d47f5878..2b2e6288 100644 --- a/src/coinbase/tests/address_test.ts +++ b/src/coinbase/tests/address_test.ts @@ -20,6 +20,7 @@ import { } from "./utils"; import { ArgumentError } from "../errors"; import { Transfer } from "../transfer"; +import { TransferStatus } from "../types"; // Test suite for Address class describe("Address", () => { @@ -184,13 +185,6 @@ describe("Address", () => { let weiAmount, destination, intervalSeconds, timeoutSeconds; let walletId, id; - const mockProvider = new ethers.JsonRpcProvider( - "https://sepolia.base.org", - ) as jest.Mocked; - mockProvider.getTransaction = jest.fn(); - mockProvider.getTransactionReceipt = jest.fn(); - Coinbase.apiClients.baseSepoliaProvider = mockProvider; - beforeEach(() => { weiAmount = new Decimal("500000000000000000"); destination = new Address(VALID_ADDRESS_MODEL, key as unknown as ethers.Wallet); @@ -219,14 +213,12 @@ describe("Address", () => { transaction_hash: "0x6c087c1676e8269dd81e0777244584d0cbfd39b6997b3477242a008fa9349e11", ...VALID_TRANSFER_MODEL, }); - mockProvider.getTransaction.mockResolvedValueOnce({ - blockHash: "0xdeadbeef", - } as ethers.TransactionResponse); - mockProvider.getTransactionReceipt.mockResolvedValueOnce({ - status: 1, - } as ethers.TransactionReceipt); - - const transfer = await address.createTransfer( + Coinbase.apiClients.transfer!.getTransfer = mockReturnValue({ + ...VALID_TRANSFER_MODEL, + status: TransferStatus.COMPLETE, + }); + + await address.createTransfer( weiAmount, Coinbase.assets.Wei, destination, @@ -236,6 +228,7 @@ describe("Address", () => { expect(Coinbase.apiClients.transfer!.createTransfer).toHaveBeenCalledTimes(1); expect(Coinbase.apiClients.transfer!.broadcastTransfer).toHaveBeenCalledTimes(1); + expect(Coinbase.apiClients.transfer!.getTransfer).toHaveBeenCalledTimes(1); }); it("should throw an APIError if the createTransfer API call fails", async () => { @@ -288,6 +281,10 @@ describe("Address", () => { transaction_hash: "0x6c087c1676e8269dd81e0777244584d0cbfd39b6997b3477242a008fa9349e11", ...VALID_TRANSFER_MODEL, }); + Coinbase.apiClients.transfer!.getTransfer = mockReturnValue({ + ...VALID_TRANSFER_MODEL, + status: TransferStatus.BROADCAST, + }); intervalSeconds = 0.000002; timeoutSeconds = 0.000002; @@ -315,6 +312,26 @@ describe("Address", () => { ).rejects.toThrow(ArgumentError); }); + it("should successfully create and complete a transfer when using server signer", async () => { + Coinbase.useServerSigner = true; + Coinbase.apiClients.transfer!.createTransfer = mockReturnValue(VALID_TRANSFER_MODEL); + Coinbase.apiClients.transfer!.getTransfer = mockReturnValue({ + ...VALID_TRANSFER_MODEL, + status: TransferStatus.COMPLETE, + }); + + await address.createTransfer( + weiAmount, + Coinbase.assets.Wei, + destination, + intervalSeconds, + timeoutSeconds, + ); + + expect(Coinbase.apiClients.transfer!.createTransfer).toHaveBeenCalledTimes(1); + expect(Coinbase.apiClients.transfer!.getTransfer).toHaveBeenCalledTimes(1); + }); + afterEach(() => { jest.restoreAllMocks(); }); diff --git a/src/coinbase/tests/transfer_test.ts b/src/coinbase/tests/transfer_test.ts index 333811f2..8197e01d 100644 --- a/src/coinbase/tests/transfer_test.ts +++ b/src/coinbase/tests/transfer_test.ts @@ -5,7 +5,7 @@ import { TransferStatus } from "../types"; import { Transfer } from "../transfer"; import { Coinbase } from "../coinbase"; import { WEI_PER_ETHER } from "../constants"; -import { VALID_TRANSFER_MODEL } from "./utils"; +import { VALID_TRANSFER_MODEL, mockReturnValue, transfersApiMock } from "./utils"; const amount = new Decimal(ethers.parseUnits("100", 18).toString()); const ethAmount = amount.div(WEI_PER_ETHER); @@ -16,20 +16,13 @@ const signedPayload = const transactionHash = "0x6c087c1676e8269dd81e0777244584d0cbfd39b6997b3477242a008fa9349e11"; -const mockProvider = new ethers.JsonRpcProvider( - "https://sepolia.base.org", -) as jest.Mocked; -mockProvider.getTransaction = jest.fn(); -mockProvider.getTransactionReceipt = jest.fn(); -Coinbase.apiClients.baseSepoliaProvider = mockProvider; - describe("Transfer Class", () => { let transferModel: TransferModel; let transfer: Transfer; beforeEach(() => { + Coinbase.apiClients.transfer = transfersApiMock; transferModel = VALID_TRANSFER_MODEL; - transfer = Transfer.fromModel(transferModel); }); @@ -138,52 +131,67 @@ describe("Transfer Class", () => { describe("getStatus", () => { it("should return PENDING when the transaction has not been created", async () => { - const status = await transfer.getStatus(); + const status = transfer.getStatus(); expect(status).toEqual(TransferStatus.PENDING); }); it("should return PENDING when the transaction has been created but not broadcast", async () => { - transferModel.transaction_hash = transactionHash; transfer = Transfer.fromModel(transferModel); - mockProvider.getTransaction.mockResolvedValueOnce(null); - const status = await transfer.getStatus(); + const status = transfer.getStatus(); expect(status).toEqual(TransferStatus.PENDING); }); it("should return BROADCAST when the transaction has been broadcast but not included in a block", async () => { - transferModel.transaction_hash = transactionHash; + transferModel.status = TransferStatus.BROADCAST; transfer = Transfer.fromModel(transferModel); - mockProvider.getTransaction.mockResolvedValueOnce({ - blockHash: null, - } as ethers.TransactionResponse); - const status = await transfer.getStatus(); + const status = transfer.getStatus(); expect(status).toEqual(TransferStatus.BROADCAST); }); it("should return COMPLETE when the transaction has confirmed", async () => { - transferModel.transaction_hash = transactionHash; + transferModel.status = TransferStatus.COMPLETE; transfer = Transfer.fromModel(transferModel); - mockProvider.getTransaction.mockResolvedValueOnce({ - blockHash: "0xdeadbeef", - } as ethers.TransactionResponse); - mockProvider.getTransactionReceipt.mockResolvedValueOnce({ - status: 1, - } as ethers.TransactionReceipt); - const status = await transfer.getStatus(); + const status = transfer.getStatus(); expect(status).toEqual(TransferStatus.COMPLETE); }); it("should return FAILED when the transaction has failed", async () => { - transferModel.transaction_hash = transactionHash; + transferModel.status = TransferStatus.FAILED; transfer = Transfer.fromModel(transferModel); - mockProvider.getTransaction.mockResolvedValueOnce({ - blockHash: "0xdeadbeef", - } as ethers.TransactionResponse); - mockProvider.getTransactionReceipt.mockResolvedValueOnce({ - status: 0, - } as ethers.TransactionReceipt); - const status = await transfer.getStatus(); + const status = transfer.getStatus(); expect(status).toEqual(TransferStatus.FAILED); }); }); + + describe("reload", () => { + it("should return PENDING when the trnasaction has not been created", async () => { + Coinbase.apiClients.transfer!.getTransfer = mockReturnValue({ + ...VALID_TRANSFER_MODEL, + status: TransferStatus.PENDING, + }); + await transfer.reload(); + expect(transfer.getStatus()).toEqual(TransferStatus.PENDING); + expect(Coinbase.apiClients.transfer!.getTransfer).toHaveBeenCalledTimes(1); + }); + + it("should return COMPLETE when the trnasaction is complete", async () => { + Coinbase.apiClients.transfer!.getTransfer = mockReturnValue({ + ...VALID_TRANSFER_MODEL, + status: TransferStatus.COMPLETE, + }); + await transfer.reload(); + expect(transfer.getStatus()).toEqual(TransferStatus.COMPLETE); + expect(Coinbase.apiClients.transfer!.getTransfer).toHaveBeenCalledTimes(1); + }); + + it("should return FAILED when the trnasaction has failed", async () => { + Coinbase.apiClients.transfer!.getTransfer = mockReturnValue({ + ...VALID_TRANSFER_MODEL, + status: TransferStatus.FAILED, + }); + await transfer.reload(); + expect(transfer.getStatus()).toEqual(TransferStatus.FAILED); + expect(Coinbase.apiClients.transfer!.getTransfer).toHaveBeenCalledTimes(1); + }); + }); }); diff --git a/src/coinbase/tests/wallet_test.ts b/src/coinbase/tests/wallet_test.ts index 60ab6198..d285f0c5 100644 --- a/src/coinbase/tests/wallet_test.ts +++ b/src/coinbase/tests/wallet_test.ts @@ -8,6 +8,7 @@ import { Coinbase } from "../coinbase"; import { GWEI_PER_ETHER, WEI_PER_ETHER } from "../constants"; import { ArgumentError, InternalError } from "../errors"; import { Wallet } from "../wallet"; +import { ServerSignerStatus, TransferStatus } from "../types"; import { AddressBalanceList, Address as AddressModel, @@ -17,6 +18,7 @@ import { import { VALID_ADDRESS_MODEL, VALID_TRANSFER_MODEL, + VALID_WALLET_MODEL, addressesApiMock, generateWalletFromSeed, mockFn, @@ -57,17 +59,14 @@ describe("Wallet Class", () => { wallet = await Wallet.create(); }); + beforeEach(async () => { + Coinbase.useServerSigner = false; + }); + describe(".createTransfer", () => { let weiAmount, destination, intervalSeconds, timeoutSeconds; let balanceModel: BalanceModel; - const mockProvider = new ethers.JsonRpcProvider( - "https://sepolia.base.org", - ) as jest.Mocked; - mockProvider.getTransaction = jest.fn(); - mockProvider.getTransactionReceipt = jest.fn(); - Coinbase.apiClients.baseSepoliaProvider = mockProvider; - beforeEach(() => { const key = ethers.Wallet.createRandom(); weiAmount = new Decimal("500000000000000000"); @@ -95,12 +94,10 @@ describe("Wallet Class", () => { transaction_hash: "0x6c087c1676e8269dd81e0777244584d0cbfd39b6997b3477242a008fa9349e11", ...VALID_TRANSFER_MODEL, }); - mockProvider.getTransaction.mockResolvedValueOnce({ - blockHash: "0xdeadbeef", - } as ethers.TransactionResponse); - mockProvider.getTransactionReceipt.mockResolvedValueOnce({ - status: 1, - } as ethers.TransactionReceipt); + Coinbase.apiClients.transfer!.getTransfer = mockReturnValue({ + ...VALID_TRANSFER_MODEL, + status: TransferStatus.COMPLETE, + }); await wallet.createTransfer( weiAmount, @@ -112,6 +109,7 @@ describe("Wallet Class", () => { expect(Coinbase.apiClients.transfer!.createTransfer).toHaveBeenCalledTimes(1); expect(Coinbase.apiClients.transfer!.broadcastTransfer).toHaveBeenCalledTimes(1); + expect(Coinbase.apiClients.transfer!.getTransfer).toHaveBeenCalledTimes(1); }); it("should throw an APIError if the createTransfer API call fails", async () => { @@ -151,6 +149,10 @@ describe("Wallet Class", () => { transaction_hash: "0x6c087c1676e8269dd81e0777244584d0cbfd39b6997b3477242a008fa9349e11", ...VALID_TRANSFER_MODEL, }); + Coinbase.apiClients.transfer!.getTransfer = mockReturnValue({ + ...VALID_TRANSFER_MODEL, + status: TransferStatus.BROADCAST, + }); intervalSeconds = 0.000002; timeoutSeconds = 0.000002; @@ -178,6 +180,26 @@ describe("Wallet Class", () => { ).rejects.toThrow(ArgumentError); }); + it("should successfully create and complete a transfer when using server signer", async () => { + Coinbase.useServerSigner = true; + Coinbase.apiClients.transfer!.createTransfer = mockReturnValue(VALID_TRANSFER_MODEL); + Coinbase.apiClients.transfer!.getTransfer = mockReturnValue({ + ...VALID_TRANSFER_MODEL, + status: TransferStatus.COMPLETE, + }); + + await wallet.createTransfer( + weiAmount, + Coinbase.assets.Wei, + destination, + intervalSeconds, + timeoutSeconds, + ); + + expect(Coinbase.apiClients.transfer!.createTransfer).toHaveBeenCalledTimes(1); + expect(Coinbase.apiClients.transfer!.getTransfer).toHaveBeenCalledTimes(1); + }); + afterEach(() => { jest.restoreAllMocks(); }); @@ -226,6 +248,49 @@ describe("Wallet Class", () => { expect(wallet.getAddress(newAddress.getId())!.getId()).toBe(newAddress.getId()); expect(Coinbase.apiClients.address!.createAddress).toHaveBeenCalledTimes(1); }); + + describe("when using a server signer", () => { + let walletId = crypto.randomUUID(); + let wallet: Wallet; + beforeEach(async () => { + jest.clearAllMocks(); + Coinbase.useServerSigner = true; + }); + + it("should return a Wallet instance", async () => { + Coinbase.apiClients.wallet!.createWallet = mockReturnValue({ + ...VALID_WALLET_MODEL, + server_signer_status: ServerSignerStatus.PENDING, + }); + Coinbase.apiClients.wallet!.getWallet = mockReturnValue({ + ...VALID_WALLET_MODEL, + server_signer_status: ServerSignerStatus.ACTIVE, + }); + Coinbase.apiClients.address!.createAddress = mockReturnValue(newAddressModel(walletId)); + + wallet = await Wallet.create(); + expect(wallet).toBeInstanceOf(Wallet); + expect(wallet.getServerSignerStatus()).toBe(ServerSignerStatus.ACTIVE); + expect(Coinbase.apiClients.wallet!.createWallet).toHaveBeenCalledTimes(1); + expect(Coinbase.apiClients.wallet!.getWallet).toHaveBeenCalledTimes(2); + expect(Coinbase.apiClients.address!.createAddress).toHaveBeenCalledTimes(1); + }); + + it("should throw an Error if the Wallet times out waiting on a not active server signer", async () => { + const intervalSeconds = 0.000002; + const timeoutSeconds = 0.000002; + Coinbase.apiClients.wallet!.getWallet = mockReturnValue({ + ...VALID_WALLET_MODEL, + server_signer_status: ServerSignerStatus.PENDING, + }); + + await expect(Wallet.create(intervalSeconds, timeoutSeconds)).rejects.toThrow( + "Wallet creation timed out. Check status of your Server-Signer", + ); + expect(Coinbase.apiClients.wallet!.createWallet).toHaveBeenCalledTimes(1); + expect(Coinbase.apiClients.wallet!.getWallet).toHaveBeenCalled(); + }); + }); }); describe(".init", () => { diff --git a/src/coinbase/wallet.ts b/src/coinbase/wallet.ts index bbe1a5c4..197d9bda 100644 --- a/src/coinbase/wallet.ts +++ b/src/coinbase/wallet.ts @@ -60,12 +60,14 @@ export class Wallet { * Instead, use User.createWallet. * * @constructs Wallet + * @param intervalSeconds - The interval at which to poll the CDPService, in seconds. + * @param timeoutSeconds - The maximum amount of time to wait for the ServerSigner to create a seed, in seconds. * @throws {ArgumentError} If the model or client is not provided. * @throws {InternalError} - If address derivation or caching fails. * @throws {APIError} - If the request fails. * @returns A promise that resolves with the new Wallet object. */ - public static async create(): Promise { + public static async create(intervalSeconds = 0.2, timeoutSeconds = 20): Promise { const result = await Coinbase.apiClients.wallet!.createWallet({ wallet: { network_id: Coinbase.networkList.BaseSepolia, @@ -76,7 +78,7 @@ export class Wallet { const wallet = await Wallet.init(result.data, undefined, []); if (Coinbase.useServerSigner) { - await wallet.waitForSigner(wallet.getId()!); + await wallet.waitForSigner(wallet.getId()!, intervalSeconds, timeoutSeconds); } await wallet.createAddress(); From b3fa9b22846640278f8c9ec304b1b180a0af7012 Mon Sep 17 00:00:00 2001 From: John Peterson Date: Sat, 1 Jun 2024 20:20:08 -0400 Subject: [PATCH 3/9] use configuration option types for constructors --- src/coinbase/coinbase.ts | 61 +++++++++++++---------------- src/coinbase/tests/coinbase_test.ts | 35 +++++++++++------ src/coinbase/types.ts | 54 ++++++++++++++++++++++++- 3 files changed, 102 insertions(+), 48 deletions(-) diff --git a/src/coinbase/coinbase.ts b/src/coinbase/coinbase.ts index cf7401ba..02796cc3 100644 --- a/src/coinbase/coinbase.ts +++ b/src/coinbase/coinbase.ts @@ -7,12 +7,11 @@ import { AddressesApiFactory, WalletsApiFactory, } from "../client"; -import { ethers } from "ethers"; import { BASE_PATH } from "./../client/base"; import { Configuration } from "./../client/configuration"; import { CoinbaseAuthenticator } from "./authenticator"; import { InternalError, InvalidAPIKeyFormat, InvalidConfiguration } from "./errors"; -import { ApiClients } from "./types"; +import { ApiClients, CoinbaseConfigureFromJsonOptions, CoinbaseOptions } from "./types"; import { User } from "./user"; import { logApiResponse, registerAxiosInterceptors } from "./utils"; import * as os from "os"; @@ -63,28 +62,24 @@ export class Coinbase { * Initializes the Coinbase SDK. * * @class - * @param apiKeyName - The API key name. - * @param privateKey - The private key associated with the API key. - * @param useServerSigner - Whether to use server signer or not. - * @param debugging - If true, logs API requests and responses to the console. - * @param basePath - The base path for the API. + * @param options - The constructor options. * @throws {InternalError} If the configuration is invalid. * @throws {InvalidAPIKeyFormat} If not able to create JWT token. */ - constructor( - apiKeyName: string, - privateKey: string, - useServerSigner: boolean = false, - debugging = false, - basePath: string = BASE_PATH, - ) { + constructor(options: CoinbaseOptions) { + const apiKeyName = options.apiKeyName ?? ""; + const privateKey = options.privateKey ?? ""; + const useServerSigner = options.useServerSigner === true; + const debugging = options.debugging === true; + const basePath = options.basePath ?? BASE_PATH; + if (apiKeyName === "") { throw new InternalError("Invalid configuration: apiKeyName is empty"); } if (privateKey === "") { throw new InternalError("Invalid configuration: privateKey is empty"); } - const coinbaseAuthenticator = new CoinbaseAuthenticator(apiKeyName, privateKey); + const coinbaseAuthenticator = new CoinbaseAuthenticator(apiKeyName!, privateKey!); const config = new Configuration({ basePath: basePath, }); @@ -95,13 +90,10 @@ export class Coinbase { response => logApiResponse(response, debugging), ); - Coinbase.apiClients.user = UsersApiFactory(config, BASE_PATH, axiosInstance); - Coinbase.apiClients.wallet = WalletsApiFactory(config, BASE_PATH, axiosInstance); - Coinbase.apiClients.address = AddressesApiFactory(config, BASE_PATH, axiosInstance); - Coinbase.apiClients.transfer = TransfersApiFactory(config, BASE_PATH, axiosInstance); - Coinbase.apiClients.baseSepoliaProvider = new ethers.JsonRpcProvider( - "https://sepolia.base.org", - ); + Coinbase.apiClients.user = UsersApiFactory(config, basePath, axiosInstance); + Coinbase.apiClients.wallet = WalletsApiFactory(config, basePath, axiosInstance); + Coinbase.apiClients.address = AddressesApiFactory(config, basePath, axiosInstance); + Coinbase.apiClients.transfer = TransfersApiFactory(config, basePath, axiosInstance); Coinbase.apiKeyPrivateKey = privateKey; Coinbase.useServerSigner = useServerSigner; } @@ -109,22 +101,19 @@ export class Coinbase { /** * Reads the API key and private key from a JSON file and initializes the Coinbase SDK. * - * @param filePath - The path to the JSON file containing the API key and private key. - * @param useServerSigner - Whether to use server signer or not. - * @param debugging - If true, logs API requests and responses to the console. - * @param basePath - The base path for the API. + * @param options - The configuration options. * @returns A new instance of the Coinbase SDK. * @throws {InvalidAPIKeyFormat} If the file does not exist or the configuration values are missing/invalid. * @throws {InvalidConfiguration} If the configuration is invalid. * @throws {InvalidAPIKeyFormat} If not able to create JWT token. */ - static configureFromJson( - filePath: string = "coinbase_cloud_api_key.json", - useServerSigner: boolean = false, - debugging: boolean = false, - basePath: string = BASE_PATH, - ): Coinbase { + static configureFromJson(options: CoinbaseConfigureFromJsonOptions): Coinbase { + let filePath = options.filePath ?? "coinbase_cloud_api_key.json"; filePath = filePath.startsWith("~") ? filePath.replace("~", os.homedir()) : filePath; + const useServerSigner = options.useServerSigner === true; + const debugging = options.debugging === true; + const basePath = options.basePath ?? BASE_PATH; + if (!fs.existsSync(filePath)) { throw new InvalidConfiguration(`Invalid configuration: file not found at ${filePath}`); } @@ -135,7 +124,13 @@ export class Coinbase { throw new InvalidAPIKeyFormat("Invalid configuration: missing configuration values"); } - return new Coinbase(config.name, config.privateKey, useServerSigner, debugging, basePath); + return new Coinbase({ + apiKeyName: config.name, + privateKey: config.privateKey, + useServerSigner: useServerSigner, + debugging: debugging, + basePath: basePath, + }); } catch (e) { if (e instanceof SyntaxError) { throw new InvalidAPIKeyFormat("Not able to parse the configuration file"); diff --git a/src/coinbase/tests/coinbase_test.ts b/src/coinbase/tests/coinbase_test.ts index c74d8078..4c014613 100644 --- a/src/coinbase/tests/coinbase_test.ts +++ b/src/coinbase/tests/coinbase_test.ts @@ -19,31 +19,39 @@ const PATH_PREFIX = "./src/coinbase/tests/config"; describe("Coinbase tests", () => { it("should throw an error if the API key name or private key is empty", () => { - expect(() => new Coinbase("", "test")).toThrow("Invalid configuration: apiKeyName is empty"); - expect(() => new Coinbase("test", "")).toThrow("Invalid configuration: privateKey is empty"); + expect(() => new Coinbase({ privateKey: "test" })).toThrow( + "Invalid configuration: apiKeyName is empty", + ); + expect(() => new Coinbase({ apiKeyName: "test" })).toThrow( + "Invalid configuration: privateKey is empty", + ); }); it("should throw an error if the file does not exist", () => { - expect(() => Coinbase.configureFromJson(`${PATH_PREFIX}/does-not-exist.json`)).toThrow( + expect(() => + Coinbase.configureFromJson({ filePath: `${PATH_PREFIX}/does-not-exist.json` }), + ).toThrow( "Invalid configuration: file not found at ./src/coinbase/tests/config/does-not-exist.json", ); }); it("should initialize the Coinbase SDK from a JSON file", () => { - const cbInstance = Coinbase.configureFromJson(`${PATH_PREFIX}/coinbase_cloud_api_key.json`); + const cbInstance = Coinbase.configureFromJson({ + filePath: `${PATH_PREFIX}/coinbase_cloud_api_key.json`, + }); expect(cbInstance).toBeInstanceOf(Coinbase); }); it("should throw an error if there is an issue reading the file or parsing the JSON data", () => { - expect(() => Coinbase.configureFromJson(`${PATH_PREFIX}/invalid.json`)).toThrow( + expect(() => Coinbase.configureFromJson({ filePath: `${PATH_PREFIX}/invalid.json` })).toThrow( "Invalid configuration: missing configuration values", ); }); it("should throw an error if the JSON file is not parseable", () => { - expect(() => Coinbase.configureFromJson(`${PATH_PREFIX}/not_parseable.json`)).toThrow( - "Not able to parse the configuration file", - ); + expect(() => + Coinbase.configureFromJson({ filePath: `${PATH_PREFIX}/not_parseable.json` }), + ).toThrow("Not able to parse the configuration file"); }); it("should expand the tilde to the home directory", () => { @@ -59,10 +67,9 @@ describe("Coinbase tests", () => { describe("should able to interact with the API", () => { let user, walletId, publicKey, addressId, transactionHash; - const cbInstance = Coinbase.configureFromJson( - `${PATH_PREFIX}/coinbase_cloud_api_key.json`, - true, - ); + const cbInstance = Coinbase.configureFromJson({ + filePath: `${PATH_PREFIX}/coinbase_cloud_api_key.json`, + }); beforeAll(async () => { Coinbase.apiClients = { @@ -110,7 +117,9 @@ describe("Coinbase tests", () => { }); it("should raise an error if the user is not found", async () => { - const cbInstance = Coinbase.configureFromJson(`${PATH_PREFIX}/coinbase_cloud_api_key.json`); + const cbInstance = Coinbase.configureFromJson({ + filePath: `${PATH_PREFIX}/coinbase_cloud_api_key.json`, + }); Coinbase.apiClients.user!.getCurrentUser = mockReturnRejectedValue( new APIError("User not found"), ); diff --git a/src/coinbase/types.ts b/src/coinbase/types.ts index 24e5ad2c..1260f54d 100644 --- a/src/coinbase/types.ts +++ b/src/coinbase/types.ts @@ -1,6 +1,5 @@ import { Decimal } from "decimal.js"; import { AxiosPromise, AxiosRequestConfig, RawAxiosRequestConfig } from "axios"; -import { ethers } from "ethers"; import { Address as AddressModel, AddressList, @@ -298,7 +297,6 @@ export type ApiClients = { wallet?: WalletAPIClient; address?: AddressAPIClient; transfer?: TransferAPIClient; - baseSepoliaProvider?: ethers.Provider; }; /** @@ -347,3 +345,55 @@ export enum ServerSignerStatus { PENDING = "pending_seed_creation", ACTIVE = "active_seed", } + +/** + * CoinbaseOptions type definition. + */ +export type CoinbaseOptions = { + /** + * The API key name. + */ + apiKeyName?: string; + + /** + * The private key associated with the API key. + */ + privateKey?: string; + + /** + * Whether to use a Server-Signer or not. + */ + useServerSigner?: boolean; + + /** + * If true, logs API requests and responses to the console. + */ + debugging?: boolean; + + /** + * The base path for the API. + */ + basePath?: string; +}; + +export type CoinbaseConfigureFromJsonOptions = { + /** + * The path to the JSON file containing the API key and private key. + */ + filePath: string; + + /** + * Whether to use a Server-Signer or not. + */ + useServerSigner?: boolean; + + /** + * If true, logs API requests and responses to the console. + */ + debugging?: boolean; + + /** + * The base path for the API. + */ + basePath?: string; +}; From 827eb6834c8cbb4114324197477182a67a355afc Mon Sep 17 00:00:00 2001 From: John Peterson Date: Sun, 2 Jun 2024 19:57:47 -0700 Subject: [PATCH 4/9] typedocs --- docs/assets/navigation.js | 2 +- docs/assets/search.js | 2 +- docs/classes/client_api.AddressesApi.html | 16 ++-- docs/classes/client_api.ServerSignersApi.html | 43 ++++++++++ docs/classes/client_api.TradesApi.html | 39 +++++++++ docs/classes/client_api.TransfersApi.html | 12 +-- docs/classes/client_api.UsersApi.html | 6 +- docs/classes/client_api.WalletsApi.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 | 22 ++--- docs/classes/coinbase_api_error.APIError.html | 8 +- ...coinbase_api_error.AlreadyExistsError.html | 8 +- ...ase_api_error.FaucetLimitReachedError.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 +- .../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 | 4 +- ...e_authenticator.CoinbaseAuthenticator.html | 12 +-- docs/classes/coinbase_balance.Balance.html | 8 +- .../coinbase_balance_map.BalanceMap.html | 8 +- docs/classes/coinbase_coinbase.Coinbase.html | 27 +++---- .../coinbase_errors.ArgumentError.html | 4 +- .../coinbase_errors.InternalError.html | 4 +- .../coinbase_errors.InvalidAPIKeyFormat.html | 4 +- .../coinbase_errors.InvalidConfiguration.html | 4 +- ...oinbase_errors.InvalidUnsignedPayload.html | 4 +- ..._faucet_transaction.FaucetTransaction.html | 10 +-- docs/classes/coinbase_transfer.Transfer.html | 41 +++++----- docs/classes/coinbase_user.User.html | 16 ++-- docs/classes/coinbase_wallet.Wallet.html | 80 +++++++++++-------- docs/enums/client_api.TransactionType.html | 2 + .../coinbase_types.ServerSignerStatus.html | 4 + docs/enums/coinbase_types.TransferStatus.html | 4 +- ...ent_api.AddressesApiAxiosParamCreator.html | 2 +- .../client_api.AddressesApiFactory.html | 12 +-- docs/functions/client_api.AddressesApiFp.html | 12 +-- ...api.ServerSignersApiAxiosParamCreator.html | 26 ++++++ .../client_api.ServerSignersApiFactory.html | 26 ++++++ .../client_api.ServerSignersApiFp.html | 26 ++++++ ...client_api.TradesApiAxiosParamCreator.html | 26 ++++++ .../client_api.TradesApiFactory.html | 26 ++++++ docs/functions/client_api.TradesApiFp.html | 26 ++++++ ...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 +- ...lient_api.WalletsApiAxiosParamCreator.html | 2 +- .../client_api.WalletsApiFactory.html | 10 +-- docs/functions/client_api.WalletsApiFp.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 +- .../coinbase_tests_utils.createAxiosMock.html | 2 +- ...inbase_tests_utils.generateRandomHash.html | 2 +- ...se_tests_utils.generateWalletFromSeed.html | 2 +- ...nbase_tests_utils.getAddressFromHDKey.html | 2 +- .../coinbase_tests_utils.mockFn.html | 2 +- ...e_tests_utils.mockReturnRejectedValue.html | 2 +- .../coinbase_tests_utils.mockReturnValue.html | 2 +- .../coinbase_tests_utils.newAddressModel.html | 2 +- .../coinbase_utils.convertStringToHex.html | 2 +- docs/functions/coinbase_utils.delay.html | 2 +- ...e_utils.destinationToAddressHexString.html | 2 +- .../coinbase_utils.logApiResponse.html | 2 +- ...nbase_utils.registerAxiosInterceptors.html | 2 +- docs/hierarchy.html | 2 +- docs/interfaces/client_api.Address.html | 10 +-- .../client_api.AddressBalanceList.html | 10 +-- docs/interfaces/client_api.AddressList.html | 10 +-- .../client_api.AddressesApiInterface.html | 47 +++++++++++ docs/interfaces/client_api.Asset.html | 10 +-- docs/interfaces/client_api.Balance.html | 6 +- .../client_api.BroadcastTradeRequest.html | 5 ++ .../client_api.BroadcastTransferRequest.html | 4 +- .../client_api.CreateAddressRequest.html | 10 +-- .../client_api.CreateServerSignerRequest.html | 8 ++ .../client_api.CreateTradeRequest.html | 11 +++ .../client_api.CreateTransferRequest.html | 10 +-- .../client_api.CreateWalletRequest.html | 6 +- .../client_api.CreateWalletRequestWallet.html | 9 +++ .../client_api.FaucetTransaction.html | 4 +- docs/interfaces/client_api.ModelError.html | 6 +- .../client_api.SeedCreationEvent.html | 9 +++ .../client_api.SeedCreationEventResult.html | 15 ++++ docs/interfaces/client_api.ServerSigner.html | 9 +++ .../client_api.ServerSignerEvent.html | 8 ++ .../client_api.ServerSignerEventList.html | 13 +++ .../client_api.ServerSignersApiInterface.html | 39 +++++++++ .../client_api.SignatureCreationEvent.html | 26 ++++++ ...ient_api.SignatureCreationEventResult.html | 20 +++++ docs/interfaces/client_api.Trade.html | 27 +++++++ docs/interfaces/client_api.TradeList.html | 13 +++ .../client_api.TradesApiInterface.html | 35 ++++++++ docs/interfaces/client_api.Transaction.html | 21 +++++ docs/interfaces/client_api.Transfer.html | 24 +++--- docs/interfaces/client_api.TransferList.html | 10 +-- .../client_api.TransfersApiInterface.html | 35 ++++++++ docs/interfaces/client_api.User.html | 6 +- .../client_api.UsersApiInterface.html | 8 ++ docs/interfaces/client_api.Wallet.html | 13 +-- docs/interfaces/client_api.WalletList.html | 10 +-- .../client_api.WalletsApiInterface.html | 34 ++++++++ docs/interfaces/client_base.RequestArgs.html | 4 +- ...configuration.ConfigurationParameters.html | 4 +- docs/modules/client.html | 36 ++++++++- docs/modules/client_api.html | 40 +++++++++- docs/modules/client_base.html | 2 +- docs/modules/client_common.html | 2 +- docs/modules/client_configuration.html | 2 +- docs/modules/coinbase.html | 2 +- docs/modules/coinbase_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_errors.html | 2 +- docs/modules/coinbase_faucet_transaction.html | 2 +- docs/modules/coinbase_tests_address_test.html | 2 +- .../coinbase_tests_authenticator_test.html | 2 +- .../coinbase_tests_balance_map_test.html | 2 +- docs/modules/coinbase_tests_balance_test.html | 2 +- .../modules/coinbase_tests_coinbase_test.html | 2 +- ...oinbase_tests_faucet_transaction_test.html | 2 +- .../modules/coinbase_tests_transfer_test.html | 2 +- docs/modules/coinbase_tests_user_test.html | 2 +- docs/modules/coinbase_tests_utils.html | 2 +- docs/modules/coinbase_tests_wallet_test.html | 2 +- docs/modules/coinbase_transfer.html | 2 +- docs/modules/coinbase_types.html | 5 +- docs/modules/coinbase_user.html | 2 +- docs/modules/coinbase_utils.html | 2 +- docs/modules/coinbase_wallet.html | 2 +- .../client_api.ServerSignerEventEvent.html | 1 + .../client_api.TransactionStatusEnum.html | 1 + docs/types/client_api.TransferStatusEnum.html | 2 +- ...ient_api.WalletServerSignerStatusEnum.html | 1 + .../coinbase_types.AddressAPIClient.html | 12 +-- docs/types/coinbase_types.Amount.html | 2 +- docs/types/coinbase_types.ApiClients.html | 4 +- ...ypes.CoinbaseConfigureFromJsonOptions.html | 5 ++ .../types/coinbase_types.CoinbaseOptions.html | 7 ++ docs/types/coinbase_types.Destination.html | 2 +- docs/types/coinbase_types.SeedData.html | 2 +- .../coinbase_types.TransferAPIClient.html | 8 +- docs/types/coinbase_types.UserAPIClient.html | 2 +- .../types/coinbase_types.WalletAPIClient.html | 8 +- docs/types/coinbase_types.WalletData.html | 2 +- .../client_api.TransactionStatusEnum-1.html | 1 + .../client_api.TransferStatusEnum-1.html | 2 +- ...nt_api.WalletServerSignerStatusEnum-1.html | 1 + 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 +- ...nbase_constants.ATOMIC_UNITS_PER_USDC.html | 2 +- .../coinbase_constants.GWEI_PER_ETHER.html | 2 +- .../coinbase_constants.WEI_PER_ETHER.html | 2 +- .../coinbase_constants.WEI_PER_GWEI.html | 2 +- ...ests_utils.VALID_ADDRESS_BALANCE_LIST.html | 2 +- ...nbase_tests_utils.VALID_ADDRESS_MODEL.html | 2 +- ...nbase_tests_utils.VALID_BALANCE_MODEL.html | 2 +- ...base_tests_utils.VALID_TRANSFER_MODEL.html | 2 +- ...inbase_tests_utils.VALID_WALLET_MODEL.html | 2 +- ...coinbase_tests_utils.addressesApiMock.html | 2 +- .../coinbase_tests_utils.transferId.html | 2 +- ...coinbase_tests_utils.transfersApiMock.html | 2 +- .../coinbase_tests_utils.usersApiMock.html | 2 +- .../coinbase_tests_utils.walletId.html | 2 +- .../coinbase_tests_utils.walletsApiMock.html | 2 +- src/coinbase/tests/coinbase_test.ts | 2 +- 199 files changed, 1201 insertions(+), 460 deletions(-) create mode 100644 docs/classes/client_api.ServerSignersApi.html create mode 100644 docs/classes/client_api.TradesApi.html create mode 100644 docs/enums/client_api.TransactionType.html create mode 100644 docs/enums/coinbase_types.ServerSignerStatus.html create mode 100644 docs/functions/client_api.ServerSignersApiAxiosParamCreator.html create mode 100644 docs/functions/client_api.ServerSignersApiFactory.html create mode 100644 docs/functions/client_api.ServerSignersApiFp.html create mode 100644 docs/functions/client_api.TradesApiAxiosParamCreator.html create mode 100644 docs/functions/client_api.TradesApiFactory.html create mode 100644 docs/functions/client_api.TradesApiFp.html create mode 100644 docs/interfaces/client_api.AddressesApiInterface.html create mode 100644 docs/interfaces/client_api.BroadcastTradeRequest.html create mode 100644 docs/interfaces/client_api.CreateServerSignerRequest.html create mode 100644 docs/interfaces/client_api.CreateTradeRequest.html create mode 100644 docs/interfaces/client_api.CreateWalletRequestWallet.html create mode 100644 docs/interfaces/client_api.SeedCreationEvent.html create mode 100644 docs/interfaces/client_api.SeedCreationEventResult.html create mode 100644 docs/interfaces/client_api.ServerSigner.html create mode 100644 docs/interfaces/client_api.ServerSignerEvent.html create mode 100644 docs/interfaces/client_api.ServerSignerEventList.html create mode 100644 docs/interfaces/client_api.ServerSignersApiInterface.html create mode 100644 docs/interfaces/client_api.SignatureCreationEvent.html create mode 100644 docs/interfaces/client_api.SignatureCreationEventResult.html create mode 100644 docs/interfaces/client_api.Trade.html create mode 100644 docs/interfaces/client_api.TradeList.html create mode 100644 docs/interfaces/client_api.TradesApiInterface.html create mode 100644 docs/interfaces/client_api.Transaction.html create mode 100644 docs/interfaces/client_api.TransfersApiInterface.html create mode 100644 docs/interfaces/client_api.UsersApiInterface.html create mode 100644 docs/interfaces/client_api.WalletsApiInterface.html create mode 100644 docs/types/client_api.ServerSignerEventEvent.html create mode 100644 docs/types/client_api.TransactionStatusEnum.html create mode 100644 docs/types/client_api.WalletServerSignerStatusEnum.html create mode 100644 docs/types/coinbase_types.CoinbaseConfigureFromJsonOptions.html create mode 100644 docs/types/coinbase_types.CoinbaseOptions.html create mode 100644 docs/variables/client_api.TransactionStatusEnum-1.html create mode 100644 docs/variables/client_api.WalletServerSignerStatusEnum-1.html diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index d462774e..390e0dff 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE6WbWXPbNhSF/4vymraxs7TJG6Ol1kSyNZKcTCfj4cAULLGhSJUEvbTT/15wk4jt3gt18hTrnO9AIIhd3/8ZCP4sBp8GURLzVAxeDw5M7OT/99mmTHjxS/P3n3din8gPf8TpZvDp8vUg2sXJJufp4NP3IyLYyL8UBch4dRI1rHcXH9+9ffPu39c65jNLWBrxWVzApXpl1SNwMpWG40VwiEm8TkkBBs9xVixYzvbDnDOR5fQEm5USOWGRFL/Qg04GEv7gQT5AUCnCHmArcSHa9gJDTiInJs/YJmKFWOcsLR54vuR/lRxrXYDLFTTM0od4W+ZMxFkK03UpCVm3Fi54jrzAbpMzpmqCvH22pOpxOOAArwfgssAR31iScOERoBtc+AkrI940BvlCoQ/YJneh59mGJ+M8x7oPReeCdRUGo3oqDIR3xJoSA64EE2UxTss9DavoMTjezWtKCtCzm8eslEhSN283kPBIN29oXdDbAmtqrQIC4A+tp8JAng8LsmFRpIdkilEs8nAUnQvW9Gsw6KiBIXgPoOhgGP6sFR0O83zesBGPIz1zm5yARp67pnQBmbuCQ/mZz0JBmzVHCav+1of1hSr54vI3tH+2APtCCGj2GxZYJ4JAtmZpQZ1kEMxYYMWpnHo9sMhaa9qjeP+BuMYCoT0Hge8BRonqjN/BqkQQxZj02zmtDCSh834H2uGDsuAJtD3H5sEzPL+M1YSnOKbRUIZigRKAmbSdbxggum0ybceelBDPnE/baZ2OwqK8dH0txFQnYHZWpYEY+lzBTmlUOIfy7U5KSn3ZVgzi5WCvsJNYQ7/5+OvF+0si/pHlMbtPsIifLtSQt5dmF4vtFD2Uad2qneOq4VUzP5C3itCk1kHlH3zQB4BKXGxZQ0AvMZNWUxYHlY/VlCoGqIRVjjXA6SNk0WpHU1O4WK2chACNtBKw4gEnKY9WL4aexsbqpi81iHc95j0rnFuoYfUhaUHwWQqDxdQ5Ra5BrQiaIFfzgzjnG22EttEUKcaUc44g34IT7yO01YJzx2A1DhfB+goYEZqv3AmBcWB4M5uNh+vpzXU4uVnOg/UKo5oOAJ8deLPVu+L5I8/n7IDhTYeB77egKNvv3fudYfMxqRWNbufzP8K6zm6XM6CYLVPVA3VQtZ5c1G/w+FnOKgrg7WnZhgV4L6N6htu2nUkLxCOsNiBGFihmSfw3HzHBpg/XnG/4Bo+x2sAYIbuNL/xlnd3c/8kjQYnQLDBedgRxFJRi55VguJAQznKe+6cYNjjmxjvhhg5fycJEu7oREpqsZgDQIltI1ErkcbrFuX01OJZElBOuUFGR+gXHyZk2KqjcoTtFHR7QMzRzqACSTgBz/LjTKitOHYNv+wmxbkiYVz2dc2fQefzfekNm3ZgiXiY4Pi6dZt3uqh5Sv7rkpCbkjkOwI7DT0Aq4mLqmGSawE4O7e4ns0DcvzXDhgTZsUEiz2zGL97FYchbt3HMlM8nhheKm6aMcOzbtI6JHWXz0mOno3KDWSYnaZ2Uq/HNONkpItZ15zrfp+QgxIzl/iNO6//GO0r2EuLoBeQedXISIay6esvzHGVWnOglRC7bl3ilHEyFgFW9TLh0vScY8XlanmxDZ7RecUX+a1SOs3fY6N7BnJ4Q261vvsJ6NHHJGJSpGKGjOkocs3/NNuwqgJ1mdUNR1Jiay7/JogYoDXmEXWZlHfPy8Y2UhfIYkuxU82UuZnD9nuVzQeOQYLjgi3h8SvpdzPb8M3QaHFOXhkOVSW3f3PjkWJzJ7cly3O8It526OWZNKMotZkyzneEaR5POQNRVHjkP5I7Cv85oSB/YEs8hKgtUNf5V7503ELuLeeh7p2kvTaEaBO5r1lNNRuHDPbPcHNGSl8imkspvkKmcNPRng4uLLovB/ro+MYh55QyvYLGFaCJYKaKF01NDeqfXNfDoMb6+n61W4GC/D29VoaN3+MvlWL7AV9vu38bTWjddX4yUxRDUB9HPgvuyqMJ7oygLuYdYdK/RAGwHtaebbshoDsA69RSpyeFIieJ4y/fTaxVXklLXKYvqFv0zknIJB/fuRbpgIGdhGjj2EvJXT6uX42J80k3M0H9wLPNRr6VCAN367HFNMaknAVQjjq1gikIsR+jcSvNkYt5Wk3aoJhf3adFeIGhH2xdr3dI3/RLBhceN7Yw8NrhtwtBcWRiomlKn81w01mwQN7/C5g0S7hKPhFbUbWhZU4FEJwEScQN17C6pUpDfzazCbjsJgNFqOV6vwczALrofjcDZdrcGRqR/jRgBjoGqa34zG9mMyPLD2okldsc5JUrxo0noZXK8mcqw+J0o1o1nfgtlsvD4rqW+FDhx7V1vmWfSDnKIbgYzuPZpuyPSThcD1LrtuBDLK4gx+3wSwn5rNF3qtdAaU6V1i1Qbwm6Pg+p6JGtA7k7MFaD7gyG/L0+pUny9Zusn2V6zYkUNMKyGn2QKb5Nl+xR2n1FCWagfzRLv3X4mvRnI66hFmeIGkvazgif1Y3wZv5AhvyUWZp0teHQXzzVeWlNwrwOInJZ6bhCWk/Kmt0fr6LDlB84GnzM1LRZsa9LT65ODO0uVBPPsFXvv0wLwVbMzXjzz7zWBjcl7dZ4WKV33uVbZmv/2E5Gm5N4CqWOVbftggl4ND7Wfo7UVcFavLsau4zakbBq1FKOoQN5kFhjsKMWTvCA1h9pQYtOr2qgs7CLGTUS8zU5+QoccCqsuYVLiixcDNSEBFa2oanFDPJ6EdeadNboBXtTSv29vfVPXuvtGD1Bzz7r7ec2BLH/qiJ8rSR56L5iLQOrviz2D/3s5QDBMwfMiun8HDdwOtdSDn+J6ts7azkcnAhSedD/iB3CTbym5jyYuDhMLjaxOkGgByzrdxIeRrU0316q29iB+EsmfpDHF6CcMs0HCebD/4sLcc/RckRltuWbbfkDTtWf77D+YW/TnrRAAA" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE6WcbXPbuBWF/4vzNW032ey2m2+KJNfqyi8jyZvp7GQ4MAXbbCRSJanEbqf/veCLJAK4uPdAO/vJ8TnPgUG8EQD39/9e1Pqlvvh4kW4yndcXby92qn42P2+L9X6jq790//7n53q7Mb/8muXri4/v316kz9lmXer84uPvR8Robf6lqljGm5OoY31498uHH3/48L+3LuaT2qg81fOs4kv1htQLcJiK4XQ12mUQ76BEgKOXrKjuVKm241KruijxBMqKRF6q1Ihf8aCTAcLvIsg7EDrLa10+qlTj7KElGGG0UhvpJSFE3yR5yEkUxJSFWqeqqlelWuuF/vdeS603ZEEi8upRl9EpjisUNC7yx+xpX6o6K3Ke7kohZNvmtXm6wjAUNgVjmo6k+1YEVU/AwQcsdflNl8vsKQcfAmfjo/DmROpFON6QQhY+4rPabHQdEeAaIvDdD9EhR1so6lLtU931HzOSin2CkofQ18Vab6ZlKc0bli4EW2q9bv8+kzn9Jq0U3lByGL3Q1X4TG3A0hWNOPURiW0oECFWJL4fR5/CjQ+RFUciCRMhLJEKNgiOXSogdjYaWTGETHCMsnUg9CgeXUJwtGGXUqt6XOmb0CHniQqBxhHeGAtupkCcfJCxC7nJDGYuS+9dQJqIiexTrE8OgPkSoZbDQa2yhiAP7Caln4Njcj836A9WyNi27mub7LQy2LEDE6nUn14UjZrGP0uQ8UEkgqHMNlRIwqkJdvQSH+u9QiQDjezFrRSLRvkwYILzco20tAsX7NWkJRdxXUmvuFRxAbhcDlQSKbA+cTYqC2oEvFrHC87d0Egx87pQ8hEZeFMW3wk4gj1+WjocN127oOCY4+UC53Vo6GRbZdnmjHAe1X0oOoIU27ChlINiOaUMIr8LPLzG/g44EgksFbZqQRXOUNv1v4pZ7ulHNvw2JQ6GNe/d+CAy/pBJQV8yBiWU5QTyqBBSxSKBpRyEH9GcWAnYQcSCqsxOok4yDeSdI2aGdUk/WaYE//QweIrHQgQPgR4BBYug9g2XbJjbFPtUIUBsRR/EONmhOL2NJ/NlGgEuZ0BR6V1oOGvq4LP6cgM6hPHIGe1TABRFGOS3mAfkOiB/zaEiTnBI4M+AyLEtkgrsahHO6H7g05uSATvEMHJ06PKCxJyXHY84PaKxniKK7W39gRmfjk6hThBD+pEWZYN04hig6MmeRJjQlagYLGtk0YVM5EEW64nPAxsV4uUxna5mGtyKRgjzpo1CkRT1W3yHw0VEMHL/8zUQG98j3T3o/kecBNcrtPvFwuF7tDSga2mgkRlQpPQNHxyZIeTakdkw4lvR82HdrDoyPYcIZb23egvkxmRq+fvjlr+9+eo+fB3gppB4KCWyQ0wmWWMJjO1heEGf7g9X2TZWZetgAVfend3bUj2i9hSMsA8vHKo5M4qxsJniD8XGftzUVfJ31vHbmz/AVRjGpd6D8XQx6x1AjLjGQQaI/IhurtYArJkeqPd/A0JHTajIlbETSsMpy5RBZqp6BkuchR4ChhLAXzIQryHWgfKCaBmKGChyMkQFBH5CF1Y6jRrhSrZyEDA06cCHxjBPKw+rF02NsqW6GUo/4ZcB8UFXwmCVpfgkdjHwywtHdLLhn3oJ6Ebdj3mwXZaVeO1s1FM2SSkxd1aPyid2JP0J7LbsBO1pOk7vR6opZdXR/8kHIrDDGt/P5dLya3d4kl7eL69FqKVF9B4Mvdrq7Ft5NRddqJ+F9h4cftqC02G7Dl32S7tdQK5rcX1//M2nr7H4xZ4rZM209UwdN6ynrtgdPX8yrUsX0np7tWZh+mbYbnn3bueyBcgRpY2JMgTK1yf6jJ6pWs8cbrdd6LceQNjamNsPGr/p1Vdw+/EunNRLhWHi8GQiydLSvn6MSPJcQolWpy/gUz8bH3EYn3OLwpSlM+tw2QqDJOgYGXRd3BrWsyyx/krlDNTuXpMjXMImlgsaFwFc2zqxgc8fhFHt6EL+38acKJukE8OePL05lZXlg8u1/A9YNhHkz0AVvSAQ/eOy9iSJPqsHPJ4+Py6WR59/NQxpWl1nUJDrw9ccReNBgBbybhZYZPvAgZo/7N2ZAX79200UE2rNxId2x1zzbZvVCq/Q5vFbykwJeLm6WfzNzx7p/RHgU4cNjZpNzg3onErUt9nkdn3OyISHNzYNz/pqBD4iZmPVDlnenMrFRrheIaxtQdNDJBUTc6Pp7UX49o+psJxB1p550dMrRBAS0mz/G8bopVERnDbqByMN+wRn151gjwvoN1XMDB3YgtHu/jQ4b2OCQMyrRMnJB12rzWJRbve7fAvAk0slF3RT1pRm7Ilqg5eDfsKtiX6Z6+vKs9lUdMyXRVvaqX67M+rkozQtNRI7n4iOy7W6jt2atF5fh2viQar/bFaXRtsN9TA7hFFZPga//j3Diilxg1WST/GK2JOLKnVck8zxMTWVp4O7zETjURS2JR3SCX2QrgXTzf8pD8H+McIh4IK8OhvbSHJpX4AONvJAYKFyyVdQ1bQfZqGIKae0mhcrZQk8Gvrjya1HyB9+PvGIeeWMS7Jcwr2qV19yL0lGD9anV7fVsnNzfzFbL5G66SO6XkzG5/eXzSS+zFfb3z9NZq5uurqYLMMQ2cSe0Z8Bj2U1hItGNhd3DbAdW7oF2Auxplk/7Zg6QBvQeacn5RUmty1y51xhDXEuOvKvczX7Vr5dmTaG48f1I90xAhrSRQ4fAWzm93syPw0UznOP4+FHgsX2XTmr2c9dDji+GWhJzJ9b7U4gI4Yas+xfVutsYp0rSb9UkNf2/JjkUokUkQ7Hzd4bmfxDsWcL4wdyDwV2DjI7C8kjLJDKtH8NQv0lg+IAvHFT3r3AY3lKHofsKBR6VDKzONtzw3oMaFdQzfxvNZ5NkNJkspstl8mk0H92Mp8l8tlyxM9MwJoxg5kDbdH07mdLHZHJg6xWTDsU6J8nyikmrxehmeWnm6nOibLOY9Xk0n09XZyUNrdyB4+DS1HWRfoVTXCOTcehHszVMP1kAbnTZXSOTsa/O4A9NDPt7t/mC18rBIDKjS2zbGH53FNzeM7EDBmdyVIDjY478nnTenOrrhcrXxfZKVc9wiG8FcrotsMuy2DafpURn2XY2r+73/hvx1cQsRyPCPC+TtDUVfEkf61PwTi7wFrrel/lCN0fBev2b2ux1VADhhxLPTZIScv29r9H2Oyo4wfGxp8xdp8KWBgOtuzj4Qgx5HI/+soL5Ttzieev1I4/+ZMNbnDe3wbniNb+HyubfgT5h+8/YbahvsHOoD7shsC0OQ/uWYd41x+35+wnb35G3sa5cuhvfHelJ0FYkonZZl1lJuKNQQh72pA4vwboZqv5RFfntru1PQpBkR+Pj0kD44OxRAA+UErSZL5qbTgLxIJNwh0aKtj5PLwU0t1hRuKWVwN0UiqIdNQYH6vkkpJFfnFUhM8bt/U+76CHO/k7MG3pbjv+dmDvkSu+M+NtiWuRmBK27G1Sr4kq/sBNjv7TzTMy8a+ZMxa97OmirYznHfrYq+oHUJDM3xVw+42dyN8WTGRIXutoZKL8w6YJsA0Mu9VNW1abbNGvkdk801bva2uwNhgS9wPqEaTjfqc//6Jbjfk/oteWeRX1R2LVn89//Af+eTEwWXwAA" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 72e8279e..5583b96e 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE+V9W5PbOLLmX9mwXz01Im6U5q3Glxmftbsdbffp3eiYqGBLtK3pKqlWF1/OxPz3JQFCApKZIEBCVSdOP7lcRSQ+ZAKJzA9J8F9Pdtuv+yd/+fVfT35fb1ZP/sKePdlUd/WTvzxZ3q7rzeHP1f36ybMnx91t86u77ep4W+//bP500/zp6vPh7rb5+/K22u/rRtCTJ/9+dpIl1Una9Wq1q/f7k6j15lDvPlZLX1r3FCL12ZP7atc85gM791XMmDh19rW6va0PN+tVQndP3UZDHduWFIBNffi63f2eiMBrNRXC/fG32/Xy5vf6ewoEr9VUCJX5c6IWvFYjICCz7q/VbbVZ1m/W+0McEqfB1Lm4qg7VuE6fdk1jdeCOkgDzudrf3G139UhATvOMoDb1t8PNffVpLCq3fUZYh+2hur1Zbo+bkZPmqS9hGjRkVsdP54edx6MncL6ZO2nKZpyr0yZp1tk5dVqG5mMjYBBF+8zUORi/rZ56S91U9VCo/az9Y1LnTotpXa/q5fquuh2Mn85dOy2mdb3cbg67atl0EBfCnSEgLZOhuPOs84wDALqnps616i5ibbl9PT21GBykHUhoniX13DUY0bGn3922Wi2r/eHDrtrsP9a7n+r/d6wHNxmq2VQL7NefNvWqcZrfb5sOpoB42hM1rClKF7jqnu/q6lB3rjJObViTqSqLDvrJzhMzAHTc1LQ+HJq/Vof1djManS9jKry+BdNmPtrmQRwP3XOCG8KHPHXvDUBL24uT4EXuzSG9JezVSdBWzd/Wm/h5j6LzhUwG2J/5v2j6I2Xeey3yUDYj+316ah2pGH+wuFpeVcdlbdx/E8MMG6/3/FSVHM6ibpo05vOo/p8iUgaV1B86rqK321V9+3K32+4GsJ0fnKqUZSMprbOnXZPBUTujITq/a3aR4dwP9n9uNQ6Cq3G7ogcg2MceLOHyOkz086cxTWRzfQxJdO4QhGgm08eQRmUOgYjfR3wUiVvHoC5i4hOgh+iQZLDzuG0edJ+wsw8BOHR/T8Xgt5sM47hJyo58LEjjyYAmwMkPJnHnRCyVuGEOaqdJWY5DzAnQim0ypnPOejvGey3v5eZ4d4Lxpdqtq99ucRTn5/9UjNhGlJT8vG3d3By+39cjO356ah2tCmewhEXe1ZvVevNpGqSrs5QR0K66cREITwzERIyunPwon2/v7pt9dqJtrxwx+TG+qta39WoiwpOQLPjYbFEWMmqVti0HoI5Yn1hQGXGg5D76ACdKve6ij5S8MU07U+qDSDlUigESe6rUR5J0rBQDJf5cqQ8m8WCJgOPOzJ/3g6lO+8jUmTgYy506eRoXvmnc1LRf7+9vq+83+r+x3YJGqQBcnf4Sw7SYhy6uV6ebSM126Kfmq27HadlqGMCq/lgdb2PPylwU/ZbpUPpmjnDp5wcfwKGDzqLduTOaac4cAkhx5cMgYh05RJHkxodhxDtxCCTRhaNQ1BlId/JS76/v19ff1tv9u2pX3WkO1uEMPx43Ot3CyhbwprkTkpEInoYfic9bwnLCWqSIUvfo60EGegW7vOSw+yH1oxnYH3f3yz8VD6MAoHRiMnyqDw86E7z+/ijT4DxoOwf4A80BR92DEwAW0TyQSs7d/vGmg63V6WaFfPBZMVBvdNvs3/6TD+Qm8I7/KBMEGb2dIuUDTRHMAMOT5BGmxx91YpynxOLhpwQ9GXamcsLUCbw6blYPNCPQfv8o06I/+FOs+VDBJqL/wbzv1X28el7dP3hm13X5FPxuXO7WNARDdyl/MZ+anQXBTsu/etCxQwtnBGNSijD88UnDeOzJ0XDsEEbGu6kjmRS6hceSITibMJqLjOPyI5iyMYaHMX3rixgL5cKrZbMJfE8Yimnw8M7c6fcp9oeRbr1rjekks4OPG8BEV08P5xJOP3JIE9x/hvGkbwTJwxq7JYwe3bTNIXJ8ObaJHCO88NgeclSTNpHIoWXYTlLGV7A5urOcBtZ1TQ1rxE4iC+cui0Zjh91x6Z46xfT41G947v2wX/1pvf/TevO53q0Pui5oSF9pO0Ucuim7QIKPjwIz3n+ne+dEQCM97xi/GoUsg89M84ipqPLhCfiyKFDT/VTgveaP60/HnV9QH+sVvKY9v3C/2x7qZeMX/tc0R+EB/q3a1++qw+c0rE6rh4FZteRRGkbb5GIAnbzGVp2hPFd4nw02fZBcZxjB0/Aj6aXUuJywFqkJDN+pfpDBXmHdXnL4OTjji409qTxhuhIQ5QfrVR52ZvT6/KNMC3/gSeUKGeYEUDtdsvCws8Hv8I8yFZxRJxUoZJgHrsIDp84nWQ+jENjlH2UieONOKkTIMBV8pQ8GbkNniv6zDx6aWSYf/G5c8NU0BEMnUq0J4VUQ8PQAqjeEAQJsbCwQHsa03T51DKO2r/AAJmxQqehH+t0w/kmeNWIElLOIOb1CGjy823C5W+wPIx1I1xrTyQVcSdwgMjgVeliXci+RQ5voaEaPa5zLiRzUFOczekRj3VDkmKY5pJRRuecfboMQT+Y+9zDnH70ep55/eENN9jVRCCf7kUQvEae2SR4gZX1HwZmwdtNWZhSaSatuMpuPzvHMbH4M4Bg2H5ntOdn8GJiDbH4fYz42nwDoxHnte84jmHyy2YPEfOHen9J/jo//aBm0xmge7vlx13bhvY1/iZFd9fq6xEBzkC55B5pEyo8fMVRvcEUNUSzn5x50zdgM0/l/+qpoGjnDpHfb5HlPopswsz2wwaT39FhMwgseflgjuvE5/OUIc3Yt4fhzGnYY8RQT4wMIpxH24dDmbJ95mPTB621q6nAaXpoVB2GNt9Lk0LOnn8xh5xDQmJDTx5g13ByCNxhq+tjyhZkIMMermjsuRgSZgYYP4m2H+n8aeiDeC4ekhHQXrAMAlxRdanxXoLdLDTZHyJl7uElB57Rx+2qm84yHsrrb1f90k5/GmlTlMdHeZwUPGTvqvYusekgoBv6fYvoxF1DkmgERd094Dw7Q/Dn0gvb5P30y9AedVOMxcTogKh+cEA86E/5YUyDtVolsticqe84yhkgn98kHjqEtteP9ZkyU3DTzBhw8fkqLiAIYJ0S6APDwIXQ+0CMDtZGIE2ORKOCjoo00/OO30NAIpm6SY8eQGXxu1LjbiiFce48/tANzKcz+r0e5sq5tXxM5nVoM7inujRpEdkcXNZCxLm/qKFKdX9pgxrnBkWOa4BCjRjXZNU4e18UGdLmRuEcX58dDdO/5qYc5vgD9TT3AcAaZ4g1jgI32dfG+LALGSE+V7IlSoIzyMyP8SASmqV4ixQskwRmPY9yxF7KuMh98DYONOfqCOLMefg1DHDz+gvjyHYDhk+5safNkq48Tvrvt6uh8Qqf9G+Klz9KcL1L99fr9y5t31x/+fhLW+yKPFnd6Lsr9a3Rof89/fPPm5fMPr3/84ebVjz+9vf7wfqDjfoMxCNK+gBXqOPIDWIQIcv3uv0yCc2UEjIGERAfe19KmIttfCtlhKrLDpZDdr++d7WkUNisiDzr3WyTdh3avd59CX0TRop1Hxyw6/yOJu9vU7p6aNsMqcIdEdL+914F5MoRzu9EwnFj7r81j1+9eUxuL8bTmmTEKT4yze92RUTY1YjueKVEJiiIyJhmJaygA6UOKCj9GognGGn0ow5FGAg5nbrazd72rV/4npDE43pMPNU/7nSbPVn+EhDU+ruvbVSoS22g8BidE2t7XZuq/r3df6t3b6nwOg28l/QZjjNILMZfbuztn2YIg0/w1Nsx88fPbt//3RgeRP//0hh5PJ9V/PGo0HVqUHG6b7Q76OOzltyb1CjA2HYBei8kY9vWhCen/d/39w/bH3/7ZrNNBDL0WOTA0PmC9vD4ePqfA6DXKgqRunt8lQ+m1yoHlx1QYP+ZG8L4Z1/KznnDDsxM8n6H/Zhnerv+rflEdqtcff6jrlfOJVhoF0moylsO23WffH3buB4EpCO7Dk3s2TF4XxL3qehyEgLYaiSXpQGmw/6f4n+Ly16B0XFPBrQQLBHs7ivNQcGNx05nnbiu9HuqD+xZkP9D3+yHaR1rQHRYV3mkfngXP05OseFiUQDJPa5a1/jELYEfa5SDfN4K/bnehz4wmQHakXQ5ytWzA7T9sf683mWaGJ/BywHup0yTUaFqVG/JeR8WvN6v6Wx7UvsDL6vrHQd4iUd0/xhEak4B/3O7u2qDguZvUTUIOJGaF7majYNPNhjl6142R7ikDT+a9plQ2G+ht0vaXmN4PwUjJ8wOyIvfnVHCTt+TojTgVWYa9N3rHTcWWYZNN2VqTjZplNx1LPw7Cy7BtpmyWqfDy7I8pu+IYBU7fCJO2v1SImXa8uH1uCrjpWxu1oXmVFuv9f+y3m7frCQ7RE5FBoTDNJRLbcCrr7JTrTTsv/1yBDz6cpHUP3HQPBOUi3/jo6w0KvCYFuyqCOEds/KGO47Z7AMJKoJZko8P6NhGHbYMctKy/VId6Cp7fsYgjiOZ3EGRMwuKtrI/6cw6JcE6NRtsH1pu9RqKJIATbJhuCH+pDE5P8PgaI2zQPnrZEjK50C+IBTbPpJ3DF2JB+Iq4YS8dD1iYOoRksTEzHYqq2xkwdp2UeNEN35YWdb+RleYmYDlvA6MehcZqNx4HssPfrm9o75u7vsfaR+F323Wvi6Lwv0z4bu9Oe8FIufLe9G9f5U7dpLIyTiEl7PwEobfsPQfJ23M+Hw/3zZkdPB+S0zIameXIcmHPDnFjeNkum+jQOzrntFESp3oLAk+Awgvpxr3barO/ub+u7pj1ZHNOH1W/1KGudgEGs+mCFcl9xiGay+AMK9Kh3QBJhj/YZFGjUe1wMcYJfoQBjHuaSeBN8TwAy5oVyoh7tnyjMqKfKqmfPh1XHw+ftbv1fSS4MNHokD4ahyOXAoFoy+S8Ucjb3RYOe4L1QyHmcVyTeJN+Fws3iuuLRJnkuCnAWx0VjnuC3UMR53FZAx47X+mF7eLU9buI9ltfgUbxVH0EeT+WrIouXQqBm8lAU2NHeCYGawzNF4UzwSgjMDB4pFmWCN8KBZvBEFNbRXghBmsMDkTp1vM/rzZfqdr3q6LkX0S4Aa/covogEksclofrJ4plo4Jkc1AD00X6KBp7DXaWgTvBaNOgMzisRc4IPC8LO4MoGkI/2aDTuHI5tSN99/9YR5ukOzm/4mB4OQZLVxQEV5fRxGPS8To4EP9XLYdAzurk43Ol+DoOdz9FFo073dATwfK6OxD7V12HIMzo7WudUNDcuhHp0PwdhXCCOu1QUd+EY7jIR3CXjt4tEbxeM3S4VuV02brtM1HbJmC0+YhsZJT26F+vhuESsdrFI7dJx2oWitIvGaJeJ0C4Zn10sOrtwbHahyOyicVmMR7vbHjfJUZnT6lH9GYCR1505msnqzSDozM4MhT3Zl0HQOV3ZMOIRngwCzujIovCO8GMI5IxuDEU92YtBzDmdGK7nvg+zJbPpRBpo+Zi+DIOS1Z9BLeX0aSj4vH6Nhj/Vt6HgM/q3SOTpPg4Fns/PxeNO93UU9Hz+jkY/1eeh2DP6vYDe+77vXaOtVFdzavOY/s4HkdXTnXWS08cBwHm9GwZ5ql8DgDN6tEG06b4MgM3nxWKwpvuvPtx8ngtDPNVnAbwZvRWq376ferO+WyenmedGj+mpAIqsrspRS05fBSHndVYo6KneCkLO6K6G8ab7Kwg3n8OKQpvusRDA+VwWinmqz4KIMzotXMfuG4W3u7pafTcXkEY7jH6rx3nLEIeRx3EhmsnzJiIBOpPrCsIe/7YiATqH84pHnOC9KMAZ3FcS3pS3HmnIGRxYEPX4NyMJzDlcWFjPjg97W922t7vUq+620Gj/gTZ8FE9GI8njzHAVZfFnAeiZXNoQ+NFeLQA9h2NLwp3g2wKwM7i3VNQJHi4MPIOTG8I+2s8FkOdwdYM6996z3B/v77e7Rup101u8t0MbPtL7lhSSXO9cYirK9N4lCT3bu5dh8BPevySh53kHMwF3grcLwM7g7VJRJ72PGQKe5Z3MMPYJ72WSyPO8mzmgc6R6o31uxPsDTrNHrd+AOPIWcLjKyVrB0YOduYQDBz65hqMHO2cRRwTmEVUcPcgZyzjiEI+o48BAZyzkwHFPruTooc5ZykHouu/RXjRh3nqjr/tM9Saw6WN6NhRLVu/WU1ROD4fDz+vlAgOY6ulw+Bm9XSz2dI+HQ8/n9RKQp3s+Enw+7xfAP9UD4ugzesGQ7vue0N5rmhzd+Q0f0wsiSLL6QKCinB4Qg57X/5Hgp3o/DHpG3xeHO93zYbDz+b1o1OlejwCez+eR2Kd6PAx5Rn9H69z79ul+e9wt65ffPlfH/SHhkjS85aP4uwCUPA6P0FIWjxcCn8nlDcIf7fNC4HM4vTTkCV4vBDyD20vGneD3BqBncHyD6Ed7vhD2HK5vWO+O73ulb/LXxSg/1dXyc4LzI5o+ivcLYcnj/ihFZfF/QfiZHODwAEZ7wCD8HC4wEXuCDwxCz+AE05EneMEh8Bnc4DD+0X4wiD6HI4zQfT/nfb/+tKlX76rvt9sq3heSjR8z9yXQZM1/EXXlzIGpIeTNg4ODmJoLU0PImA/H40/PiSn4+fLiJPTpuXFgAPny4+AYpubI1Agy5slhG9Dvu74/VIdj8mUkSOv/Du+9QjgXeffV1dgl3n/tDeIy78Diw8j1HmxvEBd4FzZiBOnekhxAPneZhn/8e7HYEPK/G4uPItf7sb0xXOAdWWIEznK2EtoT6NMg+t+cav+MuEHi7RBPWF8jWtg1IRIdnxYY8KrXh+3demluRIjv+CnSNAaJETHJQ0IkaZ+WQkFgVj0ePjdt18vKRdO3rvtYtJWfd82v0U76Q/Y6QRvHzgavwylWiISUaJ1hqQGf+L+Dn9+MBVz1P/0d81XO8cg7sXnQe8IuOALPjThN666eOochUKlZZ5A3it+O69vVf/zyIQN0R9Tl8NbfDrtqeXhX3+WZOlDeQ82ezTb8uc9Y/FbOJXH394nfwOdKeztE90D03jD4/VMr8K+kYGygFmcgEngb/pwy1u9Tt10cAtt+EMn1pivuC3x+NYzJkzAanb/NDMRJKKAqMkKKxTBKK9V0TdDT/+auuh9cAu1DqcvgrSOXGqeWe34+bUFo5IGpOPy15gCKp0BCPCRHErnrroanAArKNMyKZTiXCwGK/77nMKr+FLU/0PPT/pAcv9PDPYl8TsvGBngCS6z9jSl8ebMOhVh450/9tpFATjIcREpKrk6Qbm4O3++TVeGiuTIi/lSMgHXljopQ2l+b597X99vbdZUF5pUvcArkTmbQ1Qd8DwH61OyxjWyAXJ1aJ6uqGwmhnpeHz9MgXRkJI2ENGO+Xej0RnZFwGXR/+zoZXifiMvh+3q+WE/F1Ii5l3cmTrxNxGXwtM327bmSNcB9u0wkuBCFo3kWQHTQqKGACNi98WW43H9efjrv6VROv/cd+u0kGh0mYgC6Zj6NhxbNv0er6VB9e1B+r4+3h532dDqrXfAouLN5rxly58x4J+LpHghEfPwv/5eXrm3cvf7p5+eHvL386yf1S7dbVb4Rkr0l09GehB1H8rfkhDUTbIg+Gv41Qxd8uoIvrDz++ff385ucfXn94r2X//P7F8zg4aNMJqJA5qE+UAhPQ/D0637DvOr573fi9V9vdXRWI/jvZSJvIMXbgCT/+4uWr65/ffLh5+/L9++u/vRyN42lfUBQuTOAUzzkEM8mFRkH0zvt2n47tl94Hahs6ud7Tj2LNPoLRdvSHPt2CCLQxtqNg+evxUO821W2c1bynH2kNQgQTVp879Bzrrgdt3IrDYSFe9HkXqum3JWP9gtfoMf1oH8hUR+rrI5snRYBOcKUUSMS+P2/2btVbLF7Q7DFtjEGZamWolWx2RsFOsDQNFImzPupS8JtDW7NTLb0F3Yu5+s9Gx1+m4vwD0ktPOUgvvdaRcwsZ3ASrRQNLM16MWGp53IUPHOMR3/VOICOOfhORwwzYeerv1T5ABcUPA5WaV/+BUbxZb37PP4pO6gVHMXz2FI89/iQqFXHPd5GOKuiVEB94qPeH/Z8r8122m4NbfNPzgfrZG/fZkb25BRJxffZajOvZOQGM6hc+P63XlB7H9+YJHOrO+++4/vpzOapnotk4DIeu7DaqZ+/hcf0d95F9nR4c2c9hfRsggro+2oeC8pW7ay5/f3WOQD4eN1r3hFDzdGTE4UIm+/6pPhx3m/+sbo91CginWX40P9X/rJeHejUSldc8F7pmH+w+ltmeCfz9hXvmMYAMaToJlcObftUfJHaqhxCq1IVin8/Vv1268QjOLfJZZlM3mWRtPs7cqvh9Xa/ijYO1zo3tp2qzakzvRpaRuM4tc2Ha1F+76eiXCA4AAs1yzaD/vH7z+sXN9YsXPzWZ8M3bH1+8fBM7lZCmeVH9cv3mzcsPY0C5LfNi+vDT9Q/vX738aQwqv+1lLPjX6zfXPzx/efPm9fsP4wzpSsiL0UoeoTqvaa6VuNzVzQq//rbeNmtq+XvsSgTNcumoDY321/drD8qActw207QSqk9KBfE0tkLJweJJoSiOZid/fty1Uryj8pH4rnriRsLt1470QoRUw/qtHs20CIxRxgVKoM1rwoDp8K5cWaOBDhQFGUeQDTIQdynUt+t9p5p9BtC+tMtj7lWQ54AeX1Q+egSn+QjfSMkwxc8iM6J3XFjHcNWpTgy2ezQ3hgIZ5ch6qiDMvTOv2BkS89Vxs4qesCGsV6jYCfCHJ22Xc2RB74m7HOp2XV/bJlmAQ4kPofFEPxGp+FGuYrz+U711rBXGOezEcXRxfsYFACVmxY7QQqkOG7Z7NIeNAhnlsHuqIIz9225brZbV/mBvrMgB9QqTOgF81ITNOoCeyMuhtyeduaD78i6Hu3VLtqNoNxFEDiVmxU6erZiAMOoUx3k0+RwHmrjfRfdEdD1Jb9b0jqxPIj/QslHNWsnj3/PGu05507snYWQBCIFkVLVHNCasligWmd82Gz5YtBF695tA9inu3e8UFPYO9lFg3MYZMf0CT7cSIDltMyJqz4e68GkcLCggIzbnqyGTIBJyMiIdvAiCBhd9A0QSnoFrIAJwIu+CSEETXfFKw+qLyIjv/VR0UEBGbNFlfDS65Jq9kfgmYsuIa29NMgUdISTnvNNX+I2acLblZSwZLrWMsmZcXWU0vuEiSirkia6YDGJBwu4mCQgVTrV/Dofys0VZSOftSb2/X797bd5tPonWkqBg8HBs9K0xRxIK0f3GswiYiKSjoFRMqSdAqLxewpdVbR7EhJtGQlj9YUefDSZDTzkSfAzVnvBZvfKJej0PmPBTgWO1ZPSjTtPi1IznJZAgH6/veFJ8BF7suHWCcnNq1ffoXbIR6dLh0w/m09GOE516b6iE7QKneMnYxp3d4WIHVwg8tEhHm3RWNwYlfkqXDjT1bG6aRqOcTqRiE93OeP3GOfdYLae690Tc+KlbOuLUs7ZorL7XbCvHIl2m9+iD+ct+r4nO0h8hvUKwyrw0ROkFeYi8QYvZhCnSar3HH8xyeM+J1uuPlrAgfQCaDm7UuSchNsZb5ICcfNI5Ci92yDkCbNrZ5iik+LHmCKypp5nxaEH82r+iDd81Ts89XMzqd5karZ4HRiTHx0GfiyO4Oia4WUdE+ED8a0SeTuD5mpSfRyOqoqIJHFKVGEHEYuodhKeAOiQu/mhUbZvuLtZ3u+2X9WokQFzOZKz9Q3/ASteb4x3pn8yzI1d9cV7y717+8OL1D39L7vTpuWGSE+zGiGL5608/Xr94fu287BONxm2aDc/zH9++e/Pyw8t0OE7LbGheXb9+8/JFOpZTu2lIcNL8RXWowovq/NwDU+WnLkex5HpgwU3BOXROQHHlNE6EM+Du9u6bqimIuoaT0cAZ0r78Ojw/7FMPNju8DhPnxmlIo22A9Z5kgZOA8GyoN8vd9/vDKDhu25yY2ps+PlSfRiA6t8yJZ/1lBBTdaCKKXrjvF43gwYl+ZuQqgR06dTnhXp0Hx3bdP8D1Qvze+W371+h6yfA1w1rUz7g8DLsGNuEmLb+/tOuyTm1HlkSCvkeVQmIYEIoCHF4OqiHpJHgQw0CZI+g8srxxsFfs6Guo76STrphxJyo+4ZB4sPf13f12lwoANJqKYbgUBfQfX4KC9o14rvCdPUm39TTrswre+2Kk6cdi/Rd9P8Dq7Mg/bLujgb/X34BCAygCzaeju91+alLln+r9fdN38JoeA8d/fnr/u/pTs1brnb4IQd8Yu6zvD+5F3SQUsul0VM3+8aXeHYySP2wbfQ/D6bcZiQOZ/YAM601/8/fovXvImXTifqGkYqP4Giy8eXv9f+zVIC/fp3T8FLaMgnEVrlgx+2ISjFOTHP2vN+sk7T/tGuToW1/o2gyljZHbj/E5twEF9lcE04CgpPAnCnlbA2r6elu16z74wRIEMN4+C860DzPFYbtCfvenIqFazu8msoeo/PoyI9LJ+MUGNpCR3unnLj1C08ujjTGcxyBDHJXLUItkqr5PTfKjSZ7dPd4oF5KqV8wUA6dCS5cyYxqxR8CWF8P2rjp8frerP66/jcHntb4YxtebVT0Knm2Yf0utv7VpYhKmU5McwciqbkYQ/vIYAsFtlV8neOlYfIwYXSyWgubQviU98HUMGpHXOr/GdnX4JTIE2KlJfjRmdoyxH2x5YWyJPr7fNj++347r21MkH/rMM4Kv3/a/R2gNcF2B/5/Cs9SYbEAuuaCr5edx3sVvmN/4exNQJsZBtk0OZ4fUnEcG4nmdLl5VHgMlsY48Gs3wJ88JMPF11rEWgsXrkRaKrlOPxRFx1wGOJOGeg1gs6SCy9b6vvtTpy/bcKMsMbfbyZAxOo0xW6L5gOtKF9FpnCd+qTftCdaKjt21yIDBfhEgCcGqSL4Advl2HjF7jS5Sj8AwfZSFI4o+zYufqy2/r9lznU7sCkqcqbHwRrvWlqUVpkoYRRCtsnAWhKBaCz855NVzop2MRp3x8cDnD1xmITrrt680au9eq35//+LSuY/uc2FnTaKCb7omRHcC4AetiMEgY7AS+MvKTeV8y3CvdaCSM5y4TEAOBaDCp+xQVUC0mATALOL57+PzIzukvA2JdY0+P7FjTnP73Z7EevcdGdtXbT7GOhnfO2G5MTfLLzfEuqkPv8YldD3o/8ODI7rxyNqyb8LuEQ+LBiTvWwVCxTlwXg+ryHpu2MelrZHX1xbtqV93pRTww94daZgD06j4awav7TF1WbaXh9/h+T89n6Dy61+lrMd3eQy0zABqwd+/RHF1G2Bt/PkPn0b1Oc4bptg61mghkwMbeY1O7irBt/9mJnUb1NnVrSLdouN1kMANWBQ9O7y7CstjTkzuO7HFCuO1+iV1bqT6471ujITfZJgeI+K6ndGj4gn5f3R9sb6fHwtzNk3//49mTtT5r/8u/nnxplNHC+8sTdsWvFk2Dj+v6dtU0/tUAaMRt7+5aEf/o/vaf9VJXrv7lV/PIn2dPnv06e6aKK8XUP/7x7FfbQv9B/0I/VjT/K57J2ZUS3lOF9xRr/seeSXUli7n3GPMe483/+DMxv1Kce49x7zHR/E9g0oT3mGz+J7HHpPeYav6nsMeU91jZ/K9EBlp6T82b/82Rp+beU41Ffl0gTy181baaLmaYcoENtBEKbAyFb4eCEaMofEMUnBhH4VuiEMRICt8UhSSH4hujaJVeMOxB3xxFSc2VwrdI0aq+4M8kvyokeNK3StGqvxDYnC98yzBtGYk9yXzTMG0ahfXOwBJpLVCU2IiYbxzGKR0x3zqsNUIxR9edbx+m7bNAn/QNxFozsBn6pG8hVlLLlPkWYq0ZWIFq07cQa83AcEfiW4jPSG1y30K8IJ2ObyDOyInEgRtrzcDwJ30L8dYMDFUS9y3EWzMwieL0LcS1hdApx30L8dYOrER7903EtYnQmcR9E3FtogVmTO6bSLR24OgWI3wTCW0ibJcRvokEo2wpfAsJTm1IAmw1gtpEhG8fIUmbC98+QpFTU/j2ESU544RvH9EagTNUl759RGsEztEnffvIGekTpG8fWZDzSPoGktpAqIuVvoWkjgUkNnbpm0i2huDqGVNXQhX+kyAgaA3BcZy+jWRrCI7Od+nbSOp9CNeSbyPZGkKgnlP6NpILeuy+jVRrCIHu/Mq3kSqInV/5FlKM2PmVbx/FiZ1f+dZRgtr5lW8c1VpAYLuaAvFaawDB0TH7tlF6B0Jnm/Jto+akd1W+bdSC7t23TTmjnFHpm6ZsLSDQaKL0jVO2NhBosFr65ik5Ye7SN08pCHOXvnVKSZi79I1TKsrcJQintW3QtVj6tinn5PoufduU2jbzZ0JeSc78J33bzGekzLlvnLk2zgKTOfeNM2e0TN8489YGcvZMqKuF8qfG3DfPnPZtc99Ac53tFKhM30RzRcv0bTRvDSEZOnaQ9tA2mvs2mreGkBzF6dtoQdto4dto0RpColHUwrfRgrbRwrfRgpNzaeHbaCHIGbLwbbSQpN0Xvo0WirTmwrfRgrbRwrfRYk5qfgHSU20jNOpZwBSVNpL5m/tsQarU/M19lpFKNX9zn6WXk/mb+6wgFWv+5j4rSdWav7nPKlK55m/us9pkqBc3f3Of1UYrn7FmF1HwWZC+zmj3Z/7mPKsZBEK/PXahoPUL+QXNIxD6hRyD5hII/UKeQfMJhH4h16ApBYnrAdINmlWQhB6A3TSxoGYo5wBJB00tKIKSAXbT5AKxhgDxUGh6QTFUD4B6KDTBQMhlkBdqbaMa/YorBuAC9qHQJAMlFphN0wxK4HCB2TTRQMkFZtNUg5K4XGA2zTZQcoHZNN+g8KUJuIiCBcwG2IiCB8wG+IhC0w64KQAjUWjegVAvh4wep1UGWIlCcw8KDc4KwEsUPGA2wEwUmn+g1ADMphkIQg3AapqCoNQArKZJCEoNwGqahlBoFlgAiqLQTAThqAFLUWgyglADICoKzUfgahCQiw0sNsBWFJqTINQA+IpCsxKEPwWMRaF5CcKfAs6i0MwE4U8Ba1FobkKhaXYBeItCBmISwFwUmp8o8b0NcBeFpIPHArAXheYoStz/A/6iCBAYhYQ8ugzgBXbTTEWJslwFYDEKGXCSgMcoNFtBYQB203xFiabLBeAyCs1YEEsIsBmFCtgNMBqFZi6I+QtYjUKzF8T8BcxGoQkMYv4CcqPQHEaJpiiFgkcgdIJWAIaj0DxGKXG8wG6KTtIKwHIUmssoFS4X2K0MrDdAdRSa0ChL1G6A7CjKwHoDdEdh+I45LhfYrQysN0B7FJreKPH5AKiPogzYrYSnV61t5igZWAD+owgQIAVgQArNcxDzAXAghWY6CBsDFqSYB+wGeJBCsx2ELQATUmi+g9Av4EIKzXjMcZ8K2JBiHohKAB9SaNaD0BlgRArNe1A6gweP84DOgN0090HpDNhNsx+EzgAzUmj+Y47vAYAbKTQDQvhfwI4UmgMhdAb4kUKzIITOAENSaB6E0BngSArNhBA6AyxJobkQSmfAboYowfcLwJQUhioh5MJD4xm5XzDAlTDNh8zRYxoGuBKm+ZA5SnMzwJUwzYfMiZNrcHo8o/0kA1wJ03zIXOFywQmy5kPmJf4sOEPWfMh8jj8LjpE1HzJHjx4Z4EqY5kMW6OEjA1wJ03zIAj+fBlwJ03zIAj2IY4ArYZoPWeA2BlwJM1wJujYZ4EqY4UrQ+csAV8IMV4LOXwa4Eqb5EGL+Aq6EaT5kgc9JwJWwgua4GOBKmOZDFvj8hUUamg9Z4HMSlmloPmSBz8leoYa2Gz4nYamGJkQW+JyE1RqmXGOGT0pYsGEqNmb4rIQ1G8ycyuDTEpZtaE6kmOHzEpZuaFKkmOGGhtUbmhUpZrj1AGXCTAXHDDcf4EyYJkaKGW4/wJowTseVDLAmTDMjxQw3NqBNGDcGxMtoAG/CNDdStEdlSGkQIE6YJkcKvMSLAeaEaXqkKPAyGcCdMM2PFAWaoTFAnjBO73YMkCdMEyRFgRcAAfaECVPBhh45MECfME2RFAXK0jHAnzBBs5UMEChMBBwnIFCYJkkIpwUIFGYqPghTAwaFmaIPwtSAQmFiHjA14FCY5kkoUwMShWmihDA1IFGYLAKmBiwKkyxgakCjME2VUKYGPAoL8CgM8ChMmtWHOwxApDBp7Ic7AcCkMGnsh7t8QKUwTZdghU0MEClMkyXEfANECtNkScHwnRowKUyzJQVRfgeoFKbpkoKowANcClOmTpFjwwNcCjNlIm0lHLJEAJnCNGFSMHwKATaFKVNRiu8jgE5hmjIp8FImBvgUpjmTAq+KY4BQYZo0QXlcBvgUVhrzLZ5xdtUkzP7DgFBhmjQp8DI6BhgVVpoSRtzWgFJhmjYpOHvGxZUU8GFgP82bENMTcCpM8yYF57hgYD5TUMIF/jCsODUFcxJ/GJivnIfUDMynuZOC47MIECtMkyeU5gCzwub0wQEDzAqbs4DmALXC5jygOcCtMM2fUJoD5Aqby4DmALvC5saAuKcF9AqblyHNwbLhQN4A+BU2X4Q0B+y3mAU0BxgWtigCmgMUC1uwgOYAx8IWxoD4tgNIFrYQAc0BloUtAsELYFnYQgU0B2gWtihDmgP2W8xDmoOV34uQ5mDxtzEgXoUMqBY+K2jNccC18BnNkXHAtfAZpzXHAdnCZ4LWHAdsC59JWnMc0C18pmjNccC3cM2pFALdTjggXPhsHtIcqAuf0QEMB4wLN2++EJoDlAs3b78QmgOcCy9YQHOAdOEFD2gOsC5cMyuFQPdWDmgXbt6HITQHeBdualRwzQHehRdlSHPAft2rMYTmgP3M2zGU5oABWSCE4YB74eYdGYGyExyQL9y8JkNoDrAvnNGsGQfsCzfsC6E5wL5ww74QmgPsCzfsC6E5wL5ww75QmgMGNOyLQKkaDtgXbtgXSnPAgJw+i+XwBRpDvhCagy/RdG/R4JrrvUfDA5qDr9IY9oXQHHybxrAveG04hy/UGPaF0Bx8p0YTLJTmgP0M+UJpDtiPL0KaA/Yz7AuhOcC+cMO+EJoD7As37Aters4B+8JFIIfggH7hgs4hOKBfuAjkEBzwL1wEcggO+BcuAjkEB/wLF4EcggP+hRv+RaA5BAf8C5eBHIIDAoZLOofggH/hMpBDcMC/cBnIITjgX7gM5BAcEDBcBnIIDggYbggYgeYQHBAwXAZyCA4IGC7pHIIDCobLQA7BAQfDVSCH4ICD4SqQQ3DAwXAVyCE44GC44WAEmkNwQMJwFcghOCBhuKJzCA44GK4COQQHHAxXgRyCAw6Gq0AOwQEHw1Ugh+CAheGGhRF4DgFYGF6GcgjAwvAykEMAEoaXoRwCkDC8DOUQgIXhZSiHACwML0M5BGBhuGFhJJ5DABaGl6EcArAwvAzkEICE4fNQDgFIGD4P5RCAheHzUA4BWBg+D+UQgIXhhoWReA4BWBg+D+UQgIXh80AOAUgYPg/lEICE4fNQDgFYGD4P5RCAheGLUA4BWBhuWBiJ5xCAheGLUA4BWBi+COQQgIThi1AOAUgYvgjlEICF4YtQDgFYGL4I5RCAheGGhZF4DgFYGL4I5RCAhREzOocQgIQRs0AOIQAJI2aBHEIAFkbMAjmEACyMmAVyCAFYGGFYGInmEAKwMGIWyCEEYGHEjM4hBCBhxCyQQwhAwohZIIcQgIURRSCHEICFEUUghxCAhRGGhZFoDiEACyOKQA4hAAsjCjqHEICEEUUghxCAhBFFIIcQgIURRSCHEICFEUUghxCAhRGGhZFoDiEACyNYIIcQgIURjM4hBCBhBAvkEAKQMIIFcggBWBjBAjmEACyMYIEcQgAWRhgWRqI5hAAsjOhYGOzGCcDBCMPBSDTCFoCDEYwOYASgYIQpgJFoACoAByMMB6Pw2zQAByM4HYAKQMEIQ8HgtQsCUDDCUDAKjV8EoGCEoWAUfmkFoGCEoWAUfm8FoGCEKYBRuGMGHIwwHIzCfRHgYIThYBS+/OD9JoaDQS9iEfCGE0PB4K9cCXjLiaFgFD7l4E0nhoLBrxvpXXZi7IdPOXjhiaFgSnzKwTtPuktP8JkBrz0xFEyJzwx484mhYEp8ZsDLT0QgAxSAghGGginxaQQoGGFqYEr00g4BOBhhOJgSn0aAgxGSrmASgIIRhoIpcScHKBhhKJgSn0aAghGSfrlBAAZGGAamxKcRYGCEKYGZ49MIUDDCUDBzfBoBCkYYCmaOTyNAwQhDweAV1wJQMMJQMHP8DjpAwQhDweA11wJQMMJQMHghtQAUjAhQMAJQMMJQMHjVtQAUjDAUDF52LQAFIwwFg9ddC0DBCEPB4IXXAlAwwlAweOW1ABSMMBQMXnotAAUjTCEMXnstAAcjDAeDFzMLwMEIw8Es0KtkBOBgRBkwIKBghKFg8HJmASgYYSgYCgUwYElzoAIwMMLUweCF0gJQMMJQMAQKQMGIQB2MAAyMMAwMXoItAAMjDANDoQDmmwfyB0DACEPA4MXdAhAwwpTBUCiA+eaB/A8QMEJzLAyvGheAgBGaY8HvhhOAfxGLQPoO6Bdh6Be84lAA+kVohoXN0ApXAegXoSkWNsPvagP8i1iE0nfAvwjDvxA7NuBfxMJce0jcmwbMpykWhhfFC8C/iIWxH749AP5FaIqF4UXxAvAvUnMsDC+Kl4CAkZpjYXihuwQEjJwZC6IzXwICRmqOhRXoBJWAgJGaY2EF6vIlIGCk5lhYgbp8CQgYqTkWVqAWlICAkZpkYfhdoBIwMHJm7q9ELSgBAyM1ycLwimYJGBipSRaGVylLwMBITbIwvEpZAgZGapKF4VXKEjAwUpMsjOEWBAyM1CwLw+uJJaBgpGZZGMMtCCgYqVkWxnALAgpGapaFMdyCgIKRmmVhDLcgoGBkYS4hRdegBBSM1CwLY7gFAQUjAxe2SEDBSM2y4C/AS8DASGbsh88MwMBIFrhOERAwUnMs+JudEvAvktFv2UpAv0hGv60pAf8iNcWCvwUqAf0iNcWCv10qAf0iubEcvkIA/SJ5wHKAfZGGfUGvMpKAfZGaYMGvaZKAfJGaX8GvU5KAe5GcvolMAupFcvouMgmYF6nJFfwKKgmIF2nulMUr1yUgXiSnL9uRgHeRgr5sRwLeRQrysh0JWBcp6Mt2JCBdpKAv25GAdJGaV2F4Ub4EpIvsrpnFHSYgXaTmVdB7cyWgXKShXHD+SQLKRXZVL2i0JwHlIjWrwvAbZyW8ctZQLugrIxJeOmsYF/yVEQnvnTWMC/6uhoRXz0pzfzO+d8DbZ6UxH7539C6gNebD9w54B62mVRheOS/hNbSaVmF4sbiEN9FKs/Rw3wYvo5Um5kTDdQk4F6lpFYbXD0vAuUhNqzC8ZFYCzkVqWoXhVaIScC5SBbIGCTgXqQJZgwSci9S8CsNLLiUgXaTmVRheZSgB6SIVfQWPBJyL1LQKsZkCykWqgOsEjIss6StBJCBcZBnY8wDfIkv6ShAJ6BZprnLBN2nAtkhNqBCBAiBbZGkshy9UwLbIwF0uEpAtUvMpxIYOuBap+RRiQwdcizTVLviGDqgWqdkUYkMHTIs0TAu+oQOmRWoyhdjQAdEiNZfC8PpGCYgWGbjZVgKiRc7pS68k4Fnk3Cw53GkCnkXOA0sO8CxSUylEVAFoFjknX/aTgGWRmkkhogrAskhNpBBRBSBZ5CJAUUtAssgFfcQgAccizXW32NGoBAyLXNDfLJCAYJGmwAWVCoymCRQ8qgHcijTcCl79KAG3Ig23ghf8ScCtKHPvLRouKUCtKM2e4JfJK8CsKE2e4NfJK0CsKM2d4BfKK8CrKMOr4DV5CvAqakZfnqQAraI6WgX/gA6gVZShVSRmOwVYFWVYFbyiSwFWRc3oPU4BUkUZUgUHATgVZTgVvDhKAU5FGU4FrwdSgFNRhlPBS2AU4FSUebcIPcNVgFJRBf0hCgUYFWUYFbyaRAFGRWnSBL+gH/ApKnCjiwJ0ijIVLXgyoQCdojRjgsc9CrApyrxWhOYSCrApyrAp6LasAJuiNGGCx0gKkCmKmWWH7kYKsCkqVM6iAJ2izHd48LITBfgUxcy6Q12bAoSKMp/jwUtJFGBUlPkiD17xoQClogylgld8KECpKE2bMLziQwFORWnehOEVHwqQKsp8ngf/2AMgVZT5QA9eHaIAq6LMN3rw6hAFaBXVfaYHnxqAV1HmSz14xYcCxIoyxApexaEAsaICxIoCxIoSAc8JiBUlzDdh8N0JUCvKFLQQPgBwK8p8u4eSDL8+IgKQgfkMt4LXqCjArShNoDC8RkUBdkUJ86ElfC4DdkVpAoXhZScKsCvKsCslPj8Bu6I0g8LwshMF6BUl6dv6FWBXlCZQGF52ogC7ogy7gpedKMCuKMOu4KUkCrAryrAreCmJAuyKMuwKXkqiALuiAtfjKkCuKEOu4GUnCpArypAreNmJgh/7UfSl/Qp+7kfTJ3jyqOAnf7o3itD7VBT87k93qwse+sKP/4SudVHwA0DdtS7oht37BpCxHr5I4GeANHvC8AocBb8EZD4FhFfgKPgxIGXMh098QK6o7l4XlJRSgF1RJUlMK0CuqDLwQpgC7IrSDArDS3sUoFeUplAYXtqjAL+izAtFmPEAuaI0gYJnDIBbUaaQBf/AFeBWVHehC4oA2M2UsaB1EApQK8pUseDpG6BW1NycouPPArNp+oSYDYBaUR21gj8LjDY3IQs6NsCsqLnxmLhcYLU5eZqgAK+iDK+CVlYowKsozZ0QnzADvIrS5AmeggBeRS1mdJAHeBWluRP8s1oK8CpKUyf4d6sUoFWUeXUItxqgVZTmTvBv7ijAqyhzfQuBF1hNsyf4h0gUYFaUpk/wr18oQK0ozZ7g50UKMCtKkyf4dxQUIFZKc0kuSoCUgFgpNXmCX7JfAmKl1OQJfhl+CYiVUpMn+KX1JSBWSs2d4Be7l4BXKc0luah3KAGvUppLcomxgU+pmUtyibGBj6mZ14XwOypLQKuU5s4W/INqgFYpzdtCeDlV2fEq+hvVX+rdoV69Nt+q/vXXJzc3h+/39ZNn/3py033Augm0tND2U9ZNjPeXf/372ZPGg+t/G49r/mXdv93fGxdk/u2eW3TPLbrn2q9RmR+KRfcDK+wP3P4g7Q+l/cE+zO2fpJUjrWQLsf1QgvlBKftDh6a9B7/7wbYqbavSPmyH2F5Qrn9ob1k2P/CuVXtlpfnBdtqWgHc/dHKkHVdbrmF+4PY3vBtOe6DU/WB/U9pnLB5pVdtS4eaHRddXywJ2P3TNlZWsjBL+ff7CePu/djJUy2W93x+2v9cb19jthZQna7c3jnYDXVBiViuveek0b+v9yVa7pnev5bldYZU6twPtdNCGLkGBN2sPjXQmbmcWERZQ3a+7j8U7YtpTqrOgIQy/VbfVZlnfrveeEGcRnUajwpJqT0FtKnwWIQZQ1O1QPF04ANrvmhkIixgx1bf1dn9f7aq75a6uDtudK7fZfE9yy5NYFiH2Y9V+4/67B9JR9MJO4cWAzYywe0+OcOQUVg6PkHO3Xf7uab0J5M+257OwCNPIM5pwjTawHuCcKdxFYYdRkivaCLnbrupbMHOYC2Jg1t1Xh8/3u/rjGgyEuzJIDLfNDFl9r781I9nXu50/Vwp3snBJArnbHv0VWDjtWOd8eefDhbJL27rDgpwwdnX7nmfu2Kh9X6RzOuQcbqQ0OvZEcEcEsy67vdbR/GC3v/bSvQ585825tWt7w5f5wW573G4z3HpzbsfK7TbT3l3S/WAl252svSih+8FKXlgvOGP2h05y+86s+YGRq+R+3TcoL9xxBzT2e/3dn9kzd5uxO+zJljyAohF1v1t/qQ41FDqXriEDIu5aV/8JmFC6QymtCe2eb91IexViZ0Jrp8LaycYy7TVineWsnYS1k7B2siFDe6NM94OVXFrJNqxqb2PoTGg1NLOBRmHXQVFaE5Lzf/fp2P6ib8eFszsIel9qnOTuoHcCs8JdGYuFu0ZJ5Tci/KXt+CY7CW0EKGzgp0rSc7bywLbvhjDnVdWJJD1XKwjIUQs3mCG12rb0PUo5dxpKco89bO/Wy5vjZn3Y39zXu5vjfrX0zcJcsxSknEO9P1SH9dYL5Zi7Nkn9HQ+fm/+vl81y2tX/71iDHUi5CDg5kkbKofrk9e7uwaogXUMbW3hx0szd82wIL2wwrux6tAkEK6jZ2gVi/nAclRR235jZSUYFuZ2ku+ret3LhTg8axr6+aTdVt6275bAZpZy2KQjjFm54Tmq1bbi9byeEPy8L18eJU5wdEgORy4VrH5ssiVOuZZM3G7613y3pFrX9jaSiqLa/psft7bryFV26y4lah07r+932y3pVez6uLTw5R3ILakH8tttWq2XlLwPuNrXh+4xajycRh1212X/0YbgLqv1GrNEWP/1w0qiNQ+z0lPNByLY/bCHPXct3I5iThjiub1c2nvRnfXtGc17XZAynJfzzK3AmbnLIqabLavm5RjLE9hDH6ZnSxrLRwfqT7wnnzgRSilrm/cyv8NRGDtY0/DNYqo4jo/TcNWxnrucd3EVOTrOucftr3/EvvGh5sPnm4/rTcdfbPtrPrDghGrWhw1DYzZc4qentegMH3ZJVziq33tnGrGVBKrET9meMVSjcqIQkQ84i7tc3SJTrBqvkNnwW0otxpOvAGDmNTgLOmzJA4npfQWajJ0HoFuiGeoMWsiJuepvfzN38qMDgJAa3uJt4kbuCI2PThDm97M2NtdSghbV1fQnunirIJOYk4WN1XDYxp3a21bIXdc1cxZA++yStDd32dureHIDbbt9xPUtbDM6cTpo7fxCZrtoXgxozMp15gEh0ly65tRIS+9LcGboYnKFGmv0vIs5ZfHI2OMuMuL6REcFuVEC7aV+w3aMRcS7TRMaEQNxxj4lys2s5o123L+qwBryRyz/JGRV3ATFfq9vbVnMQk0sVSDKZOgtDYqf2TStHxqDTaU8y/BEJZzm174cMCGi16yc1Lo1LZh7n9j2VSmfOqOGdwCjTk6DcvIoPTRN6K3ETLcHp2dsAMPP/43Z3V/nO1yVcWGCe3d03o/APldzJbrP8wKQnghRXnYXNNApxOvCxxzuWtGGFzR+FPcma0Q7G6dSQHk2O7G8d7pptvynXiaQ9oBFZf9xt7/65BwHX3PV7il4hzS64Oy6BPd0Qo5jZdNnmeIXlCQt7Atd+p7L74XTIYzM1aTM1yyUyyyUyyyUyG5fx2YmPtRyVzQq55XG4TW/aK9fND1b93AZ63J72cGUl28M5XlrJ9liR26MvYWkAYY80hLWwOCX49tRQnEgg24UoTz90vQs7UmGZP2HP24RlcVURsG/jt5aHGywU9dYKLaA9kG0MvN58Omw/g9MEN4FS9JptT2n8oNwN+hRJ45iGCHY3dbbGsCYoZnaO2QkgrZWl5S+VDGPtukTyVuaG3jbzng9II/gwl0ZQJOnRyWh5qf5hkHsUXpCOQ0voBvPxuOnFiIUbkrABO6Ikgstw2gORwp4rF/xEm9k1fjpXtg5BWkZZ0fmM1z1mG2c3tmtMzcN67W9obtpX2FOMws6ywi75ws43aaeBtHy5opeT0yc2AGcr5SdShNzG9l+8vc/lEmfUklpVB4/Lck9Lu4HZNdJZpqT6X9XL9V3lxxOFMwJyPq7qJpq9RZ2Se7JNTgTbHjs1WbiRv90uhD0+EbY+RNijMDGnYp5VfVt992OlhRsrUXnKqt6tv6B8Uem2J2lDrz0IF+czVwJpYy0BHEa1hd1OW2qGrpopud70fZWzwPmppMROFBrISdhh242o2ULMbuLvB+7AyMOB1Xp/3xjlRj/pzho3BCXtcry7+36jU7Lj7tbjp1xiiVH+ot4sd9/vD/XKnxPuDlhQM7b2OevCnQmCZIHqb/fbne8gXOekyCKY+pve9e/rO3gi6QbrglMdf6zWt/44hZvAWTdHBtgmWfVP1VzfbMNgVVLT0Ei4Xd+tGz/Z8q+rPgvmHugI0uEZSRQ54qwJy3SL0040p5box3V966nH9TqM9HttwtL6XxgqF94xkCXamSTV2wTr5qwOqUxwMxBBrqRWRMd3gJNC93yNPJxsmyO0pGvj0m711uUyG7eyhY21baTGbX7AbcrET1UVdiPn1j7cBhHc1tpxm7BxexrHbbkat3E0t1Vz3CYc3J4Itfermx+K0zkvOS93LbvdbA3+qnLp1FNEE9SeFlJtVugxr2tCQfmjT/Wm3rVxXSNle/e52nsuhrlEsyQP5qwQE5K0wPY18HDukYMkPdyn+oBt5w4Im8hY6xc2UStsxYC0O4u0VlOKMsS5P4RTlo63shu9zQ8LW6hQ2EoXacs9JHn+dO6tVdHnFdxb3VxKktl2K6W3YNsbXM5tySOdtm1/qjCvFpYMCJrGGPPO3KjfRrqKrFNppCyPTdy9OUAayuXeC5tAF/JUE3s6LD+VntrDxHkAchfmoSdvbiyjAvruZEDAhXsAJ1RA6U4IY2vqgAVc05NBXSOpix8aQXD2zN24sAyJaItcmtCpXaNAIS6NR0bsn8wSJwYi3IEERABv5YaGzB63S+ublWU9FMluNiI39eHrdvc7lOwWJVjXLuVJYEBTrYYav3hX7RsHCfXtltEoHpg97bltvbqvvt820auvLNe7kke/rYgm7z8CztcljRXtmcmgxQvGQh7SEdDbH2ZusYjdE6WkYhdf2u164xMRMzdsOGXGIVeC0ghu9mirAgp+4hNOLKKdC6eihMWQFj5CptQN/VjIAxw3gWng7o1kHN8IQWgGt/5ZndgFS4vaYKmw26W0ZZiyPC2tgHpNh4jXd0mnwoZJxfz0g9Wx3S+lDcBkyK2Y7uD6dfMqS45Ikuj69LVe+07anaL0zGya6Wq1JskCXn7hCiBzjWZp3Nxtd37FgxNA2NlntW7+Jf3058Phvl+P6zpJS/IyS0cym3IwW07JbZTCbXDEbe0ZtwuDW36N24XBbUrOpQ1yLXXO7Usn3Abm3M41bucat3NN2MBc2MBc2MBckPmxb3z3YMt2TRa6rO/aRBc5W3IPERRZRrrerMGRlNuMrOtZt4Wnm+oWqT51owOyCm+9+VLdrm1ZElJc7vhETpa9+FLWSJ7runs+o5yMlaMDTESIS+CQaaEVoouazfmarxg35Sb9gZVi4lUkcXcHRL4+0Emh64Fc2kaQNG8nxonjEECOn+Bk1t9J0qQEomCXSiCZmU7GKd5BsLizZjEwa+6rTzUCRbpQBhTjbW4IHJdPJdPITpbdadFZ7HLb5IkPEGSiJwSVezJJ8i2dsMAGXrhF4oJMRjpBxkEhQ3OnD/myhycE05AbU3KyLmS9b89p79Y+A1p4b6SQieD6i+9eXTaxoJYz5BC9Om5FzdD23SE/Q/fiL3fJWWrGbn6FfRmlsGcR0pI/kjxqc/oDPTkLyu509rWXwr4zUdjtXdpzF2lPfFRwiCiJxlw60J7tKjLUb+WgQapyj6LsMVNhWZLCFjAXdtuXlhqTpONo+/JiQ69D9z2BwgYKhQ1TChumFNZSktmojixTO3fo9+SWbduAqLBkTbE4lQfYo1v76oW0hzqKjETaVd6jsdzSEEUeEtxuPzWbXzOJ7rebPTiyduuMGeVz7qrbdt+sV93xHuItHB1zMkMymavP/btnJJZlVIKW8O0GP0Vyp5XilL9CTtfculNBOaj2kPojePHDzXhJpr5tuGvyrd1mV/+zXh7qVeMwj74R3PNFScZCZ0mIBLfiakbFhn2O1z/4t8eIixPZaxlL+86VIjdeLbs3L9xkycbzityRugACvGjkxnjd+rGh/an2xPxLJkOd4N6bn266KsgUblN/dd/69A/nXdaC3Gw29bfDzT2Yd46vOLm8TkPdOMmXoDfbXr2xG9GQ7M9me/jYRNLYNu1mteQ7vNv72oSsTfTypd6BamX39TZGHjYgb8y4L2Axkoy/b0Lvxop+qOMuQmYrMhj5CvB9vVmBU1qfqe4MQAYq92tQ7OjSnIwkyYlXKV3vK0ifdX/87Xa9vAGN3aSlGzblOXb1p3XreHW5jU4Ql/X9ARRoM/edGUVWve/qHl/k7q+K5Fi7raPaffJt73ogskrQlvnoY8+PzQz2gyHHRdjd3NYiFvYcrLCrS1rqTZJZWttds1/214mbKrKCbr7fHhsd198+V8dG8VgG4no1spZ7X32p+3u+WxdAcny9Zm5sqk5XE1giRp3ezyOLhluJsNCGuXGoIqd/4y7WTZrwX3Xbfv1x00jy0RVubTsj4xDjdkwbzwu4ZrEjYWQ5XJPBGzLgsN3+1m7KPhR3RpL0zL6NNffrpX4pExXjJhSM8uStmLraNWuTlON6OLKWuZGzpUW4PB3pJdr3axsoy8+6ChdU4LoKJomWvTmi8GerS5mRdOfeHkuQpwNuXTuZuxgZN2hO7GaS3fqnfNwe1KC5WSgZXPXPRLyzJyq4OGzbdz/7xUOF+34GI93xYYs0dd8OY5ZYZ/b4mZ2u2jlVKduiAW6dJbeZI7cvT3KbqnCbS3IbrXMbJnK7f3LLJ3N7BsDtdQ3cZkPcZkPcZkPCZsjCHmILWzUtrM2EsPUNpyMEdUqd7O5Npm2H7aG6vVn2ykvck97TVUfWH5p/ydf1qRnrkuOSpM7cV196p1nuPR42UaSmPnby5L4Mci7gsFmuVbsiiwVPb9GAgNw9FqN8gW1L3PXjBl2D/YMzXZcVkuQLi7YxDPqFtw9aFQwNA17041azFKe9k3yNyhUTvOhHeZfR2IyJfCXNlYvc9OMeGRSn2lsy3PCkeaG9W9lesBMsaitxBfXKu918W5Kpik+W+pPHPaYeVrlhWzfHO28OuwUOJ37JzgZyXGBjcJMmMm8/btqNebtrwx8k8XI3F3IlHDfr9u2e9neoEHevII92LGWM7Y/cewOSFnC8bw+1anMMgtBALttLpuOwUtWNlMj13Lu2w31RXZAFA7BIRnivt1vD26VRnHwiqYM96dPcqiWyvr1tr5/y4ldXA5YVZmSpXSsDOiT35qjCzuSSLGa1IsLOyKUzxUlmSNWEI3ILMAt7t0NJvol2kuQ5IfcmkMIu2pJ8JdQK6b9f4u4fJE+hzzUs13hjX6OFuwlzy3kkmRH6whAayQ1vycMWI+X0jnBfiuvUyNenjJTT3o6IcSMX8vVLI6Z7DxUR4rKjZC29OVI91F1lE325mrvfKrLEGztsdxySDelONx7aX9jDB0VW3HTjBJGIs2qNAJK3Nu0Jx+FOITKhNxL6CbjLn5NvD2OVLMwt0JanSy3JBMfI6IVTjhD7KqEiD2q6MxPgu1xPXljyuSQ31LOQoPdy7z0orKsvB1RE+C+3aKew7yyWA6rqezD3TZfCvr5TkmcHZzF9H+bWaJElU73aI/eogyzwo0uPXLJTkBWqtn2v9Mnl+gRZN/MVvlfiUggCz/3/8Uwzs7frTfPUr//497//P/Tx4DYyigIA"; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE+29a3PcOJI2+ldOWF89GpEgLpxvHrd7xvv2LdrunXNiYkJRlii7tqUqbV3c9k7Mfz8kQLCAZCYIkChpY/r91NUWkHiQCSQSDxLgP1/str/tX/zp7/988et6c/viT+XLF5vVQ/PiTy9u7tfN5vDH1eP6xcsXx919+08P29vjfbP/o/nTdfuny0+Hh/v27zf3q/2+aQW9ePGvl4MsLgZpr25vd81+P4habw7N7m5140vrSyFSX754XO3aYj6wU1vFVVkNjf22ur9vDtfr24TmLtxKUw3bmhSATXP4bbv7NRGBV2sphMfjh/v1zfWvzdcUCF6tpRBW5s+JWvBqzYCAjLo/r+5Xm5vmu/X+EIfEqbB0LN6uDqt5jV70VWN14PaSAPNptb9+2O6amYCc6hlBbZovh+vH1ce5qNz6GWEdtofV/fXN9riZOWgufAnLoCGjOn44P+04nj2A843cRUM241hdNkizjs6lwzI0HlsBkyi6MkvHYPyyOrSWuqjqrlDrWffHpMadGsuavm1u1g+r+8n46dS0U2NZ0zfbzWG3umkbiAvhThCQmslQ3HHWe8YJAH2ppWNt9RAxt9y2LoYak520HQmNs6SW+wozGvb0u9uubm9W+8P73eq2+bn572MzucKgdZbqfr/+uGluW3f59b6VPhvBxUjOtIJQFUyra7O/a3bpGnOrPZvSRiAW6s3TBa6617tmdWj6lSVObViVpSqL3iORjSdumNB+U17gcGj/ujqst5vZ6HwZS+GNLfiu2X1udu+64RI5+sl6i4e/Fnmth+5uepEO47hApEVqD1MJAbnZ7Lb39w8dpIjoegLxWFgWwGObJywO4wpPsioTzSYs0EhPCUB3u+3DdWRgSOGCMjLCO2yXgvMlLIOGDqaEpROt87RDarxYzhhVxAo5b68TgJa290mClzqqEL3NGVUx0G7bv6038Qsnis4XshjgeOT/TdPNKePeq5GHIp/Z7sVQO1Ixfmej1fK3mSDN/zwZ2xBGMGsWYmogYB73zbUXrixDi4nLAtq19ber401j9gqrm4iJOiq/1LaHk6jrT6v9p1ntXyBSJlU17jquou+3t839m91uO2XPU8GlSrlpJaU1dtFXmey10xui8Yd2yzHNq8L2T7XmQXA1/q5pbvVAbo3y5nMzGROMyj/VsSXecNoB5rizYVCtW4jYVYWRnWQsghe02c/N/nifbDlT69ns5zS/0Ip9989iSwTlEouGoTZfDs3mtiOhYjmaIF5cXG7Q+7b4QsWeRGQA58+U0zZ/EuCp6BPTMqOmZzExXl+Dc2HqNGOM51RvLgzKKnFrDij/jPZxHPxSIwVXoGa2Xi5s1UVgyqtaFrykbeYb7vD1cQLbXMMFB05ENgBa5wnyAuh2ozME8O4uyxUIwErJGkiCFps/EMCWlEmQBC4+pyAALzG7YAqgN+bbUqvDcdckRelopeVuM2qlp9tOWujxfi+NQgPg0oLQOfAiY9BpjCkhaBLQ6OzFEMi0ZMaZANvA9ksOjL2czDC7oGC9+Rh5MB2cMiNJmaG6fE63jC/Aiog6I9hFY3QkaDnQaa8dt08PVH2yzfoUhhzOMue2PRbvYscZBr3QfbqAczjRMNgsE9+FnG/6xwPPoOlcrmCCJrF1FuN1JeWC6voufY49gVKXebKzplNriedKpisLnaHTepLXCzYe7Smc1tNcQrD5Q/fHpMadGsuaNokfMfkHTut+pRwAItJNR+3HZpyGVb9N7r1bZXnjaT13aiwecpEHn/6ocyolAxi5tQjCaCj3BCSR31Y0MXTqyjIyCDSfQgBNQoglfQCGJKJnEkQ8uQNgJBI6GBAw9uLHfq7j/pTl1T/iT15kkWN9xOUmLHk+nnH1HKCOm6Ts8REqpH4OWMtAnQVSYuJIlpSRGE0d2sh26jBrrCFbayYEVmLT+p2W+mZzfBjwfF7t1qsP9yScU5U/FDPmuuCcnTzMtb+FS2774jp6y4b3mrDRT83mdr35uBjY5UnQPICXfQcJnMNdjuVIXVFnwfp6+/DYbkOWW/vSkXQWpN+u1vfN7XKcg5xcKOHxZngmj0438VbS57DCALx3J3LTCqaa7grOCRJAXHLn5EZENXfhVEsxyHtgAxgg3U0madhiTxsa2QbnxEV3U8kYqRhSKYgghLSQbMAwIxQLgIhPXfdRJGarT+oiclPu6iFlUx5uPO5mAWg+4TLBFIBD//dUDH69xTDmxOQDltkBeQDQAjj5wcyJw31LzQnCQ9qJjsBPWkkLv/3GYezd/jUp8PbKP2XUjTWcGnL7nV0cbwcgJQfbnqyMkXYIY3qYnYIyIcYOgUwOsFMwRkfXIYSJofUEPjSuxmcpHlT78pelC1qBcaTvUPRpeF+/uRTq99SnxewvAJFIAE8CSeCAAZJUGngSShITDMCkk8EYHHdk/rKf3Op0RZaOxMlYbmjkIi5807ipYb/eP96vvl7r/41tFlRKBeDqNOreZJ5LkpN6de8Wxmk2fN0xer86/wpmGMBtc7c63h8in0NyUYxrLoTip91HRaAuHqJ6OignFjV/c7N6Y6PSUM0nik8jICREqkFVhGNW92pPLsiXuOxF3ZiIyl61W6zPTddgtk54IjNjhxFb1FgexW7BNpdFcUZ0RAx3KvgEERxoLDp+c3qzLHqDAFJit2kQsZEbRJEUt03DiI/aIJDEmA2FIpxJbVavZv/qcf3qy3q7/2m1Wz1oj+LcVb87bjS/4iELVs3t4WciuAgXiXf/YTlhLVIX9N33uZ6ko5ewyXN2e+yRn83Afr/7f/xD8TQKAEonBsPH5vCkI8Fr7/cyDE6dtmOAPdEYcNQ9OQDgw6hPpJJTs7+/4WDfX+1HBX/yUTHxhux9u377JZ/ITeAN/14GCNJ7O0TkEw0RzADTg+QZhsfvdWCchkT99EOCHgw7826XeZ/q2+Pm9olGBNru72VYjDs/xJpPFWwi+p/c9337GK+ebx+ffGfXN3kB/m3e3q2tCLruMkaVWro7C4Jdtv8aQcc4L6cHc7YUYfjzNw3zsSdHw7FdmBnvpvZkUegW7kuG4GxBb87Sj/P3YMnCGO7G8qUvoi+UC1/dtIvA14SumApP78yddi+wP8x0631tTCeZHXxcBxa6ero753D6kV1a4P4z9Cd9IUju1twlYXbvli0Okf3LsUzk6OGZ+/aUvVq0iER2LcNyktS/8SfpdIW39lRq4pwKrTPnhHTaR6cCuFjki08KiHe5yQjnu9YEeHFf3IpCOdNTToINOcRkuBkcXwrgTFDPADLgrpKRLndLGNyiVKj3GXD2LVAgZzgaXjhfR2799WF3vHHPvGNavPArnlo/7G//sN7/Yb351OzWB53eMqWWNB8Yh26J30twd1Fg5ru4dM+WCGimN5vjxKKQZXBcaf4qFVU+PAHXFAVquTsi0zO2m7v1x+POT9uL9Qpe1ZFfeNxtD81N6xf+n2WOwgP8YbVvflodPqVhdWo9DcxVR12nYbRVzgbQYVXcVD+UaQ9H+pPVn4RxiUNxMV0sno2ZljWt2WCiFPrk/VP0/hJt/ykUkuNs6/zKSMqnyqcVzCx0bs3zjZ5x47/XoQM0kZSDlXHcQIME0ilG75lP8Dy5NUZi+L0OIVwhSXlbGUcSYZ7IAfXMY+n/DiOncFJa1xlHEDl49scPD2v/HkrT3GKPbz+JAmPg/F4H16RukhLGMg62aaPFDz77+vL/phGIY/q/wzCkoLQEtfMORsx+UXv0qQS2cfln2YXb9BHk3+fvs9vKiDqCXPL8vdBkDzLtldFOTWcKnLNjGbZxc3qVYxcy3bl8+4wcfTx7956sZ5mjtumeniUuy9TzxSHDrO5nCgoidRBapGJS9IhKz7NcuYkq1B8XLFy9BEpP51rC4nuVazELd/Ssy1pCZ3MscIt6mmWpS+hwxkUva7+fsMvP0NvcS2JC78+zOObWxvJlcplKci2YyXohvofbVYpNQiTr5UlERB3xHCQXeVaWmNy/fJgzLBBR6XSBNWAW7nx+Phl+ZuTnAR3vkWd14ixed06nQo41V88yOc+pFElYPpROA8s+Taok2urSdMlRt9O9dTzULB461TFHw8vgjGf64GiI+fxuurudDTIrvnjPGo33LN40kxNd0olMjnNxMifptzIndMYCj0nqxDFnTeyMhTuZ3IljzZfgGQDqcHP6s3bo8VR4q0XXexKGbqL5i8Df43m6gJCA2qjha9+y97+9e57eXY5aO09nc5z25u5sUhLmkl5DJQdzdp/E6n5T/84md3qalDy5yN6ueun82iextNPOv7OZbTeT0hoX2XhQbCB10Ug5d9+9lv6djXzqaFLu4SIzO8oNh0VTCTVOwacNfOwRsPsPM0KbtpbbV2L7Myt4oREuCU98wBOHCulrbwD03NU1CXHiAhKAO2uJSMKa7AsDaGd6uym86JSOST+ApZ94crsHV6N/nTPN+6ojJWSd8BGoF019ohP5nUBMR2a7g3m9SHUMMV2Y5yLm4U93FjE9mOs24vvgf2zsNuklmHGFpaevxLxMav5iwRScPG3CJlsaurnzKuYIeAmuWZMl6pwUTIs0WDNnwNS52lAwRGEOhZ7mJM1vbukR2qmHaXNtGtiC+ZUyrSI0NHMqRc+gaQizZk3CZJlGMHOCLD4/GY/WzAcnk1BjTkzg0M15VDIJcPKMBKDLdziCQfP3Cvr7jvMORuiqT7WLmEBwES6StL8IyAlrMeKcxHwb+ik6e4k1e87uZ6LeztP31COUhUpAlD91lvKEI2PU5u9lWPgdTz1mWTomgNqD5y1POBr8Bn8vQ8HpdepRzNJx4Co8fCZjZD2NQmCTv5eB4PU79bhm6VDwlT4ZuEUc3Thlnzw0c8hw99/mBV+GB3e7HrGpTXSbQcDLA6hRF2Jp3azdWLbap/Zh1vIV7sCCBSoV/Uy/G8a/yLNG9IByFpGHQrDC07sNQIuP/jDTgZwY8ZFOzuBK4jqRwanQ3TqXe4ns2kJHM7tf81xOZKeWOJ/ZPZrrhiL7tMwhJfXKP2saKiQcN43r5Dxx8kdNKoiLxbM5/vRpIdJlkzPyJGohxgVzLfZUCkypZIiLpk7ECdVQdoJDHso92TmV32KGo6pTV5PnaRTCxXMzcUrGqW3RNEyZfVFwFsy4tIkWhWbR5MpxujUe4/kPuCYBR55xwdGe+ZhrEmbMSRfAmPWwCwPo7IR+2c866yKrPcmuKNz6Bf3n+B0SLYPWGM1Uvz7uuia6qmft2eWorXN0NActmbejScdW83sM1RucUVMk5Knck84Zy8E4/58+K9pKTjfp1TZ53JPoFoxsD2yQFhqKxVBCoPDTGtHdwcJ/nGHOvibsf07DTiNeYmK8A+GNti0cu8kelV+6wSb0mNL6xXydTe2ybLlQ7GLLPM3uymtt6c5q6F6acSZhzTfI4sh8pJ/MUfkU0JiI3MeYNRqfgjcZifvY8kXhCDBn0fnb6v6+OcyIwQMVn2Qxmmr/IlQgfpEKSQnpLphIZCqevX+XoLVzdTZHRJ67u0kx+bJ++2qmt2FPZXW3qX93kw99TUoTW2jvk4KnjB31xfSsekj4kOa/i+n7LicliOUaAVbdgQwxr+DEOWEOvaBt/rsPhnGnk5LEFg4HROWTA+JJR8LvawgMto/6vE822xOpgScZU5ycW/KJY2jLfHn/MidKbqt5HQ6ezqVFRAGMCyJdAHg6iyUf6JmB2kzEibFIFPBZ0UYa/vlLaKgHSxfJuX3IDD43atxtxfDRo+JP7cBchnf8z7NcWV93rImcTi0G9xL3RnUiu6OL6shcl7e0F6nOL60z89zgzD4tcIhRvVrsGhf362wdOmNPnJOdU/HYsx2kxtLTHdQXpbV+Md/rxGQiLsM205HEA4MeYy6+Wb4hKlGScAKJQJdO9wSoGTBmAOeeMp5Khk5mTqWe5qQRtLf0rNHpZIqziAE220HE+4UIGDN9QbILSIEya9rPmO0RmJbO8JSJnQRnPo55J9TIvMp8Rj0NNuaUGuLMek49DXHypBriy3dWjQ+6k6VNyU4fA76H7e3x/oSv+xvipU/S2Encn1+9e3P906v3fx2EfV7t1qsPUNxQLsr9a3Roe69//O67N6/fv/3xh+tvf/z5+1fv3000PK4wB0FwW53U8EXcNpoQQc7f/edFcC6NgDmQxoG8/9X1pcj250J2WIrscC5kj+tHZ3mahc2KyIPO3Zr93Pz3sdkfXu0+hmJRLdopOmfSeTrpGkps7sLUmVaB2yWi+e2j3kMnQzjVmw3DibX/3BZ79dNbamExntaUmaPwxDh71BwZZVM9tv1ZEpWgKCJjkpm4pgKQMaSo8GMmmmCsMYYyHWkk4HDGZjd617vm9s1uNzFkvJJPNU7HjSaPVr+HhDXu1s39bSoSW2k+BidE2j42Zuibrwh9vzodmeJLybjCHKOMQsyb7cODM21BkGn+GhtmfvPL99//f9c6iPzl5+/o/vRS/eJRvenRouc4XbXdQZ9cv/nSbr0C5GoPYFRjMYZ9c2hD+v/TfH2//fHDf7XzdBLDqEYODK0PWN+8Oh4+pcAYVcqCpGnL75KhjGrlwPJjKowfcyN41/br5pMecNOjE5TP0H47De/X/9N8szqs3t790DS3zW0ECqTWYiyHbbfOvjvs1puPkxDcwotbNkxeH8R927c4CQGtNRNL0tnvZPsX+J/i9q9B6bimgksJFgiOVhSnUHBhcbczr91aej40h/DDCX47RP1IC7rdosI77cOz4LkYZMXDogSS+7R2WuufWQA70s4H+bEV/Nt2d5sHsiPtfJBXNy24/fvtr80m08jwBJ4P+GjrtAg1uq3KDXmvo+K3m9vmSx7UvsDz6vrHSd4iUd0/xhEai4DfbXcPXVDw2t3ULUIOJGaF7u5GwaKbDXP0qhsj3VMGvpn3qlK72UBri5a/xO39FIyUfX5AVuT6nApu8ZIcvRCnIsuw9kavuKnYMiyyKUtrslGzrKZz6cdJeBmWzZTFMhVenvUxZVWco8DlC2HS8pcKMdOKF7fOLQG3fGmjFjQv02K9/4/9dvP9eoFD9ERkUCjc5hIb2/BW1lkp15tuXP5xdXu7a73PWFpf4LovEJTrBgOvgMBBb1DgK1KwqyKIc8bCH2o4brkHIKwEakq2OmzuE3HYOshBy/rz6tAswfMrFnEE0fwKgoxFWLyZdbc63mDJZkE4Q6XZ9oH5Zm+RaCIIwdbJhuCH5tDGJL/OAeJWzYOnSxGjM92CeEDVbPoJPJY4pZ+IxxLT8ZC5iVNoJhMT07GYrK05Q8epmQfN1KufYecb+exnIqbDFjD6cWicavNxICvs4/q68Y65x2usLRK/yv70ljg6H8u0ZWNX2gEv5cJ324d5jV+4VWNhDCIWrf0EoLTlPwTJW3E/HQ6Pr7fY9xOnADk1s6FpS84Dc6qYE8v37ZRZfZwH51R3CaJUb0HgSXAYQf24r7Bt1g+P981DW59MjhnDGtd6lrlOwCBmfTBDeaw4RDNZ/AEFetYdkETYs30GBRr1HmdDnOBXKMCYhzkn3gTfE4CMeaGcqGf7Jwoz6qmy6tnzYavj4dN2t/6fJBcGKj2TB8NQ5HJgUC2Z/BcKOZv7okEv8F4o5DzOKxJvku9C4WZxXfFokzwXBTiL46IxL/BbKOI8biugY8dr/bA9fLs9buI9llfhWbzVGEEeT+WrIouXQqBm8lAU2NneCYGawzNF4UzwSgjMDB4pFmWCN8KBZvBEFNbZXghBmsMDkTp1vM/bzefV/fq2p+e+iXYBWL1n8UUkkDwuCdVPFs9EA8/koCagz/ZTNPAc7ioFdYLXokFncF6JmBN8WBB2Blc2gXy2R6Nx53BsU/oe+7eeME93cH7F5/RwCJKsLg6oKKePw6DndXIk+KVeDoOe0c3F4U73cxjsfI4uGnW6pyOA53N1JPalvg5DntHZ0Tqnorl5IdSz+zkI4wxx3LmiuDPHcOeJ4M4Zv50lejtj7HauyO28cdt5orZzxmzxEdvMKOnZvdgIxzlitbNFaueO084UpZ01RjtPhHbO+Oxs0dmZY7MzRWZnjctiPNrD9rhJjsqcWs/qzwCMvO7M0UxWbwZBZ3ZmKOzFvgyCzunKphHP8GQQcEZHFoV3hh9DIGd0YyjqxV4MYs7pxHA9j32YTZlNJ9JAzef0ZRiUrP4MaimnT0PB5/VrNPylvg0Fn9G/RSJP93Eo8Hx+Lh53uq+joOfzdzT6pT4PxZ7R7wX0PvZ9P7XaSnU1Q53n9Hc+iKye7qSTnD4OAM7r3TDIS/0aAJzRo02iTfdlAGw+LxaDNd1/jeHm81wY4qU+C+DN6K1Q/Y791Hfrh3XyNvNU6Tk9FUCR1VU5asnpqyDkvM4KBb3UW0HIGd3VNN50fwXh5nNYUWjTPRYCOJ/LQjEv9VkQcUanhevYvVF4v2tWt1/NA6TRDmNc63luGeIw8jguRDN5biISoDO5riDs+bcVCdA5nFc84gTvRQHO4L6S8KbceqQhZ3BgQdTzb0YSmHO4sLCeHR/2/eq+e92lue1fC432H2jFZ/FkNJI8zgxXURZ/FoCeyaVNgZ/t1QLQczi2JNwJvi0AO4N7S0Wd4OHCwDM4uSnss/1cAHkOVzepc++e5f74+LjdtVJfta3Fezu04jPdt6SQ5Lpziako071LEnq2u5dh8AvuX5LQ89zBTMCd4O0CsDN4u1TUSfcxQ8Cz3MkMY19wL5NEnudu5oTOkeyNrtyM+wNOtWfN34A48iZwuMrJmsExgp05hQMHvjiHYwQ7ZxJHBOYZWRwjyBnTOOIQz8jjwEBnTOTAcS/O5BihzpnKQeh67NG+acO89UY/95nqTWDV5/RsKJas3m2kqJweDoef18sFOrDU0+HwM3q7WOzpHg+Hns/rJSBP93wk+HzeL4B/qQfE0Wf0giHdjz2hfdc0ObrzKz6nF0SQZPWBQEU5PSAGPa//I8Ev9X4Y9Iy+Lw53uufDYOfze9Go070eATyfzyOxL/V4GPKM/o7Wufft0/32uLtp3nz5tDruDwmPpOE1n8XfBaDkcXiElrJ4vBD4TC5vEv5snxcCn8PppSFP8Hoh4BncXjLuBL83AT2D45tEP9vzhbDncH3Tend837f6JX+djPJzs7r5lOD8iKrP4v1CWPK4P0pRWfxfEH4mBzjdgdkeMAg/hwtMxJ7gA4PQMzjBdOQJXnAKfAY3OI1/th8Mos/hCCN0P97zvlt/3DS3P62+3m9X8b6QrPyce18CTdb9L6KunHtgqgt598HBTizdC1NdyLgfjsefviem4OfbFyehT98bBzqQb38c7MPSPTLVg4z75LAN6Puu7w6rwzH5MRKk9v+Ge68QzlnuvroaO8f911EnznMHFu9Grnuwo06c4S5sRA/SvSXZgXzuMg3//HuxWBfy343Fe5HrfuyoD2e4I0v0wJnOVkJ3Aj10YvzNqe7PiBskbod4wsYa0cJeESLR/mmBAa/66rB9WN+YFxHiG75AqsYgMSIWeUiIJO3TUigIzKrHw6e27vpm5aIZW9ctFm3l1331V2gj4y57jaCVY0eD1+ASK0RCSrTOtNSAT/w/wc9vxgJejT/9HfNVzvnIe7F50HvCztgDz404VZs+nzqHIVCpWUeQ14sPx/X97X/87X0G6I6o8+Ftvhx2q5vDT81DnqED5T3V6Nlsw5/7jMVv5ZwT93id+AA+VzpaIfoC0WvD5PdPrcA/k4KxjlqcgUjg+/DnlLF2L9x6cQhs/UkkrzZ9cl/g86thTJ6E2ej8ZWYiTkIBrSIjpFgMs7SyWq4JevhfP6weJ6dAVyh1GnzvyKX6qeWeyqdNCI08MBSnv9YcQHEBJMRDciSRq+7t9BBAQZmKWbFM7+VCgOK/7zmNajxE7Q96fNofyfE73d1B5GtaNtbBASwx9zcm8eW7dSjEwhu/8OtGAhlkOIgE50wMkK6vD18fk1Xhork0Iv5QzIB16faKUNqf23Lvmsft/XqVBealL3AJ5F5m0NUHfA8Beqj23EY2QC6H2smq6ntCqOfN4dMySJdGwkxYE8b7W7NeiM5IOA+6v/y2GF4v4jz4ftnf3izE14s4l3UXD75exHnwdcz0/bqVNcN9uFUXuBCEoPkpguygUUEBubAdO3e++9zs9HlZgPYioI3rL0DmBVY3283d+uNx13zbRpL/sd9ukrFhEhagS2YKaVjxvGC0uj42h2+au9Xx/vDLfoYdR9WX4MIi0bbPK3dGIqFoXyQYi7KT8L+9eXv905ufr9+8/+ubnwe5n1e79eoDIdmrEh2XWuhBFH9pf6SB6GrkwfCXGar4yxl08er9j9+/fX39yw9v37/Tsn95983rODho1QWokDGoz7oCA9D8PXonZG9h/vS29cjfbncPq8C+pJeN1InsYw+e8OLfvPn21S/fvb/+/s27d6/+8mY2jouxoChcmMAlnnMKZpILjYLonUTuPh67b9BPZF30cr3Sz2LNMYLZdvS7vtyCCLQ5tqNg+fPx0Ow2q/s4q3mln2kOQgQLZp/b9RzzbgRt3ozDYSFe9HUfqul7nLF+wav0nH50DGSpI/X1kc2TIkAXuFIKJGLfXzZ7Nx8vFi+o9pw2xqAstTLUSjY7o2AXWJoGisRZdzpJ/frQZROtbrwJPYq5xmWj4y+TC/8eaWWkHKSVUe3IsYV0boHVooGlGS9GLDU9HsJHofGIH0ZnoxGH0onI4Q7YKfXX1T5AUsV3A5WaV/+BXny33vyavxe91DP2YvpULB57/BlZKuKR7yIdVdArIT7w0OwP+z+uzBfjrg9uWtDIB+qy127Zma25qRtxbY5qzGvZOZuMaheWX9ZqSovzW/METjXn/e+89sZjOaploto8DIc+ITiqZa/wvPaO+8i2hoIz2zms7wNEUN9GVygoX7ir5s2v354ikLvjRuueEGpKR0YcLmSy7Z+bw3G3+c/V/bFJAeFUy4/m5+a/mptDczsTlVc9F7p2Hew/49mdCfz1G/c0ZgIZUnURKoc3/U1/KtnJa0KoUheKLZ+rfTt14xGcauSzzKZpd5KN+Wx0p+J3TXMbbxysdm5sP682t63p3cgyEtepZi5Mm+a3fjj6yYsTgEC1XCPoP1999/ab61fffPNzuxO+/v7Hb958FzuUkKp5Uf3t1XffvXk/B5RbMy+m9z+/+uHdt29+noPKr3seC/751Xevfnj95vq7t+/ezzOkKyEvRit5huq8qrlm4s2uaWf4qy/rbTunbn6NnYmgWi4ddaHR/tXj2oMyoRy3zjKthDKnUkFcxOZOOVg8KRTF0a7kr4+7Top3VD4T3+VI3Ey446yWUYiQali/1rOZFoExy7hACbR5TRiwHN6lK2s20Il0JeMIskEG4s6F+n6971WzzwDal3Z+zKPc9hzQ49PdZ/dgGI/wrkyGIX4SmRG948J6hqtJdWKw3rO5MRTILEc2UgVh7p25/GdIzG+Pm9voARvCeomKXQB/etD2e44s6D1x50PdzetXtkoW4FDiU2g80U9EKn6Wq5iv/1RvHWuFeQ47sR99nJ9xAkCJWbEjtFCqw4b1ns1ho0BmOeyRKghjf9htV7c3q/3BvqWRA+olJnUB+KgBm7UDI5HnQ29POnNB9+WdD3fnlmxD0W4iiBxKzIqdPFsxAWHUKY5TNPkcB5p43ERfIjqfZDRqRkfWg8j3tGxUs1by/BvoeNMpd9BHEmYmgBBIZmV7RGPCcolikfl1s+GDSRuhW+kEso9xt9JTUNjX4WeBcStnxPQ3eLqVAMmpmxFRdz7Uh0/zYEEBGbE53zNZBJGQkxHp5BMVNLjotymS8Ew8UBGAE/lKRQqa6IxXGtZYREZ875aigwIyYotO46PRJefszcS3EFtGXHtrkiXoCCE5x51+XHDWgLM1z2PJcKpllDXj8iqj8e2aWXNzqJYLx3QyJxV6RWduBrEg4X+7GQklcHV/Dm8prmpZcOcWp44zXv301tz+HkRrSVAwKBy7C9CYI4mN6Hbj2QxMRNKRVCqm1JMoVN5o45lVbR7EhLdYQlj9bkefUSZDTzmafA7VDvisXtlCvZ46TPipwPFeMvpZp3pxasb3R5Con6/veHJ+Bl7s2HeBcnNq1ffo/aYn0qXD0k/m09GGE536qKtkPEGeJiZjm3eGiIudnCHw8CQdbdKZ4RyU+GlhOtDUM8JlGo1yOpGKTXQ78/Ub59xjtZzq3hNx46d/6YhTz/yisfpes8tgi3SZXtEn85fjVhOdpd9DeoZgGYJpiNITAxF5kxazG6ZIq42KP5nl8JYTrTfuLWFB+iA2Hdys81dCbIy3yAE5+cR1Fl7ssHUG2LQz1llI8ePVGVhTT1Xj0YL4dfyIHb5qDOWeLmb1m0yNVk8dIzbHx0mfiyO4PCa4WUdE+GD+t4h9OoHnt6T9eTSiVVQ0gUNaJUYQsZhGB/IpoA6Jkz+EanygDxjnZnN8IOe8KTtzJhWnafTTmx++efvDX5IbvThVTHIsfR9RLH/++cdX37x+5VzkiUbjVs2G5/WP3//03Zv3b9LhODWzofn21dvv3nyTjmWotwwJTkR/szqswjPpVO6J6eehyVnMs+5Y0NE6B8oJKC6dyolwJhzb3r2FmoKor7gYDRwh3cXW6fFhSz3Z6PAaTBwbQ5dm2wBrPckCg4DwaGg2N7uvj4dZcNy6OTF1r3i8X32cgehUMyee9ecZUHSlhShGIbSfEIJHJLrMzFkCG3RybsKtOgVnNq0cf3B6fjkm1BmXf6Jwh2g4NeRB+otievX6/dv/nAgyKEhD3eWI4Bix7yX/+KjvBofHCSj8ZM4cazfRp8N+Us5LP23+Q/c/cxFdejLmgJtwaMhn6pIxEl+ny4aResc9GWjyg+5z0N42H44fP7opJck4XRFnQNiV/GnlfOcgGaAjIQ8+ypO8hs/cJ7kWqvaT+5ogkJnOh1QNYfW79X2C1WMQXzois0A/hx+I6shCxzCzP4meIqons13HzD6k+ZKoLsx1LvE9QLLuPF52lHTX/TX6sk34GxVa1C+4PKyPGtipoeRnWP320t5aHerOvE8D2p51jwbDgJwrgYyzSTUkpe9NYpi4IwMaj7wbM9kqlq801XZSelJMvxMVn5DZN9n6+uFxu0sFACotxTCdPwzaj88bRttGPFf4wcekpx7b+bkKPhpopOlisf6Lflzq9sQUvN/2+Rx/bb4AhQZQBKovR3e//fjqcf1zs39s2w6+8Wjg+OWXt79rPrZztdnpV7T05wZumseD+5UXEgpZdTmqdv1ow6SDUfL7bavvaTjjOjNxIKMfnGCOhr/5e/TaPeVMenF/o6RivfgtmC39/av/174r9+ZdSsMXsGYUjMtwmrFZF5NgDFVytL/erJO0f9FXyNG2/hpA25WOhO2+Me08JRlYXxFME4KSwp8o5N0FItPW96tu3ge/w4cAxutnwZn2vdE4bJfIv/2hSLji4DcT2ULUAc55eqRPe87WsYkd3oMud+4emlaerY/hfQzSxVl7GWqSLNX3UCU/muTRPTqYzIVkNcpAj4GzQvPNM2OasUbAmmfD1jEpP+2au/WXOfi82mfD+HZz28yCZyvmX1J/W60P324nvxyLQIM182NrvnRb2CRQQ5UcgdJt0/Yg/LFfBIJbK79O8LsI8fFr9O2DFDSH7vmfic++0Yi82vk1NnUDGwGG3L7OhcaMjjn2gzXPjC1x/RnXzY/vw3F9P+wyVo9J+MZ1/3eE/QDXJfj/IXRMjRcn5JITenXzaZ538SvmN/7eBLuJMZqtk8PZIZcYIzcJeZ0ufk0xBkrixcRoNKPbfLFg4i/uxVoI3oaMtFD0xcdYHBGPeOFIEh7wiudMyOyy6F0uIiETunQVZdPNfvW5SXcqp0pZ5k8baSRjcCplssI3zd3qeD/XwY1qZwkuV5tuxCUuQ7ZODgTmQ2xJAIYq+cLr6Uctydg6/kZeFJ7pQ0AESfxBYOxYffNl3Z2IfexmQPJQhZXPwlK/MWni7ZZmBkUNK2dBWBV1xa5OjASc6MOBknNbcnI6w9u7RCP94vrdGntOdtyeX3xZ07FtLmysrTTRTF9iZgMwqsGamAxhJhtxbkjfNj+bt0HCTRI1MgDQbisVA6g0E8ZrlyiJgUBUWNS8G3HFY8BrLQISPRjQ4kubjh4GVI1FAIwXjW8els/XODivj4Qwlf0zBYT+PDsGACs9s2F9XPCm+3x9sEWv2MymujhAq64F/OZzswkrGSudq+Gfm30bQ6c1P9SZDQLJM8ZbjkkbTmkuRtnj0rkantF6bgiTsQlVYy6AVlC7dd81CcOdqpIVQszAD1ecCUcvVsF2bYklDUza2S01v6EoH53FOztCDBn0ZnN8iG3Wq7EcwHuXcJ9o+n2QR49qFP1cBWwtuOGObSZFs7D4wqZjBqxbcGZz3v0BrJnwi1tT4iNCpqXxkak/JkcnrTZRcRGcSet5xZZtr/U3qHT27U+r3epBO+eJmG2qZgZA3z5GI/j2MVOTq+6mydf4dofyGRrXmc93qwl+gKqRAUB0u3mip/RBF1M7E7CJwYcWz9V0xCCk62QCETcYQ7UyAUlqf2GIlz4ig9WWQpkYg365xY1FjDqk8NJm48YZWnxp03EtLo/DZo2qYM0MgKbHll80R5NxIwwpn6Hx6HGG1sgAILrdZZF4+mAL1VoIZGKQecWWNhUxuMZlFzYaN6iw0gsbjmpv6Q4kfSiF6y0GMzGcQMHlzUUMKaz04objhhVefnHjkW3Ob8q+e6D5Pz1EmoP7EDB6KELWyQEivuklDZqT/XFb/R9sa0OxcJbFi3/94+WLtb5P8Kd/vmiD4H0H708vykt2WbcV7tbN/W1b+e8GQCtu+/DQifhH/7f/bG707dw//d0U+ePVi5d/v3opqkvOin/84+XfbQ39B/0PuljR/l/xkrNLXnGvWOEVK9v/K19W6rJi0itWesVY+3/sZSUvC+VLY16xqv2/6iWvL6uSecUqrxhv/4+/5EXbBeUV414x0f6fwKQJr5hs/0++rOpLJXxp0ium2v9TWDHlFWuN8vcaK1b76u20XVxhBQtgCG2JAutH4duiKKmeFL41Ckb1pfDtUVRUbwrfIgWnu+MbpeiUX5ToyPLtUkhq0BS+ZYrOAgV7ycXlFQeN+8YpOiMUFTb6C98+pbYPx0qWvn1KbR+BtV6CudJZoUANVPoGKhmppNK3UNnZoVDY6Ch9E5XaRDUq0zdR2dmhvEJl+iYqJS3Tt1HZGaJER3Hp26isKSdQ+iZinR3KEjMR803EOjuUDJPJfBMx7c8qzJgMeLTODiU6QJhvItbZoUQdEfNNxDg5QJhvIqZNJNHWfROxzg6lQkv6JmLaRDWK0zcRq2mcvo2qK2oOV76JqoKcw5VvoqqzA7tCS/omqvSqg465Cqw7nR1YiS0plW+iqrMDQ4dS5ZuoEmTXfQtV2s+hTqnyLVR1ZmAc7bpvoaozA0OdUuVbiGsLSaxD3DcR7+zA0JHEfRNxbaIaLembiHd2qFBXw30T8YqKNDgIDjozVGjown0L8c4OVYk27puIS7Jx30Jc0Y37FuLazTFUR76FRGeGCvWIwreQ6MxQcbSkbyFB+znhW0hoCwkMp/AtJHT0ho4k4ZtIcLp1EMJpE6FjTvgmEp0hKtR7Cd9GojMER8ec8G0kaiqgEr6J5BUVUEnfQrKgAirpG0iWZEAlfQPJzgoc9XLSN5CsyIEkfQNJTo136dtHCnK8SxBld0ZAg3bpm0dq86DLuvTNIzsjcHQKSd8+qrMCR3uufAOpzgwcnULKt5DqzMDRZV35FlKM0qbyDaQqUpvKN5Ait0DKN5ASdM99AylJ9xzshLSF0OBD+RZS2kJodKp8C9VkoFD7BqoLSpm1b5+6pFRU++ap9QRCV6vat0/dGUGgm+fat0/dWUEUaEnfQLXepaLDvfYNVHdWEOhwr30D1Z0VRIWNoxrsVjsrCNToNdywXlHO0PzJLVpQ7tD8yS1aUg7R/MktykiXaP7mlq1IDZi/uWU5NfTMn9yi2ljoYmj+5pbV5kKXQ/M3t6zewaL7KPM3tywd2pm/OWU1lSDQ+VeMaIbOMqJG5UKiwTANVy/LtiwUC6ymGQWJM0mQbdCkgixxCMBqmlaQ+KYfUg6aWJBovFFA0kFzC5QagNk0uyDR2VNA5kHzC1Jg/qgA3EOhGQaiLGAfCs0x4KO3hPQQSdYVgH8oNMuAOs8CEBCFphnw/VgBKIiipDe4BSAhCk01EKwOoCEKTTZIdEUqABFRaLqBmJeAiig040DMS8BGFJpzIOYl4CMKzToQ8xIwEoXmHaTC5UJej5HzEpAShaYeiHkJaIlCkw/EvATERKHpB2JeAmqi0AQEMS8BOVFoCoJSAzCbJiEkuhcoAEFRVPSyBiiKoqKXNcBRFBW9rAGSoqgCy1oF6djOMOoKNRogKgpNRyicNwZURaEZCYUGIQVgKwpDV6BcSQH4ikKzEhQGYDRDWaCODFAWhSYmFBoJFYC0KDQ1oXDKF9AWhSYnFMqvFIC4KDg91QBzUWiCQuFRA4c8urYa7skAfVFokoKCC6ymeQqFexzAYRSaqcCnBCAxCk1V4FMCsBiF5irwKQFojEKTFcSUAERGoekKhc91QGUUgrYZ4DIKzVjUV+hwBGxGoTkLQiw8/OjMUhe4WGAyTVsQYoHFNG9R40s74DQKQ2rgYoHJNHlRM1QsIDYKzV/gYgG1UWgCo67wkx1gMkmbDLAbheYwao6jBSaTtMkAw1FoHqNG9/mFhCdWtMkAy1FoLoMYYIDnKDSbQYwawHQUms8ghgLgOgrNaBD2BWxHoQJGA3xHoWkNwhKA8ig0sVHj4RggPQpFWw3QHoUmNwj1AuKj0PQGoV5AfRQqMNMA+VFoioNSLzCbZjkI9QIGpNBEB6FeQIIUmuuocb8PeJBCsx2EzgATUmi+g9AZ4EIKzXgQOgNsSKE5D0JngA8pNOtB6QzYTfMelM7gIbG2G76kAFakvDLn+FcvWXF5VcODYnBSrMkPXMElIEZKQ4ygCi4BM1Jq9gNXcAmYkVKzH7iCS8CMlJr+wBVcAmqk1PQHruASUCOlpj+Kq7Zz7USW4JAXcCOl4Uau2t5Vl+2KDgqDs2NNgBRXRPeA7focDPysGdAjZUGubyVgR8rCcPfo9rkE/EhZkAtcCeiRUlMgxRXKC5SAHykL0leWgB4pTUrGlcTlAtsV5BJXAnqkNHkZVwqXCyxXkGFJCVMzTG7GVY3KhdkZJW23UXqGtlsbd6Jygd1K2m4wRcPkaOApPCXM0ihpu8E0DcOQEOMMZmqYVA1i8MBkjVIFRgTM1zAkCWFmwJKULGQ7QJOUrAgYBPAkJTPWQ49zS0CUlDRRUgKipGRVQMuAKSlNBgehZUCVlCw07wBXUjIZ0DIgS0qmQloG9jPZHJSWgf00J1IUaAJECQiT0iR1EKoDlElZlQHVAdKk7EkTXHWANSmrKqA6QJuUFQ+oDvAmpeZGKNUB4qTU5EhR4MsNYE7KSgXiCkCdlFUd0jOwIL8K6BmwJyUvAnoG9EnJy4CeAX9SchbQM2BQSl4F9AwolJLzQHQBOJSSi0B0AUiUkstAdAFYlFJTJUWBng6UgEcpOb36AR6lFGYG4vYDTEop6NUPECmlMP4TNzVgUkqaSSkBk1IKYzt8VAAqpaSplBJQKaUwcw8fQIBLKWkupQRcSqn5koJKfwR2o8mUEpAppQzZDbAppSwCxgB8SmlyRQgNA0Kl1KwJpTZAqZSaNimItE3AqZQ0p1ICTqWUIqQLmGMqQ7oA1pMqpAtgPVmHdAHsp8mTosTjC8CslKoIdBBQK6UKzTzArZSKBToIyJVSVYEOAnal1BRKgafJloBfKZUIrE+AYCmVDGkDJgqrkDaABVUd0gawYH0V0AYgWcq6CKwigGUp6zKwigCapaxZYBUBPEtZmxlI5EMDC9b0DAQ8S1mbNHx8vw6IlrKmvSfgWcraeE+Bqw1metPeE/AszPAspcTwMsCzsCty1WOAZmGaSuk+tYbKBSnfV+SqxwDNwq6M3fBsasCzsCvSbgzQLOwqYDcGeBZmeBbcGAzwLMzwLJSGQQK44VkotQHbGZ6FoSsqAzwLo3kWBngWZngWQheAZ2EFC+gCMC3MMC2ELgDTwszdF0IXgGthhmvBk9IZ4FpYIUMdBPYrAjOPAbaFmYswVAeB/QzfQnQQ8C3MXIdh6DLJAOPCDOOCryIMMC6svxSDawNwLsxwLoQ2AOfCTFoKoQ3AujDDulDaABYsA0wnA6wLKwNMJwOsCysDTCeDN2UM64JfW2DwsgyjZyC8LWM4F1ahIEYXZmjvCW/MGM6FoXsnBi/NMNp7wlszhnGh8ALbGcaF4Rd34N0Zk56CgwCWM3wLBQJYzvAt+P0MBvgW1l+iwSUDvoUZvoWhR0MM8C2s51vwiQr4Fmb4FgoGsF4V2K0zwLewKrBbZ4BvYVVgt84A38IM38Lw9RrwLawi4xYG2BZm2JYKPfNhgG1hnJ55gGthhmup0PMhBrgWRueqMMC0MMO0VOhZEgNMC+P0zAM8CzM8S4UbA/AsjJPxJgMsCzMsS4WeUTHAsjCaZWGAZWGGZcHv0jDAsjCaZWGAZWGGZSHGA2BZmKZSKCMDnoWJkOUAz8I0mUKZAzAtzDAthI4B08I0nVJUuNcEXAsTtNcETAsTdUhxwHqGayEUB7gWZrgWQnGAa2GGayEUB7gWZrgWQnGAa2GGa8HvTzHAtTDJA9oAbAszbAulDXhdVIa0Aexn2BZKG8CChm2htAEsaNiWCl+dANvCDNtCrE6AbWEqNAMB28JUaAYCtoWp0AwEbAtToRkI2BamQjMQsC1MhWJOwLYwFYo5AdvCVCjmBGwLM2xLhd6rYYBtYYZt4ejVGgbYFmbYFo7ermGAbWE1vfYBroUZrgW/esYA18I0oVLgt88YYFuYYVs4moXKANvCNKVScPxqOeBbmOFbOJpcygDfwjSpUuA3txhgXCrDuHD07mUFGJfqytgPNXYFOJfqKrDrqwDnUvW3ftDRXAHWpTKsCz6aK8C6VFecHs0V4F0qw7vgd78qwLtUfX4L0UFwp9vwLvhdsQrwLpXhXfDrYhXgXSrDu+A3xirAu1TmmRGBX0MHzEtlmBeBDtEKMC+VYV7wW1MVYF4qw7wIdIhWgHmpDPMi8CEKmJfKMC8CH6KAeakM8yJxcwPmpTLMi8QtCJiXyjAvErcgYF4qw7xI3IKAeanoTJcK8C5V/xIJbmzAu1SGd8GvOVWAd6kM7yLxlwcA71L114HQkKcCvEtleBeJRgQV4F0qw7vgV0AqwLtUId6lArxLZXgXhZKZFeBdKsO74BcgKsC7VCbbRaHMWQWYl4qRN/AqwLtULORBAfNS9dkuuOsCzEvVv1eCGxtwL5XhXghjA+6lMtwLYWzAvVQm24UwNmBfKsO+EMaGr5cY9oUwNnzBxLAvhLHhIyaGfSGMDd8xqcgYpho9ZGLeA8I9BnzLxHAv+OWYCj5nYrgXhft8+KSJ4V6we0oVfNMklOlSwWdNTKaLQk8SK8C9VIZ7wS/TVIB7qUymC35DpgLsS2XYF4VeDKwA+1KZTJcaf7EG8C+V4V9qfBAB/qUymS41vpYABqYyDExNPF0D7GcyXWr8LTbAwVQ8cPJQAQ6m4uZKJX/J+OWVAlEXYGEqw8LUeOgAWJjK3BqqcXMDHqYyPEytXjJ5CQ0IaJhKBMjPCtAwlaFh6hoVDOxn3kHpBCNl4WtC5lGuAi0LrGc4GELHgIOpNNFSXuGDCLAwlWFhCLUB48lAanwFSJjKkDC42gAHU2mahVAboGAqzbIQagMMTGUYGEJtgIGpzBMpV7ijBQxMZRgYXG2AgKlkaPMACJjKEDCE2oDtNMVCqQ3YTjMshNoA+1IZ9oVQG2BfKmVshy85gH2pDPuCqw2QL5UKBS6AfKkM+YKrDXAvlRK02gD1Uml2hVIbfMtLhdQGbKeM7fDFFzAvlWFecLUB4qWqA9RZBYiXyhAvuNoA71LVjFYbIF4qza0QagO8S2V4F0JtgHepamM7fP0AvEtleBdCbcB4dShoAbRLZWgXQm3wNbYrUm0ckC5c8yq42jjgXLjhXHC1ccC58CtjO3Ql5YBz4YZzQdXGAeXCe8oFVRsHlAs3lAuqNg4YF34lA2oDT7RdqYDawCNtV4FohQO+hRfGdsQLefAxvYJWG6BbeBEgzDigW7ihW3C1AbaFFxWtNkC28ILTagNcCzdcC6E2wLXwwtgOfy4QcC3ccC2E2oDxDNVCqQ0Yz1AtuNoA08LLglYboFq4eXQFVxtgWrhhWgi1AaaFazKlLFCKigOmhfePv6JqA0QLLwOpnRwQLbx/ARZXG7CdeQOWUBuwXVkH1AZMZ1gWQm2AZeHmLdgCJes4YFk4o3cJHNAsnAV2CRzQLJzRuwQOWBbO6F0CByQLZ/QugQOOhbPALoEDjoWbx2ELdJfAAcfCGb1L4IBi4VVgl8ABxcIrepfAAcPCK3qXwAHBwit6l8ABw8KrwC6BA4aFaxKlLPBnPgHDwit6l8ABwcKrwC6BA4qFV/QugQOGhVf0LoHDp2M5vUvg8PFYHtglcPh+rKZQSvyhbg6fkOX0LoHDR2R5YJfARw/J0rsEDp+S5fQugcPHZDm9S+DwPVke2CVw+KSspk9K/NVyDrgVLuhdAgfUCheBXQIH1AoX9C6BA2qFC3qXwAGzwgW9S+CAWeEisEvggFrhhlop0F0CB9wKF/QugQNqhYvALoEDaoULepfAAbXCZWCXAJgVLgO7BMCscBnaJQBqhRtqpcB3CYBb4TKwSwDUCpehXQKgVrgM7BIAtcJlYJcAmBUuA7sEwKxwGdolAGqFG2qlwHcJgFvhKrBLANQKV6FdAqBWuArsEgC1wlVglwCYFa4CuwTArHAV2iUAaoUbaqXAdwmAW+EqsEsA1ApXoV0CoFZ4HdglAGqF14FdAmBWeB3YJQBmhdehXQKgVrihVkp8lwC4FV4HdgmAWuF1aJcAqBVeB3YJgFrhdWCXAJgVXgd2CYBZEVeBXYIA1Iow1EqJ7hIE4FbEFb1LEIBaEVeBXYIA1Iq4oncJAlAr4oreJQjArIgrepcgALMirgK7BAGoFWGoFfybHAJwK+KK3iUIQK2IIrBLEIBaEQW9SxCAWhEFvUsQgFkRBb1LEIBZEUVglyAAtSIMtVKiuwQBuBUR+ICOANSKMNRKicbRAlAroghEKwJwK0LTJyX+/RMBuBVRmi+14B8RAOSKKAOxpgDsiugTWdAMBAHoFaEZlLLEv1AA6BVh6BX8wykC0CuiNAZEFycB+BVhPq/DUJcsAL8iNIdSMtwRAYJFGIKF4dMPMCzCJLIQmgMGNJ/awe8PCcCwiP5rO/igAwyLYPQ3kQRgWIT55A7DxxxgWIT56g4jPlwB7GcoFoaGsgJwLMJwLPiHUAQgWYT5/A7+LRQBSBbBAps9AUgWoYmUssKHEWBZhCZSyu7TAoi1AcsiNJNSVvgwAjSLqMhEJAFYFmFYFvybJwLQLEIzKWWFjyJAs4iKvIgiAMkiNJFSVvggAiyL0ERKSXz9BLAsQjMpZYUPIkCzCEOzEF82ATyLMDwLnkotANEiNJdSEt83AUSLMEQLnkotANEiuPnkFfoOtABMizDf68HzowVgWgQP7PgEoFqEoVrwZGoBuBZhuBY8mVoAskVoPqXEk6kFIFuEIVvwZGoBP+GjCZUST6YW8Cs+wlgQNzf8kI/5kg+emCzgt3wM3YLnGgv4OR/Dtwj0pWcBv+gjQhYcfdRHWxBPTBbwuz6aVCFhAAuGGBcBv+6jWZUST3kWgHIRhnIhYADORchQDANIF2HSWfBkagFIF2FIFwoGsKAMsJ0CsC7CJLTgadoCsC5CihAM+GWmAFctAO8iDO+CJ4ALQLwIza3gH0QTgHcRKrSFALyLMLwLnmcoAPEiTE4L/py/AMSLMB8DEviHqgDzIlRoFwGoF2GoF2KNB9yLMFkteIK7ANyLMNwLnuAuAPciNL9S4gnuApAvwuS14AnuApAvQhMsJZ61LgD7Igz7IvFZBegXYegXiY99wL8Ik9mCf21CAP5FGP5F4o4f8C9CcyylxB0/IGCEyW1RuAUBASM0yVIq3IKAgRGGgcE/ByAABSMMBaPwrQHgYKTJbsETjiXgYKThYPCEYwk4GKl5lhJ/ZF8CEkaa/BY8MVgCEkZqoqVUqAUlYGGkYWEUakEJaBhpaJgataAEPIw0GS41akEJeBhpeBg8MVgCHkZqrqWs8e+oASJGmhyXGrcgIGIk/ZaLBDyMLAIvSUhAxEhDxNT4yABMjDQfFcJBAOuZ+0T4bU8JeBhpeBj8HqkERIw094nwC5wSEDGyCNyqlYCIkf0njfGP9QEiRhoiBs+nloCIkfR9IgloGKmZFvzxZwlYGKmJFvxhawlIGKl5FvwBagk4GFnSr4xLQMHIkn5lXAIGRmqSBX+0WwICRhoCBk9Bl4CAkSX5GoEE/Is0GS740zcS8C/S3CPC0/El4F+k4V/wp28kIGCkSXHBn76RgICRhoCpcb8JCBhpCJga95uAgJHmE0NobCYB/yJ7/gVdniTgX6ThX/CoTwL+RWqKBf/EnAT0i+zvEaH3RSSgX2Sf5ILeF5GAfpHmHhF+UUMCAkaaDyJf4QsOIGCk+SbyFb7gAAJGms8i45cIJKBgpPkyMp46LwEFI83nhvCEcQkoGGk+kIynSUtAwUhDweBhuwQUjDSfScYziSWgYKT5UjKePysBBSPNx5LxrFEJKBjJA7sHCSgYyY0FicLAgjyQMSEBBSM1y8Lw3EMJKBipWRaGZ9xJQMFITr4IIgEBI3ngRRAJCBipORZcLqBfpEl2IaIAQL9IQdKfEpAvsn/NBV91APkiQ6+5SEC+yP41F3ydBOSLFMZ2+FQF5Iuk382VgHqRgv7ChgTMixT0B20k/LSypL+MIuHXlc3nlXGlwQ8sm68Q4daAn1iW9JdRJPzIsuZVGJ7yJ+F3luk3cyX80rIMvF0mRx9bNnMO95rwg8uSnnPwi8sm04UIRADjIvsXc/FABDAu0jAuRCACGBepAq92SsC4SMO44IS4BIyLVPRuAfAtUlMq+Mf4JKBbpGZU8I/mScC2SEXenZWAa5GaTiEiIUC1SM2mMDw5UAKqRWo2Bf86pARMi9RkCv51SAmIFqm5FPzrkBLwLNK83IJ+HVICmkXWZtLhyzOgWST9TK4EJIvsSRY8fAQki6zNpJO41oDpNI/C8DQwCUgWST+UKwHFojSLQoBQgGJRmkVheFKVAhSL0iwKw1OJFKBYlGZRGJ5AowDFokyeC3oIrADDoszXmtHgWAGCRV2ZWYcudQoQLEpzKPiQV4BfUZpCYXjChgL8ijIfbMaTMBTgV1RBxikKsCtKUygMT8FQgF9RJs8Fz31QgF9RReCgTwF+RWkShZXog28KMCzKMCz46wsKMCyqMObDPzQPGBZFf5dIAX5FFcZ66NRTgF9RJtGF0gWwnqZQKF0AfkX1iS64LgDDokoz+fCZCigWpWkUfGVSgGJRZeCMSAGORZlrRPgGWQGSRZUBgkwBlkWZe0T4DlkBmkWVgUcfFaBZlMlzwcN5BYgWZT7ijOfmKEC0KBa40qAA0aI0l8LwRB4FiBaluRSGJ/IoQLQozaUwhjsjQLQozaUwPDlHAaJFaTKF4Qk3CjAtSpMpDE+4UYBpUZpMYXjCjQJMi2I1GTwpwLSoyhgQn9uAaVGaTGF4co4CTIvSZArD820UYFqUYVoq3NqAaVGGacHzbRRgWhSd6qIAz6IMz0KEAoBnUYZnqdBIRwGeRVUBokwBnkWZDztTkoH9eCh8ATyLMjwLniOkAM+iDM+CJ/4owLMobuyHD2bAsyjDs+CJPwrwLEpTKQxP/FGAZ1GGZ8ETfxTgWZThWfA3FBXgWZQmU/AdrQJEi+LmlB0fzIBoUcIQZSjppADVojSbwvAXFxWgWpTmUxieUaQA2aI0n8LwJCEFyBYlyE2fAlSL0mwKw/OJFKBalKFa8HwiBagWpfkUnBNRgGtRhmvB1z/Ataj+XhH6opACZIsyb7bgjwQpwLYoGSCqFaBblDTWwycJ4FuUeTiXiAYA4aIM4YLnVilAuChp7IfPKEC5KM2qMDy3SgHKRRnKBc+tUoByUebdFvy1KQVIF9WTLiiPogDpolTgmoMCpIvSvArDn5NUgHRRmldheNaWAqSLMveLUPsBykVpXgUPmQHlosy7LfhQBpSLUnSevAKUizKUC5oLrQDnoszdItxygHNR/bMteFlgOJPdgvcNUC7KJLfgsxRQLsrktuD6BZSLMqktuO8GlIvqKRe8LLBbbaJOvCywW22cJmoLwLgow7jgm1pAuCjNqVS4LQDfojSpUqGP8ylAuNSaU8Efiq8B31JrSgV/4rsGdEutGZUKtUUN2JZaEyo4w1kDsqXWhApH7VYDsqXWhApHx04NyJZa8ykcnRc14FpqzacIQmcSlO1sg5+z1oBqqTWb0p2OjcdODZiW2jAtOAZAtdQmkQUNd2vAtNSaTOlerkQwAKKlNh9/xm0MeJZaUyn4pr4GNEutmRR8x1QDlqXWRIpC51sNSJZaMyn4qlUDlqXWRIoi+gbspnmUGh9ngGOpNY1S43MIUCy1ZlFqHC9gWGqTw4LjBQRLbR5qwb8cXgOGpQ59/rkGDEttGBb8K8Y1YFhqw7DgH+OtAcNSG4YF//xsDRiW2jAs+MdLa8Cw1IZhwZe5GjAsdZ/KgmsDMCx1n8qCawMwLHWfyoJrAzAsdZ/KgmsDMCw1C3zMrQYMS20excW/dlYDhqVmgc+B1YBhqfsPEhHaABY0uSz4mlsDhqXuP0mEmxtQLHX/SSJ8tgKKpe4/SYRPV0Cx1KFPEtWAYqnNJ4nwL/bUgGKpzaMtxCoNKJbaPIuLf8KkBiRLbR5tIdZ0QLLU5tUW/KsWNSBZakOyECsUIFnq/hPQ6CPPNSBZah64DVb3JMs/Xr5Ybz43u0Nz+3Zz23x58ae///3F9fXh62Pz4uU/X1yvzT+2u2Yt9MWf/vmidVvtf/718kU77Pof3P4Qww9uf0j7o+5/tFvG/octLG1haQur/l/KorA/mP0x/EnaH73ksrSFS1u4tIUt1O47y+aHsIUt5tJiLi3m0mIuLcLuA5v9D1um7st035zsfzD7oy/MbC+6L6v1P2wZZsu0k9X8qKxAbgtb9XafW+p/SPvDFrbd6b6oY37Ufa3KqqV7Mtz8qPo/dXf3+h+9ZGmhdlmz5oet3qUrmh+8b6LLqel/lPZHD0xajXW5BeaHsgKtDqVVXXfm1f/oqyuLp2Nm2h/tr37k6v/rRvLq5qbZ7w/bX5uNO1K7B8KHodq9Ad93XZFiDuvP3ljvDvwGCd0xX6jivmlu3cpKOhPFmAure+tV6i6ODrW666JkrV3bZa+3TmvWttYCyupSsbDA67WHhp9kDjbsJfX/X1sHUE5K1iJd4eVJuiRVa2qvHtc39+vuD651CleCEGERH1b3q81Nc7/ee0KEo26rJHKcGUmNp/eOjT6NETNRQ3XbrrjVa8fehZ0FXfg5LWb1Zb3dP652q4ebXbM6bHfe6HPl2jnZheHTcu/a8bzdffVQumPZzt4u+I6Q9ugJcvRdSGFh1RGC1ptDs2uxeTO0DfUd9dluljFWeNje/OpNPRebnOrbaDh3xwHOOJgYQ3AYFu70LexADDiNTsjD9ra5B4ORuyAmRtHj6vDpcdfcrUFHhCuDnNf37aC7/dp8aXuyb3Y7f/h1L+CdfEdFduRhe/QndeFosSzt0mbXMets+n8QdhnrkkaIFqzn8PTUJYed5r1dXSXtHlsprbI9EVeOiMoGDN1z5P2PHmz3ZLT5YVfh7lnf/kfvTbldYbldYbvnMc0P23luF2huo4LumTnzw8Yt3VNg/Q8r2U7W7gGi/kcvWdiYRBTkOHlcjyxbuL6gEuRMe1z/2nz1LSvc5biyy7FFQfs8LUrX9NZmd6gXYRyPu/Xn1aEBiLpr8M4oCLT/0K1BH4H9C1cP1sg2ku0eTe9/2MCjtqaw4SG/ska2kSy3Q57bCKt7xLM3uzUyt0a2oR8XVrINqLkNtbhdqLl1jtwuMt3DP739yWG/+3js/mE8vYUzvQW99LaudnfQS5TxE954EI4BK3oMtjJ8D1G6K5vpgo3yRTEs4iFMBxDnuM6q6DVX2b1JGZS0BuEbd8M3Uq9dTd8huVFE99oFUfGwfVjfXB8368P++rHZXR/3tzf+kHbjR3p2Hg7N/rA6rLdexFw6qmXkAng8fGr/f33TTqhd89/Hxl/Juhd0TghKsietlMPqoz+jHY/a5RcSNbuwx7PelWO+8spu1PiwLbN7JjunmA2Mu08YGmNfUStUHzb6A9dprrDey25gFBWz95IeVo/+iJHuiKFh7Jvrbr32gLirGKspY3d1QdRZuMOkugrV3D52o8RXuHJdH7OOrgqJGWG/Kl2jKWs0O6Gtu2LlsBkW1mh2hl7ZNcSWqdiwjbSbRjIU7EC1sLb365U/EV3PVlEz+MNuu7q9WflDX7qeyS7pBRv2uCQUK+ywW/lBRuGNNbvHLuXww6pLWQqDHn5eI8jELZx5a1dnpagNgytus79r/BjBXZvbuLo3nF1wmKWNmN3kM+vApR1NUlJ7glHLmBO6ctVm+0JKPK7vb21M7U/PLqHk5JMEORw6Cf/1G3CErisuqZl9s7r51CD7+S7lxGmZrr7Zrz96XrxLSTjVlNSAGG+ouw+DneY1GbSbin8ELsXROLVy9BW7mec1W9WuG5uo3f2zv2oVbjBSFZP1N3frj8fdaPHrvo7oxKfU8gP3AcyZNuTu/2a73sBud3Ss42n6cS8GZoWTHemF/RFjgZQbVFVU6HIS8bi+RkJ8N1IX0zhgiFa6vJkoyIE0CDiFFCDOdB2JIGmCQRCyWnev4znTkPJnUMT1aJ12mSJGhTWDGNzi7q6TTfamHaptkDbauroq4eTstkK0dX0JwoUh6IHeS7hbHW/akFm7247qBDGjcAMYksgbpHWB594O3esDdNzu8YIgg3gozR0/iEx3opELJJDpjANEojumyDWSkDiW5s4WcpUC0uz/IuLcrQTtTn1xYyMjgt2RR0YzQLBdpRFx7oyqJ4ehEXfco6LcMVhTqzQUdVj77Fn3ao8jZnKOGzG/re7vO81BTC41KacdBhZHlS47LMnNwUnG10dAThfOdJJ8cjp12vW3ZA4AFVgTbX2o0u7+w0kAmxRglOlLcHlV8vDGSggsJe5wI+ldK8eGCc3dbvvwX/vtBtkHdTeVHApqSruoBDe8vKKnfqsVMynvtruHFSBSXBqLBSbSw2OrW/8w1yU+7J6psJSTDMiigiiXFSstv1ny4azUnk3a4zhmj/fYwJPZQ9PKnozWFa0YB4fhmQ6Nv9oVrteqykEkPZCA4f3F13XVJMmvF+7d8QYMwcKljEvLApeV3fxappgNxLfl/Jjd31VXll++Gs4z7S7YyqksHVzZfWJl6eDK0sGVNURl6WBu6WBud2fcnqZzu4Xi1iLchqvcUimcWw7SHj9ze/zM7QFw902C/oeVbPeG4mpg8GwgbIk4MXAsdhQJMfywZSzx2T1y2P/ogQlLxCqSi2rN1Xrfm8M1FlC7O1naaejEidbm683Hw/YTOBlyQ0dFnunqQzx/a+EeBiuSXjEVEey1m6phOeLCUsOFHW6FJcjKq+F8fzi77/+kODlf3NaxrbjrEPqmFR2VGGk4PclcR6c46RSMjI4mHJ/xOfNX0v5WS+g7c3fcjILewnWcFT0utJx2TW1HR7dLByzJlTu27Kwry4HTrqyDsOQO7QdHDWGWcDDb7BNFh3FaJMJIuQd09mC5tPOvtNOutHO9pMPjUwsYWmfSWE0oekGyshAuyqXQrLdj1n0ym03ErL9hw9HUkNzChgNC60tIdsoHgvXLJTuG+UCGrFrcOCoq3K0ksydCzNqD2XQlJofl1ebl2CMSaROGFHnC4baOdIV5NLDtCullx8KwaM8RaTncmgx89599X+2eX5BAblcHj/J1BrRNOrO5UPbA2a7VhV33CtIf3jYfjh8/tuuAH+e5S4ClhhXpOG6bm/XDyg+lCydUJJmQ26bdyN2jK5lyYz2SXLICsBNP4e567XoibJ6XsNGGsIuGkNTAum3uV199u5fuGklNh9ZTrD/jbKlbnzz38uqDrZIb2imSFTESwEEycw9iFMnJ3LZDfr0ZL2tuIsGQT2XHCHky5Ug7bPsutZGHCUJ83bo9I3eit+v9Y2uVa3jQrtxTDZJRvD0+PHy91oTEcXfv07Mur0oe1Debm93Xx4OfQ9e9VOLsj+i6u3aH1P3TNZzcLoFIDqvGP5sq3SwaQXa5+Qz488qlD8haXx63O9/nufy3IjfpzZdD01a4vX48frhf31yDMeieW5GhUSujC3QfmweYCuEOQkEuCHer9b1vIZdsKuzSUjAbP5ILm+GbfOpaub7fBigko2gk3K8f1u1y0h2i3I7TFNxzIE4uCEYSwW+6J/rVsN2wS2dNamrd3Ps5Bu6pTEXmkt61CoZnpcw9UldkDl9HDXTDf7TtdGdwZWOZqqJcXLfxvcYTQoWbvndF9l0LGKV2ubQzbQtdFx4ouLojo4FTVYDapWlYCLRJrxgjL12aRhSUf+9E9CSvzyu6Z0QiiAA5i3FnhY3vKhuZVPYEuFJ201/bTb/NS+f2nJzbzEJuY11uM+m4zaTj9gid2/N2bnPOuT1/5nbJ53a3zS0/we3hPLep3cIyFoLcbnUd17mMvtJcqmU4Fia3z4OQ1eYWzcxxTcioleRj0+6dur1fK2X78Gm19xcG5aaIkhkqVogJbztgMDe8dI/pJLmufWwO2LbezRW1iWeFdUmF5dEKm29WWgvI4ZTdDh8lKHWemkbO1GovBWvgE2xsbMdAMVyRsOyOtONNyuk+d4r7dAsXKteZiZryhZ2U0TRmbqKQJNf1ru54ADE3YUWSh+NtZSxlqPb2NTYjQVJReCvl5tjuHjcHyMgX7jhmdtYyS9kyNuQ4Waa1spct7K5GkmF522wf/2Mhtuu/VYQMCL10cykEGedoAUNoa9OtgS0K1xbUWtJK6qPKVhAM2d2kAaXoqXzQmYttSN3NYaAQd8+hAgNary14R9zzGTLb6CMcjIWb3l9xa9hqoDrtNQ0ZELlpDr9td78CyS5pWFnXL6shHAt0s9NQ6zcfVvvWgUJ9V66yQiaj6TIv7846N9vV0uZZlXYPVZKbXNBKRzUewWbQPdmRgdGhJdw+rr7et3sw37SuiyePGzoR4+av3LNDHmge4efcNC67SS/lQNQNhw2W9CUPnD/SMbFrChlSsyNgtJgKNyoa6CmS4/Sl3a83PrMr3Gwr2zlJXl+w0kZsoRsrWtqH2fxEZocds2cjbFjRrC+WIU9g2/SZHXc9rcirYm314yYw3ip3vAXWdYxNdE8Q+UAiWmrUMjvMRptsULA9NJT22EeVAQOaprEF0nUPzJ4lMTt+meWXmRxSd4dlzd5FJO8HDg1DV+cSEzZdWJL7oo+/NV7GW+ne+BH0DG+r6Vzt5vAJLogeYUBNo3biXD9sdz4p47gng9vy2NZWhT3MKYZMdpIW+HQ4PMK8tsLNPaisISpriMo6ksomrFU2ZbeyNwy4TfjkFhwv7RbCum1uuX1uYXK7y+b2vI/bbQ+3cSu3A5HbgcjttofbbY+w2x5Bck7+eHCzmgtLPhekXdcPHZGDUdhunESm0a83a8ACudXIQahvwW1W98iVDDe6EpSp15vPq/u1zXYdS7ny0hlp8K6UNcK8uCtERbIkVo4O1REhtQuGcmlWiL7pY/IjfMW46V9kCq+VYiJ/5EKb0yFOsnu9FDI/onQvvQgysOjFOHEwAsjxPpyM83pJmiZDZDhel5O5Nb2MIV5E5LijRk2MmsfVxwYRUbhQyBlrRHirIEL7uRYnd9e9LLsko/1y+UMyfwAIMvEcgsrduZIEYC8ssNKXLgsnJBUu9IKMg0Lmljt8riaGj10+ETEePUp6nX2XSfOw9k8WCvdIqiL3BGvvkI+5xlUkcHj50L2NX5ERa3ct16c9fObFPUIbFlrLfRU2q6WwWS2lXYKkPdSX5JR3mgaNugy7jeMLGy8Xdt0rhmcobCKPtGdI0kJVghp1XetYjwuXbKpsXKbI5eXe3AYetlb6jATc1nITCIYLfDY1pLRMRmlPlEsyqx42BtpxN0KW8CztPa3SHlGUlh8pyX1W147eaPkNuGdTpeXhSnv4WVpCrrSRaklmvfQNIDsDl/lnlsdj9o4bs9E3s3EVGwaaTdWSJLfRteoF5OC42U0XsZQVs6lXzI5EZgNBZgNBaZUtycX21DRo0yW3bPoFs7plctiQWAXYHCZpbxJJC1CRqf6dP4WELHMvxCnSp95vP7ZhRjtHH7ebPcjVcjM5yVTdh9V9F6E0t30GBLLkOHI4OSQNx+LHjy6hZdPyFLmdflh9ucYPwt3TClVRYxZJEHDT1Wjk25tf7/yYyH2nRZDHO13FXbsF3m12zX81N4fmtl2ajn6GghvCi5oKGE+SEAnuOSgZt45OKwr3ZKCyN/SFXRrkkOlj6QJF7iu07NG4YN5y3csge9iHauAczJ3Q/aIx5Nz2/7UvcgybSLsNKofdJDWg+jbhyxalu7MXZBLjpvnNfdXCt4mboUOu+Jvmy+H6EQxJZ2TZxXngDWwX7Uo65F6QO/HNdnS5yB1wJWmO7eGu3eFg4ZNLQZCeevvYmK2EWe3A1aTC5aEr8pQNu8jrEhDVFdXtx3ZT1JrWJ0/cuxKVXXUq8njusdncgrwU91pOYRmCwvIB0o5BdTUhs/PlOrkM7LXcKVmQudqPa3BnonAvWDFyihFPSrj8obDnbYp83YDI5XBUa2MHQsCu+bjulgKd7qrJgZvm8QBufDE3iUGRB9C7ZkwquhdQTuEfNVL6VW21+whU6iZzkod2NuFWp2PctfPFj4OdPhT24Lmw/E9hE9oLm+JZWvZJ2nR6SYa/Xcvtsj6eoIV76FWRGQ+t39oeW803Xz6tjq05sK2kuziSl9D2q/FDYsydpUpSA3lUzSUIpN0dKMtpK+vrFbkb6iSCJcR7psKeyYcQ2Yk5TpZyt9ZD8ihloJGoVuPHe1+gy2XYvtXUvOkEwlwx5tIYMoBlt243xf/TdPXXd5tWUgN8o7tpIvN1jDO/NnsXmLLiBsI2gcL+l4qQfIHjYyX3endB7qqMFFPFi3C8NEWbf0LGh9QxnpdbV9hwI0bKeAh5/LsVFe6XI2osz41DpZVHue6RPBj5eG9MKSuOCl+8jSx8rsPdFJQ2tq/JeAPKCr4UV7gxSGmv39Tkg35QOPJcXOHyiqUdvzX5BsJIpB/fuNRgaUmNmqTjoDT04bjCffOnrIZeUx5+4rzY5fYUuUzsm4NhqQ/b7YduD+MvNe4WgnyTad9t1/frG/2ADirGZboKWkmHD81q1wYOpBw3wCPv8LdytrQI9wiJvB/ZvYXUQrn5pEcouLznOh3yBGBvcg/8RdPNuCf5+r09wSdPut1FlPaZrYx2TPhndF4OAbkI2JrkQuleerIESE2+d4fLG6+WnnrsBCVzzY2OrhEy2iPBbAaGzUCzx+YFGb52gtsQHpPs5uOT12328AaIu8clqYTxBHYHe2F9YEEeQ+yPHx7WPvfYRQG4qgs3iC4tU1ey4YcNWO2ZY0lmLSDtWntTjbtHGKWNhEubBVzafLHShoMluVM6bLGkXsfxkXRJV3OU0utYitxk2YowOnJZUbpul0c9vg5RuI83VORNmsMWqeruQSp7f6qysUJldyXVcF13eKvKpkJySzdwS+Jyy4Fzu13kdmhwS1JzS1JzmxfPLTvKLeHJLSPLLTvKLTvK7Q1PYaN/Ye+/CcuHCDsMxZBZYc/f1XBbkDzaO2wPq/vrm9Frnu4N1OHqVC/e0i02ObSwjH9B3t8ZpTt5WyP7ei65/urq8I1jlyKi5p2uOHo62BkMw8u9JFlhDhBgYOfeySyHp3/IdxIGIeGIzru0bAdKTRLig1QslPPu79oBXpNpDSdZfgznv8g1QCJnnxWDB29uuFXavOOadNfE4u5mTFjWoBiO7Nhg0oDehsdSYHYb8/IfrGz7I6S+QSQYp95zp/18DAy20zMu4AF/70Wz4WBwWlB/rL05Png6dN+ZtvcLimLYPQUMbAWPvjDgEj32LKkmc1GwND73aZnCJogVdumVwwMXapAeHDp3o/25++BMQe7DbGXi+XI3YY98pu2UnuCvgG5lcvtsK0PX5Z64FMNAJ/ccw9kkdF/urU1mjwhqekl25IQ9mMt/lPXgdWIAYk7MTcliwxaXPKXzxAE/5l7fvhqAkTGTIwl3Ze4JArOhQE1ytK7A8esG7mYl5O6dPBV/SLo5y2Q2B0h0AR7BPRgo7N6/YMNMI9c2GMq7FBgZWh433e5zu+voOOR4xU0wIU91j5t19zRO92+oEDdeJClkm7CDbWXcLXlhI6+CNFAr6vjYJRc2Jh0NIZPdLzOQaZ3wIq67IWUkMzp6Uti71koe/7UD4dojIP3DadcOtAT/EwZu8DjcYlHD+b7dC5McRyeQcL3u3pLkr7v6upS3e3DpFbvjrcj52skYu013/2KPHWsy59PKCLtM974cY4OPIwfZPuAu3eMauwepSap3EOW7SuZdvR5cZWAAhdykO3YHuo48TrbCxi7SXTfJmOK4J19tKd2XBsRwclEMP6j+6US64V6tfQxwdFzuJlxJcjfhC0OOzN2TDJIsMlKGlw5HUtx7CZIMg42UIVBCxLiXnMjNmRHTv6aH9Mg9iSSJKpPDe2j6q0iBD2W4WYTkxavfVuvD3RYZBcx1ioq8soFkh7uLiT3EPH2ox55bnWKysGhIjDhRkxEwPMtlmxj29LYBuxpR3qdvSD+8CA4D3ZTd4Y2vvh3bE2rsGbGEe3bnAPmchpEwPsRz7yaR98yxCyGlm48q7JZekrGHkQFnsDv1Cqv2muSukTS4yntqNlwPLi3uuGTDzphcc09SJhYXN+y1FzTqwLyxYrHlxe0fGw7ayCu1jjB/gXGPEpkY+ho2Ob3EuMeJbGA6yGvCJ3HjRcYNo8ldVS9gdLAEA2r3rnjBbUBtj7hr8lxldF3JHVb0iKBvK7n1yfePbP3RbSk3+hRkzPrb6C0W91AWT1X4x0udxXO/3rSl/v6Pf/3r/weplr0ATmoDAA=="; \ No newline at end of file diff --git a/docs/classes/client_api.AddressesApi.html b/docs/classes/client_api.AddressesApi.html index 002421a5..966d869e 100644 --- a/docs/classes/client_api.AddressesApi.html +++ b/docs/classes/client_api.AddressesApi.html @@ -1,6 +1,6 @@ AddressesApi | @coinbase/coinbase-sdk

AddressesApi - object-oriented interface

Export

AddressesApi

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Implements

Constructors

Properties

axios: AxiosInstance = globalAxios
basePath: string = BASE_PATH
configuration: undefined | Configuration

Methods

  • Create a new address scoped to the wallet.

    +

Constructors

Properties

axios: AxiosInstance = globalAxios
basePath: string = BASE_PATH
configuration: undefined | Configuration

Methods

  • 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

    -
  • 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

    -
  • 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

    -
  • 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

    -
  • 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

    -
  • 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 options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<FaucetTransaction, any>>

    Summary

    Request faucet funds for onchain address.

    Throws

    Memberof

    AddressesApi

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/classes/client_api.ServerSignersApi.html b/docs/classes/client_api.ServerSignersApi.html new file mode 100644 index 00000000..f02a6dc4 --- /dev/null +++ b/docs/classes/client_api.ServerSignersApi.html @@ -0,0 +1,43 @@ +ServerSignersApi | @coinbase/coinbase-sdk

ServerSignersApi - object-oriented interface

+

Export

ServerSignersApi

+

Hierarchy (view full)

Implements

Constructors

Properties

axios: AxiosInstance = globalAxios
basePath: string = BASE_PATH
configuration: undefined | Configuration

Methods

  • 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

    +
  • 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

    +

    Throws

    Memberof

    ServerSignersApi

    +
\ No newline at end of file diff --git a/docs/classes/client_api.TradesApi.html b/docs/classes/client_api.TradesApi.html new file mode 100644 index 00000000..70a3c556 --- /dev/null +++ b/docs/classes/client_api.TradesApi.html @@ -0,0 +1,39 @@ +TradesApi | @coinbase/coinbase-sdk

TradesApi - object-oriented interface

+

Export

TradesApi

+

Hierarchy (view full)

Implements

Constructors

Properties

axios: AxiosInstance = globalAxios
basePath: string = BASE_PATH
configuration: undefined | Configuration

Methods

  • 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

    +
  • 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

    +
  • 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

    +
  • 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&#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<TradeList, any>>

    Summary

    List trades for an address.

    +

    Throws

    Memberof

    TradesApi

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

TransfersApi - object-oriented interface

Export

TransfersApi

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Implements

Constructors

Properties

axios: AxiosInstance = globalAxios
basePath: string = BASE_PATH
configuration: undefined | Configuration

Methods

  • Broadcast a transfer

    +

Constructors

Properties

axios: AxiosInstance = globalAxios
basePath: string = BASE_PATH
configuration: undefined | Configuration

Methods

  • 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

    -
  • 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

    -
  • 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

    -
  • 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

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

UsersApi - object-oriented interface

Export

UsersApi

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Implements

Constructors

Properties

Methods

Constructors

Properties

axios: AxiosInstance = globalAxios
basePath: string = BASE_PATH
configuration: undefined | Configuration

Methods

  • Get current user

    +

Constructors

Properties

axios: AxiosInstance = globalAxios
basePath: string = BASE_PATH
configuration: undefined | Configuration

Methods

  • Get current user

    Parameters

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<User, any>>

    Summary

    Get current user

    Throws

    Memberof

    UsersApi

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

WalletsApi - object-oriented interface

Export

WalletsApi

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Implements

Constructors

Properties

axios: AxiosInstance = globalAxios
basePath: string = BASE_PATH
configuration: undefined | Configuration

Methods

  • Create a new wallet scoped to the user.

    +

Constructors

Properties

axios: AxiosInstance = globalAxios
basePath: string = BASE_PATH
configuration: undefined | Configuration

Methods

  • 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

    -
  • 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

    -
  • 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

    -
  • 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

    -
  • 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

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

Export

BaseAPI

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

Constructors

Properties

axios: AxiosInstance = globalAxios
basePath: string = BASE_PATH
configuration: undefined | Configuration
\ No newline at end of file +

Constructors

Properties

axios: AxiosInstance = globalAxios
basePath: string = BASE_PATH
configuration: undefined | Configuration
\ No newline at end of file diff --git a/docs/classes/client_base.RequiredError.html b/docs/classes/client_base.RequiredError.html index 81c30453..98b2dd28 100644 --- a/docs/classes/client_base.RequiredError.html +++ b/docs/classes/client_base.RequiredError.html @@ -1,5 +1,5 @@ RequiredError | @coinbase/coinbase-sdk

Export

RequiredError

-

Hierarchy

  • Error
    • RequiredError

Constructors

Hierarchy

  • Error
    • RequiredError

Constructors

Properties

Methods

Constructors

Properties

field: string
message: string
name: string
stack?: string
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

Properties

field: string
message: string
name: string
stack?: string
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

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

Constructors

constructor +Configuration | @coinbase/coinbase-sdk

Constructors

Properties

Methods

Constructors

Properties

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

parameter for oauth2 security

+

Constructors

Properties

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

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

parameter for apiKey security

+
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

-
baseOptions?: any

base options for axios calls

+
baseOptions?: any

base options for axios calls

Memberof

Configuration

-
basePath?: string

override base path

+
basePath?: string

override base path

Memberof

Configuration

-
formDataCtor?: (new () => any)

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

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

password?: string

parameter for basic security

+

Type declaration

    • new (): any
    • Returns any

password?: string

parameter for basic security

Memberof

Configuration

-
serverIndex?: number

override server index

+
serverIndex?: number

override server index

Memberof

Configuration

-
username?: string

parameter for basic security

+
username?: string

parameter for basic security

Memberof

Configuration

-

Methods

Methods

  • 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.

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

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

-

Constructors

Constructors

Properties

Methods

createTransfer @@ -15,7 +15,7 @@

Parameters

  • model: Address

    The address model data.

  • Optional key: Wallet

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

Returns Address

Throws

If the model or key is empty.

-

Properties

key?: Wallet
model: Address

Methods

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

    +

Properties

key?: Wallet
model: Address

Methods

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

    Parameters

    • amount: Amount

      The amount of the Asset to send.

    • assetId: string

      The ID of the Asset to send. For Ether, Coinbase.assets.Eth, Coinbase.assets.Gwei, and Coinbase.assets.Wei supported.

    • destination: Destination

      The destination of the transfer. If a Wallet, sends to the Wallet's default address. If a String, interprets it as the address ID.

      @@ -25,26 +25,26 @@

      Throws

      if the API request to create a Transfer fails.

      Throws

      if the API request to broadcast a Transfer fails.

      Throws

      if the Transfer times out.

      -
  • Returns the balance of the provided asset.

    Parameters

    • assetId: string

      The asset ID.

    Returns Promise<Decimal>

    The balance of the asset.

    -
  • Returns a string representation of the address.

    Returns string

    A string representing the address.

    -
\ No newline at end of file +
\ 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 4e7cc913..28f5b10d 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

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

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

Constructors

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns APIError

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Returns a String representation of the APIError.

    Returns string

    a String representation of the APIError

    -
  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

  • 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>

\ No newline at end of file +
\ 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 c06102d6..14f4e64c 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

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

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

Constructors

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns AlreadyExistsError

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

  • 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>

\ No newline at end of file +
\ 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 32b69cff..14ecb24e 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

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

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

Constructors

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns FaucetLimitReachedError

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

  • 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>

\ No newline at end of file +
\ 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 be7eb669..03556404 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

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

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

Constructors

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns InvalidAddressError

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

  • 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>

\ No newline at end of file +
\ 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 03f04a4a..30b0379a 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

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

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

Constructors

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns InvalidAddressIDError

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

  • 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>

\ No newline at end of file +
\ 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 f2905fa8..62a585d9 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

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

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

Constructors

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns InvalidAmountError

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

  • 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>

\ No newline at end of file +
\ 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 4a3e50ab..7a2d0a7a 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

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

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

Constructors

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns InvalidAssetIDError

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

  • 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>

\ No newline at end of file +
\ 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 a4f0c81e..b9a41fba 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

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

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

Constructors

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns InvalidDestinationError

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

  • 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>

\ No newline at end of file +
\ 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 07d1a36e..6697d1ee 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

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

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

Constructors

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns InvalidLimitError

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

  • 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>

\ No newline at end of file +
\ 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 816c4099..16d5c0da 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

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

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

Constructors

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns InvalidNetworkIDError

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

  • 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>

\ No newline at end of file +
\ 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 8816f744..3bc2c932 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

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

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

Constructors

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns InvalidPageError

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

  • 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>

\ No newline at end of file +
\ 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 a511160f..4eccb4e8 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

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

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

Constructors

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns InvalidSignedPayloadError

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

  • 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>

\ No newline at end of file +
\ 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 91d6942c..26460460 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

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

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

Constructors

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns InvalidTransferIDError

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

  • 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>

\ No newline at end of file +
\ 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 1279f664..831d911e 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

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

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

Constructors

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns InvalidTransferStatusError

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

  • 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>

\ No newline at end of file +
\ 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 36a846e0..998e6ede 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

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

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

Constructors

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns InvalidWalletError

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

  • 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>

\ No newline at end of file +
\ 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 3b1bd040..92d2f3da 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

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

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

Constructors

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns InvalidWalletIDError

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

  • 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>

\ No newline at end of file +
\ 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 fc8934c4..282e4ca8 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

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

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

Constructors

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns MalformedRequestError

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

  • 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>

\ No newline at end of file +
\ 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 a979720f..2f4a9b61 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

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

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

Constructors

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns NotFoundError

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

  • 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>

\ No newline at end of file +
\ 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 c7795854..1cc99378 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

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

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

Constructors

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns ResourceExhaustedError

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

  • 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>

\ No newline at end of file +
\ 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 3856dc82..d08a4a15 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

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

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

Constructors

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns UnauthorizedError

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

  • 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>

\ No newline at end of file +
\ 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 2c3cb5a4..88cc8fb0 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

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

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

Constructors

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns UnimplementedError

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

  • 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>

\ No newline at end of file +
\ 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 661f2867..242b2f03 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

A wrapper for API errors to provide more context.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

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

Constructors

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns UnsupportedAssetError

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

  • 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>

\ No newline at end of file +
\ No newline at end of file diff --git a/docs/classes/coinbase_asset.Asset.html b/docs/classes/coinbase_asset.Asset.html index 4bdaaa98..6289a57a 100644 --- a/docs/classes/coinbase_asset.Asset.html +++ b/docs/classes/coinbase_asset.Asset.html @@ -1,9 +1,9 @@ Asset | @coinbase/coinbase-sdk

A representation of an Asset.

-

Constructors

Constructors

Methods

Constructors

Methods

  • Converts an amount from the atomic value of the primary denomination of the provided Asset ID to whole units of the specified asset ID.

    Parameters

    • atomicAmount: Decimal

      The amount in atomic units.

    • assetId: string

      The assset ID.

    Returns Decimal

    The amount in whole units of the asset with the specified ID.

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

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

-

Constructors

Constructors

Properties

Methods

authenticateRequest @@ -9,20 +9,20 @@

Constructors

Properties

apiKey: string
privateKey: string

Methods

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

    +

Returns CoinbaseAuthenticator

Properties

apiKey: string
privateKey: string

Methods

  • 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.

    -
  • 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.

    -
  • 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.

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/classes/coinbase_balance.Balance.html b/docs/classes/coinbase_balance.Balance.html index 7165f3b7..8eac8122 100644 --- a/docs/classes/coinbase_balance.Balance.html +++ b/docs/classes/coinbase_balance.Balance.html @@ -1,13 +1,13 @@ Balance | @coinbase/coinbase-sdk

A representation of a balance.

-

Properties

Properties

amount: Decimal
assetId: string

Methods

  • Converts a BalanceModel into a Balance object.

    +

Properties

amount: Decimal
assetId: string

Methods

  • 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.

    -
\ No newline at end of file +
\ 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 4f4b4d30..6173c1a6 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

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

-

Hierarchy

  • Map<string, Decimal>
    • BalanceMap

Constructors

Hierarchy

  • Map<string, Decimal>
    • BalanceMap

Constructors

Properties

[toStringTag] size [species] @@ -20,7 +20,7 @@
[species]: MapConstructor

Methods

  • Returns an iterable of entries in the map.

    Returns IterableIterator<[string, Decimal]>

  • Returns void

  • 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

  • Returns void

  • 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 an iterable of key, value pairs for every entry in the map.

    Returns IterableIterator<[string, Decimal]>

  • 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

  • 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.

    @@ -30,8 +30,8 @@

    Returns IterableIterator<string>

  • 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

  • Returns a string representation of the balance map.

    Returns string

    The string representation of the balance map.

    -
  • Returns an iterable of values in the map

    Returns IterableIterator<Decimal>

\ No newline at end of file +
\ No newline at end of file diff --git a/docs/classes/coinbase_coinbase.Coinbase.html b/docs/classes/coinbase_coinbase.Coinbase.html index cf016a14..bdf2bcdd 100644 --- a/docs/classes/coinbase_coinbase.Coinbase.html +++ b/docs/classes/coinbase_coinbase.Coinbase.html @@ -1,30 +1,27 @@ Coinbase | @coinbase/coinbase-sdk

The Coinbase SDK.

-

Constructors

Constructors

  • Initializes the Coinbase SDK.

    -

    Parameters

    • apiKeyName: string

      The API key name.

      -
    • privateKey: string

      The private key associated with the API key.

      -
    • debugging: boolean = false

      If true, logs API requests and responses to the console.

      -
    • basePath: string = BASE_PATH

      The base path for the API.

      +

Constructors

Properties

apiClients: ApiClients = {}
apiKeyPrivateKey: string

The CDP API key Private Key.

-

Constant

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

The list of supported assets.

-

Type declaration

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

Constant

networkList: {
    BaseSepolia: string;
} = ...

The list of supported networks.

-

Type declaration

  • BaseSepolia: string

Constant

Methods

Properties

apiClients: ApiClients = {}
apiKeyPrivateKey: string

The CDP API key Private Key.

+

Constant

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

The list of supported assets.

+

Type declaration

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

Constant

networkList: {
    BaseSepolia: string;
} = ...

The list of supported networks.

+

Type declaration

  • BaseSepolia: string

Constant

useServerSigner: boolean

Whether to use server signer or not.

+

Constant

Methods

  • Returns User object for the default user.

    Returns Promise<User>

    The default user.

    Throws

    If the request fails.

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

    -

    Parameters

    • filePath: string = "coinbase_cloud_api_key.json"

      The path to the JSON file containing the API key and private key.

      -
    • debugging: boolean = false

      If true, logs API requests and responses to the console.

      -
    • basePath: string = BASE_PATH

      The base path for the API.

      +
  • 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.

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

ArgumentError is thrown when an argument is invalid.

-

Hierarchy

  • Error
    • ArgumentError

Constructors

Hierarchy

  • Error
    • ArgumentError

Constructors

Properties

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

Methods

Constructors

Properties

message: string
name: string
stack?: string
DEFAULT_MESSAGE: string = "Argument Error"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns ArgumentError

Properties

message: string
name: string
stack?: string
DEFAULT_MESSAGE: string = "Argument Error"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

\ No newline at end of file diff --git a/docs/classes/coinbase_errors.InternalError.html b/docs/classes/coinbase_errors.InternalError.html index cb55a074..7f972ef2 100644 --- a/docs/classes/coinbase_errors.InternalError.html +++ b/docs/classes/coinbase_errors.InternalError.html @@ -1,5 +1,5 @@ InternalError | @coinbase/coinbase-sdk

InternalError is thrown when there is an internal error in the SDK.

-

Hierarchy

  • Error
    • InternalError

Constructors

Hierarchy

  • Error
    • InternalError

Constructors

Properties

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

Methods

Constructors

Properties

message: string
name: string
stack?: string
DEFAULT_MESSAGE: string = "Internal Error"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns InternalError

Properties

message: string
name: string
stack?: string
DEFAULT_MESSAGE: string = "Internal Error"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

\ No newline at end of file diff --git a/docs/classes/coinbase_errors.InvalidAPIKeyFormat.html b/docs/classes/coinbase_errors.InvalidAPIKeyFormat.html index fd5be450..543cbde2 100644 --- a/docs/classes/coinbase_errors.InvalidAPIKeyFormat.html +++ b/docs/classes/coinbase_errors.InvalidAPIKeyFormat.html @@ -1,5 +1,5 @@ InvalidAPIKeyFormat | @coinbase/coinbase-sdk

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

-

Hierarchy

  • Error
    • InvalidAPIKeyFormat

Constructors

Hierarchy

  • Error
    • InvalidAPIKeyFormat

Constructors

Properties

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

Methods

Constructors

Properties

message: string
name: string
stack?: string
DEFAULT_MESSAGE: string = "Invalid API key format"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns InvalidAPIKeyFormat

Properties

message: string
name: string
stack?: string
DEFAULT_MESSAGE: string = "Invalid API key format"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

\ No newline at end of file diff --git a/docs/classes/coinbase_errors.InvalidConfiguration.html b/docs/classes/coinbase_errors.InvalidConfiguration.html index 93716b8b..b889a6ac 100644 --- a/docs/classes/coinbase_errors.InvalidConfiguration.html +++ b/docs/classes/coinbase_errors.InvalidConfiguration.html @@ -1,5 +1,5 @@ InvalidConfiguration | @coinbase/coinbase-sdk

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

-

Hierarchy

  • Error
    • InvalidConfiguration

Constructors

Hierarchy

  • Error
    • InvalidConfiguration

Constructors

Properties

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

Methods

Constructors

Properties

message: string
name: string
stack?: string
DEFAULT_MESSAGE: string = "Invalid configuration"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns InvalidConfiguration

Properties

message: string
name: string
stack?: string
DEFAULT_MESSAGE: string = "Invalid configuration"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

\ No newline at end of file diff --git a/docs/classes/coinbase_errors.InvalidUnsignedPayload.html b/docs/classes/coinbase_errors.InvalidUnsignedPayload.html index 3fc2798b..6833932e 100644 --- a/docs/classes/coinbase_errors.InvalidUnsignedPayload.html +++ b/docs/classes/coinbase_errors.InvalidUnsignedPayload.html @@ -1,5 +1,5 @@ InvalidUnsignedPayload | @coinbase/coinbase-sdk

InvalidUnsignedPayload error is thrown when the unsigned payload is invalid.

-

Hierarchy

  • Error
    • InvalidUnsignedPayload

Constructors

Hierarchy

  • Error
    • InvalidUnsignedPayload

Constructors

Properties

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

Methods

Constructors

Properties

message: string
name: string
stack?: string
DEFAULT_MESSAGE: string = "Invalid unsigned payload"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Returns InvalidUnsignedPayload

Properties

message: string
name: string
stack?: string
DEFAULT_MESSAGE: string = "Invalid unsigned payload"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

\ 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 15661878..c1cac2b8 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

Represents a transaction from a faucet.

-

Constructors

Constructors

Properties

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

Methods

Properties

Methods

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

    Returns string

    The link to the transaction on the blockchain explorer

    -
  • Returns a string representation of the FaucetTransaction.

    Returns string

    A string representation of the FaucetTransaction.

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/classes/coinbase_transfer.Transfer.html b/docs/classes/coinbase_transfer.Transfer.html index 514bbddd..9795fdc9 100644 --- a/docs/classes/coinbase_transfer.Transfer.html +++ b/docs/classes/coinbase_transfer.Transfer.html @@ -1,7 +1,7 @@ Transfer | @coinbase/coinbase-sdk

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

Properties

model: Transfer
transaction?: Transaction

Methods

  • Returns the Amount of the Transfer.

    +

Properties

model: Transfer
transaction?: Transaction

Methods

  • Returns the Destination Address ID of the Transfer.

    Returns string

    The Destination Address ID.

    -
  • Returns the From Address ID of the Transfer.

    Returns string

    The From Address ID.

    -
  • Returns the Signed Payload of the Transfer.

    Returns undefined | string

    The Signed Payload as a Hex string, or undefined if not yet available.

    -
  • Returns the Transaction of the Transfer.

    Returns Transaction

    The ethers.js Transaction object.

    Throws

    (InvalidUnsignedPayload) If the Unsigned Payload is invalid.

    -
  • Returns the Transaction Hash of the Transfer.

    Returns undefined | string

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

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

    Returns string

    The link to the Transaction on the blockchain explorer.

    -
  • Returns the Unsigned Payload of the Transfer.

    Returns string

    The Unsigned Payload as a Hex string.

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

    +

    Returns Promise<void>

    Throws

    if the API request to get a Transfer fails.

    +
  • Sets the Signed Transaction of the Transfer.

    Parameters

    • transaction: Transaction

      The Signed Transaction.

      -

    Returns void

  • Returns a string representation of the Transfer.

    +

Returns void

  • Returns a string representation of the Transfer.

    Returns Promise<string>

    The string representation of the Transfer.

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/classes/coinbase_user.User.html b/docs/classes/coinbase_user.User.html index 670f942e..a1b49df9 100644 --- a/docs/classes/coinbase_user.User.html +++ b/docs/classes/coinbase_user.User.html @@ -1,7 +1,7 @@ User | @coinbase/coinbase-sdk

A representation of a User. Users have Wallets, which can hold balances of Assets. Access the default User through Coinbase.defaultUser().

-

Constructors

Constructors

Properties

Methods

createWallet getId @@ -11,7 +11,7 @@ toString

Constructors

Properties

model: User

Methods

  • Creates a new Wallet belonging to the User.

    +

Returns User

Properties

model: User

Methods

  • Creates a new Wallet belonging to the User.

    Returns Promise<Wallet>

    the new Wallet

    Throws

    • If the request fails.
    • @@ -22,18 +22,18 @@

      Throws

        Throws

        • If address derivation or caching fails.
        -
  • Returns the Wallet with the given ID.

    Parameters

    • wallet_id: string

      the ID of the Wallet

    Returns Promise<Wallet>

    the Wallet with the given ID

    -
  • Lists the Wallets belonging to the User.

    +
  • Lists the Wallets belonging to the User.

    Parameters

    • pageSize: number = 10

      The number of Wallets to return per page. Defaults to 10

    • Optional nextPageToken: string

      The token for the next page of Wallets

    Returns Promise<{
        nextPageToken: string;
        wallets: Wallet[];
    }>

    An object containing the Wallets and the token for the next page

    -
  • Returns a string representation of the User.

    Returns string

    The string representation of the User.

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/classes/coinbase_wallet.Wallet.html b/docs/classes/coinbase_wallet.Wallet.html index 1a18a95b..1da7a4af 100644 --- a/docs/classes/coinbase_wallet.Wallet.html +++ b/docs/classes/coinbase_wallet.Wallet.html @@ -1,7 +1,7 @@ Wallet | @coinbase/coinbase-sdk

A representation of a Wallet. Wallets come with a single default Address, but can expand to have a set of Addresses, each of which can hold a balance of one or more Assets. Wallets can create new Addresses, list their addresses, list their balances, and transfer Assets to other Addresses. Wallets should be created through User.createWallet or User.importWallet.

-

Properties

Properties

addressIndex: number = 0
addressModels: Address[] = []
addressPathPrefix: "m/44'/60'/0'/0" = "m/44'/60'/0'/0"
addresses: Address[] = []
master?: HDKey
model: Wallet
seed?: string
MAX_ADDRESSES: number = 20

Methods

  • Builds a Hash of the registered Addresses.

    +

Properties

addressIndex: number = 0
addressModels: Address[] = []
addressPathPrefix: "m/44'/60'/0'/0" = "m/44'/60'/0'/0"
addresses: Address[] = []
master?: HDKey
model: Wallet
seed?: string
MAX_ADDRESSES: number = 20

Methods

  • Builds a Hash of the registered Addresses.

    Parameters

    • addressModels: Address[]

      The models of the addresses already registered with the Wallet.

    Returns {
        [key: string]: boolean;
    }

    The Hash of registered Addresses

    -
    • [key: string]: boolean
  • Caches an Address on the client-side and increments the address index.

    +
    • [key: string]: boolean
  • Caches an Address on the client-side and increments the address index.

    Parameters

    • address: Address

      The AddressModel to cache.

    • Optional key: Wallet

      The ethers.js Wallet object the address uses for signing data.

    Returns void

    Throws

    If the address is not provided.

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

    +
  • 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.

    -
  • Creates an attestation for the Address currently being created.

    +
  • Creates an attestation for the Address currently being created.

    Parameters

    • key: HDKey

      The key of the Wallet.

    Returns string

    The attestation.

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

  • 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

    • amount: Amount

      The amount of the Asset to send.

    • assetId: string

      The ID of the Asset to send.

      @@ -66,7 +68,7 @@

      Throws

      if the API request to create a Transfer fails.

      Throws

      if the API request to broadcast a Transfer fails.

      Throws

      if the Transfer times out.

      -
  • Derives an already registered Address in the Wallet.

    +
  • Derives an already registered Address in the Wallet.

    Parameters

    • addressMap: {
          [key: string]: boolean;
      }

      The map of registered Address IDs

      • [key: string]: boolean
    • addressModel: Address

      The Address model

    Returns void

    Throws

      @@ -75,46 +77,52 @@

      Throws

      if the Transfer times out.

      Throws

      • If the request fails.
      -
  • Derives the registered Addresses in the Wallet.

    Parameters

    • addresses: Address[]

      The models of the addresses already registered with the

      -

    Returns void

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

    +

Returns void

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

    Returns HDKey

    The derived key.

    Throws

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

    Returns Promise<FaucetTransaction>

    The successful faucet transaction

    Throws

    If the default address is not found.

    Throws

    If the request fails.

    -
  • Returns the Address with the given ID.

    Parameters

    • addressId: string

      The ID of the Address to retrieve.

    Returns undefined | Address

    The Address.

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

    +
  • 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.

    -
  • Gets the key for encrypting seed data.

    Returns Buffer

    The encryption key.

    -
  • 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

    -
  • 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.

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

    Parameters

    • filePath: string

      The path of the file to load the seed from

    Returns string

    A string indicating the success of the operation

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

    -

    Returns Promise<void>

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

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

    +

    Returns Promise<void>

    Throws

    if the API request to get a Wallet fails.

    +
  • 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

      @@ -122,13 +130,21 @@

      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

    -
  • Returns the Wallet model.

    Parameters

    • seed: string

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

      -

    Returns void

  • Returns a String representation of the Wallet.

    +

Returns void

  • Returns a String representation of the Wallet.

    Returns string

    a String representation of the Wallet

    -
  • 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.

    +
  • Returns a newly created Wallet object. Do not use this method directly. Instead, use User.createWallet.

    -

    Returns Promise<Wallet>

    A promise that resolves with the new Wallet object.

    +

    Parameters

    • 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<Wallet>

    A promise that resolves with the new Wallet object.

    Constructs

    Wallet

    Throws

    If the model or client is not provided.

    Throws

      @@ -137,10 +153,10 @@

      Throws

        Throws

        • If the request fails.
        -
  • Returns the seed and master key.

    +
  • Returns the seed and master key.

    Parameters

    • seed: undefined | string

      The seed to use for the Wallet. The function will generate one if it is not provided.

    Returns {
        master: undefined | HDKey;
        seed: undefined | string;
    }

    The master key

    -
    • master: undefined | HDKey
    • seed: undefined | string
  • Returns a new Wallet object. Do not use this method directly. Instead, use User.createWallet or User.importWallet.

    +
    • master: undefined | HDKey
    • seed: undefined | string
  • Returns a new Wallet object. Do not use this method directly. Instead, use User.createWallet or User.importWallet.

    Parameters

    • model: Wallet

      The underlying Wallet model object

    • Optional seed: string

      The seed to use for the Wallet. Expects a 32-byte hexadecimal with no 0x prefix. If null or undefined, a new seed will be generated. If the empty string, no seed is generated, and the Wallet will be instantiated without a seed and its corresponding private keys.

      @@ -154,7 +170,7 @@

      Throws

        Throws

        • If the request fails.
        -
  • Validates the seed and address models passed to the constructor.

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

    Parameters

    • seed: undefined | string

      The seed to use for the Wallet

    • addressModels: Address[]

      The models of the addresses already registered with the Wallet

      -

    Returns void

\ No newline at end of file +

Returns void

\ No newline at end of file diff --git a/docs/enums/client_api.TransactionType.html b/docs/enums/client_api.TransactionType.html new file mode 100644 index 00000000..235d704f --- /dev/null +++ b/docs/enums/client_api.TransactionType.html @@ -0,0 +1,2 @@ +TransactionType | @coinbase/coinbase-sdk

Export

Enumeration Members

Enumeration Members

Transfer: "transfer"
\ No newline at end of file diff --git a/docs/enums/coinbase_types.ServerSignerStatus.html b/docs/enums/coinbase_types.ServerSignerStatus.html new file mode 100644 index 00000000..a12c6d60 --- /dev/null +++ b/docs/enums/coinbase_types.ServerSignerStatus.html @@ -0,0 +1,4 @@ +ServerSignerStatus | @coinbase/coinbase-sdk

ServerSigner status type definition.

+

Enumeration Members

Enumeration Members

ACTIVE: "active_seed"
PENDING: "pending_seed_creation"
\ No newline at end of file diff --git a/docs/enums/coinbase_types.TransferStatus.html b/docs/enums/coinbase_types.TransferStatus.html index fe1efe5e..ba1490ce 100644 --- a/docs/enums/coinbase_types.TransferStatus.html +++ b/docs/enums/coinbase_types.TransferStatus.html @@ -1,6 +1,6 @@ TransferStatus | @coinbase/coinbase-sdk

Transfer status type definition.

-

Enumeration Members

Enumeration Members

Enumeration Members

BROADCAST: "BROADCAST"
COMPLETE: "COMPLETE"
FAILED: "FAILED"
PENDING: "PENDING"
\ No newline at end of file +

Enumeration Members

BROADCAST: "broadcast"
COMPLETE: "complete"
FAILED: "failed"
PENDING: "pending"
\ No newline at end of file diff --git a/docs/functions/client_api.AddressesApiAxiosParamCreator.html b/docs/functions/client_api.AddressesApiAxiosParamCreator.html index 7afe82be..d4585a6d 100644 --- a/docs/functions/client_api.AddressesApiAxiosParamCreator.html +++ b/docs/functions/client_api.AddressesApiAxiosParamCreator.html @@ -31,4 +31,4 @@

Throws

    • (walletId, addressId, options?): Promise<RequestArgs>
    • 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<RequestArgs>

Export

\ No newline at end of file +

Returns Promise<RequestArgs>

Export

\ No newline at end of file diff --git a/docs/functions/client_api.AddressesApiFactory.html b/docs/functions/client_api.AddressesApiFactory.html index b9d792f8..19ca996c 100644 --- a/docs/functions/client_api.AddressesApiFactory.html +++ b/docs/functions/client_api.AddressesApiFactory.html @@ -3,32 +3,32 @@

Parameters

  • walletId: string

    The ID of the wallet to create the address in.

  • Optional createAddressRequest: CreateAddressRequest
  • Optional options: any

    Override http request option.

Returns AxiosPromise<Address>

Summary

Create a new address

-

Throws

  • getAddress:function
  • getAddress:function
    • 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: any

        Override http request option.

      Returns AxiosPromise<Address>

      Summary

      Get address by onchain address

      -

      Throws

  • getAddressBalance:function
  • getAddressBalance:function
    • 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: any

        Override http request option.

      Returns AxiosPromise<Balance>

      Summary

      Get address balance for asset

      -

      Throws

  • listAddressBalances:function
  • listAddressBalances:function
    • 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: any

        Override http request option.

      Returns AxiosPromise<AddressBalanceList>

      Summary

      Get all balances for address

      -

      Throws

  • listAddresses:function
  • listAddresses:function
    • 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: any

        Override http request option.

      Returns AxiosPromise<AddressList>

      Summary

      List addresses in a wallet.

      -

      Throws

  • requestFaucetFunds:function
  • requestFaucetFunds:function
    • 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 options: any

        Override http request option.

      Returns AxiosPromise<FaucetTransaction>

      Summary

      Request faucet funds for onchain address.

      -

      Throws

  • Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.AddressesApiFp.html b/docs/functions/client_api.AddressesApiFp.html index b2937677..7f435940 100644 --- a/docs/functions/client_api.AddressesApiFp.html +++ b/docs/functions/client_api.AddressesApiFp.html @@ -3,32 +3,32 @@

    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<((axios?, basePath?) => AxiosPromise<Address>)>

    Summary

    Create a new address

    -

    Throws

  • getAddress:function
    • Get address

      +

      Throws

  • getAddress:function
    • 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<((axios?, basePath?) => AxiosPromise<Address>)>

      Summary

      Get address by onchain address

      -

      Throws

  • getAddressBalance:function
    • Get address balance

      +

      Throws

  • getAddressBalance:function
    • 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<((axios?, basePath?) => AxiosPromise<Balance>)>

      Summary

      Get address balance for asset

      -

      Throws

  • listAddressBalances:function
  • listAddressBalances:function
    • 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<((axios?, basePath?) => AxiosPromise<AddressBalanceList>)>

      Summary

      Get all balances for address

      -

      Throws

  • listAddresses:function
    • List addresses in the wallet.

      +

      Throws

  • listAddresses:function
    • 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<((axios?, basePath?) => AxiosPromise<AddressList>)>

      Summary

      List addresses in a wallet.

      -

      Throws

  • requestFaucetFunds:function
    • Request faucet funds to be sent to onchain address.

      +

      Throws

  • requestFaucetFunds:function
    • 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 options: RawAxiosRequestConfig

        Override http request option.

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

      Summary

      Request faucet funds for onchain address.

      -

      Throws

  • Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.ServerSignersApiAxiosParamCreator.html b/docs/functions/client_api.ServerSignersApiAxiosParamCreator.html new file mode 100644 index 00000000..78642c5f --- /dev/null +++ b/docs/functions/client_api.ServerSignersApiAxiosParamCreator.html @@ -0,0 +1,26 @@ +ServerSignersApiAxiosParamCreator | @coinbase/coinbase-sdk
    • ServerSignersApi - axios parameter creator

      +

      Parameters

      Returns {
          createServerSigner: ((createServerSignerRequest?, options?) => Promise<RequestArgs>);
          getServerSigner: ((serverSignerId, options?) => Promise<RequestArgs>);
          listServerSignerEvents: ((serverSignerId, limit?, page?, options?) => Promise<RequestArgs>);
          listServerSigners: ((options?) => Promise<RequestArgs>);
          submitServerSignerSeedEventResult: ((serverSignerId, seedCreationEventResult?, options?) => Promise<RequestArgs>);
          submitServerSignerSignatureEventResult: ((serverSignerId, signatureCreationEventResult?, options?) => Promise<RequestArgs>);
      }

      • createServerSigner: ((createServerSignerRequest?, options?) => Promise<RequestArgs>)

        Create a new Server-Signer

        +

        Summary

        Create a new Server-Signer

        +

        Throws

      • getServerSigner: ((serverSignerId, options?) => Promise<RequestArgs>)

        Get a server signer by ID

        +

        Summary

        Get a server signer by ID

        +

        Throws

          • (serverSignerId, options?): Promise<RequestArgs>
          • Parameters

            • serverSignerId: string

              The ID of the server signer to fetch

              +
            • Optional options: RawAxiosRequestConfig = {}

              Override http request option.

              +

            Returns Promise<RequestArgs>

      • listServerSignerEvents: ((serverSignerId, limit?, page?, options?) => Promise<RequestArgs>)

        List events for a server signer

        +

        Summary

        List events for a server signer

        +

        Throws

          • (serverSignerId, limit?, page?, options?): Promise<RequestArgs>
          • 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<RequestArgs>

      • listServerSigners: ((options?) => Promise<RequestArgs>)

        List server signers for the current project

        +

        Summary

        List server signers for the current project

        +

        Throws

          • (options?): Promise<RequestArgs>
          • Parameters

            • Optional options: RawAxiosRequestConfig = {}

              Override http request option.

              +

            Returns Promise<RequestArgs>

      • submitServerSignerSeedEventResult: ((serverSignerId, seedCreationEventResult?, options?) => Promise<RequestArgs>)

        Submit the result of a server signer event

        +

        Summary

        Submit the result of a server signer event

        +

        Throws

          • (serverSignerId, seedCreationEventResult?, options?): Promise<RequestArgs>
          • 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 Promise<RequestArgs>

      • submitServerSignerSignatureEventResult: ((serverSignerId, signatureCreationEventResult?, options?) => Promise<RequestArgs>)

        Submit the result of a server signer event

        +

        Summary

        Submit the result of a server signer event

        +

        Throws

          • (serverSignerId, signatureCreationEventResult?, options?): Promise<RequestArgs>
          • 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 Promise<RequestArgs>

      Export

    \ No newline at end of file diff --git a/docs/functions/client_api.ServerSignersApiFactory.html b/docs/functions/client_api.ServerSignersApiFactory.html new file mode 100644 index 00000000..e8c19837 --- /dev/null +++ b/docs/functions/client_api.ServerSignersApiFactory.html @@ -0,0 +1,26 @@ +ServerSignersApiFactory | @coinbase/coinbase-sdk
    • ServerSignersApi - factory interface

      +

      Parameters

      • Optional configuration: Configuration
      • Optional basePath: string
      • Optional axios: AxiosInstance

      Returns {
          createServerSigner(createServerSignerRequest?, options?): AxiosPromise<ServerSigner>;
          getServerSigner(serverSignerId, options?): AxiosPromise<ServerSigner>;
          listServerSignerEvents(serverSignerId, limit?, page?, options?): AxiosPromise<ServerSignerEventList>;
          listServerSigners(options?): AxiosPromise<ServerSigner>;
          submitServerSignerSeedEventResult(serverSignerId, seedCreationEventResult?, options?): AxiosPromise<SeedCreationEventResult>;
          submitServerSignerSignatureEventResult(serverSignerId, signatureCreationEventResult?, options?): AxiosPromise<SignatureCreationEventResult>;
      }

      • createServerSigner:function
      • getServerSigner:function
        • Get a server signer by ID

          +

          Parameters

          • serverSignerId: string

            The ID of the server signer to fetch

            +
          • Optional options: any

            Override http request option.

            +

          Returns AxiosPromise<ServerSigner>

          Summary

          Get a server signer by ID

          +

          Throws

      • listServerSignerEvents:function
        • 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: any

            Override http request option.

            +

          Returns AxiosPromise<ServerSignerEventList>

          Summary

          List events for a server signer

          +

          Throws

      • listServerSigners:function
        • List server signers for the current project

          +

          Parameters

          • Optional options: any

            Override http request option.

            +

          Returns AxiosPromise<ServerSigner>

          Summary

          List server signers for the current project

          +

          Throws

      • submitServerSignerSeedEventResult:function
        • 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: any

            Override http request option.

            +

          Returns AxiosPromise<SeedCreationEventResult>

          Summary

          Submit the result of a server signer event

          +

          Throws

      • submitServerSignerSignatureEventResult:function
        • 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: any

            Override http request option.

            +

          Returns AxiosPromise<SignatureCreationEventResult>

          Summary

          Submit the result of a server signer event

          +

          Throws

      Export

    \ No newline at end of file diff --git a/docs/functions/client_api.ServerSignersApiFp.html b/docs/functions/client_api.ServerSignersApiFp.html new file mode 100644 index 00000000..6d00f77d --- /dev/null +++ b/docs/functions/client_api.ServerSignersApiFp.html @@ -0,0 +1,26 @@ +ServerSignersApiFp | @coinbase/coinbase-sdk
    • ServerSignersApi - functional programming interface

      +

      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(options?): Promise<((axios?, basePath?) => AxiosPromise<ServerSigner>)>;
          submitServerSignerSeedEventResult(serverSignerId, seedCreationEventResult?, options?): Promise<((axios?, basePath?) => AxiosPromise<SeedCreationEventResult>)>;
          submitServerSignerSignatureEventResult(serverSignerId, signatureCreationEventResult?, options?): Promise<((axios?, basePath?) => AxiosPromise<SignatureCreationEventResult>)>;
      }

      • createServerSigner:function
        • Create a new Server-Signer

          +

          Parameters

          • Optional createServerSignerRequest: CreateServerSignerRequest
          • Optional options: RawAxiosRequestConfig

            Override http request option.

            +

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

          Summary

          Create a new Server-Signer

          +

          Throws

      • getServerSigner:function
        • 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<((axios?, basePath?) => AxiosPromise<ServerSigner>)>

          Summary

          Get a server signer by ID

          +

          Throws

      • listServerSignerEvents:function
        • 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<((axios?, basePath?) => AxiosPromise<ServerSignerEventList>)>

          Summary

          List events for a server signer

          +

          Throws

      • listServerSigners:function
        • List server signers for the current project

          +

          Parameters

          • Optional options: RawAxiosRequestConfig

            Override http request option.

            +

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

          Summary

          List server signers for the current project

          +

          Throws

      • submitServerSignerSeedEventResult:function
        • 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 Promise<((axios?, basePath?) => AxiosPromise<SeedCreationEventResult>)>

          Summary

          Submit the result of a server signer event

          +

          Throws

      • submitServerSignerSignatureEventResult:function
        • 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 Promise<((axios?, basePath?) => AxiosPromise<SignatureCreationEventResult>)>

          Summary

          Submit the result of a server signer event

          +

          Throws

      Export

    \ No newline at end of file diff --git a/docs/functions/client_api.TradesApiAxiosParamCreator.html b/docs/functions/client_api.TradesApiAxiosParamCreator.html new file mode 100644 index 00000000..f75256c6 --- /dev/null +++ b/docs/functions/client_api.TradesApiAxiosParamCreator.html @@ -0,0 +1,26 @@ +TradesApiAxiosParamCreator | @coinbase/coinbase-sdk
    • TradesApi - axios parameter creator

      +

      Parameters

      Returns {
          broadcastTrade: ((walletId, addressId, tradeId, broadcastTradeRequest, options?) => Promise<RequestArgs>);
          createTrade: ((walletId, addressId, createTradeRequest, options?) => Promise<RequestArgs>);
          getTrade: ((walletId, addressId, tradeId, options?) => Promise<RequestArgs>);
          listTrades: ((walletId, addressId, limit?, page?, options?) => Promise<RequestArgs>);
      }

      • broadcastTrade: ((walletId, addressId, tradeId, broadcastTradeRequest, options?) => Promise<RequestArgs>)

        Broadcast a trade

        +

        Summary

        Broadcast a trade

        +

        Throws

          • (walletId, addressId, tradeId, broadcastTradeRequest, options?): Promise<RequestArgs>
          • 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<RequestArgs>

      • createTrade: ((walletId, addressId, createTradeRequest, options?) => Promise<RequestArgs>)

        Create a new trade

        +

        Summary

        Create a new trade for an address

        +

        Throws

          • (walletId, addressId, createTradeRequest, options?): Promise<RequestArgs>
          • 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<RequestArgs>

      • getTrade: ((walletId, addressId, tradeId, options?) => Promise<RequestArgs>)

        Get a trade by ID

        +

        Summary

        Get a trade by ID

        +

        Throws

          • (walletId, addressId, tradeId, options?): Promise<RequestArgs>
          • 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<RequestArgs>

      • listTrades: ((walletId, addressId, limit?, page?, options?) => Promise<RequestArgs>)

        List trades for an address.

        +

        Summary

        List trades for an address.

        +

        Throws

          • (walletId, addressId, limit?, page?, options?): Promise<RequestArgs>
          • 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&#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<RequestArgs>

      Export

    \ No newline at end of file diff --git a/docs/functions/client_api.TradesApiFactory.html b/docs/functions/client_api.TradesApiFactory.html new file mode 100644 index 00000000..7e68a0e6 --- /dev/null +++ b/docs/functions/client_api.TradesApiFactory.html @@ -0,0 +1,26 @@ +TradesApiFactory | @coinbase/coinbase-sdk
    • TradesApi - factory interface

      +

      Parameters

      • Optional configuration: Configuration
      • Optional basePath: string
      • Optional axios: AxiosInstance

      Returns {
          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>;
      }

      • broadcastTrade:function
        • 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: any

            Override http request option.

            +

          Returns AxiosPromise<Trade>

          Summary

          Broadcast a trade

          +

          Throws

      • createTrade:function
        • 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: any

            Override http request option.

            +

          Returns AxiosPromise<Trade>

          Summary

          Create a new trade for an address

          +

          Throws

      • getTrade:function
        • 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: any

            Override http request option.

            +

          Returns AxiosPromise<Trade>

          Summary

          Get a trade by ID

          +

          Throws

      • listTrades:function
        • 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&#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: any

            Override http request option.

            +

          Returns AxiosPromise<TradeList>

          Summary

          List trades for an address.

          +

          Throws

      Export

    \ No newline at end of file diff --git a/docs/functions/client_api.TradesApiFp.html b/docs/functions/client_api.TradesApiFp.html new file mode 100644 index 00000000..006ab3d4 --- /dev/null +++ b/docs/functions/client_api.TradesApiFp.html @@ -0,0 +1,26 @@ +TradesApiFp | @coinbase/coinbase-sdk
    • TradesApi - functional programming interface

      +

      Parameters

      Returns {
          broadcastTrade(walletId, addressId, tradeId, broadcastTradeRequest, options?): Promise<((axios?, basePath?) => AxiosPromise<Trade>)>;
          createTrade(walletId, addressId, createTradeRequest, options?): Promise<((axios?, basePath?) => AxiosPromise<Trade>)>;
          getTrade(walletId, addressId, tradeId, options?): Promise<((axios?, basePath?) => AxiosPromise<Trade>)>;
          listTrades(walletId, addressId, limit?, page?, options?): Promise<((axios?, basePath?) => AxiosPromise<TradeList>)>;
      }

      • broadcastTrade:function
        • 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<((axios?, basePath?) => AxiosPromise<Trade>)>

          Summary

          Broadcast a trade

          +

          Throws

      • createTrade:function
        • 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<((axios?, basePath?) => AxiosPromise<Trade>)>

          Summary

          Create a new trade for an address

          +

          Throws

      • getTrade:function
        • 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<((axios?, basePath?) => AxiosPromise<Trade>)>

          Summary

          Get a trade by ID

          +

          Throws

      • listTrades:function
        • 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&#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<TradeList>)>

          Summary

          List trades for an address.

          +

          Throws

      Export

    \ No newline at end of file diff --git a/docs/functions/client_api.TransfersApiAxiosParamCreator.html b/docs/functions/client_api.TransfersApiAxiosParamCreator.html index 99a8190d..0ed4ee09 100644 --- a/docs/functions/client_api.TransfersApiAxiosParamCreator.html +++ b/docs/functions/client_api.TransfersApiAxiosParamCreator.html @@ -23,4 +23,4 @@

    Throws

    • 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<RequestArgs>

    Export

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.TransfersApiFactory.html b/docs/functions/client_api.TransfersApiFactory.html index 325be9fe..6c03df8e 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: any

    Override http request option.

  • Returns AxiosPromise<Transfer>

    Summary

    Broadcast a transfer

    -

    Throws

  • createTransfer:function
    • Create a new transfer

      +

      Throws

  • createTransfer:function
    • 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: any

        Override http request option.

      Returns AxiosPromise<Transfer>

      Summary

      Create a new transfer for an address

      -

      Throws

  • getTransfer:function
  • getTransfer:function
    • 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: any

        Override http request option.

      Returns AxiosPromise<Transfer>

      Summary

      Get a transfer by ID

      -

      Throws

  • listTransfers:function
  • listTransfers:function
    • 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.

      • 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: any

        Override http request option.

      Returns AxiosPromise<TransferList>

      Summary

      List transfers for an address.

      -

      Throws

  • Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.TransfersApiFp.html b/docs/functions/client_api.TransfersApiFp.html index e8767af6..ded30b7c 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
    • Create a new transfer

      +

      Throws

  • createTransfer:function
    • 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<((axios?, basePath?) => AxiosPromise<Transfer>)>

      Summary

      Create a new transfer for an address

      -

      Throws

  • getTransfer:function
    • Get a transfer by ID

      +

      Throws

  • getTransfer:function
    • 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<((axios?, basePath?) => AxiosPromise<Transfer>)>

      Summary

      Get a transfer by ID

      -

      Throws

  • listTransfers:function
    • List transfers for an address.

      +

      Throws

  • listTransfers:function
    • 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.

      • 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<TransferList>)>

      Summary

      List transfers for an address.

      -

      Throws

  • Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.UsersApiAxiosParamCreator.html b/docs/functions/client_api.UsersApiAxiosParamCreator.html index 83af9592..b214cd32 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>);
    }

    • getCurrentUser: ((options?) => Promise<RequestArgs>)

      Get current user

      Summary

      Get current user

      Throws

        • (options?): Promise<RequestArgs>
        • Parameters

          • Optional options: RawAxiosRequestConfig = {}

            Override http request option.

            -

          Returns Promise<RequestArgs>

    Export

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.UsersApiFactory.html b/docs/functions/client_api.UsersApiFactory.html index e33391b8..12d13ec9 100644 --- a/docs/functions/client_api.UsersApiFactory.html +++ b/docs/functions/client_api.UsersApiFactory.html @@ -2,4 +2,4 @@

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns {
        getCurrentUser(options?): AxiosPromise<User>;
    }

    • getCurrentUser:function
      • Get current user

        Parameters

        • Optional options: any

          Override http request option.

        Returns AxiosPromise<User>

        Summary

        Get current user

        -

        Throws

    Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.UsersApiFp.html b/docs/functions/client_api.UsersApiFp.html index 6ab16a60..686af72d 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>)>;
    }

    • getCurrentUser:function
      • Get current user

        Parameters

        • Optional options: RawAxiosRequestConfig

          Override http request option.

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

        Summary

        Get current user

        -

        Throws

    Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.WalletsApiAxiosParamCreator.html b/docs/functions/client_api.WalletsApiAxiosParamCreator.html index 9839ca4f..2526cad6 100644 --- a/docs/functions/client_api.WalletsApiAxiosParamCreator.html +++ b/docs/functions/client_api.WalletsApiAxiosParamCreator.html @@ -20,4 +20,4 @@

    Throws

      • (limit?, page?, options?): Promise<RequestArgs>
      • 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<RequestArgs>

    Export

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.WalletsApiFactory.html b/docs/functions/client_api.WalletsApiFactory.html index a189cfde..08578135 100644 --- a/docs/functions/client_api.WalletsApiFactory.html +++ b/docs/functions/client_api.WalletsApiFactory.html @@ -2,22 +2,22 @@

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    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>;
    }

    • createWallet:function
      • Create a new wallet scoped to the user.

        Parameters

        • Optional createWalletRequest: CreateWalletRequest
        • Optional options: any

          Override http request option.

        Returns AxiosPromise<Wallet>

        Summary

        Create a new wallet

        -

        Throws

    • getWallet:function
    • getWallet:function
      • Get wallet

        Parameters

        • walletId: string

          The ID of the wallet to fetch

        • Optional options: any

          Override http request option.

        Returns AxiosPromise<Wallet>

        Summary

        Get wallet by ID

        -

        Throws

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

        +

        Throws

    • getWalletBalance:function
      • 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: any

          Override http request option.

        Returns AxiosPromise<Balance>

        Summary

        Get the balance of an asset in the wallet

        -

        Throws

    • listWalletBalances:function
    • listWalletBalances:function
      • 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: any

          Override http request option.

        Returns AxiosPromise<AddressBalanceList>

        Summary

        List wallet balances

        -

        Throws

    • listWallets:function
    • listWallets:function
      • 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: any

          Override http request option.

        Returns AxiosPromise<WalletList>

        Summary

        List wallets

        -

        Throws

    Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.WalletsApiFp.html b/docs/functions/client_api.WalletsApiFp.html index 53d5505b..6bc52057 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>)>;
    }

    • createWallet:function
      • Create a new wallet scoped to the user.

        Parameters

        • Optional createWalletRequest: CreateWalletRequest
        • Optional options: RawAxiosRequestConfig

          Override http request option.

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

        Summary

        Create a new wallet

        -

        Throws

    • getWallet:function
    • getWallet:function
      • Get wallet

        Parameters

        • walletId: string

          The ID of the wallet to fetch

        • Optional options: RawAxiosRequestConfig

          Override http request option.

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

        Summary

        Get wallet by ID

        -

        Throws

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

        +

        Throws

    • getWalletBalance:function
      • 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<((axios?, basePath?) => AxiosPromise<Balance>)>

        Summary

        Get the balance of an asset in the wallet

        -

        Throws

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

        +

        Throws

    • listWalletBalances:function
      • 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<((axios?, basePath?) => AxiosPromise<AddressBalanceList>)>

        Summary

        List wallet balances

        -

        Throws

    • listWallets:function
      • List wallets belonging to the user.

        +

        Throws

    • listWallets:function
      • 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<((axios?, basePath?) => AxiosPromise<WalletList>)>

        Summary

        List wallets

        -

        Throws

    Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_common.assertParamExists.html b/docs/functions/client_common.assertParamExists.html index 7fa3e8d1..a87482f0 100644 --- a/docs/functions/client_common.assertParamExists.html +++ b/docs/functions/client_common.assertParamExists.html @@ -1 +1 @@ -assertParamExists | @coinbase/coinbase-sdk
    • Parameters

      • functionName: string
      • paramName: string
      • paramValue: unknown

      Returns void

      Throws

      Export

    \ No newline at end of file +assertParamExists | @coinbase/coinbase-sdk
    • Parameters

      • functionName: string
      • paramName: string
      • paramValue: unknown

      Returns void

      Throws

      Export

    \ No newline at end of file diff --git a/docs/functions/client_common.createRequestFunction.html b/docs/functions/client_common.createRequestFunction.html index 5fea358c..802f89dd 100644 --- a/docs/functions/client_common.createRequestFunction.html +++ b/docs/functions/client_common.createRequestFunction.html @@ -1 +1 @@ -createRequestFunction | @coinbase/coinbase-sdk
    • 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

    \ No newline at end of file +createRequestFunction | @coinbase/coinbase-sdk
    • 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

    \ No newline at end of file diff --git a/docs/functions/client_common.serializeDataIfNeeded.html b/docs/functions/client_common.serializeDataIfNeeded.html index c029f4ac..a29d3eb9 100644 --- a/docs/functions/client_common.serializeDataIfNeeded.html +++ b/docs/functions/client_common.serializeDataIfNeeded.html @@ -1 +1 @@ -serializeDataIfNeeded | @coinbase/coinbase-sdk
    • Parameters

      • value: any
      • requestOptions: any
      • Optional configuration: Configuration

      Returns any

      Export

    \ No newline at end of file +serializeDataIfNeeded | @coinbase/coinbase-sdk
    • Parameters

      • value: any
      • requestOptions: any
      • Optional configuration: Configuration

      Returns any

      Export

    \ No newline at end of file diff --git a/docs/functions/client_common.setApiKeyToObject.html b/docs/functions/client_common.setApiKeyToObject.html index cdf256fc..a1fe6765 100644 --- a/docs/functions/client_common.setApiKeyToObject.html +++ b/docs/functions/client_common.setApiKeyToObject.html @@ -1 +1 @@ -setApiKeyToObject | @coinbase/coinbase-sdk
    • Parameters

      • object: any
      • keyParamName: string
      • Optional configuration: Configuration

      Returns Promise<void>

      Export

    \ No newline at end of file +setApiKeyToObject | @coinbase/coinbase-sdk
    • Parameters

      • object: any
      • keyParamName: string
      • Optional configuration: Configuration

      Returns Promise<void>

      Export

    \ No newline at end of file diff --git a/docs/functions/client_common.setBasicAuthToObject.html b/docs/functions/client_common.setBasicAuthToObject.html index c115c6ca..79592365 100644 --- a/docs/functions/client_common.setBasicAuthToObject.html +++ b/docs/functions/client_common.setBasicAuthToObject.html @@ -1 +1 @@ -setBasicAuthToObject | @coinbase/coinbase-sdk
    \ No newline at end of file +setBasicAuthToObject | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/functions/client_common.setBearerAuthToObject.html b/docs/functions/client_common.setBearerAuthToObject.html index 70a975e3..91e9af35 100644 --- a/docs/functions/client_common.setBearerAuthToObject.html +++ b/docs/functions/client_common.setBearerAuthToObject.html @@ -1 +1 @@ -setBearerAuthToObject | @coinbase/coinbase-sdk
    \ No newline at end of file +setBearerAuthToObject | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/functions/client_common.setOAuthToObject.html b/docs/functions/client_common.setOAuthToObject.html index 09291ac6..e955cff3 100644 --- a/docs/functions/client_common.setOAuthToObject.html +++ b/docs/functions/client_common.setOAuthToObject.html @@ -1 +1 @@ -setOAuthToObject | @coinbase/coinbase-sdk
    • Parameters

      • object: any
      • name: string
      • scopes: string[]
      • Optional configuration: Configuration

      Returns Promise<void>

      Export

    \ No newline at end of file +setOAuthToObject | @coinbase/coinbase-sdk
    • Parameters

      • object: any
      • name: string
      • scopes: string[]
      • Optional configuration: Configuration

      Returns Promise<void>

      Export

    \ No newline at end of file diff --git a/docs/functions/client_common.setSearchParams.html b/docs/functions/client_common.setSearchParams.html index f3791666..b0e5446c 100644 --- a/docs/functions/client_common.setSearchParams.html +++ b/docs/functions/client_common.setSearchParams.html @@ -1 +1 @@ -setSearchParams | @coinbase/coinbase-sdk
    • Parameters

      • url: URL
      • Rest ...objects: any[]

      Returns void

      Export

    \ No newline at end of file +setSearchParams | @coinbase/coinbase-sdk
    • Parameters

      • url: URL
      • Rest ...objects: any[]

      Returns void

      Export

    \ No newline at end of file diff --git a/docs/functions/client_common.toPathString.html b/docs/functions/client_common.toPathString.html index f70d61d5..64bc9d4b 100644 --- a/docs/functions/client_common.toPathString.html +++ b/docs/functions/client_common.toPathString.html @@ -1 +1 @@ -toPathString | @coinbase/coinbase-sdk
    \ No newline at end of file +toPathString | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/functions/coinbase_tests_utils.createAxiosMock.html b/docs/functions/coinbase_tests_utils.createAxiosMock.html index 4f55f360..8e873bed 100644 --- a/docs/functions/coinbase_tests_utils.createAxiosMock.html +++ b/docs/functions/coinbase_tests_utils.createAxiosMock.html @@ -1,3 +1,3 @@ createAxiosMock | @coinbase/coinbase-sdk
    • Returns an Axios instance with interceptors and configuration for testing.

      Returns AxiosMockType

      The Axios instance, configuration, and base path.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/functions/coinbase_tests_utils.generateRandomHash.html b/docs/functions/coinbase_tests_utils.generateRandomHash.html index 6d48b957..75c7ae9d 100644 --- a/docs/functions/coinbase_tests_utils.generateRandomHash.html +++ b/docs/functions/coinbase_tests_utils.generateRandomHash.html @@ -1 +1 @@ -generateRandomHash | @coinbase/coinbase-sdk
    \ No newline at end of file +generateRandomHash | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/functions/coinbase_tests_utils.generateWalletFromSeed.html b/docs/functions/coinbase_tests_utils.generateWalletFromSeed.html index 492b2955..06941761 100644 --- a/docs/functions/coinbase_tests_utils.generateWalletFromSeed.html +++ b/docs/functions/coinbase_tests_utils.generateWalletFromSeed.html @@ -1 +1 @@ -generateWalletFromSeed | @coinbase/coinbase-sdk
    • Parameters

      • seed: string
      • count: number = 2

      Returns Record<string, string>

    \ No newline at end of file +generateWalletFromSeed | @coinbase/coinbase-sdk
    • Parameters

      • seed: string
      • count: number = 2

      Returns Record<string, string>

    \ No newline at end of file diff --git a/docs/functions/coinbase_tests_utils.getAddressFromHDKey.html b/docs/functions/coinbase_tests_utils.getAddressFromHDKey.html index 4bb41b69..723714e9 100644 --- a/docs/functions/coinbase_tests_utils.getAddressFromHDKey.html +++ b/docs/functions/coinbase_tests_utils.getAddressFromHDKey.html @@ -1 +1 @@ -getAddressFromHDKey | @coinbase/coinbase-sdk
    \ No newline at end of file +getAddressFromHDKey | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/functions/coinbase_tests_utils.mockFn.html b/docs/functions/coinbase_tests_utils.mockFn.html index a2455b66..850d6339 100644 --- a/docs/functions/coinbase_tests_utils.mockFn.html +++ b/docs/functions/coinbase_tests_utils.mockFn.html @@ -1 +1 @@ -mockFn | @coinbase/coinbase-sdk
    \ No newline at end of file +mockFn | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/functions/coinbase_tests_utils.mockReturnRejectedValue.html b/docs/functions/coinbase_tests_utils.mockReturnRejectedValue.html index 81724969..2b994187 100644 --- a/docs/functions/coinbase_tests_utils.mockReturnRejectedValue.html +++ b/docs/functions/coinbase_tests_utils.mockReturnRejectedValue.html @@ -1 +1 @@ -mockReturnRejectedValue | @coinbase/coinbase-sdk
    \ No newline at end of file +mockReturnRejectedValue | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/functions/coinbase_tests_utils.mockReturnValue.html b/docs/functions/coinbase_tests_utils.mockReturnValue.html index 287a9645..a338bc55 100644 --- a/docs/functions/coinbase_tests_utils.mockReturnValue.html +++ b/docs/functions/coinbase_tests_utils.mockReturnValue.html @@ -1 +1 @@ -mockReturnValue | @coinbase/coinbase-sdk
    \ No newline at end of file +mockReturnValue | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/functions/coinbase_tests_utils.newAddressModel.html b/docs/functions/coinbase_tests_utils.newAddressModel.html index 61084454..d4265e4e 100644 --- a/docs/functions/coinbase_tests_utils.newAddressModel.html +++ b/docs/functions/coinbase_tests_utils.newAddressModel.html @@ -1 +1 @@ -newAddressModel | @coinbase/coinbase-sdk
    \ No newline at end of file +newAddressModel | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/functions/coinbase_utils.convertStringToHex.html b/docs/functions/coinbase_utils.convertStringToHex.html index 8d4bd40c..5f19e822 100644 --- a/docs/functions/coinbase_utils.convertStringToHex.html +++ b/docs/functions/coinbase_utils.convertStringToHex.html @@ -1,4 +1,4 @@ convertStringToHex | @coinbase/coinbase-sdk
    • Converts a Uint8Array to a hex string.

      Parameters

      • key: Uint8Array

        The key to convert.

      Returns string

      The converted hex string.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/functions/coinbase_utils.delay.html b/docs/functions/coinbase_utils.delay.html index 8fd30182..c3bb4a56 100644 --- a/docs/functions/coinbase_utils.delay.html +++ b/docs/functions/coinbase_utils.delay.html @@ -1,4 +1,4 @@ delay | @coinbase/coinbase-sdk
    • 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.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/functions/coinbase_utils.destinationToAddressHexString.html b/docs/functions/coinbase_utils.destinationToAddressHexString.html index dae0500d..52118d99 100644 --- a/docs/functions/coinbase_utils.destinationToAddressHexString.html +++ b/docs/functions/coinbase_utils.destinationToAddressHexString.html @@ -2,4 +2,4 @@

    Parameters

    Returns string

    The Address Hex string.

    Throws

    If the Destination is an unsupported type.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/functions/coinbase_utils.logApiResponse.html b/docs/functions/coinbase_utils.logApiResponse.html index e461f4c0..d9fff4ac 100644 --- a/docs/functions/coinbase_utils.logApiResponse.html +++ b/docs/functions/coinbase_utils.logApiResponse.html @@ -2,4 +2,4 @@

    Parameters

    • response: AxiosResponse<any, any>

      The Axios response object.

    • debugging: boolean = false

      Flag to enable or disable logging.

    Returns AxiosResponse<any, any>

    The Axios response object.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/functions/coinbase_utils.registerAxiosInterceptors.html b/docs/functions/coinbase_utils.registerAxiosInterceptors.html index 1d937a92..04151efa 100644 --- a/docs/functions/coinbase_utils.registerAxiosInterceptors.html +++ b/docs/functions/coinbase_utils.registerAxiosInterceptors.html @@ -2,4 +2,4 @@

    Parameters

    • axiosInstance: Axios

      The Axios instance to register the interceptors.

    • requestFn: RequestFunctionType

      The request interceptor function.

    • responseFn: ResponseFunctionType

      The response interceptor function.

      -

    Returns void

    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/docs/hierarchy.html b/docs/hierarchy.html index 90dac2ac..245d7c98 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1 +1 @@ -@coinbase/coinbase-sdk
    \ No newline at end of file +@coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/interfaces/client_api.Address.html b/docs/interfaces/client_api.Address.html index b005d522..92472d05 100644 --- a/docs/interfaces/client_api.Address.html +++ b/docs/interfaces/client_api.Address.html @@ -1,14 +1,14 @@ Address | @coinbase/coinbase-sdk

    Export

    Address

    -
    interface Address {
        address_id: string;
        network_id: string;
        public_key: string;
        wallet_id: string;
    }

    Properties

    interface Address {
        address_id: string;
        network_id: string;
        public_key: string;
        wallet_id: string;
    }

    Properties

    address_id: string

    The onchain address derived on the server-side.

    Memberof

    Address

    -
    network_id: string

    The ID of the blockchain network

    +
    network_id: string

    The ID of the blockchain network

    Memberof

    Address

    -
    public_key: string

    The public key from which the address is derived.

    +
    public_key: string

    The public key from which the address is derived.

    Memberof

    Address

    -
    wallet_id: string

    The ID of the wallet that owns the address

    +
    wallet_id: string

    The ID of the wallet that owns the address

    Memberof

    Address

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.AddressBalanceList.html b/docs/interfaces/client_api.AddressBalanceList.html index fe6e0be9..e909078a 100644 --- a/docs/interfaces/client_api.AddressBalanceList.html +++ b/docs/interfaces/client_api.AddressBalanceList.html @@ -1,13 +1,13 @@ AddressBalanceList | @coinbase/coinbase-sdk

    Export

    AddressBalanceList

    -
    interface AddressBalanceList {
        data: Balance[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    interface AddressBalanceList {
        data: Balance[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data: Balance[]

    Memberof

    AddressBalanceList

    -
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    AddressBalanceList

    -
    next_page: string

    The page token to be used to fetch the next page.

    +
    next_page: string

    The page token to be used to fetch the next page.

    Memberof

    AddressBalanceList

    -
    total_count: number

    The total number of balances for the wallet.

    +
    total_count: number

    The total number of balances for the wallet.

    Memberof

    AddressBalanceList

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.AddressList.html b/docs/interfaces/client_api.AddressList.html index 61601d76..046d92e9 100644 --- a/docs/interfaces/client_api.AddressList.html +++ b/docs/interfaces/client_api.AddressList.html @@ -1,13 +1,13 @@ AddressList | @coinbase/coinbase-sdk

    Export

    AddressList

    -
    interface AddressList {
        data: Address[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    interface AddressList {
        data: Address[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data: Address[]

    Memberof

    AddressList

    -
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    AddressList

    -
    next_page: string

    The page token to be used to fetch the next page.

    +
    next_page: string

    The page token to be used to fetch the next page.

    Memberof

    AddressList

    -
    total_count: number

    The total number of addresses for the wallet.

    +
    total_count: number

    The total number of addresses for the wallet.

    Memberof

    AddressList

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.AddressesApiInterface.html b/docs/interfaces/client_api.AddressesApiInterface.html new file mode 100644 index 00000000..8cd2b9f5 --- /dev/null +++ b/docs/interfaces/client_api.AddressesApiInterface.html @@ -0,0 +1,47 @@ +AddressesApiInterface | @coinbase/coinbase-sdk

    AddressesApi - interface

    +

    Export

    AddressesApi

    +
    interface AddressesApiInterface {
        createAddress(walletId, createAddressRequest?, options?): AxiosPromise<Address>;
        getAddress(walletId, addressId, options?): AxiosPromise<Address>;
        getAddressBalance(walletId, addressId, assetId, options?): AxiosPromise<Balance>;
        listAddressBalances(walletId, addressId, page?, options?): AxiosPromise<AddressBalanceList>;
        listAddresses(walletId, limit?, page?, options?): AxiosPromise<AddressList>;
        requestFaucetFunds(walletId, addressId, options?): AxiosPromise<FaucetTransaction>;
    }

    Implemented by

    Methods

    • 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 AxiosPromise<Address>

      Summary

      Create a new address

      +

      Throws

      Memberof

      AddressesApiInterface

      +
    • 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

      +
    • 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

      +
    • 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

      +
    • 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

      +
    • 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 options: RawAxiosRequestConfig

        Override http request option.

        +

      Returns AxiosPromise<FaucetTransaction>

      Summary

      Request faucet funds for onchain address.

      +

      Throws

      Memberof

      AddressesApiInterface

      +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.Asset.html b/docs/interfaces/client_api.Asset.html index f13eedd9..0b93c233 100644 --- a/docs/interfaces/client_api.Asset.html +++ b/docs/interfaces/client_api.Asset.html @@ -1,15 +1,15 @@ Asset | @coinbase/coinbase-sdk

    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

    interface Asset {
        asset_id: string;
        contract_address?: string;
        decimals?: number;
        network_id: string;
    }

    Properties

    asset_id: string

    The ID for the asset on the network

    Memberof

    Asset

    -
    contract_address?: string

    The optional contract address for the asset. This will be specified for smart contract-based assets, for example ERC20s.

    +
    contract_address?: string

    The optional contract address for the asset. This will be specified for smart contract-based assets, for example ERC20s.

    Memberof

    Asset

    -
    decimals?: number

    The number of decimals the asset supports. This is used to convert from atomic units to base units.

    +
    decimals?: number

    The number of decimals the asset supports. This is used to convert from atomic units to base units.

    Memberof

    Asset

    -
    network_id: string

    The ID of the blockchain network

    +
    network_id: string

    The ID of the blockchain network

    Memberof

    Asset

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.Balance.html b/docs/interfaces/client_api.Balance.html index 3e8ab81f..6ef68138 100644 --- a/docs/interfaces/client_api.Balance.html +++ b/docs/interfaces/client_api.Balance.html @@ -1,8 +1,8 @@ Balance | @coinbase/coinbase-sdk

    The balance of an asset onchain

    Export

    Balance

    -
    interface Balance {
        amount: string;
        asset: Asset;
    }

    Properties

    interface Balance {
        amount: string;
        asset: Asset;
    }

    Properties

    Properties

    amount: string

    The amount in the atomic units of the asset

    Memberof

    Balance

    -
    asset: Asset

    Memberof

    Balance

    -
    \ No newline at end of file +
    asset: Asset

    Memberof

    Balance

    +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.BroadcastTradeRequest.html b/docs/interfaces/client_api.BroadcastTradeRequest.html new file mode 100644 index 00000000..8462d3e7 --- /dev/null +++ b/docs/interfaces/client_api.BroadcastTradeRequest.html @@ -0,0 +1,5 @@ +BroadcastTradeRequest | @coinbase/coinbase-sdk

    Export

    BroadcastTradeRequest

    +
    interface BroadcastTradeRequest {
        signed_payload: string;
    }

    Properties

    Properties

    signed_payload: string

    The hex-encoded signed payload of the trade

    +

    Memberof

    BroadcastTradeRequest

    +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.BroadcastTransferRequest.html b/docs/interfaces/client_api.BroadcastTransferRequest.html index 81f307c3..9a196203 100644 --- a/docs/interfaces/client_api.BroadcastTransferRequest.html +++ b/docs/interfaces/client_api.BroadcastTransferRequest.html @@ -1,5 +1,5 @@ BroadcastTransferRequest | @coinbase/coinbase-sdk

    Export

    BroadcastTransferRequest

    -
    interface BroadcastTransferRequest {
        signed_payload: string;
    }

    Properties

    interface BroadcastTransferRequest {
        signed_payload: string;
    }

    Properties

    Properties

    signed_payload: string

    The hex-encoded signed payload of the transfer

    Memberof

    BroadcastTransferRequest

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateAddressRequest.html b/docs/interfaces/client_api.CreateAddressRequest.html index f82f6872..70cb387e 100644 --- a/docs/interfaces/client_api.CreateAddressRequest.html +++ b/docs/interfaces/client_api.CreateAddressRequest.html @@ -1,8 +1,8 @@ CreateAddressRequest | @coinbase/coinbase-sdk

    Export

    CreateAddressRequest

    -
    interface CreateAddressRequest {
        attestation: string;
        public_key: string;
    }

    Properties

    Properties

    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.

    +
    interface CreateAddressRequest {
        attestation?: string;
        public_key?: string;
    }

    Properties

    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

    -
    public_key: string

    The public key from which the address will be derived.

    +
    public_key?: string

    The public key from which the address will be derived.

    Memberof

    CreateAddressRequest

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateServerSignerRequest.html b/docs/interfaces/client_api.CreateServerSignerRequest.html new file mode 100644 index 00000000..fa194017 --- /dev/null +++ b/docs/interfaces/client_api.CreateServerSignerRequest.html @@ -0,0 +1,8 @@ +CreateServerSignerRequest | @coinbase/coinbase-sdk

    Export

    CreateServerSignerRequest

    +
    interface CreateServerSignerRequest {
        enrollment_data: string;
        server_signer_id: string;
    }

    Properties

    enrollment_data: string

    The enrollment data of the server signer. This will be the base64 encoded server-signer-id.

    +

    Memberof

    CreateServerSignerRequest

    +
    server_signer_id: string

    The ID of the server signer

    +

    Memberof

    CreateServerSignerRequest

    +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateTradeRequest.html b/docs/interfaces/client_api.CreateTradeRequest.html new file mode 100644 index 00000000..6d534299 --- /dev/null +++ b/docs/interfaces/client_api.CreateTradeRequest.html @@ -0,0 +1,11 @@ +CreateTradeRequest | @coinbase/coinbase-sdk

    Export

    CreateTradeRequest

    +
    interface CreateTradeRequest {
        amount: string;
        from_asset_id: string;
        to_asset_id: string;
    }

    Properties

    amount: string

    The amount to trade

    +

    Memberof

    CreateTradeRequest

    +
    from_asset_id: string

    The ID of the asset to trade

    +

    Memberof

    CreateTradeRequest

    +
    to_asset_id: string

    The ID of the asset to receive from the trade

    +

    Memberof

    CreateTradeRequest

    +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateTransferRequest.html b/docs/interfaces/client_api.CreateTransferRequest.html index ba4dea52..34c58c6f 100644 --- a/docs/interfaces/client_api.CreateTransferRequest.html +++ b/docs/interfaces/client_api.CreateTransferRequest.html @@ -1,14 +1,14 @@ CreateTransferRequest | @coinbase/coinbase-sdk

    Export

    CreateTransferRequest

    -
    interface CreateTransferRequest {
        amount: string;
        asset_id: string;
        destination: string;
        network_id: string;
    }

    Properties

    interface CreateTransferRequest {
        amount: string;
        asset_id: string;
        destination: string;
        network_id: string;
    }

    Properties

    amount: string

    The amount to transfer

    Memberof

    CreateTransferRequest

    -
    asset_id: string

    The ID of the asset to transfer

    +
    asset_id: string

    The ID of the asset to transfer

    Memberof

    CreateTransferRequest

    -
    destination: string

    The destination address

    +
    destination: string

    The destination address

    Memberof

    CreateTransferRequest

    -
    network_id: string

    The ID of the blockchain network

    +
    network_id: string

    The ID of the blockchain network

    Memberof

    CreateTransferRequest

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateWalletRequest.html b/docs/interfaces/client_api.CreateWalletRequest.html index 74b0d54d..2546cfc4 100644 --- a/docs/interfaces/client_api.CreateWalletRequest.html +++ b/docs/interfaces/client_api.CreateWalletRequest.html @@ -1,4 +1,4 @@ CreateWalletRequest | @coinbase/coinbase-sdk

    Export

    CreateWalletRequest

    -
    interface CreateWalletRequest {
        wallet: Wallet;
    }

    Properties

    Properties

    wallet: Wallet

    Memberof

    CreateWalletRequest

    -
    \ No newline at end of file +
    interface CreateWalletRequest {
        wallet: CreateWalletRequestWallet;
    }

    Properties

    Properties

    Memberof

    CreateWalletRequest

    +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateWalletRequestWallet.html b/docs/interfaces/client_api.CreateWalletRequestWallet.html new file mode 100644 index 00000000..301be1de --- /dev/null +++ b/docs/interfaces/client_api.CreateWalletRequestWallet.html @@ -0,0 +1,9 @@ +CreateWalletRequestWallet | @coinbase/coinbase-sdk

    Parameters for configuring a wallet

    +

    Export

    CreateWalletRequestWallet

    +
    interface CreateWalletRequestWallet {
        network_id: string;
        use_server_signer?: boolean;
    }

    Properties

    network_id: string

    The ID of the blockchain network

    +

    Memberof

    CreateWalletRequestWallet

    +
    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

    +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.FaucetTransaction.html b/docs/interfaces/client_api.FaucetTransaction.html index d666a67b..b0bde302 100644 --- a/docs/interfaces/client_api.FaucetTransaction.html +++ b/docs/interfaces/client_api.FaucetTransaction.html @@ -1,5 +1,5 @@ FaucetTransaction | @coinbase/coinbase-sdk

    Export

    FaucetTransaction

    -
    interface FaucetTransaction {
        transaction_hash: string;
    }

    Properties

    interface FaucetTransaction {
        transaction_hash: string;
    }

    Properties

    Properties

    transaction_hash: string

    The transaction hash of the transaction the faucet created.

    Memberof

    FaucetTransaction

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ModelError.html b/docs/interfaces/client_api.ModelError.html index 418fc7fa..74a121e2 100644 --- a/docs/interfaces/client_api.ModelError.html +++ b/docs/interfaces/client_api.ModelError.html @@ -1,9 +1,9 @@ ModelError | @coinbase/coinbase-sdk

    An error response from the Coinbase Developer Platform API

    Export

    ModelError

    -
    interface ModelError {
        code: string;
        message: string;
    }

    Properties

    interface ModelError {
        code: string;
        message: string;
    }

    Properties

    Properties

    code: string

    A short string representing the reported error. Can be use to handle errors programmatically.

    Memberof

    ModelError

    -
    message: string

    A human-readable message providing more details about the error.

    +
    message: string

    A human-readable message providing more details about the error.

    Memberof

    ModelError

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.SeedCreationEvent.html b/docs/interfaces/client_api.SeedCreationEvent.html new file mode 100644 index 00000000..d4549763 --- /dev/null +++ b/docs/interfaces/client_api.SeedCreationEvent.html @@ -0,0 +1,9 @@ +SeedCreationEvent | @coinbase/coinbase-sdk

    An event representing a seed creation.

    +

    Export

    SeedCreationEvent

    +
    interface SeedCreationEvent {
        wallet_id: string;
        wallet_user_id: string;
    }

    Properties

    wallet_id: string

    The ID of the wallet that the server-signer should create the seed for

    +

    Memberof

    SeedCreationEvent

    +
    wallet_user_id: string

    The ID of the user that the wallet belongs to

    +

    Memberof

    SeedCreationEvent

    +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.SeedCreationEventResult.html b/docs/interfaces/client_api.SeedCreationEventResult.html new file mode 100644 index 00000000..5c8211ad --- /dev/null +++ b/docs/interfaces/client_api.SeedCreationEventResult.html @@ -0,0 +1,15 @@ +SeedCreationEventResult | @coinbase/coinbase-sdk

    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: string

    The extended public key for the first master key derived from seed.

    +

    Memberof

    SeedCreationEventResult

    +
    seed_id: string

    The ID of the seed in Server-Signer used to generate the extended public key.

    +

    Memberof

    SeedCreationEventResult

    +
    wallet_id: string

    The ID of the wallet that the seed was created for

    +

    Memberof

    SeedCreationEventResult

    +
    wallet_user_id: string

    The ID of the user that the wallet belongs to

    +

    Memberof

    SeedCreationEventResult

    +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ServerSigner.html b/docs/interfaces/client_api.ServerSigner.html new file mode 100644 index 00000000..5f96107b --- /dev/null +++ b/docs/interfaces/client_api.ServerSigner.html @@ -0,0 +1,9 @@ +ServerSigner | @coinbase/coinbase-sdk

    A Server-Signer assigned to sign transactions in a wallet.

    +

    Export

    ServerSigner

    +
    interface ServerSigner {
        server_signer_id: string;
        wallets?: string[];
    }

    Properties

    server_signer_id: string

    The ID of the server-signer

    +

    Memberof

    ServerSigner

    +
    wallets?: string[]

    The IDs of the wallets that the server-signer can sign for

    +

    Memberof

    ServerSigner

    +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ServerSignerEvent.html b/docs/interfaces/client_api.ServerSignerEvent.html new file mode 100644 index 00000000..f47e9fa1 --- /dev/null +++ b/docs/interfaces/client_api.ServerSignerEvent.html @@ -0,0 +1,8 @@ +ServerSignerEvent | @coinbase/coinbase-sdk

    An event that is waiting to be processed by a Server-Signer.

    +

    Export

    ServerSignerEvent

    +
    interface ServerSignerEvent {
        event: ServerSignerEventEvent;
        server_signer_id: string;
    }

    Properties

    Properties

    Memberof

    ServerSignerEvent

    +
    server_signer_id: string

    The ID of the server-signer that the event is for

    +

    Memberof

    ServerSignerEvent

    +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ServerSignerEventList.html b/docs/interfaces/client_api.ServerSignerEventList.html new file mode 100644 index 00000000..a361fc41 --- /dev/null +++ b/docs/interfaces/client_api.ServerSignerEventList.html @@ -0,0 +1,13 @@ +ServerSignerEventList | @coinbase/coinbase-sdk

    Export

    ServerSignerEventList

    +
    interface ServerSignerEventList {
        data: ServerSignerEvent[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    Memberof

    ServerSignerEventList

    +
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +

    Memberof

    ServerSignerEventList

    +
    next_page: string

    The page token to be used to fetch the next page.

    +

    Memberof

    ServerSignerEventList

    +
    total_count: number

    The total number of events for the server signer.

    +

    Memberof

    ServerSignerEventList

    +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ServerSignersApiInterface.html b/docs/interfaces/client_api.ServerSignersApiInterface.html new file mode 100644 index 00000000..d202498d --- /dev/null +++ b/docs/interfaces/client_api.ServerSignersApiInterface.html @@ -0,0 +1,39 @@ +ServerSignersApiInterface | @coinbase/coinbase-sdk

    ServerSignersApi - interface

    +

    Export

    ServerSignersApi

    +
    interface ServerSignersApiInterface {
        createServerSigner(createServerSignerRequest?, options?): AxiosPromise<ServerSigner>;
        getServerSigner(serverSignerId, options?): AxiosPromise<ServerSigner>;
        listServerSignerEvents(serverSignerId, limit?, page?, options?): AxiosPromise<ServerSignerEventList>;
        listServerSigners(options?): AxiosPromise<ServerSigner>;
        submitServerSignerSeedEventResult(serverSignerId, seedCreationEventResult?, options?): AxiosPromise<SeedCreationEventResult>;
        submitServerSignerSignatureEventResult(serverSignerId, signatureCreationEventResult?, options?): AxiosPromise<SignatureCreationEventResult>;
    }

    Implemented by

    Methods

    • Create a new Server-Signer

      +

      Parameters

      • Optional createServerSignerRequest: CreateServerSignerRequest
      • Optional options: RawAxiosRequestConfig

        Override http request option.

        +

      Returns AxiosPromise<ServerSigner>

      Summary

      Create a new Server-Signer

      +

      Throws

      Memberof

      ServerSignersApiInterface

      +
    • 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

      +
    • 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

      +

      Throws

      Memberof

      ServerSignersApiInterface

      +
    • List server signers for the current project

      +

      Parameters

      • Optional options: RawAxiosRequestConfig

        Override http request option.

        +

      Returns AxiosPromise<ServerSigner>

      Summary

      List server signers for the current project

      +

      Throws

      Memberof

      ServerSignersApiInterface

      +
    • 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

      +
    • 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

      +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.SignatureCreationEvent.html b/docs/interfaces/client_api.SignatureCreationEvent.html new file mode 100644 index 00000000..e99e7897 --- /dev/null +++ b/docs/interfaces/client_api.SignatureCreationEvent.html @@ -0,0 +1,26 @@ +SignatureCreationEvent | @coinbase/coinbase-sdk

    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: string

    The ID of the address the transfer belongs to

    +

    Memberof

    SignatureCreationEvent

    +
    address_index: number

    The index of the address that the server-signer should sign with

    +

    Memberof

    SignatureCreationEvent

    +
    seed_id: string

    The ID of the seed that the server-signer should create the signature for

    +

    Memberof

    SignatureCreationEvent

    +
    signing_payload: string

    The payload that the server-signer should sign

    +

    Memberof

    SignatureCreationEvent

    +
    transaction_id: string

    The ID of the transaction that the server-signer should sign

    +

    Memberof

    SignatureCreationEvent

    +
    transaction_type: "transfer"

    Memberof

    SignatureCreationEvent

    +
    wallet_id: string

    The ID of the wallet the signature is for

    +

    Memberof

    SignatureCreationEvent

    +
    wallet_user_id: string

    The ID of the user that the wallet belongs to

    +

    Memberof

    SignatureCreationEvent

    +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.SignatureCreationEventResult.html b/docs/interfaces/client_api.SignatureCreationEventResult.html new file mode 100644 index 00000000..7feda58a --- /dev/null +++ b/docs/interfaces/client_api.SignatureCreationEventResult.html @@ -0,0 +1,20 @@ +SignatureCreationEventResult | @coinbase/coinbase-sdk

    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: string

    The ID of the address the transfer belongs to

    +

    Memberof

    SignatureCreationEventResult

    +
    signature: string

    The signature created by the server-signer.

    +

    Memberof

    SignatureCreationEventResult

    +
    transaction_id: string

    The ID of the transaction that the Server-Signer has signed for

    +

    Memberof

    SignatureCreationEventResult

    +
    transaction_type: "transfer"

    Memberof

    SignatureCreationEventResult

    +
    wallet_id: string

    The ID of the wallet that the event was created for.

    +

    Memberof

    SignatureCreationEventResult

    +
    wallet_user_id: string

    The ID of the user that the wallet belongs to

    +

    Memberof

    SignatureCreationEventResult

    +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.Trade.html b/docs/interfaces/client_api.Trade.html new file mode 100644 index 00000000..fea26507 --- /dev/null +++ b/docs/interfaces/client_api.Trade.html @@ -0,0 +1,27 @@ +Trade | @coinbase/coinbase-sdk

    A trade of an asset to another asset

    +

    Export

    Trade

    +
    interface Trade {
        address_id: string;
        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: string

    The onchain address of the sender

    +

    Memberof

    Trade

    +
    from_amount: string

    The amount of the from asset to be traded (in atomic units of the from asset)

    +

    Memberof

    Trade

    +
    from_asset: Asset

    Memberof

    Trade

    +
    network_id: string

    The ID of the blockchain network

    +

    Memberof

    Trade

    +
    to_amount: string

    The amount of the to asset that will be received (in atomic units of the to asset)

    +

    Memberof

    Trade

    +
    to_asset: Asset

    Memberof

    Trade

    +
    trade_id: string

    The ID of the trade

    +

    Memberof

    Trade

    +
    transaction: Transaction

    Memberof

    Trade

    +
    wallet_id: string

    The ID of the wallet that owns the from address

    +

    Memberof

    Trade

    +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.TradeList.html b/docs/interfaces/client_api.TradeList.html new file mode 100644 index 00000000..65712ca2 --- /dev/null +++ b/docs/interfaces/client_api.TradeList.html @@ -0,0 +1,13 @@ +TradeList | @coinbase/coinbase-sdk

    Export

    TradeList

    +
    interface TradeList {
        data: Trade[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data: Trade[]

    Memberof

    TradeList

    +
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +

    Memberof

    TradeList

    +
    next_page: string

    The page token to be used to fetch the next page.

    +

    Memberof

    TradeList

    +
    total_count: number

    The total number of trades for the address in the wallet.

    +

    Memberof

    TradeList

    +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.TradesApiInterface.html b/docs/interfaces/client_api.TradesApiInterface.html new file mode 100644 index 00000000..bbe5b749 --- /dev/null +++ b/docs/interfaces/client_api.TradesApiInterface.html @@ -0,0 +1,35 @@ +TradesApiInterface | @coinbase/coinbase-sdk

    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

    • 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 AxiosPromise<Trade>

      Summary

      Broadcast a trade

      +

      Throws

      Memberof

      TradesApiInterface

      +
    • 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

      +
    • 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

      +
    • 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&#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<TradeList>

      Summary

      List trades for an address.

      +

      Throws

      Memberof

      TradesApiInterface

      +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.Transaction.html b/docs/interfaces/client_api.Transaction.html new file mode 100644 index 00000000..4518da8b --- /dev/null +++ b/docs/interfaces/client_api.Transaction.html @@ -0,0 +1,21 @@ +Transaction | @coinbase/coinbase-sdk

    An onchain transaction.

    +

    Export

    Transaction

    +
    interface Transaction {
        from_address_id: string;
        network_id: string;
        signed_payload?: string;
        status: TransactionStatusEnum;
        transaction_hash?: string;
        unsigned_payload: string;
    }

    Properties

    from_address_id: string

    The onchain address of the sender

    +

    Memberof

    Transaction

    +
    network_id: string

    The ID of the blockchain network

    +

    Memberof

    Transaction

    +
    signed_payload?: string

    The signed payload of the transaction. This is the payload that has been signed by the sender.

    +

    Memberof

    Transaction

    +

    The status of the transaction

    +

    Memberof

    Transaction

    +
    transaction_hash?: string

    The hash of the transaction

    +

    Memberof

    Transaction

    +
    unsigned_payload: string

    The unsigned payload of the transaction. This is the payload that needs to be signed by the sender.

    +

    Memberof

    Transaction

    +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.Transfer.html b/docs/interfaces/client_api.Transfer.html index 6002c24a..59d39226 100644 --- a/docs/interfaces/client_api.Transfer.html +++ b/docs/interfaces/client_api.Transfer.html @@ -1,6 +1,6 @@ Transfer | @coinbase/coinbase-sdk

    A transfer of an asset from one address to another

    Export

    Transfer

    -
    interface Transfer {
        address_id: string;
        amount: string;
        asset_id: string;
        destination: string;
        network_id: string;
        signed_payload?: string;
        status: TransferStatusEnum;
        transaction_hash?: string;
        transfer_id: string;
        unsigned_payload: string;
        wallet_id: string;
    }

    Properties

    interface Transfer {
        address_id: string;
        amount: string;
        asset_id: string;
        destination: string;
        network_id: string;
        signed_payload?: string;
        status: TransferStatusEnum;
        transaction_hash?: string;
        transfer_id: string;
        unsigned_payload: string;
        wallet_id: string;
    }

    Properties

    Properties

    address_id: string

    The onchain address of the sender

    Memberof

    Transfer

    -
    amount: string

    The amount in the atomic units of the asset

    +
    amount: string

    The amount in the atomic units of the asset

    Memberof

    Transfer

    -
    asset_id: string

    The ID of the asset being transferred

    +
    asset_id: string

    The ID of the asset being transferred

    Memberof

    Transfer

    -
    destination: string

    The onchain address of the recipient

    +
    destination: string

    The onchain address of the recipient

    Memberof

    Transfer

    -
    network_id: string

    The ID of the blockchain network

    +
    network_id: string

    The ID of the blockchain network

    Memberof

    Transfer

    -
    signed_payload?: string

    The signed payload of the transfer. This is the payload that has been signed by the sender.

    +
    signed_payload?: string

    The signed payload of the transfer. This is the payload that has been signed by the sender.

    Memberof

    Transfer

    -

    The status of the transfer

    +

    The status of the transfer

    Memberof

    Transfer

    -
    transaction_hash?: string

    The hash of the transfer transaction

    +
    transaction_hash?: string

    The hash of the transfer transaction

    Memberof

    Transfer

    -
    transfer_id: string

    The ID of the transfer

    +
    transfer_id: string

    The ID of the transfer

    Memberof

    Transfer

    -
    unsigned_payload: string

    The unsigned payload of the transfer. This is the payload that needs to be signed by the sender.

    +
    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: string

    The ID of the wallet that owns the from address

    +
    wallet_id: string

    The ID of the wallet that owns the from address

    Memberof

    Transfer

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.TransferList.html b/docs/interfaces/client_api.TransferList.html index 9ea5e8f8..030bb61e 100644 --- a/docs/interfaces/client_api.TransferList.html +++ b/docs/interfaces/client_api.TransferList.html @@ -1,13 +1,13 @@ TransferList | @coinbase/coinbase-sdk

    Export

    TransferList

    -
    interface TransferList {
        data: Transfer[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    interface TransferList {
        data: Transfer[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data: Transfer[]

    Memberof

    TransferList

    -
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    TransferList

    -
    next_page: string

    The page token to be used to fetch the next page.

    +
    next_page: string

    The page token to be used to fetch the next page.

    Memberof

    TransferList

    -
    total_count: number

    The total number of transfers for the address in the wallet.

    +
    total_count: number

    The total number of transfers for the address in the wallet.

    Memberof

    TransferList

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.TransfersApiInterface.html b/docs/interfaces/client_api.TransfersApiInterface.html new file mode 100644 index 00000000..130b53d7 --- /dev/null +++ b/docs/interfaces/client_api.TransfersApiInterface.html @@ -0,0 +1,35 @@ +TransfersApiInterface | @coinbase/coinbase-sdk

    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

    • 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 AxiosPromise<Transfer>

      Summary

      Broadcast a transfer

      +

      Throws

      Memberof

      TransfersApiInterface

      +
    • 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

      +
    • 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

      +
    • 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.

        +
      • 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<TransferList>

      Summary

      List transfers for an address.

      +

      Throws

      Memberof

      TransfersApiInterface

      +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.User.html b/docs/interfaces/client_api.User.html index 15169907..3b74a1ee 100644 --- a/docs/interfaces/client_api.User.html +++ b/docs/interfaces/client_api.User.html @@ -1,7 +1,7 @@ User | @coinbase/coinbase-sdk

    Export

    User

    -
    interface User {
        display_name?: string;
        id: string;
    }

    Properties

    interface User {
        display_name?: string;
        id: string;
    }

    Properties

    Properties

    display_name?: string

    Memberof

    User

    -
    id: string

    The ID of the user

    +
    id: string

    The ID of the user

    Memberof

    User

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.UsersApiInterface.html b/docs/interfaces/client_api.UsersApiInterface.html new file mode 100644 index 00000000..553b06b9 --- /dev/null +++ b/docs/interfaces/client_api.UsersApiInterface.html @@ -0,0 +1,8 @@ +UsersApiInterface | @coinbase/coinbase-sdk

    UsersApi - interface

    +

    Export

    UsersApi

    +
    interface UsersApiInterface {
        getCurrentUser(options?): AxiosPromise<User>;
    }

    Implemented by

    Methods

    • Get current user

      +

      Parameters

      • Optional options: RawAxiosRequestConfig

        Override http request option.

        +

      Returns AxiosPromise<User>

      Summary

      Get current user

      +

      Throws

      Memberof

      UsersApiInterface

      +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.Wallet.html b/docs/interfaces/client_api.Wallet.html index f6d0e7c7..83ab6c42 100644 --- a/docs/interfaces/client_api.Wallet.html +++ b/docs/interfaces/client_api.Wallet.html @@ -1,10 +1,13 @@ Wallet | @coinbase/coinbase-sdk

    Export

    Wallet

    -
    interface Wallet {
        default_address?: Address;
        id?: string;
        network_id: string;
    }

    Properties

    interface Wallet {
        default_address?: Address;
        id: string;
        network_id: string;
        server_signer_status?: WalletServerSignerStatusEnum;
    }

    Properties

    default_address?: Address

    Memberof

    Wallet

    -
    id?: string

    The server-assigned ID for the wallet.

    +
    id: string

    The server-assigned ID for the wallet.

    Memberof

    Wallet

    -
    network_id: string

    The ID of the blockchain network

    +
    network_id: string

    The ID of the blockchain network

    Memberof

    Wallet

    -
    \ No newline at end of file +
    server_signer_status?: WalletServerSignerStatusEnum

    The status of the Server-Signer for the wallet if present.

    +

    Memberof

    Wallet

    +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.WalletList.html b/docs/interfaces/client_api.WalletList.html index 28e772a6..dbe900f7 100644 --- a/docs/interfaces/client_api.WalletList.html +++ b/docs/interfaces/client_api.WalletList.html @@ -1,14 +1,14 @@ WalletList | @coinbase/coinbase-sdk

    Paginated list of wallets

    Export

    WalletList

    -
    interface WalletList {
        data: Wallet[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    interface WalletList {
        data: Wallet[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data: Wallet[]

    Memberof

    WalletList

    -
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    WalletList

    -
    next_page: string

    The page token to be used to fetch the next page.

    +
    next_page: string

    The page token to be used to fetch the next page.

    Memberof

    WalletList

    -
    total_count: number

    The total number of wallets

    +
    total_count: number

    The total number of wallets

    Memberof

    WalletList

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.WalletsApiInterface.html b/docs/interfaces/client_api.WalletsApiInterface.html new file mode 100644 index 00000000..b1bd17e0 --- /dev/null +++ b/docs/interfaces/client_api.WalletsApiInterface.html @@ -0,0 +1,34 @@ +WalletsApiInterface | @coinbase/coinbase-sdk

    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

    • Create a new wallet scoped to the user.

      +

      Parameters

      • Optional createWalletRequest: CreateWalletRequest
      • Optional options: RawAxiosRequestConfig

        Override http request option.

        +

      Returns AxiosPromise<Wallet>

      Summary

      Create a new wallet

      +

      Throws

      Memberof

      WalletsApiInterface

      +
    • 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

      +
    • 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

      +
    • 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

      +
    • 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

      +
    \ No newline at end of file diff --git a/docs/interfaces/client_base.RequestArgs.html b/docs/interfaces/client_base.RequestArgs.html index 40c95ccd..bccd3c84 100644 --- a/docs/interfaces/client_base.RequestArgs.html +++ b/docs/interfaces/client_base.RequestArgs.html @@ -1,4 +1,4 @@ RequestArgs | @coinbase/coinbase-sdk

    Export

    RequestArgs

    -
    interface RequestArgs {
        options: RawAxiosRequestConfig;
        url: string;
    }

    Properties

    interface RequestArgs {
        options: RawAxiosRequestConfig;
        url: string;
    }

    Properties

    Properties

    options: RawAxiosRequestConfig
    url: string
    \ No newline at end of file +

    Properties

    options: RawAxiosRequestConfig
    url: string
    \ No newline at end of file diff --git a/docs/interfaces/client_configuration.ConfigurationParameters.html b/docs/interfaces/client_configuration.ConfigurationParameters.html index e24dcfa1..598ba90c 100644 --- a/docs/interfaces/client_configuration.ConfigurationParameters.html +++ b/docs/interfaces/client_configuration.ConfigurationParameters.html @@ -5,7 +5,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

    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?: 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>

    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>

    baseOptions?: any
    basePath?: string
    formDataCtor?: (new () => any)

    Type declaration

      • new (): any
      • Returns any

    password?: string
    serverIndex?: number
    username?: string
    \ No newline at end of file +

    Properties

    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>

    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>

    baseOptions?: any
    basePath?: string
    formDataCtor?: (new () => any)

    Type declaration

      • new (): any
      • Returns any

    password?: string
    serverIndex?: number
    username?: string
    \ No newline at end of file diff --git a/docs/modules/client.html b/docs/modules/client.html index 720d2652..b48e8389 100644 --- a/docs/modules/client.html +++ b/docs/modules/client.html @@ -1,20 +1,48 @@ -client | @coinbase/coinbase-sdk

    References

    Address +client | @coinbase/coinbase-sdk

    References

    Re-exports Address
    Re-exports AddressBalanceList
    Re-exports AddressList
    Re-exports AddressesApi
    Re-exports AddressesApiAxiosParamCreator
    Re-exports AddressesApiFactory
    Re-exports AddressesApiFp
    Re-exports Asset
    Re-exports Balance
    Re-exports BroadcastTransferRequest
    Re-exports Configuration
    Re-exports ConfigurationParameters
    Re-exports CreateAddressRequest
    Re-exports CreateTransferRequest
    Re-exports CreateWalletRequest
    Re-exports FaucetTransaction
    Re-exports ModelError
    Re-exports Transfer
    Re-exports TransferList
    Re-exports TransferStatusEnum
    Re-exports TransfersApi
    Re-exports TransfersApiAxiosParamCreator
    Re-exports TransfersApiFactory
    Re-exports TransfersApiFp
    Re-exports User
    Re-exports UsersApi
    Re-exports UsersApiAxiosParamCreator
    Re-exports UsersApiFactory
    Re-exports UsersApiFp
    Re-exports Wallet
    Re-exports WalletList
    Re-exports WalletsApi
    Re-exports WalletsApiAxiosParamCreator
    Re-exports WalletsApiFactory
    Re-exports WalletsApiFp
    \ No newline at end of file +WalletsApiInterface +

    References

    Re-exports Address
    Re-exports AddressBalanceList
    Re-exports AddressList
    Re-exports AddressesApi
    Re-exports AddressesApiAxiosParamCreator
    Re-exports AddressesApiFactory
    Re-exports AddressesApiFp
    Re-exports AddressesApiInterface
    Re-exports Asset
    Re-exports Balance
    Re-exports BroadcastTradeRequest
    Re-exports BroadcastTransferRequest
    Re-exports Configuration
    Re-exports ConfigurationParameters
    Re-exports CreateAddressRequest
    Re-exports CreateServerSignerRequest
    Re-exports CreateTradeRequest
    Re-exports CreateTransferRequest
    Re-exports CreateWalletRequest
    Re-exports CreateWalletRequestWallet
    Re-exports FaucetTransaction
    Re-exports ModelError
    Re-exports SeedCreationEvent
    Re-exports SeedCreationEventResult
    Re-exports ServerSigner
    Re-exports ServerSignerEvent
    Re-exports ServerSignerEventEvent
    Re-exports ServerSignerEventList
    Re-exports ServerSignersApi
    Re-exports ServerSignersApiAxiosParamCreator
    Re-exports ServerSignersApiFactory
    Re-exports ServerSignersApiFp
    Re-exports ServerSignersApiInterface
    Re-exports SignatureCreationEvent
    Re-exports SignatureCreationEventResult
    Re-exports Trade
    Re-exports TradeList
    Re-exports TradesApi
    Re-exports TradesApiAxiosParamCreator
    Re-exports TradesApiFactory
    Re-exports TradesApiFp
    Re-exports TradesApiInterface
    Re-exports Transaction
    Re-exports TransactionStatusEnum
    Re-exports TransactionType
    Re-exports Transfer
    Re-exports TransferList
    Re-exports TransferStatusEnum
    Re-exports TransfersApi
    Re-exports TransfersApiAxiosParamCreator
    Re-exports TransfersApiFactory
    Re-exports TransfersApiFp
    Re-exports TransfersApiInterface
    Re-exports User
    Re-exports UsersApi
    Re-exports UsersApiAxiosParamCreator
    Re-exports UsersApiFactory
    Re-exports UsersApiFp
    Re-exports UsersApiInterface
    Re-exports Wallet
    Re-exports WalletList
    Re-exports WalletServerSignerStatusEnum
    Re-exports WalletsApi
    Re-exports WalletsApiAxiosParamCreator
    Re-exports WalletsApiFactory
    Re-exports WalletsApiFp
    Re-exports WalletsApiInterface
    \ No newline at end of file diff --git a/docs/modules/client_api.html b/docs/modules/client_api.html index 1e1d1a0c..d6fa21d1 100644 --- a/docs/modules/client_api.html +++ b/docs/modules/client_api.html @@ -1,28 +1,62 @@ -client/api | @coinbase/coinbase-sdk

    Index

    Classes

    AddressesApi +client/api | @coinbase/coinbase-sdk

    Index

    Enumerations

    Classes

    Interfaces

    Type Aliases

    Variables

    Type Aliases

    Variables

    Functions

    AddressesApiAxiosParamCreator AddressesApiFactory AddressesApiFp +ServerSignersApiAxiosParamCreator +ServerSignersApiFactory +ServerSignersApiFp +TradesApiAxiosParamCreator +TradesApiFactory +TradesApiFp TransfersApiAxiosParamCreator TransfersApiFactory TransfersApiFp diff --git a/docs/modules/client_base.html b/docs/modules/client_base.html index 745db200..cf1df197 100644 --- a/docs/modules/client_base.html +++ b/docs/modules/client_base.html @@ -1,4 +1,4 @@ -client/base | @coinbase/coinbase-sdk

    Index

    Classes

    BaseAPI +client/base | @coinbase/coinbase-sdk

    Index

    Classes

    Interfaces

    Variables

    BASE_PATH diff --git a/docs/modules/client_common.html b/docs/modules/client_common.html index b4b3502b..ac42b33d 100644 --- a/docs/modules/client_common.html +++ b/docs/modules/client_common.html @@ -1,4 +1,4 @@ -client/common | @coinbase/coinbase-sdk

    Index

    Variables

    DUMMY_BASE_URL +client/common | @coinbase/coinbase-sdk

    Index

    Variables

    Functions

    assertParamExists createRequestFunction serializeDataIfNeeded diff --git a/docs/modules/client_configuration.html b/docs/modules/client_configuration.html index b09f56a7..f8f3e767 100644 --- a/docs/modules/client_configuration.html +++ b/docs/modules/client_configuration.html @@ -1,3 +1,3 @@ -client/configuration | @coinbase/coinbase-sdk

    Index

    Classes

    Configuration +client/configuration | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase.html b/docs/modules/coinbase.html index 81bd6a8e..669feaf7 100644 --- a/docs/modules/coinbase.html +++ b/docs/modules/coinbase.html @@ -1,2 +1,2 @@ -coinbase | @coinbase/coinbase-sdk

    References

    Coinbase +coinbase | @coinbase/coinbase-sdk

    References

    References

    Re-exports Coinbase
    \ No newline at end of file diff --git a/docs/modules/coinbase_address.html b/docs/modules/coinbase_address.html index a011d6a8..22ee0ca6 100644 --- a/docs/modules/coinbase_address.html +++ b/docs/modules/coinbase_address.html @@ -1,2 +1,2 @@ -coinbase/address | @coinbase/coinbase-sdk

    Index

    Classes

    Address +coinbase/address | @coinbase/coinbase-sdk

    Index

    Classes

    \ No newline at end of file diff --git a/docs/modules/coinbase_api_error.html b/docs/modules/coinbase_api_error.html index 9d0b64fc..fbbb3bc9 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

    Index

    Classes

    APIError +coinbase/api_error | @coinbase/coinbase-sdk

    Index

    Classes

    APIError AlreadyExistsError FaucetLimitReachedError InvalidAddressError diff --git a/docs/modules/coinbase_asset.html b/docs/modules/coinbase_asset.html index 70b4066e..1023238c 100644 --- a/docs/modules/coinbase_asset.html +++ b/docs/modules/coinbase_asset.html @@ -1,2 +1,2 @@ -coinbase/asset | @coinbase/coinbase-sdk

    Index

    Classes

    Asset +coinbase/asset | @coinbase/coinbase-sdk

    Index

    Classes

    \ No newline at end of file diff --git a/docs/modules/coinbase_authenticator.html b/docs/modules/coinbase_authenticator.html index fb1b061e..1456ff32 100644 --- a/docs/modules/coinbase_authenticator.html +++ b/docs/modules/coinbase_authenticator.html @@ -1,2 +1,2 @@ -coinbase/authenticator | @coinbase/coinbase-sdk

    Index

    Classes

    CoinbaseAuthenticator +coinbase/authenticator | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_balance.html b/docs/modules/coinbase_balance.html index 5ba7c195..58c0439f 100644 --- a/docs/modules/coinbase_balance.html +++ b/docs/modules/coinbase_balance.html @@ -1,2 +1,2 @@ -coinbase/balance | @coinbase/coinbase-sdk

    Index

    Classes

    Balance +coinbase/balance | @coinbase/coinbase-sdk

    Index

    Classes

    \ No newline at end of file diff --git a/docs/modules/coinbase_balance_map.html b/docs/modules/coinbase_balance_map.html index dc93eab5..2c8cc284 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

    Index

    Classes

    BalanceMap +coinbase/balance_map | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_coinbase.html b/docs/modules/coinbase_coinbase.html index e29a3821..b29b9e5d 100644 --- a/docs/modules/coinbase_coinbase.html +++ b/docs/modules/coinbase_coinbase.html @@ -1,2 +1,2 @@ -coinbase/coinbase | @coinbase/coinbase-sdk

    Index

    Classes

    Coinbase +coinbase/coinbase | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_constants.html b/docs/modules/coinbase_constants.html index 845ec12a..9b261b98 100644 --- a/docs/modules/coinbase_constants.html +++ b/docs/modules/coinbase_constants.html @@ -1,4 +1,4 @@ -coinbase/constants | @coinbase/coinbase-sdk

    Index

    Variables

    ATOMIC_UNITS_PER_USDC +coinbase/constants | @coinbase/coinbase-sdk

    Index

    Variables

    ATOMIC_UNITS_PER_USDC GWEI_PER_ETHER WEI_PER_ETHER WEI_PER_GWEI diff --git a/docs/modules/coinbase_errors.html b/docs/modules/coinbase_errors.html index f121d667..d37f5647 100644 --- a/docs/modules/coinbase_errors.html +++ b/docs/modules/coinbase_errors.html @@ -1,4 +1,4 @@ -coinbase/errors | @coinbase/coinbase-sdk

    Index

    Classes

    ArgumentError +coinbase/errors | @coinbase/coinbase-sdk

    Index

    Classes

    ArgumentError InternalError InvalidAPIKeyFormat InvalidConfiguration diff --git a/docs/modules/coinbase_faucet_transaction.html b/docs/modules/coinbase_faucet_transaction.html index 5b4b22f0..c7022ab1 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
    \ No newline at end of file diff --git a/docs/modules/coinbase_tests_address_test.html b/docs/modules/coinbase_tests_address_test.html index c11b5237..1541ad23 100644 --- a/docs/modules/coinbase_tests_address_test.html +++ b/docs/modules/coinbase_tests_address_test.html @@ -1 +1 @@ -coinbase/tests/address_test | @coinbase/coinbase-sdk
    \ No newline at end of file +coinbase/tests/address_test | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_tests_authenticator_test.html b/docs/modules/coinbase_tests_authenticator_test.html index a1c2e606..3d45db97 100644 --- a/docs/modules/coinbase_tests_authenticator_test.html +++ b/docs/modules/coinbase_tests_authenticator_test.html @@ -1 +1 @@ -coinbase/tests/authenticator_test | @coinbase/coinbase-sdk
    \ No newline at end of file +coinbase/tests/authenticator_test | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_tests_balance_map_test.html b/docs/modules/coinbase_tests_balance_map_test.html index 1b339096..712d8c44 100644 --- a/docs/modules/coinbase_tests_balance_map_test.html +++ b/docs/modules/coinbase_tests_balance_map_test.html @@ -1 +1 @@ -coinbase/tests/balance_map_test | @coinbase/coinbase-sdk
    \ No newline at end of file +coinbase/tests/balance_map_test | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_tests_balance_test.html b/docs/modules/coinbase_tests_balance_test.html index a8505cff..a15b496a 100644 --- a/docs/modules/coinbase_tests_balance_test.html +++ b/docs/modules/coinbase_tests_balance_test.html @@ -1 +1 @@ -coinbase/tests/balance_test | @coinbase/coinbase-sdk
    \ No newline at end of file +coinbase/tests/balance_test | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_tests_coinbase_test.html b/docs/modules/coinbase_tests_coinbase_test.html index 5ae25370..1473cf49 100644 --- a/docs/modules/coinbase_tests_coinbase_test.html +++ b/docs/modules/coinbase_tests_coinbase_test.html @@ -1 +1 @@ -coinbase/tests/coinbase_test | @coinbase/coinbase-sdk
    \ No newline at end of file +coinbase/tests/coinbase_test | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_tests_faucet_transaction_test.html b/docs/modules/coinbase_tests_faucet_transaction_test.html index 1fdab321..b385d306 100644 --- a/docs/modules/coinbase_tests_faucet_transaction_test.html +++ b/docs/modules/coinbase_tests_faucet_transaction_test.html @@ -1 +1 @@ -coinbase/tests/faucet_transaction_test | @coinbase/coinbase-sdk
    \ No newline at end of file +coinbase/tests/faucet_transaction_test | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_tests_transfer_test.html b/docs/modules/coinbase_tests_transfer_test.html index f03ffacb..a77f966e 100644 --- a/docs/modules/coinbase_tests_transfer_test.html +++ b/docs/modules/coinbase_tests_transfer_test.html @@ -1 +1 @@ -coinbase/tests/transfer_test | @coinbase/coinbase-sdk
    \ No newline at end of file +coinbase/tests/transfer_test | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_tests_user_test.html b/docs/modules/coinbase_tests_user_test.html index 495b6e4b..f53b02d1 100644 --- a/docs/modules/coinbase_tests_user_test.html +++ b/docs/modules/coinbase_tests_user_test.html @@ -1 +1 @@ -coinbase/tests/user_test | @coinbase/coinbase-sdk
    \ No newline at end of file +coinbase/tests/user_test | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_tests_utils.html b/docs/modules/coinbase_tests_utils.html index 8cfbc3ae..8208e8ef 100644 --- a/docs/modules/coinbase_tests_utils.html +++ b/docs/modules/coinbase_tests_utils.html @@ -1,4 +1,4 @@ -coinbase/tests/utils | @coinbase/coinbase-sdk

    Index

    Variables

    VALID_ADDRESS_BALANCE_LIST +coinbase/tests/utils | @coinbase/coinbase-sdk

    Index

    Variables

    VALID_ADDRESS_BALANCE_LIST VALID_ADDRESS_MODEL VALID_BALANCE_MODEL VALID_TRANSFER_MODEL diff --git a/docs/modules/coinbase_tests_wallet_test.html b/docs/modules/coinbase_tests_wallet_test.html index df1f7645..a9363063 100644 --- a/docs/modules/coinbase_tests_wallet_test.html +++ b/docs/modules/coinbase_tests_wallet_test.html @@ -1 +1 @@ -coinbase/tests/wallet_test | @coinbase/coinbase-sdk
    \ No newline at end of file +coinbase/tests/wallet_test | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_transfer.html b/docs/modules/coinbase_transfer.html index e5e6f8ce..0c7db21c 100644 --- a/docs/modules/coinbase_transfer.html +++ b/docs/modules/coinbase_transfer.html @@ -1,2 +1,2 @@ -coinbase/transfer | @coinbase/coinbase-sdk

    Index

    Classes

    Transfer +coinbase/transfer | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_types.html b/docs/modules/coinbase_types.html index 4a75a730..d2214a59 100644 --- a/docs/modules/coinbase_types.html +++ b/docs/modules/coinbase_types.html @@ -1,7 +1,10 @@ -coinbase/types | @coinbase/coinbase-sdk

    Index

    Enumerations

    TransferStatus +coinbase/types | @coinbase/coinbase-sdk

    Index

    Enumerations

    Type Aliases

    AddressAPIClient Amount ApiClients +CoinbaseConfigureFromJsonOptions +CoinbaseOptions Destination SeedData TransferAPIClient diff --git a/docs/modules/coinbase_user.html b/docs/modules/coinbase_user.html index 55e61b94..34ec6a8e 100644 --- a/docs/modules/coinbase_user.html +++ b/docs/modules/coinbase_user.html @@ -1,2 +1,2 @@ -coinbase/user | @coinbase/coinbase-sdk

    Index

    Classes

    User +coinbase/user | @coinbase/coinbase-sdk

    Index

    Classes

    \ No newline at end of file diff --git a/docs/modules/coinbase_utils.html b/docs/modules/coinbase_utils.html index 4c64066b..ccc92db0 100644 --- a/docs/modules/coinbase_utils.html +++ b/docs/modules/coinbase_utils.html @@ -1,4 +1,4 @@ -coinbase/utils | @coinbase/coinbase-sdk

    Index

    Functions

    convertStringToHex +coinbase/utils | @coinbase/coinbase-sdk

    Index

    Functions

    convertStringToHex delay destinationToAddressHexString logApiResponse diff --git a/docs/modules/coinbase_wallet.html b/docs/modules/coinbase_wallet.html index 3757ff7c..7d96d84e 100644 --- a/docs/modules/coinbase_wallet.html +++ b/docs/modules/coinbase_wallet.html @@ -1,2 +1,2 @@ -coinbase/wallet | @coinbase/coinbase-sdk

    Index

    Classes

    Wallet +coinbase/wallet | @coinbase/coinbase-sdk

    Index

    Classes

    \ No newline at end of file diff --git a/docs/types/client_api.ServerSignerEventEvent.html b/docs/types/client_api.ServerSignerEventEvent.html new file mode 100644 index 00000000..171175fc --- /dev/null +++ b/docs/types/client_api.ServerSignerEventEvent.html @@ -0,0 +1 @@ +ServerSignerEventEvent | @coinbase/coinbase-sdk
    ServerSignerEventEvent: SeedCreationEvent | SignatureCreationEvent

    Export

    \ No newline at end of file diff --git a/docs/types/client_api.TransactionStatusEnum.html b/docs/types/client_api.TransactionStatusEnum.html new file mode 100644 index 00000000..9b59ab72 --- /dev/null +++ b/docs/types/client_api.TransactionStatusEnum.html @@ -0,0 +1 @@ +TransactionStatusEnum | @coinbase/coinbase-sdk
    TransactionStatusEnum: typeof TransactionStatusEnum[keyof typeof TransactionStatusEnum]
    \ No newline at end of file diff --git a/docs/types/client_api.TransferStatusEnum.html b/docs/types/client_api.TransferStatusEnum.html index 3a74356d..004deafb 100644 --- a/docs/types/client_api.TransferStatusEnum.html +++ b/docs/types/client_api.TransferStatusEnum.html @@ -1 +1 @@ -TransferStatusEnum | @coinbase/coinbase-sdk
    TransferStatusEnum: typeof TransferStatusEnum[keyof typeof TransferStatusEnum]
    \ No newline at end of file +TransferStatusEnum | @coinbase/coinbase-sdk
    TransferStatusEnum: typeof TransferStatusEnum[keyof typeof TransferStatusEnum]
    \ No newline at end of file diff --git a/docs/types/client_api.WalletServerSignerStatusEnum.html b/docs/types/client_api.WalletServerSignerStatusEnum.html new file mode 100644 index 00000000..900ecf16 --- /dev/null +++ b/docs/types/client_api.WalletServerSignerStatusEnum.html @@ -0,0 +1 @@ +WalletServerSignerStatusEnum | @coinbase/coinbase-sdk
    WalletServerSignerStatusEnum: typeof WalletServerSignerStatusEnum[keyof typeof WalletServerSignerStatusEnum]
    \ No newline at end of file diff --git a/docs/types/coinbase_types.AddressAPIClient.html b/docs/types/coinbase_types.AddressAPIClient.html index 3f8c930e..bae52f07 100644 --- a/docs/types/coinbase_types.AddressAPIClient.html +++ b/docs/types/coinbase_types.AddressAPIClient.html @@ -1,30 +1,30 @@ AddressAPIClient | @coinbase/coinbase-sdk
    AddressAPIClient: {
        createAddress(walletId, createAddressRequest?, options?): AxiosPromise<Address>;
        getAddress(walletId, addressId, options?): AxiosPromise<Address>;
        getAddressBalance(walletId, addressId, assetId, options?): AxiosPromise<Balance>;
        listAddressBalances(walletId, addressId, page?, options?): AxiosPromise<AddressBalanceList>;
        listAddresses(walletId, limit?, page?, options?): AxiosPromise<AddressList>;
        requestFaucetFunds(walletId, addressId): Promise<{
            data: {
                transaction_hash: string;
            };
        }>;
    }

    AddressAPI client type definition.

    -

    Type declaration

    • createAddress:function
    • getAddress:function
      • Get address by onchain address.

        +

        Type declaration

        • createAddress:function
        • getAddress:function
          • 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
          • 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

        • listAddressBalances:function
          • Lists address balances

            +

        Returns AxiosPromise<Balance>

        Throws

    • listAddressBalances:function
      • 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
      • Lists addresses.

        +

    Returns AxiosPromise<AddressBalanceList>

    Throws

  • listAddresses:function
    • 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.

      -
  • requestFaucetFunds:function
    • Requests faucet funds for the address.

      +
  • requestFaucetFunds:function
    • Requests faucet funds for the address.

      Parameters

      • walletId: string

        The wallet ID.

      • addressId: string

        The address ID.

      Returns Promise<{
          data: {
              transaction_hash: string;
          };
      }>

      The transaction hash.

      Throws

      If the request fails.

      -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/coinbase_types.Amount.html b/docs/types/coinbase_types.Amount.html index ab2d45fd..11d6016e 100644 --- a/docs/types/coinbase_types.Amount.html +++ b/docs/types/coinbase_types.Amount.html @@ -1,2 +1,2 @@ Amount | @coinbase/coinbase-sdk
    Amount: number | bigint | Decimal

    Amount type definition.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/coinbase_types.ApiClients.html b/docs/types/coinbase_types.ApiClients.html index 2f09e7f4..2cd724f1 100644 --- a/docs/types/coinbase_types.ApiClients.html +++ b/docs/types/coinbase_types.ApiClients.html @@ -1,3 +1,3 @@ -ApiClients | @coinbase/coinbase-sdk
    ApiClients: {
        address?: AddressAPIClient;
        baseSepoliaProvider?: ethers.Provider;
        transfer?: TransferAPIClient;
        user?: UserAPIClient;
        wallet?: WalletAPIClient;
    }

    API clients type definition for the Coinbase SDK. +ApiClients | @coinbase/coinbase-sdk

    ApiClients: {
        address?: AddressAPIClient;
        transfer?: TransferAPIClient;
        user?: UserAPIClient;
        wallet?: WalletAPIClient;
    }

    API clients type definition for the Coinbase SDK. Represents the set of API clients available in the SDK.

    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/docs/types/coinbase_types.CoinbaseConfigureFromJsonOptions.html b/docs/types/coinbase_types.CoinbaseConfigureFromJsonOptions.html new file mode 100644 index 00000000..b1b3814b --- /dev/null +++ b/docs/types/coinbase_types.CoinbaseConfigureFromJsonOptions.html @@ -0,0 +1,5 @@ +CoinbaseConfigureFromJsonOptions | @coinbase/coinbase-sdk
    CoinbaseConfigureFromJsonOptions: {
        basePath?: string;
        debugging?: boolean;
        filePath: string;
        useServerSigner?: boolean;
    }

    Type declaration

    • Optional basePath?: string

      The base path for the API.

      +
    • Optional debugging?: boolean

      If true, logs API requests and responses to the console.

      +
    • 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.

      +
    \ No newline at end of file diff --git a/docs/types/coinbase_types.CoinbaseOptions.html b/docs/types/coinbase_types.CoinbaseOptions.html new file mode 100644 index 00000000..410c4695 --- /dev/null +++ b/docs/types/coinbase_types.CoinbaseOptions.html @@ -0,0 +1,7 @@ +CoinbaseOptions | @coinbase/coinbase-sdk
    CoinbaseOptions: {
        apiKeyName?: string;
        basePath?: string;
        debugging?: boolean;
        privateKey?: string;
        useServerSigner?: boolean;
    }

    CoinbaseOptions type definition.

    +

    Type declaration

    • Optional apiKeyName?: string

      The API key name.

      +
    • Optional basePath?: string

      The base path for the API.

      +
    • Optional debugging?: boolean

      If true, logs API requests and responses to the console.

      +
    • Optional privateKey?: string

      The private key associated with the API key.

      +
    • Optional useServerSigner?: boolean

      Whether to use a Server-Signer or not.

      +
    \ No newline at end of file diff --git a/docs/types/coinbase_types.Destination.html b/docs/types/coinbase_types.Destination.html index c03b43d5..dacff0b2 100644 --- a/docs/types/coinbase_types.Destination.html +++ b/docs/types/coinbase_types.Destination.html @@ -1,2 +1,2 @@ Destination | @coinbase/coinbase-sdk
    Destination: string | Address | Wallet

    Destination type definition.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/coinbase_types.SeedData.html b/docs/types/coinbase_types.SeedData.html index 17fc9f61..d13e621a 100644 --- a/docs/types/coinbase_types.SeedData.html +++ b/docs/types/coinbase_types.SeedData.html @@ -1,2 +1,2 @@ SeedData | @coinbase/coinbase-sdk
    SeedData: {
        authTag: string;
        encrypted: boolean;
        iv: string;
        seed: string;
    }

    The Seed Data type definition.

    -

    Type declaration

    • authTag: string
    • encrypted: boolean
    • iv: string
    • seed: string
    \ No newline at end of file +

    Type declaration

    • authTag: string
    • encrypted: boolean
    • iv: string
    • seed: string
    \ No newline at end of file diff --git a/docs/types/coinbase_types.TransferAPIClient.html b/docs/types/coinbase_types.TransferAPIClient.html index cf19f80d..a2635413 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
    • 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
    • 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
    • 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.

      -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/coinbase_types.UserAPIClient.html b/docs/types/coinbase_types.UserAPIClient.html index 88999bcc..e0c282bd 100644 --- a/docs/types/coinbase_types.UserAPIClient.html +++ b/docs/types/coinbase_types.UserAPIClient.html @@ -5,4 +5,4 @@
  • A promise resolvindg to the User model.
  • Throws

    If the request fails.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/coinbase_types.WalletAPIClient.html b/docs/types/coinbase_types.WalletAPIClient.html index 13239a50..2e0faeed 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
    • 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>

      Throws

      If the required parameter is not provided.

      Throws

      If the request fails.

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

      +
    • 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>

      Throws

      If the required parameter is not provided.

      Throws

      If the request fails.

      -
  • listWallets:function
  • listWallets:function
    • 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>

      Throws

      If the request fails.

      Throws

      If the required parameter is not provided.

      -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/coinbase_types.WalletData.html b/docs/types/coinbase_types.WalletData.html index 0dcf67c1..8d7b18de 100644 --- a/docs/types/coinbase_types.WalletData.html +++ b/docs/types/coinbase_types.WalletData.html @@ -1,3 +1,3 @@ WalletData | @coinbase/coinbase-sdk
    WalletData: {
        seed: string;
        walletId: string;
    }

    The Wallet Data type definition. The data required to recreate a Wallet.

    -

    Type declaration

    • seed: string
    • walletId: string
    \ No newline at end of file +

    Type declaration

    • seed: string
    • walletId: string
    \ No newline at end of file diff --git a/docs/variables/client_api.TransactionStatusEnum-1.html b/docs/variables/client_api.TransactionStatusEnum-1.html new file mode 100644 index 00000000..7dc88dab --- /dev/null +++ b/docs/variables/client_api.TransactionStatusEnum-1.html @@ -0,0 +1 @@ +TransactionStatusEnum | @coinbase/coinbase-sdk

    Variable TransactionStatusEnumConst

    TransactionStatusEnum: {
        Broadcast: "broadcast";
        Complete: "complete";
        Failed: "failed";
        Pending: "pending";
    } = ...

    Type declaration

    • Readonly Broadcast: "broadcast"
    • Readonly Complete: "complete"
    • Readonly Failed: "failed"
    • Readonly Pending: "pending"
    \ 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 f8f45439..8d82ddf9 100644 --- a/docs/variables/client_api.TransferStatusEnum-1.html +++ b/docs/variables/client_api.TransferStatusEnum-1.html @@ -1 +1 @@ -TransferStatusEnum | @coinbase/coinbase-sdk
    TransferStatusEnum: {
        Broadcast: "broadcast";
        Complete: "complete";
        Failed: "failed";
        Pending: "pending";
    } = ...

    Type declaration

    • Readonly Broadcast: "broadcast"
    • Readonly Complete: "complete"
    • Readonly Failed: "failed"
    • Readonly Pending: "pending"
    \ No newline at end of file +TransferStatusEnum | @coinbase/coinbase-sdk
    TransferStatusEnum: {
        Broadcast: "broadcast";
        Complete: "complete";
        Failed: "failed";
        Pending: "pending";
    } = ...

    Type declaration

    • Readonly Broadcast: "broadcast"
    • Readonly Complete: "complete"
    • Readonly Failed: "failed"
    • Readonly Pending: "pending"
    \ No newline at end of file diff --git a/docs/variables/client_api.WalletServerSignerStatusEnum-1.html b/docs/variables/client_api.WalletServerSignerStatusEnum-1.html new file mode 100644 index 00000000..7c648dc8 --- /dev/null +++ b/docs/variables/client_api.WalletServerSignerStatusEnum-1.html @@ -0,0 +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"
    \ 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 a8f9f67c..2886bbb6 100644 --- a/docs/variables/client_base.BASE_PATH.html +++ b/docs/variables/client_base.BASE_PATH.html @@ -1 +1 @@ -BASE_PATH | @coinbase/coinbase-sdk
    BASE_PATH: string = ...
    \ No newline at end of file +BASE_PATH | @coinbase/coinbase-sdk
    BASE_PATH: string = ...
    \ 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 10c3678f..552a94d0 100644 --- a/docs/variables/client_base.COLLECTION_FORMATS.html +++ b/docs/variables/client_base.COLLECTION_FORMATS.html @@ -1 +1 @@ -COLLECTION_FORMATS | @coinbase/coinbase-sdk
    COLLECTION_FORMATS: {
        csv: string;
        pipes: string;
        ssv: string;
        tsv: string;
    } = ...

    Type declaration

    • csv: string
    • pipes: string
    • ssv: string
    • tsv: string

    Export

    \ No newline at end of file +COLLECTION_FORMATS | @coinbase/coinbase-sdk
    COLLECTION_FORMATS: {
        csv: string;
        pipes: string;
        ssv: string;
        tsv: string;
    } = ...

    Type declaration

    • csv: string
    • pipes: string
    • ssv: string
    • tsv: string

    Export

    \ No newline at end of file diff --git a/docs/variables/client_base.operationServerMap.html b/docs/variables/client_base.operationServerMap.html index 3f2aa626..2da857cc 100644 --- a/docs/variables/client_base.operationServerMap.html +++ b/docs/variables/client_base.operationServerMap.html @@ -1 +1 @@ -operationServerMap | @coinbase/coinbase-sdk
    operationServerMap: ServerMap = {}

    Export

    \ No newline at end of file +operationServerMap | @coinbase/coinbase-sdk
    operationServerMap: ServerMap = {}

    Export

    \ 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 0d289fe3..a4ad4228 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
    DUMMY_BASE_URL: "https://example.com" = "https://example.com"

    Export

    \ No newline at end of file +DUMMY_BASE_URL | @coinbase/coinbase-sdk
    DUMMY_BASE_URL: "https://example.com" = "https://example.com"

    Export

    \ No newline at end of file diff --git a/docs/variables/coinbase_constants.ATOMIC_UNITS_PER_USDC.html b/docs/variables/coinbase_constants.ATOMIC_UNITS_PER_USDC.html index f4a6e9f7..7d4c1b52 100644 --- a/docs/variables/coinbase_constants.ATOMIC_UNITS_PER_USDC.html +++ b/docs/variables/coinbase_constants.ATOMIC_UNITS_PER_USDC.html @@ -1 +1 @@ -ATOMIC_UNITS_PER_USDC | @coinbase/coinbase-sdk
    ATOMIC_UNITS_PER_USDC: Decimal = ...
    \ No newline at end of file +ATOMIC_UNITS_PER_USDC | @coinbase/coinbase-sdk
    ATOMIC_UNITS_PER_USDC: Decimal = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_constants.GWEI_PER_ETHER.html b/docs/variables/coinbase_constants.GWEI_PER_ETHER.html index 5e73d7aa..e5dd2b96 100644 --- a/docs/variables/coinbase_constants.GWEI_PER_ETHER.html +++ b/docs/variables/coinbase_constants.GWEI_PER_ETHER.html @@ -1 +1 @@ -GWEI_PER_ETHER | @coinbase/coinbase-sdk
    GWEI_PER_ETHER: Decimal = ...
    \ No newline at end of file +GWEI_PER_ETHER | @coinbase/coinbase-sdk
    GWEI_PER_ETHER: Decimal = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_constants.WEI_PER_ETHER.html b/docs/variables/coinbase_constants.WEI_PER_ETHER.html index 68ab139c..ff8f2930 100644 --- a/docs/variables/coinbase_constants.WEI_PER_ETHER.html +++ b/docs/variables/coinbase_constants.WEI_PER_ETHER.html @@ -1 +1 @@ -WEI_PER_ETHER | @coinbase/coinbase-sdk
    WEI_PER_ETHER: Decimal = ...
    \ No newline at end of file +WEI_PER_ETHER | @coinbase/coinbase-sdk
    WEI_PER_ETHER: Decimal = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_constants.WEI_PER_GWEI.html b/docs/variables/coinbase_constants.WEI_PER_GWEI.html index d703141d..18876ae8 100644 --- a/docs/variables/coinbase_constants.WEI_PER_GWEI.html +++ b/docs/variables/coinbase_constants.WEI_PER_GWEI.html @@ -1 +1 @@ -WEI_PER_GWEI | @coinbase/coinbase-sdk
    WEI_PER_GWEI: Decimal = ...
    \ No newline at end of file +WEI_PER_GWEI | @coinbase/coinbase-sdk
    WEI_PER_GWEI: Decimal = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.VALID_ADDRESS_BALANCE_LIST.html b/docs/variables/coinbase_tests_utils.VALID_ADDRESS_BALANCE_LIST.html index fd7b5112..81185edd 100644 --- a/docs/variables/coinbase_tests_utils.VALID_ADDRESS_BALANCE_LIST.html +++ b/docs/variables/coinbase_tests_utils.VALID_ADDRESS_BALANCE_LIST.html @@ -1 +1 @@ -VALID_ADDRESS_BALANCE_LIST | @coinbase/coinbase-sdk
    VALID_ADDRESS_BALANCE_LIST: AddressBalanceList = ...
    \ No newline at end of file +VALID_ADDRESS_BALANCE_LIST | @coinbase/coinbase-sdk
    VALID_ADDRESS_BALANCE_LIST: AddressBalanceList = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.VALID_ADDRESS_MODEL.html b/docs/variables/coinbase_tests_utils.VALID_ADDRESS_MODEL.html index 6de14907..32c1f1b3 100644 --- a/docs/variables/coinbase_tests_utils.VALID_ADDRESS_MODEL.html +++ b/docs/variables/coinbase_tests_utils.VALID_ADDRESS_MODEL.html @@ -1 +1 @@ -VALID_ADDRESS_MODEL | @coinbase/coinbase-sdk
    VALID_ADDRESS_MODEL: Address = ...
    \ No newline at end of file +VALID_ADDRESS_MODEL | @coinbase/coinbase-sdk
    VALID_ADDRESS_MODEL: Address = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.VALID_BALANCE_MODEL.html b/docs/variables/coinbase_tests_utils.VALID_BALANCE_MODEL.html index 453d3f4c..1d598555 100644 --- a/docs/variables/coinbase_tests_utils.VALID_BALANCE_MODEL.html +++ b/docs/variables/coinbase_tests_utils.VALID_BALANCE_MODEL.html @@ -1 +1 @@ -VALID_BALANCE_MODEL | @coinbase/coinbase-sdk
    VALID_BALANCE_MODEL: Balance = ...
    \ No newline at end of file +VALID_BALANCE_MODEL | @coinbase/coinbase-sdk
    VALID_BALANCE_MODEL: Balance = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.VALID_TRANSFER_MODEL.html b/docs/variables/coinbase_tests_utils.VALID_TRANSFER_MODEL.html index 45055fc0..1f0da069 100644 --- a/docs/variables/coinbase_tests_utils.VALID_TRANSFER_MODEL.html +++ b/docs/variables/coinbase_tests_utils.VALID_TRANSFER_MODEL.html @@ -1 +1 @@ -VALID_TRANSFER_MODEL | @coinbase/coinbase-sdk
    VALID_TRANSFER_MODEL: Transfer = ...
    \ No newline at end of file +VALID_TRANSFER_MODEL | @coinbase/coinbase-sdk
    VALID_TRANSFER_MODEL: Transfer = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.VALID_WALLET_MODEL.html b/docs/variables/coinbase_tests_utils.VALID_WALLET_MODEL.html index dff02c07..47cd1385 100644 --- a/docs/variables/coinbase_tests_utils.VALID_WALLET_MODEL.html +++ b/docs/variables/coinbase_tests_utils.VALID_WALLET_MODEL.html @@ -1 +1 @@ -VALID_WALLET_MODEL | @coinbase/coinbase-sdk
    VALID_WALLET_MODEL: Wallet = ...
    \ No newline at end of file +VALID_WALLET_MODEL | @coinbase/coinbase-sdk
    VALID_WALLET_MODEL: Wallet = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.addressesApiMock.html b/docs/variables/coinbase_tests_utils.addressesApiMock.html index 370c6db6..a2073c56 100644 --- a/docs/variables/coinbase_tests_utils.addressesApiMock.html +++ b/docs/variables/coinbase_tests_utils.addressesApiMock.html @@ -1 +1 @@ -addressesApiMock | @coinbase/coinbase-sdk
    addressesApiMock: {
        createAddress: Mock<any, any, any>;
        getAddress: Mock<any, any, any>;
        getAddressBalance: Mock<any, any, any>;
        listAddressBalances: Mock<any, any, any>;
        listAddresses: Mock<any, any, any>;
        requestFaucetFunds: Mock<any, any, any>;
    } = ...

    Type declaration

    • createAddress: Mock<any, any, any>
    • getAddress: Mock<any, any, any>
    • getAddressBalance: Mock<any, any, any>
    • listAddressBalances: Mock<any, any, any>
    • listAddresses: Mock<any, any, any>
    • requestFaucetFunds: Mock<any, any, any>
    \ No newline at end of file +addressesApiMock | @coinbase/coinbase-sdk
    addressesApiMock: {
        createAddress: Mock<any, any, any>;
        getAddress: Mock<any, any, any>;
        getAddressBalance: Mock<any, any, any>;
        listAddressBalances: Mock<any, any, any>;
        listAddresses: Mock<any, any, any>;
        requestFaucetFunds: Mock<any, any, any>;
    } = ...

    Type declaration

    • createAddress: Mock<any, any, any>
    • getAddress: Mock<any, any, any>
    • getAddressBalance: Mock<any, any, any>
    • listAddressBalances: Mock<any, any, any>
    • listAddresses: Mock<any, any, any>
    • requestFaucetFunds: Mock<any, any, any>
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.transferId.html b/docs/variables/coinbase_tests_utils.transferId.html index 8cc40221..cae7c4bc 100644 --- a/docs/variables/coinbase_tests_utils.transferId.html +++ b/docs/variables/coinbase_tests_utils.transferId.html @@ -1 +1 @@ -transferId | @coinbase/coinbase-sdk
    transferId: `${string}-${string}-${string}-${string}-${string}` = ...
    \ No newline at end of file +transferId | @coinbase/coinbase-sdk
    transferId: `${string}-${string}-${string}-${string}-${string}` = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.transfersApiMock.html b/docs/variables/coinbase_tests_utils.transfersApiMock.html index 5cac6a26..63e315aa 100644 --- a/docs/variables/coinbase_tests_utils.transfersApiMock.html +++ b/docs/variables/coinbase_tests_utils.transfersApiMock.html @@ -1 +1 @@ -transfersApiMock | @coinbase/coinbase-sdk
    transfersApiMock: {
        broadcastTransfer: Mock<any, any, any>;
        createTransfer: Mock<any, any, any>;
        getTransfer: Mock<any, any, any>;
        listTransfers: Mock<any, any, any>;
    } = ...

    Type declaration

    • broadcastTransfer: Mock<any, any, any>
    • createTransfer: Mock<any, any, any>
    • getTransfer: Mock<any, any, any>
    • listTransfers: Mock<any, any, any>
    \ No newline at end of file +transfersApiMock | @coinbase/coinbase-sdk
    transfersApiMock: {
        broadcastTransfer: Mock<any, any, any>;
        createTransfer: Mock<any, any, any>;
        getTransfer: Mock<any, any, any>;
        listTransfers: Mock<any, any, any>;
    } = ...

    Type declaration

    • broadcastTransfer: Mock<any, any, any>
    • createTransfer: Mock<any, any, any>
    • getTransfer: Mock<any, any, any>
    • listTransfers: Mock<any, any, any>
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.usersApiMock.html b/docs/variables/coinbase_tests_utils.usersApiMock.html index bae1ec27..8c310b9e 100644 --- a/docs/variables/coinbase_tests_utils.usersApiMock.html +++ b/docs/variables/coinbase_tests_utils.usersApiMock.html @@ -1 +1 @@ -usersApiMock | @coinbase/coinbase-sdk
    usersApiMock: {
        getCurrentUser: Mock<any, any, any>;
    } = ...

    Type declaration

    • getCurrentUser: Mock<any, any, any>
    \ No newline at end of file +usersApiMock | @coinbase/coinbase-sdk
    usersApiMock: {
        getCurrentUser: Mock<any, any, any>;
    } = ...

    Type declaration

    • getCurrentUser: Mock<any, any, any>
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.walletId.html b/docs/variables/coinbase_tests_utils.walletId.html index 284cc9a9..45de1085 100644 --- a/docs/variables/coinbase_tests_utils.walletId.html +++ b/docs/variables/coinbase_tests_utils.walletId.html @@ -1 +1 @@ -walletId | @coinbase/coinbase-sdk
    walletId: `${string}-${string}-${string}-${string}-${string}` = ...
    \ No newline at end of file +walletId | @coinbase/coinbase-sdk
    walletId: `${string}-${string}-${string}-${string}-${string}` = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.walletsApiMock.html b/docs/variables/coinbase_tests_utils.walletsApiMock.html index 0e046641..582ce8c4 100644 --- a/docs/variables/coinbase_tests_utils.walletsApiMock.html +++ b/docs/variables/coinbase_tests_utils.walletsApiMock.html @@ -1 +1 @@ -walletsApiMock | @coinbase/coinbase-sdk
    walletsApiMock: {
        createWallet: Mock<any, any, any>;
        getWallet: Mock<any, any, any>;
        getWalletBalance: Mock<any, any, any>;
        listWalletBalances: Mock<any, any, any>;
        listWallets: Mock<any, any, any>;
    } = ...

    Type declaration

    • createWallet: Mock<any, any, any>
    • getWallet: Mock<any, any, any>
    • getWalletBalance: Mock<any, any, any>
    • listWalletBalances: Mock<any, any, any>
    • listWallets: Mock<any, any, any>
    \ No newline at end of file +walletsApiMock | @coinbase/coinbase-sdk
    walletsApiMock: {
        createWallet: Mock<any, any, any>;
        getWallet: Mock<any, any, any>;
        getWalletBalance: Mock<any, any, any>;
        listWalletBalances: Mock<any, any, any>;
        listWallets: Mock<any, any, any>;
    } = ...

    Type declaration

    • createWallet: Mock<any, any, any>
    • getWallet: Mock<any, any, any>
    • getWalletBalance: Mock<any, any, any>
    • listWalletBalances: Mock<any, any, any>
    • listWallets: Mock<any, any, any>
    \ No newline at end of file diff --git a/src/coinbase/tests/coinbase_test.ts b/src/coinbase/tests/coinbase_test.ts index 4c014613..a92ef25b 100644 --- a/src/coinbase/tests/coinbase_test.ts +++ b/src/coinbase/tests/coinbase_test.ts @@ -60,7 +60,7 @@ describe("Coinbase tests", () => { const relativePath = "~/test_config.json"; const expandedPath = path.join(homeDir, "test_config.json"); fs.writeFileSync(expandedPath, configuration, "utf8"); - const cbInstance = Coinbase.configureFromJson(relativePath); + const cbInstance = Coinbase.configureFromJson({ filePath: relativePath }); expect(cbInstance).toBeInstanceOf(Coinbase); fs.unlinkSync(expandedPath); }); From 510c57366ad01faaea3e39e1dc2ef4022e6713cd Mon Sep 17 00:00:00 2001 From: John Peterson Date: Sun, 2 Jun 2024 20:18:36 -0700 Subject: [PATCH 5/9] nits --- src/coinbase/coinbase.ts | 2 +- src/coinbase/types.ts | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/src/coinbase/coinbase.ts b/src/coinbase/coinbase.ts index 02796cc3..232dd130 100644 --- a/src/coinbase/coinbase.ts +++ b/src/coinbase/coinbase.ts @@ -79,7 +79,7 @@ export class Coinbase { if (privateKey === "") { throw new InternalError("Invalid configuration: privateKey is empty"); } - const coinbaseAuthenticator = new CoinbaseAuthenticator(apiKeyName!, privateKey!); + const coinbaseAuthenticator = new CoinbaseAuthenticator(apiKeyName, privateKey); const config = new Configuration({ basePath: basePath, }); diff --git a/src/coinbase/types.ts b/src/coinbase/types.ts index 1260f54d..751269b0 100644 --- a/src/coinbase/types.ts +++ b/src/coinbase/types.ts @@ -376,6 +376,9 @@ export type CoinbaseOptions = { basePath?: string; }; +/** + * CoinbaseConfigureFromJsonOptions type definition. + */ export type CoinbaseConfigureFromJsonOptions = { /** * The path to the JSON file containing the API key and private key. From 173b1289aa0e90f822daf7c0180bfe7dd178031e Mon Sep 17 00:00:00 2001 From: John Peterson Date: Sun, 2 Jun 2024 20:31:36 -0700 Subject: [PATCH 6/9] readme --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cafd2585..c2db5d8c 100644 --- a/README.md +++ b/README.md @@ -52,13 +52,18 @@ const apiKeyName = "Copy your API Key name here."; const apiKeyPrivateKey = "Copy your API Key's private key here."; -const coinbase = new Coinbase(apiKeyName, apiKeyPrivateKey); +const coinbase = new Coinbase({ apiKeyName: apiKeyName, privateKey: apiKeyPrivateKey }); +``` + +If you are using a CDP Server-Signer to manage your private keys, enable it with the constuctor option: +```typescript +const coinbase = new Coinbase({ apiKeyName: apiKeyName, privateKey: apiKeyPrivateKey, useServerSigner: true }) ``` Another way to initialize the SDK is by sourcing the API key from the json file that contains your API key, downloaded from CDP portal. ```typescript -const coinbase = Coinbase.configureFromJson("path/to/your/api-key.json"); +const coinbase = Coinbase.configureFromJson({ filePath: "path/to/your/api-key.json" }); ``` This will allow you to authenticate with the Platform APIs and get access to the default `User`. From 7f681e1bbe34c0360b74e611a1ca01210145016a Mon Sep 17 00:00:00 2001 From: John Peterson Date: Mon, 3 Jun 2024 08:30:44 -0700 Subject: [PATCH 7/9] pr review --- README.md | 4 ++-- src/coinbase/coinbase.ts | 27 ++++++++++++++------------- 2 files changed, 16 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index c2db5d8c..2f421f5f 100644 --- a/README.md +++ b/README.md @@ -50,9 +50,9 @@ To start, [create a CDP API Key](https://portal.cdp.coinbase.com/access/api). Th ```typescript const apiKeyName = "Copy your API Key name here."; -const apiKeyPrivateKey = "Copy your API Key's private key here."; +const privatekey = "Copy your API Key's private key here."; -const coinbase = new Coinbase({ apiKeyName: apiKeyName, privateKey: apiKeyPrivateKey }); +const coinbase = new Coinbase({ apiKeyName: apiKeyName, privateKey: privateKey }); ``` If you are using a CDP Server-Signer to manage your private keys, enable it with the constuctor option: diff --git a/src/coinbase/coinbase.ts b/src/coinbase/coinbase.ts index 232dd130..990e93fb 100644 --- a/src/coinbase/coinbase.ts +++ b/src/coinbase/coinbase.ts @@ -52,7 +52,7 @@ export class Coinbase { static apiKeyPrivateKey: string; /** - * Whether to use server signer or not. + * Whether to use a server signer or not. * * @constant */ @@ -66,13 +66,13 @@ export class Coinbase { * @throws {InternalError} If the configuration is invalid. * @throws {InvalidAPIKeyFormat} If not able to create JWT token. */ - constructor(options: CoinbaseOptions) { - const apiKeyName = options.apiKeyName ?? ""; - const privateKey = options.privateKey ?? ""; - const useServerSigner = options.useServerSigner === true; - const debugging = options.debugging === true; - const basePath = options.basePath ?? BASE_PATH; - + constructor({ + apiKeyName = "", + privateKey = "", + useServerSigner = false, + debugging = false, + basePath = BASE_PATH, + }: CoinbaseOptions) { if (apiKeyName === "") { throw new InternalError("Invalid configuration: apiKeyName is empty"); } @@ -107,12 +107,13 @@ export class Coinbase { * @throws {InvalidConfiguration} If the configuration is invalid. * @throws {InvalidAPIKeyFormat} If not able to create JWT token. */ - static configureFromJson(options: CoinbaseConfigureFromJsonOptions): Coinbase { - let filePath = options.filePath ?? "coinbase_cloud_api_key.json"; + static configureFromJson({ + filePath = "coinbase_cloud_api_key.json", + useServerSigner = false, + debugging = false, + basePath = BASE_PATH, + }: CoinbaseConfigureFromJsonOptions): Coinbase { filePath = filePath.startsWith("~") ? filePath.replace("~", os.homedir()) : filePath; - const useServerSigner = options.useServerSigner === true; - const debugging = options.debugging === true; - const basePath = options.basePath ?? BASE_PATH; if (!fs.existsSync(filePath)) { throw new InvalidConfiguration(`Invalid configuration: file not found at ${filePath}`); From 6ebd4349d6e3d0be38926c2ee7c9d3aab24b8491 Mon Sep 17 00:00:00 2001 From: John Peterson Date: Mon, 3 Jun 2024 08:33:08 -0700 Subject: [PATCH 8/9] update docs --- docs/assets/navigation.js | 2 +- docs/assets/search.js | 2 +- docs/classes/client_api.AddressesApi.html | 16 ++--- docs/classes/client_api.ServerSignersApi.html | 16 ++--- docs/classes/client_api.TradesApi.html | 12 ++-- docs/classes/client_api.TransfersApi.html | 12 ++-- docs/classes/client_api.UsersApi.html | 6 +- docs/classes/client_api.WalletsApi.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 | 22 +++---- docs/classes/coinbase_api_error.APIError.html | 8 +-- ...coinbase_api_error.AlreadyExistsError.html | 8 +-- ...ase_api_error.FaucetLimitReachedError.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 +-- .../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 | 4 +- ...e_authenticator.CoinbaseAuthenticator.html | 12 ++-- docs/classes/coinbase_balance.Balance.html | 8 +-- .../coinbase_balance_map.BalanceMap.html | 8 +-- docs/classes/coinbase_coinbase.Coinbase.html | 16 ++--- .../coinbase_errors.ArgumentError.html | 4 +- .../coinbase_errors.InternalError.html | 4 +- .../coinbase_errors.InvalidAPIKeyFormat.html | 4 +- .../coinbase_errors.InvalidConfiguration.html | 4 +- ...oinbase_errors.InvalidUnsignedPayload.html | 4 +- ..._faucet_transaction.FaucetTransaction.html | 10 +-- docs/classes/coinbase_transfer.Transfer.html | 38 +++++------ docs/classes/coinbase_user.User.html | 16 ++--- docs/classes/coinbase_wallet.Wallet.html | 66 +++++++++---------- docs/enums/client_api.TransactionType.html | 4 +- .../coinbase_types.ServerSignerStatus.html | 4 +- docs/enums/coinbase_types.TransferStatus.html | 4 +- ...ent_api.AddressesApiAxiosParamCreator.html | 2 +- .../client_api.AddressesApiFactory.html | 12 ++-- docs/functions/client_api.AddressesApiFp.html | 12 ++-- ...api.ServerSignersApiAxiosParamCreator.html | 2 +- .../client_api.ServerSignersApiFactory.html | 12 ++-- .../client_api.ServerSignersApiFp.html | 12 ++-- ...client_api.TradesApiAxiosParamCreator.html | 2 +- .../client_api.TradesApiFactory.html | 8 +-- docs/functions/client_api.TradesApiFp.html | 8 +-- ...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 +- ...lient_api.WalletsApiAxiosParamCreator.html | 2 +- .../client_api.WalletsApiFactory.html | 10 +-- docs/functions/client_api.WalletsApiFp.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 +- .../coinbase_tests_utils.createAxiosMock.html | 2 +- ...inbase_tests_utils.generateRandomHash.html | 2 +- ...se_tests_utils.generateWalletFromSeed.html | 2 +- ...nbase_tests_utils.getAddressFromHDKey.html | 2 +- .../coinbase_tests_utils.mockFn.html | 2 +- ...e_tests_utils.mockReturnRejectedValue.html | 2 +- .../coinbase_tests_utils.mockReturnValue.html | 2 +- .../coinbase_tests_utils.newAddressModel.html | 2 +- .../coinbase_utils.convertStringToHex.html | 2 +- docs/functions/coinbase_utils.delay.html | 2 +- ...e_utils.destinationToAddressHexString.html | 2 +- .../coinbase_utils.logApiResponse.html | 2 +- ...nbase_utils.registerAxiosInterceptors.html | 2 +- docs/index.html | 7 +- docs/interfaces/client_api.Address.html | 10 +-- .../client_api.AddressBalanceList.html | 10 +-- docs/interfaces/client_api.AddressList.html | 10 +-- .../client_api.AddressesApiInterface.html | 14 ++-- docs/interfaces/client_api.Asset.html | 10 +-- docs/interfaces/client_api.Balance.html | 6 +- .../client_api.BroadcastTradeRequest.html | 4 +- .../client_api.BroadcastTransferRequest.html | 4 +- .../client_api.CreateAddressRequest.html | 6 +- .../client_api.CreateServerSignerRequest.html | 6 +- .../client_api.CreateTradeRequest.html | 8 +-- .../client_api.CreateTransferRequest.html | 10 +-- .../client_api.CreateWalletRequest.html | 4 +- .../client_api.CreateWalletRequestWallet.html | 6 +- .../client_api.FaucetTransaction.html | 4 +- docs/interfaces/client_api.ModelError.html | 6 +- .../client_api.SeedCreationEvent.html | 6 +- .../client_api.SeedCreationEventResult.html | 10 +-- docs/interfaces/client_api.ServerSigner.html | 6 +- .../client_api.ServerSignerEvent.html | 6 +- .../client_api.ServerSignerEventList.html | 10 +-- .../client_api.ServerSignersApiInterface.html | 14 ++-- .../client_api.SignatureCreationEvent.html | 18 ++--- ...ient_api.SignatureCreationEventResult.html | 14 ++-- docs/interfaces/client_api.Trade.html | 20 +++--- docs/interfaces/client_api.TradeList.html | 10 +-- .../client_api.TradesApiInterface.html | 10 +-- docs/interfaces/client_api.Transaction.html | 14 ++-- docs/interfaces/client_api.Transfer.html | 24 +++---- docs/interfaces/client_api.TransferList.html | 10 +-- .../client_api.TransfersApiInterface.html | 10 +-- docs/interfaces/client_api.User.html | 6 +- .../client_api.UsersApiInterface.html | 4 +- docs/interfaces/client_api.Wallet.html | 10 +-- docs/interfaces/client_api.WalletList.html | 10 +-- .../client_api.WalletsApiInterface.html | 12 ++-- docs/interfaces/client_base.RequestArgs.html | 4 +- ...configuration.ConfigurationParameters.html | 4 +- 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.html | 2 +- docs/modules/coinbase_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_errors.html | 2 +- docs/modules/coinbase_faucet_transaction.html | 2 +- docs/modules/coinbase_tests_address_test.html | 2 +- .../coinbase_tests_authenticator_test.html | 2 +- .../coinbase_tests_balance_map_test.html | 2 +- docs/modules/coinbase_tests_balance_test.html | 2 +- .../modules/coinbase_tests_coinbase_test.html | 2 +- ...oinbase_tests_faucet_transaction_test.html | 2 +- .../modules/coinbase_tests_transfer_test.html | 2 +- docs/modules/coinbase_tests_user_test.html | 2 +- docs/modules/coinbase_tests_utils.html | 2 +- docs/modules/coinbase_tests_wallet_test.html | 2 +- docs/modules/coinbase_transfer.html | 2 +- docs/modules/coinbase_types.html | 2 +- docs/modules/coinbase_user.html | 2 +- docs/modules/coinbase_utils.html | 2 +- docs/modules/coinbase_wallet.html | 2 +- docs/modules/index.html | 2 + .../client_api.ServerSignerEventEvent.html | 2 +- .../client_api.TransactionStatusEnum.html | 2 +- docs/types/client_api.TransferStatusEnum.html | 2 +- ...ient_api.WalletServerSignerStatusEnum.html | 2 +- .../coinbase_types.AddressAPIClient.html | 12 ++-- docs/types/coinbase_types.Amount.html | 2 +- docs/types/coinbase_types.ApiClients.html | 2 +- ...ypes.CoinbaseConfigureFromJsonOptions.html | 5 +- .../types/coinbase_types.CoinbaseOptions.html | 2 +- docs/types/coinbase_types.Destination.html | 2 +- docs/types/coinbase_types.SeedData.html | 2 +- .../coinbase_types.TransferAPIClient.html | 8 +-- docs/types/coinbase_types.UserAPIClient.html | 2 +- .../types/coinbase_types.WalletAPIClient.html | 8 +-- docs/types/coinbase_types.WalletData.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 +- ...nbase_constants.ATOMIC_UNITS_PER_USDC.html | 2 +- .../coinbase_constants.GWEI_PER_ETHER.html | 2 +- .../coinbase_constants.WEI_PER_ETHER.html | 2 +- .../coinbase_constants.WEI_PER_GWEI.html | 2 +- ...ests_utils.VALID_ADDRESS_BALANCE_LIST.html | 2 +- ...nbase_tests_utils.VALID_ADDRESS_MODEL.html | 2 +- ...nbase_tests_utils.VALID_BALANCE_MODEL.html | 2 +- ...base_tests_utils.VALID_TRANSFER_MODEL.html | 2 +- ...inbase_tests_utils.VALID_WALLET_MODEL.html | 2 +- ...coinbase_tests_utils.addressesApiMock.html | 2 +- .../coinbase_tests_utils.transferId.html | 2 +- ...coinbase_tests_utils.transfersApiMock.html | 2 +- .../coinbase_tests_utils.usersApiMock.html | 2 +- .../coinbase_tests_utils.walletId.html | 2 +- .../coinbase_tests_utils.walletsApiMock.html | 2 +- 199 files changed, 602 insertions(+), 596 deletions(-) create mode 100644 docs/modules/index.html diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index 390e0dff..6f1a5fd7 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE6WcbXPbuBWF/4vzNW032ey2m2+KJNfqyi8jyZvp7GQ4MAXbbCRSJanEbqf/veCLJAK4uPdAO/vJ8TnPgUG8EQD39/9e1Pqlvvh4kW4yndcXby92qn42P2+L9X6jq790//7n53q7Mb/8muXri4/v316kz9lmXer84uPvR8Robf6lqljGm5OoY31498uHH3/48L+3LuaT2qg81fOs4kv1htQLcJiK4XQ12mUQ76BEgKOXrKjuVKm241KruijxBMqKRF6q1Ihf8aCTAcLvIsg7EDrLa10+qlTj7KElGGG0UhvpJSFE3yR5yEkUxJSFWqeqqlelWuuF/vdeS603ZEEi8upRl9EpjisUNC7yx+xpX6o6K3Ke7kohZNvmtXm6wjAUNgVjmo6k+1YEVU/AwQcsdflNl8vsKQcfAmfjo/DmROpFON6QQhY+4rPabHQdEeAaIvDdD9EhR1so6lLtU931HzOSin2CkofQ18Vab6ZlKc0bli4EW2q9bv8+kzn9Jq0U3lByGL3Q1X4TG3A0hWNOPURiW0oECFWJL4fR5/CjQ+RFUciCRMhLJEKNgiOXSogdjYaWTGETHCMsnUg9CgeXUJwtGGXUqt6XOmb0CHniQqBxhHeGAtupkCcfJCxC7nJDGYuS+9dQJqIiexTrE8OgPkSoZbDQa2yhiAP7Caln4Njcj836A9WyNi27mub7LQy2LEDE6nUn14UjZrGP0uQ8UEkgqHMNlRIwqkJdvQSH+u9QiQDjezFrRSLRvkwYILzco20tAsX7NWkJRdxXUmvuFRxAbhcDlQSKbA+cTYqC2oEvFrHC87d0Egx87pQ8hEZeFMW3wk4gj1+WjocN127oOCY4+UC53Vo6GRbZdnmjHAe1X0oOoIU27ChlINiOaUMIr8LPLzG/g44EgksFbZqQRXOUNv1v4pZ7ulHNvw2JQ6GNe/d+CAy/pBJQV8yBiWU5QTyqBBSxSKBpRyEH9GcWAnYQcSCqsxOok4yDeSdI2aGdUk/WaYE//QweIrHQgQPgR4BBYug9g2XbJjbFPtUIUBsRR/EONmhOL2NJ/NlGgEuZ0BR6V1oOGvq4LP6cgM6hPHIGe1TABRFGOS3mAfkOiB/zaEiTnBI4M+AyLEtkgrsahHO6H7g05uSATvEMHJ06PKCxJyXHY84PaKxniKK7W39gRmfjk6hThBD+pEWZYN04hig6MmeRJjQlagYLGtk0YVM5EEW64nPAxsV4uUxna5mGtyKRgjzpo1CkRT1W3yHw0VEMHL/8zUQG98j3T3o/kecBNcrtPvFwuF7tDSga2mgkRlQpPQNHxyZIeTakdkw4lvR82HdrDoyPYcIZb23egvkxmRq+fvjlr+9+eo+fB3gppB4KCWyQ0wmWWMJjO1heEGf7g9X2TZWZetgAVfend3bUj2i9hSMsA8vHKo5M4qxsJniD8XGftzUVfJ31vHbmz/AVRjGpd6D8XQx6x1AjLjGQQaI/IhurtYArJkeqPd/A0JHTajIlbETSsMpy5RBZqp6BkuchR4ChhLAXzIQryHWgfKCaBmKGChyMkQFBH5CF1Y6jRrhSrZyEDA06cCHxjBPKw+rF02NsqW6GUo/4ZcB8UFXwmCVpfgkdjHwywtHdLLhn3oJ6Ebdj3mwXZaVeO1s1FM2SSkxd1aPyid2JP0J7LbsBO1pOk7vR6opZdXR/8kHIrDDGt/P5dLya3d4kl7eL69FqKVF9B4Mvdrq7Ft5NRddqJ+F9h4cftqC02G7Dl32S7tdQK5rcX1//M2nr7H4xZ4rZM209UwdN6ynrtgdPX8yrUsX0np7tWZh+mbYbnn3bueyBcgRpY2JMgTK1yf6jJ6pWs8cbrdd6LceQNjamNsPGr/p1Vdw+/EunNRLhWHi8GQiydLSvn6MSPJcQolWpy/gUz8bH3EYn3OLwpSlM+tw2QqDJOgYGXRd3BrWsyyx/krlDNTuXpMjXMImlgsaFwFc2zqxgc8fhFHt6EL+38acKJukE8OePL05lZXlg8u1/A9YNhHkz0AVvSAQ/eOy9iSJPqsHPJ4+Py6WR59/NQxpWl1nUJDrw9ccReNBgBbybhZYZPvAgZo/7N2ZAX79200UE2rNxId2x1zzbZvVCq/Q5vFbykwJeLm6WfzNzx7p/RHgU4cNjZpNzg3onErUt9nkdn3OyISHNzYNz/pqBD4iZmPVDlnenMrFRrheIaxtQdNDJBUTc6Pp7UX49o+psJxB1p550dMrRBAS0mz/G8bopVERnDbqByMN+wRn151gjwvoN1XMDB3YgtHu/jQ4b2OCQMyrRMnJB12rzWJRbve7fAvAk0slF3RT1pRm7Ilqg5eDfsKtiX6Z6+vKs9lUdMyXRVvaqX67M+rkozQtNRI7n4iOy7W6jt2atF5fh2viQar/bFaXRtsN9TA7hFFZPga//j3Diilxg1WST/GK2JOLKnVck8zxMTWVp4O7zETjURS2JR3SCX2QrgXTzf8pD8H+McIh4IK8OhvbSHJpX4AONvJAYKFyyVdQ1bQfZqGIKae0mhcrZQk8Gvrjya1HyB9+PvGIeeWMS7Jcwr2qV19yL0lGD9anV7fVsnNzfzFbL5G66SO6XkzG5/eXzSS+zFfb3z9NZq5uurqYLMMQ2cSe0Z8Bj2U1hItGNhd3DbAdW7oF2Auxplk/7Zg6QBvQeacn5RUmty1y51xhDXEuOvKvczX7Vr5dmTaG48f1I90xAhrSRQ4fAWzm93syPw0UznOP4+FHgsX2XTmr2c9dDji+GWhJzJ9b7U4gI4Yas+xfVutsYp0rSb9UkNf2/JjkUokUkQ7Hzd4bmfxDsWcL4wdyDwV2DjI7C8kjLJDKtH8NQv0lg+IAvHFT3r3AY3lKHofsKBR6VDKzONtzw3oMaFdQzfxvNZ5NkNJkspstl8mk0H92Mp8l8tlyxM9MwJoxg5kDbdH07mdLHZHJg6xWTDsU6J8nyikmrxehmeWnm6nOibLOY9Xk0n09XZyUNrdyB4+DS1HWRfoVTXCOTcehHszVMP1kAbnTZXSOTsa/O4A9NDPt7t/mC18rBIDKjS2zbGH53FNzeM7EDBmdyVIDjY478nnTenOrrhcrXxfZKVc9wiG8FcrotsMuy2DafpURn2XY2r+73/hvx1cQsRyPCPC+TtDUVfEkf61PwTi7wFrrel/lCN0fBev2b2ux1VADhhxLPTZIScv29r9H2Oyo4wfGxp8xdp8KWBgOtuzj4Qgx5HI/+soL5Ttzieev1I4/+ZMNbnDe3wbniNb+HyubfgT5h+8/YbahvsHOoD7shsC0OQ/uWYd41x+35+wnb35G3sa5cuhvfHelJ0FYkonZZl1lJuKNQQh72pA4vwboZqv5RFfntru1PQpBkR+Pj0kD44OxRAA+UErSZL5qbTgLxIJNwh0aKtj5PLwU0t1hRuKWVwN0UiqIdNQYH6vkkpJFfnFUhM8bt/U+76CHO/k7MG3pbjv+dmDvkSu+M+NtiWuRmBK27G1Sr4kq/sBNjv7TzTMy8a+ZMxa97OmirYznHfrYq+oHUJDM3xVw+42dyN8WTGRIXutoZKL8w6YJsA0Mu9VNW1abbNGvkdk801bva2uwNhgS9wPqEaTjfqc//6Jbjfk/oteWeRX1R2LVn89//Af+eTEwWXwAA" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE6Wca3PbuBWG/4vzNdtustltN98USW7UlS8jyZvZ2clwYAq22VCkSoKJ3U7/e8GrcDk450D5GPt9nxcGcSMA5s//Xij5rC7eX6R5Jgt18friKNST/veh3De5rP/a//wvT+qQ619+yYr9xfu3ry/SpyzfV7K4eP/nhJjt9U/qGmW8Ool61rs3v7776cd3/3vtYj6IXBSpXGc1XqpXoJ6As6k8nKxnx4zFG5Uc4Ow5K+tbUYnDvJJClRU/AbJyIi9FqsUv/KCTgYU/RpCPTOiqULJ6EKnks01LMEJrqTYySEKIoUnikJMoiKlKsU9FrXaV2MuN/HcjqdYbsnAiivpBVtEpjisUNC+Lh+yxqYTKygKnu1IWsmvzUj9dYhgKm4IxbUeSQytiVU/AgQdsZfVVVtvssWA+BMyGR/GbE6gn4fyGFLLgEZ9EnksVEeAaIvD9P6JDJlso6lI0qez7jx5JyT4ByUPoq3Iv82VVUfOGpQvBtlLuu79PZy6/UiuFV5Ccjd7IusljAyZTOObUQyi2peQAWVXiy9noc/jRIfSiKGThRNBLJEDNBUculTh2bjRryRQ2sWOIpROo58KZSyjMFozSaqGaSsaMHiFPXAhrHMGdocBuKsTJowRF0F3OlKEoun+ZMhIV2aNQHxnG6kOAmgYTvcYWkjhmPwH1CJw39/NmfUO1Vbpl18uiObDBloURsXs50nXhiFHsAzU5GyoKxOpcppICRlWoq6fgrP5rKjnA+F6MWjmR3L4MGFh4ukfbWg6U369BSyjirqZa86DAAHS7MFQUKLI9YDYqitUOfDGJJZ6/paNgzOcOyUNozosi+VbYC+jxy9LhMHPtxh3HCCceSLdbS0fDItsubqTjWO0XkjPQRBt2lDSQ2Y5hQwgvws8v0b9jHQkElwpSNyGL5iht+t/JLfc0F+3PTKIptHFv3prA8EsqAHXFGBhYlgPESUWggEUCTJuEGNCfWQDYKMJAUGcHUCcZBvNOkLKxnUJP1mmBP//CPERCoYaDwY8AM4mh9wyUbZvQFPtUI0BtRRjFO9iAOYMMJeFnGwEuZOKmwLvSdJDpw7LwcwI4B/LQGehRARYEGOm0mAfkO1j8mEcDmuiUwJkBlmFZIhPc1SA7p/8HloacHMApngGjQ4cHMPakxHjI+QGM9QxRdHfrj5nR2/Ak6BQhhD9puUxm3TiGKDpnzgJN3JSoGSxoRNOITeVAFOiKz2E2LsSLZTpbyzC8E5EUzpOehCQt6rH6DoLPHcWY45e/mYjgHvD+Ce8n4jxGjWK7TzicXa/2BhQMbTUUI6qUngGj8yZIejaEdkwwFvV80HdrDMwfw4gzXqXfgvExGRq+fvz1b29+fss/D/BSQD0rJLBBDidYYgrP28HygjDbd1bbV1Fl4j5nVN0Pb+yon7j1Fo6wDCifV3FgEmZFM5k3GB+aoqup4Ous57Uzf2FfYSSTBgeXf4xBHxFqxCUGMIj0R2Tzai3gismhas83IHTOaTWYEjZy0niV5cpZZKp6DCXO4xwBhhLCXmYmu4JcB5fPqCZDjFAZB2NgQNDHyOLVjqPmcKlaOQkRGuvABcQjTlYer148PY9N1Y0p9YifDea9qIPHLEn7S9bByActnN2ugnvmHWgQYTvm7XZRVsm9s1UD0SwpxZS1mlWP6E78BB206AbsbLtMbme7j8iqo/+TRyGywpjfrNfL+W51c51c3myuZrstRfUdCL48yv5aeD8VXYkjhfcdHt5sQWl5OIQv+yT9r1mtaHF3dfVH0tXZ3WaNFHNg2nqkDtrWU6muBy+f9atSjfSege1ZkH6ZdhueQ9u5HIB0BGhDYnSBMpFn/5ELocTq4VrKvdzTMaANjVF62PhNvuzKm/t/yVRxIhwLjtcDQZbOGvUUleC5iBApKlnFp3g2POYmOuGGD9/qwqRPXSNkNFnHgKBVeatRW1VlxSPNNdXoXJJyvoZJLBVrXAh8ZePMCjZ3Hk6xpwfyext/qkCSTgB//vjsVFZWBCbf4TfMumFhXhm64A2J4AePgzcR4Ek18/PJ6XG5NPD8u31IZnXpRU0iA19/TMBRwyvg7Sq0zPCBoxg97s/1gL5/6aeLCLRnw0L6Y691dsjURor0KbxW8pMCXixuVXzVc8d+eET8KMDHj1ktzg0anJyoQ9kUKj7nZOOEtDcPzvlrDB8jZqHXD1nRn8rERrleRlzXgKKDTi5GxLVU38rqyxlVZzsZUbfiUUanTCZGQLf5ox0veSkiOmvQzYgc9wvOqD/HGhE2bKieG2jYGaH9+210mGFjh5xRiZYRC7oS+UNZHeR+eAvgJ4FOLOq6VJd67IpogZYDf8Ouy6ZK5fL5STS1ipmSYCt61a8Qev1cVvqFJiLHc+ER2eGYy4Ne68VluDY8pG6Ox7LS2m64j8kBnMTqKfD1/wQHrsgFVk02yS9mRwKu3HlF0s9D11SWBu4+T0BTF7UknsEJfpGtBNCN/yn3wf8YYYy4B68OhvbSHJpX4JEGXkgMFC45COiatoNsVTGFtHaTQuXsoCcDXlz6tSj5zvcjr5gTbw6C/RIWtRKFwl6UJg2vT+1urlbz5O56tdsmt8tNcrddzMHtL58PepGtsH98Wq463XL3cblhhtgm7IT2DHgsuy1MJLq1oHuY3cCKPdBewHua1WPTzgHUgD4gLTm+KFGyKoR7jTHEteScd5Xb1W/y5VKvKQQ2vk90z8TIoDZy4BD2Vs6g1/OjuWhm5zg+fBR46N6lE4V+7jrm+GJWS0LuxHp/ChBB3JB1/yIl+41xqCTDVk2i4P+aZCxEh0hMsfN3huZ/JtizhPHG3MODuwYaHYXFkZaJZFr/DEP9JsHDB3zhIDW8wvHwljoMbWoucFIiMJXl2PA+gFoVq2f+PluvFslssdgst9vkw2w9u54vk/Vqu0NnJjMmjEDmQNt0dbNYwsdkdGDnJZPGYp2TZHnJpN1mdr291HP1OVG2mcz6NFuvl7uzkkwrduBoXJq6KtMv7BTXiGSM/Wi1Z9NPFgY3uuyuEclo6jP4pglhf+s3X/i1MhpIZnSJbRvC74+Cu3smdoBxJgcFOD7kyO9RFu2pvtyIYl8ePor6iR3iWxk5/RbYZVUe2s9SorNsO5qnhr3/VvxxoZejEWGeF0k66Aq+hI/1IXgvJ3gbqZqq2Mj2KFjufxd5I6MCAD8r8dwkKqGQ34Ya7b6jYic4PvSUue9UvKWBoXUXB5+BIQ/jwV9WIN+JWzxvvT7x4E82vMV5exscK177e1bZ/DvQJ+zwGbsN9Q12DvRhNwtsi8PQoWXod815d/5+wg535G2sK6fuxvdHehS0E5GoY9Zn1hRuElLIcU9qfAmW7VD1z7osbo5dfyKCKDs3Pi6NCTfOHgmwoaSg7XzR3nQiiKOMwo2NlNv6PD0V0N5i5cItLQXup1Au2lHz4Ix6Pglh5GdnVYiMcY3/aRc8xNnfiXlDb8fxvxNzh1zqnZH/tpiWhR5BVX+Dald+lM/oxDgs7TwTMu/qOVPg654e2ulQztTPduUwkOpk5KaYy0f8SG5ePuohcSPro4biC5M+yDYg5Eo+ZrXS3aZdI3d7oqk8KmuzNxgS9DLWJ0jD+QZ9/ge3HPd7Qq8tDyzoi8K+PZsl0z82m95YsO7H33nZ7MQI3zTThfk/2/dHf6FfAAA=" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 5583b96e..27f27369 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE+29a3PcOJI2+ldOWF89GpEgLpxvHrd7xvv2LdrunXNiYkJRlii7tqUqbV3c9k7Mfz8kQLCAZCYIkChpY/r91NUWkHiQCSQSDxLgP1/str/tX/zp7/988et6c/viT+XLF5vVQ/PiTy9u7tfN5vDH1eP6xcsXx919+08P29vjfbP/o/nTdfuny0+Hh/v27zf3q/2+aQW9ePGvl4MsLgZpr25vd81+P4habw7N7m5140vrSyFSX754XO3aYj6wU1vFVVkNjf22ur9vDtfr24TmLtxKUw3bmhSATXP4bbv7NRGBV2sphMfjh/v1zfWvzdcUCF6tpRBW5s+JWvBqzYCAjLo/r+5Xm5vmu/X+EIfEqbB0LN6uDqt5jV70VWN14PaSAPNptb9+2O6amYCc6hlBbZovh+vH1ce5qNz6GWEdtofV/fXN9riZOWgufAnLoCGjOn44P+04nj2A843cRUM241hdNkizjs6lwzI0HlsBkyi6MkvHYPyyOrSWuqjqrlDrWffHpMadGsuavm1u1g+r+8n46dS0U2NZ0zfbzWG3umkbiAvhThCQmslQ3HHWe8YJAH2ppWNt9RAxt9y2LoYak520HQmNs6SW+wozGvb0u9uubm9W+8P73eq2+bn572MzucKgdZbqfr/+uGluW3f59b6VPhvBxUjOtIJQFUyra7O/a3bpGnOrPZvSRiAW6s3TBa6617tmdWj6lSVObViVpSqL3iORjSdumNB+U17gcGj/ujqst5vZ6HwZS+GNLfiu2X1udu+64RI5+sl6i4e/Fnmth+5uepEO47hApEVqD1MJAbnZ7Lb39w8dpIjoegLxWFgWwGObJywO4wpPsioTzSYs0EhPCUB3u+3DdWRgSOGCMjLCO2yXgvMlLIOGDqaEpROt87RDarxYzhhVxAo5b68TgJa290mClzqqEL3NGVUx0G7bv6038Qsnis4XshjgeOT/TdPNKePeq5GHIp/Z7sVQO1Ixfmej1fK3mSDN/zwZ2xBGMGsWYmogYB73zbUXrixDi4nLAtq19ber401j9gqrm4iJOiq/1LaHk6jrT6v9p1ntXyBSJlU17jquou+3t839m91uO2XPU8GlSrlpJaU1dtFXmey10xui8Yd2yzHNq8L2T7XmQXA1/q5pbvVAbo3y5nMzGROMyj/VsSXecNoB5rizYVCtW4jYVYWRnWQsghe02c/N/nifbDlT69ns5zS/0Ip9989iSwTlEouGoTZfDs3mtiOhYjmaIF5cXG7Q+7b4QsWeRGQA58+U0zZ/EuCp6BPTMqOmZzExXl+Dc2HqNGOM51RvLgzKKnFrDij/jPZxHPxSIwVXoGa2Xi5s1UVgyqtaFrykbeYb7vD1cQLbXMMFB05ENgBa5wnyAuh2ozME8O4uyxUIwErJGkiCFps/EMCWlEmQBC4+pyAALzG7YAqgN+bbUqvDcdckRelopeVuM2qlp9tOWujxfi+NQgPg0oLQOfAiY9BpjCkhaBLQ6OzFEMi0ZMaZANvA9ksOjL2czDC7oGC9+Rh5MB2cMiNJmaG6fE63jC/Aiog6I9hFY3QkaDnQaa8dt08PVH2yzfoUhhzOMue2PRbvYscZBr3QfbqAczjRMNgsE9+FnG/6xwPPoOlcrmCCJrF1FuN1JeWC6voufY49gVKXebKzplNriedKpisLnaHTepLXCzYe7Smc1tNcQrD5Q/fHpMadGsuaNokfMfkHTut+pRwAItJNR+3HZpyGVb9N7r1bZXnjaT13aiwecpEHn/6ocyolAxi5tQjCaCj3BCSR31Y0MXTqyjIyCDSfQgBNQoglfQCGJKJnEkQ8uQNgJBI6GBAw9uLHfq7j/pTl1T/iT15kkWN9xOUmLHk+nnH1HKCOm6Ts8REqpH4OWMtAnQVSYuJIlpSRGE0d2sh26jBrrCFbayYEVmLT+p2W+mZzfBjwfF7t1qsP9yScU5U/FDPmuuCcnTzMtb+FS2774jp6y4b3mrDRT83mdr35uBjY5UnQPICXfQcJnMNdjuVIXVFnwfp6+/DYbkOWW/vSkXQWpN+u1vfN7XKcg5xcKOHxZngmj0438VbS57DCALx3J3LTCqaa7grOCRJAXHLn5EZENXfhVEsxyHtgAxgg3U0madhiTxsa2QbnxEV3U8kYqRhSKYgghLSQbMAwIxQLgIhPXfdRJGarT+oiclPu6iFlUx5uPO5mAWg+4TLBFIBD//dUDH69xTDmxOQDltkBeQDQAjj5wcyJw31LzQnCQ9qJjsBPWkkLv/3GYezd/jUp8PbKP2XUjTWcGnL7nV0cbwcgJQfbnqyMkXYIY3qYnYIyIcYOgUwOsFMwRkfXIYSJofUEPjSuxmcpHlT78pelC1qBcaTvUPRpeF+/uRTq99SnxewvAJFIAE8CSeCAAZJUGngSShITDMCkk8EYHHdk/rKf3Op0RZaOxMlYbmjkIi5807ipYb/eP96vvl7r/41tFlRKBeDqNOreZJ5LkpN6de8Wxmk2fN0xer86/wpmGMBtc7c63h8in0NyUYxrLoTip91HRaAuHqJ6OignFjV/c7N6Y6PSUM0nik8jICREqkFVhGNW92pPLsiXuOxF3ZiIyl61W6zPTddgtk54IjNjhxFb1FgexW7BNpdFcUZ0RAx3KvgEERxoLDp+c3qzLHqDAFJit2kQsZEbRJEUt03DiI/aIJDEmA2FIpxJbVavZv/qcf3qy3q7/2m1Wz1oj+LcVb87bjS/4iELVs3t4WciuAgXiXf/YTlhLVIX9N33uZ6ko5ewyXN2e+yRn83Afr/7f/xD8TQKAEonBsPH5vCkI8Fr7/cyDE6dtmOAPdEYcNQ9OQDgw6hPpJJTs7+/4WDfX+1HBX/yUTHxhux9u377JZ/ITeAN/14GCNJ7O0TkEw0RzADTg+QZhsfvdWCchkT99EOCHgw7826XeZ/q2+Pm9olGBNru72VYjDs/xJpPFWwi+p/c9337GK+ebx+ffGfXN3kB/m3e3q2tCLruMkaVWro7C4Jdtv8aQcc4L6cHc7YUYfjzNw3zsSdHw7FdmBnvpvZkUegW7kuG4GxBb87Sj/P3YMnCGO7G8qUvoi+UC1/dtIvA14SumApP78yddi+wP8x0631tTCeZHXxcBxa6ero753D6kV1a4P4z9Cd9IUju1twlYXbvli0Okf3LsUzk6OGZ+/aUvVq0iER2LcNyktS/8SfpdIW39lRq4pwKrTPnhHTaR6cCuFjki08KiHe5yQjnu9YEeHFf3IpCOdNTToINOcRkuBkcXwrgTFDPADLgrpKRLndLGNyiVKj3GXD2LVAgZzgaXjhfR2799WF3vHHPvGNavPArnlo/7G//sN7/Yb351OzWB53eMqWWNB8Yh26J30twd1Fg5ru4dM+WCGimN5vjxKKQZXBcaf4qFVU+PAHXFAVquTsi0zO2m7v1x+POT9uL9Qpe1ZFfeNxtD81N6xf+n2WOwgP8YbVvflodPqVhdWo9DcxVR12nYbRVzgbQYVXcVD+UaQ9H+pPVn4RxiUNxMV0sno2ZljWt2WCiFPrk/VP0/hJt/ykUkuNs6/zKSMqnyqcVzCx0bs3zjZ5x47/XoQM0kZSDlXHcQIME0ilG75lP8Dy5NUZi+L0OIVwhSXlbGUcSYZ7IAfXMY+n/DiOncFJa1xlHEDl49scPD2v/HkrT3GKPbz+JAmPg/F4H16RukhLGMg62aaPFDz77+vL/phGIY/q/wzCkoLQEtfMORsx+UXv0qQS2cfln2YXb9BHk3+fvs9vKiDqCXPL8vdBkDzLtldFOTWcKnLNjGbZxc3qVYxcy3bl8+4wcfTx7956sZ5mjtumeniUuy9TzxSHDrO5nCgoidRBapGJS9IhKz7NcuYkq1B8XLFy9BEpP51rC4nuVazELd/Ssy1pCZ3MscIt6mmWpS+hwxkUva7+fsMvP0NvcS2JC78+zOObWxvJlcplKci2YyXohvofbVYpNQiTr5UlERB3xHCQXeVaWmNy/fJgzLBBR6XSBNWAW7nx+Phl+ZuTnAR3vkWd14ixed06nQo41V88yOc+pFElYPpROA8s+Taok2urSdMlRt9O9dTzULB461TFHw8vgjGf64GiI+fxuurudDTIrvnjPGo33LN40kxNd0olMjnNxMifptzIndMYCj0nqxDFnTeyMhTuZ3IljzZfgGQDqcHP6s3bo8VR4q0XXexKGbqL5i8Df43m6gJCA2qjha9+y97+9e57eXY5aO09nc5z25u5sUhLmkl5DJQdzdp/E6n5T/84md3qalDy5yN6ueun82iextNPOv7OZbTeT0hoX2XhQbCB10Ug5d9+9lv6djXzqaFLu4SIzO8oNh0VTCTVOwacNfOwRsPsPM0KbtpbbV2L7Myt4oREuCU98wBOHCulrbwD03NU1CXHiAhKAO2uJSMKa7AsDaGd6uym86JSOST+ApZ94crsHV6N/nTPN+6ojJWSd8BGoF019ohP5nUBMR2a7g3m9SHUMMV2Y5yLm4U93FjE9mOs24vvgf2zsNuklmHGFpaevxLxMav5iwRScPG3CJlsaurnzKuYIeAmuWZMl6pwUTIs0WDNnwNS52lAwRGEOhZ7mJM1vbukR2qmHaXNtGtiC+ZUyrSI0NHMqRc+gaQizZk3CZJlGMHOCLD4/GY/WzAcnk1BjTkzg0M15VDIJcPKMBKDLdziCQfP3Cvr7jvMORuiqT7WLmEBwES6StL8IyAlrMeKcxHwb+ik6e4k1e87uZ6LeztP31COUhUpAlD91lvKEI2PU5u9lWPgdTz1mWTomgNqD5y1POBr8Bn8vQ8HpdepRzNJx4Co8fCZjZD2NQmCTv5eB4PU79bhm6VDwlT4ZuEUc3Thlnzw0c8hw99/mBV+GB3e7HrGpTXSbQcDLA6hRF2Jp3azdWLbap/Zh1vIV7sCCBSoV/Uy/G8a/yLNG9IByFpGHQrDC07sNQIuP/jDTgZwY8ZFOzuBK4jqRwanQ3TqXe4ns2kJHM7tf81xOZKeWOJ/ZPZrrhiL7tMwhJfXKP2saKiQcN43r5Dxx8kdNKoiLxbM5/vRpIdJlkzPyJGohxgVzLfZUCkypZIiLpk7ECdVQdoJDHso92TmV32KGo6pTV5PnaRTCxXMzcUrGqW3RNEyZfVFwFsy4tIkWhWbR5MpxujUe4/kPuCYBR55xwdGe+ZhrEmbMSRfAmPWwCwPo7IR+2c866yKrPcmuKNz6Bf3n+B0SLYPWGM1Uvz7uuia6qmft2eWorXN0NActmbejScdW83sM1RucUVMk5Knck84Zy8E4/58+K9pKTjfp1TZ53JPoFoxsD2yQFhqKxVBCoPDTGtHdwcJ/nGHOvibsf07DTiNeYmK8A+GNti0cu8kelV+6wSb0mNL6xXydTe2ybLlQ7GLLPM3uymtt6c5q6F6acSZhzTfI4sh8pJ/MUfkU0JiI3MeYNRqfgjcZifvY8kXhCDBn0fnb6v6+OcyIwQMVn2Qxmmr/IlQgfpEKSQnpLphIZCqevX+XoLVzdTZHRJ67u0kx+bJ++2qmt2FPZXW3qX93kw99TUoTW2jvk4KnjB31xfSsekj4kOa/i+n7LicliOUaAVbdgQwxr+DEOWEOvaBt/rsPhnGnk5LEFg4HROWTA+JJR8LvawgMto/6vE822xOpgScZU5ycW/KJY2jLfHn/MidKbqt5HQ6ezqVFRAGMCyJdAHg6iyUf6JmB2kzEibFIFPBZ0UYa/vlLaKgHSxfJuX3IDD43atxtxfDRo+JP7cBchnf8z7NcWV93rImcTi0G9xL3RnUiu6OL6shcl7e0F6nOL60z89zgzD4tcIhRvVrsGhf362wdOmNPnJOdU/HYsx2kxtLTHdQXpbV+Md/rxGQiLsM205HEA4MeYy6+Wb4hKlGScAKJQJdO9wSoGTBmAOeeMp5Khk5mTqWe5qQRtLf0rNHpZIqziAE220HE+4UIGDN9QbILSIEya9rPmO0RmJbO8JSJnQRnPo55J9TIvMp8Rj0NNuaUGuLMek49DXHypBriy3dWjQ+6k6VNyU4fA76H7e3x/oSv+xvipU/S2Encn1+9e3P906v3fx2EfV7t1qsPUNxQLsr9a3Roe69//O67N6/fv/3xh+tvf/z5+1fv3000PK4wB0FwW53U8EXcNpoQQc7f/edFcC6NgDmQxoG8/9X1pcj250J2WIrscC5kj+tHZ3mahc2KyIPO3Zr93Pz3sdkfXu0+hmJRLdopOmfSeTrpGkps7sLUmVaB2yWi+e2j3kMnQzjVmw3DibX/3BZ79dNbamExntaUmaPwxDh71BwZZVM9tv1ZEpWgKCJjkpm4pgKQMaSo8GMmmmCsMYYyHWkk4HDGZjd617vm9s1uNzFkvJJPNU7HjSaPVr+HhDXu1s39bSoSW2k+BidE2j42Zuibrwh9vzodmeJLybjCHKOMQsyb7cODM21BkGn+GhtmfvPL99//f9c6iPzl5+/o/vRS/eJRvenRouc4XbXdQZ9cv/nSbr0C5GoPYFRjMYZ9c2hD+v/TfH2//fHDf7XzdBLDqEYODK0PWN+8Oh4+pcAYVcqCpGnL75KhjGrlwPJjKowfcyN41/br5pMecNOjE5TP0H47De/X/9N8szqs3t790DS3zW0ECqTWYiyHbbfOvjvs1puPkxDcwotbNkxeH8R927c4CQGtNRNL0tnvZPsX+J/i9q9B6bimgksJFgiOVhSnUHBhcbczr91aej40h/DDCX47RP1IC7rdosI77cOz4LkYZMXDogSS+7R2WuufWQA70s4H+bEV/Nt2d5sHsiPtfJBXNy24/fvtr80m08jwBJ4P+GjrtAg1uq3KDXmvo+K3m9vmSx7UvsDz6vrHSd4iUd0/xhEai4DfbXcPXVDw2t3ULUIOJGaF7u5GwaKbDXP0qhsj3VMGvpn3qlK72UBri5a/xO39FIyUfX5AVuT6nApu8ZIcvRCnIsuw9kavuKnYMiyyKUtrslGzrKZz6cdJeBmWzZTFMhVenvUxZVWco8DlC2HS8pcKMdOKF7fOLQG3fGmjFjQv02K9/4/9dvP9eoFD9ERkUCjc5hIb2/BW1lkp15tuXP5xdXu7a73PWFpf4LovEJTrBgOvgMBBb1DgK1KwqyKIc8bCH2o4brkHIKwEakq2OmzuE3HYOshBy/rz6tAswfMrFnEE0fwKgoxFWLyZdbc63mDJZkE4Q6XZ9oH5Zm+RaCIIwdbJhuCH5tDGJL/OAeJWzYOnSxGjM92CeEDVbPoJPJY4pZ+IxxLT8ZC5iVNoJhMT07GYrK05Q8epmQfN1KufYecb+exnIqbDFjD6cWicavNxICvs4/q68Y65x2usLRK/yv70ljg6H8u0ZWNX2gEv5cJ324d5jV+4VWNhDCIWrf0EoLTlPwTJW3E/HQ6Pr7fY9xOnADk1s6FpS84Dc6qYE8v37ZRZfZwH51R3CaJUb0HgSXAYQf24r7Bt1g+P981DW59MjhnDGtd6lrlOwCBmfTBDeaw4RDNZ/AEFetYdkETYs30GBRr1HmdDnOBXKMCYhzkn3gTfE4CMeaGcqGf7Jwoz6qmy6tnzYavj4dN2t/6fJBcGKj2TB8NQ5HJgUC2Z/BcKOZv7okEv8F4o5DzOKxJvku9C4WZxXfFokzwXBTiL46IxL/BbKOI8biugY8dr/bA9fLs9buI9llfhWbzVGEEeT+WrIouXQqBm8lAU2NneCYGawzNF4UzwSgjMDB4pFmWCN8KBZvBEFNbZXghBmsMDkTp1vM/bzefV/fq2p+e+iXYBWL1n8UUkkDwuCdVPFs9EA8/koCagz/ZTNPAc7ioFdYLXokFncF6JmBN8WBB2Blc2gXy2R6Nx53BsU/oe+7eeME93cH7F5/RwCJKsLg6oKKePw6DndXIk+KVeDoOe0c3F4U73cxjsfI4uGnW6pyOA53N1JPalvg5DntHZ0Tqnorl5IdSz+zkI4wxx3LmiuDPHcOeJ4M4Zv50lejtj7HauyO28cdt5orZzxmzxEdvMKOnZvdgIxzlitbNFaueO084UpZ01RjtPhHbO+Oxs0dmZY7MzRWZnjctiPNrD9rhJjsqcWs/qzwCMvO7M0UxWbwZBZ3ZmKOzFvgyCzunKphHP8GQQcEZHFoV3hh9DIGd0YyjqxV4MYs7pxHA9j32YTZlNJ9JAzef0ZRiUrP4MaimnT0PB5/VrNPylvg0Fn9G/RSJP93Eo8Hx+Lh53uq+joOfzdzT6pT4PxZ7R7wX0PvZ9P7XaSnU1Q53n9Hc+iKye7qSTnD4OAM7r3TDIS/0aAJzRo02iTfdlAGw+LxaDNd1/jeHm81wY4qU+C+DN6K1Q/Y791Hfrh3XyNvNU6Tk9FUCR1VU5asnpqyDkvM4KBb3UW0HIGd3VNN50fwXh5nNYUWjTPRYCOJ/LQjEv9VkQcUanhevYvVF4v2tWt1/NA6TRDmNc63luGeIw8jguRDN5biISoDO5riDs+bcVCdA5nFc84gTvRQHO4L6S8KbceqQhZ3BgQdTzb0YSmHO4sLCeHR/2/eq+e92lue1fC432H2jFZ/FkNJI8zgxXURZ/FoCeyaVNgZ/t1QLQczi2JNwJvi0AO4N7S0Wd4OHCwDM4uSnss/1cAHkOVzepc++e5f74+LjdtVJfta3Fezu04jPdt6SQ5Lpziako071LEnq2u5dh8AvuX5LQ89zBTMCd4O0CsDN4u1TUSfcxQ8Cz3MkMY19wL5NEnudu5oTOkeyNrtyM+wNOtWfN34A48iZwuMrJmsExgp05hQMHvjiHYwQ7ZxJHBOYZWRwjyBnTOOIQz8jjwEBnTOTAcS/O5BihzpnKQeh67NG+acO89UY/95nqTWDV5/RsKJas3m2kqJweDoef18sFOrDU0+HwM3q7WOzpHg+Hns/rJSBP93wk+HzeL4B/qQfE0Wf0giHdjz2hfdc0ObrzKz6nF0SQZPWBQEU5PSAGPa//I8Ev9X4Y9Iy+Lw53uufDYOfze9Go070eATyfzyOxL/V4GPKM/o7Wufft0/32uLtp3nz5tDruDwmPpOE1n8XfBaDkcXiElrJ4vBD4TC5vEv5snxcCn8PppSFP8Hoh4BncXjLuBL83AT2D45tEP9vzhbDncH3Tend837f6JX+djPJzs7r5lOD8iKrP4v1CWPK4P0pRWfxfEH4mBzjdgdkeMAg/hwtMxJ7gA4PQMzjBdOQJXnAKfAY3OI1/th8Mos/hCCN0P97zvlt/3DS3P62+3m9X8b6QrPyce18CTdb9L6KunHtgqgt598HBTizdC1NdyLgfjsefviem4OfbFyehT98bBzqQb38c7MPSPTLVg4z75LAN6Puu7w6rwzH5MRKk9v+Ge68QzlnuvroaO8f911EnznMHFu9Grnuwo06c4S5sRA/SvSXZgXzuMg3//HuxWBfy343Fe5HrfuyoD2e4I0v0wJnOVkJ3Aj10YvzNqe7PiBskbod4wsYa0cJeESLR/mmBAa/66rB9WN+YFxHiG75AqsYgMSIWeUiIJO3TUigIzKrHw6e27vpm5aIZW9ctFm3l1331V2gj4y57jaCVY0eD1+ASK0RCSrTOtNSAT/w/wc9vxgJejT/9HfNVzvnIe7F50HvCztgDz404VZs+nzqHIVCpWUeQ14sPx/X97X/87X0G6I6o8+Ftvhx2q5vDT81DnqED5T3V6Nlsw5/7jMVv5ZwT93id+AA+VzpaIfoC0WvD5PdPrcA/k4KxjlqcgUjg+/DnlLF2L9x6cQhs/UkkrzZ9cl/g86thTJ6E2ej8ZWYiTkIBrSIjpFgMs7SyWq4JevhfP6weJ6dAVyh1GnzvyKX6qeWeyqdNCI08MBSnv9YcQHEBJMRDciSRq+7t9BBAQZmKWbFM7+VCgOK/7zmNajxE7Q96fNofyfE73d1B5GtaNtbBASwx9zcm8eW7dSjEwhu/8OtGAhlkOIgE50wMkK6vD18fk1Xhork0Iv5QzIB16faKUNqf23Lvmsft/XqVBealL3AJ5F5m0NUHfA8Beqj23EY2QC6H2smq6ntCqOfN4dMySJdGwkxYE8b7W7NeiM5IOA+6v/y2GF4v4jz4ftnf3izE14s4l3UXD75exHnwdcz0/bqVNcN9uFUXuBCEoPkpguygUUEBubAdO3e++9zs9HlZgPYioI3rL0DmBVY3283d+uNx13zbRpL/sd9ukrFhEhagS2YKaVjxvGC0uj42h2+au9Xx/vDLfoYdR9WX4MIi0bbPK3dGIqFoXyQYi7KT8L+9eXv905ufr9+8/+ubnwe5n1e79eoDIdmrEh2XWuhBFH9pf6SB6GrkwfCXGar4yxl08er9j9+/fX39yw9v37/Tsn95983rODho1QWokDGoz7oCA9D8PXonZG9h/vS29cjfbncPq8C+pJeN1InsYw+e8OLfvPn21S/fvb/+/s27d6/+8mY2jouxoChcmMAlnnMKZpILjYLonUTuPh67b9BPZF30cr3Sz2LNMYLZdvS7vtyCCLQ5tqNg+fPx0Ow2q/s4q3mln2kOQgQLZp/b9RzzbgRt3ozDYSFe9HUfqul7nLF+wav0nH50DGSpI/X1kc2TIkAXuFIKJGLfXzZ7Nx8vFi+o9pw2xqAstTLUSjY7o2AXWJoGisRZdzpJ/frQZROtbrwJPYq5xmWj4y+TC/8eaWWkHKSVUe3IsYV0boHVooGlGS9GLDU9HsJHofGIH0ZnoxGH0onI4Q7YKfXX1T5AUsV3A5WaV/+BXny33vyavxe91DP2YvpULB57/BlZKuKR7yIdVdArIT7w0OwP+z+uzBfjrg9uWtDIB+qy127Zma25qRtxbY5qzGvZOZuMaheWX9ZqSovzW/METjXn/e+89sZjOaploto8DIc+ITiqZa/wvPaO+8i2hoIz2zms7wNEUN9GVygoX7ir5s2v354ikLvjRuueEGpKR0YcLmSy7Z+bw3G3+c/V/bFJAeFUy4/m5+a/mptDczsTlVc9F7p2Hew/49mdCfz1G/c0ZgIZUnURKoc3/U1/KtnJa0KoUheKLZ+rfTt14xGcauSzzKZpd5KN+Wx0p+J3TXMbbxysdm5sP682t63p3cgyEtepZi5Mm+a3fjj6yYsTgEC1XCPoP1999/ab61fffPNzuxO+/v7Hb958FzuUkKp5Uf3t1XffvXk/B5RbMy+m9z+/+uHdt29+noPKr3seC/751Xevfnj95vq7t+/ezzOkKyEvRit5huq8qrlm4s2uaWf4qy/rbTunbn6NnYmgWi4ddaHR/tXj2oMyoRy3zjKthDKnUkFcxOZOOVg8KRTF0a7kr4+7Top3VD4T3+VI3Ey446yWUYiQali/1rOZFoExy7hACbR5TRiwHN6lK2s20Il0JeMIskEG4s6F+n6971WzzwDal3Z+zKPc9hzQ49PdZ/dgGI/wrkyGIX4SmRG948J6hqtJdWKw3rO5MRTILEc2UgVh7p25/GdIzG+Pm9voARvCeomKXQB/etD2e44s6D1x50PdzetXtkoW4FDiU2g80U9EKn6Wq5iv/1RvHWuFeQ47sR99nJ9xAkCJWbEjtFCqw4b1ns1ho0BmOeyRKghjf9htV7c3q/3BvqWRA+olJnUB+KgBm7UDI5HnQ29POnNB9+WdD3fnlmxD0W4iiBxKzIqdPFsxAWHUKY5TNPkcB5p43ERfIjqfZDRqRkfWg8j3tGxUs1by/BvoeNMpd9BHEmYmgBBIZmV7RGPCcolikfl1s+GDSRuhW+kEso9xt9JTUNjX4WeBcStnxPQ3eLqVAMmpmxFRdz7Uh0/zYEEBGbE53zNZBJGQkxHp5BMVNLjotymS8Ew8UBGAE/lKRQqa6IxXGtZYREZ875aigwIyYotO46PRJefszcS3EFtGXHtrkiXoCCE5x51+XHDWgLM1z2PJcKpllDXj8iqj8e2aWXNzqJYLx3QyJxV6RWduBrEg4X+7GQklcHV/Dm8prmpZcOcWp44zXv301tz+HkRrSVAwKBy7C9CYI4mN6Hbj2QxMRNKRVCqm1JMoVN5o45lVbR7EhLdYQlj9bkefUSZDTzmafA7VDvisXtlCvZ46TPipwPFeMvpZp3pxasb3R5Con6/veHJ+Bl7s2HeBcnNq1ffo/aYn0qXD0k/m09GGE536qKtkPEGeJiZjm3eGiIudnCHw8CQdbdKZ4RyU+GlhOtDUM8JlGo1yOpGKTXQ78/Ub59xjtZzq3hNx46d/6YhTz/yisfpes8tgi3SZXtEn85fjVhOdpd9DeoZgGYJpiNITAxF5kxazG6ZIq42KP5nl8JYTrTfuLWFB+iA2Hdys81dCbIy3yAE5+cR1Fl7ssHUG2LQz1llI8ePVGVhTT1Xj0YL4dfyIHb5qDOWeLmb1m0yNVk8dIzbHx0mfiyO4PCa4WUdE+GD+t4h9OoHnt6T9eTSiVVQ0gUNaJUYQsZhGB/IpoA6Jkz+EanygDxjnZnN8IOe8KTtzJhWnafTTmx++efvDX5IbvThVTHIsfR9RLH/++cdX37x+5VzkiUbjVs2G5/WP3//03Zv3b9LhODWzofn21dvv3nyTjmWotwwJTkR/szqswjPpVO6J6eehyVnMs+5Y0NE6B8oJKC6dyolwJhzb3r2FmoKor7gYDRwh3cXW6fFhSz3Z6PAaTBwbQ5dm2wBrPckCg4DwaGg2N7uvj4dZcNy6OTF1r3i8X32cgehUMyee9ecZUHSlhShGIbSfEIJHJLrMzFkCG3RybsKtOgVnNq0cf3B6fjkm1BmXf6Jwh2g4NeRB+otievX6/dv/nAgyKEhD3eWI4Bix7yX/+KjvBofHCSj8ZM4cazfRp8N+Us5LP23+Q/c/cxFdejLmgJtwaMhn6pIxEl+ny4aResc9GWjyg+5z0N42H44fP7opJck4XRFnQNiV/GnlfOcgGaAjIQ8+ypO8hs/cJ7kWqvaT+5ogkJnOh1QNYfW79X2C1WMQXzois0A/hx+I6shCxzCzP4meIqons13HzD6k+ZKoLsx1LvE9QLLuPF52lHTX/TX6sk34GxVa1C+4PKyPGtipoeRnWP320t5aHerOvE8D2p51jwbDgJwrgYyzSTUkpe9NYpi4IwMaj7wbM9kqlq801XZSelJMvxMVn5DZN9n6+uFxu0sFACotxTCdPwzaj88bRttGPFf4wcekpx7b+bkKPhpopOlisf6Lflzq9sQUvN/2+Rx/bb4AhQZQBKovR3e//fjqcf1zs39s2w6+8Wjg+OWXt79rPrZztdnpV7T05wZumseD+5UXEgpZdTmqdv1ow6SDUfL7bavvaTjjOjNxIKMfnGCOhr/5e/TaPeVMenF/o6RivfgtmC39/av/174r9+ZdSsMXsGYUjMtwmrFZF5NgDFVytL/erJO0f9FXyNG2/hpA25WOhO2+Me08JRlYXxFME4KSwp8o5N0FItPW96tu3ge/w4cAxutnwZn2vdE4bJfIv/2hSLji4DcT2ULUAc55eqRPe87WsYkd3oMud+4emlaerY/hfQzSxVl7GWqSLNX3UCU/muTRPTqYzIVkNcpAj4GzQvPNM2OasUbAmmfD1jEpP+2au/WXOfi82mfD+HZz28yCZyvmX1J/W60P324nvxyLQIM182NrvnRb2CRQQ5UcgdJt0/Yg/LFfBIJbK79O8LsI8fFr9O2DFDSH7vmfic++0Yi82vk1NnUDGwGG3L7OhcaMjjn2gzXPjC1x/RnXzY/vw3F9P+wyVo9J+MZ1/3eE/QDXJfj/IXRMjRcn5JITenXzaZ538SvmN/7eBLuJMZqtk8PZIZcYIzcJeZ0ufk0xBkrixcRoNKPbfLFg4i/uxVoI3oaMtFD0xcdYHBGPeOFIEh7wiudMyOyy6F0uIiETunQVZdPNfvW5SXcqp0pZ5k8baSRjcCplssI3zd3qeD/XwY1qZwkuV5tuxCUuQ7ZODgTmQ2xJAIYq+cLr6Uctydg6/kZeFJ7pQ0AESfxBYOxYffNl3Z2IfexmQPJQhZXPwlK/MWni7ZZmBkUNK2dBWBV1xa5OjASc6MOBknNbcnI6w9u7RCP94vrdGntOdtyeX3xZ07FtLmysrTTRTF9iZgMwqsGamAxhJhtxbkjfNj+bt0HCTRI1MgDQbisVA6g0E8ZrlyiJgUBUWNS8G3HFY8BrLQISPRjQ4kubjh4GVI1FAIwXjW8els/XODivj4Qwlf0zBYT+PDsGACs9s2F9XPCm+3x9sEWv2MymujhAq64F/OZzswkrGSudq+Gfm30bQ6c1P9SZDQLJM8ZbjkkbTmkuRtnj0rkantF6bgiTsQlVYy6AVlC7dd81CcOdqpIVQszAD1ecCUcvVsF2bYklDUza2S01v6EoH53FOztCDBn0ZnN8iG3Wq7EcwHuXcJ9o+n2QR49qFP1cBWwtuOGObSZFs7D4wqZjBqxbcGZz3v0BrJnwi1tT4iNCpqXxkak/JkcnrTZRcRGcSet5xZZtr/U3qHT27U+r3epBO+eJmG2qZgZA3z5GI/j2MVOTq+6mydf4dofyGRrXmc93qwl+gKqRAUB0u3mip/RBF1M7E7CJwYcWz9V0xCCk62QCETcYQ7UyAUlqf2GIlz4ig9WWQpkYg365xY1FjDqk8NJm48YZWnxp03EtLo/DZo2qYM0MgKbHll80R5NxIwwpn6Hx6HGG1sgAILrdZZF4+mAL1VoIZGKQecWWNhUxuMZlFzYaN6iw0gsbjmpv6Q4kfSiF6y0GMzGcQMHlzUUMKaz04objhhVefnHjkW3Ob8q+e6D5Pz1EmoP7EDB6KELWyQEivuklDZqT/XFb/R9sa0OxcJbFi3/94+WLtb5P8Kd/vmiD4H0H708vykt2WbcV7tbN/W1b+e8GQCtu+/DQifhH/7f/bG707dw//d0U+ePVi5d/v3opqkvOin/84+XfbQ39B/0PuljR/l/xkrNLXnGvWOEVK9v/K19W6rJi0itWesVY+3/sZSUvC+VLY16xqv2/6iWvL6uSecUqrxhv/4+/5EXbBeUV414x0f6fwKQJr5hs/0++rOpLJXxp0ium2v9TWDHlFWuN8vcaK1b76u20XVxhBQtgCG2JAutH4duiKKmeFL41Ckb1pfDtUVRUbwrfIgWnu+MbpeiUX5ToyPLtUkhq0BS+ZYrOAgV7ycXlFQeN+8YpOiMUFTb6C98+pbYPx0qWvn1KbR+BtV6CudJZoUANVPoGKhmppNK3UNnZoVDY6Ch9E5XaRDUq0zdR2dmhvEJl+iYqJS3Tt1HZGaJER3Hp26isKSdQ+iZinR3KEjMR803EOjuUDJPJfBMx7c8qzJgMeLTODiU6QJhvItbZoUQdEfNNxDg5QJhvIqZNJNHWfROxzg6lQkv6JmLaRDWK0zcRq2mcvo2qK2oOV76JqoKcw5VvoqqzA7tCS/omqvSqg465Cqw7nR1YiS0plW+iqrMDQ4dS5ZuoEmTXfQtV2s+hTqnyLVR1ZmAc7bpvoaozA0OdUuVbiGsLSaxD3DcR7+zA0JHEfRNxbaIaLembiHd2qFBXw30T8YqKNDgIDjozVGjown0L8c4OVYk27puIS7Jx30Jc0Y37FuLazTFUR76FRGeGCvWIwreQ6MxQcbSkbyFB+znhW0hoCwkMp/AtJHT0ho4k4ZtIcLp1EMJpE6FjTvgmEp0hKtR7Cd9GojMER8ec8G0kaiqgEr6J5BUVUEnfQrKgAirpG0iWZEAlfQPJzgoc9XLSN5CsyIEkfQNJTo136dtHCnK8SxBld0ZAg3bpm0dq86DLuvTNIzsjcHQKSd8+qrMCR3uufAOpzgwcnULKt5DqzMDRZV35FlKM0qbyDaQqUpvKN5Ait0DKN5ASdM99AylJ9xzshLSF0OBD+RZS2kJodKp8C9VkoFD7BqoLSpm1b5+6pFRU++ap9QRCV6vat0/dGUGgm+fat0/dWUEUaEnfQLXepaLDvfYNVHdWEOhwr30D1Z0VRIWNoxrsVjsrCNToNdywXlHO0PzJLVpQ7tD8yS1aUg7R/MktykiXaP7mlq1IDZi/uWU5NfTMn9yi2ljoYmj+5pbV5kKXQ/M3t6zewaL7KPM3tywd2pm/OWU1lSDQ+VeMaIbOMqJG5UKiwTANVy/LtiwUC6ymGQWJM0mQbdCkgixxCMBqmlaQ+KYfUg6aWJBovFFA0kFzC5QagNk0uyDR2VNA5kHzC1Jg/qgA3EOhGQaiLGAfCs0x4KO3hPQQSdYVgH8oNMuAOs8CEBCFphnw/VgBKIiipDe4BSAhCk01EKwOoCEKTTZIdEUqABFRaLqBmJeAiig040DMS8BGFJpzIOYl4CMKzToQ8xIwEoXmHaTC5UJej5HzEpAShaYeiHkJaIlCkw/EvATERKHpB2JeAmqi0AQEMS8BOVFoCoJSAzCbJiEkuhcoAEFRVPSyBiiKoqKXNcBRFBW9rAGSoqgCy1oF6djOMOoKNRogKgpNRyicNwZURaEZCYUGIQVgKwpDV6BcSQH4ikKzEhQGYDRDWaCODFAWhSYmFBoJFYC0KDQ1oXDKF9AWhSYnFMqvFIC4KDg91QBzUWiCQuFRA4c8urYa7skAfVFokoKCC6ymeQqFexzAYRSaqcCnBCAxCk1V4FMCsBiF5irwKQFojEKTFcSUAERGoekKhc91QGUUgrYZ4DIKzVjUV+hwBGxGoTkLQiw8/OjMUhe4WGAyTVsQYoHFNG9R40s74DQKQ2rgYoHJNHlRM1QsIDYKzV/gYgG1UWgCo67wkx1gMkmbDLAbheYwao6jBSaTtMkAw1FoHqNG9/mFhCdWtMkAy1FoLoMYYIDnKDSbQYwawHQUms8ghgLgOgrNaBD2BWxHoQJGA3xHoWkNwhKA8ig0sVHj4RggPQpFWw3QHoUmNwj1AuKj0PQGoV5AfRQqMNMA+VFoioNSLzCbZjkI9QIGpNBEB6FeQIIUmuuocb8PeJBCsx2EzgATUmi+g9AZ4EIKzXgQOgNsSKE5D0JngA8pNOtB6QzYTfMelM7gIbG2G76kAFakvDLn+FcvWXF5VcODYnBSrMkPXMElIEZKQ4ygCi4BM1Jq9gNXcAmYkVKzH7iCS8CMlJr+wBVcAmqk1PQHruASUCOlpj+Kq7Zz7USW4JAXcCOl4Uau2t5Vl+2KDgqDs2NNgBRXRPeA7focDPysGdAjZUGubyVgR8rCcPfo9rkE/EhZkAtcCeiRUlMgxRXKC5SAHykL0leWgB4pTUrGlcTlAtsV5BJXAnqkNHkZVwqXCyxXkGFJCVMzTG7GVY3KhdkZJW23UXqGtlsbd6Jygd1K2m4wRcPkaOApPCXM0ihpu8E0DcOQEOMMZmqYVA1i8MBkjVIFRgTM1zAkCWFmwJKULGQ7QJOUrAgYBPAkJTPWQ49zS0CUlDRRUgKipGRVQMuAKSlNBgehZUCVlCw07wBXUjIZ0DIgS0qmQloG9jPZHJSWgf00J1IUaAJECQiT0iR1EKoDlElZlQHVAdKk7EkTXHWANSmrKqA6QJuUFQ+oDvAmpeZGKNUB4qTU5EhR4MsNYE7KSgXiCkCdlFUd0jOwIL8K6BmwJyUvAnoG9EnJy4CeAX9SchbQM2BQSl4F9AwolJLzQHQBOJSSi0B0AUiUkstAdAFYlFJTJUWBng6UgEcpOb36AR6lFGYG4vYDTEop6NUPECmlMP4TNzVgUkqaSSkBk1IKYzt8VAAqpaSplBJQKaUwcw8fQIBLKWkupQRcSqn5koJKfwR2o8mUEpAppQzZDbAppSwCxgB8SmlyRQgNA0Kl1KwJpTZAqZSaNimItE3AqZQ0p1ICTqWUIqQLmGMqQ7oA1pMqpAtgPVmHdAHsp8mTosTjC8CslKoIdBBQK6UKzTzArZSKBToIyJVSVYEOAnal1BRKgafJloBfKZUIrE+AYCmVDGkDJgqrkDaABVUd0gawYH0V0AYgWcq6CKwigGUp6zKwigCapaxZYBUBPEtZmxlI5EMDC9b0DAQ8S1mbNHx8vw6IlrKmvSfgWcraeE+Bqw1metPeE/AszPAspcTwMsCzsCty1WOAZmGaSuk+tYbKBSnfV+SqxwDNwq6M3fBsasCzsCvSbgzQLOwqYDcGeBZmeBbcGAzwLMzwLJSGQQK44VkotQHbGZ6FoSsqAzwLo3kWBngWZngWQheAZ2EFC+gCMC3MMC2ELgDTwszdF0IXgGthhmvBk9IZ4FpYIUMdBPYrAjOPAbaFmYswVAeB/QzfQnQQ8C3MXIdh6DLJAOPCDOOCryIMMC6svxSDawNwLsxwLoQ2AOfCTFoKoQ3AujDDulDaABYsA0wnA6wLKwNMJwOsCysDTCeDN2UM64JfW2DwsgyjZyC8LWM4F1ahIEYXZmjvCW/MGM6FoXsnBi/NMNp7wlszhnGh8ALbGcaF4Rd34N0Zk56CgwCWM3wLBQJYzvAt+P0MBvgW1l+iwSUDvoUZvoWhR0MM8C2s51vwiQr4Fmb4FgoGsF4V2K0zwLewKrBbZ4BvYVVgt84A38IM38Lw9RrwLawi4xYG2BZm2JYKPfNhgG1hnJ55gGthhmup0PMhBrgWRueqMMC0MMO0VOhZEgNMC+P0zAM8CzM8S4UbA/AsjJPxJgMsCzMsS4WeUTHAsjCaZWGAZWGGZcHv0jDAsjCaZWGAZWGGZSHGA2BZmKZSKCMDnoWJkOUAz8I0mUKZAzAtzDAthI4B08I0nVJUuNcEXAsTtNcETAsTdUhxwHqGayEUB7gWZrgWQnGAa2GGayEUB7gWZrgWQnGAa2GGa8HvTzHAtTDJA9oAbAszbAulDXhdVIa0Aexn2BZKG8CChm2htAEsaNiWCl+dANvCDNtCrE6AbWEqNAMB28JUaAYCtoWp0AwEbAtToRkI2BamQjMQsC1MhWJOwLYwFYo5AdvCVCjmBGwLM2xLhd6rYYBtYYZt4ejVGgbYFmbYFo7ermGAbWE1vfYBroUZrgW/esYA18I0oVLgt88YYFuYYVs4moXKANvCNKVScPxqOeBbmOFbOJpcygDfwjSpUuA3txhgXCrDuHD07mUFGJfqytgPNXYFOJfqKrDrqwDnUvW3ftDRXAHWpTKsCz6aK8C6VFecHs0V4F0qw7vgd78qwLtUfX4L0UFwp9vwLvhdsQrwLpXhXfDrYhXgXSrDu+A3xirAu1TmmRGBX0MHzEtlmBeBDtEKMC+VYV7wW1MVYF4qw7wIdIhWgHmpDPMi8CEKmJfKMC8CH6KAeakM8yJxcwPmpTLMi8QtCJiXyjAvErcgYF4qw7xI3IKAeanoTJcK8C5V/xIJbmzAu1SGd8GvOVWAd6kM7yLxlwcA71L114HQkKcCvEtleBeJRgQV4F0qw7vgV0AqwLtUId6lArxLZXgXhZKZFeBdKsO74BcgKsC7VCbbRaHMWQWYl4qRN/AqwLtULORBAfNS9dkuuOsCzEvVv1eCGxtwL5XhXghjA+6lMtwLYWzAvVQm24UwNmBfKsO+EMaGr5cY9oUwNnzBxLAvhLHhIyaGfSGMDd8xqcgYpho9ZGLeA8I9BnzLxHAv+OWYCj5nYrgXhft8+KSJ4V6we0oVfNMklOlSwWdNTKaLQk8SK8C9VIZ7wS/TVIB7qUymC35DpgLsS2XYF4VeDKwA+1KZTJcaf7EG8C+V4V9qfBAB/qUymS41vpYABqYyDExNPF0D7GcyXWr8LTbAwVQ8cPJQAQ6m4uZKJX/J+OWVAlEXYGEqw8LUeOgAWJjK3BqqcXMDHqYyPEytXjJ5CQ0IaJhKBMjPCtAwlaFh6hoVDOxn3kHpBCNl4WtC5lGuAi0LrGc4GELHgIOpNNFSXuGDCLAwlWFhCLUB48lAanwFSJjKkDC42gAHU2mahVAboGAqzbIQagMMTGUYGEJtgIGpzBMpV7ijBQxMZRgYXG2AgKlkaPMACJjKEDCE2oDtNMVCqQ3YTjMshNoA+1IZ9oVQG2BfKmVshy85gH2pDPuCqw2QL5UKBS6AfKkM+YKrDXAvlRK02gD1Uml2hVIbfMtLhdQGbKeM7fDFFzAvlWFecLUB4qWqA9RZBYiXyhAvuNoA71LVjFYbIF4qza0QagO8S2V4F0JtgHepamM7fP0AvEtleBdCbcB4dShoAbRLZWgXQm3wNbYrUm0ckC5c8yq42jjgXLjhXHC1ccC58CtjO3Ql5YBz4YZzQdXGAeXCe8oFVRsHlAs3lAuqNg4YF34lA2oDT7RdqYDawCNtV4FohQO+hRfGdsQLefAxvYJWG6BbeBEgzDigW7ihW3C1AbaFFxWtNkC28ILTagNcCzdcC6E2wLXwwtgOfy4QcC3ccC2E2oDxDNVCqQ0Yz1AtuNoA08LLglYboFq4eXQFVxtgWrhhWgi1AaaFazKlLFCKigOmhfePv6JqA0QLLwOpnRwQLbx/ARZXG7CdeQOWUBuwXVkH1AZMZ1gWQm2AZeHmLdgCJes4YFk4o3cJHNAsnAV2CRzQLJzRuwQOWBbO6F0CByQLZ/QugQOOhbPALoEDjoWbx2ELdJfAAcfCGb1L4IBi4VVgl8ABxcIrepfAAcPCK3qXwAHBwit6l8ABw8KrwC6BA4aFaxKlLPBnPgHDwit6l8ABwcKrwC6BA4qFV/QugQOGhVf0LoHDp2M5vUvg8PFYHtglcPh+rKZQSvyhbg6fkOX0LoHDR2R5YJfARw/J0rsEDp+S5fQugcPHZDm9S+DwPVke2CVw+KSspk9K/NVyDrgVLuhdAgfUCheBXQIH1AoX9C6BA2qFC3qXwAGzwgW9S+CAWeEisEvggFrhhlop0F0CB9wKF/QugQNqhYvALoEDaoULepfAAbXCZWCXAJgVLgO7BMCscBnaJQBqhRtqpcB3CYBb4TKwSwDUCpehXQKgVrgM7BIAtcJlYJcAmBUuA7sEwKxwGdolAGqFG2qlwHcJgFvhKrBLANQKV6FdAqBWuArsEgC1wlVglwCYFa4CuwTArHAV2iUAaoUbaqXAdwmAW+EqsEsA1ApXoV0CoFZ4HdglAGqF14FdAmBWeB3YJQBmhdehXQKgVrihVkp8lwC4FV4HdgmAWuF1aJcAqBVeB3YJgFrhdWCXAJgVXgd2CYBZEVeBXYIA1Iow1EqJ7hIE4FbEFb1LEIBaEVeBXYIA1Iq4oncJAlAr4oreJQjArIgrepcgALMirgK7BAGoFWGoFfybHAJwK+KK3iUIQK2IIrBLEIBaEQW9SxCAWhEFvUsQgFkRBb1LEIBZEUVglyAAtSIMtVKiuwQBuBUR+ICOANSKMNRKicbRAlAroghEKwJwK0LTJyX+/RMBuBVRmi+14B8RAOSKKAOxpgDsiugTWdAMBAHoFaEZlLLEv1AA6BVh6BX8wykC0CuiNAZEFycB+BVhPq/DUJcsAL8iNIdSMtwRAYJFGIKF4dMPMCzCJLIQmgMGNJ/awe8PCcCwiP5rO/igAwyLYPQ3kQRgWIT55A7DxxxgWIT56g4jPlwB7GcoFoaGsgJwLMJwLPiHUAQgWYT5/A7+LRQBSBbBAps9AUgWoYmUssKHEWBZhCZSyu7TAoi1AcsiNJNSVvgwAjSLqMhEJAFYFmFYFvybJwLQLEIzKWWFjyJAs4iKvIgiAMkiNJFSVvggAiyL0ERKSXz9BLAsQjMpZYUPIkCzCEOzEF82ATyLMDwLnkotANEiNJdSEt83AUSLMEQLnkotANEiuPnkFfoOtABMizDf68HzowVgWgQP7PgEoFqEoVrwZGoBuBZhuBY8mVoAskVoPqXEk6kFIFuEIVvwZGoBP+GjCZUST6YW8Cs+wlgQNzf8kI/5kg+emCzgt3wM3YLnGgv4OR/Dtwj0pWcBv+gjQhYcfdRHWxBPTBbwuz6aVCFhAAuGGBcBv+6jWZUST3kWgHIRhnIhYADORchQDANIF2HSWfBkagFIF2FIFwoGsKAMsJ0CsC7CJLTgadoCsC5CihAM+GWmAFctAO8iDO+CJ4ALQLwIza3gH0QTgHcRKrSFALyLMLwLnmcoAPEiTE4L/py/AMSLMB8DEviHqgDzIlRoFwGoF2GoF2KNB9yLMFkteIK7ANyLMNwLnuAuAPciNL9S4gnuApAvwuS14AnuApAvQhMsJZ61LgD7Igz7IvFZBegXYegXiY99wL8Ik9mCf21CAP5FGP5F4o4f8C9CcyylxB0/IGCEyW1RuAUBASM0yVIq3IKAgRGGgcE/ByAABSMMBaPwrQHgYKTJbsETjiXgYKThYPCEYwk4GKl5lhJ/ZF8CEkaa/BY8MVgCEkZqoqVUqAUlYGGkYWEUakEJaBhpaJgataAEPIw0GS41akEJeBhpeBg8MVgCHkZqrqWs8e+oASJGmhyXGrcgIGIk/ZaLBDyMLAIvSUhAxEhDxNT4yABMjDQfFcJBAOuZ+0T4bU8JeBhpeBj8HqkERIw094nwC5wSEDGyCNyqlYCIkf0njfGP9QEiRhoiBs+nloCIkfR9IgloGKmZFvzxZwlYGKmJFvxhawlIGKl5FvwBagk4GFnSr4xLQMHIkn5lXAIGRmqSBX+0WwICRhoCBk9Bl4CAkSX5GoEE/Is0GS740zcS8C/S3CPC0/El4F+k4V/wp28kIGCkSXHBn76RgICRhoCpcb8JCBhpCJga95uAgJHmE0NobCYB/yJ7/gVdniTgX6ThX/CoTwL+RWqKBf/EnAT0i+zvEaH3RSSgX2Sf5ILeF5GAfpHmHhF+UUMCAkaaDyJf4QsOIGCk+SbyFb7gAAJGms8i45cIJKBgpPkyMp46LwEFI83nhvCEcQkoGGk+kIynSUtAwUhDweBhuwQUjDSfScYziSWgYKT5UjKePysBBSPNx5LxrFEJKBjJA7sHCSgYyY0FicLAgjyQMSEBBSM1y8Lw3EMJKBipWRaGZ9xJQMFITr4IIgEBI3ngRRAJCBipORZcLqBfpEl2IaIAQL9IQdKfEpAvsn/NBV91APkiQ6+5SEC+yP41F3ydBOSLFMZ2+FQF5Iuk382VgHqRgv7ChgTMixT0B20k/LSypL+MIuHXlc3nlXGlwQ8sm68Q4daAn1iW9JdRJPzIsuZVGJ7yJ+F3luk3cyX80rIMvF0mRx9bNnMO95rwg8uSnnPwi8sm04UIRADjIvsXc/FABDAu0jAuRCACGBepAq92SsC4SMO44IS4BIyLVPRuAfAtUlMq+Mf4JKBbpGZU8I/mScC2SEXenZWAa5GaTiEiIUC1SM2mMDw5UAKqRWo2Bf86pARMi9RkCv51SAmIFqm5FPzrkBLwLNK83IJ+HVICmkXWZtLhyzOgWST9TK4EJIvsSRY8fAQki6zNpJO41oDpNI/C8DQwCUgWST+UKwHFojSLQoBQgGJRmkVheFKVAhSL0iwKw1OJFKBYlGZRGJ5AowDFokyeC3oIrADDoszXmtHgWAGCRV2ZWYcudQoQLEpzKPiQV4BfUZpCYXjChgL8ijIfbMaTMBTgV1RBxikKsCtKUygMT8FQgF9RJs8Fz31QgF9RReCgTwF+RWkShZXog28KMCzKMCz46wsKMCyqMObDPzQPGBZFf5dIAX5FFcZ66NRTgF9RJtGF0gWwnqZQKF0AfkX1iS64LgDDokoz+fCZCigWpWkUfGVSgGJRZeCMSAGORZlrRPgGWQGSRZUBgkwBlkWZe0T4DlkBmkWVgUcfFaBZlMlzwcN5BYgWZT7ijOfmKEC0KBa40qAA0aI0l8LwRB4FiBaluRSGJ/IoQLQozaUwhjsjQLQozaUwPDlHAaJFaTKF4Qk3CjAtSpMpDE+4UYBpUZpMYXjCjQJMi2I1GTwpwLSoyhgQn9uAaVGaTGF4co4CTIvSZArD820UYFqUYVoq3NqAaVGGacHzbRRgWhSd6qIAz6IMz0KEAoBnUYZnqdBIRwGeRVUBokwBnkWZDztTkoH9eCh8ATyLMjwLniOkAM+iDM+CJ/4owLMobuyHD2bAsyjDs+CJPwrwLEpTKQxP/FGAZ1GGZ8ETfxTgWZThWfA3FBXgWZQmU/AdrQJEi+LmlB0fzIBoUcIQZSjppADVojSbwvAXFxWgWpTmUxieUaQA2aI0n8LwJCEFyBYlyE2fAlSL0mwKw/OJFKBalKFa8HwiBagWpfkUnBNRgGtRhmvB1z/Ataj+XhH6opACZIsyb7bgjwQpwLYoGSCqFaBblDTWwycJ4FuUeTiXiAYA4aIM4YLnVilAuChp7IfPKEC5KM2qMDy3SgHKRRnKBc+tUoByUebdFvy1KQVIF9WTLiiPogDpolTgmoMCpIvSvArDn5NUgHRRmldheNaWAqSLMveLUPsBykVpXgUPmQHlosy7LfhQBpSLUnSevAKUizKUC5oLrQDnoszdItxygHNR/bMteFlgOJPdgvcNUC7KJLfgsxRQLsrktuD6BZSLMqktuO8GlIvqKRe8LLBbbaJOvCywW22cJmoLwLgow7jgm1pAuCjNqVS4LQDfojSpUqGP8ylAuNSaU8Efiq8B31JrSgV/4rsGdEutGZUKtUUN2JZaEyo4w1kDsqXWhApH7VYDsqXWhApHx04NyJZa8ykcnRc14FpqzacIQmcSlO1sg5+z1oBqqTWb0p2OjcdODZiW2jAtOAZAtdQmkQUNd2vAtNSaTOlerkQwAKKlNh9/xm0MeJZaUyn4pr4GNEutmRR8x1QDlqXWRIpC51sNSJZaMyn4qlUDlqXWRIoi+gbspnmUGh9ngGOpNY1S43MIUCy1ZlFqHC9gWGqTw4LjBQRLbR5qwb8cXgOGpQ59/rkGDEttGBb8K8Y1YFhqw7DgH+OtAcNSG4YF//xsDRiW2jAs+MdLa8Cw1IZhwZe5GjAsdZ/KgmsDMCx1n8qCawMwLHWfyoJrAzAsdZ/KgmsDMCw1C3zMrQYMS20excW/dlYDhqVmgc+B1YBhqfsPEhHaABY0uSz4mlsDhqXuP0mEmxtQLHX/SSJ8tgKKpe4/SYRPV0Cx1KFPEtWAYqnNJ4nwL/bUgGKpzaMtxCoNKJbaPIuLf8KkBiRLbR5tIdZ0QLLU5tUW/KsWNSBZakOyECsUIFnq/hPQ6CPPNSBZah64DVb3JMs/Xr5Ybz43u0Nz+3Zz23x58ae///3F9fXh62Pz4uU/X1yvzT+2u2Yt9MWf/vmidVvtf/718kU77Pof3P4Qww9uf0j7o+5/tFvG/octLG1haQur/l/KorA/mP0x/EnaH73ksrSFS1u4tIUt1O47y+aHsIUt5tJiLi3m0mIuLcLuA5v9D1um7st035zsfzD7oy/MbC+6L6v1P2wZZsu0k9X8qKxAbgtb9XafW+p/SPvDFrbd6b6oY37Ufa3KqqV7Mtz8qPo/dXf3+h+9ZGmhdlmz5oet3qUrmh+8b6LLqel/lPZHD0xajXW5BeaHsgKtDqVVXXfm1f/oqyuLp2Nm2h/tr37k6v/rRvLq5qbZ7w/bX5uNO1K7B8KHodq9Ad93XZFiDuvP3ljvDvwGCd0xX6jivmlu3cpKOhPFmAure+tV6i6ODrW666JkrV3bZa+3TmvWttYCyupSsbDA67WHhp9kDjbsJfX/X1sHUE5K1iJd4eVJuiRVa2qvHtc39+vuD651CleCEGERH1b3q81Nc7/ee0KEo26rJHKcGUmNp/eOjT6NETNRQ3XbrrjVa8fehZ0FXfg5LWb1Zb3dP652q4ebXbM6bHfe6HPl2jnZheHTcu/a8bzdffVQumPZzt4u+I6Q9ugJcvRdSGFh1RGC1ptDs2uxeTO0DfUd9dluljFWeNje/OpNPRebnOrbaDh3xwHOOJgYQ3AYFu70LexADDiNTsjD9ra5B4ORuyAmRtHj6vDpcdfcrUFHhCuDnNf37aC7/dp8aXuyb3Y7f/h1L+CdfEdFduRhe/QndeFosSzt0mbXMets+n8QdhnrkkaIFqzn8PTUJYed5r1dXSXtHlsprbI9EVeOiMoGDN1z5P2PHmz3ZLT5YVfh7lnf/kfvTbldYbldYbvnMc0P23luF2huo4LumTnzw8Yt3VNg/Q8r2U7W7gGi/kcvWdiYRBTkOHlcjyxbuL6gEuRMe1z/2nz1LSvc5biyy7FFQfs8LUrX9NZmd6gXYRyPu/Xn1aEBiLpr8M4oCLT/0K1BH4H9C1cP1sg2ku0eTe9/2MCjtqaw4SG/ska2kSy3Q57bCKt7xLM3uzUyt0a2oR8XVrINqLkNtbhdqLl1jtwuMt3DP739yWG/+3js/mE8vYUzvQW99LaudnfQS5TxE954EI4BK3oMtjJ8D1G6K5vpgo3yRTEs4iFMBxDnuM6q6DVX2b1JGZS0BuEbd8M3Uq9dTd8huVFE99oFUfGwfVjfXB8368P++rHZXR/3tzf+kHbjR3p2Hg7N/rA6rLdexFw6qmXkAng8fGr/f33TTqhd89/Hxl/Juhd0TghKsietlMPqoz+jHY/a5RcSNbuwx7PelWO+8spu1PiwLbN7JjunmA2Mu08YGmNfUStUHzb6A9dprrDey25gFBWz95IeVo/+iJHuiKFh7Jvrbr32gLirGKspY3d1QdRZuMOkugrV3D52o8RXuHJdH7OOrgqJGWG/Kl2jKWs0O6Gtu2LlsBkW1mh2hl7ZNcSWqdiwjbSbRjIU7EC1sLb365U/EV3PVlEz+MNuu7q9WflDX7qeyS7pBRv2uCQUK+ywW/lBRuGNNbvHLuXww6pLWQqDHn5eI8jELZx5a1dnpagNgytus79r/BjBXZvbuLo3nF1wmKWNmN3kM+vApR1NUlJ7glHLmBO6ctVm+0JKPK7vb21M7U/PLqHk5JMEORw6Cf/1G3CErisuqZl9s7r51CD7+S7lxGmZrr7Zrz96XrxLSTjVlNSAGG+ouw+DneY1GbSbin8ELsXROLVy9BW7mec1W9WuG5uo3f2zv2oVbjBSFZP1N3frj8fdaPHrvo7oxKfU8gP3AcyZNuTu/2a73sBud3Ss42n6cS8GZoWTHemF/RFjgZQbVFVU6HIS8bi+RkJ8N1IX0zhgiFa6vJkoyIE0CDiFFCDOdB2JIGmCQRCyWnev4znTkPJnUMT1aJ12mSJGhTWDGNzi7q6TTfamHaptkDbauroq4eTstkK0dX0JwoUh6IHeS7hbHW/akFm7247qBDGjcAMYksgbpHWB594O3esDdNzu8YIgg3gozR0/iEx3opELJJDpjANEojumyDWSkDiW5s4WcpUC0uz/IuLcrQTtTn1xYyMjgt2RR0YzQLBdpRFx7oyqJ4ehEXfco6LcMVhTqzQUdVj77Fn3ao8jZnKOGzG/re7vO81BTC41KacdBhZHlS47LMnNwUnG10dAThfOdJJ8cjp12vW3ZA4AFVgTbX2o0u7+w0kAmxRglOlLcHlV8vDGSggsJe5wI+ldK8eGCc3dbvvwX/vtBtkHdTeVHApqSruoBDe8vKKnfqsVMynvtruHFSBSXBqLBSbSw2OrW/8w1yU+7J6psJSTDMiigiiXFSstv1ny4azUnk3a4zhmj/fYwJPZQ9PKnozWFa0YB4fhmQ6Nv9oVrteqykEkPZCA4f3F13XVJMmvF+7d8QYMwcKljEvLApeV3fxappgNxLfl/Jjd31VXll++Gs4z7S7YyqksHVzZfWJl6eDK0sGVNURl6WBu6WBud2fcnqZzu4Xi1iLchqvcUimcWw7SHj9ze/zM7QFw902C/oeVbPeG4mpg8GwgbIk4MXAsdhQJMfywZSzx2T1y2P/ogQlLxCqSi2rN1Xrfm8M1FlC7O1naaejEidbm683Hw/YTOBlyQ0dFnunqQzx/a+EeBiuSXjEVEey1m6phOeLCUsOFHW6FJcjKq+F8fzi77/+kODlf3NaxrbjrEPqmFR2VGGk4PclcR6c46RSMjI4mHJ/xOfNX0v5WS+g7c3fcjILewnWcFT0utJx2TW1HR7dLByzJlTu27Kwry4HTrqyDsOQO7QdHDWGWcDDb7BNFh3FaJMJIuQd09mC5tPOvtNOutHO9pMPjUwsYWmfSWE0oekGyshAuyqXQrLdj1n0ym03ErL9hw9HUkNzChgNC60tIdsoHgvXLJTuG+UCGrFrcOCoq3K0ksydCzNqD2XQlJofl1ebl2CMSaROGFHnC4baOdIV5NLDtCullx8KwaM8RaTncmgx89599X+2eX5BAblcHj/J1BrRNOrO5UPbA2a7VhV33CtIf3jYfjh8/tuuAH+e5S4ClhhXpOG6bm/XDyg+lCydUJJmQ26bdyN2jK5lyYz2SXLICsBNP4e567XoibJ6XsNGGsIuGkNTAum3uV199u5fuGklNh9ZTrD/jbKlbnzz38uqDrZIb2imSFTESwEEycw9iFMnJ3LZDfr0ZL2tuIsGQT2XHCHky5Ug7bPsutZGHCUJ83bo9I3eit+v9Y2uVa3jQrtxTDZJRvD0+PHy91oTEcXfv07Mur0oe1Debm93Xx4OfQ9e9VOLsj+i6u3aH1P3TNZzcLoFIDqvGP5sq3SwaQXa5+Qz488qlD8haXx63O9/nufy3IjfpzZdD01a4vX48frhf31yDMeieW5GhUSujC3QfmweYCuEOQkEuCHer9b1vIZdsKuzSUjAbP5ILm+GbfOpaub7fBigko2gk3K8f1u1y0h2i3I7TFNxzIE4uCEYSwW+6J/rVsN2wS2dNamrd3Ps5Bu6pTEXmkt61CoZnpcw9UldkDl9HDXTDf7TtdGdwZWOZqqJcXLfxvcYTQoWbvndF9l0LGKV2ubQzbQtdFx4ouLojo4FTVYDapWlYCLRJrxgjL12aRhSUf+9E9CSvzyu6Z0QiiAA5i3FnhY3vKhuZVPYEuFJ201/bTb/NS+f2nJzbzEJuY11uM+m4zaTj9gid2/N2bnPOuT1/5nbJ53a3zS0/we3hPLep3cIyFoLcbnUd17mMvtJcqmU4Fia3z4OQ1eYWzcxxTcioleRj0+6dur1fK2X78Gm19xcG5aaIkhkqVogJbztgMDe8dI/pJLmufWwO2LbezRW1iWeFdUmF5dEKm29WWgvI4ZTdDh8lKHWemkbO1GovBWvgE2xsbMdAMVyRsOyOtONNyuk+d4r7dAsXKteZiZryhZ2U0TRmbqKQJNf1ru54ADE3YUWSh+NtZSxlqPb2NTYjQVJReCvl5tjuHjcHyMgX7jhmdtYyS9kyNuQ4Waa1spct7K5GkmF522wf/2Mhtuu/VYQMCL10cykEGedoAUNoa9OtgS0K1xbUWtJK6qPKVhAM2d2kAaXoqXzQmYttSN3NYaAQd8+hAgNary14R9zzGTLb6CMcjIWb3l9xa9hqoDrtNQ0ZELlpDr9td78CyS5pWFnXL6shHAt0s9NQ6zcfVvvWgUJ9V66yQiaj6TIv7846N9vV0uZZlXYPVZKbXNBKRzUewWbQPdmRgdGhJdw+rr7et3sw37SuiyePGzoR4+av3LNDHmge4efcNC67SS/lQNQNhw2W9CUPnD/SMbFrChlSsyNgtJgKNyoa6CmS4/Sl3a83PrMr3Gwr2zlJXl+w0kZsoRsrWtqH2fxEZocds2cjbFjRrC+WIU9g2/SZHXc9rcirYm314yYw3ip3vAXWdYxNdE8Q+UAiWmrUMjvMRptsULA9NJT22EeVAQOaprEF0nUPzJ4lMTt+meWXmRxSd4dlzd5FJO8HDg1DV+cSEzZdWJL7oo+/NV7GW+ne+BH0DG+r6Vzt5vAJLogeYUBNo3biXD9sdz4p47gng9vy2NZWhT3MKYZMdpIW+HQ4PMK8tsLNPaisISpriMo6ksomrFU2ZbeyNwy4TfjkFhwv7RbCum1uuX1uYXK7y+b2vI/bbQ+3cSu3A5HbgcjttofbbY+w2x5Bck7+eHCzmgtLPhekXdcPHZGDUdhunESm0a83a8ACudXIQahvwW1W98iVDDe6EpSp15vPq/u1zXYdS7ny0hlp8K6UNcK8uCtERbIkVo4O1REhtQuGcmlWiL7pY/IjfMW46V9kCq+VYiJ/5EKb0yFOsnu9FDI/onQvvQgysOjFOHEwAsjxPpyM83pJmiZDZDhel5O5Nb2MIV5E5LijRk2MmsfVxwYRUbhQyBlrRHirIEL7uRYnd9e9LLsko/1y+UMyfwAIMvEcgsrduZIEYC8ssNKXLgsnJBUu9IKMg0Lmljt8riaGj10+ETEePUp6nX2XSfOw9k8WCvdIqiL3BGvvkI+5xlUkcHj50L2NX5ERa3ct16c9fObFPUIbFlrLfRU2q6WwWS2lXYKkPdSX5JR3mgaNugy7jeMLGy8Xdt0rhmcobCKPtGdI0kJVghp1XetYjwuXbKpsXKbI5eXe3AYetlb6jATc1nITCIYLfDY1pLRMRmlPlEsyqx42BtpxN0KW8CztPa3SHlGUlh8pyX1W147eaPkNuGdTpeXhSnv4WVpCrrSRaklmvfQNIDsDl/lnlsdj9o4bs9E3s3EVGwaaTdWSJLfRteoF5OC42U0XsZQVs6lXzI5EZgNBZgNBaZUtycX21DRo0yW3bPoFs7plctiQWAXYHCZpbxJJC1CRqf6dP4WELHMvxCnSp95vP7ZhRjtHH7ebPcjVcjM5yVTdh9V9F6E0t30GBLLkOHI4OSQNx+LHjy6hZdPyFLmdflh9ucYPwt3TClVRYxZJEHDT1Wjk25tf7/yYyH2nRZDHO13FXbsF3m12zX81N4fmtl2ajn6GghvCi5oKGE+SEAnuOSgZt45OKwr3ZKCyN/SFXRrkkOlj6QJF7iu07NG4YN5y3csge9iHauAczJ3Q/aIx5Nz2/7UvcgybSLsNKofdJDWg+jbhyxalu7MXZBLjpvnNfdXCt4mboUOu+Jvmy+H6EQxJZ2TZxXngDWwX7Uo65F6QO/HNdnS5yB1wJWmO7eGu3eFg4ZNLQZCeevvYmK2EWe3A1aTC5aEr8pQNu8jrEhDVFdXtx3ZT1JrWJ0/cuxKVXXUq8njusdncgrwU91pOYRmCwvIB0o5BdTUhs/PlOrkM7LXcKVmQudqPa3BnonAvWDFyihFPSrj8obDnbYp83YDI5XBUa2MHQsCu+bjulgKd7qrJgZvm8QBufDE3iUGRB9C7ZkwquhdQTuEfNVL6VW21+whU6iZzkod2NuFWp2PctfPFj4OdPhT24Lmw/E9hE9oLm+JZWvZJ2nR6SYa/Xcvtsj6eoIV76FWRGQ+t39oeW803Xz6tjq05sK2kuziSl9D2q/FDYsydpUpSA3lUzSUIpN0dKMtpK+vrFbkb6iSCJcR7psKeyYcQ2Yk5TpZyt9ZD8ihloJGoVuPHe1+gy2XYvtXUvOkEwlwx5tIYMoBlt243xf/TdPXXd5tWUgN8o7tpIvN1jDO/NnsXmLLiBsI2gcL+l4qQfIHjYyX3endB7qqMFFPFi3C8NEWbf0LGh9QxnpdbV9hwI0bKeAh5/LsVFe6XI2osz41DpZVHue6RPBj5eG9MKSuOCl+8jSx8rsPdFJQ2tq/JeAPKCr4UV7gxSGmv39Tkg35QOPJcXOHyiqUdvzX5BsJIpB/fuNRgaUmNmqTjoDT04bjCffOnrIZeUx5+4rzY5fYUuUzsm4NhqQ/b7YduD+MvNe4WgnyTad9t1/frG/2ADirGZboKWkmHD81q1wYOpBw3wCPv8LdytrQI9wiJvB/ZvYXUQrn5pEcouLznOh3yBGBvcg/8RdPNuCf5+r09wSdPut1FlPaZrYx2TPhndF4OAbkI2JrkQuleerIESE2+d4fLG6+WnnrsBCVzzY2OrhEy2iPBbAaGzUCzx+YFGb52gtsQHpPs5uOT12328AaIu8clqYTxBHYHe2F9YEEeQ+yPHx7WPvfYRQG4qgs3iC4tU1ey4YcNWO2ZY0lmLSDtWntTjbtHGKWNhEubBVzafLHShoMluVM6bLGkXsfxkXRJV3OU0utYitxk2YowOnJZUbpul0c9vg5RuI83VORNmsMWqeruQSp7f6qysUJldyXVcF13eKvKpkJySzdwS+Jyy4Fzu13kdmhwS1JzS1JzmxfPLTvKLeHJLSPLLTvKLTvK7Q1PYaN/Ye+/CcuHCDsMxZBZYc/f1XBbkDzaO2wPq/vrm9Frnu4N1OHqVC/e0i02ObSwjH9B3t8ZpTt5WyP7ei65/urq8I1jlyKi5p2uOHo62BkMw8u9JFlhDhBgYOfeySyHp3/IdxIGIeGIzru0bAdKTRLig1QslPPu79oBXpNpDSdZfgznv8g1QCJnnxWDB29uuFXavOOadNfE4u5mTFjWoBiO7Nhg0oDehsdSYHYb8/IfrGz7I6S+QSQYp95zp/18DAy20zMu4AF/70Wz4WBwWlB/rL05Png6dN+ZtvcLimLYPQUMbAWPvjDgEj32LKkmc1GwND73aZnCJogVdumVwwMXapAeHDp3o/25++BMQe7DbGXi+XI3YY98pu2UnuCvgG5lcvtsK0PX5Z64FMNAJ/ccw9kkdF/urU1mjwhqekl25IQ9mMt/lPXgdWIAYk7MTcliwxaXPKXzxAE/5l7fvhqAkTGTIwl3Ze4JArOhQE1ytK7A8esG7mYl5O6dPBV/SLo5y2Q2B0h0AR7BPRgo7N6/YMNMI9c2GMq7FBgZWh433e5zu+voOOR4xU0wIU91j5t19zRO92+oEDdeJClkm7CDbWXcLXlhI6+CNFAr6vjYJRc2Jh0NIZPdLzOQaZ3wIq67IWUkMzp6Uti71koe/7UD4dojIP3DadcOtAT/EwZu8DjcYlHD+b7dC5McRyeQcL3u3pLkr7v6upS3e3DpFbvjrcj52skYu013/2KPHWsy59PKCLtM974cY4OPIwfZPuAu3eMauwepSap3EOW7SuZdvR5cZWAAhdykO3YHuo48TrbCxi7SXTfJmOK4J19tKd2XBsRwclEMP6j+6US64V6tfQxwdFzuJlxJcjfhC0OOzN2TDJIsMlKGlw5HUtx7CZIMg42UIVBCxLiXnMjNmRHTv6aH9Mg9iSSJKpPDe2j6q0iBD2W4WYTkxavfVuvD3RYZBcx1ioq8soFkh7uLiT3EPH2ox55bnWKysGhIjDhRkxEwPMtlmxj29LYBuxpR3qdvSD+8CA4D3ZTd4Y2vvh3bE2rsGbGEe3bnAPmchpEwPsRz7yaR98yxCyGlm48q7JZekrGHkQFnsDv1Cqv2muSukTS4yntqNlwPLi3uuGTDzphcc09SJhYXN+y1FzTqwLyxYrHlxe0fGw7ayCu1jjB/gXGPEpkY+ho2Ob3EuMeJbGA6yGvCJ3HjRcYNo8ldVS9gdLAEA2r3rnjBbUBtj7hr8lxldF3JHVb0iKBvK7n1yfePbP3RbSk3+hRkzPrb6C0W91AWT1X4x0udxXO/3rSl/v6Pf/3r/weplr0ATmoDAA=="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE+29XXPcOJI2+ldOWLceTZEgPjh3Hrd7xvv2V7TdO+fExISiLFF2bUtV2qqS296J+e+HBAgWkMwEARIlbUy/V11tAYkHmUAi8SAB/vPFfvfb4cWf/v7PF79utjcv/lS+fLFd3zcv/vTi+m7TbI9/XD9sXrx88bi/a//pfnfzeNcc/mj+dNX+6fLT8f6u/fv13fpwaFpBL1786+Ugi4tB2qubm31zOAyiNttjs79dX/vS+lKI1JcvHtb7tpgP7NRWsSqrobHf1nd3zfFqc5PQ3IVbaaphW5MCsG2Ov+32vyYi8GothfDw+OFuc331a/M1BYJXaymEtflzoha8WjMgIKPuz+u79fa6+W5zOMYhcSosHYs36+N6XqMXfdVYHbi9JMB8Wh+u7nf7ZiYgp3pGUNvmy/HqYf1xLiq3fkZYx91xfXd1vXvczhw0F76EZdCQUR0/nJ92HM8ewPlG7qIhm3GsLhukWUfn0mEZGo+tgEkUXZmlYzB+WR1aS11UdVeo9az7Y1LjTo1lTd8015v79d1k/HRq2qmxrOnr3fa4X1+3DcSFcCcISM1kKO446z3jBIC+1NKxtr6PmFtuWxdDjclO2o6ExllSy32FGQ17+t3v1jfX68Px/X590/zc/PdjM7nCoHWW6v6w+bhtblp3+fWulT4bwcVIzrSCUBVMq2t7uG326Rpzqz2b0kYgFurN0wWuutf7Zn1s+pUlTm1YlaUqi94jkY0nbpjQflNe4Hhs/7o+bnbb2eh8GUvhjS34rtl/bvbvuuESOfrJeouHvxZ5pYfufnqRDuO4QKRFag9TCQG52e53d3f3HaSI6HoC8VhYFsBjmycsDuMKT7IqE80mLNBITwlAt/vd/VVkYEjhgjIywjvuloLzJSyDhg6mhKUTrfO0Q2q8WM4YVcQKOW+vE4CWtvdJgpc6qhC9zRlVMdBu2r9ttvELJ4rOF7IY4Hjk/03TzSnj3quRhyKf2e7FUDtSMX5no9Xyt5kgzf88GdsQRjBrFmJqIGA+HporL1xZhhYTlwW0a+tv14/XjdkrrK8jJuqo/FLbHk+irj6tD59mtX+BSJlU1bjruIq+3900d2/2+92UPU8FlyrlupWU1thFX2Wy105viMbv2y3HNK8K2z/VmgfB1fi7prnRA7k1ypvPzWRMMCr/VMeWeMNpB5jjzoZBtW4hYlcVRnaSsQhe0GY/N4fHu2TLmVrPZj+n+YVW7Lt/FlsiKJdYNAy1+XJstjcdCRXL0QTx4uJygz60xRcq9iQiAzh/ppy2+ZMAT0WfmJYZNT2LifH6GpwLU6cZYzynenNhUFaJW3NA+We0j+PglxopuAI1s/VyYasuAlOualnwkraZb7jj14cJbHMNFxw4EdkAaJ0nyAug243OEMC7uyxXIAArJWsgCVps/kAAW1ImQRK4+JyCALzE7IIpgN6Yb0utj4/7JilKRystd5tRKz3ddtJCj/d7aRQaAJcWhM6BFxmDTmNMCUGTgEZnL4ZApiUzzgTYBrZfcmDs5WSG2QUFm+3HyIPp4JQZScoM1eVzumV8AVZE1BnBLhqjI0HLgU577bh9eqDqk23WpzDkcJY5t+2xeBc7zjDohe7TBZzDiYbBZpn4LuR80z8eeAZN53IFEzSJrbMYryspF1TXd+lz7AmUusyTnTWdWks8VzJdWegMndaTvF6w8WhP4bSe5hKCzR+7PyY17tRY1rRJ/IjJP3Ba9yvlABCRbjpqPzbjNKz6XXLv3SrLG0/ruVNj8ZCLPPj0R51TKRnAyK1FEEZDuScgify2oomhU1eWkUGg+RQCaBJCLOkDMCQRPZMg4skdACOR0MGAgLEXP/ZzHfenLK/+EX/yIosc6yMuN2HJ8/GMq+cA9bhNyh4foULq54C1DNRZICUmjmRJGYnR1LGNbKcOs8YasrVmQmAlNq3faalvto/3A57P6/1m/eGOhHOq8odixlwXnLOTh7nyt3DJbV9cRW/Z8F4TNvqp2d5sth8XA7s8CZoH8LLvIIFzuMuxHKkr6ixYX+/uH9ptyHJrXzqSzoL02/XmrrlZjnOQkwslPN4Mz+TR6SbeSvocVhiA9+5EblrBVNNdwTlBAohLbp3ciKjmLpxqKQZ5D2wAA6TbySQNW+xpQyPb4Jy46HYqGSMVQyoFEYSQFpINGGaEYgEQ8anrPorEbPVJXURuyl09pGzKw43H3SwAzSdcJpgCcOz/norBr7cYxpyYfMAyOyAPAFoAJz+YOXG4b6k5QXhIO9ER+EkraeG33ziMvdu/JgXeXvmnjLqxhlNDbr+zi+PtAKTkYNuTlTHSDmFMD7NTUCbE2CGQyQF2Csbo6DqEMDG0nsCHxtX4LMWDal/+snRBKzCO9B2KPg3v6zeXQv2e+rSY/QUgEgngSSAJHDBAkkoDT0JJYoIBmHQyGIPjjsxfDpNbna7I0pE4GcsNjVzEhW8aNzXsN4eHu/XXK/2/sc2CSqkAXJ1G3ZvMc0lyUq/u3cI4zYavO0bvV+dfwQwDuGlu1493x8jnkFwU45oLofhp91ERqIuHqJ4OyolFzd/crN7YqDRU84ni0wgICZFqUBXhmNW92pML8iUue1E3JqKyV+0W63PTNZitE57IzNhhxBY1lkexW7DNZVGcER0Rw50KPkEEBxqLjt+c3iyL3iCAlNhtGkRs5AZRJMVt0zDiozYIJDFmQ6EIZ1Kb1as5vHrYvPqy2R1+Wu/X99qjOHfVbx+3ml/xkAWr5vbwMxFchIvEu/+wnLAWqQv67vtcT9LRS9jkObs99sjPZmC/3/0//qF4GgUApROD4WNzfNKR4LX3exkGp07bMcCeaAw46p4cAPBh1CdSyanZ399wsO+v9qOCP/momHhD9q5dv/2ST+Qm8IZ/LwME6b0dIvKJhghmgOlB8gzD4/c6ME5Don76IUEPhr15t8u8T/Xt4/bmiUYE2u7vZViMOz/Emk8VbCL6n9z3ffsQr55vH558Z9c3eQH+bd7era0Iuu4yRpVaujsLgl22/xpBxzgvpwdzthRh+PM3DfOxJ0fDsV2YGe+m9mRR6BbuS4bgbEFvztKP8/dgycIY7sbypS+iL5QLX1+3i8DXhK6YCk/vzJ12L7A/zHTrfW1MJ5kdfFwHFrp6ujvncPqRXVrg/jP0J30hSO7W3CVhdu+WLQ6R/cuxTOTo4Zn79pS9WrSIRHYtw3KS1L/xJ+l0hbf2VGrinAqtM+eEdNpHpwK4WOSLTwqId7nJCOe71gR4cV/cikI501NOgg05xGS4GRxfCuBMUM8AMuCukpEud0sY3KJUqPcZcPYtUCBnOBpeOF9Hbv31cf947Z55x7R44Vc8tX483Pxhc/jDZvup2W+OOr1lSi1pPjAO3RK/l+DuosDMd3Hpni0R0ExvNseJRSHL4LjS/FUqqnx4Aq4pCtRyd0SmZ+y2t5uPj3s/bS/WK3hVR37hYb87NtetX/h/ljkKD/CH9aH5aX38lIbVqfU0MNcddZ2G0VY5G0CHVXFT/VCmPRzpT1Z/EsYlDsXFdLF4NmZa1rRmg4lS6JP3T9H7S7T9p1BIjrOt8ysjKZ8qn1Yws9C5Nc83esaN/16HDtBEUg5WxnEDDRJIpxi9Zz7B8+TWGInh9zqEcIUk5W1lHEmEeSIH1DOPpf87jJzCSWldZxxB5OA5PH643/j3UJrmBnt8+0kUGAPn9zq4JnWTlDCWcbBNGy1+8NnXl/83jUAc0/8dhiEFpSWonXcwYvaL2qNPJbCNyz/LLtymjyD/Pn+f3VZG1BHkkufvhSZ7kGmvjHZqOlPgnB3LsI2b06scu5DpzuXbZ+To49m792Q9yxy1Tff0LHFZpp4vDhlmdT9TUBCpg9AiFZOiR1R6nuXKTVSh/rhg4eolUHo61xIW36tci1m4o2dd1hI6m2OBW9TTLEtdQoczLnpZ+/2EXX6G3uZeEhN6f57FMbc2li+Ty1SSa8FM1gvxPdyuUmwSIlkvTyIi6ojnILnIs7LE5P7lw5xhgYhKpwusAbNw5/PzyfAzIz8P6HiPPKsTZ/G6czoVcqy5epbJeU6lSMLyoXQaWPZpUiXRVpemS466ne6t46Fm8dCpjjkaXgZnPNMHR0PM53fT3e1skFnxxXvWaLxn8aaZnOiSTmRynIuTOUm/lTmhMxZ4TFInjjlrYmcs3MnkThxrvgTPAFCHm9OftUOPp8JbLbrekzB0E81fBP4ez9MFhATURg1f+5a9/+3d8/TuctTaeTqb47Q3d2eTkjCX9BoqOZiz+yRW95v6dza509Ok5MlF9nbVS+fXPomlnXb+nc1su5mU1rjIxoNiA6mLRsq5++619O9s5FNHk3IPF5nZUW44LJpKqHEKPm3gY4+A3X+YEdq0tdy+EtufWcELjXBJeOIDnjhUSF97A6Dnrq5JiBMXkADcWUtEEtZkXxhAO9PbTeFFp3RM+gEs/cST2z24Gv3rnGneVx0pIeuEj0C9aOoTncjvBGI6MtsdzOtFqmOI6cI8FzEPf7qziOnBXLcR3wf/Y2M3SS/BjCssPX0l5mVS8xcLpuDkaRM22dLQzZ1XMUfAS3DNmixR56RgWqTBmjkDps7VhoIhCnMo9DQnaX5zS4/QTj1Mm2vTwBbMr5RpFaGhmVMpegZNQ5g1axImyzSCmRNk8fnJeLRmPjiZhBpzYgKHbs6jkkmAk2ckAF2+wxEMmr9X0N93nHcwQld9ql3EBIKLcJGk/UVATliLEeck5tvQT9HZS6zZc3Y/E/V2nr6nHqEsVAKi/KmzlCccGaM2fy/Dwu946jHL0jEB1B48b3nC0eA3+HsZCk6vU49ilo4DV+HhMxkj62kUApv8vQwEr9+pxzVLh4Kv9MnALeLoxin75KGZQ4a7/zYv+DI8uNv1iE1totsMAl4eQI26EEvrZu3GstU+tQ+zlq9wBxYsUKnoZ/rdMP5FnjWiB5SziDwUghWe3m0AWnz0h5kO5MSIj3RyBlcS14kMToXu1rncS2TXFjqa2f2a53IiO7XE+czu0Vw3FNmnZQ4pqVf+WdNQIeG4aVwn54mTP2pSQVwsns3xp08LkS6bnJEnUQsxLphrsadSYEolQ1w0dSJOqIayExzyUO7Jzqn8FjMcVZ26mjxPoxAunpuJUzJObYumYcrsi4KzYMalTbQoNIsmV47TrfEYz3/ANQk48owLjvbMx1yTMGNOugDGrIddGEBnJ/TLYdZZF1ntSXZF4dYv6D/H75BoGbTGaKb69eO+a6KretaeXY7aOkdHc9CSeTuadGw1v8dQvcEZNUVCnso96ZyxHIzz/+mzoq3kdJNebZPHPYluwcj2wAZpoaFYDCUECj+tEd0dLPzHGebsa8L+5zTsNOIlJsY7EN5o28Kxm+xR+aUbbEKPKa1fzNfZ1C7LlgvFLrbM0+yuvNaW7qyG7qUZZxLWfIMsjsxH+skclU8BjYnIfYxZo/EpeJORuI8tXxSOAHMWnb+t7+6a44wYPFDxSRajqfYvQgXiF6mQlJDugolEpuLZ+3cJWjtXZ3NE5Lm7mxSTL+u3r2Z6G/ZUVneb+nc3+dDXpDSxhfY+KXjK2FFfTM+qh4QPaf67mL7vclKCWK4RYNUdyBDzCk6cE+bQC9rmv/tgGHc6KUls4XBAVD45IJ50JPy+hsBg+6jP+2SzPZEaeJIxxcm5JZ84hrbMl/cvc6LktprX4eDpXFpEFMC4INIFgKezWPKBnhmozUScGItEAZ8VbaThn7+EhnqwdJGc24fM4HOjxt1WDB89Kv7UDsxleMf/PMuV9XXHmsjp1GJwL3FvVCeyO7qojsx1eUt7ker80jozzw3O7NMChxjVq8WucXG/ztahM/bEOdk5FY8920FqLD3dQX1RWusX871OTCbiMmwzHUk8MOgx5uKb5RuiEiUJJ5AIdOl0T4CaAWMGcO4p46lk6GTmVOppThpBe0vPGp1OpjiLGGCzHUS8X4iAMdMXJLuAFCizpv2M2R6BaekMT5nYSXDm45h3Qo3Mq8xn1NNgY06pIc6s59TTECdPqiG+fGfV+KA7WdqU7PQx4Lvf3TzenfB1f0O89EkaO4n786t3b65+evX+r4Owz+v9Zv0BihvKRbl/jQ5t7/WP33335vX7tz/+cPXtjz9//+r9u4mGxxXmIAhuq5MavojbRhMiyPl7+LwIzqURMAfSOJD3v7q+FNnhXMiOS5Edz4XsYfPgLE+zsFkRedC5W7Ofm/9+bA7HV/uPoVhUi3aKzpl0nk66hhKbuzB1plXgdolofveg99DJEE71ZsNwYu0/t8Ve/fSWWliMpzVl5ig8Mc4eNUdG2VSPbX+WRCUoisiYZCauqQBkDCkq/JiJJhhrjKFMRxoJOJyx2Y3ezb65ebPfTwwZr+RTjdNxo8mj1e8hYY3bTXN3k4rEVpqPwQmRdg+NGfrmK0Lfr09HpvhSMq4wxyijEPN6d3/vTFsQZJq/xoaZ3/zy/ff/35UOIn/5+Tu6P71Uv3hUb3q06DlOV21/1CfXb760W68AudoDGNVYjOHQHNuQ/v80X9/vfvzwX+08ncQwqpEDQ+sDNtevHo+fUmCMKmVB0rTl98lQRrVyYPkxFcaPuRG8a/t1/UkPuOnRCcpnaL+dhneb/2m+WR/Xb29/aJqb5iYCBVJrMZbjrltn3x33m+3HSQhu4cUtGyavD+K+7VuchIDWmokl6ex3sv0L/E9x+9egdFxTwaUECwRHK4pTKLiwuNuZ124tPR+aY/jhBL8don6kBd1uUeGd9uFZ8FwMsuJhUQLJfVo7rfXPLIAdaeeD/NAK/m23v8kD2ZF2Psjr6xbc4f3u12abaWR4As8HfLR1WoQa3VblhnzQUfHb7U3zJQ9qX+B5df3jJG+RqO4f4wiNRcBvd/v7Lih47W7qFiEHErNCd3ejYNHNhjl61Y2R7ikD38x7VandbKC1Rctf4vZ+CkbKPj8gK3J9TgW3eEmOXohTkWVYe6NX3FRsGRbZlKU12ahZVtO59OMkvAzLZspimQovz/qYsirOUeDyhTBp+UuFmGnFi1vnloBbvrRRC5qXabE5/Mdht/1+s8AheiIyKBRuc4mNbXgr66yUm203Lv+4vrnZt95nLK0vcNUXCMp1g4FXQOCgNyjwFSnYVRHEOWPhDzUct9wDEFYCNSVbHTZ3iThsHeSgZfN5fWyW4PkViziCaH4FQcYiLN7Mul0/XmPJZkE4Q6XZ9oH5Zm+RaCIIwdbJhuCH5tjGJL/OAeJWzYOnSxGjM92CeEDVbPoJPJY4pZ+IxxLT8ZC5iVNoJhMT07GYrK05Q8epmQfN1KufYecb+exnIqbjDjD6cWicavNxICvsw+aq8Y65x2usLRK/yv70ljg6H8u0ZWNX2gEv5cL3u/t5jV+4VWNhDCIWrf0EoLTlPwTJW3E/HY8Pr3fY9xOnADk1s6FpS84Dc6qYE8v37ZRZf5wH51R3CaJUb0HgSXAYQf24r7BtN/cPd819W59MjhnDGtd6lrlOwCBmfTBDeaw4RDNZ/AEFetYdkETYs30GBRr1HmdDnOBXKMCYhzkn3gTfE4CMeaGcqGf7Jwoz6qmy6tnzYevH46fdfvM/SS4MVHomD4ahyOXAoFoy+S8Ucjb3RYNe4L1QyHmcVyTeJN+Fws3iuuLRJnkuCnAWx0VjXuC3UMR53FZAx47X+mF3/Hb3uI33WF6FZ/FWYwR5PJWviixeCoGayUNRYGd7JwRqDs8UhTPBKyEwM3ikWJQJ3ggHmsETUVhneyEEaQ4PROrU8T5vt5/Xd5ubnp77JtoFYPWexReRQPK4JFQ/WTwTDTyTg5qAPttP0cBzuKsU1AleiwadwXklYk7wYUHYGVzZBPLZHo3GncOxTel77N96wjzdwfkVn9PDIUiyujigopw+DoOe18mR4Jd6OQx6RjcXhzvdz2Gw8zm6aNTpno4Ans/VkdiX+joMeUZnR+uciubmhVDP7ucgjDPEceeK4s4cw50ngjtn/HaW6O2Msdu5Irfzxm3nidrOGbPFR2wzo6Rn92IjHOeI1c4WqZ07TjtTlHbWGO08Edo547OzRWdnjs3OFJmdNS6L8Wj3u8dtclTm1HpWfwZg5HVnjmayejMIOrMzQ2Ev9mUQdE5XNo14hieDgDM6sii8M/wYAjmjG0NRL/ZiEHNOJ4breezDbMpsOpEGaj6nL8OgZPVnUEs5fRoKPq9fo+Ev9W0o+Iz+LRJ5uo9Dgefzc/G4030dBT2fv6PRL/V5KPaMfi+g97Hv+6nVVqqrGeo8p7/zQWT1dCed5PRxAHBe74ZBXurXAOCMHm0SbbovA2DzebEYrOn+aww3n+fCEC/1WQBvRm+F6nfsp77b3G+St5mnSs/pqQCKrK7KUUtOXwUh53VWKOil3gpCzuiupvGm+ysIN5/DikKb7rEQwPlcFop5qc+CiDM6LVzH7o3Cu32zvvlqHiCNdhjjWs9zyxCHkcdxIZrJcxORAJ3JdQVhz7+tSIDO4bziESd4LwpwBveVhDfl1iMNOYMDC6KefzOSwJzDhYX17Piw79d33esuzU3/Wmi0/0ArPosno5HkcWa4irL4swD0TC5tCvxsrxaAnsOxJeFO8G0B2BncWyrqBA8XBp7ByU1hn+3nAshzuLpJnXv3LA+PDw+7fSv1VdtavLdDKz7TfUsKSa47l5iKMt27JKFnu3sZBr/g/iUJPc8dzATcCd4uADuDt0tFnXQfMwQ8y53MMPYF9zJJ5HnuZk7oHMne6MrNuD/gVHvW/A2II28Ch6ucrBkcI9iZUzhw4ItzOEawcyZxRGCekcUxgpwxjSMO8Yw8Dgx0xkQOHPfiTI4R6pypHISuxx7tmzbM22z1c5+p3gRWfU7PhmLJ6t1Gisrp4XD4eb1coANLPR0OP6O3i8We7vFw6Pm8XgLydM9Hgs/n/QL4l3pAHH1GLxjS/dgT2ndNk6M7v+JzekEESVYfCFSU0wNi0PP6PxL8Uu+HQc/o++Jwp3s+DHY+vxeNOt3rEcDz+TwS+1KPhyHP6O9onXvfPj3sHvfXzZsvn9aPh2PCI2l4zWfxdwEoeRweoaUsHi8EPpPLm4Q/2+eFwOdwemnIE7xeCHgGt5eMO8HvTUDP4Pgm0c/2fCHsOVzftN4d3/etfslfJ6P83KyvPyU4P6Lqs3i/EJY87o9SVBb/F4SfyQFOd2C2BwzCz+ECE7En+MAg9AxOMB15ghecAp/BDU7jn+0Hg+hzOMII3Y/3vO82H7fNzU/rr3e7dbwvJCs/596XQJN1/4uoK+cemOpC3n1wsBNL98JUFzLuh+Pxp++JKfj59sVJ6NP3xoEO5NsfB/uwdI9M9SDjPjlsA/q+67vj+viY/BgJUvt/w71XCOcsd19djZ3j/uuoE+e5A4t3I9c92FEnznAXNqIH6d6S7EA+d5mGf/69WKwL+e/G4r3IdT921Icz3JEleuBMZyuhO4EeOjH+5lT3Z8QNErdDPGFjjWhhrwiRaP+0wIBXfXXc3W+uzYsI8Q1fIFVjkBgRizwkRJL2aSkUBGbVx+Ontu7meu2iGVvXLRZt5dd99VdoI+Mue42glWNHg9fgEitEQkq0zrTUgE/8P8HPb8YCXo8//R3zVc75yHuxedB7ws7YA8+NOFWbPp86hyFQqVlHkNeLD4+bu5v/+Nv7DNAdUefD23w57tfXx5+a+zxDB8p7qtGz3YU/9xmL38o5J+7xOvEBfK50tEL0BaLXhsnvn1qBfyYFYx21OAORwPfhzylj7V649eIQ2PqTSF5t++S+wOdXw5g8CbPR+cvMRJyEAlpHRkixGGZpZb1cE/Twv7pfP0xOga5Q6jT43pFL9VPLPZVPmxAaeWAoTn+tOYDiAkiIh+RIIlfdm+khgIIyFbNimd7LhQDFf99zGtV4iNof9Pi0P5Ljd7q7g8jXtGysgwNYYu5vTeLLd5tQiIU3fuHXjQQyyHAQCc6ZGCBdXR2/PiSrwkVzaUT8oZgB69LtFaG0P7fl3jUPu7vNOgvMS1/gEsi9zKCrD/geAvRQ7bmNbIBcDrWTVdX3hFDPm+OnZZAujYSZsCaM97dmsxCdkXAedH/5bTG8XsR58P1yuLleiK8XcS7rLh58vYjz4OuY6btNK2uG+3CrLnAhCEHzUwTZQaOCAnJhe+zc+f5zs9fnZQHai4A2rr8AmRdYXe+2t5uPj/vm2zaS/I/DbpuMDZOwAF0yU0jDiucFo9X1sTl+09yuH++Ovxxm2HFUfQkuLBJt+7x2ZyQSivZFgrEoOwn/25u3Vz+9+fnqzfu/vvl5kPt5vd+sPxCSvSrRcamFHkTxl/ZHGoiuRh4Mf5mhir+cQRev3v/4/dvXV7/88Pb9Oy37l3ffvI6Dg1ZdgAoZg/qsKzAAzd+jd0L2FuZPb1uP/O1uf78O7Et62UidyD724Akv/s2bb1/98t37q+/fvHv36i9vZuO4GAuKwoUJXOI5p2AmudAoiN5J5P7jY/cN+omsi16uV/pZrDlGMNuOfteXWxCBNsd2FCx/Ph6b/XZ9F2c1r/QzzUGIYMHsc7ueY96NoM2bcTgsxIu+7kM1fY8z1i94lZ7Tj46BLHWkvj6yeVIE6AJXSoFE7PvL9uDm48XiBdWe08YYlKVWhlrJZmcU7AJL00CROOtWJ6lfHbtsovW1N6FHMde4bHT8ZXLh3yOtjJSDtDKqHTm2kM4tsFo0sDTjxYilpsd9+Cg0HvH96Gw04lA6ETncATul/ro+BEiq+G6gUvPqP9CL7zbbX/P3opd6xl5Mn4rFY48/I0tFPPJdpKMKeiXEBx6bw/Hwx7X5YtzV0U0LGvlAXfbKLTuzNTd1I67NUY15LTtnk1HtwvLLWk1pcX5rnsCp5rz/ndfeeCxHtUxUm4fh2CcER7XsFZ7X3uMhsq2h4Mx2jpu7ABHUt9EVCsoX7qp5/eu3pwjk9nGrdU8INaUjIw4XMtn2z83xcb/9z/XdY5MCwqmWH83PzX8118fmZiYqr3oudO062H/GszsT+Os37mnMBDKk6iJUDm/6m/5UspPXhFClLhRbPlf7durGIzjVyGeZbdPuJBvz2ehOxe+a5ibeOFjt3Nh+Xm9vWtO7kWUkrlPNXJi2zW/9cPSTFycAgWq5RtB/vvru7TdXr7755ud2J3z1/Y/fvPkudighVfOi+tur7757834OKLdmXkzvf371w7tv3/w8B5Vf9zwW/POr71798PrN1Xdv372fZ0hXQl6MVvIM1XlVc83E633TzvBXXza7dk5d/xo7E0G1XDrqQqPDq4eNB2VCOW6dZVoJZU6lgriIzZ1ysHhSKIqjXclfP+47Kd5R+Ux8lyNxM+GOs1pGIUKqYf1az2ZaBMYs4wIl0OY1YcByeJeurNlAJ9KVjCPIBhmIOxfqu82hV80hA2hf2vkxj3Lbc0CPT3ef3YNhPMK7MhmG+ElkRvSOC+sZribVicF6z+bGUCCzHNlIFYS59+bynyExv33c3kQP2BDWS1TsAvjTg7bfc2RB74k7H+puXr+yVbIAhxKfQuOJfiJS8bNcxXz9p3rrWCvMc9iJ/ejj/IwTAErMih2hhVIdNqz3bA4bBTLLYY9UQRj7w363vrleH472LY0cUC8xqQvARw3YrB0YiTwfenvSmQu6L+98uDu3ZBuKdhNB5FBiVuzk2YoJCKNOcZyiyec40MTjJvoS0fkko1EzOrIeRL6nZaOatZLn30DHm065gz6SMDMBhEAyK9sjGhOWSxSLzK+bDR9M2gjdSieQfYy7lZ6Cwr4OPwuMWzkjpr/B060ESE7djIi686E+fJoHCwrIiM35nskiiIScjEgnn6igwUW/TZGEZ+KBigCcyFcqUtBEZ7zSsMYiMuJ7txQdFJARW3QaH40uOWdvJr6F2DLiOliTLEFHCMk57vTjgrMGnK15HkuGUy2jrBmXVxmNb9/MmptDtVw4ppM5qdArOnMziAUJ/9vNSCiBq/tzeEuxqmXBnVucOs549dNbc/t7EK0lQcGgcOwuQGOOJDai241nMzARSUdSqZhST6JQeaONZ1a1eRAT3mIJYfW7HX1GmQw95WjyOVQ74LN6ZQv1euow4acCx3vJ6Ged6sWpGd8fQaJ+vr7jyfkZeLFj3wXKzalV36P3m55Ilw5LP5lPRxtOdOqjrpLxBHmamIxt3hkiLnZyhsDDk3S0SWeGc1Dip4XpQFPPCJdpNMrpRCo20e3M12+cc4/Vcqp7T8SNn/6lI04984vG6nvNLoMt0mV6RZ/MX45bTXSWfg/pGYJlCKYhSk8MRORNWsxumCKtNir+ZJbDW0603ri3hAXpg9h0cLPOXwmxMd4iB+TkE9dZeLHD1hlg085YZyHFj1dnYE09VY1HC+LX8SN2+KoxlHu6mNVvMjVaPXWM2Bw/TvpcHMHlY4KbdUSED+Z/i9inE3h+S9qfRyNaR0UTOKR1YgQRi2l0IJ8C6pg4+UOoxgf6gHFuto/35Jw3ZWfOpOI0jX5688M3b3/4S3KjF6eKSY6l7yOK5c8///jqm9evnIs80WjcqtnwvP7x+5++e/P+TTocp2Y2NN++evvdm2/SsQz1liHBiehv1sd1eCadyj0x/Tw0OYt51h0LOlrnQDkBxaVTORHOhGM7uLdQUxD1FRejgSOku9g6PT5sqScbHV6DiWNj6NJsG2CtJ1lgEBAeDc32ev/14TgLjls3J6buFY/3648zEJ1q5sSz+TwDiq60EMUohPYTQvCIRJeZOUtgg07OTbhVp+DMppXjD07PL8eEOuPyTxTuEA2nhjxIf1FMr16/f/ufE0EGBWmouxwRHCP2veQfH/Td4PA4AYWfzJlj7Sb6dNhPynnpp81/6P5nLqJLT8YccBMODflMXTJG4ut02TBS77gnA01+0H0O2pvmw+PHj25KSTJOV8QZEHYlf1o73zlIBuhIyIOP8iSv4TP3Sa6Fqv3kviYIZKbzIVVDWP12c5dg9RjEl47ILNDP4QeiOrLQMczsT6KniOrJbNcxsw9pviSqC3OdS3wPkKw7j5cdJd11f42+bBP+RoUW9QsuD+ujBnZqKPkZVr+9tLdWh7oz79OAtmfdo8EwIOdKIONsUg1J6XuTGCbuyIDGI+/GTLaK5StNtZ2UnhTT70TFJ2T2Tba+uX/Y7VMBgEpLMUznD4P24/OG0bYRzxV+8DHpqcd2fq6DjwYaabpYrP+iH5e6OTEF73d9Psdfmy9AoQEUgerL0d3tPr562PzcHB7atoNvPBo4fvnl7e+bj+1cbfb6FS39uYHr5uHofuWFhEJWXY6qXT/aMOlolPx+1+p7Gs64zkwcyOgHJ5ij4W/+Hr12TzmTXtzfKKlYL34LZkt//+r/te/KvXmX0vAFrBkF4zKcZmzWxSQYQ5Uc7W+2myTtX/QVcrStvwbQdqUjYbtvTDtPSQbWVwTThKCk8CcKeXeByLT1/bqb98Hv8CGA8fpZcKZ9bzQO2yXyb38oEq44+M1EthB1gHOeHunTnrN1bGKHd6/LnbuHppVn62N4H4N0cdZehpokS/U9VMmPJnl0jw4mcyFZjzLQY+Cs0XzzzJhmrBGw5tmwdUzKT/vmdvNlDj6v9tkwvt3eNLPg2Yr5l9Tf1pvjt7vJL8ci0GDN/NiaL90WNgnUUCVHoHTTtD0If+wXgeDWyq8T/C5CfPwaffsgBc2xe/5n4rNvNCKvdn6NTd3ARoAht69zoTGjY479YM0zY0tcf8Z18+P78Li5G3YZ64ckfOO6/zvCfoDrEvz/EDqmxosTcskJvb7+NM+7+BXzG/9ggt3EGM3WyeHskEuMkZuEvE4Xv6YYAyXxYmI0mtFtvlgw8Rf3Yi0Eb0NGWij64mMsjohHvHAkCQ94xXMmZHZZ9C4XkZAJXbqKsunmsP7cpDuVU6Us86eNNJIxOJUyWeGb5nb9eDfXwY1qZwku19tuxCUuQ7ZODgTmQ2xJAIYq+cLr6Uctydg6/kZeFJ7pQ0AESfxBYOxYffNl052IfexmQPJQhZXPwlK/MWni7ZZmBkUNK+dB6Bw9uCSEPUjS/xo8PqqKumKrE6cBXcVwJOXct5x0CPD+L9FIvzx/t8EepB235xdf1nRsmwsbaytNNNOXmNkAjIuwJiaDoMlGnDvWN83P5nWRcJNEjQwAtONLxQAqzYTx2qVaYiAQFRY178Zs8RjwWouARA8GtPjSpqOHAVVjEQDjh+Obh+XzNQ5O/CMhTOUPTQGhP/COAcBKz2xYHzi82e93SLaj06JXbGZTXSShVdcCfvO52YaVjJXO1fDPzaGNwtOaH+rMBoFkKuMtxyQepzQXo+xx6VwNz2g9N4TJ2ISqMRdAK6jd/O+bhOFOVckKIWbghyvOhKMXq2C7tsSSBibt7Jaa31CUj87inR0hhk56s328j23Wq7EcwHuXsp9o+n2QiY9qFP3gBWwtuGWPbSZFs7D4wqZjBqxbcGZz3g0ErJnwm11T4iNCpqXxkak/plcnrTZRcRGcSet5xZZtr/VXrHT+7k/r/fpeO+eJmG2qZgZA3z5EI/j2IVOT6+6uytf4dofyGRrXudO36wl+gKqRAUB0u3mip/RBF1M7E7CJwYcWz9V0xCCk62QCETcYQ7UyAUlqf2GIlz4ig9WWQpkYg365xY1FjDqk8NJm48YZWnxp03EtLo/DZo2qYM0MgKbHll80R5NxIwwpn6Hx6HGG1sgAILrdZZF4+mAL1VoIZGKQecWWNhUxuMZlFzYaN6iw0gsbjmpv6Q4kfSiF6y0GMzGcQMHlzUUMKaz04objhhVefnHjkW3Ob8q+nKD5Pz1EmqP7lDB6KELWyQEivuklDZrcgHFb/R9sa0OxcJ7GnKZO6QXT7ZgEhX/942X/60//fNFG2odOB396UV6yy7otfbtp7m7amn83Tbeydvf3Xf1/9H/7z+ZaXyL+099NkT+uXrz8++qlqC45L//xj5d/tzX0H/Q/6GJF+3/FS84uuRBescIrVrb/V76s1GXFlVes9Iqx9v/Yy0pelitfGvOKVe3/VS95fVlVlVes8orx9v/4S160Xai9YtwrJtr/E5g04RWT7f/Jl1V9qZQvTXrFVPt/CiumvGKtUf5eY8VqX72dtosVVrAAhtCWKLB+FL4tipLqSeFbo2BUXwrfHkVF9abwLVJwuju+UYpO+UWJjizfLoWkBk3hW6boLFCwl1xcriRo3DdO0RmhqLDRX/j2KbV9OFay9O1TavsIrPUSzJXOCgVqoNI3UMlIJZW+hcrODoXCRkfpm6jUJqpRmb6Jys4O5QqV6ZuolLRM30ZlZ4gSHcWlb6OyppxA6ZuIdXYoS8xEzDcR6+xQMkwm803EtD+rMGMy4NE6O5ToAGG+iVhnhxJ1RMw3EePkAGG+iZg2kURb903EOjuUCi3pm4hpE9UoTt9ErKZx+jaqVtQcrnwTVQU5hyvfRFVnB7ZCS/omqvSqg465Cqw7nR1YiS0plW+iqrMDQ4dS5ZuoEmTXfQtV2s+hTqnyLVR1ZmAc7bpvoaozA0OdUuVbiGsLSaxD3DcR7+zA0JHEfRNxbaIaLembiHd2qFBXw30T8YqKNDgIDjozVGjown0L8c4OVYk27puIS7Jx30Jc0Y37FuLazTFUR76FRGeGCvWIwreQ6MxQcbSkbyFB+znhW0hoCwkMp/AtJHT0ho4k4ZtIcLp1EMJpE6FjTvgmEp0hKtR7Cd9GojMER8ec8G0kaiqgEr6J5IoKqKRvIVlQAZX0DSRLMqCSvoFkZwWOejnpG0hW5ECSvoEkp8a79O0jBTneJYiyOyOgQbv0zSO1edBlXfrmkZ0RODqFpG8f1VmBoz1XvoFUZwaOTiHlW0h1ZuDosq58CylGaVP5BlIVqU3lG0iRWyDlG0gJuue+gZSkew52QtpCaPChfAspbSE0OlW+hWoyUKh9A9UFpczat09dUiqqffPUegKhq1Xt26fujCDQzXPt26furCAKtKRvoFrvUtHhXvsGqjsrCHS4176B6s4KosLGUQ12q50VBGr0Gm5YV5QzNH9yixaUOzR/couWlEM0f3KLMtIlmr+5ZStSA+ZvbllODT3zJ7eoNha6GJq/uWW1udDl0PzNLat3sOg+yvzNLUuHduZvTllNJQh0/hUjmqGzjKhRuZBoMEzD6mXZluUFKAvMpikFiVNJkG7QrIIscQzAbJpXkPiuH3IOmlmQaMBRQNZBkwuUHoDdNL0g0elTQOpBEwxSYA6pAORDoSkGoiygHwpNMuDDt4T8EMnWFYCAKDTNgHrPAjAQheYZ8A1ZATiIoqR3uAVgIQrNNRC0DuAhCs02SHRJKgATUWi+gZiYgIsoNOVATExARxSadCAmJiAkCk07EBMTUBKFJh6kwuVCYo/RExPQEoUmH4iJCYiJQtMPxMQE1EShCQhiYgJyotAUBDExAT1RaBKC0gOwm6YhJLobKABFUVT0wgZIiqKiFzbAUhQVvbABmqKoAgtbBQnZzjBqhRoNUBWFJiQUzhwDsqLQnIRCw5AC8BWFISxQtqQAjEWheQkKAzCaIS1QTwZIi0JTEwqNhQpAWxSanFA46QuIi0LTEwplWApAXRQ8MNcAeVFojkLhgQOHVLo2G+7LAINRaJ6CwgvMpqkKhfscQGMUmqzA5wTgMQrNVuBzAhAZhaYr8DkBmIxC8xXEnABcRqEZC4VPdsBmFCJgNMBnFJq1qFfogASMRqF5C0ouPAHpDFMXuFxgNM1dUHKB0TR7UePrO2A2CkNtEHKB2TSHUTNULuA3Ck1jEHIBxVFoIqOu8BMeYDcZsBugOQpNZtQcxwvsJgN2A1xHoRmNGt3xFxKeXQXsBgiPQtMaxDgDlEehiQ1i7ADSo9DUBjEeAO1RaHKDsDEgPgoVsBugPgrNcBC2AOxHoTmOGg/MAP9RqIDdAAVSaKKD0C8gQQpNdRD6BTRIoQLzDRAhhaY7KP0Cu2nGg9AvYEMKTXoQ+gWESKF5jxpfAAAnUmjmg9AZYEUKzX0QOgO8SKHZD0JngBkpNP9B6AxwI4VmQCidAbtpDoTSGTww1nbD1xbAkJQrc6a/esmKy3Yb7BUuAUdSaiIEV3AJSJLSkCSogkvAkpSaCcEVXAKWpNRMCK7gErAkpaZCcAWXgCYpNRWCK7gENEmpqZBi1Xaunck1OPAFPElpeJJV27vqsnUfoDA4R9ZkSLEiugds1+dj4OfOgCopC3qRKwFVUhaGyEe30iXgSsqCXuVKwJWUmg8pVihJUAKypCxod1kCsqQ0GRoriQsG5ivoda4EbElp8jRWChcMrFfQAUoJczVMssaqRgXDdI0yYLxRwoY2XhuGooKB8cqA8WDWhknbwLN6Spi4UQaMB1M3DGlCDDeYvWHSN4ghBBM4ShUYFjCHw/AmhKkBcVKykPkAc1KyImASQJ2UzNgPPeItAXdSBriTEnAnJasCagbkSWnSOgg1A/akZKHZB+iTksmAmgF/UjIVUjMwoEnxoNQMDKhpkqJAsyJKwKGUJtODUB1gUcqqDKgO8Chlz6PgqgNESllVAdUBJqWseEB1gEopNV1CqQ5wKaXmS4oCX3cAmVJWKhBgADalrOqQnoEF+SqgZ0ColLwI6BkwKiUvA3oGlErJWUDPgFMpeRXQMyBVSs4DYQZgVUouAmEGoFVKLgNhBuBVSk2eFAV6YlACZqXkgSUQUCulMFMQNyAgV0oRWAIBuVIK40JxYwN2pQywKyVgV0phzIcPDECvlAF6pQT0SinM/MMHEeBXygC/UgJ+pdQcSkElRgLjBQiWEhAspQwZDzAspSwCBgEUS2nSSAglA46l1DwKpThAspSaSCmIjE7AspQBlqUELEspRUgZMP9UhpQB7CdVSBnAfrIOKQMYULMpRYnHGYBqKVUR6CDgWkoVmn6AbCkVC3QQsC2lqgIdBHRLqSmVAk+hLQHfUioRWKYA4VIqGdIGTCJWIW0AC6o6pA1gwXoV0AYgXcq6CCwmgHUp6zKwmADapaxZYDEBvEtZmylI5EoDC9aBKQiIl7I2Ofr4Bh4wL2Ud8KCAeSlr40EFrjiYBx7woIB6YYZ6KSWGmAHqha3o5Y8B6oVpeqX7YhwqGKSEr+jljwHuha2M8fB0a0C+sBVtPAbIF7YKGI8B9oUZ9gU3CAPsCzPsC6VkkCJu2BdKccB8hn1h6MrKAPvCAuwLA+wLM+wLoQzAvrCCBZQB6Bdm6BdCGYB+YeZ6DKEMwL8ww7/geesM8C+skKEOAgMWgenHAAHDzF0ZqoPAgIaBIToIGBhmbswwdLVkgIJhhoLBFxMGKBjW35vBtQE4GGY4GEIbgINhJnGF0AYgYZghYShtAAuWAQKUARKGlQEClAEShpUBApTByzSGhMFvNjB4n4YFpiC8UWM4GFahKEaXagIeFF6rMRwMQ/dSDN6sYQEPCu/WGAqGQgzMZygYhl/vgTdsTAoLgQJYzzAwFApgPcPA4Nc4GGBgWH/XBpcMGBhmGBiGnhoxwMCwnoHBJytgYJhhYCgYwH5VYP/OAAPDqsD+nQEGhlWB/TsDDAwzDAzDV23AwLCKDmAYIGCYIWAq9DyIAQKG8cD0A/wLM/xLhR4eMcC/sEBKCwP0CzP0S4WeNDFAvzAemH6AfWGGfalwgwD2hXE6+mSAfGGGfKnQMywGyBcWIF8YIF+YIV/wizcMkC8sQL4wQL4wQ74QowKQL0wTLJSlAfvCRMh6gH1hmmGhLALoF2boF0LLgH5hmmIpKtx7Av6FiYD3BPQLE3VIc8B+hn8hNAf4F2b4F0JzgH9hhn8hNAf4F2b4F0JzgH9hhn/Br1sxwL8wyQPaAAQMMwQMpQ14u1SGtAEMaAgYShvAgoaAobQBLGgImApfpQABwwwBQ6xSgIBhKjQFAQHDVGgKAgKGqdAUBAQMU6EpCAgYpkJTEBAwTIXiT0DAMBWKPwEBw1Qo/gQEDDMETIVew2GAgGGGgOHoTRwGCBhmCBiOXsZhgIBhdWAFBPwLM/wLflWNAf6FaY6lwG+rMUDAMEPAcDRnlQEChmmSpeD4VXTAwDDDwHA0E5UBBoZplqXAb3oxQMFUhoLh6F3NClAw1coYELV2BTiYahXYAlaAg6n6W0LocK4ACVMZEgYfzhUgYaoVp4dzBViYyrAw+F2xCrAwVZ8DQ3QQ3AE3LAx+t6wCLExlWBj8elkFWJjKsDD4DbMKsDCVeZZE4NfWAQ1TGRpGoEO0AjRMZWgY/JZVBWiYytAwAh2iFaBhKkPDCHyIAhqmMjSMwIcooGEqQ8NI3NyAhqkMDSNxCwIapjI0jMQtCGiYytAwErcgoGGqQCJMBViYqn+6BLc2YGEqw8Lg16IqwMJUhoWR+FMFgIWp+utDaNBTARamMiyMRGOCCrAwlWFh8BsjFWBhqhALUwEWpjIsjEK5zQqwMJVhYfD7EhVgYSqTCqNQHq0CNEzF6Ct7FWBhKhbyoYCGqfpUGNx5ARqm6l84wa0NeJjK8DCEtQEPUxkehrA24GEqkwpDWBsQMZUhYghrw/dODBFDWBu+eWKIGMLa8NkTQ8QQ1oYvn1R0GFON3j4xTwjhTgM+f2J4GPw2TQVfQDE8jMLdPnwFxfAw2MWmCj6DEsqDqeBLKCYPRqEHjBWgYSpDw+CXbypAw1QmDwa/UVMBHqYyPIxCrxJWgIepTB5MjT9yA4iYyhAxNT6KABFTmTyYGl9OABNTGSamJl67AfYzeTA1/nwboGIqHjiJqAAVU3FzCZO/ZPyyWIHAC3AxleFiajx6AFxMZW4Z1bi5ARlTGTKmVi+ZvKwkmFSAjKlEgAmtABlTGTKmrnHJwILm8ZROMlYYvkFknvIq8MLAgoaMIfQMyJhKEy7lCh9IgI2pDBtDqQ5YUAbS6CvAxlSGjSFUB9iYShMulOoAG1NpwoVSHWBjKsPGEKoDbExlXldZ4Q4XsDGVYWMI1QE2ppKhjQRgYyrDxlCqAxbUhAupOmBBTbhQqgNsTGXYGEJ1gI2plLEgvvwANqYybAyhOsDGVCoUxgA2pjJsDKE6wMZUSgRUB9iYShMupOrgc2AqpDpgQWUsiC/GgI2pDBtDqA6wMVUd4NMqwMZUho0hVAfYmKpmAdUBOqbSjAulOkDHVIaOIVQH6JiqNhbE1xRAx1SGjqFUByxYhyIZQMdUho6hVAefdVvRquOAjuGacSFUxwEdww0dg6uOAzqGr4wF0RWWAzqGGzoGVx0HdAzv6RhUdRzQMdzQMbjqOKBj+EqGVAcefFupkOrAm2+rQCTDAR3DC2NB4sE9+DZfEVAdoGN4ESDUOKBjuKFjCNUBOoYXVUB1gI7hBQ+oDtAx3NAxhOoAHcMLY0H8BUJAx3BDx1CqAxY0dAylOmBBQ8cQqgN0DC+LgOoAH8PNSy6E6gAfww0fQ6gO8DFcUy5lgTJZHPAxvH9TFlcd4GN4GUgL5YCP4f3LsoTqgAXN47KU6oAFyzqkOmBBw8cQqgN8DDfPzBYor8cBH8NZYDfBASHDWWA3wQEhw1lgN8EBIcNZYDfBASHDWWA3wQEhw1lgN8EBIcPN27MFupvggJDhLLCb4ICQ4VVgN8EBIcOrwG6CA0KGV4HdBAeEDK8CuwkOGBleBXYTHDAyXJMuZYG/JAoYGV4FdhMcMDK8CuwmOOBkeBXYTXDAyfAqsJvg8IFaHthNcPhGLQ/sJjh8plbTLiX+HjiHL9XywG6Cw8dqeWA3wUcP1gZ2Exy+WcsDuwkOn63lgd0Eh0/X8sBugsPXazXtUuIPpHPAyXAR2E1wwMlwEdhNcMDJcBHYTXDAyXAR2E1wwMlwEdhNcMDJcBHYTXDAyXDDyRToboIDToaLwG6CA06Gi8BuggNOhovAboIDTobL0G4CcDJchnYTgJPhMrSbAJwMN5xMge8mACfDZWg3ATgZLkO7CcDJcBnaTQBOhsvQbgJwMlyGdhOAk+EytJsAnAw3nEyB7yYAJ8NVaDcBOBmuQrsJwMlwFdpNAE6Gq9BuAnAyXIV2E4CT4Sq0mwCcDDecTIHvJgAnw1VoNwE4Ga5CuwnAyfA6tJsAnAyvQ7sJwMnwOrSbAJwMr0O7CcDJcMPJlPhuAnAyvA7tJgAnw+vQbgJwMrwO7SYAJ8Pr0G4CcDK8Du0mACcjVoHdhACcjDCcTInuJgTgZMQqsJsQgJMRq8BuQgBORqwCuwkBOBmxCuwmBOBkxCqwmxCAkxGrwG5CAE5GGE4G/zSIAJyMWAV2EwJwMqII7CYE4GREEdhNCMDJiCKwmxCAkxFFYDchACcjisBuQgBORhhOpkR3EwJwMiLwLR8BKBlhKJkSjbUFoGREEQhkBKBkhGZdSvxTLAJQMqI0H43Bv2cAKBlRBkJRASgZ0afIoKkNAlAyQrMuZYl/LAFQMsJQMvg3XASgZERpDIguVgJQMsJ86Yeh7lkASkZo1qVkuEMClIwwlAzDpyCgZIRJkSE0BwxovvqD31MSgJER/Yd/8EEHGBnB6M8zCUDICPP1H4aPOUDICPMBIEZ8QwPYzxAyDA1xBSBkhCFk8G+yCEDICPMlIPyzLAIQMoIFNoMCEDJCcy5lhQ8jQMgIzbmU+FcOBCBkhOZcygofRoCQERWd4iQAHyMMH4N/f0UAPkZoyqWs8GEE+BhR0VddBKBjhGZcygofRoCOEZpxKYlPsQA6RmjGpazwYQToGGHoGOIzK4COEYaOwRO1BaBjhGZcSuJjK4COEYaOwRO1BaBjBDff30KfpBaAjhHm40F48rUAdIzgga2gAHSMMHQMnqktAB0jDB2DZ2oLQMcIzbiUeKa2AHSMMHQMnqkt4PeENONS4pnaAn5SSBgL4uaGXxUynxXCs54F/LCQoWPwRGYBvy1k6BiBPjot4OeFRMiCoy8MaQviWc8CfmRIMy4kDGDBEB0j4KeGNONS4vnUAtAxwtAxBAxAxwgZimIAHSNMigyeqS0AHSMMHUPBABaUAUpUADpGmBQZPAdcADpGSBGCAT8TFSC1BaBjhKFj8OxyAegYoRkX/OtsArAxQoX2EYCNEYaNwTMYBWBjhMmQwT8tIAAbI8yXiQT+1SzAxggV2kcANkYYNoZY5QEbI0yGDJ49LwAbIwwbg2fPC8DGCE24lHj2vABsjDAZMnj2vABsjNCES4lnxAvAxgjDxkh8VgE2Rhg2RuJjH7AxwmTI4F++EICNEYaNkbjjB2yM0IRLKXHHD9gYYTJkFG5BwMYITbiUCrcgYGOEYWPwLxMIwMYIw8YofHMA2BhpMmTwVGYJ2Bhp2Bg8lVkCNkZqwqXEn/uXgI2RJkMGTzmWgI2RmnApFWpBCdgYadgYhVpQAjZGGjamRi0oARsjTYZMjVpQAjZGGjYGTzmWgI2RmnApa/yjboCNkSZDpsYtCNgYGXg2RgIyRhaBNyskIGOkIWNqfGgAMkaaLxwRKID9zHUl/DapBFyMNFwMfk9VAjJGmutK+AVRCcgYWQRu7UpAxsj+C8v4twMBGSMNGYPnaktAxsjAdSUJuBip6Rb8AWoJqBip2Rb8cW0JmBipyRb8EWwJiBhZ0i+dS8DDyJJ+6VwCGkZqpgV/OFwCFkYaFgbPb5eAhZEl/eKBBCyMNHkx+EM7ErAw0txTwpP9JWBhpGFh8Id2JKBhpMmLwR/akYCGkYaGqXHfCWgYaWiYGvedgIaR5otHaHwmAQsjexYGXaIkYGGkYWHwyE8CFkZqogX/5p0EJIzsrymht1EkIGFknxWD3kaRgISR5poSfg1EAhZGmi80r/BFB7Aw0nykeYUvOoCFkeY7zfj1BAloGGk+1Ywn5EtAw0jz9SM8BV0CGkaaLzbjSdcS0DDS0DB46C4BDSPNd5vxnGQJaBhpPt2MZ+FKQMNI8/VmPO9UAhpG8sAOQgIaRnJjQaIwsCAP5FRIQMNIzbQwPGtRAhpGaqaF4Xl6EtAwktOPjkjAwkgeeHREAhZGaqKFEAxIGGlyYohIAJAwUtA0qAQcjOzfjMFXHsDByNCbMRJwMLJ/MwZfKwEHI4UxHz5bAQcjA0/2SkDBSEF/6kMCBkYK+tM6En7vWdKfaJHwk8/mm8+41uBXn80nkXBzwO8+S/oTLRJ++VnzKwxPEpTw48+B13ol/P6zDLyVJkefgDYTD3ed8DPQMjDx4IegTSYMEY4A7kX2j/Xi4QjgXqThXohwBHAvUgUeC5WAe5GGe8GpcQm4F6kC2wZAvUjNruCfCJSAeZGaXME/5ScB8SIVeUFXAtpFamaFCIgA6yI1scLwTEIJWBepiRX8m5USkC5S8yr4Nysl4FykplXwb1ZKQLlI80QM+s1KCRgXWZt5h6/SgHGRgSd6JSBcZE+44GEkIFxkbeadxNUGbKc5FYYniklAuMjAG70S8C1KUyoECgX4FqUpFYbnXCnAtyhNqTA8y0gBvkVpSoXheTUK8C3KZL+gZ8IK0C3KfEcajZIVYFvUysw7dMFTgG1RmlDBB70CZIvSfArD8zcUIFuU+ZQ0npOhANmiCjpeUYBrUZpPYXhKhgJkizKZL3guhAJkiyoCx34KkC1KEyqsRF+XU4BtUYZtwZ95UIBtUYWxHxpQK8C2qMA3khQgW1Rh7IfOPgXIFmUyXyhlAPtpPoVSBiBbVJ/5gisDsC2qNNMPn6uAblGaUsFXJwXoFlUGjowU4FuUuYuE75UVIFxUGWDLFGBclLmLhG+WFaBcVBl4ZFIBykWZxBc8rleAc1Hm+9J4so4CnItigXsQCnAuStMqDM/sUYBzUZpWYXhmjwKci9K0CmO4OwKci9K0CsOzdRTgXJTmVRiegaMA6aI0r8LwDBwFSBeleRWGZ+AoQLooVpMBlAKki6qMAfG5DUgXpXkVhmfrKEC6KM2rMDwBRwHSRRnSpcKtDUgXZUgXPAFHAdJFBVJfFOBclOFciGgAcC7KcC4VGu0owLmoKkCaKcC5KPPNaUoyMCAPRTCAc1GGc8GThhTgXJThXPBEIAU4F8WNAfHRDDgXZTgXPBFIAc5FaVqF4YlACnAuynAueCKQApyLMpwL/mKjApyL0rwKvrNVgHNR3Jy646MZcC5KGNIMJaAUIF2U5lUY/ryjAqSL0sQKwzOMFGBdlCZWGJ40pADrogS99VOAdFGaV2F4gpECpIsypAueYKQA6aI0sYKTIwqQLsqQLvgKCEgX1d9CQh8vUoB1UeZlGPw9IgVoFyUDrLUCvIuSxnz4LAHEizLv9BLxAGBelGFe8GQrBZgXJY398CkFqBel2RWGJ1spQL0oQ73gyVYKUC/KvAyDP2ylAPeieu4FpVMU4F6UCtyAUIB7UZpeYfjjlQpwL0rTKwxP41KAe1GaXmF4spUC3IsyeS+osQH1ojS9gkfYgHlR5gYSPu4B86IM84Lm2StAvShz/wjNpVaAelHm+hFuZsC8KJPvgrJVCjAvyqS74H0DzIsy2S74lAbMizLJLrh+AfOiTK4L7ukB8aI0uYJ/cEUB4kXVJu7EywK7Gd4FzQhTgHZRhnbBN8GAdVGaWakIW/h2qzWxUqGvBtaAdKk1r4I/Y18DzqXWtAr+/HgNKJdasyoVaosaMC61ZlVwVrQGjEutWRWO2q0GjEutSRWOjp0aEC61JlU4Oi9qQLjUmlMRhM4UKEuf0NaAbqk1pdKdq43HTg3oltqktuAYANtSa0IFp2ZrQLbU5nPUCscA7GYSW3AbA6qlLmiGugZMS13QDHUNiJZakykKnW81IFpqzaXgS1wNeJZaUymK6Buwm2ZSanycAZal1kRKjc8hQLLUJqUFxws4ltqktOB4AcdS9xwLel5fA46lNhwLvmrVgGOpDceCf3y5BhxLbTgW/BPCNeBYasOx4B/NrQHHUhuOBf/kag04lrrPa8HdD+BY6j6vBdcG4FjqPq8F1wbgWOo+rwXXBuBYahb4DGANOJbaPMCLr4s14Fjq/kNIhDaABfsPIRHaABY0iS34J8BqwLHU/ZeQCG0AC/ZfQsLNDUiWuv8SEj5bAclS919CwqcrIFlq8yUk/LNJNSBZ6v5LSLhRAMlSmxd4iVUasCy1ee8F/75KDViW2rz3QqzpgGWpDcuCf3GjBixLbd7gJVYowLLU/beo0dena8Cy1OaCEZ5nXgOWpTYXjKjCxoL/ePlis/3c7I/NzdvtTfPlxZ/+/vcXV1fHrw/Ni5f/fHG1Mf/Ybsi10Bd/+ueL1se1//nXyxftGO1/cPtDDD+4/SHtj7r/0W5G+x+2sLSFpS2s+n8pi8L+YPbH8Cdpf/SSy9IWLm3h0ha2ULsvSZsfwha2mEuLubSYS4u5tAi7b4f2P2yZui/TfUuz/8Hsj74ws73ovhbX/7BlmC3TugHzo7ICuS1s1dt9O6r/Ie0PW9h2p/s0kPlR97Uqq5bu4XPzo+r/1N0T7H/0kqWF2qXnmh+2epcVaX7wvokucaf/UdofPTBpNdYlL5gfygq0OpRWdd2BWv+jr64sno7zaX+0v/qRq/+vG8nr6+vmcDjufm227kjtnjkfhmr3lH3fdUWKOW4+e2O9O04cJHSHiKGKh6a5cSsr6UwUYy6s7o1XqbulOtTq7qaStfZtl73eOq1Z21oLKKtLRarQCLzaeGj4SeZgw15S//+1dQBmnoUka5Gu8PIkXZKqNbXXD5vru033B9c6hStBiLCID+u79fa6udscPCHCUbdVUsBWnaTG03tHdJ/GiJmoobptV9zqtWPvws6CekqbWsz6y2Z3eFjv1/fX+2Z93O290efKtXOyNv5xQu5tO553+68eSncs29lblzGdvX3wBDn6LqSwglYRgjbbY7NvsXkztN0XOOqz3SzLCHn3u+tfvannYpNTkEbDuTtpcMbBxESDw7Bwp29hB+LEkL7f3TR3YDByF8SEGh7Wx08P++Z2AzoiXBnkSLxrB93N1+ZL25NDs9/7w697lu/kOypyRt3vHv1JXThaLEu7tNl1zDqb/h+EXca6lBSiBes5PD112WeneW9X1y75jJbSKtsTsXJEVDZg6B5T73/0YCvVj/LKrsLdI8T9j96bcrvCcrvCdo93mh+289wu0NxGBd2jd+aHjVu6B8n6H1aynazd00f9j16ysDGJKMhx8rAZWbZwfUElSBfwsPm1+epbVrjLcWWXY4uCnrRalK7prc3uUC/COB72m8/rYwMQdTfunVEQaP++W4M+AvsXrh6skW0k27323v+wgUdtTWHDQ76yRraRLLdDntsIq3tdtDe7NTK3RrahHxdWsg2ouQ21uF2ouXWO3C4y3UtDvf3JYb//+Nj9w3h6C2d6C3rpbV3t/qiXKOMnvPEgHANW9BhsZfgeonRXNtMFG+WLYljEydCpkwfiHNdZFb3mKrs3KUO9O25A+Mbd8I3Ua1fTd0huFNG9rEFUPO7uN9dXj9vN8XD10OyvHg831/6QduNHenYej83huD5udl7EXDqqZeQC+Hj81P7/5rqdUPvmvx8bfyXrnus5ISjJnrRSjuuP/ox2PGqXvUjU7MIez3orx3zlym7U+LAts3smO6eYDYy7bzEaY6+oFaoPG/2B6zRXWO9lNzCKCmV7SffrB3/ESHfE0DAOzVW3XntA3FWM1ZSxu7og6izcYVKtQjV3D90o8RWuXNfHrKOrQmJG2FelazRljWYntHVXrBw2w8Iazc7QlV1DbJmKDdtIu2kkY9QOVAtrd7dZ+xPR9WwVNYM/7Hfrm+u1P/Sl65nskl6wYY9LQrHCjvu1H2QU3lize+xSDj+supSlMEi/5zeCTNzCmbd2dVaK2jC44raH28aPEdy1uY2re8PZBYdZ2ojZTT6zDlza0SRldMuYE1q5auv7UlMe7cPj5u7GxtT+9OxyVU4+SZDDoZPwX78BR+i64pKa2dfr608Nsp/vklmclunq28Pmo+fFu2SHU01JDYjxhrr7utlpXpNBu6n4R+BSHI1Teu4rdjPPa7aqXTc2Ubv7Z3/VKtxgpCom629vNx8f96PFr/vIoxOfUssP3AcwZ9qQu//r3WYLu93RsY6n6ce9GJgVuyupycDUSv0jRgcpN7qqqBjmJOJhc4XE+m7ILkjNDkJgrFa6BJooyBE1CDjFFiDgdD2KIGmMQRCybHdv8jnzkVqmoYir0YLtUkaMim8GMbjp3e0nm+xNO2bbaG20h3VVwslpboVo6/oShAtDTA6z2/XjdRs7a7/bcZ4geBRuJEMyeoO0LgI92KF7dYQe3D1nECQTAqW54weR6c44cqUEMp1xgEh0xxQZ+hESx9Lc2UIuvUCa/V9EnLunoP2qL25sZESwO/LIsAYItss1Is6dUfXkMDTiHg+oKHcM1tRyDUUdNz6N1r0U5IiZnONGzG/ru7tOcxCTy1HKaYeBBVSlSxNLcpdwkvH1AbDUhTOdJJ+cTp12/b2ZA0AFFkdbH6q0u2RxEsAmBRhl+hJcgpU8xbESAkuJO9xIntfKsfFCc7vf3f/XYbdFNkTdfSiHi5rSLirBjTNX9NRvtWIm5e1uf78GjIrLZ7HARLp/aHXrn+q6DIjdPBWWe5IBWVQ05dJjpSU6Sz4cmtpDSnsux+w5HxsIM3t6Wtkj0prT1nJwGMLp2PirXeF6rcpuOOqK1jUwvL/4uq6aZPv1wr1/vAZDsHC549LSwWVld8GWMmYDA27JP2Y3etXKEs2r4WDTboetnMrywpXdMFaWF64sL1xZQ1SWF+aWF+Z2m8btsTq3eyluLcJt3Motp8K5JSPtOTS359DcngR3H0fof1jJdpMoVgOVZyNiy8iJgWyxo0iI4YctYxnQ7mHF/kcPTFhGVpGkVGuu1vteH6+wgNrd0gaGYZdB0dp8s/143H0CR0Ru6KjIw119mufvMdxTYUXyLKYigr12czYsWVxYjriww62wTFm5Gg76h0P8/k+Kk47XbR3bk7sOoW9a0cGDkYbzlMx1dIqTM9jI6PjC8WGfM38l7W+1hL4zt4/bUdBbuI6zoseFltOuqe3o6LbrgC5ZuWPLzrqyHMjtyjoIy/LQTmvUEGYJB7NNQ1G0i9ciEWrKPamzJ8ylnX+lnXalneslHR6fWsDQOpPGakLRoZ2VhZBSLpdmvR2z7pPZtCJm/Q0bzqiGLBc2nBRaX0LSVD4QrF8u6zHMB9I1aXHjqKhwt5LMHg0xaw9m85aYHJZXm6Bjz0qkzRxS5FGH2zrSFebxwbYrZJQ6FoZFe45IS+bWJL7DZ99XuwcZpE5v1keP+3UGtM0+s0lR9uTZrtWFXfcK0h/eNB8eP35s1wE/znOXAMsRK9Jx3DTXm/u1H0oXTqhIMiE3TbuRu0NXMuXGemREZQVgR5/C3fXa9UTYhC9how1hFw0hKcPdNHfrr77dS3eNpKZ56yk2n3Ha1K1PHoB59cFWyQ3tFMmKGAngRJm5JzKK5GRu2iG/2Y6XNTejYEissmOEPKJypB13fZfayMMEIb5u3Z6RO9GbzeGhtcoVPHFX7vEGySjePN7ff73ShMTj/s7naV2ClTyxb7bX+68PRz+ZrnsQxdkf0XX37Q6p+6crOLldApEcVo1/SFW66TSC7HLzGRDplUsfkLW+POz2vs9ziXBFbtKbL8emrXBz9fD44W5zfQXGoHuARYZGrYwu0H1o7mFOhDsIBbkg3K43d76FXLKpsEtLwWz8SC7Yhm/yqWvl+n4boJCMopFwt7nftMtJd5pyM85XcA+EOLkgGEkEv+ke7VfDdsMunTU11283zZ2fbOAez1RkUultq2B4aMrcs3VVkFV3+/tu+I+2ne4MrmwsU1WUi+s2vld4Zqhw8/hW5CjRAkY5Xi7tTNtC14UHCq7uyADjVBWgdmkaFgJt8izGyEuXphEFafNWRE/y+ryie1gkggiQsxh3Vtj4rrKRSWWPgitlN/213fTbBHVuD8y5TTHkNtblNqWO25Q6bs/SuT145zb5nNuDaG6XfG5329zyE9ye0nOb4y0sYyHI7VbXcZ3U6CvNpVqG82Fy+zwIWW9v0BQd14SMWkk+Nu3eqdv7tVJ295/WB39hUG6uKJmqYoWY8LYDBpPES/eYTpLr2sfmiG3r3aRRm4FWWJdUWB6tsIlnpbWAHI7b7fBRglLnqWnkTK32crEGPsHGxnYMFMNdCcvuSDvepJzuc6e4TzdwoXKdmagpX9hJGU1j5mYMSXJd7+qOBxBzM1ckeUreVsZyh2pvX2NTEyQVhbdSrh/b3eP2CBn5wh3HzM5aZilbxoZkJ8u0VvbWhd3VSDIsb5vt438sxHb9t4qQAaGXblKFIOMcLWAIbW3eNbBF4dqCWktaSX1U2QqCIbubPaAUPZWPOoWxDam7OQwU4u45VGBA67UF74h7PkOmHX2Eg7Fw8/wrbg1bDVSnva8hAyK3zfG33f5XINklDSvr+mU1hGOBbnYaav3m/frQOlCo78pVVshkNF3mJeBZ52a7WtqEq9LuoUpykwta6ajGR7AZdE92ZGB0aAk3D+uvd+0ezDet6+KrgKNCml+5Z4dkIsjHBksdc/O57Ca9lANRNxw2WNKXPHD+SMfErilkSM2OgNFiKtyoaKCnSI7Tl3a32frMrnDTrmznJHmPwUobsYVurGhpH2YTFZkddsyejbBhRbO+WIY8gW3TZ3bc9bQi74y11R+3gfFWueMtsK5jbKJ7gsgHEtFSo5bZYTbaZIOC7aGhtMc+qgwY0DSNLZCue2D2LInZ8cssv8zkkMM7LGv2UiJ5UXBoGLo6l5iwecOS3Bd9/K3xUt9K9+qPoGd4W00nbTfHT3BB9AgDahq1E+fqfrf3SRnHPRnclse2tirsYU4xpLSTtMCn4/EBJrgVbu5BZQ1RWUNU1pFUNnOtsrm7lb1qwG3mJ7fgeGm3ENZtc8vtcwuT2102t+d93G57uI1buR2I3A5Ebrc93G57hN32CJJz8seDm95cWPK5IO26ue+IHIzCduMkMp/elPbCCTcXgLyTtNluAHvkNkcOXn2Nbru+Q+50uFGZoIbIZvt5fbex6bJjKSsvH5LutCtlgzA27spSkcS/laNDfERI7YKhXKEVoq8KmbwKXzFu2hiZA2ylmB0DciPO6RAnWcFeCplXUbq3ZgQZkPRinPgZAeR4LU7Gh70kTa8hMhxvzcmcnF7GEGcictxRoyZGzcP6Y4OIKFwo5Ew3IrzVE6ELXYuTu/Jell3K0X65vCOZdwAEmTgQQeXueEnisBcWiBBKl70TkgozekHGsSFzyx0+q4nhY5ddRIxHq5Je59Bl4Nxv/BOJwj3Kqsi9xMY7HGSucRUJHN5edK/zV2Sk293r9ekSn7Fxj96GBdpyZoXNhilsNkxply5pkwEkOeWdpkGjLjNv4//CxtmFXS+L4R0LmwAk7dmTtFCVoEZd1zrW48IlqSobzylyebkz14mHLZk+WwHXvdzEg+EGoE0pKS0DUtqT6JJMy4eNgXbcDZQlSkt70au0Rxul5VVKcn/WtaM3aH4D7plWafm70h6alpbIK22EW5I5vH0DyI7CPTFglv9j9pIcs1E7s/EYGwaaTfGSJCfSteoF8uCY2k0zsVQXsylbzI5EZgNIZgNIaZUtycX21DRo0yXFbNoGs7plctjIWAXY3CdpryJJC1CRVwQ6fwqJXObeqFOkT73bfWzDjHaOPuy2B5Dj5UZ9ZIrv/fqui1Camz5zAllyHDmcHJKGm/HjR5cIs+l8ityG36+/XOEH6O4ph6qoMYskFrhpbjTy3fWvt35M5D70Ishjoa7ivt0677f75r+a62Nz0y5Nj35mgxv6C/JM7yQJkeCen5Jx6+iUo3BPFCp7xV/YpUEOGUKWZlDkfkTLHo0L5i3XvQySNu9DNXB+5k7oftEYcnX7/9onPYbNp90+lcMulBpQfZvwaYzSZQQEmfy4bX5zn8XwbeJm9pAr/rb5crx6AEPSGVl2cR74BttFu5IOORvkDn67G11KcgdcSQ247e542+5wsPDJpS5IT717aMxWwqx24EpT4fLXFXk6h90EdomLakV1+6HdFLWm9UkX945FZVedijzWe2i2NyCfxb3OU1hmobA8grRjUK0mZHa+XCelgb2WOyULMsf7YQPuWhTuxSxGOhHiTQqXdxT2nE6RzyMQOSCOam3sQAjYNx833VKg02Q1OXDdPBzBTTHmJj8o8uB634zJSPfiyin8o0ZKv6qt9x+BSt0kUNJr2URdncZx284XPw52+lDYA+vC8kaFTYQvbGpoaVkradPwJRn+di23y/p4ghbuYVlFZkq0fmv32Gq++fJp/diaA9tKuosjeXntsB6/RMbcWaokNZBH1VyCQNrdgbJcuLK+XpG7oU4iWEK8dy7sWX4IkZ2Y4yQrd2s9JJ1Sw3wkqtX4450v0OUyhnUs1DeYY8ZcGkOSw7R1wpt2U/w/TVd/c7ttJTXAN7qbJjLPxzjzK7N3gakubiBsEy/sf6kIyRc4Po5y74cX5K7KSBnRmoXy0htt3goZH1LHf15Onr0jTXI0o72kJ8rj7a0oytWORI3luXGotPKoeGMkD0Y+3iNVyoqjJ4uzkYXvfbibgtLG9jW5w4Gygk/NFW4MUtprOzXJdkHhyHtzhcsrlnb81mQ64kikH9+41GBpSY2afJIBSkNfnivcR4PKaug16ZjD58wut6fIZeLQHA1LfdztPnR7GH+pcbcQ5KNOh267fthc6xd4UDEu01XQVjx+aNb7NnAg5bgBHnn3v5Wzo0W4R0/kvcruMaUWyvUnPULBpT/X6ZAnAAeTs+Avmm6mPsnXH+zJP3lC7i6itM9sZbRjwj/b83IPyKlqa5ILpXtZyhIgNZlNjssbr5aeeuwEpQeu1tEVQkZ7JJjN3LCZa/a4vSDD105wG8Jjkt08fvKazgHeHHH3uCSVMJ7A7mAvrA8syGOIw+OH+43PPXZRAK7qwg2iS8vUlWz4YQNWe1ZZktkOSLvW3lTj7hFGaSPh0mYPlzbPrLThYEnulI47LBnYcXwkXdLVHKUCO5YiN1m2IoyOXFaUrtvlX4+vURTuow8VeQPnuEOqunuQyt67qmysUNldSTVc8x0eu7IplNzSDdySuNxy4NxuF7kdGtyS1NyS1Nzm03PLjnJLeHLLyHLLjnLLjnJ7M1TY6F/Ye3PC8iHCDkMxZGTYc3s13DIkj/aOu+P67up69Byoe3N1uHLVi7d0i00qLSzjX5D3fkZpUt7WyD6/SxIGujp8JNmliKh5pyuO3h52BsPw9C95rmcOEGBg597lLIe3g8gLLoOQcETnXXa2A6UmnfAgFQvlvHu/doDXpGc8yfJjOP9JLwuJzKoYxODBmxtulTZfuSafpSAWdzdjwrIGxXBkxwaTBvQ2PLICs+KYl/9gZdsfoX4PIsE49d5L7edjYKCfnn8BXwDwnkQbDganBfXH2tvHe0+H7kPV9l5CYXnlmswgcQSPPlHgEj32LKkmk3+w9D/3SZrCJpYVdumVw8MYapAeHDq3o/25+1BNQW4abGXi/XM30Y985+2UnuCvgG5lkuWwlaHrck9cimGgk5uF4WwSui/3tiezRwQ1mUjiygl7MJf/KOvB68QAxJyYm8rFhi0uSYR64oAfc699rwZgVKTpSsJdmXuCwGwoUNNRjSNw/CqCu1kh2QE/T8Ufkm6uM5nNARJdgEdwDwYKu/cv2DDTyLUNhvIuBUaGlo/bbve523d0HHK84iaYkKe6j9tN96RO92+oEDdeJClkm7CDbWXcLXlhI6+CNFAr6vGhS0psTDoaQia7n3Yg00HhBV53Q8pIqnX0JrF3HZY8/msHwpVHQPqH064daAn+NxDc4HG4/aKG8327Fya5iU4g4XrdvSXJX3f1dSlv9+DSK3bHW5GupJMxdpvu/sUeO9bktRErI+wy3Xt2jA0+LmAv2l26xzV2D1KTZ7eDKN9VMu/KtnWVJGFspRBu0h27A11HpslaYWMX6a6bZHTyeCBfeyndFwrEcHJRDD8ohetEuuE+rn1EcHRc7iZcSXIn4wtDjszdkwySczZShhcSR1Lc+wyS3NkYKUOghIhxL0eRHJMR07/Ch/TIPYkk6S+Tw3ts+itMgS9tuFmE5Mz7bb053u6QUcBcp6jIqx5IVrm7mNhDzNOXfuyZ3Ckmo9TVKwqEhU7UZAQMz3nZJoY9vW3ArkbUVOob0g82gsNAN2V3eBusb8f2hBp7Rizhnt05QD7DYSSMD/HcO03k/XTsIknp5qMKu6WXZOxhZMAZ7E69gg8bIWr2IGlwlfdEbbgeXFrcccmGnTGZbHSSMrG4uGGvvdhRkym7J7HY8uL2jw0HbeQ9XkeYv8C4R4lMDH0NT0Z6iXGPE9nAdJDhyknceJFxw2gy4O0FjA6WYEDt3jEvuA2ohyNu8lRkdM3JHVZ0t+hbTm598t0kW390y8qNPgUZs/42esPFPZTFUxX+8VJn8dxttm2pv//jX//6/wHRU8pJLmwDAA=="; \ No newline at end of file diff --git a/docs/classes/client_api.AddressesApi.html b/docs/classes/client_api.AddressesApi.html index 966d869e..c8a174d8 100644 --- a/docs/classes/client_api.AddressesApi.html +++ b/docs/classes/client_api.AddressesApi.html @@ -1,6 +1,6 @@ AddressesApi | @coinbase/coinbase-sdk

    AddressesApi - object-oriented interface

    Export

    AddressesApi

    -

    Hierarchy (view full)

    Implements

    Constructors

    Hierarchy (view full)

    Implements

    Constructors

    Properties

    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: undefined | Configuration

    Methods

    • Create a new address scoped to the wallet.

      +

    Constructors

    Properties

    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: undefined | Configuration

    Methods

    • 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

      -
    • 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

      -
    • 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

      -
    • 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

      -
    • 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

      -
    • 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 options: RawAxiosRequestConfig

        Override http request option.

      Returns Promise<AxiosResponse<FaucetTransaction, any>>

      Summary

      Request faucet funds for onchain address.

      Throws

      Memberof

      AddressesApi

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

    ServerSignersApi - object-oriented interface

    Export

    ServerSignersApi

    -

    Hierarchy (view full)

    Implements

    Constructors

    Hierarchy (view full)

    Implements

    Constructors

    Properties

    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: undefined | Configuration

    Methods

    • Create a new Server-Signer

      +

    Constructors

    Properties

    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: undefined | Configuration

    Methods

    • 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

      -
    • 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

      Throws

      Memberof

      ServerSignersApi

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/classes/client_api.TradesApi.html b/docs/classes/client_api.TradesApi.html index 70a3c556..c24f95cc 100644 --- a/docs/classes/client_api.TradesApi.html +++ b/docs/classes/client_api.TradesApi.html @@ -1,6 +1,6 @@ TradesApi | @coinbase/coinbase-sdk

    TradesApi - object-oriented interface

    Export

    TradesApi

    -

    Hierarchy (view full)

    Implements

    Constructors

    Hierarchy (view full)

    Implements

    Constructors

    Properties

    Constructors

    Properties

    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: undefined | Configuration

    Methods

    • Broadcast a trade

      +

    Constructors

    Properties

    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: undefined | Configuration

    Methods

    • 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

      -
    • 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

      -
    • 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

      -
    • 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

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

    TransfersApi - object-oriented interface

    Export

    TransfersApi

    -

    Hierarchy (view full)

    Implements

    Constructors

    Hierarchy (view full)

    Implements

    Constructors

    Properties

    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: undefined | Configuration

    Methods

    • Broadcast a transfer

      +

    Constructors

    Properties

    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: undefined | Configuration

    Methods

    • 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

      -
    • 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

      -
    • 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

      -
    • 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

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

    UsersApi - object-oriented interface

    Export

    UsersApi

    -

    Hierarchy (view full)

    Implements

    Constructors

    Hierarchy (view full)

    Implements

    Constructors

    Properties

    Methods

    Constructors

    Properties

    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: undefined | Configuration

    Methods

    • Get current user

      +

    Constructors

    Properties

    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: undefined | Configuration

    Methods

    • Get current user

      Parameters

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns Promise<AxiosResponse<User, any>>

      Summary

      Get current user

      Throws

      Memberof

      UsersApi

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/classes/client_api.WalletsApi.html b/docs/classes/client_api.WalletsApi.html index 92d6c081..4950bfe2 100644 --- a/docs/classes/client_api.WalletsApi.html +++ b/docs/classes/client_api.WalletsApi.html @@ -1,6 +1,6 @@ WalletsApi | @coinbase/coinbase-sdk

    WalletsApi - object-oriented interface

    Export

    WalletsApi

    -

    Hierarchy (view full)

    Implements

    Constructors

    Hierarchy (view full)

    Implements

    Constructors

    Properties

    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: undefined | Configuration

    Methods

    • Create a new wallet scoped to the user.

      +

    Constructors

    Properties

    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: undefined | Configuration

    Methods

    • 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

      -
    • 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

      -
    • 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

      -
    • 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

      -
    • 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

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

    Export

    BaseAPI

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

    Constructors

    Properties

    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: undefined | Configuration
    \ No newline at end of file +

    Constructors

    Properties

    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: undefined | Configuration
    \ No newline at end of file diff --git a/docs/classes/client_base.RequiredError.html b/docs/classes/client_base.RequiredError.html index 98b2dd28..35e5afb1 100644 --- a/docs/classes/client_base.RequiredError.html +++ b/docs/classes/client_base.RequiredError.html @@ -1,5 +1,5 @@ RequiredError | @coinbase/coinbase-sdk

    Export

    RequiredError

    -

    Hierarchy

    • Error
      • RequiredError

    Constructors

    Hierarchy

    • Error
      • RequiredError

    Constructors

    Properties

    Methods

    Constructors

    Properties

    field: string
    message: string
    name: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Constructors

    Properties

    field: string
    message: string
    name: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

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

    Constructors

    constructor +Configuration | @coinbase/coinbase-sdk

    Constructors

    Properties

    Methods

    Constructors

    Properties

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

    parameter for oauth2 security

    +

    Constructors

    Properties

    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

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

    parameter for apiKey security

    +
    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

    -
    baseOptions?: any

    base options for axios calls

    +
    baseOptions?: any

    base options for axios calls

    Memberof

    Configuration

    -
    basePath?: string

    override base path

    +
    basePath?: string

    override base path

    Memberof

    Configuration

    -
    formDataCtor?: (new () => any)

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

    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

    password?: string

    parameter for basic security

    +

    Type declaration

      • new (): any
      • Returns any

    password?: string

    parameter for basic security

    Memberof

    Configuration

    -
    serverIndex?: number

    override server index

    +
    serverIndex?: number

    override server index

    Memberof

    Configuration

    -
    username?: string

    parameter for basic security

    +
    username?: string

    parameter for basic security

    Memberof

    Configuration

    -

    Methods

    Methods

    • 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.

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

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

    -

    Constructors

    Constructors

    Properties

    Methods

    createTransfer @@ -15,7 +15,7 @@

    Parameters

    • model: Address

      The address model data.

    • Optional key: Wallet

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

    Returns Address

    Throws

    If the model or key is empty.

    -

    Properties

    key?: Wallet
    model: Address

    Methods

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

      +

    Properties

    key?: Wallet
    model: Address

    Methods

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

      Parameters

      • amount: Amount

        The amount of the Asset to send.

      • assetId: string

        The ID of the Asset to send. For Ether, Coinbase.assets.Eth, Coinbase.assets.Gwei, and Coinbase.assets.Wei supported.

      • destination: Destination

        The destination of the transfer. If a Wallet, sends to the Wallet's default address. If a String, interprets it as the address ID.

        @@ -25,26 +25,26 @@

        Throws

        if the API request to create a Transfer fails.

        Throws

        if the API request to broadcast a Transfer fails.

        Throws

        if the Transfer times out.

        -
    • Returns the balance of the provided asset.

      Parameters

      • assetId: string

        The asset ID.

      Returns Promise<Decimal>

      The balance of the asset.

      -
    • Returns a string representation of the address.

      Returns string

      A string representing the address.

      -
    \ No newline at end of file +
    \ 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 28f5b10d..091811e5 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns APIError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Returns a String representation of the APIError.

      Returns string

      a String representation of the APIError

      -
    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 14f4e64c..058e1dc9 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns AlreadyExistsError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 14ecb24e..403dc19d 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns FaucetLimitReachedError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 03556404..ec372592 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidAddressError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 30b0379a..04407eba 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidAddressIDError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 62a585d9..5b6345c0 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidAmountError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 7a2d0a7a..387b4c5c 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidAssetIDError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 b9a41fba..0e93d4c4 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidDestinationError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 6697d1ee..b7792710 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidLimitError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 16d5c0da..ad491db5 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidNetworkIDError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 3bc2c932..7f496d5f 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidPageError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 4eccb4e8..9ad69f77 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidSignedPayloadError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 26460460..3d230208 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidTransferIDError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 831d911e..fc229ae7 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidTransferStatusError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 998e6ede..47814412 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidWalletError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 92d2f3da..fbbdaba7 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidWalletIDError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 282e4ca8..7c6e130d 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns MalformedRequestError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 2f4a9b61..902d001a 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns NotFoundError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 1cc99378..e9dbb5a1 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns ResourceExhaustedError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 d08a4a15..59d96834 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns UnauthorizedError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 88cc8fb0..85506367 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns UnimplementedError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 242b2f03..7d962d33 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns UnsupportedAssetError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/classes/coinbase_asset.Asset.html b/docs/classes/coinbase_asset.Asset.html index 6289a57a..db7bd765 100644 --- a/docs/classes/coinbase_asset.Asset.html +++ b/docs/classes/coinbase_asset.Asset.html @@ -1,9 +1,9 @@ Asset | @coinbase/coinbase-sdk

    A representation of an Asset.

    -

    Constructors

    Constructors

    Methods

    Constructors

    Methods

    • Converts an amount from the atomic value of the primary denomination of the provided Asset ID to whole units of the specified asset ID.

      Parameters

      • atomicAmount: Decimal

        The amount in atomic units.

      • assetId: string

        The assset ID.

      Returns Decimal

      The amount in whole units of the asset with the specified ID.

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

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

    -

    Constructors

    Constructors

    Properties

    Methods

    authenticateRequest @@ -9,20 +9,20 @@

    Constructors

    Properties

    apiKey: string
    privateKey: string

    Methods

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

      +

    Returns CoinbaseAuthenticator

    Properties

    apiKey: string
    privateKey: string

    Methods

    • 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.

      -
    • 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.

      -
    • 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.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/classes/coinbase_balance.Balance.html b/docs/classes/coinbase_balance.Balance.html index 8eac8122..6b5f6bfa 100644 --- a/docs/classes/coinbase_balance.Balance.html +++ b/docs/classes/coinbase_balance.Balance.html @@ -1,13 +1,13 @@ Balance | @coinbase/coinbase-sdk

    A representation of a balance.

    -

    Properties

    Properties

    amount: Decimal
    assetId: string

    Methods

    • Converts a BalanceModel into a Balance object.

      +

    Properties

    amount: Decimal
    assetId: string

    Methods

    • 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.

      -
    \ No newline at end of file +
    \ 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 6173c1a6..bcac41de 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

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

    -

    Hierarchy

    • Map<string, Decimal>
      • BalanceMap

    Constructors

    Hierarchy

    • Map<string, Decimal>
      • BalanceMap

    Constructors

    Properties

    [toStringTag] size [species] @@ -20,7 +20,7 @@
    [species]: MapConstructor

    Methods

    • Returns an iterable of entries in the map.

      Returns IterableIterator<[string, Decimal]>

    • Returns void

    • 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

    • Returns void

    • 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 an iterable of key, value pairs for every entry in the map.

      Returns IterableIterator<[string, Decimal]>

    • 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

    • 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.

      @@ -30,8 +30,8 @@

      Returns IterableIterator<string>

    • 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

    • Returns a string representation of the balance map.

      Returns string

      The string representation of the balance map.

      -
    • Returns an iterable of values in the map

      Returns IterableIterator<Decimal>

    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/classes/coinbase_coinbase.Coinbase.html b/docs/classes/coinbase_coinbase.Coinbase.html index bdf2bcdd..99fd607f 100644 --- a/docs/classes/coinbase_coinbase.Coinbase.html +++ b/docs/classes/coinbase_coinbase.Coinbase.html @@ -1,5 +1,5 @@ Coinbase | @coinbase/coinbase-sdk

    The Coinbase SDK.

    -

    Constructors

    Constructors

    Properties

    apiClients apiKeyPrivateKey assets @@ -11,17 +11,17 @@

    Parameters

    Returns Coinbase

    Throws

    If the configuration is invalid.

    Throws

    If not able to create JWT token.

    -

    Properties

    apiClients: ApiClients = {}
    apiKeyPrivateKey: string

    The CDP API key Private Key.

    -

    Constant

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

    The list of supported assets.

    -

    Type declaration

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

    Constant

    networkList: {
        BaseSepolia: string;
    } = ...

    The list of supported networks.

    -

    Type declaration

    • BaseSepolia: string

    Constant

    useServerSigner: boolean

    Whether to use server signer or not.

    -

    Constant

    Methods

    Properties

    apiClients: ApiClients = {}
    apiKeyPrivateKey: string

    The CDP API key Private Key.

    +

    Constant

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

    The list of supported assets.

    +

    Type declaration

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

    Constant

    networkList: {
        BaseSepolia: string;
    } = ...

    The list of supported networks.

    +

    Type declaration

    • BaseSepolia: string

    Constant

    useServerSigner: boolean

    Whether to use a server signer or not.

    +

    Constant

    Methods

    • Returns User object for the default user.

      Returns Promise<User>

      The default user.

      Throws

      If the request fails.

      -
    • 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.

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

    ArgumentError is thrown when an argument is invalid.

    -

    Hierarchy

    • Error
      • ArgumentError

    Constructors

    Hierarchy

    • Error
      • ArgumentError

    Constructors

    Properties

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

    Methods

    Constructors

    Properties

    message: string
    name: string
    stack?: string
    DEFAULT_MESSAGE: string = "Argument Error"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns ArgumentError

    Properties

    message: string
    name: string
    stack?: string
    DEFAULT_MESSAGE: string = "Argument Error"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    \ No newline at end of file diff --git a/docs/classes/coinbase_errors.InternalError.html b/docs/classes/coinbase_errors.InternalError.html index 7f972ef2..2cf3150d 100644 --- a/docs/classes/coinbase_errors.InternalError.html +++ b/docs/classes/coinbase_errors.InternalError.html @@ -1,5 +1,5 @@ InternalError | @coinbase/coinbase-sdk

    InternalError is thrown when there is an internal error in the SDK.

    -

    Hierarchy

    • Error
      • InternalError

    Constructors

    Hierarchy

    • Error
      • InternalError

    Constructors

    Properties

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

    Methods

    Constructors

    Properties

    message: string
    name: string
    stack?: string
    DEFAULT_MESSAGE: string = "Internal Error"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InternalError

    Properties

    message: string
    name: string
    stack?: string
    DEFAULT_MESSAGE: string = "Internal Error"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    \ No newline at end of file diff --git a/docs/classes/coinbase_errors.InvalidAPIKeyFormat.html b/docs/classes/coinbase_errors.InvalidAPIKeyFormat.html index 543cbde2..619f4a5d 100644 --- a/docs/classes/coinbase_errors.InvalidAPIKeyFormat.html +++ b/docs/classes/coinbase_errors.InvalidAPIKeyFormat.html @@ -1,5 +1,5 @@ InvalidAPIKeyFormat | @coinbase/coinbase-sdk

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

    -

    Hierarchy

    • Error
      • InvalidAPIKeyFormat

    Constructors

    Hierarchy

    • Error
      • InvalidAPIKeyFormat

    Constructors

    Properties

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

    Methods

    Constructors

    Properties

    message: string
    name: string
    stack?: string
    DEFAULT_MESSAGE: string = "Invalid API key format"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidAPIKeyFormat

    Properties

    message: string
    name: string
    stack?: string
    DEFAULT_MESSAGE: string = "Invalid API key format"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

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

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

    -

    Hierarchy

    • Error
      • InvalidConfiguration

    Constructors

    Hierarchy

    • Error
      • InvalidConfiguration

    Constructors

    Properties

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

    Methods

    Constructors

    Properties

    message: string
    name: string
    stack?: string
    DEFAULT_MESSAGE: string = "Invalid configuration"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidConfiguration

    Properties

    message: string
    name: string
    stack?: string
    DEFAULT_MESSAGE: string = "Invalid configuration"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    \ No newline at end of file diff --git a/docs/classes/coinbase_errors.InvalidUnsignedPayload.html b/docs/classes/coinbase_errors.InvalidUnsignedPayload.html index 6833932e..de9a5f37 100644 --- a/docs/classes/coinbase_errors.InvalidUnsignedPayload.html +++ b/docs/classes/coinbase_errors.InvalidUnsignedPayload.html @@ -1,5 +1,5 @@ InvalidUnsignedPayload | @coinbase/coinbase-sdk

    InvalidUnsignedPayload error is thrown when the unsigned payload is invalid.

    -

    Hierarchy

    • Error
      • InvalidUnsignedPayload

    Constructors

    Hierarchy

    • Error
      • InvalidUnsignedPayload

    Constructors

    Properties

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

    Methods

    Constructors

    Properties

    message: string
    name: string
    stack?: string
    DEFAULT_MESSAGE: string = "Invalid unsigned payload"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidUnsignedPayload

    Properties

    message: string
    name: string
    stack?: string
    DEFAULT_MESSAGE: string = "Invalid unsigned payload"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    \ 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 c1cac2b8..813f17ad 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

    Represents a transaction from a faucet.

    -

    Constructors

    Constructors

    Properties

    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

    Methods

    Properties

    Methods

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

      Returns string

      The link to the transaction on the blockchain explorer

      -
    • Returns a string representation of the FaucetTransaction.

      Returns string

      A string representation of the FaucetTransaction.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/classes/coinbase_transfer.Transfer.html b/docs/classes/coinbase_transfer.Transfer.html index 9795fdc9..4ea8644e 100644 --- a/docs/classes/coinbase_transfer.Transfer.html +++ b/docs/classes/coinbase_transfer.Transfer.html @@ -1,7 +1,7 @@ Transfer | @coinbase/coinbase-sdk

    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

    Properties

    model: Transfer
    transaction?: Transaction

    Methods

    • Returns the Amount of the Transfer.

      +

    Properties

    model: Transfer
    transaction?: Transaction

    Methods

    • Returns the Destination Address ID of the Transfer.

      Returns string

      The Destination Address ID.

      -
    • Returns the From Address ID of the Transfer.

      Returns string

      The From Address ID.

      -
    • Returns the Signed Payload of the Transfer.

      Returns undefined | string

      The Signed Payload as a Hex string, or undefined if not yet available.

      -
    • Returns the Transaction of the Transfer.

      Returns Transaction

      The ethers.js Transaction object.

      Throws

      (InvalidUnsignedPayload) If the Unsigned Payload is invalid.

      -
    • Returns the Transaction Hash of the Transfer.

      Returns undefined | string

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

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

      Returns string

      The link to the Transaction on the blockchain explorer.

      -
    • Returns the Unsigned Payload of the Transfer.

      Returns string

      The Unsigned Payload as a Hex string.

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

      Returns Promise<void>

      Throws

      if the API request to get a Transfer fails.

      -
    • Sets the Signed Transaction of the Transfer.

      Parameters

      • transaction: Transaction

        The Signed Transaction.

        -

      Returns void

    • Returns a string representation of the Transfer.

      +

    Returns void

    • Returns a string representation of the Transfer.

      Returns Promise<string>

      The string representation of the Transfer.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/classes/coinbase_user.User.html b/docs/classes/coinbase_user.User.html index a1b49df9..04f6426e 100644 --- a/docs/classes/coinbase_user.User.html +++ b/docs/classes/coinbase_user.User.html @@ -1,7 +1,7 @@ User | @coinbase/coinbase-sdk

    A representation of a User. Users have Wallets, which can hold balances of Assets. Access the default User through Coinbase.defaultUser().

    -

    Constructors

    Constructors

    Properties

    Methods

    createWallet getId @@ -11,7 +11,7 @@ toString

    Constructors

    Properties

    model: User

    Methods

    • Creates a new Wallet belonging to the User.

      +

    Returns User

    Properties

    model: User

    Methods

    • Creates a new Wallet belonging to the User.

      Returns Promise<Wallet>

      the new Wallet

      Throws

      • If the request fails.
      • @@ -22,18 +22,18 @@

        Throws

          Throws

          • If address derivation or caching fails.
          -
    • Returns the Wallet with the given ID.

      Parameters

      • wallet_id: string

        the ID of the Wallet

      Returns Promise<Wallet>

      the Wallet with the given ID

      -
    • Lists the Wallets belonging to the User.

      +
    • Lists the Wallets belonging to the User.

      Parameters

      • pageSize: number = 10

        The number of Wallets to return per page. Defaults to 10

      • Optional nextPageToken: string

        The token for the next page of Wallets

      Returns Promise<{
          nextPageToken: string;
          wallets: Wallet[];
      }>

      An object containing the Wallets and the token for the next page

      -
    • Returns a string representation of the User.

      Returns string

      The string representation of the User.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/classes/coinbase_wallet.Wallet.html b/docs/classes/coinbase_wallet.Wallet.html index 1da7a4af..7e40913b 100644 --- a/docs/classes/coinbase_wallet.Wallet.html +++ b/docs/classes/coinbase_wallet.Wallet.html @@ -1,7 +1,7 @@ Wallet | @coinbase/coinbase-sdk

    A representation of a Wallet. Wallets come with a single default Address, but can expand to have a set of Addresses, each of which can hold a balance of one or more Assets. Wallets can create new Addresses, list their addresses, list their balances, and transfer Assets to other Addresses. Wallets should be created through User.createWallet or User.importWallet.

    -

    Properties

    Properties

    addressIndex: number = 0
    addressModels: Address[] = []
    addressPathPrefix: "m/44'/60'/0'/0" = "m/44'/60'/0'/0"
    addresses: Address[] = []
    master?: HDKey
    model: Wallet
    seed?: string
    MAX_ADDRESSES: number = 20

    Methods

    • Builds a Hash of the registered Addresses.

      +

    Properties

    addressIndex: number = 0
    addressModels: Address[] = []
    addressPathPrefix: "m/44'/60'/0'/0" = "m/44'/60'/0'/0"
    addresses: Address[] = []
    master?: HDKey
    model: Wallet
    seed?: string
    MAX_ADDRESSES: number = 20

    Methods

    • Builds a Hash of the registered Addresses.

      Parameters

      • addressModels: Address[]

        The models of the addresses already registered with the Wallet.

      Returns {
          [key: string]: boolean;
      }

      The Hash of registered Addresses

      -
      • [key: string]: boolean
    • Caches an Address on the client-side and increments the address index.

      +
      • [key: string]: boolean
    • Caches an Address on the client-side and increments the address index.

      Parameters

      • address: Address

        The AddressModel to cache.

      • Optional key: Wallet

        The ethers.js Wallet object the address uses for signing data.

      Returns void

      Throws

      If the address is not provided.

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

      +
    • 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.

      -
    • Creates an attestation for the Address currently being created.

      +
    • Creates an attestation for the Address currently being created.

      Parameters

      • key: HDKey

        The key of the Wallet.

      Returns string

      The attestation.

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

    • 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

      • amount: Amount

        The amount of the Asset to send.

      • assetId: string

        The ID of the Asset to send.

        @@ -68,7 +68,7 @@

        Throws

        if the API request to create a Transfer fails.

        Throws

        if the API request to broadcast a Transfer fails.

        Throws

        if the Transfer times out.

        -
    • Derives an already registered Address in the Wallet.

      +
    • Derives an already registered Address in the Wallet.

      Parameters

      • addressMap: {
            [key: string]: boolean;
        }

        The map of registered Address IDs

        • [key: string]: boolean
      • addressModel: Address

        The Address model

      Returns void

      Throws

        @@ -77,52 +77,52 @@

        Throws

        if the Transfer times out.

        Throws

        • If the request fails.
        -
    • Derives the registered Addresses in the Wallet.

      Parameters

      • addresses: Address[]

        The models of the addresses already registered with the

        -

      Returns void

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

      +

    Returns void

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

      Returns HDKey

      The derived key.

      Throws

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

      Returns Promise<FaucetTransaction>

      The successful faucet transaction

      Throws

      If the default address is not found.

      Throws

      If the request fails.

      -
    • Returns the Address with the given ID.

      Parameters

      • addressId: string

        The ID of the Address to retrieve.

      Returns undefined | Address

      The Address.

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

      +
    • 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.

      -
    • Gets the key for encrypting seed data.

      Returns Buffer

      The encryption key.

      -
    • 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

      -
    • 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.

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

      Parameters

      • filePath: string

        The path of the file to load the seed from

      Returns string

      A string indicating the success of the operation

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

      Returns Promise<void>

      Throws

      if the API request to get a Wallet fails.

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

    • 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

        @@ -130,17 +130,17 @@

        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

      -
    • Returns the Wallet model.

      Parameters

      • seed: string

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

        -

      Returns void

    • Returns a String representation of the Wallet.

      +

    Returns void

    • Returns a String representation of the Wallet.

      Returns string

      a String representation of the Wallet

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

      +
    • 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.

      -
    • Returns a newly created Wallet object. Do not use this method directly. +

    • Returns a newly created Wallet object. Do not use this method directly. Instead, use User.createWallet.

      Parameters

      • 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.

        @@ -153,10 +153,10 @@

        Throws

          Throws

          • If the request fails.
          -
    • Returns the seed and master key.

      +
    • Returns the seed and master key.

      Parameters

      • seed: undefined | string

        The seed to use for the Wallet. The function will generate one if it is not provided.

      Returns {
          master: undefined | HDKey;
          seed: undefined | string;
      }

      The master key

      -
      • master: undefined | HDKey
      • seed: undefined | string
    • Returns a new Wallet object. Do not use this method directly. Instead, use User.createWallet or User.importWallet.

      +
      • master: undefined | HDKey
      • seed: undefined | string
    • Returns a new Wallet object. Do not use this method directly. Instead, use User.createWallet or User.importWallet.

      Parameters

      • model: Wallet

        The underlying Wallet model object

      • Optional seed: string

        The seed to use for the Wallet. Expects a 32-byte hexadecimal with no 0x prefix. If null or undefined, a new seed will be generated. If the empty string, no seed is generated, and the Wallet will be instantiated without a seed and its corresponding private keys.

        @@ -170,7 +170,7 @@

        Throws

          Throws

          • If the request fails.
          -
    • Validates the seed and address models passed to the constructor.

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

      Parameters

      • seed: undefined | string

        The seed to use for the Wallet

      • addressModels: Address[]

        The models of the addresses already registered with the Wallet

        -

      Returns void

    \ No newline at end of file +

    Returns void

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

    Export

    Enumeration Members

    Enumeration Members

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

    Export

    Enumeration Members

    Enumeration Members

    Transfer: "transfer"
    \ No newline at end of file diff --git a/docs/enums/coinbase_types.ServerSignerStatus.html b/docs/enums/coinbase_types.ServerSignerStatus.html index a12c6d60..a3dec56c 100644 --- a/docs/enums/coinbase_types.ServerSignerStatus.html +++ b/docs/enums/coinbase_types.ServerSignerStatus.html @@ -1,4 +1,4 @@ ServerSignerStatus | @coinbase/coinbase-sdk

    ServerSigner status type definition.

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    ACTIVE: "active_seed"
    PENDING: "pending_seed_creation"
    \ No newline at end of file +

    Enumeration Members

    ACTIVE: "active_seed"
    PENDING: "pending_seed_creation"
    \ No newline at end of file diff --git a/docs/enums/coinbase_types.TransferStatus.html b/docs/enums/coinbase_types.TransferStatus.html index ba1490ce..dc29f625 100644 --- a/docs/enums/coinbase_types.TransferStatus.html +++ b/docs/enums/coinbase_types.TransferStatus.html @@ -1,6 +1,6 @@ TransferStatus | @coinbase/coinbase-sdk

    Transfer status type definition.

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    BROADCAST: "broadcast"
    COMPLETE: "complete"
    FAILED: "failed"
    PENDING: "pending"
    \ No newline at end of file +

    Enumeration Members

    BROADCAST: "broadcast"
    COMPLETE: "complete"
    FAILED: "failed"
    PENDING: "pending"
    \ No newline at end of file diff --git a/docs/functions/client_api.AddressesApiAxiosParamCreator.html b/docs/functions/client_api.AddressesApiAxiosParamCreator.html index d4585a6d..9cb3798d 100644 --- a/docs/functions/client_api.AddressesApiAxiosParamCreator.html +++ b/docs/functions/client_api.AddressesApiAxiosParamCreator.html @@ -31,4 +31,4 @@

    Throws

      • (walletId, addressId, options?): Promise<RequestArgs>
      • 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<RequestArgs>

    Export

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.AddressesApiFactory.html b/docs/functions/client_api.AddressesApiFactory.html index 19ca996c..b29a7928 100644 --- a/docs/functions/client_api.AddressesApiFactory.html +++ b/docs/functions/client_api.AddressesApiFactory.html @@ -3,32 +3,32 @@

    Parameters

    • walletId: string

      The ID of the wallet to create the address in.

    • Optional createAddressRequest: CreateAddressRequest
    • Optional options: any

      Override http request option.

    Returns AxiosPromise<Address>

    Summary

    Create a new address

    -

    Throws

  • getAddress:function
  • getAddress:function
    • 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: any

        Override http request option.

      Returns AxiosPromise<Address>

      Summary

      Get address by onchain address

      -

      Throws

  • getAddressBalance:function
  • getAddressBalance:function
    • 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: any

        Override http request option.

      Returns AxiosPromise<Balance>

      Summary

      Get address balance for asset

      -

      Throws

  • listAddressBalances:function
  • listAddressBalances:function
    • 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: any

        Override http request option.

      Returns AxiosPromise<AddressBalanceList>

      Summary

      Get all balances for address

      -

      Throws

  • listAddresses:function
  • listAddresses:function
    • 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: any

        Override http request option.

      Returns AxiosPromise<AddressList>

      Summary

      List addresses in a wallet.

      -

      Throws

  • requestFaucetFunds:function
  • requestFaucetFunds:function
    • 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 options: any

        Override http request option.

      Returns AxiosPromise<FaucetTransaction>

      Summary

      Request faucet funds for onchain address.

      -

      Throws

  • Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.AddressesApiFp.html b/docs/functions/client_api.AddressesApiFp.html index 7f435940..5ab07ccb 100644 --- a/docs/functions/client_api.AddressesApiFp.html +++ b/docs/functions/client_api.AddressesApiFp.html @@ -3,32 +3,32 @@

    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<((axios?, basePath?) => AxiosPromise<Address>)>

    Summary

    Create a new address

    -

    Throws

  • getAddress:function
    • Get address

      +

      Throws

  • getAddress:function
    • 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<((axios?, basePath?) => AxiosPromise<Address>)>

      Summary

      Get address by onchain address

      -

      Throws

  • getAddressBalance:function
    • Get address balance

      +

      Throws

  • getAddressBalance:function
    • 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<((axios?, basePath?) => AxiosPromise<Balance>)>

      Summary

      Get address balance for asset

      -

      Throws

  • listAddressBalances:function
  • listAddressBalances:function
    • 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<((axios?, basePath?) => AxiosPromise<AddressBalanceList>)>

      Summary

      Get all balances for address

      -

      Throws

  • listAddresses:function
    • List addresses in the wallet.

      +

      Throws

  • listAddresses:function
    • 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<((axios?, basePath?) => AxiosPromise<AddressList>)>

      Summary

      List addresses in a wallet.

      -

      Throws

  • requestFaucetFunds:function
    • Request faucet funds to be sent to onchain address.

      +

      Throws

  • requestFaucetFunds:function
    • 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 options: RawAxiosRequestConfig

        Override http request option.

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

      Summary

      Request faucet funds for onchain address.

      -

      Throws

  • Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.ServerSignersApiAxiosParamCreator.html b/docs/functions/client_api.ServerSignersApiAxiosParamCreator.html index 78642c5f..273da577 100644 --- a/docs/functions/client_api.ServerSignersApiAxiosParamCreator.html +++ b/docs/functions/client_api.ServerSignersApiAxiosParamCreator.html @@ -23,4 +23,4 @@

    Throws

    • Summary

      Submit the result of a server signer event

      Throws

        • (serverSignerId, signatureCreationEventResult?, options?): Promise<RequestArgs>
        • 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 Promise<RequestArgs>

    Export

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.ServerSignersApiFactory.html b/docs/functions/client_api.ServerSignersApiFactory.html index e8c19837..1d5b96e7 100644 --- a/docs/functions/client_api.ServerSignersApiFactory.html +++ b/docs/functions/client_api.ServerSignersApiFactory.html @@ -2,25 +2,25 @@

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns {
        createServerSigner(createServerSignerRequest?, options?): AxiosPromise<ServerSigner>;
        getServerSigner(serverSignerId, options?): AxiosPromise<ServerSigner>;
        listServerSignerEvents(serverSignerId, limit?, page?, options?): AxiosPromise<ServerSignerEventList>;
        listServerSigners(options?): AxiosPromise<ServerSigner>;
        submitServerSignerSeedEventResult(serverSignerId, seedCreationEventResult?, options?): AxiosPromise<SeedCreationEventResult>;
        submitServerSignerSignatureEventResult(serverSignerId, signatureCreationEventResult?, options?): AxiosPromise<SignatureCreationEventResult>;
    }

    • createServerSigner:function
    • getServerSigner:function
    • getServerSigner:function
      • Get a server signer by ID

        Parameters

        • serverSignerId: string

          The ID of the server signer to fetch

        • Optional options: any

          Override http request option.

        Returns AxiosPromise<ServerSigner>

        Summary

        Get a server signer by ID

        -

        Throws

    • listServerSignerEvents:function
    • listServerSignerEvents:function
      • 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: any

          Override http request option.

        Returns AxiosPromise<ServerSignerEventList>

        Summary

        List events for a server signer

        -

        Throws

    • listServerSigners:function
    • listServerSigners:function
      • List server signers for the current project

        Parameters

        • Optional options: any

          Override http request option.

        Returns AxiosPromise<ServerSigner>

        Summary

        List server signers for the current project

        -

        Throws

    • submitServerSignerSeedEventResult:function
    • submitServerSignerSeedEventResult:function
      • 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: any

          Override http request option.

        Returns AxiosPromise<SeedCreationEventResult>

        Summary

        Submit the result of a server signer event

        -

        Throws

    • submitServerSignerSignatureEventResult:function
    • submitServerSignerSignatureEventResult:function
      • 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: any

          Override http request option.

        Returns AxiosPromise<SignatureCreationEventResult>

        Summary

        Submit the result of a server signer event

        -

        Throws

    Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.ServerSignersApiFp.html b/docs/functions/client_api.ServerSignersApiFp.html index 6d00f77d..74675f3d 100644 --- a/docs/functions/client_api.ServerSignersApiFp.html +++ b/docs/functions/client_api.ServerSignersApiFp.html @@ -2,25 +2,25 @@

    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(options?): Promise<((axios?, basePath?) => AxiosPromise<ServerSigner>)>;
        submitServerSignerSeedEventResult(serverSignerId, seedCreationEventResult?, options?): Promise<((axios?, basePath?) => AxiosPromise<SeedCreationEventResult>)>;
        submitServerSignerSignatureEventResult(serverSignerId, signatureCreationEventResult?, options?): Promise<((axios?, basePath?) => AxiosPromise<SignatureCreationEventResult>)>;
    }

    • createServerSigner:function
      • Create a new Server-Signer

        Parameters

        • Optional createServerSignerRequest: CreateServerSignerRequest
        • Optional options: RawAxiosRequestConfig

          Override http request option.

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

        Summary

        Create a new Server-Signer

        -

        Throws

    • getServerSigner:function
    • getServerSigner:function
      • 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<((axios?, basePath?) => AxiosPromise<ServerSigner>)>

        Summary

        Get a server signer by ID

        -

        Throws

    • listServerSignerEvents:function
    • listServerSignerEvents:function
      • 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<((axios?, basePath?) => AxiosPromise<ServerSignerEventList>)>

        Summary

        List events for a server signer

        -

        Throws

    • listServerSigners:function
      • List server signers for the current project

        +

        Throws

    • listServerSigners:function
      • List server signers for the current project

        Parameters

        • Optional options: RawAxiosRequestConfig

          Override http request option.

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

        Summary

        List server signers for the current project

        -

        Throws

    • submitServerSignerSeedEventResult:function
      • Submit the result of a server signer event

        +

        Throws

    • submitServerSignerSeedEventResult:function
      • 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 Promise<((axios?, basePath?) => AxiosPromise<SeedCreationEventResult>)>

        Summary

        Submit the result of a server signer event

        -

        Throws

    • submitServerSignerSignatureEventResult:function
      • Submit the result of a server signer event

        +

        Throws

    • submitServerSignerSignatureEventResult:function
      • 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 Promise<((axios?, basePath?) => AxiosPromise<SignatureCreationEventResult>)>

        Summary

        Submit the result of a server signer event

        -

        Throws

    Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.TradesApiAxiosParamCreator.html b/docs/functions/client_api.TradesApiAxiosParamCreator.html index f75256c6..a24f292f 100644 --- a/docs/functions/client_api.TradesApiAxiosParamCreator.html +++ b/docs/functions/client_api.TradesApiAxiosParamCreator.html @@ -23,4 +23,4 @@

    Throws

    • 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<RequestArgs>

    Export

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.TradesApiFactory.html b/docs/functions/client_api.TradesApiFactory.html index 7e68a0e6..127d60c4 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: any

    Override http request option.

  • Returns AxiosPromise<Trade>

    Summary

    Broadcast a trade

    -

    Throws

  • createTrade:function
    • Create a new trade

      +

      Throws

  • createTrade:function
    • 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: any

        Override http request option.

      Returns AxiosPromise<Trade>

      Summary

      Create a new trade for an address

      -

      Throws

  • getTrade:function
  • getTrade:function
    • 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: any

        Override http request option.

      Returns AxiosPromise<Trade>

      Summary

      Get a trade by ID

      -

      Throws

  • listTrades:function
  • listTrades:function
    • 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&#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: any

        Override http request option.

      Returns AxiosPromise<TradeList>

      Summary

      List trades for an address.

      -

      Throws

  • Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.TradesApiFp.html b/docs/functions/client_api.TradesApiFp.html index 006ab3d4..a952d152 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
    • Create a new trade

      +

      Throws

  • createTrade:function
    • 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<((axios?, basePath?) => AxiosPromise<Trade>)>

      Summary

      Create a new trade for an address

      -

      Throws

  • getTrade:function
    • Get a trade by ID

      +

      Throws

  • getTrade:function
    • 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<((axios?, basePath?) => AxiosPromise<Trade>)>

      Summary

      Get a trade by ID

      -

      Throws

  • listTrades:function
    • List trades for an address.

      +

      Throws

  • listTrades:function
    • 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&#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<TradeList>)>

      Summary

      List trades for an address.

      -

      Throws

  • Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.TransfersApiAxiosParamCreator.html b/docs/functions/client_api.TransfersApiAxiosParamCreator.html index 0ed4ee09..70974519 100644 --- a/docs/functions/client_api.TransfersApiAxiosParamCreator.html +++ b/docs/functions/client_api.TransfersApiAxiosParamCreator.html @@ -23,4 +23,4 @@

    Throws

    • 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<RequestArgs>

    Export

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.TransfersApiFactory.html b/docs/functions/client_api.TransfersApiFactory.html index 6c03df8e..c646ff2a 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: any

    Override http request option.

  • Returns AxiosPromise<Transfer>

    Summary

    Broadcast a transfer

    -

    Throws

  • createTransfer:function
    • Create a new transfer

      +

      Throws

  • createTransfer:function
    • 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: any

        Override http request option.

      Returns AxiosPromise<Transfer>

      Summary

      Create a new transfer for an address

      -

      Throws

  • getTransfer:function
  • getTransfer:function
    • 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: any

        Override http request option.

      Returns AxiosPromise<Transfer>

      Summary

      Get a transfer by ID

      -

      Throws

  • listTransfers:function
  • listTransfers:function
    • 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.

      • 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: any

        Override http request option.

      Returns AxiosPromise<TransferList>

      Summary

      List transfers for an address.

      -

      Throws

  • Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.TransfersApiFp.html b/docs/functions/client_api.TransfersApiFp.html index ded30b7c..a2fc76a0 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
    • Create a new transfer

      +

      Throws

  • createTransfer:function
    • 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<((axios?, basePath?) => AxiosPromise<Transfer>)>

      Summary

      Create a new transfer for an address

      -

      Throws

  • getTransfer:function
    • Get a transfer by ID

      +

      Throws

  • getTransfer:function
    • 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<((axios?, basePath?) => AxiosPromise<Transfer>)>

      Summary

      Get a transfer by ID

      -

      Throws

  • listTransfers:function
    • List transfers for an address.

      +

      Throws

  • listTransfers:function
    • 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.

      • 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<TransferList>)>

      Summary

      List transfers for an address.

      -

      Throws

  • Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.UsersApiAxiosParamCreator.html b/docs/functions/client_api.UsersApiAxiosParamCreator.html index b214cd32..0539cac5 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>);
    }

    • getCurrentUser: ((options?) => Promise<RequestArgs>)

      Get current user

      Summary

      Get current user

      Throws

        • (options?): Promise<RequestArgs>
        • Parameters

          • Optional options: RawAxiosRequestConfig = {}

            Override http request option.

            -

          Returns Promise<RequestArgs>

    Export

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.UsersApiFactory.html b/docs/functions/client_api.UsersApiFactory.html index 12d13ec9..04979310 100644 --- a/docs/functions/client_api.UsersApiFactory.html +++ b/docs/functions/client_api.UsersApiFactory.html @@ -2,4 +2,4 @@

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns {
        getCurrentUser(options?): AxiosPromise<User>;
    }

    • getCurrentUser:function
      • Get current user

        Parameters

        • Optional options: any

          Override http request option.

        Returns AxiosPromise<User>

        Summary

        Get current user

        -

        Throws

    Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.UsersApiFp.html b/docs/functions/client_api.UsersApiFp.html index 686af72d..bdfa8fc2 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>)>;
    }

    • getCurrentUser:function
      • Get current user

        Parameters

        • Optional options: RawAxiosRequestConfig

          Override http request option.

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

        Summary

        Get current user

        -

        Throws

    Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.WalletsApiAxiosParamCreator.html b/docs/functions/client_api.WalletsApiAxiosParamCreator.html index 2526cad6..b3884702 100644 --- a/docs/functions/client_api.WalletsApiAxiosParamCreator.html +++ b/docs/functions/client_api.WalletsApiAxiosParamCreator.html @@ -20,4 +20,4 @@

    Throws

      • (limit?, page?, options?): Promise<RequestArgs>
      • 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<RequestArgs>

    Export

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.WalletsApiFactory.html b/docs/functions/client_api.WalletsApiFactory.html index 08578135..8944a3ad 100644 --- a/docs/functions/client_api.WalletsApiFactory.html +++ b/docs/functions/client_api.WalletsApiFactory.html @@ -2,22 +2,22 @@

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    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>;
    }

    • createWallet:function
      • Create a new wallet scoped to the user.

        Parameters

        • Optional createWalletRequest: CreateWalletRequest
        • Optional options: any

          Override http request option.

        Returns AxiosPromise<Wallet>

        Summary

        Create a new wallet

        -

        Throws

    • getWallet:function
    • getWallet:function
      • Get wallet

        Parameters

        • walletId: string

          The ID of the wallet to fetch

        • Optional options: any

          Override http request option.

        Returns AxiosPromise<Wallet>

        Summary

        Get wallet by ID

        -

        Throws

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

        +

        Throws

    • getWalletBalance:function
      • 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: any

          Override http request option.

        Returns AxiosPromise<Balance>

        Summary

        Get the balance of an asset in the wallet

        -

        Throws

    • listWalletBalances:function
    • listWalletBalances:function
      • 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: any

          Override http request option.

        Returns AxiosPromise<AddressBalanceList>

        Summary

        List wallet balances

        -

        Throws

    • listWallets:function
    • listWallets:function
      • 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: any

          Override http request option.

        Returns AxiosPromise<WalletList>

        Summary

        List wallets

        -

        Throws

    Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.WalletsApiFp.html b/docs/functions/client_api.WalletsApiFp.html index 6bc52057..646630f2 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>)>;
    }

    • createWallet:function
      • Create a new wallet scoped to the user.

        Parameters

        • Optional createWalletRequest: CreateWalletRequest
        • Optional options: RawAxiosRequestConfig

          Override http request option.

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

        Summary

        Create a new wallet

        -

        Throws

    • getWallet:function
    • getWallet:function
      • Get wallet

        Parameters

        • walletId: string

          The ID of the wallet to fetch

        • Optional options: RawAxiosRequestConfig

          Override http request option.

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

        Summary

        Get wallet by ID

        -

        Throws

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

        +

        Throws

    • getWalletBalance:function
      • 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<((axios?, basePath?) => AxiosPromise<Balance>)>

        Summary

        Get the balance of an asset in the wallet

        -

        Throws

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

        +

        Throws

    • listWalletBalances:function
      • 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<((axios?, basePath?) => AxiosPromise<AddressBalanceList>)>

        Summary

        List wallet balances

        -

        Throws

    • listWallets:function
      • List wallets belonging to the user.

        +

        Throws

    • listWallets:function
      • 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<((axios?, basePath?) => AxiosPromise<WalletList>)>

        Summary

        List wallets

        -

        Throws

    Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_common.assertParamExists.html b/docs/functions/client_common.assertParamExists.html index a87482f0..0127df25 100644 --- a/docs/functions/client_common.assertParamExists.html +++ b/docs/functions/client_common.assertParamExists.html @@ -1 +1 @@ -assertParamExists | @coinbase/coinbase-sdk
    • Parameters

      • functionName: string
      • paramName: string
      • paramValue: unknown

      Returns void

      Throws

      Export

    \ No newline at end of file +assertParamExists | @coinbase/coinbase-sdk
    • Parameters

      • functionName: string
      • paramName: string
      • paramValue: unknown

      Returns void

      Throws

      Export

    \ No newline at end of file diff --git a/docs/functions/client_common.createRequestFunction.html b/docs/functions/client_common.createRequestFunction.html index 802f89dd..38f90472 100644 --- a/docs/functions/client_common.createRequestFunction.html +++ b/docs/functions/client_common.createRequestFunction.html @@ -1 +1 @@ -createRequestFunction | @coinbase/coinbase-sdk
    • 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

    \ No newline at end of file +createRequestFunction | @coinbase/coinbase-sdk
    • 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

    \ No newline at end of file diff --git a/docs/functions/client_common.serializeDataIfNeeded.html b/docs/functions/client_common.serializeDataIfNeeded.html index a29d3eb9..5543a283 100644 --- a/docs/functions/client_common.serializeDataIfNeeded.html +++ b/docs/functions/client_common.serializeDataIfNeeded.html @@ -1 +1 @@ -serializeDataIfNeeded | @coinbase/coinbase-sdk
    • Parameters

      • value: any
      • requestOptions: any
      • Optional configuration: Configuration

      Returns any

      Export

    \ No newline at end of file +serializeDataIfNeeded | @coinbase/coinbase-sdk
    • Parameters

      • value: any
      • requestOptions: any
      • Optional configuration: Configuration

      Returns any

      Export

    \ No newline at end of file diff --git a/docs/functions/client_common.setApiKeyToObject.html b/docs/functions/client_common.setApiKeyToObject.html index a1fe6765..485b53a0 100644 --- a/docs/functions/client_common.setApiKeyToObject.html +++ b/docs/functions/client_common.setApiKeyToObject.html @@ -1 +1 @@ -setApiKeyToObject | @coinbase/coinbase-sdk
    • Parameters

      • object: any
      • keyParamName: string
      • Optional configuration: Configuration

      Returns Promise<void>

      Export

    \ No newline at end of file +setApiKeyToObject | @coinbase/coinbase-sdk
    • Parameters

      • object: any
      • keyParamName: string
      • Optional configuration: Configuration

      Returns Promise<void>

      Export

    \ No newline at end of file diff --git a/docs/functions/client_common.setBasicAuthToObject.html b/docs/functions/client_common.setBasicAuthToObject.html index 79592365..c242f995 100644 --- a/docs/functions/client_common.setBasicAuthToObject.html +++ b/docs/functions/client_common.setBasicAuthToObject.html @@ -1 +1 @@ -setBasicAuthToObject | @coinbase/coinbase-sdk
    \ No newline at end of file +setBasicAuthToObject | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/functions/client_common.setBearerAuthToObject.html b/docs/functions/client_common.setBearerAuthToObject.html index 91e9af35..f22c7bad 100644 --- a/docs/functions/client_common.setBearerAuthToObject.html +++ b/docs/functions/client_common.setBearerAuthToObject.html @@ -1 +1 @@ -setBearerAuthToObject | @coinbase/coinbase-sdk
    \ No newline at end of file +setBearerAuthToObject | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/functions/client_common.setOAuthToObject.html b/docs/functions/client_common.setOAuthToObject.html index e955cff3..aa14f6ff 100644 --- a/docs/functions/client_common.setOAuthToObject.html +++ b/docs/functions/client_common.setOAuthToObject.html @@ -1 +1 @@ -setOAuthToObject | @coinbase/coinbase-sdk
    • Parameters

      • object: any
      • name: string
      • scopes: string[]
      • Optional configuration: Configuration

      Returns Promise<void>

      Export

    \ No newline at end of file +setOAuthToObject | @coinbase/coinbase-sdk
    • Parameters

      • object: any
      • name: string
      • scopes: string[]
      • Optional configuration: Configuration

      Returns Promise<void>

      Export

    \ No newline at end of file diff --git a/docs/functions/client_common.setSearchParams.html b/docs/functions/client_common.setSearchParams.html index b0e5446c..13a6e2d1 100644 --- a/docs/functions/client_common.setSearchParams.html +++ b/docs/functions/client_common.setSearchParams.html @@ -1 +1 @@ -setSearchParams | @coinbase/coinbase-sdk
    • Parameters

      • url: URL
      • Rest ...objects: any[]

      Returns void

      Export

    \ No newline at end of file +setSearchParams | @coinbase/coinbase-sdk
    • Parameters

      • url: URL
      • Rest ...objects: any[]

      Returns void

      Export

    \ No newline at end of file diff --git a/docs/functions/client_common.toPathString.html b/docs/functions/client_common.toPathString.html index 64bc9d4b..fdede8df 100644 --- a/docs/functions/client_common.toPathString.html +++ b/docs/functions/client_common.toPathString.html @@ -1 +1 @@ -toPathString | @coinbase/coinbase-sdk
    \ No newline at end of file +toPathString | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/functions/coinbase_tests_utils.createAxiosMock.html b/docs/functions/coinbase_tests_utils.createAxiosMock.html index 8e873bed..62633eea 100644 --- a/docs/functions/coinbase_tests_utils.createAxiosMock.html +++ b/docs/functions/coinbase_tests_utils.createAxiosMock.html @@ -1,3 +1,3 @@ createAxiosMock | @coinbase/coinbase-sdk
    • Returns an Axios instance with interceptors and configuration for testing.

      Returns AxiosMockType

      The Axios instance, configuration, and base path.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/functions/coinbase_tests_utils.generateRandomHash.html b/docs/functions/coinbase_tests_utils.generateRandomHash.html index 75c7ae9d..551526bb 100644 --- a/docs/functions/coinbase_tests_utils.generateRandomHash.html +++ b/docs/functions/coinbase_tests_utils.generateRandomHash.html @@ -1 +1 @@ -generateRandomHash | @coinbase/coinbase-sdk
    \ No newline at end of file +generateRandomHash | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/functions/coinbase_tests_utils.generateWalletFromSeed.html b/docs/functions/coinbase_tests_utils.generateWalletFromSeed.html index 06941761..e8081807 100644 --- a/docs/functions/coinbase_tests_utils.generateWalletFromSeed.html +++ b/docs/functions/coinbase_tests_utils.generateWalletFromSeed.html @@ -1 +1 @@ -generateWalletFromSeed | @coinbase/coinbase-sdk
    • Parameters

      • seed: string
      • count: number = 2

      Returns Record<string, string>

    \ No newline at end of file +generateWalletFromSeed | @coinbase/coinbase-sdk
    • Parameters

      • seed: string
      • count: number = 2

      Returns Record<string, string>

    \ No newline at end of file diff --git a/docs/functions/coinbase_tests_utils.getAddressFromHDKey.html b/docs/functions/coinbase_tests_utils.getAddressFromHDKey.html index 723714e9..7260fd30 100644 --- a/docs/functions/coinbase_tests_utils.getAddressFromHDKey.html +++ b/docs/functions/coinbase_tests_utils.getAddressFromHDKey.html @@ -1 +1 @@ -getAddressFromHDKey | @coinbase/coinbase-sdk
    \ No newline at end of file +getAddressFromHDKey | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/functions/coinbase_tests_utils.mockFn.html b/docs/functions/coinbase_tests_utils.mockFn.html index 850d6339..515387a1 100644 --- a/docs/functions/coinbase_tests_utils.mockFn.html +++ b/docs/functions/coinbase_tests_utils.mockFn.html @@ -1 +1 @@ -mockFn | @coinbase/coinbase-sdk
    \ No newline at end of file +mockFn | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/functions/coinbase_tests_utils.mockReturnRejectedValue.html b/docs/functions/coinbase_tests_utils.mockReturnRejectedValue.html index 2b994187..e22e4db0 100644 --- a/docs/functions/coinbase_tests_utils.mockReturnRejectedValue.html +++ b/docs/functions/coinbase_tests_utils.mockReturnRejectedValue.html @@ -1 +1 @@ -mockReturnRejectedValue | @coinbase/coinbase-sdk
    \ No newline at end of file +mockReturnRejectedValue | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/functions/coinbase_tests_utils.mockReturnValue.html b/docs/functions/coinbase_tests_utils.mockReturnValue.html index a338bc55..99ea9cbd 100644 --- a/docs/functions/coinbase_tests_utils.mockReturnValue.html +++ b/docs/functions/coinbase_tests_utils.mockReturnValue.html @@ -1 +1 @@ -mockReturnValue | @coinbase/coinbase-sdk
    \ No newline at end of file +mockReturnValue | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/functions/coinbase_tests_utils.newAddressModel.html b/docs/functions/coinbase_tests_utils.newAddressModel.html index d4265e4e..86b95560 100644 --- a/docs/functions/coinbase_tests_utils.newAddressModel.html +++ b/docs/functions/coinbase_tests_utils.newAddressModel.html @@ -1 +1 @@ -newAddressModel | @coinbase/coinbase-sdk
    \ No newline at end of file +newAddressModel | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/functions/coinbase_utils.convertStringToHex.html b/docs/functions/coinbase_utils.convertStringToHex.html index 5f19e822..2939bdff 100644 --- a/docs/functions/coinbase_utils.convertStringToHex.html +++ b/docs/functions/coinbase_utils.convertStringToHex.html @@ -1,4 +1,4 @@ convertStringToHex | @coinbase/coinbase-sdk
    • Converts a Uint8Array to a hex string.

      Parameters

      • key: Uint8Array

        The key to convert.

      Returns string

      The converted hex string.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/functions/coinbase_utils.delay.html b/docs/functions/coinbase_utils.delay.html index c3bb4a56..eb3b78f5 100644 --- a/docs/functions/coinbase_utils.delay.html +++ b/docs/functions/coinbase_utils.delay.html @@ -1,4 +1,4 @@ delay | @coinbase/coinbase-sdk
    • 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.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/functions/coinbase_utils.destinationToAddressHexString.html b/docs/functions/coinbase_utils.destinationToAddressHexString.html index 52118d99..83462e4e 100644 --- a/docs/functions/coinbase_utils.destinationToAddressHexString.html +++ b/docs/functions/coinbase_utils.destinationToAddressHexString.html @@ -2,4 +2,4 @@

    Parameters

    Returns string

    The Address Hex string.

    Throws

    If the Destination is an unsupported type.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/functions/coinbase_utils.logApiResponse.html b/docs/functions/coinbase_utils.logApiResponse.html index d9fff4ac..58a9bde6 100644 --- a/docs/functions/coinbase_utils.logApiResponse.html +++ b/docs/functions/coinbase_utils.logApiResponse.html @@ -2,4 +2,4 @@

    Parameters

    • response: AxiosResponse<any, any>

      The Axios response object.

    • debugging: boolean = false

      Flag to enable or disable logging.

    Returns AxiosResponse<any, any>

    The Axios response object.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/functions/coinbase_utils.registerAxiosInterceptors.html b/docs/functions/coinbase_utils.registerAxiosInterceptors.html index 04151efa..3444b0e5 100644 --- a/docs/functions/coinbase_utils.registerAxiosInterceptors.html +++ b/docs/functions/coinbase_utils.registerAxiosInterceptors.html @@ -2,4 +2,4 @@

    Parameters

    • axiosInstance: Axios

      The Axios instance to register the interceptors.

    • requestFn: RequestFunctionType

      The request interceptor function.

    • responseFn: ResponseFunctionType

      The response interceptor function.

      -

    Returns void

    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 87c67523..7ab38900 100644 --- a/docs/index.html +++ b/docs/index.html @@ -21,10 +21,13 @@
  • Node.js 18 or higher
  • Usage

    Initialization

    To start, create a CDP API Key. Then, initialize the Platform SDK by passing your API Key name and API Key's private key via the Coinbase constructor:

    -
    const apiKeyName = "Copy your API Key name here.";

    const apiKeyPrivateKey = "Copy your API Key's private key here.";

    const coinbase = new Coinbase(apiKeyName, apiKeyPrivateKey); +
    const apiKeyName = "Copy your API Key name here.";

    const privatekey = "Copy your API Key's private key here.";

    const coinbase = new Coinbase({ apiKeyName: apiKeyName, privateKey: privateKey }); +
    +

    If you are using a CDP Server-Signer to manage your private keys, enable it with the constuctor option:

    +
    const coinbase = new Coinbase({ apiKeyName: apiKeyName, privateKey: apiKeyPrivateKey, useServerSigner: true })
     

    Another way to initialize the SDK is by sourcing the API key from the json file that contains your API key, downloaded from CDP portal.

    -
    const coinbase = Coinbase.configureFromJson("path/to/your/api-key.json");
    +
    const coinbase = Coinbase.configureFromJson({ filePath: "path/to/your/api-key.json" });
     

    This will allow you to authenticate with the Platform APIs and get access to the default User.

    const user = await coinbase.getDefaultUser();
    diff --git a/docs/interfaces/client_api.Address.html b/docs/interfaces/client_api.Address.html
    index 92472d05..19773525 100644
    --- a/docs/interfaces/client_api.Address.html
    +++ b/docs/interfaces/client_api.Address.html
    @@ -1,14 +1,14 @@
     Address | @coinbase/coinbase-sdk

    Export

    Address

    -
    interface Address {
        address_id: string;
        network_id: string;
        public_key: string;
        wallet_id: string;
    }

    Properties

    interface Address {
        address_id: string;
        network_id: string;
        public_key: string;
        wallet_id: string;
    }

    Properties

    address_id: string

    The onchain address derived on the server-side.

    Memberof

    Address

    -
    network_id: string

    The ID of the blockchain network

    +
    network_id: string

    The ID of the blockchain network

    Memberof

    Address

    -
    public_key: string

    The public key from which the address is derived.

    +
    public_key: string

    The public key from which the address is derived.

    Memberof

    Address

    -
    wallet_id: string

    The ID of the wallet that owns the address

    +
    wallet_id: string

    The ID of the wallet that owns the address

    Memberof

    Address

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.AddressBalanceList.html b/docs/interfaces/client_api.AddressBalanceList.html index e909078a..6f4923b0 100644 --- a/docs/interfaces/client_api.AddressBalanceList.html +++ b/docs/interfaces/client_api.AddressBalanceList.html @@ -1,13 +1,13 @@ AddressBalanceList | @coinbase/coinbase-sdk

    Export

    AddressBalanceList

    -
    interface AddressBalanceList {
        data: Balance[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    interface AddressBalanceList {
        data: Balance[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data: Balance[]

    Memberof

    AddressBalanceList

    -
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    AddressBalanceList

    -
    next_page: string

    The page token to be used to fetch the next page.

    +
    next_page: string

    The page token to be used to fetch the next page.

    Memberof

    AddressBalanceList

    -
    total_count: number

    The total number of balances for the wallet.

    +
    total_count: number

    The total number of balances for the wallet.

    Memberof

    AddressBalanceList

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.AddressList.html b/docs/interfaces/client_api.AddressList.html index 046d92e9..aa28249e 100644 --- a/docs/interfaces/client_api.AddressList.html +++ b/docs/interfaces/client_api.AddressList.html @@ -1,13 +1,13 @@ AddressList | @coinbase/coinbase-sdk

    Export

    AddressList

    -
    interface AddressList {
        data: Address[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    interface AddressList {
        data: Address[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data: Address[]

    Memberof

    AddressList

    -
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    AddressList

    -
    next_page: string

    The page token to be used to fetch the next page.

    +
    next_page: string

    The page token to be used to fetch the next page.

    Memberof

    AddressList

    -
    total_count: number

    The total number of addresses for the wallet.

    +
    total_count: number

    The total number of addresses for the wallet.

    Memberof

    AddressList

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.AddressesApiInterface.html b/docs/interfaces/client_api.AddressesApiInterface.html index 8cd2b9f5..5a92bdd7 100644 --- a/docs/interfaces/client_api.AddressesApiInterface.html +++ b/docs/interfaces/client_api.AddressesApiInterface.html @@ -1,6 +1,6 @@ AddressesApiInterface | @coinbase/coinbase-sdk

    AddressesApi - interface

    Export

    AddressesApi

    -
    interface AddressesApiInterface {
        createAddress(walletId, createAddressRequest?, options?): AxiosPromise<Address>;
        getAddress(walletId, addressId, options?): AxiosPromise<Address>;
        getAddressBalance(walletId, addressId, assetId, options?): AxiosPromise<Balance>;
        listAddressBalances(walletId, addressId, page?, options?): AxiosPromise<AddressBalanceList>;
        listAddresses(walletId, limit?, page?, options?): AxiosPromise<AddressList>;
        requestFaucetFunds(walletId, addressId, options?): AxiosPromise<FaucetTransaction>;
    }

    Implemented by

    Methods

    interface AddressesApiInterface {
        createAddress(walletId, createAddressRequest?, options?): AxiosPromise<Address>;
        getAddress(walletId, addressId, options?): AxiosPromise<Address>;
        getAddressBalance(walletId, addressId, assetId, options?): AxiosPromise<Balance>;
        listAddressBalances(walletId, addressId, page?, options?): AxiosPromise<AddressBalanceList>;
        listAddresses(walletId, limit?, page?, options?): AxiosPromise<AddressList>;
        requestFaucetFunds(walletId, addressId, options?): AxiosPromise<FaucetTransaction>;
    }

    Implemented by

    Methods

  • Optional createAddressRequest: CreateAddressRequest
  • Optional options: RawAxiosRequestConfig

    Override http request option.

  • Returns AxiosPromise<Address>

    Summary

    Create a new address

    Throws

    Memberof

    AddressesApiInterface

    -
    • 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

      -
    • 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

      -
    • 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

      -
    • 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

      -
    • 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 options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<FaucetTransaction>

      Summary

      Request faucet funds for onchain address.

      Throws

      Memberof

      AddressesApiInterface

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.Asset.html b/docs/interfaces/client_api.Asset.html index 0b93c233..8d33522f 100644 --- a/docs/interfaces/client_api.Asset.html +++ b/docs/interfaces/client_api.Asset.html @@ -1,15 +1,15 @@ Asset | @coinbase/coinbase-sdk

    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

    interface Asset {
        asset_id: string;
        contract_address?: string;
        decimals?: number;
        network_id: string;
    }

    Properties

    asset_id: string

    The ID for the asset on the network

    Memberof

    Asset

    -
    contract_address?: string

    The optional contract address for the asset. This will be specified for smart contract-based assets, for example ERC20s.

    +
    contract_address?: string

    The optional contract address for the asset. This will be specified for smart contract-based assets, for example ERC20s.

    Memberof

    Asset

    -
    decimals?: number

    The number of decimals the asset supports. This is used to convert from atomic units to base units.

    +
    decimals?: number

    The number of decimals the asset supports. This is used to convert from atomic units to base units.

    Memberof

    Asset

    -
    network_id: string

    The ID of the blockchain network

    +
    network_id: string

    The ID of the blockchain network

    Memberof

    Asset

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.Balance.html b/docs/interfaces/client_api.Balance.html index 6ef68138..63906782 100644 --- a/docs/interfaces/client_api.Balance.html +++ b/docs/interfaces/client_api.Balance.html @@ -1,8 +1,8 @@ Balance | @coinbase/coinbase-sdk

    The balance of an asset onchain

    Export

    Balance

    -
    interface Balance {
        amount: string;
        asset: Asset;
    }

    Properties

    interface Balance {
        amount: string;
        asset: Asset;
    }

    Properties

    Properties

    amount: string

    The amount in the atomic units of the asset

    Memberof

    Balance

    -
    asset: Asset

    Memberof

    Balance

    -
    \ No newline at end of file +
    asset: Asset

    Memberof

    Balance

    +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.BroadcastTradeRequest.html b/docs/interfaces/client_api.BroadcastTradeRequest.html index 8462d3e7..f8641213 100644 --- a/docs/interfaces/client_api.BroadcastTradeRequest.html +++ b/docs/interfaces/client_api.BroadcastTradeRequest.html @@ -1,5 +1,5 @@ BroadcastTradeRequest | @coinbase/coinbase-sdk

    Export

    BroadcastTradeRequest

    -
    interface BroadcastTradeRequest {
        signed_payload: string;
    }

    Properties

    interface BroadcastTradeRequest {
        signed_payload: string;
    }

    Properties

    Properties

    signed_payload: string

    The hex-encoded signed payload of the trade

    Memberof

    BroadcastTradeRequest

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.BroadcastTransferRequest.html b/docs/interfaces/client_api.BroadcastTransferRequest.html index 9a196203..21136bd3 100644 --- a/docs/interfaces/client_api.BroadcastTransferRequest.html +++ b/docs/interfaces/client_api.BroadcastTransferRequest.html @@ -1,5 +1,5 @@ BroadcastTransferRequest | @coinbase/coinbase-sdk

    Export

    BroadcastTransferRequest

    -
    interface BroadcastTransferRequest {
        signed_payload: string;
    }

    Properties

    interface BroadcastTransferRequest {
        signed_payload: string;
    }

    Properties

    Properties

    signed_payload: string

    The hex-encoded signed payload of the transfer

    Memberof

    BroadcastTransferRequest

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateAddressRequest.html b/docs/interfaces/client_api.CreateAddressRequest.html index 70cb387e..05d5d4be 100644 --- a/docs/interfaces/client_api.CreateAddressRequest.html +++ b/docs/interfaces/client_api.CreateAddressRequest.html @@ -1,8 +1,8 @@ CreateAddressRequest | @coinbase/coinbase-sdk

    Export

    CreateAddressRequest

    -
    interface CreateAddressRequest {
        attestation?: string;
        public_key?: string;
    }

    Properties

    interface CreateAddressRequest {
        attestation?: string;
        public_key?: string;
    }

    Properties

    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

    -
    public_key?: string

    The public key from which the address will be derived.

    +
    public_key?: string

    The public key from which the address will be derived.

    Memberof

    CreateAddressRequest

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateServerSignerRequest.html b/docs/interfaces/client_api.CreateServerSignerRequest.html index fa194017..9b47252f 100644 --- a/docs/interfaces/client_api.CreateServerSignerRequest.html +++ b/docs/interfaces/client_api.CreateServerSignerRequest.html @@ -1,8 +1,8 @@ CreateServerSignerRequest | @coinbase/coinbase-sdk

    Export

    CreateServerSignerRequest

    -
    interface CreateServerSignerRequest {
        enrollment_data: string;
        server_signer_id: string;
    }

    Properties

    interface CreateServerSignerRequest {
        enrollment_data: string;
        server_signer_id: string;
    }

    Properties

    enrollment_data: string

    The enrollment data of the server signer. This will be the base64 encoded server-signer-id.

    Memberof

    CreateServerSignerRequest

    -
    server_signer_id: string

    The ID of the server signer

    +
    server_signer_id: string

    The ID of the server signer

    Memberof

    CreateServerSignerRequest

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateTradeRequest.html b/docs/interfaces/client_api.CreateTradeRequest.html index 6d534299..327ce94b 100644 --- a/docs/interfaces/client_api.CreateTradeRequest.html +++ b/docs/interfaces/client_api.CreateTradeRequest.html @@ -1,11 +1,11 @@ CreateTradeRequest | @coinbase/coinbase-sdk

    Export

    CreateTradeRequest

    -
    interface CreateTradeRequest {
        amount: string;
        from_asset_id: string;
        to_asset_id: string;
    }

    Properties

    interface CreateTradeRequest {
        amount: string;
        from_asset_id: string;
        to_asset_id: string;
    }

    Properties

    amount: string

    The amount to trade

    Memberof

    CreateTradeRequest

    -
    from_asset_id: string

    The ID of the asset to trade

    +
    from_asset_id: string

    The ID of the asset to trade

    Memberof

    CreateTradeRequest

    -
    to_asset_id: string

    The ID of the asset to receive from the trade

    +
    to_asset_id: string

    The ID of the asset to receive from the trade

    Memberof

    CreateTradeRequest

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateTransferRequest.html b/docs/interfaces/client_api.CreateTransferRequest.html index 34c58c6f..984c6f4f 100644 --- a/docs/interfaces/client_api.CreateTransferRequest.html +++ b/docs/interfaces/client_api.CreateTransferRequest.html @@ -1,14 +1,14 @@ CreateTransferRequest | @coinbase/coinbase-sdk

    Export

    CreateTransferRequest

    -
    interface CreateTransferRequest {
        amount: string;
        asset_id: string;
        destination: string;
        network_id: string;
    }

    Properties

    interface CreateTransferRequest {
        amount: string;
        asset_id: string;
        destination: string;
        network_id: string;
    }

    Properties

    amount: string

    The amount to transfer

    Memberof

    CreateTransferRequest

    -
    asset_id: string

    The ID of the asset to transfer

    +
    asset_id: string

    The ID of the asset to transfer

    Memberof

    CreateTransferRequest

    -
    destination: string

    The destination address

    +
    destination: string

    The destination address

    Memberof

    CreateTransferRequest

    -
    network_id: string

    The ID of the blockchain network

    +
    network_id: string

    The ID of the blockchain network

    Memberof

    CreateTransferRequest

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateWalletRequest.html b/docs/interfaces/client_api.CreateWalletRequest.html index 2546cfc4..15bfa6e3 100644 --- a/docs/interfaces/client_api.CreateWalletRequest.html +++ b/docs/interfaces/client_api.CreateWalletRequest.html @@ -1,4 +1,4 @@ CreateWalletRequest | @coinbase/coinbase-sdk

    Export

    CreateWalletRequest

    -
    interface CreateWalletRequest {
        wallet: CreateWalletRequestWallet;
    }

    Properties

    interface CreateWalletRequest {
        wallet: CreateWalletRequestWallet;
    }

    Properties

    Properties

    Memberof

    CreateWalletRequest

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateWalletRequestWallet.html b/docs/interfaces/client_api.CreateWalletRequestWallet.html index 301be1de..290497ed 100644 --- a/docs/interfaces/client_api.CreateWalletRequestWallet.html +++ b/docs/interfaces/client_api.CreateWalletRequestWallet.html @@ -1,9 +1,9 @@ CreateWalletRequestWallet | @coinbase/coinbase-sdk

    Parameters for configuring a wallet

    Export

    CreateWalletRequestWallet

    -
    interface CreateWalletRequestWallet {
        network_id: string;
        use_server_signer?: boolean;
    }

    Properties

    interface CreateWalletRequestWallet {
        network_id: string;
        use_server_signer?: boolean;
    }

    Properties

    network_id: string

    The ID of the blockchain network

    Memberof

    CreateWalletRequestWallet

    -
    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.

    +
    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

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.FaucetTransaction.html b/docs/interfaces/client_api.FaucetTransaction.html index b0bde302..ea1dfd93 100644 --- a/docs/interfaces/client_api.FaucetTransaction.html +++ b/docs/interfaces/client_api.FaucetTransaction.html @@ -1,5 +1,5 @@ FaucetTransaction | @coinbase/coinbase-sdk

    Export

    FaucetTransaction

    -
    interface FaucetTransaction {
        transaction_hash: string;
    }

    Properties

    interface FaucetTransaction {
        transaction_hash: string;
    }

    Properties

    Properties

    transaction_hash: string

    The transaction hash of the transaction the faucet created.

    Memberof

    FaucetTransaction

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ModelError.html b/docs/interfaces/client_api.ModelError.html index 74a121e2..283aeaf8 100644 --- a/docs/interfaces/client_api.ModelError.html +++ b/docs/interfaces/client_api.ModelError.html @@ -1,9 +1,9 @@ ModelError | @coinbase/coinbase-sdk

    An error response from the Coinbase Developer Platform API

    Export

    ModelError

    -
    interface ModelError {
        code: string;
        message: string;
    }

    Properties

    interface ModelError {
        code: string;
        message: string;
    }

    Properties

    Properties

    code: string

    A short string representing the reported error. Can be use to handle errors programmatically.

    Memberof

    ModelError

    -
    message: string

    A human-readable message providing more details about the error.

    +
    message: string

    A human-readable message providing more details about the error.

    Memberof

    ModelError

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.SeedCreationEvent.html b/docs/interfaces/client_api.SeedCreationEvent.html index d4549763..b9aae842 100644 --- a/docs/interfaces/client_api.SeedCreationEvent.html +++ b/docs/interfaces/client_api.SeedCreationEvent.html @@ -1,9 +1,9 @@ SeedCreationEvent | @coinbase/coinbase-sdk

    An event representing a seed creation.

    Export

    SeedCreationEvent

    -
    interface SeedCreationEvent {
        wallet_id: string;
        wallet_user_id: string;
    }

    Properties

    interface SeedCreationEvent {
        wallet_id: string;
        wallet_user_id: string;
    }

    Properties

    wallet_id: string

    The ID of the wallet that the server-signer should create the seed for

    Memberof

    SeedCreationEvent

    -
    wallet_user_id: string

    The ID of the user that the wallet belongs to

    +
    wallet_user_id: string

    The ID of the user that the wallet belongs to

    Memberof

    SeedCreationEvent

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.SeedCreationEventResult.html b/docs/interfaces/client_api.SeedCreationEventResult.html index 5c8211ad..44478c67 100644 --- a/docs/interfaces/client_api.SeedCreationEventResult.html +++ b/docs/interfaces/client_api.SeedCreationEventResult.html @@ -1,15 +1,15 @@ SeedCreationEventResult | @coinbase/coinbase-sdk

    The result to a SeedCreationEvent.

    Export

    SeedCreationEventResult

    -
    interface SeedCreationEventResult {
        extended_public_key: string;
        seed_id: string;
        wallet_id: string;
        wallet_user_id: string;
    }

    Properties

    interface SeedCreationEventResult {
        extended_public_key: string;
        seed_id: string;
        wallet_id: string;
        wallet_user_id: string;
    }

    Properties

    extended_public_key: string

    The extended public key for the first master key derived from seed.

    Memberof

    SeedCreationEventResult

    -
    seed_id: string

    The ID of the seed in Server-Signer used to generate the extended public key.

    +
    seed_id: string

    The ID of the seed in Server-Signer used to generate the extended public key.

    Memberof

    SeedCreationEventResult

    -
    wallet_id: string

    The ID of the wallet that the seed was created for

    +
    wallet_id: string

    The ID of the wallet that the seed was created for

    Memberof

    SeedCreationEventResult

    -
    wallet_user_id: string

    The ID of the user that the wallet belongs to

    +
    wallet_user_id: string

    The ID of the user that the wallet belongs to

    Memberof

    SeedCreationEventResult

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ServerSigner.html b/docs/interfaces/client_api.ServerSigner.html index 5f96107b..ddca33e4 100644 --- a/docs/interfaces/client_api.ServerSigner.html +++ b/docs/interfaces/client_api.ServerSigner.html @@ -1,9 +1,9 @@ ServerSigner | @coinbase/coinbase-sdk

    A Server-Signer assigned to sign transactions in a wallet.

    Export

    ServerSigner

    -
    interface ServerSigner {
        server_signer_id: string;
        wallets?: string[];
    }

    Properties

    interface ServerSigner {
        server_signer_id: string;
        wallets?: string[];
    }

    Properties

    server_signer_id: string

    The ID of the server-signer

    Memberof

    ServerSigner

    -
    wallets?: string[]

    The IDs of the wallets that the server-signer can sign for

    +
    wallets?: string[]

    The IDs of the wallets that the server-signer can sign for

    Memberof

    ServerSigner

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ServerSignerEvent.html b/docs/interfaces/client_api.ServerSignerEvent.html index f47e9fa1..d444433d 100644 --- a/docs/interfaces/client_api.ServerSignerEvent.html +++ b/docs/interfaces/client_api.ServerSignerEvent.html @@ -1,8 +1,8 @@ ServerSignerEvent | @coinbase/coinbase-sdk

    An event that is waiting to be processed by a Server-Signer.

    Export

    ServerSignerEvent

    -
    interface ServerSignerEvent {
        event: ServerSignerEventEvent;
        server_signer_id: string;
    }

    Properties

    interface ServerSignerEvent {
        event: ServerSignerEventEvent;
        server_signer_id: string;
    }

    Properties

    Memberof

    ServerSignerEvent

    -
    server_signer_id: string

    The ID of the server-signer that the event is for

    +
    server_signer_id: string

    The ID of the server-signer that the event is for

    Memberof

    ServerSignerEvent

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ServerSignerEventList.html b/docs/interfaces/client_api.ServerSignerEventList.html index a361fc41..26cc852d 100644 --- a/docs/interfaces/client_api.ServerSignerEventList.html +++ b/docs/interfaces/client_api.ServerSignerEventList.html @@ -1,13 +1,13 @@ ServerSignerEventList | @coinbase/coinbase-sdk

    Export

    ServerSignerEventList

    -
    interface ServerSignerEventList {
        data: ServerSignerEvent[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    interface ServerSignerEventList {
        data: ServerSignerEvent[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    Memberof

    ServerSignerEventList

    -
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    ServerSignerEventList

    -
    next_page: string

    The page token to be used to fetch the next page.

    +
    next_page: string

    The page token to be used to fetch the next page.

    Memberof

    ServerSignerEventList

    -
    total_count: number

    The total number of events for the server signer.

    +
    total_count: number

    The total number of events for the server signer.

    Memberof

    ServerSignerEventList

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ServerSignersApiInterface.html b/docs/interfaces/client_api.ServerSignersApiInterface.html index d202498d..a7a5698e 100644 --- a/docs/interfaces/client_api.ServerSignersApiInterface.html +++ b/docs/interfaces/client_api.ServerSignersApiInterface.html @@ -1,6 +1,6 @@ ServerSignersApiInterface | @coinbase/coinbase-sdk

    ServerSignersApi - interface

    Export

    ServerSignersApi

    -
    interface ServerSignersApiInterface {
        createServerSigner(createServerSignerRequest?, options?): AxiosPromise<ServerSigner>;
        getServerSigner(serverSignerId, options?): AxiosPromise<ServerSigner>;
        listServerSignerEvents(serverSignerId, limit?, page?, options?): AxiosPromise<ServerSignerEventList>;
        listServerSigners(options?): AxiosPromise<ServerSigner>;
        submitServerSignerSeedEventResult(serverSignerId, seedCreationEventResult?, options?): AxiosPromise<SeedCreationEventResult>;
        submitServerSignerSignatureEventResult(serverSignerId, signatureCreationEventResult?, options?): AxiosPromise<SignatureCreationEventResult>;
    }

    Implemented by

    Methods

    interface ServerSignersApiInterface {
        createServerSigner(createServerSignerRequest?, options?): AxiosPromise<ServerSigner>;
        getServerSigner(serverSignerId, options?): AxiosPromise<ServerSigner>;
        listServerSignerEvents(serverSignerId, limit?, page?, options?): AxiosPromise<ServerSignerEventList>;
        listServerSigners(options?): AxiosPromise<ServerSigner>;
        submitServerSignerSeedEventResult(serverSignerId, seedCreationEventResult?, options?): AxiosPromise<SeedCreationEventResult>;
        submitServerSignerSignatureEventResult(serverSignerId, signatureCreationEventResult?, options?): AxiosPromise<SignatureCreationEventResult>;
    }

    Implemented by

    Methods

    Parameters

    • Optional createServerSignerRequest: CreateServerSignerRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ServerSigner>

    Summary

    Create a new Server-Signer

    Throws

    Memberof

    ServerSignersApiInterface

    -
    • 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

      -
    • 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

      Throws

      Memberof

      ServerSignersApiInterface

      -
    • List server signers for the current project

      Parameters

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<ServerSigner>

      Summary

      List server signers for the current project

      Throws

      Memberof

      ServerSignersApiInterface

      -
    • 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

      -
    • 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

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.SignatureCreationEvent.html b/docs/interfaces/client_api.SignatureCreationEvent.html index e99e7897..cefccd83 100644 --- a/docs/interfaces/client_api.SignatureCreationEvent.html +++ b/docs/interfaces/client_api.SignatureCreationEvent.html @@ -1,6 +1,6 @@ SignatureCreationEvent | @coinbase/coinbase-sdk

    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

    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: string

    The ID of the address the transfer belongs to

    Memberof

    SignatureCreationEvent

    -
    address_index: number

    The index of the address that the server-signer should sign with

    +
    address_index: number

    The index of the address that the server-signer should sign with

    Memberof

    SignatureCreationEvent

    -
    seed_id: string

    The ID of the seed that the server-signer should create the signature for

    +
    seed_id: string

    The ID of the seed that the server-signer should create the signature for

    Memberof

    SignatureCreationEvent

    -
    signing_payload: string

    The payload that the server-signer should sign

    +
    signing_payload: string

    The payload that the server-signer should sign

    Memberof

    SignatureCreationEvent

    -
    transaction_id: string

    The ID of the transaction that the server-signer should sign

    +
    transaction_id: string

    The ID of the transaction that the server-signer should sign

    Memberof

    SignatureCreationEvent

    -
    transaction_type: "transfer"

    Memberof

    SignatureCreationEvent

    -
    wallet_id: string

    The ID of the wallet the signature is for

    +
    transaction_type: "transfer"

    Memberof

    SignatureCreationEvent

    +
    wallet_id: string

    The ID of the wallet the signature is for

    Memberof

    SignatureCreationEvent

    -
    wallet_user_id: string

    The ID of the user that the wallet belongs to

    +
    wallet_user_id: string

    The ID of the user that the wallet belongs to

    Memberof

    SignatureCreationEvent

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.SignatureCreationEventResult.html b/docs/interfaces/client_api.SignatureCreationEventResult.html index 7feda58a..d10a0c9e 100644 --- a/docs/interfaces/client_api.SignatureCreationEventResult.html +++ b/docs/interfaces/client_api.SignatureCreationEventResult.html @@ -1,6 +1,6 @@ SignatureCreationEventResult | @coinbase/coinbase-sdk

    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

    interface SignatureCreationEventResult {
        address_id: string;
        signature: string;
        transaction_id: string;
        transaction_type: "transfer";
        wallet_id: string;
        wallet_user_id: string;
    }

    Properties

    address_id: string

    The ID of the address the transfer belongs to

    Memberof

    SignatureCreationEventResult

    -
    signature: string

    The signature created by the server-signer.

    +
    signature: string

    The signature created by the server-signer.

    Memberof

    SignatureCreationEventResult

    -
    transaction_id: string

    The ID of the transaction that the Server-Signer has signed for

    +
    transaction_id: string

    The ID of the transaction that the Server-Signer has signed for

    Memberof

    SignatureCreationEventResult

    -
    transaction_type: "transfer"

    Memberof

    SignatureCreationEventResult

    -
    wallet_id: string

    The ID of the wallet that the event was created for.

    +
    transaction_type: "transfer"

    Memberof

    SignatureCreationEventResult

    +
    wallet_id: string

    The ID of the wallet that the event was created for.

    Memberof

    SignatureCreationEventResult

    -
    wallet_user_id: string

    The ID of the user that the wallet belongs to

    +
    wallet_user_id: string

    The ID of the user that the wallet belongs to

    Memberof

    SignatureCreationEventResult

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.Trade.html b/docs/interfaces/client_api.Trade.html index fea26507..495f9d3a 100644 --- a/docs/interfaces/client_api.Trade.html +++ b/docs/interfaces/client_api.Trade.html @@ -1,6 +1,6 @@ Trade | @coinbase/coinbase-sdk

    A trade of an asset to another asset

    Export

    Trade

    -
    interface Trade {
        address_id: string;
        from_amount: string;
        from_asset: Asset;
        network_id: string;
        to_amount: string;
        to_asset: Asset;
        trade_id: string;
        transaction: Transaction;
        wallet_id: string;
    }

    Properties

    interface Trade {
        address_id: string;
        from_amount: string;
        from_asset: Asset;
        network_id: string;
        to_amount: string;
        to_asset: Asset;
        trade_id: string;
        transaction: Transaction;
        wallet_id: string;
    }

    Properties

    Properties

    address_id: string

    The onchain address of the sender

    Memberof

    Trade

    -
    from_amount: string

    The amount of the from asset to be traded (in atomic units of the from asset)

    +
    from_amount: string

    The amount of the from asset to be traded (in atomic units of the from asset)

    Memberof

    Trade

    -
    from_asset: Asset

    Memberof

    Trade

    -
    network_id: string

    The ID of the blockchain network

    +
    from_asset: Asset

    Memberof

    Trade

    +
    network_id: string

    The ID of the blockchain network

    Memberof

    Trade

    -
    to_amount: string

    The amount of the to asset that will be received (in atomic units of the to asset)

    +
    to_amount: string

    The amount of the to asset that will be received (in atomic units of the to asset)

    Memberof

    Trade

    -
    to_asset: Asset

    Memberof

    Trade

    -
    trade_id: string

    The ID of the trade

    +
    to_asset: Asset

    Memberof

    Trade

    +
    trade_id: string

    The ID of the trade

    Memberof

    Trade

    -
    transaction: Transaction

    Memberof

    Trade

    -
    wallet_id: string

    The ID of the wallet that owns the from address

    +
    transaction: Transaction

    Memberof

    Trade

    +
    wallet_id: string

    The ID of the wallet that owns the from address

    Memberof

    Trade

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.TradeList.html b/docs/interfaces/client_api.TradeList.html index 65712ca2..ad8f9cd8 100644 --- a/docs/interfaces/client_api.TradeList.html +++ b/docs/interfaces/client_api.TradeList.html @@ -1,13 +1,13 @@ TradeList | @coinbase/coinbase-sdk

    Export

    TradeList

    -
    interface TradeList {
        data: Trade[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    interface TradeList {
        data: Trade[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data: Trade[]

    Memberof

    TradeList

    -
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    TradeList

    -
    next_page: string

    The page token to be used to fetch the next page.

    +
    next_page: string

    The page token to be used to fetch the next page.

    Memberof

    TradeList

    -
    total_count: number

    The total number of trades for the address in the wallet.

    +
    total_count: number

    The total number of trades for the address in the wallet.

    Memberof

    TradeList

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.TradesApiInterface.html b/docs/interfaces/client_api.TradesApiInterface.html index bbe5b749..4fca1f6e 100644 --- a/docs/interfaces/client_api.TradesApiInterface.html +++ b/docs/interfaces/client_api.TradesApiInterface.html @@ -1,6 +1,6 @@ TradesApiInterface | @coinbase/coinbase-sdk

    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

    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

  • broadcastTradeRequest: BroadcastTradeRequest
  • Optional options: RawAxiosRequestConfig

    Override http request option.

  • Returns AxiosPromise<Trade>

    Summary

    Broadcast a trade

    Throws

    Memberof

    TradesApiInterface

    -
    • Create a new 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

      -
    • 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

      -
    • 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

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.Transaction.html b/docs/interfaces/client_api.Transaction.html index 4518da8b..b76059c1 100644 --- a/docs/interfaces/client_api.Transaction.html +++ b/docs/interfaces/client_api.Transaction.html @@ -1,6 +1,6 @@ Transaction | @coinbase/coinbase-sdk

    An onchain transaction.

    Export

    Transaction

    -
    interface Transaction {
        from_address_id: string;
        network_id: string;
        signed_payload?: string;
        status: TransactionStatusEnum;
        transaction_hash?: string;
        unsigned_payload: string;
    }

    Properties

    interface Transaction {
        from_address_id: string;
        network_id: string;
        signed_payload?: string;
        status: TransactionStatusEnum;
        transaction_hash?: string;
        unsigned_payload: string;
    }

    Properties

    from_address_id: string

    The onchain address of the sender

    Memberof

    Transaction

    -
    network_id: string

    The ID of the blockchain network

    +
    network_id: string

    The ID of the blockchain network

    Memberof

    Transaction

    -
    signed_payload?: string

    The signed payload of the transaction. This is the payload that has been signed by the sender.

    +
    signed_payload?: string

    The signed payload of the transaction. This is the payload that has been signed by the sender.

    Memberof

    Transaction

    -

    The status of the transaction

    +

    The status of the transaction

    Memberof

    Transaction

    -
    transaction_hash?: string

    The hash of the transaction

    +
    transaction_hash?: string

    The hash of the transaction

    Memberof

    Transaction

    -
    unsigned_payload: string

    The unsigned payload of the transaction. This is the payload that needs to be signed by the sender.

    +
    unsigned_payload: string

    The unsigned payload of the transaction. This is the payload that needs to be signed by the sender.

    Memberof

    Transaction

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.Transfer.html b/docs/interfaces/client_api.Transfer.html index 59d39226..a912ba46 100644 --- a/docs/interfaces/client_api.Transfer.html +++ b/docs/interfaces/client_api.Transfer.html @@ -1,6 +1,6 @@ Transfer | @coinbase/coinbase-sdk

    A transfer of an asset from one address to another

    Export

    Transfer

    -
    interface Transfer {
        address_id: string;
        amount: string;
        asset_id: string;
        destination: string;
        network_id: string;
        signed_payload?: string;
        status: TransferStatusEnum;
        transaction_hash?: string;
        transfer_id: string;
        unsigned_payload: string;
        wallet_id: string;
    }

    Properties

    interface Transfer {
        address_id: string;
        amount: string;
        asset_id: string;
        destination: string;
        network_id: string;
        signed_payload?: string;
        status: TransferStatusEnum;
        transaction_hash?: string;
        transfer_id: string;
        unsigned_payload: string;
        wallet_id: string;
    }

    Properties

    Properties

    address_id: string

    The onchain address of the sender

    Memberof

    Transfer

    -
    amount: string

    The amount in the atomic units of the asset

    +
    amount: string

    The amount in the atomic units of the asset

    Memberof

    Transfer

    -
    asset_id: string

    The ID of the asset being transferred

    +
    asset_id: string

    The ID of the asset being transferred

    Memberof

    Transfer

    -
    destination: string

    The onchain address of the recipient

    +
    destination: string

    The onchain address of the recipient

    Memberof

    Transfer

    -
    network_id: string

    The ID of the blockchain network

    +
    network_id: string

    The ID of the blockchain network

    Memberof

    Transfer

    -
    signed_payload?: string

    The signed payload of the transfer. This is the payload that has been signed by the sender.

    +
    signed_payload?: string

    The signed payload of the transfer. This is the payload that has been signed by the sender.

    Memberof

    Transfer

    -

    The status of the transfer

    +

    The status of the transfer

    Memberof

    Transfer

    -
    transaction_hash?: string

    The hash of the transfer transaction

    +
    transaction_hash?: string

    The hash of the transfer transaction

    Memberof

    Transfer

    -
    transfer_id: string

    The ID of the transfer

    +
    transfer_id: string

    The ID of the transfer

    Memberof

    Transfer

    -
    unsigned_payload: string

    The unsigned payload of the transfer. This is the payload that needs to be signed by the sender.

    +
    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: string

    The ID of the wallet that owns the from address

    +
    wallet_id: string

    The ID of the wallet that owns the from address

    Memberof

    Transfer

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.TransferList.html b/docs/interfaces/client_api.TransferList.html index 030bb61e..0d9d07e8 100644 --- a/docs/interfaces/client_api.TransferList.html +++ b/docs/interfaces/client_api.TransferList.html @@ -1,13 +1,13 @@ TransferList | @coinbase/coinbase-sdk

    Export

    TransferList

    -
    interface TransferList {
        data: Transfer[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    interface TransferList {
        data: Transfer[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data: Transfer[]

    Memberof

    TransferList

    -
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    TransferList

    -
    next_page: string

    The page token to be used to fetch the next page.

    +
    next_page: string

    The page token to be used to fetch the next page.

    Memberof

    TransferList

    -
    total_count: number

    The total number of transfers for the address in the wallet.

    +
    total_count: number

    The total number of transfers for the address in the wallet.

    Memberof

    TransferList

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.TransfersApiInterface.html b/docs/interfaces/client_api.TransfersApiInterface.html index 130b53d7..f59eb5f7 100644 --- a/docs/interfaces/client_api.TransfersApiInterface.html +++ b/docs/interfaces/client_api.TransfersApiInterface.html @@ -1,6 +1,6 @@ TransfersApiInterface | @coinbase/coinbase-sdk

    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

    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

  • broadcastTransferRequest: BroadcastTransferRequest
  • Optional options: RawAxiosRequestConfig

    Override http request option.

  • Returns AxiosPromise<Transfer>

    Summary

    Broadcast a transfer

    Throws

    Memberof

    TransfersApiInterface

    -
    • 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

      -
    • 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

      -
    • 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

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.User.html b/docs/interfaces/client_api.User.html index 3b74a1ee..e50a3927 100644 --- a/docs/interfaces/client_api.User.html +++ b/docs/interfaces/client_api.User.html @@ -1,7 +1,7 @@ User | @coinbase/coinbase-sdk

    Export

    User

    -
    interface User {
        display_name?: string;
        id: string;
    }

    Properties

    interface User {
        display_name?: string;
        id: string;
    }

    Properties

    Properties

    display_name?: string

    Memberof

    User

    -
    id: string

    The ID of the user

    +
    id: string

    The ID of the user

    Memberof

    User

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.UsersApiInterface.html b/docs/interfaces/client_api.UsersApiInterface.html index 553b06b9..16e913ae 100644 --- a/docs/interfaces/client_api.UsersApiInterface.html +++ b/docs/interfaces/client_api.UsersApiInterface.html @@ -1,8 +1,8 @@ UsersApiInterface | @coinbase/coinbase-sdk

    UsersApi - interface

    Export

    UsersApi

    -
    interface UsersApiInterface {
        getCurrentUser(options?): AxiosPromise<User>;
    }

    Implemented by

    Methods

    interface UsersApiInterface {
        getCurrentUser(options?): AxiosPromise<User>;
    }

    Implemented by

    Methods

    • Get current user

      Parameters

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<User>

      Summary

      Get current user

      Throws

      Memberof

      UsersApiInterface

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.Wallet.html b/docs/interfaces/client_api.Wallet.html index 83ab6c42..945389ea 100644 --- a/docs/interfaces/client_api.Wallet.html +++ b/docs/interfaces/client_api.Wallet.html @@ -1,13 +1,13 @@ Wallet | @coinbase/coinbase-sdk

    Export

    Wallet

    -
    interface Wallet {
        default_address?: Address;
        id: string;
        network_id: string;
        server_signer_status?: WalletServerSignerStatusEnum;
    }

    Properties

    interface Wallet {
        default_address?: Address;
        id: string;
        network_id: string;
        server_signer_status?: WalletServerSignerStatusEnum;
    }

    Properties

    default_address?: Address

    Memberof

    Wallet

    -
    id: string

    The server-assigned ID for the wallet.

    +
    id: string

    The server-assigned ID for the wallet.

    Memberof

    Wallet

    -
    network_id: string

    The ID of the blockchain network

    +
    network_id: string

    The ID of the blockchain network

    Memberof

    Wallet

    -
    server_signer_status?: WalletServerSignerStatusEnum

    The status of the Server-Signer for the wallet if present.

    +
    server_signer_status?: WalletServerSignerStatusEnum

    The status of the Server-Signer for the wallet if present.

    Memberof

    Wallet

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.WalletList.html b/docs/interfaces/client_api.WalletList.html index dbe900f7..b49623d3 100644 --- a/docs/interfaces/client_api.WalletList.html +++ b/docs/interfaces/client_api.WalletList.html @@ -1,14 +1,14 @@ WalletList | @coinbase/coinbase-sdk

    Paginated list of wallets

    Export

    WalletList

    -
    interface WalletList {
        data: Wallet[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    interface WalletList {
        data: Wallet[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data: Wallet[]

    Memberof

    WalletList

    -
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    WalletList

    -
    next_page: string

    The page token to be used to fetch the next page.

    +
    next_page: string

    The page token to be used to fetch the next page.

    Memberof

    WalletList

    -
    total_count: number

    The total number of wallets

    +
    total_count: number

    The total number of wallets

    Memberof

    WalletList

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.WalletsApiInterface.html b/docs/interfaces/client_api.WalletsApiInterface.html index b1bd17e0..99a074c6 100644 --- a/docs/interfaces/client_api.WalletsApiInterface.html +++ b/docs/interfaces/client_api.WalletsApiInterface.html @@ -1,6 +1,6 @@ WalletsApiInterface | @coinbase/coinbase-sdk

    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

    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

    Parameters

    • Optional createWalletRequest: CreateWalletRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<Wallet>

    Summary

    Create a new wallet

    Throws

    Memberof

    WalletsApiInterface

    -
    • 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

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

      +
    • 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

      -
    • 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

      -
    • 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

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_base.RequestArgs.html b/docs/interfaces/client_base.RequestArgs.html index bccd3c84..792e0f17 100644 --- a/docs/interfaces/client_base.RequestArgs.html +++ b/docs/interfaces/client_base.RequestArgs.html @@ -1,4 +1,4 @@ RequestArgs | @coinbase/coinbase-sdk

    Export

    RequestArgs

    -
    interface RequestArgs {
        options: RawAxiosRequestConfig;
        url: string;
    }

    Properties

    interface RequestArgs {
        options: RawAxiosRequestConfig;
        url: string;
    }

    Properties

    Properties

    options: RawAxiosRequestConfig
    url: string
    \ No newline at end of file +

    Properties

    options: RawAxiosRequestConfig
    url: string
    \ No newline at end of file diff --git a/docs/interfaces/client_configuration.ConfigurationParameters.html b/docs/interfaces/client_configuration.ConfigurationParameters.html index 598ba90c..c9804725 100644 --- a/docs/interfaces/client_configuration.ConfigurationParameters.html +++ b/docs/interfaces/client_configuration.ConfigurationParameters.html @@ -5,7 +5,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

    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?: 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>

    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>

    baseOptions?: any
    basePath?: string
    formDataCtor?: (new () => any)

    Type declaration

      • new (): any
      • Returns any

    password?: string
    serverIndex?: number
    username?: string
    \ No newline at end of file +

    Properties

    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>

    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>

    baseOptions?: any
    basePath?: string
    formDataCtor?: (new () => any)

    Type declaration

      • new (): any
      • Returns any

    password?: string
    serverIndex?: number
    username?: string
    \ No newline at end of file diff --git a/docs/modules/client.html b/docs/modules/client.html index b48e8389..ce24d242 100644 --- a/docs/modules/client.html +++ b/docs/modules/client.html @@ -1,4 +1,4 @@ -client | @coinbase/coinbase-sdk

    References

    Address +client | @coinbase/coinbase-sdk

    References

    Address AddressBalanceList AddressList AddressesApi diff --git a/docs/modules/client_api.html b/docs/modules/client_api.html index d6fa21d1..1b4a9ace 100644 --- a/docs/modules/client_api.html +++ b/docs/modules/client_api.html @@ -1,4 +1,4 @@ -client/api | @coinbase/coinbase-sdk

    Index

    Enumerations

    TransactionType +client/api | @coinbase/coinbase-sdk

    Index

    Enumerations

    Classes

    AddressesApi ServerSignersApi TradesApi diff --git a/docs/modules/client_base.html b/docs/modules/client_base.html index cf1df197..b0b93010 100644 --- a/docs/modules/client_base.html +++ b/docs/modules/client_base.html @@ -1,4 +1,4 @@ -client/base | @coinbase/coinbase-sdk

    Index

    Classes

    BaseAPI +client/base | @coinbase/coinbase-sdk

    Index

    Classes

    Interfaces

    Variables

    BASE_PATH diff --git a/docs/modules/client_common.html b/docs/modules/client_common.html index ac42b33d..2ffc69cc 100644 --- a/docs/modules/client_common.html +++ b/docs/modules/client_common.html @@ -1,4 +1,4 @@ -client/common | @coinbase/coinbase-sdk

    Index

    Variables

    DUMMY_BASE_URL +client/common | @coinbase/coinbase-sdk

    Index

    Variables

    Functions

    assertParamExists createRequestFunction serializeDataIfNeeded diff --git a/docs/modules/client_configuration.html b/docs/modules/client_configuration.html index f8f3e767..7e5bd7ae 100644 --- a/docs/modules/client_configuration.html +++ b/docs/modules/client_configuration.html @@ -1,3 +1,3 @@ -client/configuration | @coinbase/coinbase-sdk

    Index

    Classes

    Configuration +client/configuration | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase.html b/docs/modules/coinbase.html index 669feaf7..3782ed8b 100644 --- a/docs/modules/coinbase.html +++ b/docs/modules/coinbase.html @@ -1,2 +1,2 @@ -coinbase | @coinbase/coinbase-sdk

    References

    Coinbase +coinbase | @coinbase/coinbase-sdk

    References

    References

    Re-exports Coinbase
    \ No newline at end of file diff --git a/docs/modules/coinbase_address.html b/docs/modules/coinbase_address.html index 22ee0ca6..3eb5e7da 100644 --- a/docs/modules/coinbase_address.html +++ b/docs/modules/coinbase_address.html @@ -1,2 +1,2 @@ -coinbase/address | @coinbase/coinbase-sdk

    Index

    Classes

    Address +coinbase/address | @coinbase/coinbase-sdk

    Index

    Classes

    \ No newline at end of file diff --git a/docs/modules/coinbase_api_error.html b/docs/modules/coinbase_api_error.html index fbbb3bc9..a922e234 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

    Index

    Classes

    APIError +coinbase/api_error | @coinbase/coinbase-sdk

    Index

    Classes

    APIError AlreadyExistsError FaucetLimitReachedError InvalidAddressError diff --git a/docs/modules/coinbase_asset.html b/docs/modules/coinbase_asset.html index 1023238c..8a892760 100644 --- a/docs/modules/coinbase_asset.html +++ b/docs/modules/coinbase_asset.html @@ -1,2 +1,2 @@ -coinbase/asset | @coinbase/coinbase-sdk

    Index

    Classes

    Asset +coinbase/asset | @coinbase/coinbase-sdk

    Index

    Classes

    \ No newline at end of file diff --git a/docs/modules/coinbase_authenticator.html b/docs/modules/coinbase_authenticator.html index 1456ff32..bbe01da3 100644 --- a/docs/modules/coinbase_authenticator.html +++ b/docs/modules/coinbase_authenticator.html @@ -1,2 +1,2 @@ -coinbase/authenticator | @coinbase/coinbase-sdk

    Index

    Classes

    CoinbaseAuthenticator +coinbase/authenticator | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_balance.html b/docs/modules/coinbase_balance.html index 58c0439f..de7a70b8 100644 --- a/docs/modules/coinbase_balance.html +++ b/docs/modules/coinbase_balance.html @@ -1,2 +1,2 @@ -coinbase/balance | @coinbase/coinbase-sdk

    Index

    Classes

    Balance +coinbase/balance | @coinbase/coinbase-sdk

    Index

    Classes

    \ No newline at end of file diff --git a/docs/modules/coinbase_balance_map.html b/docs/modules/coinbase_balance_map.html index 2c8cc284..3a0f6904 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

    Index

    Classes

    BalanceMap +coinbase/balance_map | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_coinbase.html b/docs/modules/coinbase_coinbase.html index b29b9e5d..fb4b2892 100644 --- a/docs/modules/coinbase_coinbase.html +++ b/docs/modules/coinbase_coinbase.html @@ -1,2 +1,2 @@ -coinbase/coinbase | @coinbase/coinbase-sdk

    Index

    Classes

    Coinbase +coinbase/coinbase | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_constants.html b/docs/modules/coinbase_constants.html index 9b261b98..ad2bd780 100644 --- a/docs/modules/coinbase_constants.html +++ b/docs/modules/coinbase_constants.html @@ -1,4 +1,4 @@ -coinbase/constants | @coinbase/coinbase-sdk

    Index

    Variables

    ATOMIC_UNITS_PER_USDC +coinbase/constants | @coinbase/coinbase-sdk

    Index

    Variables

    ATOMIC_UNITS_PER_USDC GWEI_PER_ETHER WEI_PER_ETHER WEI_PER_GWEI diff --git a/docs/modules/coinbase_errors.html b/docs/modules/coinbase_errors.html index d37f5647..59247655 100644 --- a/docs/modules/coinbase_errors.html +++ b/docs/modules/coinbase_errors.html @@ -1,4 +1,4 @@ -coinbase/errors | @coinbase/coinbase-sdk

    Index

    Classes

    ArgumentError +coinbase/errors | @coinbase/coinbase-sdk

    Index

    Classes

    ArgumentError InternalError InvalidAPIKeyFormat InvalidConfiguration diff --git a/docs/modules/coinbase_faucet_transaction.html b/docs/modules/coinbase_faucet_transaction.html index c7022ab1..4c7ada54 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
    \ No newline at end of file diff --git a/docs/modules/coinbase_tests_address_test.html b/docs/modules/coinbase_tests_address_test.html index 1541ad23..55a37ad8 100644 --- a/docs/modules/coinbase_tests_address_test.html +++ b/docs/modules/coinbase_tests_address_test.html @@ -1 +1 @@ -coinbase/tests/address_test | @coinbase/coinbase-sdk
    \ No newline at end of file +coinbase/tests/address_test | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_tests_authenticator_test.html b/docs/modules/coinbase_tests_authenticator_test.html index 3d45db97..9f45bb18 100644 --- a/docs/modules/coinbase_tests_authenticator_test.html +++ b/docs/modules/coinbase_tests_authenticator_test.html @@ -1 +1 @@ -coinbase/tests/authenticator_test | @coinbase/coinbase-sdk
    \ No newline at end of file +coinbase/tests/authenticator_test | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_tests_balance_map_test.html b/docs/modules/coinbase_tests_balance_map_test.html index 712d8c44..97fe7dc6 100644 --- a/docs/modules/coinbase_tests_balance_map_test.html +++ b/docs/modules/coinbase_tests_balance_map_test.html @@ -1 +1 @@ -coinbase/tests/balance_map_test | @coinbase/coinbase-sdk
    \ No newline at end of file +coinbase/tests/balance_map_test | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_tests_balance_test.html b/docs/modules/coinbase_tests_balance_test.html index a15b496a..aa6afb52 100644 --- a/docs/modules/coinbase_tests_balance_test.html +++ b/docs/modules/coinbase_tests_balance_test.html @@ -1 +1 @@ -coinbase/tests/balance_test | @coinbase/coinbase-sdk
    \ No newline at end of file +coinbase/tests/balance_test | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_tests_coinbase_test.html b/docs/modules/coinbase_tests_coinbase_test.html index 1473cf49..df29792d 100644 --- a/docs/modules/coinbase_tests_coinbase_test.html +++ b/docs/modules/coinbase_tests_coinbase_test.html @@ -1 +1 @@ -coinbase/tests/coinbase_test | @coinbase/coinbase-sdk
    \ No newline at end of file +coinbase/tests/coinbase_test | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_tests_faucet_transaction_test.html b/docs/modules/coinbase_tests_faucet_transaction_test.html index b385d306..951d7810 100644 --- a/docs/modules/coinbase_tests_faucet_transaction_test.html +++ b/docs/modules/coinbase_tests_faucet_transaction_test.html @@ -1 +1 @@ -coinbase/tests/faucet_transaction_test | @coinbase/coinbase-sdk
    \ No newline at end of file +coinbase/tests/faucet_transaction_test | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_tests_transfer_test.html b/docs/modules/coinbase_tests_transfer_test.html index a77f966e..e7162d47 100644 --- a/docs/modules/coinbase_tests_transfer_test.html +++ b/docs/modules/coinbase_tests_transfer_test.html @@ -1 +1 @@ -coinbase/tests/transfer_test | @coinbase/coinbase-sdk
    \ No newline at end of file +coinbase/tests/transfer_test | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_tests_user_test.html b/docs/modules/coinbase_tests_user_test.html index f53b02d1..70f6c7ce 100644 --- a/docs/modules/coinbase_tests_user_test.html +++ b/docs/modules/coinbase_tests_user_test.html @@ -1 +1 @@ -coinbase/tests/user_test | @coinbase/coinbase-sdk
    \ No newline at end of file +coinbase/tests/user_test | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_tests_utils.html b/docs/modules/coinbase_tests_utils.html index 8208e8ef..b5825538 100644 --- a/docs/modules/coinbase_tests_utils.html +++ b/docs/modules/coinbase_tests_utils.html @@ -1,4 +1,4 @@ -coinbase/tests/utils | @coinbase/coinbase-sdk

    Index

    Variables

    VALID_ADDRESS_BALANCE_LIST +coinbase/tests/utils | @coinbase/coinbase-sdk

    Index

    Variables

    VALID_ADDRESS_BALANCE_LIST VALID_ADDRESS_MODEL VALID_BALANCE_MODEL VALID_TRANSFER_MODEL diff --git a/docs/modules/coinbase_tests_wallet_test.html b/docs/modules/coinbase_tests_wallet_test.html index a9363063..b6477a66 100644 --- a/docs/modules/coinbase_tests_wallet_test.html +++ b/docs/modules/coinbase_tests_wallet_test.html @@ -1 +1 @@ -coinbase/tests/wallet_test | @coinbase/coinbase-sdk
    \ No newline at end of file +coinbase/tests/wallet_test | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_transfer.html b/docs/modules/coinbase_transfer.html index 0c7db21c..24830e76 100644 --- a/docs/modules/coinbase_transfer.html +++ b/docs/modules/coinbase_transfer.html @@ -1,2 +1,2 @@ -coinbase/transfer | @coinbase/coinbase-sdk

    Index

    Classes

    Transfer +coinbase/transfer | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_types.html b/docs/modules/coinbase_types.html index d2214a59..46a04965 100644 --- a/docs/modules/coinbase_types.html +++ b/docs/modules/coinbase_types.html @@ -1,4 +1,4 @@ -coinbase/types | @coinbase/coinbase-sdk

    Index

    Enumerations

    ServerSignerStatus +coinbase/types | @coinbase/coinbase-sdk

    Index

    Enumerations

    Type Aliases

    AddressAPIClient Amount diff --git a/docs/modules/coinbase_user.html b/docs/modules/coinbase_user.html index 34ec6a8e..486f6e74 100644 --- a/docs/modules/coinbase_user.html +++ b/docs/modules/coinbase_user.html @@ -1,2 +1,2 @@ -coinbase/user | @coinbase/coinbase-sdk

    Index

    Classes

    User +coinbase/user | @coinbase/coinbase-sdk

    Index

    Classes

    \ No newline at end of file diff --git a/docs/modules/coinbase_utils.html b/docs/modules/coinbase_utils.html index ccc92db0..db9bdad6 100644 --- a/docs/modules/coinbase_utils.html +++ b/docs/modules/coinbase_utils.html @@ -1,4 +1,4 @@ -coinbase/utils | @coinbase/coinbase-sdk

    Index

    Functions

    convertStringToHex +coinbase/utils | @coinbase/coinbase-sdk

    Index

    Functions

    convertStringToHex delay destinationToAddressHexString logApiResponse diff --git a/docs/modules/coinbase_wallet.html b/docs/modules/coinbase_wallet.html index 7d96d84e..4a427e39 100644 --- a/docs/modules/coinbase_wallet.html +++ b/docs/modules/coinbase_wallet.html @@ -1,2 +1,2 @@ -coinbase/wallet | @coinbase/coinbase-sdk

    Index

    Classes

    Wallet +coinbase/wallet | @coinbase/coinbase-sdk

    Index

    Classes

    \ No newline at end of file diff --git a/docs/modules/index.html b/docs/modules/index.html new file mode 100644 index 00000000..f4308cf3 --- /dev/null +++ b/docs/modules/index.html @@ -0,0 +1,2 @@ +index | @coinbase/coinbase-sdk

    References

    References

    Re-exports Coinbase
    \ No newline at end of file diff --git a/docs/types/client_api.ServerSignerEventEvent.html b/docs/types/client_api.ServerSignerEventEvent.html index 171175fc..c9b782fb 100644 --- a/docs/types/client_api.ServerSignerEventEvent.html +++ b/docs/types/client_api.ServerSignerEventEvent.html @@ -1 +1 @@ -ServerSignerEventEvent | @coinbase/coinbase-sdk
    ServerSignerEventEvent: SeedCreationEvent | SignatureCreationEvent

    Export

    \ No newline at end of file +ServerSignerEventEvent | @coinbase/coinbase-sdk
    ServerSignerEventEvent: SeedCreationEvent | SignatureCreationEvent

    Export

    \ No newline at end of file diff --git a/docs/types/client_api.TransactionStatusEnum.html b/docs/types/client_api.TransactionStatusEnum.html index 9b59ab72..65386eae 100644 --- a/docs/types/client_api.TransactionStatusEnum.html +++ b/docs/types/client_api.TransactionStatusEnum.html @@ -1 +1 @@ -TransactionStatusEnum | @coinbase/coinbase-sdk
    TransactionStatusEnum: typeof TransactionStatusEnum[keyof typeof TransactionStatusEnum]
    \ No newline at end of file +TransactionStatusEnum | @coinbase/coinbase-sdk
    TransactionStatusEnum: typeof TransactionStatusEnum[keyof typeof TransactionStatusEnum]
    \ No newline at end of file diff --git a/docs/types/client_api.TransferStatusEnum.html b/docs/types/client_api.TransferStatusEnum.html index 004deafb..de9f29d8 100644 --- a/docs/types/client_api.TransferStatusEnum.html +++ b/docs/types/client_api.TransferStatusEnum.html @@ -1 +1 @@ -TransferStatusEnum | @coinbase/coinbase-sdk
    TransferStatusEnum: typeof TransferStatusEnum[keyof typeof TransferStatusEnum]
    \ No newline at end of file +TransferStatusEnum | @coinbase/coinbase-sdk
    TransferStatusEnum: typeof TransferStatusEnum[keyof typeof TransferStatusEnum]
    \ No newline at end of file diff --git a/docs/types/client_api.WalletServerSignerStatusEnum.html b/docs/types/client_api.WalletServerSignerStatusEnum.html index 900ecf16..ab1657f5 100644 --- a/docs/types/client_api.WalletServerSignerStatusEnum.html +++ b/docs/types/client_api.WalletServerSignerStatusEnum.html @@ -1 +1 @@ -WalletServerSignerStatusEnum | @coinbase/coinbase-sdk
    WalletServerSignerStatusEnum: typeof WalletServerSignerStatusEnum[keyof typeof WalletServerSignerStatusEnum]
    \ No newline at end of file +WalletServerSignerStatusEnum | @coinbase/coinbase-sdk
    WalletServerSignerStatusEnum: typeof WalletServerSignerStatusEnum[keyof typeof WalletServerSignerStatusEnum]
    \ No newline at end of file diff --git a/docs/types/coinbase_types.AddressAPIClient.html b/docs/types/coinbase_types.AddressAPIClient.html index bae52f07..164b4bb0 100644 --- a/docs/types/coinbase_types.AddressAPIClient.html +++ b/docs/types/coinbase_types.AddressAPIClient.html @@ -1,30 +1,30 @@ AddressAPIClient | @coinbase/coinbase-sdk
    AddressAPIClient: {
        createAddress(walletId, createAddressRequest?, options?): AxiosPromise<Address>;
        getAddress(walletId, addressId, options?): AxiosPromise<Address>;
        getAddressBalance(walletId, addressId, assetId, options?): AxiosPromise<Balance>;
        listAddressBalances(walletId, addressId, page?, options?): AxiosPromise<AddressBalanceList>;
        listAddresses(walletId, limit?, page?, options?): AxiosPromise<AddressList>;
        requestFaucetFunds(walletId, addressId): Promise<{
            data: {
                transaction_hash: string;
            };
        }>;
    }

    AddressAPI client type definition.

    -

    Type declaration

    • createAddress:function
    • getAddress:function
      • Get address by onchain address.

        +

        Type declaration

        • createAddress:function
        • getAddress:function
          • 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
          • 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

        • listAddressBalances:function
          • Lists address balances

            +

        Returns AxiosPromise<Balance>

        Throws

    • listAddressBalances:function
      • 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
      • Lists addresses.

        +

    Returns AxiosPromise<AddressBalanceList>

    Throws

  • listAddresses:function
    • 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.

      -
  • requestFaucetFunds:function
    • Requests faucet funds for the address.

      +
  • requestFaucetFunds:function
    • Requests faucet funds for the address.

      Parameters

      • walletId: string

        The wallet ID.

      • addressId: string

        The address ID.

      Returns Promise<{
          data: {
              transaction_hash: string;
          };
      }>

      The transaction hash.

      Throws

      If the request fails.

      -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/coinbase_types.Amount.html b/docs/types/coinbase_types.Amount.html index 11d6016e..c608f6f2 100644 --- a/docs/types/coinbase_types.Amount.html +++ b/docs/types/coinbase_types.Amount.html @@ -1,2 +1,2 @@ Amount | @coinbase/coinbase-sdk
    Amount: number | bigint | Decimal

    Amount type definition.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/coinbase_types.ApiClients.html b/docs/types/coinbase_types.ApiClients.html index 2cd724f1..701ca705 100644 --- a/docs/types/coinbase_types.ApiClients.html +++ b/docs/types/coinbase_types.ApiClients.html @@ -1,3 +1,3 @@ ApiClients | @coinbase/coinbase-sdk
    ApiClients: {
        address?: AddressAPIClient;
        transfer?: TransferAPIClient;
        user?: UserAPIClient;
        wallet?: WalletAPIClient;
    }

    API clients type definition for the Coinbase SDK. Represents the set of API clients available in the SDK.

    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/docs/types/coinbase_types.CoinbaseConfigureFromJsonOptions.html b/docs/types/coinbase_types.CoinbaseConfigureFromJsonOptions.html index b1b3814b..c522a0e0 100644 --- a/docs/types/coinbase_types.CoinbaseConfigureFromJsonOptions.html +++ b/docs/types/coinbase_types.CoinbaseConfigureFromJsonOptions.html @@ -1,5 +1,6 @@ -CoinbaseConfigureFromJsonOptions | @coinbase/coinbase-sdk
    CoinbaseConfigureFromJsonOptions: {
        basePath?: string;
        debugging?: boolean;
        filePath: string;
        useServerSigner?: boolean;
    }

    Type declaration

    • Optional basePath?: string

      The base path for the API.

      +CoinbaseConfigureFromJsonOptions | @coinbase/coinbase-sdk
      CoinbaseConfigureFromJsonOptions: {
          basePath?: string;
          debugging?: boolean;
          filePath: string;
          useServerSigner?: boolean;
      }

      CoinbaseConfigureFromJsonOptions type definition.

      +

      Type declaration

      • Optional basePath?: string

        The base path for the API.

      • Optional debugging?: boolean

        If true, logs API requests and responses to the console.

      • 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.

        -
      \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/coinbase_types.CoinbaseOptions.html b/docs/types/coinbase_types.CoinbaseOptions.html index 410c4695..0e98c14a 100644 --- a/docs/types/coinbase_types.CoinbaseOptions.html +++ b/docs/types/coinbase_types.CoinbaseOptions.html @@ -4,4 +4,4 @@
  • Optional debugging?: boolean

    If true, logs API requests and responses to the console.

  • Optional privateKey?: string

    The private key associated with the API key.

  • Optional useServerSigner?: boolean

    Whether to use a Server-Signer or not.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/coinbase_types.Destination.html b/docs/types/coinbase_types.Destination.html index dacff0b2..dc521967 100644 --- a/docs/types/coinbase_types.Destination.html +++ b/docs/types/coinbase_types.Destination.html @@ -1,2 +1,2 @@ Destination | @coinbase/coinbase-sdk
    Destination: string | Address | Wallet

    Destination type definition.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/coinbase_types.SeedData.html b/docs/types/coinbase_types.SeedData.html index d13e621a..fb380018 100644 --- a/docs/types/coinbase_types.SeedData.html +++ b/docs/types/coinbase_types.SeedData.html @@ -1,2 +1,2 @@ SeedData | @coinbase/coinbase-sdk
    SeedData: {
        authTag: string;
        encrypted: boolean;
        iv: string;
        seed: string;
    }

    The Seed Data type definition.

    -

    Type declaration

    • authTag: string
    • encrypted: boolean
    • iv: string
    • seed: string
    \ No newline at end of file +

    Type declaration

    • authTag: string
    • encrypted: boolean
    • iv: string
    • seed: string
    \ No newline at end of file diff --git a/docs/types/coinbase_types.TransferAPIClient.html b/docs/types/coinbase_types.TransferAPIClient.html index a2635413..df375867 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
    • 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
    • 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
    • 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.

      -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/coinbase_types.UserAPIClient.html b/docs/types/coinbase_types.UserAPIClient.html index e0c282bd..2ee8a1d3 100644 --- a/docs/types/coinbase_types.UserAPIClient.html +++ b/docs/types/coinbase_types.UserAPIClient.html @@ -5,4 +5,4 @@
  • A promise resolvindg to the User model.
  • Throws

    If the request fails.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/coinbase_types.WalletAPIClient.html b/docs/types/coinbase_types.WalletAPIClient.html index 2e0faeed..5a649d4e 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
    • 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>

      Throws

      If the required parameter is not provided.

      Throws

      If the request fails.

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

      +
    • 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>

      Throws

      If the required parameter is not provided.

      Throws

      If the request fails.

      -
  • listWallets:function
  • listWallets:function
    • 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>

      Throws

      If the request fails.

      Throws

      If the required parameter is not provided.

      -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/coinbase_types.WalletData.html b/docs/types/coinbase_types.WalletData.html index 8d7b18de..838df144 100644 --- a/docs/types/coinbase_types.WalletData.html +++ b/docs/types/coinbase_types.WalletData.html @@ -1,3 +1,3 @@ WalletData | @coinbase/coinbase-sdk
    WalletData: {
        seed: string;
        walletId: string;
    }

    The Wallet Data type definition. The data required to recreate a Wallet.

    -

    Type declaration

    • seed: string
    • walletId: string
    \ No newline at end of file +

    Type declaration

    • seed: string
    • walletId: string
    \ 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 7dc88dab..dfbe52bc 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";
    } = ...

    Type declaration

    • Readonly Broadcast: "broadcast"
    • Readonly Complete: "complete"
    • Readonly Failed: "failed"
    • Readonly Pending: "pending"
    \ No newline at end of file +TransactionStatusEnum | @coinbase/coinbase-sdk

    Variable TransactionStatusEnumConst

    TransactionStatusEnum: {
        Broadcast: "broadcast";
        Complete: "complete";
        Failed: "failed";
        Pending: "pending";
    } = ...

    Type declaration

    • Readonly Broadcast: "broadcast"
    • Readonly Complete: "complete"
    • Readonly Failed: "failed"
    • Readonly Pending: "pending"
    \ 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 8d82ddf9..aa84b3f0 100644 --- a/docs/variables/client_api.TransferStatusEnum-1.html +++ b/docs/variables/client_api.TransferStatusEnum-1.html @@ -1 +1 @@ -TransferStatusEnum | @coinbase/coinbase-sdk
    TransferStatusEnum: {
        Broadcast: "broadcast";
        Complete: "complete";
        Failed: "failed";
        Pending: "pending";
    } = ...

    Type declaration

    • Readonly Broadcast: "broadcast"
    • Readonly Complete: "complete"
    • Readonly Failed: "failed"
    • Readonly Pending: "pending"
    \ No newline at end of file +TransferStatusEnum | @coinbase/coinbase-sdk
    TransferStatusEnum: {
        Broadcast: "broadcast";
        Complete: "complete";
        Failed: "failed";
        Pending: "pending";
    } = ...

    Type declaration

    • Readonly Broadcast: "broadcast"
    • Readonly Complete: "complete"
    • Readonly Failed: "failed"
    • Readonly Pending: "pending"
    \ 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 7c648dc8..ce9f712d 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"
    \ 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"
    \ 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 2886bbb6..ae4a2ee8 100644 --- a/docs/variables/client_base.BASE_PATH.html +++ b/docs/variables/client_base.BASE_PATH.html @@ -1 +1 @@ -BASE_PATH | @coinbase/coinbase-sdk
    BASE_PATH: string = ...
    \ No newline at end of file +BASE_PATH | @coinbase/coinbase-sdk
    BASE_PATH: string = ...
    \ 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 552a94d0..8b589b67 100644 --- a/docs/variables/client_base.COLLECTION_FORMATS.html +++ b/docs/variables/client_base.COLLECTION_FORMATS.html @@ -1 +1 @@ -COLLECTION_FORMATS | @coinbase/coinbase-sdk
    COLLECTION_FORMATS: {
        csv: string;
        pipes: string;
        ssv: string;
        tsv: string;
    } = ...

    Type declaration

    • csv: string
    • pipes: string
    • ssv: string
    • tsv: string

    Export

    \ No newline at end of file +COLLECTION_FORMATS | @coinbase/coinbase-sdk
    COLLECTION_FORMATS: {
        csv: string;
        pipes: string;
        ssv: string;
        tsv: string;
    } = ...

    Type declaration

    • csv: string
    • pipes: string
    • ssv: string
    • tsv: string

    Export

    \ No newline at end of file diff --git a/docs/variables/client_base.operationServerMap.html b/docs/variables/client_base.operationServerMap.html index 2da857cc..a736ba5b 100644 --- a/docs/variables/client_base.operationServerMap.html +++ b/docs/variables/client_base.operationServerMap.html @@ -1 +1 @@ -operationServerMap | @coinbase/coinbase-sdk
    operationServerMap: ServerMap = {}

    Export

    \ No newline at end of file +operationServerMap | @coinbase/coinbase-sdk
    operationServerMap: ServerMap = {}

    Export

    \ 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 a4ad4228..4f45b59f 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
    DUMMY_BASE_URL: "https://example.com" = "https://example.com"

    Export

    \ No newline at end of file +DUMMY_BASE_URL | @coinbase/coinbase-sdk
    DUMMY_BASE_URL: "https://example.com" = "https://example.com"

    Export

    \ No newline at end of file diff --git a/docs/variables/coinbase_constants.ATOMIC_UNITS_PER_USDC.html b/docs/variables/coinbase_constants.ATOMIC_UNITS_PER_USDC.html index 7d4c1b52..561de740 100644 --- a/docs/variables/coinbase_constants.ATOMIC_UNITS_PER_USDC.html +++ b/docs/variables/coinbase_constants.ATOMIC_UNITS_PER_USDC.html @@ -1 +1 @@ -ATOMIC_UNITS_PER_USDC | @coinbase/coinbase-sdk
    ATOMIC_UNITS_PER_USDC: Decimal = ...
    \ No newline at end of file +ATOMIC_UNITS_PER_USDC | @coinbase/coinbase-sdk
    ATOMIC_UNITS_PER_USDC: Decimal = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_constants.GWEI_PER_ETHER.html b/docs/variables/coinbase_constants.GWEI_PER_ETHER.html index e5dd2b96..e37914ed 100644 --- a/docs/variables/coinbase_constants.GWEI_PER_ETHER.html +++ b/docs/variables/coinbase_constants.GWEI_PER_ETHER.html @@ -1 +1 @@ -GWEI_PER_ETHER | @coinbase/coinbase-sdk
    GWEI_PER_ETHER: Decimal = ...
    \ No newline at end of file +GWEI_PER_ETHER | @coinbase/coinbase-sdk
    GWEI_PER_ETHER: Decimal = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_constants.WEI_PER_ETHER.html b/docs/variables/coinbase_constants.WEI_PER_ETHER.html index ff8f2930..fc4355be 100644 --- a/docs/variables/coinbase_constants.WEI_PER_ETHER.html +++ b/docs/variables/coinbase_constants.WEI_PER_ETHER.html @@ -1 +1 @@ -WEI_PER_ETHER | @coinbase/coinbase-sdk
    WEI_PER_ETHER: Decimal = ...
    \ No newline at end of file +WEI_PER_ETHER | @coinbase/coinbase-sdk
    WEI_PER_ETHER: Decimal = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_constants.WEI_PER_GWEI.html b/docs/variables/coinbase_constants.WEI_PER_GWEI.html index 18876ae8..a15cf1e9 100644 --- a/docs/variables/coinbase_constants.WEI_PER_GWEI.html +++ b/docs/variables/coinbase_constants.WEI_PER_GWEI.html @@ -1 +1 @@ -WEI_PER_GWEI | @coinbase/coinbase-sdk
    WEI_PER_GWEI: Decimal = ...
    \ No newline at end of file +WEI_PER_GWEI | @coinbase/coinbase-sdk
    WEI_PER_GWEI: Decimal = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.VALID_ADDRESS_BALANCE_LIST.html b/docs/variables/coinbase_tests_utils.VALID_ADDRESS_BALANCE_LIST.html index 81185edd..f1435c24 100644 --- a/docs/variables/coinbase_tests_utils.VALID_ADDRESS_BALANCE_LIST.html +++ b/docs/variables/coinbase_tests_utils.VALID_ADDRESS_BALANCE_LIST.html @@ -1 +1 @@ -VALID_ADDRESS_BALANCE_LIST | @coinbase/coinbase-sdk
    VALID_ADDRESS_BALANCE_LIST: AddressBalanceList = ...
    \ No newline at end of file +VALID_ADDRESS_BALANCE_LIST | @coinbase/coinbase-sdk
    VALID_ADDRESS_BALANCE_LIST: AddressBalanceList = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.VALID_ADDRESS_MODEL.html b/docs/variables/coinbase_tests_utils.VALID_ADDRESS_MODEL.html index 32c1f1b3..06fc204c 100644 --- a/docs/variables/coinbase_tests_utils.VALID_ADDRESS_MODEL.html +++ b/docs/variables/coinbase_tests_utils.VALID_ADDRESS_MODEL.html @@ -1 +1 @@ -VALID_ADDRESS_MODEL | @coinbase/coinbase-sdk
    VALID_ADDRESS_MODEL: Address = ...
    \ No newline at end of file +VALID_ADDRESS_MODEL | @coinbase/coinbase-sdk
    VALID_ADDRESS_MODEL: Address = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.VALID_BALANCE_MODEL.html b/docs/variables/coinbase_tests_utils.VALID_BALANCE_MODEL.html index 1d598555..b9678e93 100644 --- a/docs/variables/coinbase_tests_utils.VALID_BALANCE_MODEL.html +++ b/docs/variables/coinbase_tests_utils.VALID_BALANCE_MODEL.html @@ -1 +1 @@ -VALID_BALANCE_MODEL | @coinbase/coinbase-sdk
    VALID_BALANCE_MODEL: Balance = ...
    \ No newline at end of file +VALID_BALANCE_MODEL | @coinbase/coinbase-sdk
    VALID_BALANCE_MODEL: Balance = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.VALID_TRANSFER_MODEL.html b/docs/variables/coinbase_tests_utils.VALID_TRANSFER_MODEL.html index 1f0da069..947c42d9 100644 --- a/docs/variables/coinbase_tests_utils.VALID_TRANSFER_MODEL.html +++ b/docs/variables/coinbase_tests_utils.VALID_TRANSFER_MODEL.html @@ -1 +1 @@ -VALID_TRANSFER_MODEL | @coinbase/coinbase-sdk
    VALID_TRANSFER_MODEL: Transfer = ...
    \ No newline at end of file +VALID_TRANSFER_MODEL | @coinbase/coinbase-sdk
    VALID_TRANSFER_MODEL: Transfer = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.VALID_WALLET_MODEL.html b/docs/variables/coinbase_tests_utils.VALID_WALLET_MODEL.html index 47cd1385..3943281e 100644 --- a/docs/variables/coinbase_tests_utils.VALID_WALLET_MODEL.html +++ b/docs/variables/coinbase_tests_utils.VALID_WALLET_MODEL.html @@ -1 +1 @@ -VALID_WALLET_MODEL | @coinbase/coinbase-sdk
    VALID_WALLET_MODEL: Wallet = ...
    \ No newline at end of file +VALID_WALLET_MODEL | @coinbase/coinbase-sdk
    VALID_WALLET_MODEL: Wallet = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.addressesApiMock.html b/docs/variables/coinbase_tests_utils.addressesApiMock.html index a2073c56..807c1a35 100644 --- a/docs/variables/coinbase_tests_utils.addressesApiMock.html +++ b/docs/variables/coinbase_tests_utils.addressesApiMock.html @@ -1 +1 @@ -addressesApiMock | @coinbase/coinbase-sdk
    addressesApiMock: {
        createAddress: Mock<any, any, any>;
        getAddress: Mock<any, any, any>;
        getAddressBalance: Mock<any, any, any>;
        listAddressBalances: Mock<any, any, any>;
        listAddresses: Mock<any, any, any>;
        requestFaucetFunds: Mock<any, any, any>;
    } = ...

    Type declaration

    • createAddress: Mock<any, any, any>
    • getAddress: Mock<any, any, any>
    • getAddressBalance: Mock<any, any, any>
    • listAddressBalances: Mock<any, any, any>
    • listAddresses: Mock<any, any, any>
    • requestFaucetFunds: Mock<any, any, any>
    \ No newline at end of file +addressesApiMock | @coinbase/coinbase-sdk
    addressesApiMock: {
        createAddress: Mock<any, any, any>;
        getAddress: Mock<any, any, any>;
        getAddressBalance: Mock<any, any, any>;
        listAddressBalances: Mock<any, any, any>;
        listAddresses: Mock<any, any, any>;
        requestFaucetFunds: Mock<any, any, any>;
    } = ...

    Type declaration

    • createAddress: Mock<any, any, any>
    • getAddress: Mock<any, any, any>
    • getAddressBalance: Mock<any, any, any>
    • listAddressBalances: Mock<any, any, any>
    • listAddresses: Mock<any, any, any>
    • requestFaucetFunds: Mock<any, any, any>
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.transferId.html b/docs/variables/coinbase_tests_utils.transferId.html index cae7c4bc..56f2ad27 100644 --- a/docs/variables/coinbase_tests_utils.transferId.html +++ b/docs/variables/coinbase_tests_utils.transferId.html @@ -1 +1 @@ -transferId | @coinbase/coinbase-sdk
    transferId: `${string}-${string}-${string}-${string}-${string}` = ...
    \ No newline at end of file +transferId | @coinbase/coinbase-sdk
    transferId: `${string}-${string}-${string}-${string}-${string}` = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.transfersApiMock.html b/docs/variables/coinbase_tests_utils.transfersApiMock.html index 63e315aa..02b67a91 100644 --- a/docs/variables/coinbase_tests_utils.transfersApiMock.html +++ b/docs/variables/coinbase_tests_utils.transfersApiMock.html @@ -1 +1 @@ -transfersApiMock | @coinbase/coinbase-sdk
    transfersApiMock: {
        broadcastTransfer: Mock<any, any, any>;
        createTransfer: Mock<any, any, any>;
        getTransfer: Mock<any, any, any>;
        listTransfers: Mock<any, any, any>;
    } = ...

    Type declaration

    • broadcastTransfer: Mock<any, any, any>
    • createTransfer: Mock<any, any, any>
    • getTransfer: Mock<any, any, any>
    • listTransfers: Mock<any, any, any>
    \ No newline at end of file +transfersApiMock | @coinbase/coinbase-sdk
    transfersApiMock: {
        broadcastTransfer: Mock<any, any, any>;
        createTransfer: Mock<any, any, any>;
        getTransfer: Mock<any, any, any>;
        listTransfers: Mock<any, any, any>;
    } = ...

    Type declaration

    • broadcastTransfer: Mock<any, any, any>
    • createTransfer: Mock<any, any, any>
    • getTransfer: Mock<any, any, any>
    • listTransfers: Mock<any, any, any>
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.usersApiMock.html b/docs/variables/coinbase_tests_utils.usersApiMock.html index 8c310b9e..ef395d96 100644 --- a/docs/variables/coinbase_tests_utils.usersApiMock.html +++ b/docs/variables/coinbase_tests_utils.usersApiMock.html @@ -1 +1 @@ -usersApiMock | @coinbase/coinbase-sdk
    usersApiMock: {
        getCurrentUser: Mock<any, any, any>;
    } = ...

    Type declaration

    • getCurrentUser: Mock<any, any, any>
    \ No newline at end of file +usersApiMock | @coinbase/coinbase-sdk
    usersApiMock: {
        getCurrentUser: Mock<any, any, any>;
    } = ...

    Type declaration

    • getCurrentUser: Mock<any, any, any>
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.walletId.html b/docs/variables/coinbase_tests_utils.walletId.html index 45de1085..2ddb133f 100644 --- a/docs/variables/coinbase_tests_utils.walletId.html +++ b/docs/variables/coinbase_tests_utils.walletId.html @@ -1 +1 @@ -walletId | @coinbase/coinbase-sdk
    walletId: `${string}-${string}-${string}-${string}-${string}` = ...
    \ No newline at end of file +walletId | @coinbase/coinbase-sdk
    walletId: `${string}-${string}-${string}-${string}-${string}` = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.walletsApiMock.html b/docs/variables/coinbase_tests_utils.walletsApiMock.html index 582ce8c4..5499e322 100644 --- a/docs/variables/coinbase_tests_utils.walletsApiMock.html +++ b/docs/variables/coinbase_tests_utils.walletsApiMock.html @@ -1 +1 @@ -walletsApiMock | @coinbase/coinbase-sdk
    walletsApiMock: {
        createWallet: Mock<any, any, any>;
        getWallet: Mock<any, any, any>;
        getWalletBalance: Mock<any, any, any>;
        listWalletBalances: Mock<any, any, any>;
        listWallets: Mock<any, any, any>;
    } = ...

    Type declaration

    • createWallet: Mock<any, any, any>
    • getWallet: Mock<any, any, any>
    • getWalletBalance: Mock<any, any, any>
    • listWalletBalances: Mock<any, any, any>
    • listWallets: Mock<any, any, any>
    \ No newline at end of file +walletsApiMock | @coinbase/coinbase-sdk
    walletsApiMock: {
        createWallet: Mock<any, any, any>;
        getWallet: Mock<any, any, any>;
        getWalletBalance: Mock<any, any, any>;
        listWalletBalances: Mock<any, any, any>;
        listWallets: Mock<any, any, any>;
    } = ...

    Type declaration

    • createWallet: Mock<any, any, any>
    • getWallet: Mock<any, any, any>
    • getWalletBalance: Mock<any, any, any>
    • listWalletBalances: Mock<any, any, any>
    • listWallets: Mock<any, any, any>
    \ No newline at end of file From 4f9f71c0ac1fee7b2e69cdbd4709173a806dfd51 Mon Sep 17 00:00:00 2001 From: John Peterson Date: Mon, 3 Jun 2024 08:38:04 -0700 Subject: [PATCH 9/9] update typedocs --- docs/classes/client_api.AddressesApi.html | 16 ++--- docs/classes/client_api.ServerSignersApi.html | 16 ++--- docs/classes/client_api.TradesApi.html | 12 ++-- docs/classes/client_api.TransfersApi.html | 12 ++-- docs/classes/client_api.UsersApi.html | 6 +- docs/classes/client_api.WalletsApi.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 | 22 +++---- docs/classes/coinbase_api_error.APIError.html | 8 +-- ...coinbase_api_error.AlreadyExistsError.html | 8 +-- ...ase_api_error.FaucetLimitReachedError.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 +-- .../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 | 4 +- ...e_authenticator.CoinbaseAuthenticator.html | 12 ++-- docs/classes/coinbase_balance.Balance.html | 8 +-- .../coinbase_balance_map.BalanceMap.html | 8 +-- docs/classes/coinbase_coinbase.Coinbase.html | 16 ++--- .../coinbase_errors.ArgumentError.html | 4 +- .../coinbase_errors.InternalError.html | 4 +- .../coinbase_errors.InvalidAPIKeyFormat.html | 4 +- .../coinbase_errors.InvalidConfiguration.html | 4 +- ...oinbase_errors.InvalidUnsignedPayload.html | 4 +- ..._faucet_transaction.FaucetTransaction.html | 10 +-- docs/classes/coinbase_transfer.Transfer.html | 38 +++++------ docs/classes/coinbase_user.User.html | 16 ++--- docs/classes/coinbase_wallet.Wallet.html | 66 +++++++++---------- docs/enums/client_api.TransactionType.html | 4 +- .../coinbase_types.ServerSignerStatus.html | 4 +- docs/enums/coinbase_types.TransferStatus.html | 4 +- ...ent_api.AddressesApiAxiosParamCreator.html | 2 +- .../client_api.AddressesApiFactory.html | 12 ++-- docs/functions/client_api.AddressesApiFp.html | 12 ++-- ...api.ServerSignersApiAxiosParamCreator.html | 2 +- .../client_api.ServerSignersApiFactory.html | 12 ++-- .../client_api.ServerSignersApiFp.html | 12 ++-- ...client_api.TradesApiAxiosParamCreator.html | 2 +- .../client_api.TradesApiFactory.html | 8 +-- docs/functions/client_api.TradesApiFp.html | 8 +-- ...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 +- ...lient_api.WalletsApiAxiosParamCreator.html | 2 +- .../client_api.WalletsApiFactory.html | 10 +-- docs/functions/client_api.WalletsApiFp.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 +- .../coinbase_tests_utils.createAxiosMock.html | 2 +- ...inbase_tests_utils.generateRandomHash.html | 2 +- ...se_tests_utils.generateWalletFromSeed.html | 2 +- ...nbase_tests_utils.getAddressFromHDKey.html | 2 +- .../coinbase_tests_utils.mockFn.html | 2 +- ...e_tests_utils.mockReturnRejectedValue.html | 2 +- .../coinbase_tests_utils.mockReturnValue.html | 2 +- .../coinbase_tests_utils.newAddressModel.html | 2 +- .../coinbase_utils.convertStringToHex.html | 2 +- docs/functions/coinbase_utils.delay.html | 2 +- ...e_utils.destinationToAddressHexString.html | 2 +- .../coinbase_utils.logApiResponse.html | 2 +- ...nbase_utils.registerAxiosInterceptors.html | 2 +- docs/interfaces/client_api.Address.html | 10 +-- .../client_api.AddressBalanceList.html | 10 +-- docs/interfaces/client_api.AddressList.html | 10 +-- .../client_api.AddressesApiInterface.html | 14 ++-- docs/interfaces/client_api.Asset.html | 10 +-- docs/interfaces/client_api.Balance.html | 6 +- .../client_api.BroadcastTradeRequest.html | 4 +- .../client_api.BroadcastTransferRequest.html | 4 +- .../client_api.CreateAddressRequest.html | 6 +- .../client_api.CreateServerSignerRequest.html | 6 +- .../client_api.CreateTradeRequest.html | 8 +-- .../client_api.CreateTransferRequest.html | 10 +-- .../client_api.CreateWalletRequest.html | 4 +- .../client_api.CreateWalletRequestWallet.html | 6 +- .../client_api.FaucetTransaction.html | 4 +- docs/interfaces/client_api.ModelError.html | 6 +- .../client_api.SeedCreationEvent.html | 6 +- .../client_api.SeedCreationEventResult.html | 10 +-- docs/interfaces/client_api.ServerSigner.html | 6 +- .../client_api.ServerSignerEvent.html | 6 +- .../client_api.ServerSignerEventList.html | 10 +-- .../client_api.ServerSignersApiInterface.html | 14 ++-- .../client_api.SignatureCreationEvent.html | 18 ++--- ...ient_api.SignatureCreationEventResult.html | 14 ++-- docs/interfaces/client_api.Trade.html | 20 +++--- docs/interfaces/client_api.TradeList.html | 10 +-- .../client_api.TradesApiInterface.html | 10 +-- docs/interfaces/client_api.Transaction.html | 14 ++-- docs/interfaces/client_api.Transfer.html | 24 +++---- docs/interfaces/client_api.TransferList.html | 10 +-- .../client_api.TransfersApiInterface.html | 10 +-- docs/interfaces/client_api.User.html | 6 +- .../client_api.UsersApiInterface.html | 4 +- docs/interfaces/client_api.Wallet.html | 10 +-- docs/interfaces/client_api.WalletList.html | 10 +-- .../client_api.WalletsApiInterface.html | 12 ++-- docs/interfaces/client_base.RequestArgs.html | 4 +- ...configuration.ConfigurationParameters.html | 4 +- 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.html | 2 +- docs/modules/coinbase_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_errors.html | 2 +- docs/modules/coinbase_faucet_transaction.html | 2 +- docs/modules/coinbase_tests_address_test.html | 2 +- .../coinbase_tests_authenticator_test.html | 2 +- .../coinbase_tests_balance_map_test.html | 2 +- docs/modules/coinbase_tests_balance_test.html | 2 +- .../modules/coinbase_tests_coinbase_test.html | 2 +- ...oinbase_tests_faucet_transaction_test.html | 2 +- .../modules/coinbase_tests_transfer_test.html | 2 +- docs/modules/coinbase_tests_user_test.html | 2 +- docs/modules/coinbase_tests_utils.html | 2 +- docs/modules/coinbase_tests_wallet_test.html | 2 +- docs/modules/coinbase_transfer.html | 2 +- docs/modules/coinbase_types.html | 2 +- docs/modules/coinbase_user.html | 2 +- docs/modules/coinbase_utils.html | 2 +- docs/modules/coinbase_wallet.html | 2 +- docs/modules/index.html | 2 +- .../client_api.ServerSignerEventEvent.html | 2 +- .../client_api.TransactionStatusEnum.html | 2 +- docs/types/client_api.TransferStatusEnum.html | 2 +- ...ient_api.WalletServerSignerStatusEnum.html | 2 +- .../coinbase_types.AddressAPIClient.html | 12 ++-- docs/types/coinbase_types.Amount.html | 2 +- docs/types/coinbase_types.ApiClients.html | 2 +- ...ypes.CoinbaseConfigureFromJsonOptions.html | 2 +- .../types/coinbase_types.CoinbaseOptions.html | 2 +- docs/types/coinbase_types.Destination.html | 2 +- docs/types/coinbase_types.SeedData.html | 2 +- .../coinbase_types.TransferAPIClient.html | 8 +-- docs/types/coinbase_types.UserAPIClient.html | 2 +- .../types/coinbase_types.WalletAPIClient.html | 8 +-- docs/types/coinbase_types.WalletData.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 +- ...nbase_constants.ATOMIC_UNITS_PER_USDC.html | 2 +- .../coinbase_constants.GWEI_PER_ETHER.html | 2 +- .../coinbase_constants.WEI_PER_ETHER.html | 2 +- .../coinbase_constants.WEI_PER_GWEI.html | 2 +- ...ests_utils.VALID_ADDRESS_BALANCE_LIST.html | 2 +- ...nbase_tests_utils.VALID_ADDRESS_MODEL.html | 2 +- ...nbase_tests_utils.VALID_BALANCE_MODEL.html | 2 +- ...base_tests_utils.VALID_TRANSFER_MODEL.html | 2 +- ...inbase_tests_utils.VALID_WALLET_MODEL.html | 2 +- ...coinbase_tests_utils.addressesApiMock.html | 2 +- .../coinbase_tests_utils.transferId.html | 2 +- ...coinbase_tests_utils.transfersApiMock.html | 2 +- .../coinbase_tests_utils.usersApiMock.html | 2 +- .../coinbase_tests_utils.walletId.html | 2 +- .../coinbase_tests_utils.walletsApiMock.html | 2 +- src/coinbase/coinbase.ts | 9 +++ 197 files changed, 601 insertions(+), 592 deletions(-) diff --git a/docs/classes/client_api.AddressesApi.html b/docs/classes/client_api.AddressesApi.html index c8a174d8..7e0c6f0f 100644 --- a/docs/classes/client_api.AddressesApi.html +++ b/docs/classes/client_api.AddressesApi.html @@ -1,6 +1,6 @@ AddressesApi | @coinbase/coinbase-sdk

    AddressesApi - object-oriented interface

    Export

    AddressesApi

    -

    Hierarchy (view full)

    Implements

    Constructors

    Hierarchy (view full)

    Implements

    Constructors

    Properties

    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: undefined | Configuration

    Methods

    • Create a new address scoped to the wallet.

      +

    Constructors

    Properties

    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: undefined | Configuration

    Methods

    • 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

      -
    • 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

      -
    • 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

      -
    • 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

      -
    • 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

      -
    • 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 options: RawAxiosRequestConfig

        Override http request option.

      Returns Promise<AxiosResponse<FaucetTransaction, any>>

      Summary

      Request faucet funds for onchain address.

      Throws

      Memberof

      AddressesApi

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

    ServerSignersApi - object-oriented interface

    Export

    ServerSignersApi

    -

    Hierarchy (view full)

    Implements

    Constructors

    Hierarchy (view full)

    Implements

    Constructors

    Properties

    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: undefined | Configuration

    Methods

    • Create a new Server-Signer

      +

    Constructors

    Properties

    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: undefined | Configuration

    Methods

    • 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

      -
    • 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

      Throws

      Memberof

      ServerSignersApi

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

    TradesApi - object-oriented interface

    Export

    TradesApi

    -

    Hierarchy (view full)

    Implements

    Constructors

    Hierarchy (view full)

    Implements

    Constructors

    Properties

    Constructors

    Properties

    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: undefined | Configuration

    Methods

    • Broadcast a trade

      +

    Constructors

    Properties

    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: undefined | Configuration

    Methods

    • 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

      -
    • 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

      -
    • 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

      -
    • 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

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

    TransfersApi - object-oriented interface

    Export

    TransfersApi

    -

    Hierarchy (view full)

    Implements

    Constructors

    Hierarchy (view full)

    Implements

    Constructors

    Properties

    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: undefined | Configuration

    Methods

    • Broadcast a transfer

      +

    Constructors

    Properties

    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: undefined | Configuration

    Methods

    • 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

      -
    • 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

      -
    • 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

      -
    • 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

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

    UsersApi - object-oriented interface

    Export

    UsersApi

    -

    Hierarchy (view full)

    Implements

    Constructors

    Hierarchy (view full)

    Implements

    Constructors

    Properties

    Methods

    Constructors

    Properties

    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: undefined | Configuration

    Methods

    • Get current user

      +

    Constructors

    Properties

    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: undefined | Configuration

    Methods

    • Get current user

      Parameters

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns Promise<AxiosResponse<User, any>>

      Summary

      Get current user

      Throws

      Memberof

      UsersApi

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

    WalletsApi - object-oriented interface

    Export

    WalletsApi

    -

    Hierarchy (view full)

    Implements

    Constructors

    Hierarchy (view full)

    Implements

    Constructors

    Properties

    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: undefined | Configuration

    Methods

    • Create a new wallet scoped to the user.

      +

    Constructors

    Properties

    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: undefined | Configuration

    Methods

    • 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

      -
    • 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

      -
    • 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

      -
    • 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

      -
    • 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

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/classes/client_base.BaseAPI.html b/docs/classes/client_base.BaseAPI.html index 3e393626..259d32ee 100644 --- a/docs/classes/client_base.BaseAPI.html +++ b/docs/classes/client_base.BaseAPI.html @@ -1,6 +1,6 @@ BaseAPI | @coinbase/coinbase-sdk

    Export

    BaseAPI

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

    Constructors

    Properties

    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: undefined | Configuration
    \ No newline at end of file +

    Constructors

    Properties

    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: undefined | Configuration
    \ No newline at end of file diff --git a/docs/classes/client_base.RequiredError.html b/docs/classes/client_base.RequiredError.html index 35e5afb1..1ba869de 100644 --- a/docs/classes/client_base.RequiredError.html +++ b/docs/classes/client_base.RequiredError.html @@ -1,5 +1,5 @@ RequiredError | @coinbase/coinbase-sdk

    Export

    RequiredError

    -

    Hierarchy

    • Error
      • RequiredError

    Constructors

    Hierarchy

    • Error
      • RequiredError

    Constructors

    Properties

    Methods

    Constructors

    Properties

    field: string
    message: string
    name: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Constructors

    Properties

    field: string
    message: string
    name: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

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

    Constructors

    constructor +Configuration | @coinbase/coinbase-sdk

    Constructors

    Properties

    Methods

    Constructors

    Properties

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

    parameter for oauth2 security

    +

    Constructors

    Properties

    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

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

    parameter for apiKey security

    +
    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

    -
    baseOptions?: any

    base options for axios calls

    +
    baseOptions?: any

    base options for axios calls

    Memberof

    Configuration

    -
    basePath?: string

    override base path

    +
    basePath?: string

    override base path

    Memberof

    Configuration

    -
    formDataCtor?: (new () => any)

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

    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

    password?: string

    parameter for basic security

    +

    Type declaration

      • new (): any
      • Returns any

    password?: string

    parameter for basic security

    Memberof

    Configuration

    -
    serverIndex?: number

    override server index

    +
    serverIndex?: number

    override server index

    Memberof

    Configuration

    -
    username?: string

    parameter for basic security

    +
    username?: string

    parameter for basic security

    Memberof

    Configuration

    -

    Methods

    Methods

    • 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.

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

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

    -

    Constructors

    Constructors

    Properties

    Methods

    createTransfer @@ -15,7 +15,7 @@

    Parameters

    • model: Address

      The address model data.

    • Optional key: Wallet

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

    Returns Address

    Throws

    If the model or key is empty.

    -

    Properties

    key?: Wallet
    model: Address

    Methods

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

      +

    Properties

    key?: Wallet
    model: Address

    Methods

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

      Parameters

      • amount: Amount

        The amount of the Asset to send.

      • assetId: string

        The ID of the Asset to send. For Ether, Coinbase.assets.Eth, Coinbase.assets.Gwei, and Coinbase.assets.Wei supported.

      • destination: Destination

        The destination of the transfer. If a Wallet, sends to the Wallet's default address. If a String, interprets it as the address ID.

        @@ -25,26 +25,26 @@

        Throws

        if the API request to create a Transfer fails.

        Throws

        if the API request to broadcast a Transfer fails.

        Throws

        if the Transfer times out.

        -
    • Returns the balance of the provided asset.

      Parameters

      • assetId: string

        The asset ID.

      Returns Promise<Decimal>

      The balance of the asset.

      -
    • Returns a string representation of the address.

      Returns string

      A string representing the address.

      -
    \ No newline at end of file +
    \ 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 091811e5..4407297b 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns APIError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Returns a String representation of the APIError.

      Returns string

      a String representation of the APIError

      -
    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 058e1dc9..f71f43b5 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns AlreadyExistsError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 403dc19d..110feebd 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns FaucetLimitReachedError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 ec372592..655c3122 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidAddressError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 04407eba..c7ffc02d 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidAddressIDError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 5b6345c0..f04aa52c 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidAmountError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 387b4c5c..1dc56419 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidAssetIDError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 0e93d4c4..73666fb3 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidDestinationError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 b7792710..c4be0782 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidLimitError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 ad491db5..84452d91 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidNetworkIDError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 7f496d5f..c7908340 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidPageError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 9ad69f77..254a2731 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidSignedPayloadError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 3d230208..778d94df 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidTransferIDError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 fc229ae7..9d9fbfe1 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidTransferStatusError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 47814412..67c6ffaa 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidWalletError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 fbbdaba7..0e78a878 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidWalletIDError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 7c6e130d..abf66abd 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns MalformedRequestError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 902d001a..c9ffea84 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns NotFoundError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 e9dbb5a1..91a6f8f9 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns ResourceExhaustedError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 59d96834..b25fbf57 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns UnauthorizedError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 85506367..6c4022c7 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns UnimplementedError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ 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 7d962d33..e23787c8 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

    A wrapper for API errors to provide more context.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

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

    Constructors

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns UnsupportedAssetError

    Properties

    apiCode: null | string
    apiMessage: null | string
    cause?: Error
    code?: string
    config?: InternalAxiosRequestConfig<any>
    httpCode: null | number
    isAxiosError: boolean
    message: string
    name: string
    request?: any
    response?: AxiosResponse<unknown, any>
    stack?: string
    status?: number
    toJSON: (() => object)

    Type declaration

      • (): object
      • Returns object

    ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
    ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
    ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
    ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
    ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
    ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
    ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
    ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
    ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
    ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
    ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
    ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • 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>

    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/classes/coinbase_asset.Asset.html b/docs/classes/coinbase_asset.Asset.html index db7bd765..7f4fc320 100644 --- a/docs/classes/coinbase_asset.Asset.html +++ b/docs/classes/coinbase_asset.Asset.html @@ -1,9 +1,9 @@ Asset | @coinbase/coinbase-sdk

    A representation of an Asset.

    -

    Constructors

    Constructors

    Methods

    Constructors

    Methods

    • Converts an amount from the atomic value of the primary denomination of the provided Asset ID to whole units of the specified asset ID.

      Parameters

      • atomicAmount: Decimal

        The amount in atomic units.

      • assetId: string

        The assset ID.

      Returns Decimal

      The amount in whole units of the asset with the specified ID.

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

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

    -

    Constructors

    Constructors

    Properties

    Methods

    authenticateRequest @@ -9,20 +9,20 @@

    Constructors

    Properties

    apiKey: string
    privateKey: string

    Methods

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

      +

    Returns CoinbaseAuthenticator

    Properties

    apiKey: string
    privateKey: string

    Methods

    • 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.

      -
    • 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.

      -
    • 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.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/classes/coinbase_balance.Balance.html b/docs/classes/coinbase_balance.Balance.html index 6b5f6bfa..59e1316a 100644 --- a/docs/classes/coinbase_balance.Balance.html +++ b/docs/classes/coinbase_balance.Balance.html @@ -1,13 +1,13 @@ Balance | @coinbase/coinbase-sdk

    A representation of a balance.

    -

    Properties

    Properties

    amount: Decimal
    assetId: string

    Methods

    • Converts a BalanceModel into a Balance object.

      +

    Properties

    amount: Decimal
    assetId: string

    Methods

    • 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.

      -
    \ No newline at end of file +
    \ 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 bcac41de..1edc7a67 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

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

    -

    Hierarchy

    • Map<string, Decimal>
      • BalanceMap

    Constructors

    Hierarchy

    • Map<string, Decimal>
      • BalanceMap

    Constructors

    Properties

    [toStringTag] size [species] @@ -20,7 +20,7 @@
    [species]: MapConstructor

    Methods

    • Returns an iterable of entries in the map.

      Returns IterableIterator<[string, Decimal]>

    • Returns void

    • 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

    • Returns void

    • 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 an iterable of key, value pairs for every entry in the map.

      Returns IterableIterator<[string, Decimal]>

    • 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

    • 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.

      @@ -30,8 +30,8 @@

      Returns IterableIterator<string>

    • 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

    • Returns a string representation of the balance map.

      Returns string

      The string representation of the balance map.

      -
    • Returns an iterable of values in the map

      Returns IterableIterator<Decimal>

    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/classes/coinbase_coinbase.Coinbase.html b/docs/classes/coinbase_coinbase.Coinbase.html index 99fd607f..a214d4de 100644 --- a/docs/classes/coinbase_coinbase.Coinbase.html +++ b/docs/classes/coinbase_coinbase.Coinbase.html @@ -1,5 +1,5 @@ Coinbase | @coinbase/coinbase-sdk

    The Coinbase SDK.

    -

    Constructors

    Constructors

    Properties

    apiClients apiKeyPrivateKey assets @@ -11,17 +11,17 @@

    Parameters

    Returns Coinbase

    Throws

    If the configuration is invalid.

    Throws

    If not able to create JWT token.

    -

    Properties

    apiClients: ApiClients = {}
    apiKeyPrivateKey: string

    The CDP API key Private Key.

    -

    Constant

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

    The list of supported assets.

    -

    Type declaration

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

    Constant

    networkList: {
        BaseSepolia: string;
    } = ...

    The list of supported networks.

    -

    Type declaration

    • BaseSepolia: string

    Constant

    useServerSigner: boolean

    Whether to use a server signer or not.

    -

    Constant

    Methods

    Properties

    apiClients: ApiClients = {}
    apiKeyPrivateKey: string

    The CDP API key Private Key.

    +

    Constant

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

    The list of supported assets.

    +

    Type declaration

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

    Constant

    networkList: {
        BaseSepolia: string;
    } = ...

    The list of supported networks.

    +

    Type declaration

    • BaseSepolia: string

    Constant

    useServerSigner: boolean

    Whether to use a server signer or not.

    +

    Constant

    Methods

    • Returns User object for the default user.

      Returns Promise<User>

      The default user.

      Throws

      If the request fails.

      -
    • 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.

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

    ArgumentError is thrown when an argument is invalid.

    -

    Hierarchy

    • Error
      • ArgumentError

    Constructors

    Hierarchy

    • Error
      • ArgumentError

    Constructors

    Properties

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

    Methods

    Constructors

    Properties

    message: string
    name: string
    stack?: string
    DEFAULT_MESSAGE: string = "Argument Error"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns ArgumentError

    Properties

    message: string
    name: string
    stack?: string
    DEFAULT_MESSAGE: string = "Argument Error"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    \ No newline at end of file diff --git a/docs/classes/coinbase_errors.InternalError.html b/docs/classes/coinbase_errors.InternalError.html index 2cf3150d..613e0c40 100644 --- a/docs/classes/coinbase_errors.InternalError.html +++ b/docs/classes/coinbase_errors.InternalError.html @@ -1,5 +1,5 @@ InternalError | @coinbase/coinbase-sdk

    InternalError is thrown when there is an internal error in the SDK.

    -

    Hierarchy

    • Error
      • InternalError

    Constructors

    Hierarchy

    • Error
      • InternalError

    Constructors

    Properties

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

    Methods

    Constructors

    Properties

    message: string
    name: string
    stack?: string
    DEFAULT_MESSAGE: string = "Internal Error"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InternalError

    Properties

    message: string
    name: string
    stack?: string
    DEFAULT_MESSAGE: string = "Internal Error"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    \ No newline at end of file diff --git a/docs/classes/coinbase_errors.InvalidAPIKeyFormat.html b/docs/classes/coinbase_errors.InvalidAPIKeyFormat.html index 619f4a5d..b47d04d4 100644 --- a/docs/classes/coinbase_errors.InvalidAPIKeyFormat.html +++ b/docs/classes/coinbase_errors.InvalidAPIKeyFormat.html @@ -1,5 +1,5 @@ InvalidAPIKeyFormat | @coinbase/coinbase-sdk

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

    -

    Hierarchy

    • Error
      • InvalidAPIKeyFormat

    Constructors

    Hierarchy

    • Error
      • InvalidAPIKeyFormat

    Constructors

    Properties

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

    Methods

    Constructors

    Properties

    message: string
    name: string
    stack?: string
    DEFAULT_MESSAGE: string = "Invalid API key format"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidAPIKeyFormat

    Properties

    message: string
    name: string
    stack?: string
    DEFAULT_MESSAGE: string = "Invalid API key format"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    \ No newline at end of file diff --git a/docs/classes/coinbase_errors.InvalidConfiguration.html b/docs/classes/coinbase_errors.InvalidConfiguration.html index aaf7a03e..870df4ec 100644 --- a/docs/classes/coinbase_errors.InvalidConfiguration.html +++ b/docs/classes/coinbase_errors.InvalidConfiguration.html @@ -1,5 +1,5 @@ InvalidConfiguration | @coinbase/coinbase-sdk

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

    -

    Hierarchy

    • Error
      • InvalidConfiguration

    Constructors

    Hierarchy

    • Error
      • InvalidConfiguration

    Constructors

    Properties

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

    Methods

    Constructors

    Properties

    message: string
    name: string
    stack?: string
    DEFAULT_MESSAGE: string = "Invalid configuration"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidConfiguration

    Properties

    message: string
    name: string
    stack?: string
    DEFAULT_MESSAGE: string = "Invalid configuration"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    \ No newline at end of file diff --git a/docs/classes/coinbase_errors.InvalidUnsignedPayload.html b/docs/classes/coinbase_errors.InvalidUnsignedPayload.html index de9a5f37..826973c0 100644 --- a/docs/classes/coinbase_errors.InvalidUnsignedPayload.html +++ b/docs/classes/coinbase_errors.InvalidUnsignedPayload.html @@ -1,5 +1,5 @@ InvalidUnsignedPayload | @coinbase/coinbase-sdk

    InvalidUnsignedPayload error is thrown when the unsigned payload is invalid.

    -

    Hierarchy

    • Error
      • InvalidUnsignedPayload

    Constructors

    Hierarchy

    • Error
      • InvalidUnsignedPayload

    Constructors

    Properties

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

    Methods

    Constructors

    Properties

    message: string
    name: string
    stack?: string
    DEFAULT_MESSAGE: string = "Invalid unsigned payload"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns InvalidUnsignedPayload

    Properties

    message: string
    name: string
    stack?: string
    DEFAULT_MESSAGE: string = "Invalid unsigned payload"
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    \ 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 813f17ad..5d20c572 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

    Represents a transaction from a faucet.

    -

    Constructors

    Constructors

    Properties

    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

    Methods

    Properties

    Methods

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

      Returns string

      The link to the transaction on the blockchain explorer

      -
    • Returns a string representation of the FaucetTransaction.

      Returns string

      A string representation of the FaucetTransaction.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/classes/coinbase_transfer.Transfer.html b/docs/classes/coinbase_transfer.Transfer.html index 4ea8644e..5f567fbe 100644 --- a/docs/classes/coinbase_transfer.Transfer.html +++ b/docs/classes/coinbase_transfer.Transfer.html @@ -1,7 +1,7 @@ Transfer | @coinbase/coinbase-sdk

    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

    Properties

    model: Transfer
    transaction?: Transaction

    Methods

    • Returns the Amount of the Transfer.

      +

    Properties

    model: Transfer
    transaction?: Transaction

    Methods

    • Returns the Destination Address ID of the Transfer.

      Returns string

      The Destination Address ID.

      -
    • Returns the From Address ID of the Transfer.

      Returns string

      The From Address ID.

      -
    • Returns the Signed Payload of the Transfer.

      Returns undefined | string

      The Signed Payload as a Hex string, or undefined if not yet available.

      -
    • Returns the Transaction of the Transfer.

      Returns Transaction

      The ethers.js Transaction object.

      Throws

      (InvalidUnsignedPayload) If the Unsigned Payload is invalid.

      -
    • Returns the Transaction Hash of the Transfer.

      Returns undefined | string

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

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

      Returns string

      The link to the Transaction on the blockchain explorer.

      -
    • Returns the Unsigned Payload of the Transfer.

      Returns string

      The Unsigned Payload as a Hex string.

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

      Returns Promise<void>

      Throws

      if the API request to get a Transfer fails.

      -
    • Sets the Signed Transaction of the Transfer.

      Parameters

      • transaction: Transaction

        The Signed Transaction.

        -

      Returns void

    • Returns a string representation of the Transfer.

      +

    Returns void

    • Returns a string representation of the Transfer.

      Returns Promise<string>

      The string representation of the Transfer.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/classes/coinbase_user.User.html b/docs/classes/coinbase_user.User.html index 04f6426e..3ee66b51 100644 --- a/docs/classes/coinbase_user.User.html +++ b/docs/classes/coinbase_user.User.html @@ -1,7 +1,7 @@ User | @coinbase/coinbase-sdk

    A representation of a User. Users have Wallets, which can hold balances of Assets. Access the default User through Coinbase.defaultUser().

    -

    Constructors

    Constructors

    Properties

    Methods

    createWallet getId @@ -11,7 +11,7 @@ toString

    Constructors

    Properties

    model: User

    Methods

    • Creates a new Wallet belonging to the User.

      +

    Returns User

    Properties

    model: User

    Methods

    • Creates a new Wallet belonging to the User.

      Returns Promise<Wallet>

      the new Wallet

      Throws

      • If the request fails.
      • @@ -22,18 +22,18 @@

        Throws

          Throws

          • If address derivation or caching fails.
          -
    • Returns the Wallet with the given ID.

      Parameters

      • wallet_id: string

        the ID of the Wallet

      Returns Promise<Wallet>

      the Wallet with the given ID

      -
    • Lists the Wallets belonging to the User.

      +
    • Lists the Wallets belonging to the User.

      Parameters

      • pageSize: number = 10

        The number of Wallets to return per page. Defaults to 10

      • Optional nextPageToken: string

        The token for the next page of Wallets

      Returns Promise<{
          nextPageToken: string;
          wallets: Wallet[];
      }>

      An object containing the Wallets and the token for the next page

      -
    • Returns a string representation of the User.

      Returns string

      The string representation of the User.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/classes/coinbase_wallet.Wallet.html b/docs/classes/coinbase_wallet.Wallet.html index 7e40913b..2166ca5d 100644 --- a/docs/classes/coinbase_wallet.Wallet.html +++ b/docs/classes/coinbase_wallet.Wallet.html @@ -1,7 +1,7 @@ Wallet | @coinbase/coinbase-sdk

    A representation of a Wallet. Wallets come with a single default Address, but can expand to have a set of Addresses, each of which can hold a balance of one or more Assets. Wallets can create new Addresses, list their addresses, list their balances, and transfer Assets to other Addresses. Wallets should be created through User.createWallet or User.importWallet.

    -

    Properties

    Properties

    addressIndex: number = 0
    addressModels: Address[] = []
    addressPathPrefix: "m/44'/60'/0'/0" = "m/44'/60'/0'/0"
    addresses: Address[] = []
    master?: HDKey
    model: Wallet
    seed?: string
    MAX_ADDRESSES: number = 20

    Methods

    • Builds a Hash of the registered Addresses.

      +

    Properties

    addressIndex: number = 0
    addressModels: Address[] = []
    addressPathPrefix: "m/44'/60'/0'/0" = "m/44'/60'/0'/0"
    addresses: Address[] = []
    master?: HDKey
    model: Wallet
    seed?: string
    MAX_ADDRESSES: number = 20

    Methods

    • Builds a Hash of the registered Addresses.

      Parameters

      • addressModels: Address[]

        The models of the addresses already registered with the Wallet.

      Returns {
          [key: string]: boolean;
      }

      The Hash of registered Addresses

      -
      • [key: string]: boolean
    • Caches an Address on the client-side and increments the address index.

      +
      • [key: string]: boolean
    • Caches an Address on the client-side and increments the address index.

      Parameters

      • address: Address

        The AddressModel to cache.

      • Optional key: Wallet

        The ethers.js Wallet object the address uses for signing data.

      Returns void

      Throws

      If the address is not provided.

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

      +
    • 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.

      -
    • Creates an attestation for the Address currently being created.

      +
    • Creates an attestation for the Address currently being created.

      Parameters

      • key: HDKey

        The key of the Wallet.

      Returns string

      The attestation.

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

    • 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

      • amount: Amount

        The amount of the Asset to send.

      • assetId: string

        The ID of the Asset to send.

        @@ -68,7 +68,7 @@

        Throws

        if the API request to create a Transfer fails.

        Throws

        if the API request to broadcast a Transfer fails.

        Throws

        if the Transfer times out.

        -
    • Derives an already registered Address in the Wallet.

      +
    • Derives an already registered Address in the Wallet.

      Parameters

      • addressMap: {
            [key: string]: boolean;
        }

        The map of registered Address IDs

        • [key: string]: boolean
      • addressModel: Address

        The Address model

      Returns void

      Throws

        @@ -77,52 +77,52 @@

        Throws

        if the Transfer times out.

        Throws

        • If the request fails.
        -
    • Derives the registered Addresses in the Wallet.

      Parameters

      • addresses: Address[]

        The models of the addresses already registered with the

        -

      Returns void

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

      +

    Returns void

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

      Returns HDKey

      The derived key.

      Throws

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

      Returns Promise<FaucetTransaction>

      The successful faucet transaction

      Throws

      If the default address is not found.

      Throws

      If the request fails.

      -
    • Returns the Address with the given ID.

      Parameters

      • addressId: string

        The ID of the Address to retrieve.

      Returns undefined | Address

      The Address.

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

      +
    • 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.

      -
    • Gets the key for encrypting seed data.

      Returns Buffer

      The encryption key.

      -
    • 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

      -
    • 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.

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

      Parameters

      • filePath: string

        The path of the file to load the seed from

      Returns string

      A string indicating the success of the operation

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

      Returns Promise<void>

      Throws

      if the API request to get a Wallet fails.

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

    • 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

        @@ -130,17 +130,17 @@

        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

      -
    • Returns the Wallet model.

      Parameters

      • seed: string

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

        -

      Returns void

    • Returns a String representation of the Wallet.

      +

    Returns void

    • Returns a String representation of the Wallet.

      Returns string

      a String representation of the Wallet

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

      +
    • 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.

      -
    • Returns a newly created Wallet object. Do not use this method directly. +

    • Returns a newly created Wallet object. Do not use this method directly. Instead, use User.createWallet.

      Parameters

      • 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.

        @@ -153,10 +153,10 @@

        Throws

          Throws

          • If the request fails.
          -
    • Returns the seed and master key.

      +
    • Returns the seed and master key.

      Parameters

      • seed: undefined | string

        The seed to use for the Wallet. The function will generate one if it is not provided.

      Returns {
          master: undefined | HDKey;
          seed: undefined | string;
      }

      The master key

      -
      • master: undefined | HDKey
      • seed: undefined | string
    • Returns a new Wallet object. Do not use this method directly. Instead, use User.createWallet or User.importWallet.

      +
      • master: undefined | HDKey
      • seed: undefined | string
    • Returns a new Wallet object. Do not use this method directly. Instead, use User.createWallet or User.importWallet.

      Parameters

      • model: Wallet

        The underlying Wallet model object

      • Optional seed: string

        The seed to use for the Wallet. Expects a 32-byte hexadecimal with no 0x prefix. If null or undefined, a new seed will be generated. If the empty string, no seed is generated, and the Wallet will be instantiated without a seed and its corresponding private keys.

        @@ -170,7 +170,7 @@

        Throws

          Throws

          • If the request fails.
          -
    • Validates the seed and address models passed to the constructor.

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

      Parameters

      • seed: undefined | string

        The seed to use for the Wallet

      • addressModels: Address[]

        The models of the addresses already registered with the Wallet

        -

      Returns void

    \ No newline at end of file +

    Returns void

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

    Export

    Enumeration Members

    Enumeration Members

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

    Export

    Enumeration Members

    Enumeration Members

    Transfer: "transfer"
    \ No newline at end of file diff --git a/docs/enums/coinbase_types.ServerSignerStatus.html b/docs/enums/coinbase_types.ServerSignerStatus.html index a3dec56c..6ec9fbbf 100644 --- a/docs/enums/coinbase_types.ServerSignerStatus.html +++ b/docs/enums/coinbase_types.ServerSignerStatus.html @@ -1,4 +1,4 @@ ServerSignerStatus | @coinbase/coinbase-sdk

    ServerSigner status type definition.

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    ACTIVE: "active_seed"
    PENDING: "pending_seed_creation"
    \ No newline at end of file +

    Enumeration Members

    ACTIVE: "active_seed"
    PENDING: "pending_seed_creation"
    \ No newline at end of file diff --git a/docs/enums/coinbase_types.TransferStatus.html b/docs/enums/coinbase_types.TransferStatus.html index dc29f625..b0c1c819 100644 --- a/docs/enums/coinbase_types.TransferStatus.html +++ b/docs/enums/coinbase_types.TransferStatus.html @@ -1,6 +1,6 @@ TransferStatus | @coinbase/coinbase-sdk

    Transfer status type definition.

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    BROADCAST: "broadcast"
    COMPLETE: "complete"
    FAILED: "failed"
    PENDING: "pending"
    \ No newline at end of file +

    Enumeration Members

    BROADCAST: "broadcast"
    COMPLETE: "complete"
    FAILED: "failed"
    PENDING: "pending"
    \ No newline at end of file diff --git a/docs/functions/client_api.AddressesApiAxiosParamCreator.html b/docs/functions/client_api.AddressesApiAxiosParamCreator.html index 9cb3798d..870d11ee 100644 --- a/docs/functions/client_api.AddressesApiAxiosParamCreator.html +++ b/docs/functions/client_api.AddressesApiAxiosParamCreator.html @@ -31,4 +31,4 @@

    Throws

      • (walletId, addressId, options?): Promise<RequestArgs>
      • 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<RequestArgs>

    Export

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.AddressesApiFactory.html b/docs/functions/client_api.AddressesApiFactory.html index b29a7928..e14482e4 100644 --- a/docs/functions/client_api.AddressesApiFactory.html +++ b/docs/functions/client_api.AddressesApiFactory.html @@ -3,32 +3,32 @@

    Parameters

    • walletId: string

      The ID of the wallet to create the address in.

    • Optional createAddressRequest: CreateAddressRequest
    • Optional options: any

      Override http request option.

    Returns AxiosPromise<Address>

    Summary

    Create a new address

    -

    Throws

  • getAddress:function
  • getAddress:function
    • 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: any

        Override http request option.

      Returns AxiosPromise<Address>

      Summary

      Get address by onchain address

      -

      Throws

  • getAddressBalance:function
  • getAddressBalance:function
    • 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: any

        Override http request option.

      Returns AxiosPromise<Balance>

      Summary

      Get address balance for asset

      -

      Throws

  • listAddressBalances:function
  • listAddressBalances:function
    • 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: any

        Override http request option.

      Returns AxiosPromise<AddressBalanceList>

      Summary

      Get all balances for address

      -

      Throws

  • listAddresses:function
  • listAddresses:function
    • 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: any

        Override http request option.

      Returns AxiosPromise<AddressList>

      Summary

      List addresses in a wallet.

      -

      Throws

  • requestFaucetFunds:function
  • requestFaucetFunds:function
    • 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 options: any

        Override http request option.

      Returns AxiosPromise<FaucetTransaction>

      Summary

      Request faucet funds for onchain address.

      -

      Throws

  • Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.AddressesApiFp.html b/docs/functions/client_api.AddressesApiFp.html index 5ab07ccb..8c6525cc 100644 --- a/docs/functions/client_api.AddressesApiFp.html +++ b/docs/functions/client_api.AddressesApiFp.html @@ -3,32 +3,32 @@

    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<((axios?, basePath?) => AxiosPromise<Address>)>

    Summary

    Create a new address

    -

    Throws

  • getAddress:function
    • Get address

      +

      Throws

  • getAddress:function
    • 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<((axios?, basePath?) => AxiosPromise<Address>)>

      Summary

      Get address by onchain address

      -

      Throws

  • getAddressBalance:function
    • Get address balance

      +

      Throws

  • getAddressBalance:function
    • 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<((axios?, basePath?) => AxiosPromise<Balance>)>

      Summary

      Get address balance for asset

      -

      Throws

  • listAddressBalances:function
  • listAddressBalances:function
    • 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<((axios?, basePath?) => AxiosPromise<AddressBalanceList>)>

      Summary

      Get all balances for address

      -

      Throws

  • listAddresses:function
    • List addresses in the wallet.

      +

      Throws

  • listAddresses:function
    • 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<((axios?, basePath?) => AxiosPromise<AddressList>)>

      Summary

      List addresses in a wallet.

      -

      Throws

  • requestFaucetFunds:function
    • Request faucet funds to be sent to onchain address.

      +

      Throws

  • requestFaucetFunds:function
    • 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 options: RawAxiosRequestConfig

        Override http request option.

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

      Summary

      Request faucet funds for onchain address.

      -

      Throws

  • Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.ServerSignersApiAxiosParamCreator.html b/docs/functions/client_api.ServerSignersApiAxiosParamCreator.html index 273da577..100a6ed6 100644 --- a/docs/functions/client_api.ServerSignersApiAxiosParamCreator.html +++ b/docs/functions/client_api.ServerSignersApiAxiosParamCreator.html @@ -23,4 +23,4 @@

    Throws

    • Summary

      Submit the result of a server signer event

      Throws

        • (serverSignerId, signatureCreationEventResult?, options?): Promise<RequestArgs>
        • 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 Promise<RequestArgs>

    Export

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.ServerSignersApiFactory.html b/docs/functions/client_api.ServerSignersApiFactory.html index 1d5b96e7..811d219d 100644 --- a/docs/functions/client_api.ServerSignersApiFactory.html +++ b/docs/functions/client_api.ServerSignersApiFactory.html @@ -2,25 +2,25 @@

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns {
        createServerSigner(createServerSignerRequest?, options?): AxiosPromise<ServerSigner>;
        getServerSigner(serverSignerId, options?): AxiosPromise<ServerSigner>;
        listServerSignerEvents(serverSignerId, limit?, page?, options?): AxiosPromise<ServerSignerEventList>;
        listServerSigners(options?): AxiosPromise<ServerSigner>;
        submitServerSignerSeedEventResult(serverSignerId, seedCreationEventResult?, options?): AxiosPromise<SeedCreationEventResult>;
        submitServerSignerSignatureEventResult(serverSignerId, signatureCreationEventResult?, options?): AxiosPromise<SignatureCreationEventResult>;
    }

    • createServerSigner:function
    • getServerSigner:function
    • getServerSigner:function
      • Get a server signer by ID

        Parameters

        • serverSignerId: string

          The ID of the server signer to fetch

        • Optional options: any

          Override http request option.

        Returns AxiosPromise<ServerSigner>

        Summary

        Get a server signer by ID

        -

        Throws

    • listServerSignerEvents:function
    • listServerSignerEvents:function
      • 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: any

          Override http request option.

        Returns AxiosPromise<ServerSignerEventList>

        Summary

        List events for a server signer

        -

        Throws

    • listServerSigners:function
    • listServerSigners:function
      • List server signers for the current project

        Parameters

        • Optional options: any

          Override http request option.

        Returns AxiosPromise<ServerSigner>

        Summary

        List server signers for the current project

        -

        Throws

    • submitServerSignerSeedEventResult:function
    • submitServerSignerSeedEventResult:function
      • 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: any

          Override http request option.

        Returns AxiosPromise<SeedCreationEventResult>

        Summary

        Submit the result of a server signer event

        -

        Throws

    • submitServerSignerSignatureEventResult:function
    • submitServerSignerSignatureEventResult:function
      • 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: any

          Override http request option.

        Returns AxiosPromise<SignatureCreationEventResult>

        Summary

        Submit the result of a server signer event

        -

        Throws

    Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.ServerSignersApiFp.html b/docs/functions/client_api.ServerSignersApiFp.html index 74675f3d..32c5fd22 100644 --- a/docs/functions/client_api.ServerSignersApiFp.html +++ b/docs/functions/client_api.ServerSignersApiFp.html @@ -2,25 +2,25 @@

    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(options?): Promise<((axios?, basePath?) => AxiosPromise<ServerSigner>)>;
        submitServerSignerSeedEventResult(serverSignerId, seedCreationEventResult?, options?): Promise<((axios?, basePath?) => AxiosPromise<SeedCreationEventResult>)>;
        submitServerSignerSignatureEventResult(serverSignerId, signatureCreationEventResult?, options?): Promise<((axios?, basePath?) => AxiosPromise<SignatureCreationEventResult>)>;
    }

    • createServerSigner:function
      • Create a new Server-Signer

        Parameters

        • Optional createServerSignerRequest: CreateServerSignerRequest
        • Optional options: RawAxiosRequestConfig

          Override http request option.

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

        Summary

        Create a new Server-Signer

        -

        Throws

    • getServerSigner:function
    • getServerSigner:function
      • 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<((axios?, basePath?) => AxiosPromise<ServerSigner>)>

        Summary

        Get a server signer by ID

        -

        Throws

    • listServerSignerEvents:function
    • listServerSignerEvents:function
      • 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<((axios?, basePath?) => AxiosPromise<ServerSignerEventList>)>

        Summary

        List events for a server signer

        -

        Throws

    • listServerSigners:function
      • List server signers for the current project

        +

        Throws

    • listServerSigners:function
      • List server signers for the current project

        Parameters

        • Optional options: RawAxiosRequestConfig

          Override http request option.

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

        Summary

        List server signers for the current project

        -

        Throws

    • submitServerSignerSeedEventResult:function
      • Submit the result of a server signer event

        +

        Throws

    • submitServerSignerSeedEventResult:function
      • 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 Promise<((axios?, basePath?) => AxiosPromise<SeedCreationEventResult>)>

        Summary

        Submit the result of a server signer event

        -

        Throws

    • submitServerSignerSignatureEventResult:function
      • Submit the result of a server signer event

        +

        Throws

    • submitServerSignerSignatureEventResult:function
      • 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 Promise<((axios?, basePath?) => AxiosPromise<SignatureCreationEventResult>)>

        Summary

        Submit the result of a server signer event

        -

        Throws

    Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.TradesApiAxiosParamCreator.html b/docs/functions/client_api.TradesApiAxiosParamCreator.html index a24f292f..1771e5b7 100644 --- a/docs/functions/client_api.TradesApiAxiosParamCreator.html +++ b/docs/functions/client_api.TradesApiAxiosParamCreator.html @@ -23,4 +23,4 @@

    Throws

    • 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<RequestArgs>

    Export

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.TradesApiFactory.html b/docs/functions/client_api.TradesApiFactory.html index 127d60c4..182e25fd 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: any

    Override http request option.

  • Returns AxiosPromise<Trade>

    Summary

    Broadcast a trade

    -

    Throws

  • createTrade:function
    • Create a new trade

      +

      Throws

  • createTrade:function
    • 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: any

        Override http request option.

      Returns AxiosPromise<Trade>

      Summary

      Create a new trade for an address

      -

      Throws

  • getTrade:function
  • getTrade:function
    • 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: any

        Override http request option.

      Returns AxiosPromise<Trade>

      Summary

      Get a trade by ID

      -

      Throws

  • listTrades:function
  • listTrades:function
    • 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&#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: any

        Override http request option.

      Returns AxiosPromise<TradeList>

      Summary

      List trades for an address.

      -

      Throws

  • Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.TradesApiFp.html b/docs/functions/client_api.TradesApiFp.html index a952d152..5f4fa7fa 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
    • Create a new trade

      +

      Throws

  • createTrade:function
    • 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<((axios?, basePath?) => AxiosPromise<Trade>)>

      Summary

      Create a new trade for an address

      -

      Throws

  • getTrade:function
    • Get a trade by ID

      +

      Throws

  • getTrade:function
    • 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<((axios?, basePath?) => AxiosPromise<Trade>)>

      Summary

      Get a trade by ID

      -

      Throws

  • listTrades:function
    • List trades for an address.

      +

      Throws

  • listTrades:function
    • 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&#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<TradeList>)>

      Summary

      List trades for an address.

      -

      Throws

  • Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.TransfersApiAxiosParamCreator.html b/docs/functions/client_api.TransfersApiAxiosParamCreator.html index 70974519..d206305f 100644 --- a/docs/functions/client_api.TransfersApiAxiosParamCreator.html +++ b/docs/functions/client_api.TransfersApiAxiosParamCreator.html @@ -23,4 +23,4 @@

    Throws

    • 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<RequestArgs>

    Export

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.TransfersApiFactory.html b/docs/functions/client_api.TransfersApiFactory.html index c646ff2a..76e1eed3 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: any

    Override http request option.

  • Returns AxiosPromise<Transfer>

    Summary

    Broadcast a transfer

    -

    Throws

  • createTransfer:function
    • Create a new transfer

      +

      Throws

  • createTransfer:function
    • 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: any

        Override http request option.

      Returns AxiosPromise<Transfer>

      Summary

      Create a new transfer for an address

      -

      Throws

  • getTransfer:function
  • getTransfer:function
    • 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: any

        Override http request option.

      Returns AxiosPromise<Transfer>

      Summary

      Get a transfer by ID

      -

      Throws

  • listTransfers:function
  • listTransfers:function
    • 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.

      • 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: any

        Override http request option.

      Returns AxiosPromise<TransferList>

      Summary

      List transfers for an address.

      -

      Throws

  • Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.TransfersApiFp.html b/docs/functions/client_api.TransfersApiFp.html index a2fc76a0..225f018b 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
    • Create a new transfer

      +

      Throws

  • createTransfer:function
    • 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<((axios?, basePath?) => AxiosPromise<Transfer>)>

      Summary

      Create a new transfer for an address

      -

      Throws

  • getTransfer:function
    • Get a transfer by ID

      +

      Throws

  • getTransfer:function
    • 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<((axios?, basePath?) => AxiosPromise<Transfer>)>

      Summary

      Get a transfer by ID

      -

      Throws

  • listTransfers:function
    • List transfers for an address.

      +

      Throws

  • listTransfers:function
    • 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.

      • 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<TransferList>)>

      Summary

      List transfers for an address.

      -

      Throws

  • Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.UsersApiAxiosParamCreator.html b/docs/functions/client_api.UsersApiAxiosParamCreator.html index 0539cac5..9cca0020 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>);
    }

    • getCurrentUser: ((options?) => Promise<RequestArgs>)

      Get current user

      Summary

      Get current user

      Throws

        • (options?): Promise<RequestArgs>
        • Parameters

          • Optional options: RawAxiosRequestConfig = {}

            Override http request option.

            -

          Returns Promise<RequestArgs>

    Export

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.UsersApiFactory.html b/docs/functions/client_api.UsersApiFactory.html index 04979310..6a92ca1c 100644 --- a/docs/functions/client_api.UsersApiFactory.html +++ b/docs/functions/client_api.UsersApiFactory.html @@ -2,4 +2,4 @@

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns {
        getCurrentUser(options?): AxiosPromise<User>;
    }

    • getCurrentUser:function
      • Get current user

        Parameters

        • Optional options: any

          Override http request option.

        Returns AxiosPromise<User>

        Summary

        Get current user

        -

        Throws

    Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.UsersApiFp.html b/docs/functions/client_api.UsersApiFp.html index bdfa8fc2..7a8583fa 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>)>;
    }

    • getCurrentUser:function
      • Get current user

        Parameters

        • Optional options: RawAxiosRequestConfig

          Override http request option.

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

        Summary

        Get current user

        -

        Throws

    Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.WalletsApiAxiosParamCreator.html b/docs/functions/client_api.WalletsApiAxiosParamCreator.html index b3884702..bfd7742e 100644 --- a/docs/functions/client_api.WalletsApiAxiosParamCreator.html +++ b/docs/functions/client_api.WalletsApiAxiosParamCreator.html @@ -20,4 +20,4 @@

    Throws

      • (limit?, page?, options?): Promise<RequestArgs>
      • 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<RequestArgs>

    Export

    \ No newline at end of file +

    Returns Promise<RequestArgs>

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.WalletsApiFactory.html b/docs/functions/client_api.WalletsApiFactory.html index 8944a3ad..fce9b3a5 100644 --- a/docs/functions/client_api.WalletsApiFactory.html +++ b/docs/functions/client_api.WalletsApiFactory.html @@ -2,22 +2,22 @@

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    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>;
    }

    • createWallet:function
      • Create a new wallet scoped to the user.

        Parameters

        • Optional createWalletRequest: CreateWalletRequest
        • Optional options: any

          Override http request option.

        Returns AxiosPromise<Wallet>

        Summary

        Create a new wallet

        -

        Throws

    • getWallet:function
    • getWallet:function
      • Get wallet

        Parameters

        • walletId: string

          The ID of the wallet to fetch

        • Optional options: any

          Override http request option.

        Returns AxiosPromise<Wallet>

        Summary

        Get wallet by ID

        -

        Throws

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

        +

        Throws

    • getWalletBalance:function
      • 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: any

          Override http request option.

        Returns AxiosPromise<Balance>

        Summary

        Get the balance of an asset in the wallet

        -

        Throws

    • listWalletBalances:function
    • listWalletBalances:function
      • 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: any

          Override http request option.

        Returns AxiosPromise<AddressBalanceList>

        Summary

        List wallet balances

        -

        Throws

    • listWallets:function
    • listWallets:function
      • 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: any

          Override http request option.

        Returns AxiosPromise<WalletList>

        Summary

        List wallets

        -

        Throws

    Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_api.WalletsApiFp.html b/docs/functions/client_api.WalletsApiFp.html index 646630f2..aafaaebb 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>)>;
    }

    • createWallet:function
      • Create a new wallet scoped to the user.

        Parameters

        • Optional createWalletRequest: CreateWalletRequest
        • Optional options: RawAxiosRequestConfig

          Override http request option.

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

        Summary

        Create a new wallet

        -

        Throws

    • getWallet:function
    • getWallet:function
      • Get wallet

        Parameters

        • walletId: string

          The ID of the wallet to fetch

        • Optional options: RawAxiosRequestConfig

          Override http request option.

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

        Summary

        Get wallet by ID

        -

        Throws

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

        +

        Throws

    • getWalletBalance:function
      • 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<((axios?, basePath?) => AxiosPromise<Balance>)>

        Summary

        Get the balance of an asset in the wallet

        -

        Throws

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

        +

        Throws

    • listWalletBalances:function
      • 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<((axios?, basePath?) => AxiosPromise<AddressBalanceList>)>

        Summary

        List wallet balances

        -

        Throws

    • listWallets:function
      • List wallets belonging to the user.

        +

        Throws

    • listWallets:function
      • 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<((axios?, basePath?) => AxiosPromise<WalletList>)>

        Summary

        List wallets

        -

        Throws

    Export

    \ No newline at end of file +

    Throws

    Export

    \ No newline at end of file diff --git a/docs/functions/client_common.assertParamExists.html b/docs/functions/client_common.assertParamExists.html index 0127df25..bbfe88b7 100644 --- a/docs/functions/client_common.assertParamExists.html +++ b/docs/functions/client_common.assertParamExists.html @@ -1 +1 @@ -assertParamExists | @coinbase/coinbase-sdk
    • Parameters

      • functionName: string
      • paramName: string
      • paramValue: unknown

      Returns void

      Throws

      Export

    \ No newline at end of file +assertParamExists | @coinbase/coinbase-sdk
    • Parameters

      • functionName: string
      • paramName: string
      • paramValue: unknown

      Returns void

      Throws

      Export

    \ No newline at end of file diff --git a/docs/functions/client_common.createRequestFunction.html b/docs/functions/client_common.createRequestFunction.html index 38f90472..3b4ad892 100644 --- a/docs/functions/client_common.createRequestFunction.html +++ b/docs/functions/client_common.createRequestFunction.html @@ -1 +1 @@ -createRequestFunction | @coinbase/coinbase-sdk
    • 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

    \ No newline at end of file +createRequestFunction | @coinbase/coinbase-sdk
    • 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

    \ No newline at end of file diff --git a/docs/functions/client_common.serializeDataIfNeeded.html b/docs/functions/client_common.serializeDataIfNeeded.html index 5543a283..e26b6304 100644 --- a/docs/functions/client_common.serializeDataIfNeeded.html +++ b/docs/functions/client_common.serializeDataIfNeeded.html @@ -1 +1 @@ -serializeDataIfNeeded | @coinbase/coinbase-sdk
    • Parameters

      • value: any
      • requestOptions: any
      • Optional configuration: Configuration

      Returns any

      Export

    \ No newline at end of file +serializeDataIfNeeded | @coinbase/coinbase-sdk
    • Parameters

      • value: any
      • requestOptions: any
      • Optional configuration: Configuration

      Returns any

      Export

    \ No newline at end of file diff --git a/docs/functions/client_common.setApiKeyToObject.html b/docs/functions/client_common.setApiKeyToObject.html index 485b53a0..a813cfea 100644 --- a/docs/functions/client_common.setApiKeyToObject.html +++ b/docs/functions/client_common.setApiKeyToObject.html @@ -1 +1 @@ -setApiKeyToObject | @coinbase/coinbase-sdk
    • Parameters

      • object: any
      • keyParamName: string
      • Optional configuration: Configuration

      Returns Promise<void>

      Export

    \ No newline at end of file +setApiKeyToObject | @coinbase/coinbase-sdk
    • Parameters

      • object: any
      • keyParamName: string
      • Optional configuration: Configuration

      Returns Promise<void>

      Export

    \ No newline at end of file diff --git a/docs/functions/client_common.setBasicAuthToObject.html b/docs/functions/client_common.setBasicAuthToObject.html index c242f995..f24c8515 100644 --- a/docs/functions/client_common.setBasicAuthToObject.html +++ b/docs/functions/client_common.setBasicAuthToObject.html @@ -1 +1 @@ -setBasicAuthToObject | @coinbase/coinbase-sdk
    \ No newline at end of file +setBasicAuthToObject | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/functions/client_common.setBearerAuthToObject.html b/docs/functions/client_common.setBearerAuthToObject.html index f22c7bad..954b971c 100644 --- a/docs/functions/client_common.setBearerAuthToObject.html +++ b/docs/functions/client_common.setBearerAuthToObject.html @@ -1 +1 @@ -setBearerAuthToObject | @coinbase/coinbase-sdk
    \ No newline at end of file +setBearerAuthToObject | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/functions/client_common.setOAuthToObject.html b/docs/functions/client_common.setOAuthToObject.html index aa14f6ff..d96f2e3f 100644 --- a/docs/functions/client_common.setOAuthToObject.html +++ b/docs/functions/client_common.setOAuthToObject.html @@ -1 +1 @@ -setOAuthToObject | @coinbase/coinbase-sdk
    • Parameters

      • object: any
      • name: string
      • scopes: string[]
      • Optional configuration: Configuration

      Returns Promise<void>

      Export

    \ No newline at end of file +setOAuthToObject | @coinbase/coinbase-sdk
    • Parameters

      • object: any
      • name: string
      • scopes: string[]
      • Optional configuration: Configuration

      Returns Promise<void>

      Export

    \ No newline at end of file diff --git a/docs/functions/client_common.setSearchParams.html b/docs/functions/client_common.setSearchParams.html index 13a6e2d1..e6d2032a 100644 --- a/docs/functions/client_common.setSearchParams.html +++ b/docs/functions/client_common.setSearchParams.html @@ -1 +1 @@ -setSearchParams | @coinbase/coinbase-sdk
    • Parameters

      • url: URL
      • Rest ...objects: any[]

      Returns void

      Export

    \ No newline at end of file +setSearchParams | @coinbase/coinbase-sdk
    • Parameters

      • url: URL
      • Rest ...objects: any[]

      Returns void

      Export

    \ No newline at end of file diff --git a/docs/functions/client_common.toPathString.html b/docs/functions/client_common.toPathString.html index fdede8df..3bda93fc 100644 --- a/docs/functions/client_common.toPathString.html +++ b/docs/functions/client_common.toPathString.html @@ -1 +1 @@ -toPathString | @coinbase/coinbase-sdk
    \ No newline at end of file +toPathString | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/functions/coinbase_tests_utils.createAxiosMock.html b/docs/functions/coinbase_tests_utils.createAxiosMock.html index 62633eea..9dc32717 100644 --- a/docs/functions/coinbase_tests_utils.createAxiosMock.html +++ b/docs/functions/coinbase_tests_utils.createAxiosMock.html @@ -1,3 +1,3 @@ createAxiosMock | @coinbase/coinbase-sdk
    • Returns an Axios instance with interceptors and configuration for testing.

      Returns AxiosMockType

      The Axios instance, configuration, and base path.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/functions/coinbase_tests_utils.generateRandomHash.html b/docs/functions/coinbase_tests_utils.generateRandomHash.html index 551526bb..d90b61eb 100644 --- a/docs/functions/coinbase_tests_utils.generateRandomHash.html +++ b/docs/functions/coinbase_tests_utils.generateRandomHash.html @@ -1 +1 @@ -generateRandomHash | @coinbase/coinbase-sdk
    \ No newline at end of file +generateRandomHash | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/functions/coinbase_tests_utils.generateWalletFromSeed.html b/docs/functions/coinbase_tests_utils.generateWalletFromSeed.html index e8081807..6e05ea42 100644 --- a/docs/functions/coinbase_tests_utils.generateWalletFromSeed.html +++ b/docs/functions/coinbase_tests_utils.generateWalletFromSeed.html @@ -1 +1 @@ -generateWalletFromSeed | @coinbase/coinbase-sdk
    • Parameters

      • seed: string
      • count: number = 2

      Returns Record<string, string>

    \ No newline at end of file +generateWalletFromSeed | @coinbase/coinbase-sdk
    • Parameters

      • seed: string
      • count: number = 2

      Returns Record<string, string>

    \ No newline at end of file diff --git a/docs/functions/coinbase_tests_utils.getAddressFromHDKey.html b/docs/functions/coinbase_tests_utils.getAddressFromHDKey.html index 7260fd30..cf294de5 100644 --- a/docs/functions/coinbase_tests_utils.getAddressFromHDKey.html +++ b/docs/functions/coinbase_tests_utils.getAddressFromHDKey.html @@ -1 +1 @@ -getAddressFromHDKey | @coinbase/coinbase-sdk
    \ No newline at end of file +getAddressFromHDKey | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/functions/coinbase_tests_utils.mockFn.html b/docs/functions/coinbase_tests_utils.mockFn.html index 515387a1..fef1fd80 100644 --- a/docs/functions/coinbase_tests_utils.mockFn.html +++ b/docs/functions/coinbase_tests_utils.mockFn.html @@ -1 +1 @@ -mockFn | @coinbase/coinbase-sdk
    \ No newline at end of file +mockFn | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/functions/coinbase_tests_utils.mockReturnRejectedValue.html b/docs/functions/coinbase_tests_utils.mockReturnRejectedValue.html index e22e4db0..67236fe0 100644 --- a/docs/functions/coinbase_tests_utils.mockReturnRejectedValue.html +++ b/docs/functions/coinbase_tests_utils.mockReturnRejectedValue.html @@ -1 +1 @@ -mockReturnRejectedValue | @coinbase/coinbase-sdk
    \ No newline at end of file +mockReturnRejectedValue | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/functions/coinbase_tests_utils.mockReturnValue.html b/docs/functions/coinbase_tests_utils.mockReturnValue.html index 99ea9cbd..7be893f7 100644 --- a/docs/functions/coinbase_tests_utils.mockReturnValue.html +++ b/docs/functions/coinbase_tests_utils.mockReturnValue.html @@ -1 +1 @@ -mockReturnValue | @coinbase/coinbase-sdk
    \ No newline at end of file +mockReturnValue | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/functions/coinbase_tests_utils.newAddressModel.html b/docs/functions/coinbase_tests_utils.newAddressModel.html index 86b95560..74e32c80 100644 --- a/docs/functions/coinbase_tests_utils.newAddressModel.html +++ b/docs/functions/coinbase_tests_utils.newAddressModel.html @@ -1 +1 @@ -newAddressModel | @coinbase/coinbase-sdk
    \ No newline at end of file +newAddressModel | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/functions/coinbase_utils.convertStringToHex.html b/docs/functions/coinbase_utils.convertStringToHex.html index 2939bdff..58e9fb53 100644 --- a/docs/functions/coinbase_utils.convertStringToHex.html +++ b/docs/functions/coinbase_utils.convertStringToHex.html @@ -1,4 +1,4 @@ convertStringToHex | @coinbase/coinbase-sdk
    • Converts a Uint8Array to a hex string.

      Parameters

      • key: Uint8Array

        The key to convert.

      Returns string

      The converted hex string.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/functions/coinbase_utils.delay.html b/docs/functions/coinbase_utils.delay.html index eb3b78f5..2f9a511b 100644 --- a/docs/functions/coinbase_utils.delay.html +++ b/docs/functions/coinbase_utils.delay.html @@ -1,4 +1,4 @@ delay | @coinbase/coinbase-sdk
    • 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.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/functions/coinbase_utils.destinationToAddressHexString.html b/docs/functions/coinbase_utils.destinationToAddressHexString.html index 83462e4e..df913a8a 100644 --- a/docs/functions/coinbase_utils.destinationToAddressHexString.html +++ b/docs/functions/coinbase_utils.destinationToAddressHexString.html @@ -2,4 +2,4 @@

    Parameters

    Returns string

    The Address Hex string.

    Throws

    If the Destination is an unsupported type.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/functions/coinbase_utils.logApiResponse.html b/docs/functions/coinbase_utils.logApiResponse.html index 58a9bde6..65ca4a13 100644 --- a/docs/functions/coinbase_utils.logApiResponse.html +++ b/docs/functions/coinbase_utils.logApiResponse.html @@ -2,4 +2,4 @@

    Parameters

    • response: AxiosResponse<any, any>

      The Axios response object.

    • debugging: boolean = false

      Flag to enable or disable logging.

    Returns AxiosResponse<any, any>

    The Axios response object.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/functions/coinbase_utils.registerAxiosInterceptors.html b/docs/functions/coinbase_utils.registerAxiosInterceptors.html index 3444b0e5..bb228027 100644 --- a/docs/functions/coinbase_utils.registerAxiosInterceptors.html +++ b/docs/functions/coinbase_utils.registerAxiosInterceptors.html @@ -2,4 +2,4 @@

    Parameters

    • axiosInstance: Axios

      The Axios instance to register the interceptors.

    • requestFn: RequestFunctionType

      The request interceptor function.

    • responseFn: ResponseFunctionType

      The response interceptor function.

      -

    Returns void

    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/docs/interfaces/client_api.Address.html b/docs/interfaces/client_api.Address.html index 19773525..ca5ed951 100644 --- a/docs/interfaces/client_api.Address.html +++ b/docs/interfaces/client_api.Address.html @@ -1,14 +1,14 @@ Address | @coinbase/coinbase-sdk

    Export

    Address

    -
    interface Address {
        address_id: string;
        network_id: string;
        public_key: string;
        wallet_id: string;
    }

    Properties

    interface Address {
        address_id: string;
        network_id: string;
        public_key: string;
        wallet_id: string;
    }

    Properties

    address_id: string

    The onchain address derived on the server-side.

    Memberof

    Address

    -
    network_id: string

    The ID of the blockchain network

    +
    network_id: string

    The ID of the blockchain network

    Memberof

    Address

    -
    public_key: string

    The public key from which the address is derived.

    +
    public_key: string

    The public key from which the address is derived.

    Memberof

    Address

    -
    wallet_id: string

    The ID of the wallet that owns the address

    +
    wallet_id: string

    The ID of the wallet that owns the address

    Memberof

    Address

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.AddressBalanceList.html b/docs/interfaces/client_api.AddressBalanceList.html index 6f4923b0..d9982a47 100644 --- a/docs/interfaces/client_api.AddressBalanceList.html +++ b/docs/interfaces/client_api.AddressBalanceList.html @@ -1,13 +1,13 @@ AddressBalanceList | @coinbase/coinbase-sdk

    Export

    AddressBalanceList

    -
    interface AddressBalanceList {
        data: Balance[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    interface AddressBalanceList {
        data: Balance[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data: Balance[]

    Memberof

    AddressBalanceList

    -
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    AddressBalanceList

    -
    next_page: string

    The page token to be used to fetch the next page.

    +
    next_page: string

    The page token to be used to fetch the next page.

    Memberof

    AddressBalanceList

    -
    total_count: number

    The total number of balances for the wallet.

    +
    total_count: number

    The total number of balances for the wallet.

    Memberof

    AddressBalanceList

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.AddressList.html b/docs/interfaces/client_api.AddressList.html index aa28249e..899f4607 100644 --- a/docs/interfaces/client_api.AddressList.html +++ b/docs/interfaces/client_api.AddressList.html @@ -1,13 +1,13 @@ AddressList | @coinbase/coinbase-sdk

    Export

    AddressList

    -
    interface AddressList {
        data: Address[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    interface AddressList {
        data: Address[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data: Address[]

    Memberof

    AddressList

    -
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    AddressList

    -
    next_page: string

    The page token to be used to fetch the next page.

    +
    next_page: string

    The page token to be used to fetch the next page.

    Memberof

    AddressList

    -
    total_count: number

    The total number of addresses for the wallet.

    +
    total_count: number

    The total number of addresses for the wallet.

    Memberof

    AddressList

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.AddressesApiInterface.html b/docs/interfaces/client_api.AddressesApiInterface.html index 5a92bdd7..b3863b35 100644 --- a/docs/interfaces/client_api.AddressesApiInterface.html +++ b/docs/interfaces/client_api.AddressesApiInterface.html @@ -1,6 +1,6 @@ AddressesApiInterface | @coinbase/coinbase-sdk

    AddressesApi - interface

    Export

    AddressesApi

    -
    interface AddressesApiInterface {
        createAddress(walletId, createAddressRequest?, options?): AxiosPromise<Address>;
        getAddress(walletId, addressId, options?): AxiosPromise<Address>;
        getAddressBalance(walletId, addressId, assetId, options?): AxiosPromise<Balance>;
        listAddressBalances(walletId, addressId, page?, options?): AxiosPromise<AddressBalanceList>;
        listAddresses(walletId, limit?, page?, options?): AxiosPromise<AddressList>;
        requestFaucetFunds(walletId, addressId, options?): AxiosPromise<FaucetTransaction>;
    }

    Implemented by

    Methods

    interface AddressesApiInterface {
        createAddress(walletId, createAddressRequest?, options?): AxiosPromise<Address>;
        getAddress(walletId, addressId, options?): AxiosPromise<Address>;
        getAddressBalance(walletId, addressId, assetId, options?): AxiosPromise<Balance>;
        listAddressBalances(walletId, addressId, page?, options?): AxiosPromise<AddressBalanceList>;
        listAddresses(walletId, limit?, page?, options?): AxiosPromise<AddressList>;
        requestFaucetFunds(walletId, addressId, options?): AxiosPromise<FaucetTransaction>;
    }

    Implemented by

    Methods

  • Optional createAddressRequest: CreateAddressRequest
  • Optional options: RawAxiosRequestConfig

    Override http request option.

  • Returns AxiosPromise<Address>

    Summary

    Create a new address

    Throws

    Memberof

    AddressesApiInterface

    -
    • 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

      -
    • 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

      -
    • 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

      -
    • 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

      -
    • 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 options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<FaucetTransaction>

      Summary

      Request faucet funds for onchain address.

      Throws

      Memberof

      AddressesApiInterface

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.Asset.html b/docs/interfaces/client_api.Asset.html index 8d33522f..e6f32658 100644 --- a/docs/interfaces/client_api.Asset.html +++ b/docs/interfaces/client_api.Asset.html @@ -1,15 +1,15 @@ Asset | @coinbase/coinbase-sdk

    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

    interface Asset {
        asset_id: string;
        contract_address?: string;
        decimals?: number;
        network_id: string;
    }

    Properties

    asset_id: string

    The ID for the asset on the network

    Memberof

    Asset

    -
    contract_address?: string

    The optional contract address for the asset. This will be specified for smart contract-based assets, for example ERC20s.

    +
    contract_address?: string

    The optional contract address for the asset. This will be specified for smart contract-based assets, for example ERC20s.

    Memberof

    Asset

    -
    decimals?: number

    The number of decimals the asset supports. This is used to convert from atomic units to base units.

    +
    decimals?: number

    The number of decimals the asset supports. This is used to convert from atomic units to base units.

    Memberof

    Asset

    -
    network_id: string

    The ID of the blockchain network

    +
    network_id: string

    The ID of the blockchain network

    Memberof

    Asset

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.Balance.html b/docs/interfaces/client_api.Balance.html index 63906782..aaadaa6e 100644 --- a/docs/interfaces/client_api.Balance.html +++ b/docs/interfaces/client_api.Balance.html @@ -1,8 +1,8 @@ Balance | @coinbase/coinbase-sdk

    The balance of an asset onchain

    Export

    Balance

    -
    interface Balance {
        amount: string;
        asset: Asset;
    }

    Properties

    interface Balance {
        amount: string;
        asset: Asset;
    }

    Properties

    Properties

    amount: string

    The amount in the atomic units of the asset

    Memberof

    Balance

    -
    asset: Asset

    Memberof

    Balance

    -
    \ No newline at end of file +
    asset: Asset

    Memberof

    Balance

    +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.BroadcastTradeRequest.html b/docs/interfaces/client_api.BroadcastTradeRequest.html index f8641213..4847708d 100644 --- a/docs/interfaces/client_api.BroadcastTradeRequest.html +++ b/docs/interfaces/client_api.BroadcastTradeRequest.html @@ -1,5 +1,5 @@ BroadcastTradeRequest | @coinbase/coinbase-sdk

    Export

    BroadcastTradeRequest

    -
    interface BroadcastTradeRequest {
        signed_payload: string;
    }

    Properties

    interface BroadcastTradeRequest {
        signed_payload: string;
    }

    Properties

    Properties

    signed_payload: string

    The hex-encoded signed payload of the trade

    Memberof

    BroadcastTradeRequest

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.BroadcastTransferRequest.html b/docs/interfaces/client_api.BroadcastTransferRequest.html index 21136bd3..f6ce14e3 100644 --- a/docs/interfaces/client_api.BroadcastTransferRequest.html +++ b/docs/interfaces/client_api.BroadcastTransferRequest.html @@ -1,5 +1,5 @@ BroadcastTransferRequest | @coinbase/coinbase-sdk

    Export

    BroadcastTransferRequest

    -
    interface BroadcastTransferRequest {
        signed_payload: string;
    }

    Properties

    interface BroadcastTransferRequest {
        signed_payload: string;
    }

    Properties

    Properties

    signed_payload: string

    The hex-encoded signed payload of the transfer

    Memberof

    BroadcastTransferRequest

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateAddressRequest.html b/docs/interfaces/client_api.CreateAddressRequest.html index 05d5d4be..f4364d2c 100644 --- a/docs/interfaces/client_api.CreateAddressRequest.html +++ b/docs/interfaces/client_api.CreateAddressRequest.html @@ -1,8 +1,8 @@ CreateAddressRequest | @coinbase/coinbase-sdk

    Export

    CreateAddressRequest

    -
    interface CreateAddressRequest {
        attestation?: string;
        public_key?: string;
    }

    Properties

    interface CreateAddressRequest {
        attestation?: string;
        public_key?: string;
    }

    Properties

    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

    -
    public_key?: string

    The public key from which the address will be derived.

    +
    public_key?: string

    The public key from which the address will be derived.

    Memberof

    CreateAddressRequest

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateServerSignerRequest.html b/docs/interfaces/client_api.CreateServerSignerRequest.html index 9b47252f..8a074ea1 100644 --- a/docs/interfaces/client_api.CreateServerSignerRequest.html +++ b/docs/interfaces/client_api.CreateServerSignerRequest.html @@ -1,8 +1,8 @@ CreateServerSignerRequest | @coinbase/coinbase-sdk

    Export

    CreateServerSignerRequest

    -
    interface CreateServerSignerRequest {
        enrollment_data: string;
        server_signer_id: string;
    }

    Properties

    interface CreateServerSignerRequest {
        enrollment_data: string;
        server_signer_id: string;
    }

    Properties

    enrollment_data: string

    The enrollment data of the server signer. This will be the base64 encoded server-signer-id.

    Memberof

    CreateServerSignerRequest

    -
    server_signer_id: string

    The ID of the server signer

    +
    server_signer_id: string

    The ID of the server signer

    Memberof

    CreateServerSignerRequest

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateTradeRequest.html b/docs/interfaces/client_api.CreateTradeRequest.html index 327ce94b..a067ed2f 100644 --- a/docs/interfaces/client_api.CreateTradeRequest.html +++ b/docs/interfaces/client_api.CreateTradeRequest.html @@ -1,11 +1,11 @@ CreateTradeRequest | @coinbase/coinbase-sdk

    Export

    CreateTradeRequest

    -
    interface CreateTradeRequest {
        amount: string;
        from_asset_id: string;
        to_asset_id: string;
    }

    Properties

    interface CreateTradeRequest {
        amount: string;
        from_asset_id: string;
        to_asset_id: string;
    }

    Properties

    amount: string

    The amount to trade

    Memberof

    CreateTradeRequest

    -
    from_asset_id: string

    The ID of the asset to trade

    +
    from_asset_id: string

    The ID of the asset to trade

    Memberof

    CreateTradeRequest

    -
    to_asset_id: string

    The ID of the asset to receive from the trade

    +
    to_asset_id: string

    The ID of the asset to receive from the trade

    Memberof

    CreateTradeRequest

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateTransferRequest.html b/docs/interfaces/client_api.CreateTransferRequest.html index 984c6f4f..92a1b96b 100644 --- a/docs/interfaces/client_api.CreateTransferRequest.html +++ b/docs/interfaces/client_api.CreateTransferRequest.html @@ -1,14 +1,14 @@ CreateTransferRequest | @coinbase/coinbase-sdk

    Export

    CreateTransferRequest

    -
    interface CreateTransferRequest {
        amount: string;
        asset_id: string;
        destination: string;
        network_id: string;
    }

    Properties

    interface CreateTransferRequest {
        amount: string;
        asset_id: string;
        destination: string;
        network_id: string;
    }

    Properties

    amount: string

    The amount to transfer

    Memberof

    CreateTransferRequest

    -
    asset_id: string

    The ID of the asset to transfer

    +
    asset_id: string

    The ID of the asset to transfer

    Memberof

    CreateTransferRequest

    -
    destination: string

    The destination address

    +
    destination: string

    The destination address

    Memberof

    CreateTransferRequest

    -
    network_id: string

    The ID of the blockchain network

    +
    network_id: string

    The ID of the blockchain network

    Memberof

    CreateTransferRequest

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateWalletRequest.html b/docs/interfaces/client_api.CreateWalletRequest.html index 15bfa6e3..356ddd5d 100644 --- a/docs/interfaces/client_api.CreateWalletRequest.html +++ b/docs/interfaces/client_api.CreateWalletRequest.html @@ -1,4 +1,4 @@ CreateWalletRequest | @coinbase/coinbase-sdk

    Export

    CreateWalletRequest

    -
    interface CreateWalletRequest {
        wallet: CreateWalletRequestWallet;
    }

    Properties

    interface CreateWalletRequest {
        wallet: CreateWalletRequestWallet;
    }

    Properties

    Properties

    Memberof

    CreateWalletRequest

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.CreateWalletRequestWallet.html b/docs/interfaces/client_api.CreateWalletRequestWallet.html index 290497ed..d4d9d6f1 100644 --- a/docs/interfaces/client_api.CreateWalletRequestWallet.html +++ b/docs/interfaces/client_api.CreateWalletRequestWallet.html @@ -1,9 +1,9 @@ CreateWalletRequestWallet | @coinbase/coinbase-sdk

    Parameters for configuring a wallet

    Export

    CreateWalletRequestWallet

    -
    interface CreateWalletRequestWallet {
        network_id: string;
        use_server_signer?: boolean;
    }

    Properties

    interface CreateWalletRequestWallet {
        network_id: string;
        use_server_signer?: boolean;
    }

    Properties

    network_id: string

    The ID of the blockchain network

    Memberof

    CreateWalletRequestWallet

    -
    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.

    +
    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

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.FaucetTransaction.html b/docs/interfaces/client_api.FaucetTransaction.html index ea1dfd93..129aba85 100644 --- a/docs/interfaces/client_api.FaucetTransaction.html +++ b/docs/interfaces/client_api.FaucetTransaction.html @@ -1,5 +1,5 @@ FaucetTransaction | @coinbase/coinbase-sdk

    Export

    FaucetTransaction

    -
    interface FaucetTransaction {
        transaction_hash: string;
    }

    Properties

    interface FaucetTransaction {
        transaction_hash: string;
    }

    Properties

    Properties

    transaction_hash: string

    The transaction hash of the transaction the faucet created.

    Memberof

    FaucetTransaction

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ModelError.html b/docs/interfaces/client_api.ModelError.html index 283aeaf8..a78c9370 100644 --- a/docs/interfaces/client_api.ModelError.html +++ b/docs/interfaces/client_api.ModelError.html @@ -1,9 +1,9 @@ ModelError | @coinbase/coinbase-sdk

    An error response from the Coinbase Developer Platform API

    Export

    ModelError

    -
    interface ModelError {
        code: string;
        message: string;
    }

    Properties

    interface ModelError {
        code: string;
        message: string;
    }

    Properties

    Properties

    code: string

    A short string representing the reported error. Can be use to handle errors programmatically.

    Memberof

    ModelError

    -
    message: string

    A human-readable message providing more details about the error.

    +
    message: string

    A human-readable message providing more details about the error.

    Memberof

    ModelError

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.SeedCreationEvent.html b/docs/interfaces/client_api.SeedCreationEvent.html index b9aae842..dd5f8985 100644 --- a/docs/interfaces/client_api.SeedCreationEvent.html +++ b/docs/interfaces/client_api.SeedCreationEvent.html @@ -1,9 +1,9 @@ SeedCreationEvent | @coinbase/coinbase-sdk

    An event representing a seed creation.

    Export

    SeedCreationEvent

    -
    interface SeedCreationEvent {
        wallet_id: string;
        wallet_user_id: string;
    }

    Properties

    interface SeedCreationEvent {
        wallet_id: string;
        wallet_user_id: string;
    }

    Properties

    wallet_id: string

    The ID of the wallet that the server-signer should create the seed for

    Memberof

    SeedCreationEvent

    -
    wallet_user_id: string

    The ID of the user that the wallet belongs to

    +
    wallet_user_id: string

    The ID of the user that the wallet belongs to

    Memberof

    SeedCreationEvent

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.SeedCreationEventResult.html b/docs/interfaces/client_api.SeedCreationEventResult.html index 44478c67..00add90f 100644 --- a/docs/interfaces/client_api.SeedCreationEventResult.html +++ b/docs/interfaces/client_api.SeedCreationEventResult.html @@ -1,15 +1,15 @@ SeedCreationEventResult | @coinbase/coinbase-sdk

    The result to a SeedCreationEvent.

    Export

    SeedCreationEventResult

    -
    interface SeedCreationEventResult {
        extended_public_key: string;
        seed_id: string;
        wallet_id: string;
        wallet_user_id: string;
    }

    Properties

    interface SeedCreationEventResult {
        extended_public_key: string;
        seed_id: string;
        wallet_id: string;
        wallet_user_id: string;
    }

    Properties

    extended_public_key: string

    The extended public key for the first master key derived from seed.

    Memberof

    SeedCreationEventResult

    -
    seed_id: string

    The ID of the seed in Server-Signer used to generate the extended public key.

    +
    seed_id: string

    The ID of the seed in Server-Signer used to generate the extended public key.

    Memberof

    SeedCreationEventResult

    -
    wallet_id: string

    The ID of the wallet that the seed was created for

    +
    wallet_id: string

    The ID of the wallet that the seed was created for

    Memberof

    SeedCreationEventResult

    -
    wallet_user_id: string

    The ID of the user that the wallet belongs to

    +
    wallet_user_id: string

    The ID of the user that the wallet belongs to

    Memberof

    SeedCreationEventResult

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ServerSigner.html b/docs/interfaces/client_api.ServerSigner.html index ddca33e4..9dad7b28 100644 --- a/docs/interfaces/client_api.ServerSigner.html +++ b/docs/interfaces/client_api.ServerSigner.html @@ -1,9 +1,9 @@ ServerSigner | @coinbase/coinbase-sdk

    A Server-Signer assigned to sign transactions in a wallet.

    Export

    ServerSigner

    -
    interface ServerSigner {
        server_signer_id: string;
        wallets?: string[];
    }

    Properties

    interface ServerSigner {
        server_signer_id: string;
        wallets?: string[];
    }

    Properties

    server_signer_id: string

    The ID of the server-signer

    Memberof

    ServerSigner

    -
    wallets?: string[]

    The IDs of the wallets that the server-signer can sign for

    +
    wallets?: string[]

    The IDs of the wallets that the server-signer can sign for

    Memberof

    ServerSigner

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ServerSignerEvent.html b/docs/interfaces/client_api.ServerSignerEvent.html index d444433d..9dce9818 100644 --- a/docs/interfaces/client_api.ServerSignerEvent.html +++ b/docs/interfaces/client_api.ServerSignerEvent.html @@ -1,8 +1,8 @@ ServerSignerEvent | @coinbase/coinbase-sdk

    An event that is waiting to be processed by a Server-Signer.

    Export

    ServerSignerEvent

    -
    interface ServerSignerEvent {
        event: ServerSignerEventEvent;
        server_signer_id: string;
    }

    Properties

    interface ServerSignerEvent {
        event: ServerSignerEventEvent;
        server_signer_id: string;
    }

    Properties

    Memberof

    ServerSignerEvent

    -
    server_signer_id: string

    The ID of the server-signer that the event is for

    +
    server_signer_id: string

    The ID of the server-signer that the event is for

    Memberof

    ServerSignerEvent

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ServerSignerEventList.html b/docs/interfaces/client_api.ServerSignerEventList.html index 26cc852d..681b3802 100644 --- a/docs/interfaces/client_api.ServerSignerEventList.html +++ b/docs/interfaces/client_api.ServerSignerEventList.html @@ -1,13 +1,13 @@ ServerSignerEventList | @coinbase/coinbase-sdk

    Export

    ServerSignerEventList

    -
    interface ServerSignerEventList {
        data: ServerSignerEvent[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    interface ServerSignerEventList {
        data: ServerSignerEvent[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    Memberof

    ServerSignerEventList

    -
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    ServerSignerEventList

    -
    next_page: string

    The page token to be used to fetch the next page.

    +
    next_page: string

    The page token to be used to fetch the next page.

    Memberof

    ServerSignerEventList

    -
    total_count: number

    The total number of events for the server signer.

    +
    total_count: number

    The total number of events for the server signer.

    Memberof

    ServerSignerEventList

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.ServerSignersApiInterface.html b/docs/interfaces/client_api.ServerSignersApiInterface.html index a7a5698e..c71200d6 100644 --- a/docs/interfaces/client_api.ServerSignersApiInterface.html +++ b/docs/interfaces/client_api.ServerSignersApiInterface.html @@ -1,6 +1,6 @@ ServerSignersApiInterface | @coinbase/coinbase-sdk

    ServerSignersApi - interface

    Export

    ServerSignersApi

    -
    interface ServerSignersApiInterface {
        createServerSigner(createServerSignerRequest?, options?): AxiosPromise<ServerSigner>;
        getServerSigner(serverSignerId, options?): AxiosPromise<ServerSigner>;
        listServerSignerEvents(serverSignerId, limit?, page?, options?): AxiosPromise<ServerSignerEventList>;
        listServerSigners(options?): AxiosPromise<ServerSigner>;
        submitServerSignerSeedEventResult(serverSignerId, seedCreationEventResult?, options?): AxiosPromise<SeedCreationEventResult>;
        submitServerSignerSignatureEventResult(serverSignerId, signatureCreationEventResult?, options?): AxiosPromise<SignatureCreationEventResult>;
    }

    Implemented by

    Methods

    interface ServerSignersApiInterface {
        createServerSigner(createServerSignerRequest?, options?): AxiosPromise<ServerSigner>;
        getServerSigner(serverSignerId, options?): AxiosPromise<ServerSigner>;
        listServerSignerEvents(serverSignerId, limit?, page?, options?): AxiosPromise<ServerSignerEventList>;
        listServerSigners(options?): AxiosPromise<ServerSigner>;
        submitServerSignerSeedEventResult(serverSignerId, seedCreationEventResult?, options?): AxiosPromise<SeedCreationEventResult>;
        submitServerSignerSignatureEventResult(serverSignerId, signatureCreationEventResult?, options?): AxiosPromise<SignatureCreationEventResult>;
    }

    Implemented by

    Methods

    Parameters

    • Optional createServerSignerRequest: CreateServerSignerRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ServerSigner>

    Summary

    Create a new Server-Signer

    Throws

    Memberof

    ServerSignersApiInterface

    -
    • 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

      -
    • 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

      Throws

      Memberof

      ServerSignersApiInterface

      -
    • List server signers for the current project

      Parameters

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<ServerSigner>

      Summary

      List server signers for the current project

      Throws

      Memberof

      ServerSignersApiInterface

      -
    • 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

      -
    • 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

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.SignatureCreationEvent.html b/docs/interfaces/client_api.SignatureCreationEvent.html index cefccd83..ed1a5653 100644 --- a/docs/interfaces/client_api.SignatureCreationEvent.html +++ b/docs/interfaces/client_api.SignatureCreationEvent.html @@ -1,6 +1,6 @@ SignatureCreationEvent | @coinbase/coinbase-sdk

    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

    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: string

    The ID of the address the transfer belongs to

    Memberof

    SignatureCreationEvent

    -
    address_index: number

    The index of the address that the server-signer should sign with

    +
    address_index: number

    The index of the address that the server-signer should sign with

    Memberof

    SignatureCreationEvent

    -
    seed_id: string

    The ID of the seed that the server-signer should create the signature for

    +
    seed_id: string

    The ID of the seed that the server-signer should create the signature for

    Memberof

    SignatureCreationEvent

    -
    signing_payload: string

    The payload that the server-signer should sign

    +
    signing_payload: string

    The payload that the server-signer should sign

    Memberof

    SignatureCreationEvent

    -
    transaction_id: string

    The ID of the transaction that the server-signer should sign

    +
    transaction_id: string

    The ID of the transaction that the server-signer should sign

    Memberof

    SignatureCreationEvent

    -
    transaction_type: "transfer"

    Memberof

    SignatureCreationEvent

    -
    wallet_id: string

    The ID of the wallet the signature is for

    +
    transaction_type: "transfer"

    Memberof

    SignatureCreationEvent

    +
    wallet_id: string

    The ID of the wallet the signature is for

    Memberof

    SignatureCreationEvent

    -
    wallet_user_id: string

    The ID of the user that the wallet belongs to

    +
    wallet_user_id: string

    The ID of the user that the wallet belongs to

    Memberof

    SignatureCreationEvent

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.SignatureCreationEventResult.html b/docs/interfaces/client_api.SignatureCreationEventResult.html index d10a0c9e..7abe0ba4 100644 --- a/docs/interfaces/client_api.SignatureCreationEventResult.html +++ b/docs/interfaces/client_api.SignatureCreationEventResult.html @@ -1,6 +1,6 @@ SignatureCreationEventResult | @coinbase/coinbase-sdk

    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

    interface SignatureCreationEventResult {
        address_id: string;
        signature: string;
        transaction_id: string;
        transaction_type: "transfer";
        wallet_id: string;
        wallet_user_id: string;
    }

    Properties

    address_id: string

    The ID of the address the transfer belongs to

    Memberof

    SignatureCreationEventResult

    -
    signature: string

    The signature created by the server-signer.

    +
    signature: string

    The signature created by the server-signer.

    Memberof

    SignatureCreationEventResult

    -
    transaction_id: string

    The ID of the transaction that the Server-Signer has signed for

    +
    transaction_id: string

    The ID of the transaction that the Server-Signer has signed for

    Memberof

    SignatureCreationEventResult

    -
    transaction_type: "transfer"

    Memberof

    SignatureCreationEventResult

    -
    wallet_id: string

    The ID of the wallet that the event was created for.

    +
    transaction_type: "transfer"

    Memberof

    SignatureCreationEventResult

    +
    wallet_id: string

    The ID of the wallet that the event was created for.

    Memberof

    SignatureCreationEventResult

    -
    wallet_user_id: string

    The ID of the user that the wallet belongs to

    +
    wallet_user_id: string

    The ID of the user that the wallet belongs to

    Memberof

    SignatureCreationEventResult

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.Trade.html b/docs/interfaces/client_api.Trade.html index 495f9d3a..12f11071 100644 --- a/docs/interfaces/client_api.Trade.html +++ b/docs/interfaces/client_api.Trade.html @@ -1,6 +1,6 @@ Trade | @coinbase/coinbase-sdk

    A trade of an asset to another asset

    Export

    Trade

    -
    interface Trade {
        address_id: string;
        from_amount: string;
        from_asset: Asset;
        network_id: string;
        to_amount: string;
        to_asset: Asset;
        trade_id: string;
        transaction: Transaction;
        wallet_id: string;
    }

    Properties

    interface Trade {
        address_id: string;
        from_amount: string;
        from_asset: Asset;
        network_id: string;
        to_amount: string;
        to_asset: Asset;
        trade_id: string;
        transaction: Transaction;
        wallet_id: string;
    }

    Properties

    Properties

    address_id: string

    The onchain address of the sender

    Memberof

    Trade

    -
    from_amount: string

    The amount of the from asset to be traded (in atomic units of the from asset)

    +
    from_amount: string

    The amount of the from asset to be traded (in atomic units of the from asset)

    Memberof

    Trade

    -
    from_asset: Asset

    Memberof

    Trade

    -
    network_id: string

    The ID of the blockchain network

    +
    from_asset: Asset

    Memberof

    Trade

    +
    network_id: string

    The ID of the blockchain network

    Memberof

    Trade

    -
    to_amount: string

    The amount of the to asset that will be received (in atomic units of the to asset)

    +
    to_amount: string

    The amount of the to asset that will be received (in atomic units of the to asset)

    Memberof

    Trade

    -
    to_asset: Asset

    Memberof

    Trade

    -
    trade_id: string

    The ID of the trade

    +
    to_asset: Asset

    Memberof

    Trade

    +
    trade_id: string

    The ID of the trade

    Memberof

    Trade

    -
    transaction: Transaction

    Memberof

    Trade

    -
    wallet_id: string

    The ID of the wallet that owns the from address

    +
    transaction: Transaction

    Memberof

    Trade

    +
    wallet_id: string

    The ID of the wallet that owns the from address

    Memberof

    Trade

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.TradeList.html b/docs/interfaces/client_api.TradeList.html index ad8f9cd8..c5470b66 100644 --- a/docs/interfaces/client_api.TradeList.html +++ b/docs/interfaces/client_api.TradeList.html @@ -1,13 +1,13 @@ TradeList | @coinbase/coinbase-sdk

    Export

    TradeList

    -
    interface TradeList {
        data: Trade[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    interface TradeList {
        data: Trade[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data: Trade[]

    Memberof

    TradeList

    -
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    TradeList

    -
    next_page: string

    The page token to be used to fetch the next page.

    +
    next_page: string

    The page token to be used to fetch the next page.

    Memberof

    TradeList

    -
    total_count: number

    The total number of trades for the address in the wallet.

    +
    total_count: number

    The total number of trades for the address in the wallet.

    Memberof

    TradeList

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.TradesApiInterface.html b/docs/interfaces/client_api.TradesApiInterface.html index 4fca1f6e..594ea9aa 100644 --- a/docs/interfaces/client_api.TradesApiInterface.html +++ b/docs/interfaces/client_api.TradesApiInterface.html @@ -1,6 +1,6 @@ TradesApiInterface | @coinbase/coinbase-sdk

    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

    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

  • broadcastTradeRequest: BroadcastTradeRequest
  • Optional options: RawAxiosRequestConfig

    Override http request option.

  • Returns AxiosPromise<Trade>

    Summary

    Broadcast a trade

    Throws

    Memberof

    TradesApiInterface

    -
    • Create a new 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

      -
    • 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

      -
    • 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

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.Transaction.html b/docs/interfaces/client_api.Transaction.html index b76059c1..4488bb53 100644 --- a/docs/interfaces/client_api.Transaction.html +++ b/docs/interfaces/client_api.Transaction.html @@ -1,6 +1,6 @@ Transaction | @coinbase/coinbase-sdk

    An onchain transaction.

    Export

    Transaction

    -
    interface Transaction {
        from_address_id: string;
        network_id: string;
        signed_payload?: string;
        status: TransactionStatusEnum;
        transaction_hash?: string;
        unsigned_payload: string;
    }

    Properties

    interface Transaction {
        from_address_id: string;
        network_id: string;
        signed_payload?: string;
        status: TransactionStatusEnum;
        transaction_hash?: string;
        unsigned_payload: string;
    }

    Properties

    from_address_id: string

    The onchain address of the sender

    Memberof

    Transaction

    -
    network_id: string

    The ID of the blockchain network

    +
    network_id: string

    The ID of the blockchain network

    Memberof

    Transaction

    -
    signed_payload?: string

    The signed payload of the transaction. This is the payload that has been signed by the sender.

    +
    signed_payload?: string

    The signed payload of the transaction. This is the payload that has been signed by the sender.

    Memberof

    Transaction

    -

    The status of the transaction

    +

    The status of the transaction

    Memberof

    Transaction

    -
    transaction_hash?: string

    The hash of the transaction

    +
    transaction_hash?: string

    The hash of the transaction

    Memberof

    Transaction

    -
    unsigned_payload: string

    The unsigned payload of the transaction. This is the payload that needs to be signed by the sender.

    +
    unsigned_payload: string

    The unsigned payload of the transaction. This is the payload that needs to be signed by the sender.

    Memberof

    Transaction

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.Transfer.html b/docs/interfaces/client_api.Transfer.html index a912ba46..3e8c9058 100644 --- a/docs/interfaces/client_api.Transfer.html +++ b/docs/interfaces/client_api.Transfer.html @@ -1,6 +1,6 @@ Transfer | @coinbase/coinbase-sdk

    A transfer of an asset from one address to another

    Export

    Transfer

    -
    interface Transfer {
        address_id: string;
        amount: string;
        asset_id: string;
        destination: string;
        network_id: string;
        signed_payload?: string;
        status: TransferStatusEnum;
        transaction_hash?: string;
        transfer_id: string;
        unsigned_payload: string;
        wallet_id: string;
    }

    Properties

    interface Transfer {
        address_id: string;
        amount: string;
        asset_id: string;
        destination: string;
        network_id: string;
        signed_payload?: string;
        status: TransferStatusEnum;
        transaction_hash?: string;
        transfer_id: string;
        unsigned_payload: string;
        wallet_id: string;
    }

    Properties

    Properties

    address_id: string

    The onchain address of the sender

    Memberof

    Transfer

    -
    amount: string

    The amount in the atomic units of the asset

    +
    amount: string

    The amount in the atomic units of the asset

    Memberof

    Transfer

    -
    asset_id: string

    The ID of the asset being transferred

    +
    asset_id: string

    The ID of the asset being transferred

    Memberof

    Transfer

    -
    destination: string

    The onchain address of the recipient

    +
    destination: string

    The onchain address of the recipient

    Memberof

    Transfer

    -
    network_id: string

    The ID of the blockchain network

    +
    network_id: string

    The ID of the blockchain network

    Memberof

    Transfer

    -
    signed_payload?: string

    The signed payload of the transfer. This is the payload that has been signed by the sender.

    +
    signed_payload?: string

    The signed payload of the transfer. This is the payload that has been signed by the sender.

    Memberof

    Transfer

    -

    The status of the transfer

    +

    The status of the transfer

    Memberof

    Transfer

    -
    transaction_hash?: string

    The hash of the transfer transaction

    +
    transaction_hash?: string

    The hash of the transfer transaction

    Memberof

    Transfer

    -
    transfer_id: string

    The ID of the transfer

    +
    transfer_id: string

    The ID of the transfer

    Memberof

    Transfer

    -
    unsigned_payload: string

    The unsigned payload of the transfer. This is the payload that needs to be signed by the sender.

    +
    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: string

    The ID of the wallet that owns the from address

    +
    wallet_id: string

    The ID of the wallet that owns the from address

    Memberof

    Transfer

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.TransferList.html b/docs/interfaces/client_api.TransferList.html index 0d9d07e8..d7ae216d 100644 --- a/docs/interfaces/client_api.TransferList.html +++ b/docs/interfaces/client_api.TransferList.html @@ -1,13 +1,13 @@ TransferList | @coinbase/coinbase-sdk

    Export

    TransferList

    -
    interface TransferList {
        data: Transfer[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    interface TransferList {
        data: Transfer[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data: Transfer[]

    Memberof

    TransferList

    -
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    TransferList

    -
    next_page: string

    The page token to be used to fetch the next page.

    +
    next_page: string

    The page token to be used to fetch the next page.

    Memberof

    TransferList

    -
    total_count: number

    The total number of transfers for the address in the wallet.

    +
    total_count: number

    The total number of transfers for the address in the wallet.

    Memberof

    TransferList

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.TransfersApiInterface.html b/docs/interfaces/client_api.TransfersApiInterface.html index f59eb5f7..c5eb08e9 100644 --- a/docs/interfaces/client_api.TransfersApiInterface.html +++ b/docs/interfaces/client_api.TransfersApiInterface.html @@ -1,6 +1,6 @@ TransfersApiInterface | @coinbase/coinbase-sdk

    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

    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

  • broadcastTransferRequest: BroadcastTransferRequest
  • Optional options: RawAxiosRequestConfig

    Override http request option.

  • Returns AxiosPromise<Transfer>

    Summary

    Broadcast a transfer

    Throws

    Memberof

    TransfersApiInterface

    -
    • 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

      -
    • 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

      -
    • 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

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.User.html b/docs/interfaces/client_api.User.html index e50a3927..eaf92c80 100644 --- a/docs/interfaces/client_api.User.html +++ b/docs/interfaces/client_api.User.html @@ -1,7 +1,7 @@ User | @coinbase/coinbase-sdk

    Export

    User

    -
    interface User {
        display_name?: string;
        id: string;
    }

    Properties

    interface User {
        display_name?: string;
        id: string;
    }

    Properties

    Properties

    display_name?: string

    Memberof

    User

    -
    id: string

    The ID of the user

    +
    id: string

    The ID of the user

    Memberof

    User

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.UsersApiInterface.html b/docs/interfaces/client_api.UsersApiInterface.html index 16e913ae..0f0103dd 100644 --- a/docs/interfaces/client_api.UsersApiInterface.html +++ b/docs/interfaces/client_api.UsersApiInterface.html @@ -1,8 +1,8 @@ UsersApiInterface | @coinbase/coinbase-sdk

    UsersApi - interface

    Export

    UsersApi

    -
    interface UsersApiInterface {
        getCurrentUser(options?): AxiosPromise<User>;
    }

    Implemented by

    Methods

    interface UsersApiInterface {
        getCurrentUser(options?): AxiosPromise<User>;
    }

    Implemented by

    Methods

    • Get current user

      Parameters

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<User>

      Summary

      Get current user

      Throws

      Memberof

      UsersApiInterface

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.Wallet.html b/docs/interfaces/client_api.Wallet.html index 945389ea..e2c93fda 100644 --- a/docs/interfaces/client_api.Wallet.html +++ b/docs/interfaces/client_api.Wallet.html @@ -1,13 +1,13 @@ Wallet | @coinbase/coinbase-sdk

    Export

    Wallet

    -
    interface Wallet {
        default_address?: Address;
        id: string;
        network_id: string;
        server_signer_status?: WalletServerSignerStatusEnum;
    }

    Properties

    interface Wallet {
        default_address?: Address;
        id: string;
        network_id: string;
        server_signer_status?: WalletServerSignerStatusEnum;
    }

    Properties

    default_address?: Address

    Memberof

    Wallet

    -
    id: string

    The server-assigned ID for the wallet.

    +
    id: string

    The server-assigned ID for the wallet.

    Memberof

    Wallet

    -
    network_id: string

    The ID of the blockchain network

    +
    network_id: string

    The ID of the blockchain network

    Memberof

    Wallet

    -
    server_signer_status?: WalletServerSignerStatusEnum

    The status of the Server-Signer for the wallet if present.

    +
    server_signer_status?: WalletServerSignerStatusEnum

    The status of the Server-Signer for the wallet if present.

    Memberof

    Wallet

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.WalletList.html b/docs/interfaces/client_api.WalletList.html index b49623d3..4bb28232 100644 --- a/docs/interfaces/client_api.WalletList.html +++ b/docs/interfaces/client_api.WalletList.html @@ -1,14 +1,14 @@ WalletList | @coinbase/coinbase-sdk

    Paginated list of wallets

    Export

    WalletList

    -
    interface WalletList {
        data: Wallet[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    interface WalletList {
        data: Wallet[];
        has_more: boolean;
        next_page: string;
        total_count: number;
    }

    Properties

    data: Wallet[]

    Memberof

    WalletList

    -
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    +
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    Memberof

    WalletList

    -
    next_page: string

    The page token to be used to fetch the next page.

    +
    next_page: string

    The page token to be used to fetch the next page.

    Memberof

    WalletList

    -
    total_count: number

    The total number of wallets

    +
    total_count: number

    The total number of wallets

    Memberof

    WalletList

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_api.WalletsApiInterface.html b/docs/interfaces/client_api.WalletsApiInterface.html index 99a074c6..dd3ae7f2 100644 --- a/docs/interfaces/client_api.WalletsApiInterface.html +++ b/docs/interfaces/client_api.WalletsApiInterface.html @@ -1,6 +1,6 @@ WalletsApiInterface | @coinbase/coinbase-sdk

    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

    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

    Parameters

    • Optional createWalletRequest: CreateWalletRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<Wallet>

    Summary

    Create a new wallet

    Throws

    Memberof

    WalletsApiInterface

    -
    • 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

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

      +
    • 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

      -
    • 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

      -
    • 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

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/client_base.RequestArgs.html b/docs/interfaces/client_base.RequestArgs.html index 792e0f17..28524a9e 100644 --- a/docs/interfaces/client_base.RequestArgs.html +++ b/docs/interfaces/client_base.RequestArgs.html @@ -1,4 +1,4 @@ RequestArgs | @coinbase/coinbase-sdk

    Export

    RequestArgs

    -
    interface RequestArgs {
        options: RawAxiosRequestConfig;
        url: string;
    }

    Properties

    interface RequestArgs {
        options: RawAxiosRequestConfig;
        url: string;
    }

    Properties

    Properties

    options: RawAxiosRequestConfig
    url: string
    \ No newline at end of file +

    Properties

    options: RawAxiosRequestConfig
    url: string
    \ No newline at end of file diff --git a/docs/interfaces/client_configuration.ConfigurationParameters.html b/docs/interfaces/client_configuration.ConfigurationParameters.html index c9804725..76ed8d39 100644 --- a/docs/interfaces/client_configuration.ConfigurationParameters.html +++ b/docs/interfaces/client_configuration.ConfigurationParameters.html @@ -5,7 +5,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

    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?: 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>

    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>

    baseOptions?: any
    basePath?: string
    formDataCtor?: (new () => any)

    Type declaration

      • new (): any
      • Returns any

    password?: string
    serverIndex?: number
    username?: string
    \ No newline at end of file +

    Properties

    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>

    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>

    baseOptions?: any
    basePath?: string
    formDataCtor?: (new () => any)

    Type declaration

      • new (): any
      • Returns any

    password?: string
    serverIndex?: number
    username?: string
    \ No newline at end of file diff --git a/docs/modules/client.html b/docs/modules/client.html index ce24d242..6e695efa 100644 --- a/docs/modules/client.html +++ b/docs/modules/client.html @@ -1,4 +1,4 @@ -client | @coinbase/coinbase-sdk

    References

    Address +client | @coinbase/coinbase-sdk

    References

    Address AddressBalanceList AddressList AddressesApi diff --git a/docs/modules/client_api.html b/docs/modules/client_api.html index 1b4a9ace..0123bc0e 100644 --- a/docs/modules/client_api.html +++ b/docs/modules/client_api.html @@ -1,4 +1,4 @@ -client/api | @coinbase/coinbase-sdk

    Index

    Enumerations

    TransactionType +client/api | @coinbase/coinbase-sdk

    Index

    Enumerations

    Classes

    AddressesApi ServerSignersApi TradesApi diff --git a/docs/modules/client_base.html b/docs/modules/client_base.html index b0b93010..1d2bf5a5 100644 --- a/docs/modules/client_base.html +++ b/docs/modules/client_base.html @@ -1,4 +1,4 @@ -client/base | @coinbase/coinbase-sdk

    Index

    Classes

    BaseAPI +client/base | @coinbase/coinbase-sdk

    Index

    Classes

    Interfaces

    Variables

    BASE_PATH diff --git a/docs/modules/client_common.html b/docs/modules/client_common.html index 2ffc69cc..d7b1b3ca 100644 --- a/docs/modules/client_common.html +++ b/docs/modules/client_common.html @@ -1,4 +1,4 @@ -client/common | @coinbase/coinbase-sdk

    Index

    Variables

    DUMMY_BASE_URL +client/common | @coinbase/coinbase-sdk

    Index

    Variables

    Functions

    assertParamExists createRequestFunction serializeDataIfNeeded diff --git a/docs/modules/client_configuration.html b/docs/modules/client_configuration.html index 7e5bd7ae..1e8169f1 100644 --- a/docs/modules/client_configuration.html +++ b/docs/modules/client_configuration.html @@ -1,3 +1,3 @@ -client/configuration | @coinbase/coinbase-sdk

    Index

    Classes

    Configuration +client/configuration | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase.html b/docs/modules/coinbase.html index 3782ed8b..066c2d37 100644 --- a/docs/modules/coinbase.html +++ b/docs/modules/coinbase.html @@ -1,2 +1,2 @@ -coinbase | @coinbase/coinbase-sdk

    References

    Coinbase +coinbase | @coinbase/coinbase-sdk

    References

    References

    Re-exports Coinbase
    \ No newline at end of file diff --git a/docs/modules/coinbase_address.html b/docs/modules/coinbase_address.html index 3eb5e7da..6b3693d3 100644 --- a/docs/modules/coinbase_address.html +++ b/docs/modules/coinbase_address.html @@ -1,2 +1,2 @@ -coinbase/address | @coinbase/coinbase-sdk

    Index

    Classes

    Address +coinbase/address | @coinbase/coinbase-sdk

    Index

    Classes

    \ No newline at end of file diff --git a/docs/modules/coinbase_api_error.html b/docs/modules/coinbase_api_error.html index a922e234..0e53ae71 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

    Index

    Classes

    APIError +coinbase/api_error | @coinbase/coinbase-sdk

    Index

    Classes

    APIError AlreadyExistsError FaucetLimitReachedError InvalidAddressError diff --git a/docs/modules/coinbase_asset.html b/docs/modules/coinbase_asset.html index 8a892760..ddbaf1a6 100644 --- a/docs/modules/coinbase_asset.html +++ b/docs/modules/coinbase_asset.html @@ -1,2 +1,2 @@ -coinbase/asset | @coinbase/coinbase-sdk

    Index

    Classes

    Asset +coinbase/asset | @coinbase/coinbase-sdk

    Index

    Classes

    \ No newline at end of file diff --git a/docs/modules/coinbase_authenticator.html b/docs/modules/coinbase_authenticator.html index bbe01da3..a61646a9 100644 --- a/docs/modules/coinbase_authenticator.html +++ b/docs/modules/coinbase_authenticator.html @@ -1,2 +1,2 @@ -coinbase/authenticator | @coinbase/coinbase-sdk

    Index

    Classes

    CoinbaseAuthenticator +coinbase/authenticator | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_balance.html b/docs/modules/coinbase_balance.html index de7a70b8..0533551f 100644 --- a/docs/modules/coinbase_balance.html +++ b/docs/modules/coinbase_balance.html @@ -1,2 +1,2 @@ -coinbase/balance | @coinbase/coinbase-sdk

    Index

    Classes

    Balance +coinbase/balance | @coinbase/coinbase-sdk

    Index

    Classes

    \ No newline at end of file diff --git a/docs/modules/coinbase_balance_map.html b/docs/modules/coinbase_balance_map.html index 3a0f6904..2fbfc431 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

    Index

    Classes

    BalanceMap +coinbase/balance_map | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_coinbase.html b/docs/modules/coinbase_coinbase.html index fb4b2892..5a681b4e 100644 --- a/docs/modules/coinbase_coinbase.html +++ b/docs/modules/coinbase_coinbase.html @@ -1,2 +1,2 @@ -coinbase/coinbase | @coinbase/coinbase-sdk

    Index

    Classes

    Coinbase +coinbase/coinbase | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_constants.html b/docs/modules/coinbase_constants.html index ad2bd780..49c2ceaa 100644 --- a/docs/modules/coinbase_constants.html +++ b/docs/modules/coinbase_constants.html @@ -1,4 +1,4 @@ -coinbase/constants | @coinbase/coinbase-sdk

    Index

    Variables

    ATOMIC_UNITS_PER_USDC +coinbase/constants | @coinbase/coinbase-sdk

    Index

    Variables

    ATOMIC_UNITS_PER_USDC GWEI_PER_ETHER WEI_PER_ETHER WEI_PER_GWEI diff --git a/docs/modules/coinbase_errors.html b/docs/modules/coinbase_errors.html index 59247655..ff521ee0 100644 --- a/docs/modules/coinbase_errors.html +++ b/docs/modules/coinbase_errors.html @@ -1,4 +1,4 @@ -coinbase/errors | @coinbase/coinbase-sdk

    Index

    Classes

    ArgumentError +coinbase/errors | @coinbase/coinbase-sdk

    Index

    Classes

    ArgumentError InternalError InvalidAPIKeyFormat InvalidConfiguration diff --git a/docs/modules/coinbase_faucet_transaction.html b/docs/modules/coinbase_faucet_transaction.html index 4c7ada54..fd0c942a 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
    \ No newline at end of file diff --git a/docs/modules/coinbase_tests_address_test.html b/docs/modules/coinbase_tests_address_test.html index 55a37ad8..5bace8f8 100644 --- a/docs/modules/coinbase_tests_address_test.html +++ b/docs/modules/coinbase_tests_address_test.html @@ -1 +1 @@ -coinbase/tests/address_test | @coinbase/coinbase-sdk
    \ No newline at end of file +coinbase/tests/address_test | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_tests_authenticator_test.html b/docs/modules/coinbase_tests_authenticator_test.html index 9f45bb18..39848e07 100644 --- a/docs/modules/coinbase_tests_authenticator_test.html +++ b/docs/modules/coinbase_tests_authenticator_test.html @@ -1 +1 @@ -coinbase/tests/authenticator_test | @coinbase/coinbase-sdk
    \ No newline at end of file +coinbase/tests/authenticator_test | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_tests_balance_map_test.html b/docs/modules/coinbase_tests_balance_map_test.html index 97fe7dc6..92cb9d34 100644 --- a/docs/modules/coinbase_tests_balance_map_test.html +++ b/docs/modules/coinbase_tests_balance_map_test.html @@ -1 +1 @@ -coinbase/tests/balance_map_test | @coinbase/coinbase-sdk
    \ No newline at end of file +coinbase/tests/balance_map_test | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_tests_balance_test.html b/docs/modules/coinbase_tests_balance_test.html index aa6afb52..b207de36 100644 --- a/docs/modules/coinbase_tests_balance_test.html +++ b/docs/modules/coinbase_tests_balance_test.html @@ -1 +1 @@ -coinbase/tests/balance_test | @coinbase/coinbase-sdk
    \ No newline at end of file +coinbase/tests/balance_test | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_tests_coinbase_test.html b/docs/modules/coinbase_tests_coinbase_test.html index df29792d..1dbf4b5e 100644 --- a/docs/modules/coinbase_tests_coinbase_test.html +++ b/docs/modules/coinbase_tests_coinbase_test.html @@ -1 +1 @@ -coinbase/tests/coinbase_test | @coinbase/coinbase-sdk
    \ No newline at end of file +coinbase/tests/coinbase_test | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_tests_faucet_transaction_test.html b/docs/modules/coinbase_tests_faucet_transaction_test.html index 951d7810..5c5ea7ac 100644 --- a/docs/modules/coinbase_tests_faucet_transaction_test.html +++ b/docs/modules/coinbase_tests_faucet_transaction_test.html @@ -1 +1 @@ -coinbase/tests/faucet_transaction_test | @coinbase/coinbase-sdk
    \ No newline at end of file +coinbase/tests/faucet_transaction_test | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_tests_transfer_test.html b/docs/modules/coinbase_tests_transfer_test.html index e7162d47..94a3b67b 100644 --- a/docs/modules/coinbase_tests_transfer_test.html +++ b/docs/modules/coinbase_tests_transfer_test.html @@ -1 +1 @@ -coinbase/tests/transfer_test | @coinbase/coinbase-sdk
    \ No newline at end of file +coinbase/tests/transfer_test | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_tests_user_test.html b/docs/modules/coinbase_tests_user_test.html index 70f6c7ce..b7d8f052 100644 --- a/docs/modules/coinbase_tests_user_test.html +++ b/docs/modules/coinbase_tests_user_test.html @@ -1 +1 @@ -coinbase/tests/user_test | @coinbase/coinbase-sdk
    \ No newline at end of file +coinbase/tests/user_test | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_tests_utils.html b/docs/modules/coinbase_tests_utils.html index b5825538..80661a21 100644 --- a/docs/modules/coinbase_tests_utils.html +++ b/docs/modules/coinbase_tests_utils.html @@ -1,4 +1,4 @@ -coinbase/tests/utils | @coinbase/coinbase-sdk

    Index

    Variables

    VALID_ADDRESS_BALANCE_LIST +coinbase/tests/utils | @coinbase/coinbase-sdk

    Index

    Variables

    VALID_ADDRESS_BALANCE_LIST VALID_ADDRESS_MODEL VALID_BALANCE_MODEL VALID_TRANSFER_MODEL diff --git a/docs/modules/coinbase_tests_wallet_test.html b/docs/modules/coinbase_tests_wallet_test.html index b6477a66..1b0c8ef6 100644 --- a/docs/modules/coinbase_tests_wallet_test.html +++ b/docs/modules/coinbase_tests_wallet_test.html @@ -1 +1 @@ -coinbase/tests/wallet_test | @coinbase/coinbase-sdk
    \ No newline at end of file +coinbase/tests/wallet_test | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_transfer.html b/docs/modules/coinbase_transfer.html index 24830e76..e23c086e 100644 --- a/docs/modules/coinbase_transfer.html +++ b/docs/modules/coinbase_transfer.html @@ -1,2 +1,2 @@ -coinbase/transfer | @coinbase/coinbase-sdk

    Index

    Classes

    Transfer +coinbase/transfer | @coinbase/coinbase-sdk
    \ No newline at end of file diff --git a/docs/modules/coinbase_types.html b/docs/modules/coinbase_types.html index 46a04965..5eced311 100644 --- a/docs/modules/coinbase_types.html +++ b/docs/modules/coinbase_types.html @@ -1,4 +1,4 @@ -coinbase/types | @coinbase/coinbase-sdk

    Index

    Enumerations

    ServerSignerStatus +coinbase/types | @coinbase/coinbase-sdk

    Index

    Enumerations

    Type Aliases

    AddressAPIClient Amount diff --git a/docs/modules/coinbase_user.html b/docs/modules/coinbase_user.html index 486f6e74..b204e2dc 100644 --- a/docs/modules/coinbase_user.html +++ b/docs/modules/coinbase_user.html @@ -1,2 +1,2 @@ -coinbase/user | @coinbase/coinbase-sdk

    Index

    Classes

    User +coinbase/user | @coinbase/coinbase-sdk

    Index

    Classes

    \ No newline at end of file diff --git a/docs/modules/coinbase_utils.html b/docs/modules/coinbase_utils.html index db9bdad6..5869418e 100644 --- a/docs/modules/coinbase_utils.html +++ b/docs/modules/coinbase_utils.html @@ -1,4 +1,4 @@ -coinbase/utils | @coinbase/coinbase-sdk

    Index

    Functions

    convertStringToHex +coinbase/utils | @coinbase/coinbase-sdk

    Index

    Functions

    convertStringToHex delay destinationToAddressHexString logApiResponse diff --git a/docs/modules/coinbase_wallet.html b/docs/modules/coinbase_wallet.html index 4a427e39..56b25bfa 100644 --- a/docs/modules/coinbase_wallet.html +++ b/docs/modules/coinbase_wallet.html @@ -1,2 +1,2 @@ -coinbase/wallet | @coinbase/coinbase-sdk

    Index

    Classes

    Wallet +coinbase/wallet | @coinbase/coinbase-sdk

    Index

    Classes

    \ No newline at end of file diff --git a/docs/modules/index.html b/docs/modules/index.html index f4308cf3..ecee1e8c 100644 --- a/docs/modules/index.html +++ b/docs/modules/index.html @@ -1,2 +1,2 @@ -index | @coinbase/coinbase-sdk

    References

    Coinbase +index | @coinbase/coinbase-sdk

    References

    References

    Re-exports Coinbase
    \ No newline at end of file diff --git a/docs/types/client_api.ServerSignerEventEvent.html b/docs/types/client_api.ServerSignerEventEvent.html index c9b782fb..6690efc1 100644 --- a/docs/types/client_api.ServerSignerEventEvent.html +++ b/docs/types/client_api.ServerSignerEventEvent.html @@ -1 +1 @@ -ServerSignerEventEvent | @coinbase/coinbase-sdk
    ServerSignerEventEvent: SeedCreationEvent | SignatureCreationEvent

    Export

    \ No newline at end of file +ServerSignerEventEvent | @coinbase/coinbase-sdk
    ServerSignerEventEvent: SeedCreationEvent | SignatureCreationEvent

    Export

    \ No newline at end of file diff --git a/docs/types/client_api.TransactionStatusEnum.html b/docs/types/client_api.TransactionStatusEnum.html index 65386eae..c24b9602 100644 --- a/docs/types/client_api.TransactionStatusEnum.html +++ b/docs/types/client_api.TransactionStatusEnum.html @@ -1 +1 @@ -TransactionStatusEnum | @coinbase/coinbase-sdk
    TransactionStatusEnum: typeof TransactionStatusEnum[keyof typeof TransactionStatusEnum]
    \ No newline at end of file +TransactionStatusEnum | @coinbase/coinbase-sdk
    TransactionStatusEnum: typeof TransactionStatusEnum[keyof typeof TransactionStatusEnum]
    \ No newline at end of file diff --git a/docs/types/client_api.TransferStatusEnum.html b/docs/types/client_api.TransferStatusEnum.html index de9f29d8..a6ef235f 100644 --- a/docs/types/client_api.TransferStatusEnum.html +++ b/docs/types/client_api.TransferStatusEnum.html @@ -1 +1 @@ -TransferStatusEnum | @coinbase/coinbase-sdk
    TransferStatusEnum: typeof TransferStatusEnum[keyof typeof TransferStatusEnum]
    \ No newline at end of file +TransferStatusEnum | @coinbase/coinbase-sdk
    TransferStatusEnum: typeof TransferStatusEnum[keyof typeof TransferStatusEnum]
    \ No newline at end of file diff --git a/docs/types/client_api.WalletServerSignerStatusEnum.html b/docs/types/client_api.WalletServerSignerStatusEnum.html index ab1657f5..6522303f 100644 --- a/docs/types/client_api.WalletServerSignerStatusEnum.html +++ b/docs/types/client_api.WalletServerSignerStatusEnum.html @@ -1 +1 @@ -WalletServerSignerStatusEnum | @coinbase/coinbase-sdk
    WalletServerSignerStatusEnum: typeof WalletServerSignerStatusEnum[keyof typeof WalletServerSignerStatusEnum]
    \ No newline at end of file +WalletServerSignerStatusEnum | @coinbase/coinbase-sdk
    WalletServerSignerStatusEnum: typeof WalletServerSignerStatusEnum[keyof typeof WalletServerSignerStatusEnum]
    \ No newline at end of file diff --git a/docs/types/coinbase_types.AddressAPIClient.html b/docs/types/coinbase_types.AddressAPIClient.html index 164b4bb0..b9c61a11 100644 --- a/docs/types/coinbase_types.AddressAPIClient.html +++ b/docs/types/coinbase_types.AddressAPIClient.html @@ -1,30 +1,30 @@ AddressAPIClient | @coinbase/coinbase-sdk
    AddressAPIClient: {
        createAddress(walletId, createAddressRequest?, options?): AxiosPromise<Address>;
        getAddress(walletId, addressId, options?): AxiosPromise<Address>;
        getAddressBalance(walletId, addressId, assetId, options?): AxiosPromise<Balance>;
        listAddressBalances(walletId, addressId, page?, options?): AxiosPromise<AddressBalanceList>;
        listAddresses(walletId, limit?, page?, options?): AxiosPromise<AddressList>;
        requestFaucetFunds(walletId, addressId): Promise<{
            data: {
                transaction_hash: string;
            };
        }>;
    }

    AddressAPI client type definition.

    -

    Type declaration

    • createAddress:function
    • getAddress:function
      • Get address by onchain address.

        +

        Type declaration

        • createAddress:function
        • getAddress:function
          • 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
          • 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

        • listAddressBalances:function
          • Lists address balances

            +

        Returns AxiosPromise<Balance>

        Throws

    • listAddressBalances:function
      • 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
      • Lists addresses.

        +

    Returns AxiosPromise<AddressBalanceList>

    Throws

  • listAddresses:function
    • 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.

      -
  • requestFaucetFunds:function
    • Requests faucet funds for the address.

      +
  • requestFaucetFunds:function
    • Requests faucet funds for the address.

      Parameters

      • walletId: string

        The wallet ID.

      • addressId: string

        The address ID.

      Returns Promise<{
          data: {
              transaction_hash: string;
          };
      }>

      The transaction hash.

      Throws

      If the request fails.

      -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/coinbase_types.Amount.html b/docs/types/coinbase_types.Amount.html index c608f6f2..67b5aed6 100644 --- a/docs/types/coinbase_types.Amount.html +++ b/docs/types/coinbase_types.Amount.html @@ -1,2 +1,2 @@ Amount | @coinbase/coinbase-sdk
    Amount: number | bigint | Decimal

    Amount type definition.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/coinbase_types.ApiClients.html b/docs/types/coinbase_types.ApiClients.html index 701ca705..947bb07e 100644 --- a/docs/types/coinbase_types.ApiClients.html +++ b/docs/types/coinbase_types.ApiClients.html @@ -1,3 +1,3 @@ ApiClients | @coinbase/coinbase-sdk
    ApiClients: {
        address?: AddressAPIClient;
        transfer?: TransferAPIClient;
        user?: UserAPIClient;
        wallet?: WalletAPIClient;
    }

    API clients type definition for the Coinbase SDK. Represents the set of API clients available in the SDK.

    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/docs/types/coinbase_types.CoinbaseConfigureFromJsonOptions.html b/docs/types/coinbase_types.CoinbaseConfigureFromJsonOptions.html index c522a0e0..62e771c8 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.

  • 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.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/coinbase_types.CoinbaseOptions.html b/docs/types/coinbase_types.CoinbaseOptions.html index 0e98c14a..cf050fa1 100644 --- a/docs/types/coinbase_types.CoinbaseOptions.html +++ b/docs/types/coinbase_types.CoinbaseOptions.html @@ -4,4 +4,4 @@
  • Optional debugging?: boolean

    If true, logs API requests and responses to the console.

  • Optional privateKey?: string

    The private key associated with the API key.

  • Optional useServerSigner?: boolean

    Whether to use a Server-Signer or not.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/coinbase_types.Destination.html b/docs/types/coinbase_types.Destination.html index dc521967..e3561210 100644 --- a/docs/types/coinbase_types.Destination.html +++ b/docs/types/coinbase_types.Destination.html @@ -1,2 +1,2 @@ Destination | @coinbase/coinbase-sdk
    Destination: string | Address | Wallet

    Destination type definition.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/coinbase_types.SeedData.html b/docs/types/coinbase_types.SeedData.html index fb380018..2be890d8 100644 --- a/docs/types/coinbase_types.SeedData.html +++ b/docs/types/coinbase_types.SeedData.html @@ -1,2 +1,2 @@ SeedData | @coinbase/coinbase-sdk
    SeedData: {
        authTag: string;
        encrypted: boolean;
        iv: string;
        seed: string;
    }

    The Seed Data type definition.

    -

    Type declaration

    • authTag: string
    • encrypted: boolean
    • iv: string
    • seed: string
    \ No newline at end of file +

    Type declaration

    • authTag: string
    • encrypted: boolean
    • iv: string
    • seed: string
    \ No newline at end of file diff --git a/docs/types/coinbase_types.TransferAPIClient.html b/docs/types/coinbase_types.TransferAPIClient.html index df375867..3e0cca79 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
    • 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
    • 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
    • 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.

      -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/coinbase_types.UserAPIClient.html b/docs/types/coinbase_types.UserAPIClient.html index 2ee8a1d3..5d50af4d 100644 --- a/docs/types/coinbase_types.UserAPIClient.html +++ b/docs/types/coinbase_types.UserAPIClient.html @@ -5,4 +5,4 @@
  • A promise resolvindg to the User model.
  • Throws

    If the request fails.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/coinbase_types.WalletAPIClient.html b/docs/types/coinbase_types.WalletAPIClient.html index 5a649d4e..d8c49986 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
    • 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>

      Throws

      If the required parameter is not provided.

      Throws

      If the request fails.

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

      +
    • 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>

      Throws

      If the required parameter is not provided.

      Throws

      If the request fails.

      -
  • listWallets:function
  • listWallets:function
    • 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>

      Throws

      If the request fails.

      Throws

      If the required parameter is not provided.

      -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/coinbase_types.WalletData.html b/docs/types/coinbase_types.WalletData.html index 838df144..de480031 100644 --- a/docs/types/coinbase_types.WalletData.html +++ b/docs/types/coinbase_types.WalletData.html @@ -1,3 +1,3 @@ WalletData | @coinbase/coinbase-sdk
    WalletData: {
        seed: string;
        walletId: string;
    }

    The Wallet Data type definition. The data required to recreate a Wallet.

    -

    Type declaration

    • seed: string
    • walletId: string
    \ No newline at end of file +

    Type declaration

    • seed: string
    • walletId: string
    \ 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 dfbe52bc..0ad44ff2 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";
    } = ...

    Type declaration

    • Readonly Broadcast: "broadcast"
    • Readonly Complete: "complete"
    • Readonly Failed: "failed"
    • Readonly Pending: "pending"
    \ No newline at end of file +TransactionStatusEnum | @coinbase/coinbase-sdk

    Variable TransactionStatusEnumConst

    TransactionStatusEnum: {
        Broadcast: "broadcast";
        Complete: "complete";
        Failed: "failed";
        Pending: "pending";
    } = ...

    Type declaration

    • Readonly Broadcast: "broadcast"
    • Readonly Complete: "complete"
    • Readonly Failed: "failed"
    • Readonly Pending: "pending"
    \ 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 aa84b3f0..9a906b59 100644 --- a/docs/variables/client_api.TransferStatusEnum-1.html +++ b/docs/variables/client_api.TransferStatusEnum-1.html @@ -1 +1 @@ -TransferStatusEnum | @coinbase/coinbase-sdk
    TransferStatusEnum: {
        Broadcast: "broadcast";
        Complete: "complete";
        Failed: "failed";
        Pending: "pending";
    } = ...

    Type declaration

    • Readonly Broadcast: "broadcast"
    • Readonly Complete: "complete"
    • Readonly Failed: "failed"
    • Readonly Pending: "pending"
    \ No newline at end of file +TransferStatusEnum | @coinbase/coinbase-sdk
    TransferStatusEnum: {
        Broadcast: "broadcast";
        Complete: "complete";
        Failed: "failed";
        Pending: "pending";
    } = ...

    Type declaration

    • Readonly Broadcast: "broadcast"
    • Readonly Complete: "complete"
    • Readonly Failed: "failed"
    • Readonly Pending: "pending"
    \ 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 ce9f712d..257d417e 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"
    \ 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"
    \ 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 ae4a2ee8..3609e83d 100644 --- a/docs/variables/client_base.BASE_PATH.html +++ b/docs/variables/client_base.BASE_PATH.html @@ -1 +1 @@ -BASE_PATH | @coinbase/coinbase-sdk
    BASE_PATH: string = ...
    \ No newline at end of file +BASE_PATH | @coinbase/coinbase-sdk
    BASE_PATH: string = ...
    \ 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 8b589b67..809a5679 100644 --- a/docs/variables/client_base.COLLECTION_FORMATS.html +++ b/docs/variables/client_base.COLLECTION_FORMATS.html @@ -1 +1 @@ -COLLECTION_FORMATS | @coinbase/coinbase-sdk
    COLLECTION_FORMATS: {
        csv: string;
        pipes: string;
        ssv: string;
        tsv: string;
    } = ...

    Type declaration

    • csv: string
    • pipes: string
    • ssv: string
    • tsv: string

    Export

    \ No newline at end of file +COLLECTION_FORMATS | @coinbase/coinbase-sdk
    COLLECTION_FORMATS: {
        csv: string;
        pipes: string;
        ssv: string;
        tsv: string;
    } = ...

    Type declaration

    • csv: string
    • pipes: string
    • ssv: string
    • tsv: string

    Export

    \ No newline at end of file diff --git a/docs/variables/client_base.operationServerMap.html b/docs/variables/client_base.operationServerMap.html index a736ba5b..63f1c9b9 100644 --- a/docs/variables/client_base.operationServerMap.html +++ b/docs/variables/client_base.operationServerMap.html @@ -1 +1 @@ -operationServerMap | @coinbase/coinbase-sdk
    operationServerMap: ServerMap = {}

    Export

    \ No newline at end of file +operationServerMap | @coinbase/coinbase-sdk
    operationServerMap: ServerMap = {}

    Export

    \ 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 4f45b59f..55864616 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
    DUMMY_BASE_URL: "https://example.com" = "https://example.com"

    Export

    \ No newline at end of file +DUMMY_BASE_URL | @coinbase/coinbase-sdk
    DUMMY_BASE_URL: "https://example.com" = "https://example.com"

    Export

    \ No newline at end of file diff --git a/docs/variables/coinbase_constants.ATOMIC_UNITS_PER_USDC.html b/docs/variables/coinbase_constants.ATOMIC_UNITS_PER_USDC.html index 561de740..a396ad4f 100644 --- a/docs/variables/coinbase_constants.ATOMIC_UNITS_PER_USDC.html +++ b/docs/variables/coinbase_constants.ATOMIC_UNITS_PER_USDC.html @@ -1 +1 @@ -ATOMIC_UNITS_PER_USDC | @coinbase/coinbase-sdk
    ATOMIC_UNITS_PER_USDC: Decimal = ...
    \ No newline at end of file +ATOMIC_UNITS_PER_USDC | @coinbase/coinbase-sdk
    ATOMIC_UNITS_PER_USDC: Decimal = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_constants.GWEI_PER_ETHER.html b/docs/variables/coinbase_constants.GWEI_PER_ETHER.html index e37914ed..ad5f39ef 100644 --- a/docs/variables/coinbase_constants.GWEI_PER_ETHER.html +++ b/docs/variables/coinbase_constants.GWEI_PER_ETHER.html @@ -1 +1 @@ -GWEI_PER_ETHER | @coinbase/coinbase-sdk
    GWEI_PER_ETHER: Decimal = ...
    \ No newline at end of file +GWEI_PER_ETHER | @coinbase/coinbase-sdk
    GWEI_PER_ETHER: Decimal = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_constants.WEI_PER_ETHER.html b/docs/variables/coinbase_constants.WEI_PER_ETHER.html index fc4355be..7d750a4f 100644 --- a/docs/variables/coinbase_constants.WEI_PER_ETHER.html +++ b/docs/variables/coinbase_constants.WEI_PER_ETHER.html @@ -1 +1 @@ -WEI_PER_ETHER | @coinbase/coinbase-sdk
    WEI_PER_ETHER: Decimal = ...
    \ No newline at end of file +WEI_PER_ETHER | @coinbase/coinbase-sdk
    WEI_PER_ETHER: Decimal = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_constants.WEI_PER_GWEI.html b/docs/variables/coinbase_constants.WEI_PER_GWEI.html index a15cf1e9..37f35644 100644 --- a/docs/variables/coinbase_constants.WEI_PER_GWEI.html +++ b/docs/variables/coinbase_constants.WEI_PER_GWEI.html @@ -1 +1 @@ -WEI_PER_GWEI | @coinbase/coinbase-sdk
    WEI_PER_GWEI: Decimal = ...
    \ No newline at end of file +WEI_PER_GWEI | @coinbase/coinbase-sdk
    WEI_PER_GWEI: Decimal = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.VALID_ADDRESS_BALANCE_LIST.html b/docs/variables/coinbase_tests_utils.VALID_ADDRESS_BALANCE_LIST.html index f1435c24..4b2ccc43 100644 --- a/docs/variables/coinbase_tests_utils.VALID_ADDRESS_BALANCE_LIST.html +++ b/docs/variables/coinbase_tests_utils.VALID_ADDRESS_BALANCE_LIST.html @@ -1 +1 @@ -VALID_ADDRESS_BALANCE_LIST | @coinbase/coinbase-sdk
    VALID_ADDRESS_BALANCE_LIST: AddressBalanceList = ...
    \ No newline at end of file +VALID_ADDRESS_BALANCE_LIST | @coinbase/coinbase-sdk
    VALID_ADDRESS_BALANCE_LIST: AddressBalanceList = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.VALID_ADDRESS_MODEL.html b/docs/variables/coinbase_tests_utils.VALID_ADDRESS_MODEL.html index 06fc204c..ce8d6e0c 100644 --- a/docs/variables/coinbase_tests_utils.VALID_ADDRESS_MODEL.html +++ b/docs/variables/coinbase_tests_utils.VALID_ADDRESS_MODEL.html @@ -1 +1 @@ -VALID_ADDRESS_MODEL | @coinbase/coinbase-sdk
    VALID_ADDRESS_MODEL: Address = ...
    \ No newline at end of file +VALID_ADDRESS_MODEL | @coinbase/coinbase-sdk
    VALID_ADDRESS_MODEL: Address = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.VALID_BALANCE_MODEL.html b/docs/variables/coinbase_tests_utils.VALID_BALANCE_MODEL.html index b9678e93..648f2c72 100644 --- a/docs/variables/coinbase_tests_utils.VALID_BALANCE_MODEL.html +++ b/docs/variables/coinbase_tests_utils.VALID_BALANCE_MODEL.html @@ -1 +1 @@ -VALID_BALANCE_MODEL | @coinbase/coinbase-sdk
    VALID_BALANCE_MODEL: Balance = ...
    \ No newline at end of file +VALID_BALANCE_MODEL | @coinbase/coinbase-sdk
    VALID_BALANCE_MODEL: Balance = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.VALID_TRANSFER_MODEL.html b/docs/variables/coinbase_tests_utils.VALID_TRANSFER_MODEL.html index 947c42d9..bd8f53fd 100644 --- a/docs/variables/coinbase_tests_utils.VALID_TRANSFER_MODEL.html +++ b/docs/variables/coinbase_tests_utils.VALID_TRANSFER_MODEL.html @@ -1 +1 @@ -VALID_TRANSFER_MODEL | @coinbase/coinbase-sdk
    VALID_TRANSFER_MODEL: Transfer = ...
    \ No newline at end of file +VALID_TRANSFER_MODEL | @coinbase/coinbase-sdk
    VALID_TRANSFER_MODEL: Transfer = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.VALID_WALLET_MODEL.html b/docs/variables/coinbase_tests_utils.VALID_WALLET_MODEL.html index 3943281e..0d0e3f0a 100644 --- a/docs/variables/coinbase_tests_utils.VALID_WALLET_MODEL.html +++ b/docs/variables/coinbase_tests_utils.VALID_WALLET_MODEL.html @@ -1 +1 @@ -VALID_WALLET_MODEL | @coinbase/coinbase-sdk
    VALID_WALLET_MODEL: Wallet = ...
    \ No newline at end of file +VALID_WALLET_MODEL | @coinbase/coinbase-sdk
    VALID_WALLET_MODEL: Wallet = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.addressesApiMock.html b/docs/variables/coinbase_tests_utils.addressesApiMock.html index 807c1a35..c0dcee05 100644 --- a/docs/variables/coinbase_tests_utils.addressesApiMock.html +++ b/docs/variables/coinbase_tests_utils.addressesApiMock.html @@ -1 +1 @@ -addressesApiMock | @coinbase/coinbase-sdk
    addressesApiMock: {
        createAddress: Mock<any, any, any>;
        getAddress: Mock<any, any, any>;
        getAddressBalance: Mock<any, any, any>;
        listAddressBalances: Mock<any, any, any>;
        listAddresses: Mock<any, any, any>;
        requestFaucetFunds: Mock<any, any, any>;
    } = ...

    Type declaration

    • createAddress: Mock<any, any, any>
    • getAddress: Mock<any, any, any>
    • getAddressBalance: Mock<any, any, any>
    • listAddressBalances: Mock<any, any, any>
    • listAddresses: Mock<any, any, any>
    • requestFaucetFunds: Mock<any, any, any>
    \ No newline at end of file +addressesApiMock | @coinbase/coinbase-sdk
    addressesApiMock: {
        createAddress: Mock<any, any, any>;
        getAddress: Mock<any, any, any>;
        getAddressBalance: Mock<any, any, any>;
        listAddressBalances: Mock<any, any, any>;
        listAddresses: Mock<any, any, any>;
        requestFaucetFunds: Mock<any, any, any>;
    } = ...

    Type declaration

    • createAddress: Mock<any, any, any>
    • getAddress: Mock<any, any, any>
    • getAddressBalance: Mock<any, any, any>
    • listAddressBalances: Mock<any, any, any>
    • listAddresses: Mock<any, any, any>
    • requestFaucetFunds: Mock<any, any, any>
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.transferId.html b/docs/variables/coinbase_tests_utils.transferId.html index 56f2ad27..7f9a5e0d 100644 --- a/docs/variables/coinbase_tests_utils.transferId.html +++ b/docs/variables/coinbase_tests_utils.transferId.html @@ -1 +1 @@ -transferId | @coinbase/coinbase-sdk
    transferId: `${string}-${string}-${string}-${string}-${string}` = ...
    \ No newline at end of file +transferId | @coinbase/coinbase-sdk
    transferId: `${string}-${string}-${string}-${string}-${string}` = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.transfersApiMock.html b/docs/variables/coinbase_tests_utils.transfersApiMock.html index 02b67a91..82f486c0 100644 --- a/docs/variables/coinbase_tests_utils.transfersApiMock.html +++ b/docs/variables/coinbase_tests_utils.transfersApiMock.html @@ -1 +1 @@ -transfersApiMock | @coinbase/coinbase-sdk
    transfersApiMock: {
        broadcastTransfer: Mock<any, any, any>;
        createTransfer: Mock<any, any, any>;
        getTransfer: Mock<any, any, any>;
        listTransfers: Mock<any, any, any>;
    } = ...

    Type declaration

    • broadcastTransfer: Mock<any, any, any>
    • createTransfer: Mock<any, any, any>
    • getTransfer: Mock<any, any, any>
    • listTransfers: Mock<any, any, any>
    \ No newline at end of file +transfersApiMock | @coinbase/coinbase-sdk
    transfersApiMock: {
        broadcastTransfer: Mock<any, any, any>;
        createTransfer: Mock<any, any, any>;
        getTransfer: Mock<any, any, any>;
        listTransfers: Mock<any, any, any>;
    } = ...

    Type declaration

    • broadcastTransfer: Mock<any, any, any>
    • createTransfer: Mock<any, any, any>
    • getTransfer: Mock<any, any, any>
    • listTransfers: Mock<any, any, any>
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.usersApiMock.html b/docs/variables/coinbase_tests_utils.usersApiMock.html index ef395d96..b244cc2b 100644 --- a/docs/variables/coinbase_tests_utils.usersApiMock.html +++ b/docs/variables/coinbase_tests_utils.usersApiMock.html @@ -1 +1 @@ -usersApiMock | @coinbase/coinbase-sdk
    usersApiMock: {
        getCurrentUser: Mock<any, any, any>;
    } = ...

    Type declaration

    • getCurrentUser: Mock<any, any, any>
    \ No newline at end of file +usersApiMock | @coinbase/coinbase-sdk
    usersApiMock: {
        getCurrentUser: Mock<any, any, any>;
    } = ...

    Type declaration

    • getCurrentUser: Mock<any, any, any>
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.walletId.html b/docs/variables/coinbase_tests_utils.walletId.html index 2ddb133f..af596a2f 100644 --- a/docs/variables/coinbase_tests_utils.walletId.html +++ b/docs/variables/coinbase_tests_utils.walletId.html @@ -1 +1 @@ -walletId | @coinbase/coinbase-sdk
    walletId: `${string}-${string}-${string}-${string}-${string}` = ...
    \ No newline at end of file +walletId | @coinbase/coinbase-sdk
    walletId: `${string}-${string}-${string}-${string}-${string}` = ...
    \ No newline at end of file diff --git a/docs/variables/coinbase_tests_utils.walletsApiMock.html b/docs/variables/coinbase_tests_utils.walletsApiMock.html index 5499e322..cd36729f 100644 --- a/docs/variables/coinbase_tests_utils.walletsApiMock.html +++ b/docs/variables/coinbase_tests_utils.walletsApiMock.html @@ -1 +1 @@ -walletsApiMock | @coinbase/coinbase-sdk
    walletsApiMock: {
        createWallet: Mock<any, any, any>;
        getWallet: Mock<any, any, any>;
        getWalletBalance: Mock<any, any, any>;
        listWalletBalances: Mock<any, any, any>;
        listWallets: Mock<any, any, any>;
    } = ...

    Type declaration

    • createWallet: Mock<any, any, any>
    • getWallet: Mock<any, any, any>
    • getWalletBalance: Mock<any, any, any>
    • listWalletBalances: Mock<any, any, any>
    • listWallets: Mock<any, any, any>
    \ No newline at end of file +walletsApiMock | @coinbase/coinbase-sdk
    walletsApiMock: {
        createWallet: Mock<any, any, any>;
        getWallet: Mock<any, any, any>;
        getWalletBalance: Mock<any, any, any>;
        listWalletBalances: Mock<any, any, any>;
        listWallets: Mock<any, any, any>;
    } = ...

    Type declaration

    • createWallet: Mock<any, any, any>
    • getWallet: Mock<any, any, any>
    • getWalletBalance: Mock<any, any, any>
    • listWalletBalances: Mock<any, any, any>
    • listWallets: Mock<any, any, any>
    \ No newline at end of file diff --git a/src/coinbase/coinbase.ts b/src/coinbase/coinbase.ts index 990e93fb..48b2009b 100644 --- a/src/coinbase/coinbase.ts +++ b/src/coinbase/coinbase.ts @@ -63,6 +63,11 @@ export class Coinbase { * * @class * @param options - The constructor options. + * @param options.apiKeyName - The API key name. + * @param options.privateKey - The private key associated with the API key. + * @param options.useServerSigner - Whether to use a Server-Signer or not. + * @param options.debugging - If true, logs API requests and responses to the console. + * @param options.basePath - The base path for the API. * @throws {InternalError} If the configuration is invalid. * @throws {InvalidAPIKeyFormat} If not able to create JWT token. */ @@ -102,6 +107,10 @@ export class Coinbase { * Reads the API key and private key from a JSON file and initializes the Coinbase SDK. * * @param options - The configuration options. + * @param options.filePath - The path to the JSON file containing the API key and private key. + * @param options.useServerSigner - Whether to use a Server-Signer or not. + * @param options.debugging - If true, logs API requests and responses to the console. + * @param options.basePath - The base path for the API. * @returns A new instance of the Coinbase SDK. * @throws {InvalidAPIKeyFormat} If the file does not exist or the configuration values are missing/invalid. * @throws {InvalidConfiguration} If the configuration is invalid.