@stacks/blockchain-api-client 7.3.7-beta.1 → 7.4.0-nakamoto.10

package/src/generated/apis/FaucetsApi.ts

@@ -18,6 +18,9 @@ import {
     InlineObject,
     InlineObjectFromJSON,
     InlineObjectToJSON,
+    InlineObject1,
+    InlineObject1FromJSON,
+    InlineObject1ToJSON,
     InlineResponse403,
     InlineResponse403FromJSON,
     InlineResponse403ToJSON,
@@ -28,12 +31,13 @@ import {
 
 export interface RunFaucetBtcRequest {
     address: string;
-    inlineObject?: InlineObject;
+    inlineObject1?: InlineObject1;
 }
 
 export interface RunFaucetStxRequest {
     address: string;
     stacking?: boolean;
+    inlineObject?: InlineObject;
 }
 
 /**
@@ -47,7 +51,7 @@ export interface FaucetsApiInterface {
      * Add 1 BTC token to the specified testnet BTC address.  The endpoint returns the transaction ID, which you can use to view the transaction in a testnet Bitcoin block explorer. The tokens are delivered once the transaction has been included in a block.  **Note:** This is a testnet only endpoint. This endpoint will not work on the mainnet. 
      * @summary Add testnet BTC tokens to address
      * @param {string} address A valid testnet BTC address
-     * @param {InlineObject} [inlineObject] 
+     * @param {InlineObject1} [inlineObject1] 
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof FaucetsApiInterface
@@ -65,6 +69,7 @@ export interface FaucetsApiInterface {
      * @summary Get STX testnet tokens
      * @param {string} address A valid testnet STX address
      * @param {boolean} [stacking] Request the amount of STX tokens needed for individual address stacking
+     * @param {InlineObject} [inlineObject] 
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof FaucetsApiInterface
@@ -108,7 +113,7 @@ export class FaucetsApi extends runtime.BaseAPI implements FaucetsApiInterface {
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
-            body: InlineObjectToJSON(requestParameters.inlineObject),
+            body: InlineObject1ToJSON(requestParameters.inlineObject1),
         }, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => RunFaucetResponseFromJSON(jsonValue));
@@ -144,11 +149,14 @@ export class FaucetsApi extends runtime.BaseAPI implements FaucetsApiInterface {
 
         const headerParameters: runtime.HTTPHeaders = {};
 
+        headerParameters['Content-Type'] = 'application/json';
+
         const response = await this.request({
             path: `/extended/v1/faucets/stx`,
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
+            body: InlineObjectToJSON(requestParameters.inlineObject),
         }, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => RunFaucetResponseFromJSON(jsonValue));

package/src/generated/apis/NonFungibleTokensApi.ts

@@ -21,21 +21,11 @@ import {
     NonFungibleTokenHoldingsList,
     NonFungibleTokenHoldingsListFromJSON,
     NonFungibleTokenHoldingsListToJSON,
-    NonFungibleTokenMetadata,
-    NonFungibleTokenMetadataFromJSON,
-    NonFungibleTokenMetadataToJSON,
     NonFungibleTokenMintList,
     NonFungibleTokenMintListFromJSON,
     NonFungibleTokenMintListToJSON,
-    NonFungibleTokensMetadataList,
-    NonFungibleTokensMetadataListFromJSON,
-    NonFungibleTokensMetadataListToJSON,
 } from '../models';
 
-export interface GetContractNftMetadataRequest {
-    contractId: string;
-}
-
 export interface GetNftHistoryRequest {
     assetIdentifier: string;
     value: string;
@@ -54,11 +44,6 @@ export interface GetNftHoldingsRequest {
     txMetadata?: boolean;
 }
 
-export interface GetNftMetadataListRequest {
-    limit?: number;
-    offset?: number;
-}
-
 export interface GetNftMintsRequest {
     assetIdentifier: string;
     limit?: number;
@@ -74,22 +59,6 @@ export interface GetNftMintsRequest {
  * @interface NonFungibleTokensApiInterface
  */
 export interface NonFungibleTokensApiInterface {
-    /**
-     * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service).  Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts). 
-     * @summary Non fungible tokens metadata for contract ID
-     * @param {string} contractId token\'s contract id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof NonFungibleTokensApiInterface
-     */
-    getContractNftMetadataRaw(requestParameters: GetContractNftMetadataRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NonFungibleTokenMetadata>>;
-
-    /**
-     * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service).  Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts). 
-     * Non fungible tokens metadata for contract ID
-     */
-    getContractNftMetadata(requestParameters: GetContractNftMetadataRequest, initOverrides?: RequestInit): Promise<NonFungibleTokenMetadata>;
-
     /**
      * Retrieves all events relevant to a Non-Fungible Token. Useful to determine the ownership history of a particular asset.  More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts). 
      * @summary Non-Fungible Token history
@@ -132,23 +101,6 @@ export interface NonFungibleTokensApiInterface {
      */
     getNftHoldings(requestParameters: GetNftHoldingsRequest, initOverrides?: RequestInit): Promise<NonFungibleTokenHoldingsList>;
 
-    /**
-     * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service).  Retrieves a list of non fungible tokens with their metadata. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts). 
-     * @summary Non fungible tokens metadata list
-     * @param {number} [limit] max number of tokens to fetch
-     * @param {number} [offset] index of first tokens to fetch
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof NonFungibleTokensApiInterface
-     */
-    getNftMetadataListRaw(requestParameters: GetNftMetadataListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NonFungibleTokensMetadataList>>;
-
-    /**
-     * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service).  Retrieves a list of non fungible tokens with their metadata. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts). 
-     * Non fungible tokens metadata list
-     */
-    getNftMetadataList(requestParameters: GetNftMetadataListRequest, initOverrides?: RequestInit): Promise<NonFungibleTokensMetadataList>;
-
     /**
      * Retrieves all mint events for a Non-Fungible Token asset class. Useful to determine which NFTs of a particular collection have been claimed.  More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts). 
      * @summary Non-Fungible Token mints
@@ -176,38 +128,6 @@ export interface NonFungibleTokensApiInterface {
  */
 export class NonFungibleTokensApi extends runtime.BaseAPI implements NonFungibleTokensApiInterface {
 
-    /**
-     * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service).  Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts). 
-     * Non fungible tokens metadata for contract ID
-     */
-    async getContractNftMetadataRaw(requestParameters: GetContractNftMetadataRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NonFungibleTokenMetadata>> {
-        if (requestParameters.contractId === null || requestParameters.contractId === undefined) {
-            throw new runtime.RequiredError('contractId','Required parameter requestParameters.contractId was null or undefined when calling getContractNftMetadata.');
-        }
-
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        const response = await this.request({
-            path: `/extended/v1/tokens/{contractId}/nft/metadata`.replace(`{${"contractId"}}`, encodeURIComponent(String(requestParameters.contractId))),
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => NonFungibleTokenMetadataFromJSON(jsonValue));
-    }
-
-    /**
-     * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service).  Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts). 
-     * Non fungible tokens metadata for contract ID
-     */
-    async getContractNftMetadata(requestParameters: GetContractNftMetadataRequest, initOverrides?: RequestInit): Promise<NonFungibleTokenMetadata> {
-        const response = await this.getContractNftMetadataRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
     /**
      * Retrieves all events relevant to a Non-Fungible Token. Useful to determine the ownership history of a particular asset.  More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts). 
      * Non-Fungible Token history
@@ -324,42 +244,6 @@ export class NonFungibleTokensApi extends runtime.BaseAPI implements NonFungible
         return await response.value();
     }
 
-    /**
-     * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service).  Retrieves a list of non fungible tokens with their metadata. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts). 
-     * Non fungible tokens metadata list
-     */
-    async getNftMetadataListRaw(requestParameters: GetNftMetadataListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NonFungibleTokensMetadataList>> {
-        const queryParameters: any = {};
-
-        if (requestParameters.limit !== undefined) {
-            queryParameters['limit'] = requestParameters.limit;
-        }
-
-        if (requestParameters.offset !== undefined) {
-            queryParameters['offset'] = requestParameters.offset;
-        }
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        const response = await this.request({
-            path: `/extended/v1/tokens/nft/metadata`,
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => NonFungibleTokensMetadataListFromJSON(jsonValue));
-    }
-
-    /**
-     * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service).  Retrieves a list of non fungible tokens with their metadata. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts). 
-     * Non fungible tokens metadata list
-     */
-    async getNftMetadataList(requestParameters: GetNftMetadataListRequest, initOverrides?: RequestInit): Promise<NonFungibleTokensMetadataList> {
-        const response = await this.getNftMetadataListRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
     /**
      * Retrieves all mint events for a Non-Fungible Token asset class. Useful to determine which NFTs of a particular collection have been claimed.  More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts). 
      * Non-Fungible Token mints

package/src/generated/apis/TransactionsApi.ts

@@ -245,7 +245,7 @@ export interface TransactionsApiInterface {
      * @summary Get recent transactions
      * @param {number} [limit] max number of transactions to fetch
      * @param {number} [offset] index of first transaction to fetch
-     * @param {Array<'coinbase' | 'token_transfer' | 'smart_contract' | 'contract_call' | 'poison_microblock'>} [type] Filter by transaction type
+     * @param {Array<'coinbase' | 'token_transfer' | 'smart_contract' | 'contract_call' | 'poison_microblock' | 'tenure_change'>} [type] Filter by transaction type
      * @param {boolean} [unanchored] Include transaction data from unanchored (i.e. unconfirmed) microblocks
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -851,5 +851,6 @@ export enum GetTransactionListTypeEnum {
     token_transfer = 'token_transfer',
     smart_contract = 'smart_contract',
     contract_call = 'contract_call',
-    poison_microblock = 'poison_microblock'
+    poison_microblock = 'poison_microblock',
+    tenure_change = 'tenure_change'
 }

package/src/generated/apis/index.ts

@@ -4,7 +4,6 @@ export * from './AccountsApi';
 export * from './BlocksApi';
 export * from './FaucetsApi';
 export * from './FeesApi';
-export * from './FungibleTokensApi';
 export * from './InfoApi';
 export * from './MicroblocksApi';
 export * from './NamesApi';

package/src/generated/models/BurnBlock.ts

@@ -0,0 +1,88 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Stacks Blockchain API
+ * Welcome to the API reference overview for the <a href=\"https://docs.hiro.so/get-started/stacks-blockchain-api\">Stacks Blockchain API</a>.  <a href=\"https://hirosystems.github.io/stacks-blockchain-api/collection.json\" download=\"stacks-api-collection.json\">Download Postman collection</a> 
+ *
+ * The version of the OpenAPI document: STACKS_API_VERSION
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * A burn block
+ * @export
+ * @interface BurnBlock
+ */
+export interface BurnBlock {
+    /**
+     * Unix timestamp (in seconds) indicating when this block was mined.
+     * @type {number}
+     * @memberof BurnBlock
+     */
+    burn_block_time: number;
+    /**
+     * An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined.
+     * @type {string}
+     * @memberof BurnBlock
+     */
+    burn_block_time_iso: string;
+    /**
+     * Hash of the anchor chain block
+     * @type {string}
+     * @memberof BurnBlock
+     */
+    burn_block_hash: string;
+    /**
+     * Height of the anchor chain block
+     * @type {number}
+     * @memberof BurnBlock
+     */
+    burn_block_height: number;
+    /**
+     * Hashes of the Stacks blocks included in the burn block
+     * @type {Array<string>}
+     * @memberof BurnBlock
+     */
+    stacks_blocks: Array<string>;
+}
+
+export function BurnBlockFromJSON(json: any): BurnBlock {
+    return BurnBlockFromJSONTyped(json, false);
+}
+
+export function BurnBlockFromJSONTyped(json: any, ignoreDiscriminator: boolean): BurnBlock {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'burn_block_time': json['burn_block_time'],
+        'burn_block_time_iso': json['burn_block_time_iso'],
+        'burn_block_hash': json['burn_block_hash'],
+        'burn_block_height': json['burn_block_height'],
+        'stacks_blocks': json['stacks_blocks'],
+    };
+}
+
+export function BurnBlockToJSON(value?: BurnBlock | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'burn_block_time': value.burn_block_time,
+        'burn_block_time_iso': value.burn_block_time_iso,
+        'burn_block_hash': value.burn_block_hash,
+        'burn_block_height': value.burn_block_height,
+        'stacks_blocks': value.stacks_blocks,
+    };
+}
+

package/src/generated/models/{AddressNftListResponse.ts → BurnBlockListResponse.ts}

@@ -14,49 +14,49 @@
 
 import { exists, mapValues } from '../runtime';
 import {
-    NftEvent,
-    NftEventFromJSON,
-    NftEventFromJSONTyped,
-    NftEventToJSON,
+    BurnBlock,
+    BurnBlockFromJSON,
+    BurnBlockFromJSONTyped,
+    BurnBlockToJSON,
 } from './';
 
 /**
- * 
+ * GET request that returns burn blocks
  * @export
- * @interface AddressNftListResponse
+ * @interface BurnBlockListResponse
  */
-export interface AddressNftListResponse {
+export interface BurnBlockListResponse {
     /**
-     * 
+     * The number of burn blocks to return
      * @type {number}
-     * @memberof AddressNftListResponse
+     * @memberof BurnBlockListResponse
      */
     limit: number;
     /**
-     * 
+     * The number to burn blocks to skip (starting at `0`)
      * @type {number}
-     * @memberof AddressNftListResponse
+     * @memberof BurnBlockListResponse
      */
     offset: number;
     /**
-     * 
+     * The number of burn blocks available (regardless of filter parameters)
      * @type {number}
-     * @memberof AddressNftListResponse
+     * @memberof BurnBlockListResponse
      */
     total: number;
     /**
      * 
-     * @type {Array<NftEvent>}
-     * @memberof AddressNftListResponse
+     * @type {Array<BurnBlock>}
+     * @memberof BurnBlockListResponse
      */
-    nft_events: Array<NftEvent>;
+    results: Array<BurnBlock>;
 }
 
-export function AddressNftListResponseFromJSON(json: any): AddressNftListResponse {
-    return AddressNftListResponseFromJSONTyped(json, false);
+export function BurnBlockListResponseFromJSON(json: any): BurnBlockListResponse {
+    return BurnBlockListResponseFromJSONTyped(json, false);
 }
 
-export function AddressNftListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddressNftListResponse {
+export function BurnBlockListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): BurnBlockListResponse {
     if ((json === undefined) || (json === null)) {
         return json;
     }
@@ -65,11 +65,11 @@ export function AddressNftListResponseFromJSONTyped(json: any, ignoreDiscriminat
         'limit': json['limit'],
         'offset': json['offset'],
         'total': json['total'],
-        'nft_events': ((json['nft_events'] as Array<any>).map(NftEventFromJSON)),
+        'results': ((json['results'] as Array<any>).map(BurnBlockFromJSON)),
     };
 }
 
-export function AddressNftListResponseToJSON(value?: AddressNftListResponse | null): any {
+export function BurnBlockListResponseToJSON(value?: BurnBlockListResponse | null): any {
     if (value === undefined) {
         return undefined;
     }
@@ -81,7 +81,7 @@ export function AddressNftListResponseToJSON(value?: AddressNftListResponse | nu
         'limit': value.limit,
         'offset': value.offset,
         'total': value.total,
-        'nft_events': ((value.nft_events as Array<any>).map(NftEventToJSON)),
+        'results': ((value.results as Array<any>).map(BurnBlockToJSON)),
     };
 }
 

package/src/generated/models/InlineObject.ts

@@ -20,11 +20,17 @@ import { exists, mapValues } from '../runtime';
  */
 export interface InlineObject {
     /**
-     * BTC testnet address
+     * STX testnet address
      * @type {string}
      * @memberof InlineObject
      */
     address?: string;
+    /**
+     * Use required number of tokens for stacking
+     * @type {boolean}
+     * @memberof InlineObject
+     */
+    stacking?: boolean;
 }
 
 export function InlineObjectFromJSON(json: any): InlineObject {
@@ -38,6 +44,7 @@ export function InlineObjectFromJSONTyped(json: any, ignoreDiscriminator: boolea
     return {
         
         'address': !exists(json, 'address') ? undefined : json['address'],
+        'stacking': !exists(json, 'stacking') ? undefined : json['stacking'],
     };
 }
 
@@ -51,6 +58,7 @@ export function InlineObjectToJSON(value?: InlineObject | null): any {
     return {
         
         'address': value.address,
+        'stacking': value.stacking,
     };
 }
 

package/src/generated/models/{AddressNftListResponseValue.ts → InlineObject1.ts}

@@ -14,41 +14,34 @@
 
 import { exists, mapValues } from '../runtime';
 /**
- * Identifier of the NFT
+ * 
  * @export
- * @interface AddressNftListResponseValue
+ * @interface InlineObject1
  */
-export interface AddressNftListResponseValue {
-    /**
-     * Hex string representing the identifier of the NFT
-     * @type {string}
-     * @memberof AddressNftListResponseValue
-     */
-    hex: string;
+export interface InlineObject1 {
     /**
-     * Readable string of the NFT identifier
+     * BTC testnet address
      * @type {string}
-     * @memberof AddressNftListResponseValue
+     * @memberof InlineObject1
      */
-    repr: string;
+    address?: string;
 }
 
-export function AddressNftListResponseValueFromJSON(json: any): AddressNftListResponseValue {
-    return AddressNftListResponseValueFromJSONTyped(json, false);
+export function InlineObject1FromJSON(json: any): InlineObject1 {
+    return InlineObject1FromJSONTyped(json, false);
 }
 
-export function AddressNftListResponseValueFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddressNftListResponseValue {
+export function InlineObject1FromJSONTyped(json: any, ignoreDiscriminator: boolean): InlineObject1 {
     if ((json === undefined) || (json === null)) {
         return json;
     }
     return {
         
-        'hex': json['hex'],
-        'repr': json['repr'],
+        'address': !exists(json, 'address') ? undefined : json['address'],
     };
 }
 
-export function AddressNftListResponseValueToJSON(value?: AddressNftListResponseValue | null): any {
+export function InlineObject1ToJSON(value?: InlineObject1 | null): any {
     if (value === undefined) {
         return undefined;
     }
@@ -57,8 +50,7 @@ export function AddressNftListResponseValueToJSON(value?: AddressNftListResponse
     }
     return {
         
-        'hex': value.hex,
-        'repr': value.repr,
+        'address': value.address,
     };
 }