@coinbase-sample/prime-sdk-ts 0.2.1 → 0.3.1

package/dist/types/model/MarginAddOn.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+import { MarginAddOnType } from './enums/MarginAddOnType';
+export type MarginAddOn = {
+    /**
+     * margin add on amount
+     */
+    amount?: string;
+    addOnType?: MarginAddOnType;
+};

package/dist/types/model/MarginCallRecord.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+export type MarginCallRecord = {
+    /**
+     * The unique ID of the margin call
+     */
+    marginCallId?: string;
+    /**
+     * The initial margin call amount in notional value
+     */
+    initialNotionalAmount?: string;
+    /**
+     * The outstanding margin call amount in notional value
+     */
+    outstandingNotionalAmount?: string;
+    /**
+     * The time the margin call is created in RFC3330 format
+     */
+    createdAt?: string;
+    /**
+     * The time the margin call is due in RFC3339 format
+     */
+    dueAt?: string;
+};

package/dist/{model/AddressEntry.d.ts → types/model/MarginInformation.d.ts}

@@ -17,11 +17,12 @@
  *
  *  Do not edit the class manually.
  */
-export type AddressEntry = {
-    name?: string;
-    address?: string;
+import { MarginCallRecord } from './MarginCallRecord';
+import { MarginSummary } from './MarginSummary';
+export type MarginInformation = {
     /**
-     * List of compatible chain IDs for a given address, empty for Solana. Ex: 1 for ETH Mainnet or 8453 for Base. Find more [here](https://chainlist.org/).
+     * The current margin call records
      */
-    chainIds?: Array<string>;
+    marginCallRecords?: Array<MarginCallRecord>;
+    marginSummary?: MarginSummary;
 };

package/dist/types/model/MarginSummary.d.ts

@@ -0,0 +1,151 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+import { AssetBalance } from './AssetBalance';
+import { LoanInfo } from './LoanInfo';
+import { MarginAddOn } from './MarginAddOn';
+import { MarketRate } from './MarketRate';
+import { PMAssetInfo } from './PMAssetInfo';
+export type MarginSummary = {
+    /**
+     * The unique ID of the entity
+     */
+    entityId?: string;
+    /**
+     * The margin equity at the entity level. Margin Equity = LMV + SMV + Trading Cash Balance + Short Collateral - Pending Withdrawals
+     */
+    marginEquity?: string;
+    /**
+     * USD notional value of required equity in entity portfolios
+     */
+    marginRequirement?: string;
+    /**
+     * margin_equity - margin_requirement
+     */
+    excessDeficit?: string;
+    /**
+     * The raw amount of portfolio margin credit used
+     */
+    pmCreditConsumed?: string;
+    /**
+     * The maximum trade finance credit limit. This field is deprecated and will be removed in the future.
+     */
+    tfCreditLimit?: string;
+    /**
+     * The amount of trade finance credit used (USD). This field is deprecated and will be removed in the future.
+     */
+    tfCreditConsumed?: string;
+    /**
+     * TF Asset Adjusted Value (USD). This field is deprecated and will be removed in the future.
+     */
+    tfAdjustedAssetValue?: string;
+    /**
+     * TF Adjusted Liability Value (USD). This field is deprecated and will be removed in the future.
+     */
+    tfAdjustedLiabilityValue?: string;
+    /**
+     * The amount of adjusted credit used. This field is deprecated and will be removed in the future.
+     */
+    tfAdjustedCreditConsumed?: string;
+    /**
+     * The amount of adjusted equity. This field is deprecated and will be removed in the future.
+     */
+    tfAdjustedEquity?: string;
+    /**
+     * Whether or not a entity is frozen due to balance outstanding or other reason
+     */
+    frozen?: boolean;
+    /**
+     * The reason why a entity is frozen
+     */
+    frozenReason?: string;
+    /**
+     * Whether TF is enabled for the entity. This field is deprecated and will be removed in the future.
+     */
+    tfEnabled?: boolean;
+    /**
+     * Whether PM is enabled for the entity
+     */
+    pmEnabled?: boolean;
+    /**
+     * Market rates for the list of assets
+     */
+    marketRates?: Array<MarketRate>;
+    /**
+     * Asset Balances across portfolios
+     */
+    assetBalances?: Array<AssetBalance>;
+    /**
+     * Trade finance debit loan amounts. This field is deprecated and will be removed in the future.
+     */
+    tfLoans?: Array<LoanInfo>;
+    /**
+     * Portfolio Margin debit loan amounts
+     */
+    pmLoans?: Array<LoanInfo>;
+    /**
+     * Short collateral amounts
+     */
+    shortCollateral?: Array<LoanInfo>;
+    /**
+     * Gross market value (GMV) = LMV + Abs (SMV)
+     */
+    grossMarketValue?: string;
+    /**
+     * Net Market Value (NMV) = LMV + SMV
+     */
+    netMarketValue?: string;
+    /**
+     * Long Market Value (LMV) = Sum of positive notional for all assets
+     */
+    longMarketValue?: string;
+    /**
+     * Non_Marginable LMV: Sum of positive notional for each non-margin eligible coin
+     */
+    nonMarginableLongMarketValue?: string;
+    /**
+     * Short Market Value (SMV) = Sum of negative notional for each margin eligible coin
+     */
+    shortMarketValue?: string;
+    /**
+     * Gross Leverage = GMV / Margin Requirement
+     */
+    grossLeverage?: string;
+    /**
+     * Net Exposure = (LMV + SMV) / GMV
+     */
+    netExposure?: string;
+    portfolioStressTriggered?: MarginAddOn;
+    /**
+     * PM asset info netted across the entity
+     */
+    pmAssetInfo?: Array<PMAssetInfo>;
+    /**
+     * PM limit that monitors gross notional borrowings (crypto + fiat)
+     */
+    pmCreditLimit?: string;
+    /**
+     * PM limit that monitors excess deficit
+     */
+    pmMarginLimit?: string;
+    /**
+     * The amount of the margin limit that is consumed by the excess deficit
+     */
+    pmMarginConsumed?: string;
+};

package/dist/types/model/MarginSummaryHistorical.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+import { MarginSummary } from './MarginSummary';
+export type MarginSummaryHistorical = {
+    /**
+     * The UTC date time used for conversion
+     */
+    conversionDatetime?: string;
+    /**
+     * The date used for conversion
+     */
+    conversionDate?: string;
+    marginSummary?: MarginSummary;
+};

package/dist/types/model/MarketRate.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+export type MarketRate = {
+    /**
+     * The currency symbol
+     */
+    symbol?: string;
+    /**
+     * The current market rate of currency
+     */
+    rate?: string;
+};

package/dist/{model → types/model}/Order.d.ts

@@ -106,4 +106,8 @@ export type Order = {
      * Indicates a user friendly message for regarding various aspects of the order such as cancellation or rejection reasons
      */
     userContext?: string;
+    /**
+     * The client product ID of the fill indicating the settlement currency
+     */
+    clientProductId?: string;
 };

package/dist/{model → types/model}/OrderPreviewRequest.d.ts

@@ -33,4 +33,8 @@ export type OrderPreviewRequest = {
     isRaiseExact?: boolean;
     historicalPov?: string;
     stopPrice?: string;
+    /**
+     * next: 15
+     */
+    settlCurrency?: string;
 };

package/dist/types/model/PMAssetInfo.d.ts

@@ -0,0 +1,89 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+export type PMAssetInfo = {
+    /**
+     * The currency symbol
+     */
+    symbol?: string;
+    /**
+     * Nominal amount of the currency
+     */
+    amount?: string;
+    /**
+     * Spot price for the currency
+     */
+    price?: string;
+    /**
+     * Notional amount of the currency
+     */
+    notionalAmount?: string;
+    /**
+     * Asset tier of the currency
+     */
+    assetTier?: string;
+    /**
+     * Whether the currency is margin eligible
+     */
+    marginEligible?: boolean;
+    /**
+     * Base margin requirement of the currency
+     */
+    baseMarginRequirement?: string;
+    /**
+     * Notional amount of the currency\'s base margin requirement
+     */
+    baseMarginRequirementNotional?: string;
+    /**
+     * The 30d adv of the currency
+     */
+    adv30d?: string;
+    /**
+     * Historic 5d volatility of the currency
+     */
+    hist5dVol?: string;
+    /**
+     * Historic 30d volatility of the currency
+     */
+    hist30dVol?: string;
+    /**
+     * Historic 90d volatility of the currency
+     */
+    hist90dVol?: string;
+    /**
+     * Volatility margin addon of the currency position
+     */
+    volatilityAddon?: string;
+    /**
+     * Liquidity margin addon of the currency position
+     */
+    liquidityAddon?: string;
+    /**
+     * Total position margin of the currency
+     */
+    totalPositionMargin?: string;
+    /**
+     * Nominal short position of the currency
+     */
+    shortNominal?: string;
+    /**
+     * Nominal long position of the currency
+     */
+    longNominal?: string;
+};

package/dist/types/model/Position.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+import { PositionReference } from './PositionReference';
+export type Position = {
+    /**
+     * Asset symbol
+     */
+    symbol?: string;
+    /**
+     * The long position based on \'reference\' value
+     */
+    _long?: string;
+    /**
+     * The short position based on \'reference\' value
+     */
+    _short?: string;
+    positionReference?: PositionReference;
+};

package/dist/types/model/PositionReference.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+import { PositionReferenceType } from './enums/PositionReferenceType';
+export type PositionReference = {
+    /**
+     * Reference ID
+     */
+    id?: string;
+    type?: PositionReferenceType;
+};

package/dist/{model → types/model}/Product.d.ts

@@ -18,6 +18,7 @@
  *  Do not edit the class manually.
  */
 import { ProductPermissions } from './enums/ProductPermissions';
+import { RFQProductDetails } from './RFQProductDetails';
 export type Product = {
     /**
      * The product ID, written as `BASE-QUOTE`
@@ -55,4 +56,5 @@ export type Product = {
      * The smallest permitted price increment for the product
      */
     priceIncrement?: string;
+    rfqProductDetails?: RFQProductDetails;
 };

package/dist/{model → types/model}/RFQ.d.ts

@@ -31,4 +31,5 @@ export type RFQ = {
     baseQuantity?: string;
     quoteValue?: string;
     limitPrice: string;
+    settlCurrency?: string;
 };

package/dist/types/model/RFQProductDetails.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+export type RFQProductDetails = {
+    tradable?: boolean;
+    minNotionalSize?: string;
+    maxNotionalSize?: string;
+};

package/dist/{model → types/model}/RpcConfig.d.ts

@@ -23,7 +23,7 @@ export type RpcConfig = {
      */
     skipBroadcast?: boolean;
     /**
-     * Custom blockchain node URL. Currently only supports Flashbots RPC endpoint for EVM mainnet (https://rpc.flashbots.net/fast).
+     * Custom blockchain node RPC URL. (EVM-only)
      */
     url?: string;
 };

package/dist/types/model/ShortCollateral.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+export type ShortCollateral = {
+    /**
+     * Existing short collateral balance
+     */
+    oldBalance?: string;
+    /**
+     * New short collateral balance required
+     */
+    newBalance?: string;
+    /**
+     * Loan interest rate
+     */
+    loanInterestRate?: string;
+    /**
+     * Collateral interest rate
+     */
+    collateralInterestRate?: string;
+};

package/dist/types/model/StakingInitiateRequest.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+import { StakingInputs } from './StakingInputs';
+export type StakingInitiateRequest = {
+    /**
+     * The client generated idempotency key for requested execution. Subsequent requests using the same key will fail
+     */
+    idempotencyKey: string;
+    inputs?: StakingInputs;
+};

package/dist/types/model/StakingInitiateResponse.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+export type StakingInitiateResponse = {
+    /**
+     * The wallet ID
+     */
+    walletId: string;
+    /**
+     * ID of the newly created transaction, can be used to fetch details of the current state of execution
+     */
+    transactionId: string;
+    /**
+     * The ID for the activity generated for this request
+     */
+    activityId: string;
+};

package/dist/types/model/StakingInputs.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+export type StakingInputs = {
+    /**
+     * Optional amount to stake or unstake. If omitted, the wallet will stake or unstake the maximum amount available
+     */
+    amount?: string;
+};