@stacks/blockchain-api-client 0.71.1 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +362 -15
- package/lib/generated/apis/AccountsApi.d.ts +60 -25
- package/lib/generated/apis/AccountsApi.js +45 -10
- package/lib/generated/apis/AccountsApi.js.map +1 -1
- package/lib/generated/apis/BlocksApi.d.ts +38 -38
- package/lib/generated/apis/BlocksApi.js +20 -20
- package/lib/generated/apis/FaucetsApi.d.ts +10 -10
- package/lib/generated/apis/FaucetsApi.js +6 -6
- package/lib/generated/apis/FeesApi.d.ts +34 -6
- package/lib/generated/apis/FeesApi.js +33 -4
- package/lib/generated/apis/FeesApi.js.map +1 -1
- package/lib/generated/apis/FungibleTokensApi.d.ts +82 -0
- package/lib/generated/apis/FungibleTokensApi.js +80 -0
- package/lib/generated/apis/FungibleTokensApi.js.map +1 -0
- package/lib/generated/apis/InfoApi.d.ts +42 -24
- package/lib/generated/apis/InfoApi.js +22 -10
- package/lib/generated/apis/InfoApi.js.map +1 -1
- package/lib/generated/apis/MicroblocksApi.d.ts +14 -11
- package/lib/generated/apis/MicroblocksApi.js +8 -6
- package/lib/generated/apis/MicroblocksApi.js.map +1 -1
- package/lib/generated/apis/{BNSApi.d.ts → NamesApi.d.ts} +66 -63
- package/lib/generated/apis/{BNSApi.js → NamesApi.js} +30 -28
- package/lib/generated/apis/NamesApi.js.map +1 -0
- package/lib/generated/apis/NonFungibleTokensApi.d.ts +82 -0
- package/lib/generated/apis/NonFungibleTokensApi.js +80 -0
- package/lib/generated/apis/NonFungibleTokensApi.js.map +1 -0
- package/lib/generated/apis/RosettaApi.d.ts +42 -42
- package/lib/generated/apis/RosettaApi.js +22 -22
- package/lib/generated/apis/SearchApi.d.ts +4 -2
- package/lib/generated/apis/SearchApi.js +5 -2
- package/lib/generated/apis/SearchApi.js.map +1 -1
- package/lib/generated/apis/SmartContractsApi.d.ts +54 -23
- package/lib/generated/apis/SmartContractsApi.js +47 -12
- package/lib/generated/apis/SmartContractsApi.js.map +1 -1
- package/lib/generated/apis/{BurnchainApi.d.ts → StackingRewardsApi.d.ts} +31 -31
- package/lib/generated/apis/{BurnchainApi.js → StackingRewardsApi.js} +16 -16
- package/lib/generated/apis/StackingRewardsApi.js.map +1 -0
- package/lib/generated/apis/TransactionsApi.d.ts +87 -46
- package/lib/generated/apis/TransactionsApi.js +62 -24
- package/lib/generated/apis/TransactionsApi.js.map +1 -1
- package/lib/generated/apis/index.d.ts +4 -4
- package/lib/generated/apis/index.js +4 -4
- package/lib/generated/apis/index.js.map +1 -1
- package/lib/generated/models/AccountDataResponse.d.ts +2 -2
- package/lib/generated/models/AccountDataResponse.js +2 -2
- package/lib/generated/models/AddressAssetsListResponse.d.ts +2 -2
- package/lib/generated/models/AddressAssetsListResponse.js +2 -2
- package/lib/generated/models/AddressBalanceResponse.d.ts +2 -2
- package/lib/generated/models/AddressBalanceResponse.js +2 -2
- package/lib/generated/models/AddressBalanceResponseStx.d.ts +2 -2
- package/lib/generated/models/AddressBalanceResponseStx.js +2 -2
- package/lib/generated/models/AddressNftListResponse.d.ts +2 -2
- package/lib/generated/models/AddressNftListResponse.js +2 -2
- package/lib/generated/models/AddressNftListResponseValue.d.ts +2 -2
- package/lib/generated/models/AddressNftListResponseValue.js +2 -2
- package/lib/generated/models/AddressNonces.d.ts +2 -2
- package/lib/generated/models/AddressNonces.js +2 -2
- package/lib/generated/models/AddressStxInboundListResponse.d.ts +2 -2
- package/lib/generated/models/AddressStxInboundListResponse.js +2 -2
- package/lib/generated/models/AddressTokenOfferingLocked.d.ts +2 -2
- package/lib/generated/models/AddressTokenOfferingLocked.js +2 -2
- package/lib/generated/models/AddressTransactionWithTransfers.d.ts +2 -2
- package/lib/generated/models/AddressTransactionWithTransfers.js +2 -2
- package/lib/generated/models/AddressTransactionWithTransfersFtTransfers.d.ts +2 -2
- package/lib/generated/models/AddressTransactionWithTransfersFtTransfers.js +2 -2
- package/lib/generated/models/AddressTransactionWithTransfersNftTransfers.d.ts +6 -5
- package/lib/generated/models/AddressTransactionWithTransfersNftTransfers.js +5 -4
- package/lib/generated/models/AddressTransactionWithTransfersNftTransfers.js.map +1 -1
- package/lib/generated/models/AddressTransactionWithTransfersStxTransfers.d.ts +2 -2
- package/lib/generated/models/AddressTransactionWithTransfersStxTransfers.js +2 -2
- package/lib/generated/models/AddressTransactionWithTransfersValue.d.ts +33 -0
- package/lib/generated/models/AddressTransactionWithTransfersValue.js +44 -0
- package/lib/generated/models/AddressTransactionWithTransfersValue.js.map +1 -0
- package/lib/generated/models/AddressTransactionsListResponse.d.ts +2 -2
- package/lib/generated/models/AddressTransactionsListResponse.js +2 -2
- package/lib/generated/models/AddressTransactionsWithTransfersListResponse.d.ts +2 -2
- package/lib/generated/models/AddressTransactionsWithTransfersListResponse.js +2 -2
- package/lib/generated/models/AddressUnlockSchedule.d.ts +2 -2
- package/lib/generated/models/AddressUnlockSchedule.js +2 -2
- package/lib/generated/models/Block.d.ts +2 -2
- package/lib/generated/models/Block.js +2 -2
- package/lib/generated/models/BlockListResponse.d.ts +2 -2
- package/lib/generated/models/BlockListResponse.js +2 -2
- package/lib/generated/models/BnsError.d.ts +2 -2
- package/lib/generated/models/BnsError.js +2 -2
- package/lib/generated/models/BnsGetAllNamespacesResponse.d.ts +2 -2
- package/lib/generated/models/BnsGetAllNamespacesResponse.js +2 -2
- package/lib/generated/models/BnsGetNameInfoResponse.d.ts +2 -2
- package/lib/generated/models/BnsGetNameInfoResponse.js +2 -2
- package/lib/generated/models/BnsGetNamePriceResponse.d.ts +2 -2
- package/lib/generated/models/BnsGetNamePriceResponse.js +2 -2
- package/lib/generated/models/BnsGetNamespacePriceResponse.d.ts +2 -2
- package/lib/generated/models/BnsGetNamespacePriceResponse.js +2 -2
- package/lib/generated/models/BnsNamesOwnByAddressResponse.d.ts +2 -2
- package/lib/generated/models/BnsNamesOwnByAddressResponse.js +2 -2
- package/lib/generated/models/BurnchainReward.d.ts +2 -2
- package/lib/generated/models/BurnchainReward.js +2 -2
- package/lib/generated/models/BurnchainRewardListResponse.d.ts +2 -2
- package/lib/generated/models/BurnchainRewardListResponse.js +2 -2
- package/lib/generated/models/BurnchainRewardSlotHolder.d.ts +2 -2
- package/lib/generated/models/BurnchainRewardSlotHolder.js +2 -2
- package/lib/generated/models/BurnchainRewardSlotHolderListResponse.d.ts +2 -2
- package/lib/generated/models/BurnchainRewardSlotHolderListResponse.js +2 -2
- package/lib/generated/models/BurnchainRewardsTotal.d.ts +2 -2
- package/lib/generated/models/BurnchainRewardsTotal.js +2 -2
- package/lib/generated/models/ContractInterfaceResponse.d.ts +2 -2
- package/lib/generated/models/ContractInterfaceResponse.js +2 -2
- package/lib/generated/models/ContractListResponse.d.ts +40 -0
- package/lib/generated/models/ContractListResponse.js +47 -0
- package/lib/generated/models/ContractListResponse.js.map +1 -0
- package/lib/generated/models/ContractSourceResponse.d.ts +2 -2
- package/lib/generated/models/ContractSourceResponse.js +2 -2
- package/lib/generated/models/CoreNodeInfoResponse.d.ts +2 -2
- package/lib/generated/models/CoreNodeInfoResponse.js +2 -2
- package/lib/generated/models/CoreNodePoxResponse.d.ts +2 -2
- package/lib/generated/models/CoreNodePoxResponse.js +2 -2
- package/lib/generated/models/FeeRate.d.ts +2 -2
- package/lib/generated/models/FeeRate.js +2 -2
- package/lib/generated/models/FeeRateRequest.d.ts +2 -2
- package/lib/generated/models/FeeRateRequest.js +2 -2
- package/lib/generated/models/FungibleTokenMetadata.d.ts +2 -2
- package/lib/generated/models/FungibleTokenMetadata.js +2 -2
- package/lib/generated/models/FungibleTokensMetadataList.d.ts +2 -2
- package/lib/generated/models/FungibleTokensMetadataList.js +2 -2
- package/lib/generated/models/GetRawTransactionResult.d.ts +2 -2
- package/lib/generated/models/GetRawTransactionResult.js +2 -2
- package/lib/generated/models/GetStxSupplyLegacyFormatResponse.d.ts +2 -2
- package/lib/generated/models/GetStxSupplyLegacyFormatResponse.js +2 -2
- package/lib/generated/models/GetStxSupplyResponse.d.ts +2 -2
- package/lib/generated/models/GetStxSupplyResponse.js +2 -2
- package/lib/generated/models/InboundStxTransfer.d.ts +2 -2
- package/lib/generated/models/InboundStxTransfer.js +2 -2
- package/lib/generated/models/InlineResponse200.d.ts +2 -2
- package/lib/generated/models/InlineResponse200.js +2 -2
- package/lib/generated/models/MapEntryResponse.d.ts +2 -2
- package/lib/generated/models/MapEntryResponse.js +2 -2
- package/lib/generated/models/MempoolTransactionListResponse.d.ts +2 -2
- package/lib/generated/models/MempoolTransactionListResponse.js +2 -2
- package/lib/generated/models/Microblock.d.ts +2 -2
- package/lib/generated/models/Microblock.js +2 -2
- package/lib/generated/models/MicroblockListResponse.d.ts +2 -2
- package/lib/generated/models/MicroblockListResponse.js +2 -2
- package/lib/generated/models/NetworkBlockTimeResponse.d.ts +2 -2
- package/lib/generated/models/NetworkBlockTimeResponse.js +2 -2
- package/lib/generated/models/NetworkBlockTimesResponse.d.ts +2 -2
- package/lib/generated/models/NetworkBlockTimesResponse.js +2 -2
- package/lib/generated/models/NetworkBlockTimesResponseMainnet.d.ts +2 -2
- package/lib/generated/models/NetworkBlockTimesResponseMainnet.js +2 -2
- package/lib/generated/models/NetworkIdentifier.d.ts +2 -2
- package/lib/generated/models/NetworkIdentifier.js +2 -2
- package/lib/generated/models/NftEvent.d.ts +2 -2
- package/lib/generated/models/NftEvent.js +2 -2
- package/lib/generated/models/NonFungibleTokenMetadata.d.ts +2 -2
- package/lib/generated/models/NonFungibleTokenMetadata.js +2 -2
- package/lib/generated/models/NonFungibleTokensMetadataList.d.ts +2 -2
- package/lib/generated/models/NonFungibleTokensMetadataList.js +2 -2
- package/lib/generated/models/OtherTransactionIdentifier.d.ts +2 -2
- package/lib/generated/models/OtherTransactionIdentifier.js +2 -2
- package/lib/generated/models/PostCoreNodeTransactionsError.d.ts +2 -2
- package/lib/generated/models/PostCoreNodeTransactionsError.js +2 -2
- package/lib/generated/models/ReadOnlyFunctionArgs.d.ts +2 -2
- package/lib/generated/models/ReadOnlyFunctionArgs.js +2 -2
- package/lib/generated/models/ReadOnlyFunctionSuccessResponse.d.ts +2 -2
- package/lib/generated/models/ReadOnlyFunctionSuccessResponse.js +2 -2
- package/lib/generated/models/RosettaAccount.d.ts +2 -2
- package/lib/generated/models/RosettaAccount.js +2 -2
- package/lib/generated/models/RosettaAccountBalanceRequest.d.ts +2 -2
- package/lib/generated/models/RosettaAccountBalanceRequest.js +2 -2
- package/lib/generated/models/RosettaAccountBalanceResponse.d.ts +2 -2
- package/lib/generated/models/RosettaAccountBalanceResponse.js +2 -2
- package/lib/generated/models/RosettaAccountBalanceResponseCoinIdentifier.d.ts +2 -2
- package/lib/generated/models/RosettaAccountBalanceResponseCoinIdentifier.js +2 -2
- package/lib/generated/models/RosettaAccountBalanceResponseMetadata.d.ts +2 -2
- package/lib/generated/models/RosettaAccountBalanceResponseMetadata.js +2 -2
- package/lib/generated/models/RosettaAccountIdentifier.d.ts +2 -2
- package/lib/generated/models/RosettaAccountIdentifier.js +2 -2
- package/lib/generated/models/RosettaAmount.d.ts +2 -2
- package/lib/generated/models/RosettaAmount.js +2 -2
- package/lib/generated/models/RosettaBlock.d.ts +2 -2
- package/lib/generated/models/RosettaBlock.js +2 -2
- package/lib/generated/models/RosettaBlockMetadata.d.ts +2 -2
- package/lib/generated/models/RosettaBlockMetadata.js +2 -2
- package/lib/generated/models/RosettaBlockMetadata1.d.ts +2 -2
- package/lib/generated/models/RosettaBlockMetadata1.js +2 -2
- package/lib/generated/models/RosettaBlockRequest.d.ts +2 -2
- package/lib/generated/models/RosettaBlockRequest.js +2 -2
- package/lib/generated/models/RosettaBlockResponse.d.ts +2 -2
- package/lib/generated/models/RosettaBlockResponse.js +2 -2
- package/lib/generated/models/RosettaBlockTransactionRequest.d.ts +2 -2
- package/lib/generated/models/RosettaBlockTransactionRequest.js +2 -2
- package/lib/generated/models/RosettaBlockTransactionResponse.d.ts +2 -2
- package/lib/generated/models/RosettaBlockTransactionResponse.js +2 -2
- package/lib/generated/models/RosettaCoin.d.ts +2 -2
- package/lib/generated/models/RosettaCoin.js +2 -2
- package/lib/generated/models/RosettaCoinChange.d.ts +2 -2
- package/lib/generated/models/RosettaCoinChange.js +2 -2
- package/lib/generated/models/RosettaConstructionCombineRequest.d.ts +2 -2
- package/lib/generated/models/RosettaConstructionCombineRequest.js +2 -2
- package/lib/generated/models/RosettaConstructionCombineResponse.d.ts +2 -2
- package/lib/generated/models/RosettaConstructionCombineResponse.js +2 -2
- package/lib/generated/models/RosettaConstructionDeriveRequest.d.ts +2 -2
- package/lib/generated/models/RosettaConstructionDeriveRequest.js +2 -2
- package/lib/generated/models/RosettaConstructionDeriveResponse.d.ts +2 -2
- package/lib/generated/models/RosettaConstructionDeriveResponse.js +2 -2
- package/lib/generated/models/RosettaConstructionHashRequest.d.ts +2 -2
- package/lib/generated/models/RosettaConstructionHashRequest.js +2 -2
- package/lib/generated/models/RosettaConstructionHashResponse.d.ts +2 -2
- package/lib/generated/models/RosettaConstructionHashResponse.js +2 -2
- package/lib/generated/models/RosettaConstructionMetadataRequest.d.ts +2 -2
- package/lib/generated/models/RosettaConstructionMetadataRequest.js +2 -2
- package/lib/generated/models/RosettaConstructionMetadataResponse.d.ts +2 -2
- package/lib/generated/models/RosettaConstructionMetadataResponse.js +2 -2
- package/lib/generated/models/RosettaConstructionMetadataResponseMetadata.d.ts +2 -2
- package/lib/generated/models/RosettaConstructionMetadataResponseMetadata.js +2 -2
- package/lib/generated/models/RosettaConstructionParseRequest.d.ts +2 -2
- package/lib/generated/models/RosettaConstructionParseRequest.js +2 -2
- package/lib/generated/models/RosettaConstructionParseResponse.d.ts +2 -2
- package/lib/generated/models/RosettaConstructionParseResponse.js +2 -2
- package/lib/generated/models/RosettaConstructionPayloadResponse.d.ts +2 -2
- package/lib/generated/models/RosettaConstructionPayloadResponse.js +2 -2
- package/lib/generated/models/RosettaConstructionPayloadsRequest.d.ts +2 -2
- package/lib/generated/models/RosettaConstructionPayloadsRequest.js +2 -2
- package/lib/generated/models/RosettaConstructionPreprocessRequest.d.ts +2 -2
- package/lib/generated/models/RosettaConstructionPreprocessRequest.js +2 -2
- package/lib/generated/models/RosettaConstructionPreprocessResponse.d.ts +2 -2
- package/lib/generated/models/RosettaConstructionPreprocessResponse.js +2 -2
- package/lib/generated/models/RosettaConstructionSubmitRequest.d.ts +2 -2
- package/lib/generated/models/RosettaConstructionSubmitRequest.js +2 -2
- package/lib/generated/models/RosettaConstructionSubmitResponse.d.ts +2 -2
- package/lib/generated/models/RosettaConstructionSubmitResponse.js +2 -2
- package/lib/generated/models/RosettaCurrency.d.ts +2 -2
- package/lib/generated/models/RosettaCurrency.js +2 -2
- package/lib/generated/models/RosettaError.d.ts +2 -2
- package/lib/generated/models/RosettaError.js +2 -2
- package/lib/generated/models/RosettaErrorDetails.d.ts +2 -2
- package/lib/generated/models/RosettaErrorDetails.js +2 -2
- package/lib/generated/models/RosettaErrorNoDetails.d.ts +2 -2
- package/lib/generated/models/RosettaErrorNoDetails.js +2 -2
- package/lib/generated/models/RosettaMaxFeeAmount.d.ts +2 -2
- package/lib/generated/models/RosettaMaxFeeAmount.js +2 -2
- package/lib/generated/models/RosettaMempoolRequest.d.ts +2 -2
- package/lib/generated/models/RosettaMempoolRequest.js +2 -2
- package/lib/generated/models/RosettaMempoolResponse.d.ts +2 -2
- package/lib/generated/models/RosettaMempoolResponse.js +2 -2
- package/lib/generated/models/RosettaMempoolTransactionRequest.d.ts +2 -2
- package/lib/generated/models/RosettaMempoolTransactionRequest.js +2 -2
- package/lib/generated/models/RosettaMempoolTransactionResponse.d.ts +2 -2
- package/lib/generated/models/RosettaMempoolTransactionResponse.js +2 -2
- package/lib/generated/models/RosettaNetworkListResponse.d.ts +2 -2
- package/lib/generated/models/RosettaNetworkListResponse.js +2 -2
- package/lib/generated/models/RosettaNetworkListResponseSubNetworkIdentifier.d.ts +2 -2
- package/lib/generated/models/RosettaNetworkListResponseSubNetworkIdentifier.js +2 -2
- package/lib/generated/models/RosettaNetworkListResponseSubNetworkIdentifierMetadata.d.ts +2 -2
- package/lib/generated/models/RosettaNetworkListResponseSubNetworkIdentifierMetadata.js +2 -2
- package/lib/generated/models/RosettaNetworkOptionsResponse.d.ts +2 -2
- package/lib/generated/models/RosettaNetworkOptionsResponse.js +2 -2
- package/lib/generated/models/RosettaNetworkOptionsResponseAllow.d.ts +2 -2
- package/lib/generated/models/RosettaNetworkOptionsResponseAllow.js +2 -2
- package/lib/generated/models/RosettaNetworkOptionsResponseVersion.d.ts +2 -2
- package/lib/generated/models/RosettaNetworkOptionsResponseVersion.js +2 -2
- package/lib/generated/models/RosettaOperation.d.ts +2 -2
- package/lib/generated/models/RosettaOperation.js +2 -2
- package/lib/generated/models/RosettaOperationIdentifier.d.ts +2 -2
- package/lib/generated/models/RosettaOperationIdentifier.js +2 -2
- package/lib/generated/models/RosettaOperationStatus.d.ts +2 -2
- package/lib/generated/models/RosettaOperationStatus.js +2 -2
- package/lib/generated/models/RosettaOptions.d.ts +2 -2
- package/lib/generated/models/RosettaOptions.js +2 -2
- package/lib/generated/models/RosettaOptionsRequest.d.ts +2 -2
- package/lib/generated/models/RosettaOptionsRequest.js +2 -2
- package/lib/generated/models/RosettaParentBlockIdentifier.d.ts +2 -2
- package/lib/generated/models/RosettaParentBlockIdentifier.js +2 -2
- package/lib/generated/models/RosettaPublicKey.d.ts +2 -2
- package/lib/generated/models/RosettaPublicKey.js +2 -2
- package/lib/generated/models/RosettaRelatedOperation.d.ts +2 -2
- package/lib/generated/models/RosettaRelatedOperation.js +2 -2
- package/lib/generated/models/RosettaSignature.d.ts +2 -2
- package/lib/generated/models/RosettaSignature.js +2 -2
- package/lib/generated/models/RosettaStatusRequest.d.ts +2 -2
- package/lib/generated/models/RosettaStatusRequest.js +2 -2
- package/lib/generated/models/RosettaSubAccount.d.ts +2 -2
- package/lib/generated/models/RosettaSubAccount.js +2 -2
- package/lib/generated/models/RosettaTransaction.d.ts +2 -2
- package/lib/generated/models/RosettaTransaction.js +2 -2
- package/lib/generated/models/RunFaucetResponse.d.ts +2 -2
- package/lib/generated/models/RunFaucetResponse.js +2 -2
- package/lib/generated/models/ServerStatusResponse.d.ts +2 -2
- package/lib/generated/models/ServerStatusResponse.js +2 -2
- package/lib/generated/models/SigningPayload.d.ts +2 -2
- package/lib/generated/models/SigningPayload.js +2 -2
- package/lib/generated/models/SmartContract.d.ts +51 -0
- package/lib/generated/models/SmartContract.js +50 -0
- package/lib/generated/models/SmartContract.js.map +1 -0
- package/lib/generated/models/TransactionIdentifier.d.ts +2 -2
- package/lib/generated/models/TransactionIdentifier.js +2 -2
- package/lib/generated/models/TransactionResults.d.ts +2 -2
- package/lib/generated/models/TransactionResults.js +2 -2
- package/lib/generated/models/UnanchoredTransactionListResponse.d.ts +2 -2
- package/lib/generated/models/UnanchoredTransactionListResponse.js +2 -2
- package/lib/generated/models/index.d.ts +3 -0
- package/lib/generated/models/index.js +3 -0
- package/lib/generated/models/index.js.map +1 -1
- package/lib/generated/runtime.d.ts +2 -2
- package/lib/generated/runtime.js +2 -2
- package/lib/index.umd.js +1393 -976
- package/lib/index.umd.js.map +1 -1
- package/lib/socket-io/index.d.ts +4 -0
- package/lib/socket-io/index.js +6 -1
- package/lib/socket-io/index.js.map +1 -1
- package/lib/ws/index.d.ts +7 -1
- package/lib/ws/index.js +51 -0
- package/lib/ws/index.js.map +1 -1
- package/package.json +5 -5
- package/src/generated/.openapi-generator/FILES +7 -4
- package/src/generated/apis/AccountsApi.ts +88 -25
- package/src/generated/apis/BlocksApi.ts +38 -38
- package/src/generated/apis/FaucetsApi.ts +10 -10
- package/src/generated/apis/FeesApi.ts +69 -6
- package/src/generated/apis/FungibleTokensApi.ts +150 -0
- package/src/generated/apis/InfoApi.ts +42 -24
- package/src/generated/apis/MicroblocksApi.ts +14 -11
- package/src/generated/apis/{BNSApi.ts → NamesApi.ts} +66 -63
- package/src/generated/apis/NonFungibleTokensApi.ts +150 -0
- package/src/generated/apis/RosettaApi.ts +42 -42
- package/src/generated/apis/SearchApi.ts +8 -2
- package/src/generated/apis/SmartContractsApi.ts +93 -22
- package/src/generated/apis/{BurnchainApi.ts → StackingRewardsApi.ts} +31 -31
- package/src/generated/apis/TransactionsApi.ts +120 -46
- package/src/generated/apis/index.ts +4 -4
- package/src/generated/models/AccountDataResponse.ts +2 -2
- package/src/generated/models/AddressAssetsListResponse.ts +2 -2
- package/src/generated/models/AddressBalanceResponse.ts +2 -2
- package/src/generated/models/AddressBalanceResponseStx.ts +2 -2
- package/src/generated/models/AddressNftListResponse.ts +2 -2
- package/src/generated/models/AddressNftListResponseValue.ts +2 -2
- package/src/generated/models/AddressNonces.ts +2 -2
- package/src/generated/models/AddressStxInboundListResponse.ts +2 -2
- package/src/generated/models/AddressTokenOfferingLocked.ts +2 -2
- package/src/generated/models/AddressTransactionWithTransfers.ts +2 -2
- package/src/generated/models/AddressTransactionWithTransfersFtTransfers.ts +2 -2
- package/src/generated/models/AddressTransactionWithTransfersNftTransfers.ts +14 -7
- package/src/generated/models/AddressTransactionWithTransfersStxTransfers.ts +2 -2
- package/src/generated/models/AddressTransactionWithTransfersValue.ts +64 -0
- package/src/generated/models/AddressTransactionsListResponse.ts +2 -2
- package/src/generated/models/AddressTransactionsWithTransfersListResponse.ts +2 -2
- package/src/generated/models/AddressUnlockSchedule.ts +2 -2
- package/src/generated/models/Block.ts +2 -2
- package/src/generated/models/BlockListResponse.ts +2 -2
- package/src/generated/models/BnsError.ts +2 -2
- package/src/generated/models/BnsGetAllNamespacesResponse.ts +2 -2
- package/src/generated/models/BnsGetNameInfoResponse.ts +2 -2
- package/src/generated/models/BnsGetNamePriceResponse.ts +2 -2
- package/src/generated/models/BnsGetNamespacePriceResponse.ts +2 -2
- package/src/generated/models/BnsNamesOwnByAddressResponse.ts +2 -2
- package/src/generated/models/BurnchainReward.ts +2 -2
- package/src/generated/models/BurnchainRewardListResponse.ts +2 -2
- package/src/generated/models/BurnchainRewardSlotHolder.ts +2 -2
- package/src/generated/models/BurnchainRewardSlotHolderListResponse.ts +2 -2
- package/src/generated/models/BurnchainRewardsTotal.ts +2 -2
- package/src/generated/models/ContractInterfaceResponse.ts +2 -2
- package/src/generated/models/ContractListResponse.ts +79 -0
- package/src/generated/models/ContractSourceResponse.ts +2 -2
- package/src/generated/models/CoreNodeInfoResponse.ts +2 -2
- package/src/generated/models/CoreNodePoxResponse.ts +2 -2
- package/src/generated/models/FeeRate.ts +2 -2
- package/src/generated/models/FeeRateRequest.ts +2 -2
- package/src/generated/models/FungibleTokenMetadata.ts +2 -2
- package/src/generated/models/FungibleTokensMetadataList.ts +2 -2
- package/src/generated/models/GetRawTransactionResult.ts +2 -2
- package/src/generated/models/GetStxSupplyLegacyFormatResponse.ts +2 -2
- package/src/generated/models/GetStxSupplyResponse.ts +2 -2
- package/src/generated/models/InboundStxTransfer.ts +2 -2
- package/src/generated/models/InlineResponse200.ts +2 -2
- package/src/generated/models/MapEntryResponse.ts +2 -2
- package/src/generated/models/MempoolTransactionListResponse.ts +2 -2
- package/src/generated/models/Microblock.ts +2 -2
- package/src/generated/models/MicroblockListResponse.ts +2 -2
- package/src/generated/models/NetworkBlockTimeResponse.ts +2 -2
- package/src/generated/models/NetworkBlockTimesResponse.ts +2 -2
- package/src/generated/models/NetworkBlockTimesResponseMainnet.ts +2 -2
- package/src/generated/models/NetworkIdentifier.ts +2 -2
- package/src/generated/models/NftEvent.ts +2 -2
- package/src/generated/models/NonFungibleTokenMetadata.ts +2 -2
- package/src/generated/models/NonFungibleTokensMetadataList.ts +2 -2
- package/src/generated/models/OtherTransactionIdentifier.ts +2 -2
- package/src/generated/models/PostCoreNodeTransactionsError.ts +2 -2
- package/src/generated/models/ReadOnlyFunctionArgs.ts +2 -2
- package/src/generated/models/ReadOnlyFunctionSuccessResponse.ts +2 -2
- package/src/generated/models/RosettaAccount.ts +2 -2
- package/src/generated/models/RosettaAccountBalanceRequest.ts +2 -2
- package/src/generated/models/RosettaAccountBalanceResponse.ts +2 -2
- package/src/generated/models/RosettaAccountBalanceResponseCoinIdentifier.ts +2 -2
- package/src/generated/models/RosettaAccountBalanceResponseMetadata.ts +2 -2
- package/src/generated/models/RosettaAccountIdentifier.ts +2 -2
- package/src/generated/models/RosettaAmount.ts +2 -2
- package/src/generated/models/RosettaBlock.ts +2 -2
- package/src/generated/models/RosettaBlockMetadata.ts +2 -2
- package/src/generated/models/RosettaBlockMetadata1.ts +2 -2
- package/src/generated/models/RosettaBlockRequest.ts +2 -2
- package/src/generated/models/RosettaBlockResponse.ts +2 -2
- package/src/generated/models/RosettaBlockTransactionRequest.ts +2 -2
- package/src/generated/models/RosettaBlockTransactionResponse.ts +2 -2
- package/src/generated/models/RosettaCoin.ts +2 -2
- package/src/generated/models/RosettaCoinChange.ts +2 -2
- package/src/generated/models/RosettaConstructionCombineRequest.ts +2 -2
- package/src/generated/models/RosettaConstructionCombineResponse.ts +2 -2
- package/src/generated/models/RosettaConstructionDeriveRequest.ts +2 -2
- package/src/generated/models/RosettaConstructionDeriveResponse.ts +2 -2
- package/src/generated/models/RosettaConstructionHashRequest.ts +2 -2
- package/src/generated/models/RosettaConstructionHashResponse.ts +2 -2
- package/src/generated/models/RosettaConstructionMetadataRequest.ts +2 -2
- package/src/generated/models/RosettaConstructionMetadataResponse.ts +2 -2
- package/src/generated/models/RosettaConstructionMetadataResponseMetadata.ts +2 -2
- package/src/generated/models/RosettaConstructionParseRequest.ts +2 -2
- package/src/generated/models/RosettaConstructionParseResponse.ts +2 -2
- package/src/generated/models/RosettaConstructionPayloadResponse.ts +2 -2
- package/src/generated/models/RosettaConstructionPayloadsRequest.ts +2 -2
- package/src/generated/models/RosettaConstructionPreprocessRequest.ts +2 -2
- package/src/generated/models/RosettaConstructionPreprocessResponse.ts +2 -2
- package/src/generated/models/RosettaConstructionSubmitRequest.ts +2 -2
- package/src/generated/models/RosettaConstructionSubmitResponse.ts +2 -2
- package/src/generated/models/RosettaCurrency.ts +2 -2
- package/src/generated/models/RosettaError.ts +2 -2
- package/src/generated/models/RosettaErrorDetails.ts +2 -2
- package/src/generated/models/RosettaErrorNoDetails.ts +2 -2
- package/src/generated/models/RosettaMaxFeeAmount.ts +2 -2
- package/src/generated/models/RosettaMempoolRequest.ts +2 -2
- package/src/generated/models/RosettaMempoolResponse.ts +2 -2
- package/src/generated/models/RosettaMempoolTransactionRequest.ts +2 -2
- package/src/generated/models/RosettaMempoolTransactionResponse.ts +2 -2
- package/src/generated/models/RosettaNetworkListResponse.ts +2 -2
- package/src/generated/models/RosettaNetworkListResponseSubNetworkIdentifier.ts +2 -2
- package/src/generated/models/RosettaNetworkListResponseSubNetworkIdentifierMetadata.ts +2 -2
- package/src/generated/models/RosettaNetworkOptionsResponse.ts +2 -2
- package/src/generated/models/RosettaNetworkOptionsResponseAllow.ts +2 -2
- package/src/generated/models/RosettaNetworkOptionsResponseVersion.ts +2 -2
- package/src/generated/models/RosettaOperation.ts +2 -2
- package/src/generated/models/RosettaOperationIdentifier.ts +2 -2
- package/src/generated/models/RosettaOperationStatus.ts +2 -2
- package/src/generated/models/RosettaOptions.ts +2 -2
- package/src/generated/models/RosettaOptionsRequest.ts +2 -2
- package/src/generated/models/RosettaParentBlockIdentifier.ts +2 -2
- package/src/generated/models/RosettaPublicKey.ts +2 -2
- package/src/generated/models/RosettaRelatedOperation.ts +2 -2
- package/src/generated/models/RosettaSignature.ts +2 -2
- package/src/generated/models/RosettaStatusRequest.ts +2 -2
- package/src/generated/models/RosettaSubAccount.ts +2 -2
- package/src/generated/models/RosettaTransaction.ts +2 -2
- package/src/generated/models/RunFaucetResponse.ts +2 -2
- package/src/generated/models/ServerStatusResponse.ts +2 -2
- package/src/generated/models/SigningPayload.ts +2 -2
- package/src/generated/models/SmartContract.ts +88 -0
- package/src/generated/models/TransactionIdentifier.ts +2 -2
- package/src/generated/models/TransactionResults.ts +2 -2
- package/src/generated/models/UnanchoredTransactionListResponse.ts +2 -2
- package/src/generated/models/index.ts +3 -0
- package/src/generated/runtime.ts +2 -2
- package/src/socket-io/index.ts +8 -1
- package/src/ws/index.ts +63 -0
- package/lib/generated/apis/BNSApi.js.map +0 -1
- package/lib/generated/apis/BurnchainApi.js.map +0 -1
- package/lib/generated/apis/FeeRateApi.d.ts +0 -53
- package/lib/generated/apis/FeeRateApi.js +0 -53
- package/lib/generated/apis/FeeRateApi.js.map +0 -1
- package/lib/generated/apis/TokensApi.d.ts +0 -138
- package/lib/generated/apis/TokensApi.js +0 -135
- package/lib/generated/apis/TokensApi.js.map +0 -1
- package/src/generated/apis/FeeRateApi.ts +0 -95
- package/src/generated/apis/TokensApi.ts +0 -266
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Stacks
|
|
3
|
-
*
|
|
2
|
+
* Stacks Blockchain API
|
|
3
|
+
* 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=\"/collection.json\" download=\"stacks-api-collection.json\">Download Postman collection</a>
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: STACKS_API_VERSION
|
|
6
6
|
*
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import { ContractInterfaceResponse, ContractSourceResponse, MapEntryResponse, ReadOnlyFunctionArgs, ReadOnlyFunctionSuccessResponse } from '../models';
|
|
13
|
+
import { ContractInterfaceResponse, ContractListResponse, ContractSourceResponse, MapEntryResponse, ReadOnlyFunctionArgs, ReadOnlyFunctionSuccessResponse } from '../models';
|
|
14
14
|
export interface CallReadOnlyFunctionRequest {
|
|
15
15
|
contractAddress: string;
|
|
16
16
|
contractName: string;
|
|
@@ -47,6 +47,11 @@ export interface GetContractSourceRequest {
|
|
|
47
47
|
proof?: number;
|
|
48
48
|
tip?: string;
|
|
49
49
|
}
|
|
50
|
+
export interface GetContractsByTraitRequest {
|
|
51
|
+
traitAbi: string;
|
|
52
|
+
limit?: number;
|
|
53
|
+
offset?: number;
|
|
54
|
+
}
|
|
50
55
|
/**
|
|
51
56
|
* SmartContractsApi - interface
|
|
52
57
|
*
|
|
@@ -73,7 +78,7 @@ export interface SmartContractsApiInterface {
|
|
|
73
78
|
*/
|
|
74
79
|
callReadOnlyFunction(requestParameters: CallReadOnlyFunctionRequest, initOverrides?: RequestInit): Promise<ReadOnlyFunctionSuccessResponse>;
|
|
75
80
|
/**
|
|
76
|
-
*
|
|
81
|
+
* Retrieves details of a contract with a given `contract_id`
|
|
77
82
|
* @summary Get contract info
|
|
78
83
|
* @param {string} contractId Contract identifier formatted as `<contract_address>.<contract_name>`
|
|
79
84
|
* @param {boolean} [unanchored] Include transaction data from unanchored (i.e. unconfirmed) microblocks
|
|
@@ -83,12 +88,12 @@ export interface SmartContractsApiInterface {
|
|
|
83
88
|
*/
|
|
84
89
|
getContractByIdRaw(requestParameters: GetContractByIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>>;
|
|
85
90
|
/**
|
|
86
|
-
*
|
|
91
|
+
* Retrieves details of a contract with a given `contract_id`
|
|
87
92
|
* Get contract info
|
|
88
93
|
*/
|
|
89
94
|
getContractById(requestParameters: GetContractByIdRequest, initOverrides?: RequestInit): Promise<object>;
|
|
90
95
|
/**
|
|
91
|
-
* Attempt to fetch data from a contract data map. The contract is identified with
|
|
96
|
+
* Attempt to fetch data from a contract data map. The contract is identified with Stacks Address `contract_address` and Contract Name `contract_address` in the URL path. The map is identified with [Map Name]. The key to lookup in the map is supplied via the POST body. This should be supplied as the hex string serialization of the key (which should be a Clarity value). Note, this is a JSON string atom. In the response, `data` is the hex serialization of the map response. Note that map responses are Clarity option types, for non-existent values, this is a serialized none, and for all other responses, it is a serialized (some ...) object.
|
|
92
97
|
* @summary Get specific data-map inside a contract
|
|
93
98
|
* @param {string} contractAddress Stacks address
|
|
94
99
|
* @param {string} contractName Contract name
|
|
@@ -102,12 +107,12 @@ export interface SmartContractsApiInterface {
|
|
|
102
107
|
*/
|
|
103
108
|
getContractDataMapEntryRaw(requestParameters: GetContractDataMapEntryRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<MapEntryResponse>>;
|
|
104
109
|
/**
|
|
105
|
-
* Attempt to fetch data from a contract data map. The contract is identified with
|
|
110
|
+
* Attempt to fetch data from a contract data map. The contract is identified with Stacks Address `contract_address` and Contract Name `contract_address` in the URL path. The map is identified with [Map Name]. The key to lookup in the map is supplied via the POST body. This should be supplied as the hex string serialization of the key (which should be a Clarity value). Note, this is a JSON string atom. In the response, `data` is the hex serialization of the map response. Note that map responses are Clarity option types, for non-existent values, this is a serialized none, and for all other responses, it is a serialized (some ...) object.
|
|
106
111
|
* Get specific data-map inside a contract
|
|
107
112
|
*/
|
|
108
113
|
getContractDataMapEntry(requestParameters: GetContractDataMapEntryRequest, initOverrides?: RequestInit): Promise<MapEntryResponse>;
|
|
109
114
|
/**
|
|
110
|
-
*
|
|
115
|
+
* Retrieves a list of events that have been triggered by a given `contract_id`
|
|
111
116
|
* @summary Get contract events
|
|
112
117
|
* @param {string} contractId Contract identifier formatted as `<contract_address>.<contract_name>`
|
|
113
118
|
* @param {number} [limit] max number of contract events to fetch
|
|
@@ -119,12 +124,12 @@ export interface SmartContractsApiInterface {
|
|
|
119
124
|
*/
|
|
120
125
|
getContractEventsByIdRaw(requestParameters: GetContractEventsByIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>>;
|
|
121
126
|
/**
|
|
122
|
-
*
|
|
127
|
+
* Retrieves a list of events that have been triggered by a given `contract_id`
|
|
123
128
|
* Get contract events
|
|
124
129
|
*/
|
|
125
130
|
getContractEventsById(requestParameters: GetContractEventsByIdRequest, initOverrides?: RequestInit): Promise<object>;
|
|
126
131
|
/**
|
|
127
|
-
*
|
|
132
|
+
* Retrieves a contract interface with a given `contract_address` and `contract name`
|
|
128
133
|
* @summary Get contract interface
|
|
129
134
|
* @param {string} contractAddress Stacks address
|
|
130
135
|
* @param {string} contractName Contract name
|
|
@@ -135,12 +140,12 @@ export interface SmartContractsApiInterface {
|
|
|
135
140
|
*/
|
|
136
141
|
getContractInterfaceRaw(requestParameters: GetContractInterfaceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ContractInterfaceResponse>>;
|
|
137
142
|
/**
|
|
138
|
-
*
|
|
143
|
+
* Retrieves a contract interface with a given `contract_address` and `contract name`
|
|
139
144
|
* Get contract interface
|
|
140
145
|
*/
|
|
141
146
|
getContractInterface(requestParameters: GetContractInterfaceRequest, initOverrides?: RequestInit): Promise<ContractInterfaceResponse>;
|
|
142
147
|
/**
|
|
143
|
-
*
|
|
148
|
+
* Retrieves the Clarity source code of a given contract, along with the block height it was published in, and the MARF proof for the data
|
|
144
149
|
* @summary Get contract source
|
|
145
150
|
* @param {string} contractAddress Stacks address
|
|
146
151
|
* @param {string} contractName Contract name
|
|
@@ -152,10 +157,26 @@ export interface SmartContractsApiInterface {
|
|
|
152
157
|
*/
|
|
153
158
|
getContractSourceRaw(requestParameters: GetContractSourceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ContractSourceResponse>>;
|
|
154
159
|
/**
|
|
155
|
-
*
|
|
160
|
+
* Retrieves the Clarity source code of a given contract, along with the block height it was published in, and the MARF proof for the data
|
|
156
161
|
* Get contract source
|
|
157
162
|
*/
|
|
158
163
|
getContractSource(requestParameters: GetContractSourceRequest, initOverrides?: RequestInit): Promise<ContractSourceResponse>;
|
|
164
|
+
/**
|
|
165
|
+
* Retrieves a list of contracts based on the following traits listed in JSON format - functions, variables, maps, fungible tokens and non-fungible tokens
|
|
166
|
+
* @summary Get contracts by trait
|
|
167
|
+
* @param {string} traitAbi JSON abi of the trait.
|
|
168
|
+
* @param {number} [limit] max number of contracts fetch
|
|
169
|
+
* @param {number} [offset] index of first contract event to fetch
|
|
170
|
+
* @param {*} [options] Override http request option.
|
|
171
|
+
* @throws {RequiredError}
|
|
172
|
+
* @memberof SmartContractsApiInterface
|
|
173
|
+
*/
|
|
174
|
+
getContractsByTraitRaw(requestParameters: GetContractsByTraitRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ContractListResponse>>;
|
|
175
|
+
/**
|
|
176
|
+
* Retrieves a list of contracts based on the following traits listed in JSON format - functions, variables, maps, fungible tokens and non-fungible tokens
|
|
177
|
+
* Get contracts by trait
|
|
178
|
+
*/
|
|
179
|
+
getContractsByTrait(requestParameters: GetContractsByTraitRequest, initOverrides?: RequestInit): Promise<ContractListResponse>;
|
|
159
180
|
}
|
|
160
181
|
/**
|
|
161
182
|
*
|
|
@@ -172,53 +193,63 @@ export declare class SmartContractsApi extends runtime.BaseAPI implements SmartC
|
|
|
172
193
|
*/
|
|
173
194
|
callReadOnlyFunction(requestParameters: CallReadOnlyFunctionRequest, initOverrides?: RequestInit): Promise<ReadOnlyFunctionSuccessResponse>;
|
|
174
195
|
/**
|
|
175
|
-
*
|
|
196
|
+
* Retrieves details of a contract with a given `contract_id`
|
|
176
197
|
* Get contract info
|
|
177
198
|
*/
|
|
178
199
|
getContractByIdRaw(requestParameters: GetContractByIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>>;
|
|
179
200
|
/**
|
|
180
|
-
*
|
|
201
|
+
* Retrieves details of a contract with a given `contract_id`
|
|
181
202
|
* Get contract info
|
|
182
203
|
*/
|
|
183
204
|
getContractById(requestParameters: GetContractByIdRequest, initOverrides?: RequestInit): Promise<object>;
|
|
184
205
|
/**
|
|
185
|
-
* Attempt to fetch data from a contract data map. The contract is identified with
|
|
206
|
+
* Attempt to fetch data from a contract data map. The contract is identified with Stacks Address `contract_address` and Contract Name `contract_address` in the URL path. The map is identified with [Map Name]. The key to lookup in the map is supplied via the POST body. This should be supplied as the hex string serialization of the key (which should be a Clarity value). Note, this is a JSON string atom. In the response, `data` is the hex serialization of the map response. Note that map responses are Clarity option types, for non-existent values, this is a serialized none, and for all other responses, it is a serialized (some ...) object.
|
|
186
207
|
* Get specific data-map inside a contract
|
|
187
208
|
*/
|
|
188
209
|
getContractDataMapEntryRaw(requestParameters: GetContractDataMapEntryRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<MapEntryResponse>>;
|
|
189
210
|
/**
|
|
190
|
-
* Attempt to fetch data from a contract data map. The contract is identified with
|
|
211
|
+
* Attempt to fetch data from a contract data map. The contract is identified with Stacks Address `contract_address` and Contract Name `contract_address` in the URL path. The map is identified with [Map Name]. The key to lookup in the map is supplied via the POST body. This should be supplied as the hex string serialization of the key (which should be a Clarity value). Note, this is a JSON string atom. In the response, `data` is the hex serialization of the map response. Note that map responses are Clarity option types, for non-existent values, this is a serialized none, and for all other responses, it is a serialized (some ...) object.
|
|
191
212
|
* Get specific data-map inside a contract
|
|
192
213
|
*/
|
|
193
214
|
getContractDataMapEntry(requestParameters: GetContractDataMapEntryRequest, initOverrides?: RequestInit): Promise<MapEntryResponse>;
|
|
194
215
|
/**
|
|
195
|
-
*
|
|
216
|
+
* Retrieves a list of events that have been triggered by a given `contract_id`
|
|
196
217
|
* Get contract events
|
|
197
218
|
*/
|
|
198
219
|
getContractEventsByIdRaw(requestParameters: GetContractEventsByIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>>;
|
|
199
220
|
/**
|
|
200
|
-
*
|
|
221
|
+
* Retrieves a list of events that have been triggered by a given `contract_id`
|
|
201
222
|
* Get contract events
|
|
202
223
|
*/
|
|
203
224
|
getContractEventsById(requestParameters: GetContractEventsByIdRequest, initOverrides?: RequestInit): Promise<object>;
|
|
204
225
|
/**
|
|
205
|
-
*
|
|
226
|
+
* Retrieves a contract interface with a given `contract_address` and `contract name`
|
|
206
227
|
* Get contract interface
|
|
207
228
|
*/
|
|
208
229
|
getContractInterfaceRaw(requestParameters: GetContractInterfaceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ContractInterfaceResponse>>;
|
|
209
230
|
/**
|
|
210
|
-
*
|
|
231
|
+
* Retrieves a contract interface with a given `contract_address` and `contract name`
|
|
211
232
|
* Get contract interface
|
|
212
233
|
*/
|
|
213
234
|
getContractInterface(requestParameters: GetContractInterfaceRequest, initOverrides?: RequestInit): Promise<ContractInterfaceResponse>;
|
|
214
235
|
/**
|
|
215
|
-
*
|
|
236
|
+
* Retrieves the Clarity source code of a given contract, along with the block height it was published in, and the MARF proof for the data
|
|
216
237
|
* Get contract source
|
|
217
238
|
*/
|
|
218
239
|
getContractSourceRaw(requestParameters: GetContractSourceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ContractSourceResponse>>;
|
|
219
240
|
/**
|
|
220
|
-
*
|
|
241
|
+
* Retrieves the Clarity source code of a given contract, along with the block height it was published in, and the MARF proof for the data
|
|
221
242
|
* Get contract source
|
|
222
243
|
*/
|
|
223
244
|
getContractSource(requestParameters: GetContractSourceRequest, initOverrides?: RequestInit): Promise<ContractSourceResponse>;
|
|
245
|
+
/**
|
|
246
|
+
* Retrieves a list of contracts based on the following traits listed in JSON format - functions, variables, maps, fungible tokens and non-fungible tokens
|
|
247
|
+
* Get contracts by trait
|
|
248
|
+
*/
|
|
249
|
+
getContractsByTraitRaw(requestParameters: GetContractsByTraitRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ContractListResponse>>;
|
|
250
|
+
/**
|
|
251
|
+
* Retrieves a list of contracts based on the following traits listed in JSON format - functions, variables, maps, fungible tokens and non-fungible tokens
|
|
252
|
+
* Get contracts by trait
|
|
253
|
+
*/
|
|
254
|
+
getContractsByTrait(requestParameters: GetContractsByTraitRequest, initOverrides?: RequestInit): Promise<ContractListResponse>;
|
|
224
255
|
}
|
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
/* tslint:disable */
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
|
-
* Stacks
|
|
6
|
-
*
|
|
5
|
+
* Stacks Blockchain API
|
|
6
|
+
* 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=\"/collection.json\" download=\"stacks-api-collection.json\">Download Postman collection</a>
|
|
7
7
|
*
|
|
8
8
|
* The version of the OpenAPI document: STACKS_API_VERSION
|
|
9
9
|
*
|
|
@@ -61,7 +61,7 @@ class SmartContractsApi extends runtime.BaseAPI {
|
|
|
61
61
|
return await response.value();
|
|
62
62
|
}
|
|
63
63
|
/**
|
|
64
|
-
*
|
|
64
|
+
* Retrieves details of a contract with a given `contract_id`
|
|
65
65
|
* Get contract info
|
|
66
66
|
*/
|
|
67
67
|
async getContractByIdRaw(requestParameters, initOverrides) {
|
|
@@ -82,7 +82,7 @@ class SmartContractsApi extends runtime.BaseAPI {
|
|
|
82
82
|
return new runtime.JSONApiResponse(response);
|
|
83
83
|
}
|
|
84
84
|
/**
|
|
85
|
-
*
|
|
85
|
+
* Retrieves details of a contract with a given `contract_id`
|
|
86
86
|
* Get contract info
|
|
87
87
|
*/
|
|
88
88
|
async getContractById(requestParameters, initOverrides) {
|
|
@@ -90,7 +90,7 @@ class SmartContractsApi extends runtime.BaseAPI {
|
|
|
90
90
|
return await response.value();
|
|
91
91
|
}
|
|
92
92
|
/**
|
|
93
|
-
* Attempt to fetch data from a contract data map. The contract is identified with
|
|
93
|
+
* Attempt to fetch data from a contract data map. The contract is identified with Stacks Address `contract_address` and Contract Name `contract_address` in the URL path. The map is identified with [Map Name]. The key to lookup in the map is supplied via the POST body. This should be supplied as the hex string serialization of the key (which should be a Clarity value). Note, this is a JSON string atom. In the response, `data` is the hex serialization of the map response. Note that map responses are Clarity option types, for non-existent values, this is a serialized none, and for all other responses, it is a serialized (some ...) object.
|
|
94
94
|
* Get specific data-map inside a contract
|
|
95
95
|
*/
|
|
96
96
|
async getContractDataMapEntryRaw(requestParameters, initOverrides) {
|
|
@@ -125,7 +125,7 @@ class SmartContractsApi extends runtime.BaseAPI {
|
|
|
125
125
|
return new runtime.JSONApiResponse(response, (jsonValue) => models_1.MapEntryResponseFromJSON(jsonValue));
|
|
126
126
|
}
|
|
127
127
|
/**
|
|
128
|
-
* Attempt to fetch data from a contract data map. The contract is identified with
|
|
128
|
+
* Attempt to fetch data from a contract data map. The contract is identified with Stacks Address `contract_address` and Contract Name `contract_address` in the URL path. The map is identified with [Map Name]. The key to lookup in the map is supplied via the POST body. This should be supplied as the hex string serialization of the key (which should be a Clarity value). Note, this is a JSON string atom. In the response, `data` is the hex serialization of the map response. Note that map responses are Clarity option types, for non-existent values, this is a serialized none, and for all other responses, it is a serialized (some ...) object.
|
|
129
129
|
* Get specific data-map inside a contract
|
|
130
130
|
*/
|
|
131
131
|
async getContractDataMapEntry(requestParameters, initOverrides) {
|
|
@@ -133,7 +133,7 @@ class SmartContractsApi extends runtime.BaseAPI {
|
|
|
133
133
|
return await response.value();
|
|
134
134
|
}
|
|
135
135
|
/**
|
|
136
|
-
*
|
|
136
|
+
* Retrieves a list of events that have been triggered by a given `contract_id`
|
|
137
137
|
* Get contract events
|
|
138
138
|
*/
|
|
139
139
|
async getContractEventsByIdRaw(requestParameters, initOverrides) {
|
|
@@ -160,7 +160,7 @@ class SmartContractsApi extends runtime.BaseAPI {
|
|
|
160
160
|
return new runtime.JSONApiResponse(response);
|
|
161
161
|
}
|
|
162
162
|
/**
|
|
163
|
-
*
|
|
163
|
+
* Retrieves a list of events that have been triggered by a given `contract_id`
|
|
164
164
|
* Get contract events
|
|
165
165
|
*/
|
|
166
166
|
async getContractEventsById(requestParameters, initOverrides) {
|
|
@@ -168,7 +168,7 @@ class SmartContractsApi extends runtime.BaseAPI {
|
|
|
168
168
|
return await response.value();
|
|
169
169
|
}
|
|
170
170
|
/**
|
|
171
|
-
*
|
|
171
|
+
* Retrieves a contract interface with a given `contract_address` and `contract name`
|
|
172
172
|
* Get contract interface
|
|
173
173
|
*/
|
|
174
174
|
async getContractInterfaceRaw(requestParameters, initOverrides) {
|
|
@@ -192,7 +192,7 @@ class SmartContractsApi extends runtime.BaseAPI {
|
|
|
192
192
|
return new runtime.JSONApiResponse(response, (jsonValue) => models_1.ContractInterfaceResponseFromJSON(jsonValue));
|
|
193
193
|
}
|
|
194
194
|
/**
|
|
195
|
-
*
|
|
195
|
+
* Retrieves a contract interface with a given `contract_address` and `contract name`
|
|
196
196
|
* Get contract interface
|
|
197
197
|
*/
|
|
198
198
|
async getContractInterface(requestParameters, initOverrides) {
|
|
@@ -200,7 +200,7 @@ class SmartContractsApi extends runtime.BaseAPI {
|
|
|
200
200
|
return await response.value();
|
|
201
201
|
}
|
|
202
202
|
/**
|
|
203
|
-
*
|
|
203
|
+
* Retrieves the Clarity source code of a given contract, along with the block height it was published in, and the MARF proof for the data
|
|
204
204
|
* Get contract source
|
|
205
205
|
*/
|
|
206
206
|
async getContractSourceRaw(requestParameters, initOverrides) {
|
|
@@ -227,13 +227,48 @@ class SmartContractsApi extends runtime.BaseAPI {
|
|
|
227
227
|
return new runtime.JSONApiResponse(response, (jsonValue) => models_1.ContractSourceResponseFromJSON(jsonValue));
|
|
228
228
|
}
|
|
229
229
|
/**
|
|
230
|
-
*
|
|
230
|
+
* Retrieves the Clarity source code of a given contract, along with the block height it was published in, and the MARF proof for the data
|
|
231
231
|
* Get contract source
|
|
232
232
|
*/
|
|
233
233
|
async getContractSource(requestParameters, initOverrides) {
|
|
234
234
|
const response = await this.getContractSourceRaw(requestParameters, initOverrides);
|
|
235
235
|
return await response.value();
|
|
236
236
|
}
|
|
237
|
+
/**
|
|
238
|
+
* Retrieves a list of contracts based on the following traits listed in JSON format - functions, variables, maps, fungible tokens and non-fungible tokens
|
|
239
|
+
* Get contracts by trait
|
|
240
|
+
*/
|
|
241
|
+
async getContractsByTraitRaw(requestParameters, initOverrides) {
|
|
242
|
+
if (requestParameters.traitAbi === null || requestParameters.traitAbi === undefined) {
|
|
243
|
+
throw new runtime.RequiredError('traitAbi', 'Required parameter requestParameters.traitAbi was null or undefined when calling getContractsByTrait.');
|
|
244
|
+
}
|
|
245
|
+
const queryParameters = {};
|
|
246
|
+
if (requestParameters.traitAbi !== undefined) {
|
|
247
|
+
queryParameters['trait_abi'] = requestParameters.traitAbi;
|
|
248
|
+
}
|
|
249
|
+
if (requestParameters.limit !== undefined) {
|
|
250
|
+
queryParameters['limit'] = requestParameters.limit;
|
|
251
|
+
}
|
|
252
|
+
if (requestParameters.offset !== undefined) {
|
|
253
|
+
queryParameters['offset'] = requestParameters.offset;
|
|
254
|
+
}
|
|
255
|
+
const headerParameters = {};
|
|
256
|
+
const response = await this.request({
|
|
257
|
+
path: `/extended/v1/contract/by_trait`,
|
|
258
|
+
method: 'GET',
|
|
259
|
+
headers: headerParameters,
|
|
260
|
+
query: queryParameters,
|
|
261
|
+
}, initOverrides);
|
|
262
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => models_1.ContractListResponseFromJSON(jsonValue));
|
|
263
|
+
}
|
|
264
|
+
/**
|
|
265
|
+
* Retrieves a list of contracts based on the following traits listed in JSON format - functions, variables, maps, fungible tokens and non-fungible tokens
|
|
266
|
+
* Get contracts by trait
|
|
267
|
+
*/
|
|
268
|
+
async getContractsByTrait(requestParameters, initOverrides) {
|
|
269
|
+
const response = await this.getContractsByTraitRaw(requestParameters, initOverrides);
|
|
270
|
+
return await response.value();
|
|
271
|
+
}
|
|
237
272
|
}
|
|
238
273
|
exports.SmartContractsApi = SmartContractsApi;
|
|
239
274
|
//# sourceMappingURL=SmartContractsApi.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SmartContractsApi.js","sourceRoot":"","sources":["../../../src/generated/apis/SmartContractsApi.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;AAGH,sCAAsC;AACtC,
|
|
1
|
+
{"version":3,"file":"SmartContractsApi.js","sourceRoot":"","sources":["../../../src/generated/apis/SmartContractsApi.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;AAGH,sCAAsC;AACtC,sCAmBmB;AA+LnB;;GAEG;AACH,MAAa,iBAAkB,SAAQ,OAAO,CAAC,OAAO;IAElD;;;OAGG;IACH,KAAK,CAAC,uBAAuB,CAAC,iBAA8C,EAAE,aAA2B;QACrG,IAAI,iBAAiB,CAAC,eAAe,KAAK,IAAI,IAAI,iBAAiB,CAAC,eAAe,KAAK,SAAS,EAAE;YAC/F,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,iBAAiB,EAAC,+GAA+G,CAAC,CAAC;SACtK;QAED,IAAI,iBAAiB,CAAC,YAAY,KAAK,IAAI,IAAI,iBAAiB,CAAC,YAAY,KAAK,SAAS,EAAE;YACzF,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,cAAc,EAAC,4GAA4G,CAAC,CAAC;SAChK;QAED,IAAI,iBAAiB,CAAC,YAAY,KAAK,IAAI,IAAI,iBAAiB,CAAC,YAAY,KAAK,SAAS,EAAE;YACzF,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,cAAc,EAAC,4GAA4G,CAAC,CAAC;SAChK;QAED,IAAI,iBAAiB,CAAC,oBAAoB,KAAK,IAAI,IAAI,iBAAiB,CAAC,oBAAoB,KAAK,SAAS,EAAE;YACzG,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,sBAAsB,EAAC,oHAAoH,CAAC,CAAC;SAChL;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,IAAI,iBAAiB,CAAC,GAAG,KAAK,SAAS,EAAE;YACrC,eAAe,CAAC,KAAK,CAAC,GAAG,iBAAiB,CAAC,GAAG,CAAC;SAClD;QAED,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,gBAAgB,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAEtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,4EAA4E,CAAC,OAAO,CAAC,IAAI,kBAAkB,GAAG,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,eAAe,GAAG,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,eAAe,GAAG,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC,CAAC;YAC5W,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;YACtB,IAAI,EAAE,mCAA0B,CAAC,iBAAiB,CAAC,oBAAoB,CAAC;SAC3E,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,gDAAuC,CAAC,SAAS,CAAC,CAAC,CAAC;IACpH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,oBAAoB,CAAC,iBAA8C,EAAE,aAA2B;QAClG,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACtF,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,kBAAkB,CAAC,iBAAyC,EAAE,aAA2B;QAC3F,IAAI,iBAAiB,CAAC,UAAU,KAAK,IAAI,IAAI,iBAAiB,CAAC,UAAU,KAAK,SAAS,EAAE;YACrF,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,YAAY,EAAC,qGAAqG,CAAC,CAAC;SACvJ;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,IAAI,iBAAiB,CAAC,UAAU,KAAK,SAAS,EAAE;YAC5C,eAAe,CAAC,YAAY,CAAC,GAAG,iBAAiB,CAAC,UAAU,CAAC;SAChE;QAED,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,qCAAqC,CAAC,OAAO,CAAC,IAAI,aAAa,GAAG,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAC;YACnI,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAM,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,eAAe,CAAC,iBAAyC,EAAE,aAA2B;QACxF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACjF,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,0BAA0B,CAAC,iBAAiD,EAAE,aAA2B;QAC3G,IAAI,iBAAiB,CAAC,eAAe,KAAK,IAAI,IAAI,iBAAiB,CAAC,eAAe,KAAK,SAAS,EAAE;YAC/F,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,iBAAiB,EAAC,kHAAkH,CAAC,CAAC;SACzK;QAED,IAAI,iBAAiB,CAAC,YAAY,KAAK,IAAI,IAAI,iBAAiB,CAAC,YAAY,KAAK,SAAS,EAAE;YACzF,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,cAAc,EAAC,+GAA+G,CAAC,CAAC;SACnK;QAED,IAAI,iBAAiB,CAAC,OAAO,KAAK,IAAI,IAAI,iBAAiB,CAAC,OAAO,KAAK,SAAS,EAAE;YAC/E,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,SAAS,EAAC,0GAA0G,CAAC,CAAC;SACzJ;QAED,IAAI,iBAAiB,CAAC,GAAG,KAAK,IAAI,IAAI,iBAAiB,CAAC,GAAG,KAAK,SAAS,EAAE;YACvE,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,KAAK,EAAC,sGAAsG,CAAC,CAAC;SACjJ;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,IAAI,iBAAiB,CAAC,KAAK,KAAK,SAAS,EAAE;YACvC,eAAe,CAAC,OAAO,CAAC,GAAG,iBAAiB,CAAC,KAAK,CAAC;SACtD;QAED,IAAI,iBAAiB,CAAC,GAAG,KAAK,SAAS,EAAE;YACrC,eAAe,CAAC,KAAK,CAAC,GAAG,iBAAiB,CAAC,GAAG,CAAC;SAClD;QAED,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,gBAAgB,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAEtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,6DAA6D,CAAC,OAAO,CAAC,IAAI,kBAAkB,GAAG,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,eAAe,GAAG,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,UAAU,GAAG,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;YACnV,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;YACtB,IAAI,EAAE,iBAAiB,CAAC,GAAU;SACrC,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,iCAAwB,CAAC,SAAS,CAAC,CAAC,CAAC;IACrG,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,uBAAuB,CAAC,iBAAiD,EAAE,aAA2B;QACxG,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,0BAA0B,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACzF,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,wBAAwB,CAAC,iBAA+C,EAAE,aAA2B;QACvG,IAAI,iBAAiB,CAAC,UAAU,KAAK,IAAI,IAAI,iBAAiB,CAAC,UAAU,KAAK,SAAS,EAAE;YACrF,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,YAAY,EAAC,2GAA2G,CAAC,CAAC;SAC7J;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,IAAI,iBAAiB,CAAC,KAAK,KAAK,SAAS,EAAE;YACvC,eAAe,CAAC,OAAO,CAAC,GAAG,iBAAiB,CAAC,KAAK,CAAC;SACtD;QAED,IAAI,iBAAiB,CAAC,MAAM,KAAK,SAAS,EAAE;YACxC,eAAe,CAAC,QAAQ,CAAC,GAAG,iBAAiB,CAAC,MAAM,CAAC;SACxD;QAED,IAAI,iBAAiB,CAAC,UAAU,KAAK,SAAS,EAAE;YAC5C,eAAe,CAAC,YAAY,CAAC,GAAG,iBAAiB,CAAC,UAAU,CAAC;SAChE;QAED,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,4CAA4C,CAAC,OAAO,CAAC,IAAI,aAAa,GAAG,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAC;YAC1I,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAM,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,qBAAqB,CAAC,iBAA+C,EAAE,aAA2B;QACpG,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACvF,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,uBAAuB,CAAC,iBAA8C,EAAE,aAA2B;QACrG,IAAI,iBAAiB,CAAC,eAAe,KAAK,IAAI,IAAI,iBAAiB,CAAC,eAAe,KAAK,SAAS,EAAE;YAC/F,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,iBAAiB,EAAC,+GAA+G,CAAC,CAAC;SACtK;QAED,IAAI,iBAAiB,CAAC,YAAY,KAAK,IAAI,IAAI,iBAAiB,CAAC,YAAY,KAAK,SAAS,EAAE;YACzF,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,cAAc,EAAC,4GAA4G,CAAC,CAAC;SAChK;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,IAAI,iBAAiB,CAAC,GAAG,KAAK,SAAS,EAAE;YACrC,eAAe,CAAC,KAAK,CAAC,GAAG,iBAAiB,CAAC,GAAG,CAAC;SAClD;QAED,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,4DAA4D,CAAC,OAAO,CAAC,IAAI,kBAAkB,GAAG,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,eAAe,GAAG,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC,CAAC;YAChQ,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,0CAAiC,CAAC,SAAS,CAAC,CAAC,CAAC;IAC9G,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,oBAAoB,CAAC,iBAA8C,EAAE,aAA2B;QAClG,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACtF,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,oBAAoB,CAAC,iBAA2C,EAAE,aAA2B;QAC/F,IAAI,iBAAiB,CAAC,eAAe,KAAK,IAAI,IAAI,iBAAiB,CAAC,eAAe,KAAK,SAAS,EAAE;YAC/F,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,iBAAiB,EAAC,4GAA4G,CAAC,CAAC;SACnK;QAED,IAAI,iBAAiB,CAAC,YAAY,KAAK,IAAI,IAAI,iBAAiB,CAAC,YAAY,KAAK,SAAS,EAAE;YACzF,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,cAAc,EAAC,yGAAyG,CAAC,CAAC;SAC7J;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,IAAI,iBAAiB,CAAC,KAAK,KAAK,SAAS,EAAE;YACvC,eAAe,CAAC,OAAO,CAAC,GAAG,iBAAiB,CAAC,KAAK,CAAC;SACtD;QAED,IAAI,iBAAiB,CAAC,GAAG,KAAK,SAAS,EAAE;YACrC,eAAe,CAAC,KAAK,CAAC,GAAG,iBAAiB,CAAC,GAAG,CAAC;SAClD;QAED,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,yDAAyD,CAAC,OAAO,CAAC,IAAI,kBAAkB,GAAG,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,eAAe,GAAG,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC,CAAC;YAC7P,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,uCAA8B,CAAC,SAAS,CAAC,CAAC,CAAC;IAC3G,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,iBAAiB,CAAC,iBAA2C,EAAE,aAA2B;QAC5F,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACnF,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,sBAAsB,CAAC,iBAA6C,EAAE,aAA2B;QACnG,IAAI,iBAAiB,CAAC,QAAQ,KAAK,IAAI,IAAI,iBAAiB,CAAC,QAAQ,KAAK,SAAS,EAAE;YACjF,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,UAAU,EAAC,uGAAuG,CAAC,CAAC;SACvJ;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,IAAI,iBAAiB,CAAC,QAAQ,KAAK,SAAS,EAAE;YAC1C,eAAe,CAAC,WAAW,CAAC,GAAG,iBAAiB,CAAC,QAAQ,CAAC;SAC7D;QAED,IAAI,iBAAiB,CAAC,KAAK,KAAK,SAAS,EAAE;YACvC,eAAe,CAAC,OAAO,CAAC,GAAG,iBAAiB,CAAC,KAAK,CAAC;SACtD;QAED,IAAI,iBAAiB,CAAC,MAAM,KAAK,SAAS,EAAE;YACxC,eAAe,CAAC,QAAQ,CAAC,GAAG,iBAAiB,CAAC,MAAM,CAAC;SACxD;QAED,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,gCAAgC;YACtC,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,qCAA4B,CAAC,SAAS,CAAC,CAAC,CAAC;IACzG,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,mBAAmB,CAAC,iBAA6C,EAAE,aAA2B;QAChG,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACrF,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;CAEJ;AA5TD,8CA4TC"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Stacks
|
|
3
|
-
*
|
|
2
|
+
* Stacks Blockchain API
|
|
3
|
+
* 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=\"/collection.json\" download=\"stacks-api-collection.json\">Download Postman collection</a>
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: STACKS_API_VERSION
|
|
6
6
|
*
|
|
@@ -33,85 +33,85 @@ export interface GetBurnchainRewardsTotalByAddressRequest {
|
|
|
33
33
|
address: string;
|
|
34
34
|
}
|
|
35
35
|
/**
|
|
36
|
-
*
|
|
36
|
+
* StackingRewardsApi - interface
|
|
37
37
|
*
|
|
38
38
|
* @export
|
|
39
|
-
* @interface
|
|
39
|
+
* @interface StackingRewardsApiInterface
|
|
40
40
|
*/
|
|
41
|
-
export interface
|
|
41
|
+
export interface StackingRewardsApiInterface {
|
|
42
42
|
/**
|
|
43
|
-
*
|
|
43
|
+
* Retrieves a list of recent burnchain (e.g. Bitcoin) reward recipients with the associated amounts and block info
|
|
44
44
|
* @summary Get recent burnchain reward recipients
|
|
45
45
|
* @param {number} [limit] max number of rewards to fetch
|
|
46
46
|
* @param {number} [offset] index of first rewards to fetch
|
|
47
47
|
* @param {*} [options] Override http request option.
|
|
48
48
|
* @throws {RequiredError}
|
|
49
|
-
* @memberof
|
|
49
|
+
* @memberof StackingRewardsApiInterface
|
|
50
50
|
*/
|
|
51
51
|
getBurnchainRewardListRaw(requestParameters: GetBurnchainRewardListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnchainRewardListResponse>>;
|
|
52
52
|
/**
|
|
53
|
-
*
|
|
53
|
+
* Retrieves a list of recent burnchain (e.g. Bitcoin) reward recipients with the associated amounts and block info
|
|
54
54
|
* Get recent burnchain reward recipients
|
|
55
55
|
*/
|
|
56
56
|
getBurnchainRewardList(requestParameters: GetBurnchainRewardListRequest, initOverrides?: RequestInit): Promise<BurnchainRewardListResponse>;
|
|
57
57
|
/**
|
|
58
|
-
*
|
|
58
|
+
* Retrieves a list of recent burnchain (e.g. Bitcoin) rewards for the given recipient with the associated amounts and block info
|
|
59
59
|
* @summary Get recent burnchain reward for the given recipient
|
|
60
60
|
* @param {string} address Reward recipient address. Should either be in the native burnchain\'s format (e.g. B58 for Bitcoin), or if a STX principal address is provided it will be encoded as into the equivalent burnchain format
|
|
61
61
|
* @param {number} [limit] max number of rewards to fetch
|
|
62
62
|
* @param {number} [offset] index of first rewards to fetch
|
|
63
63
|
* @param {*} [options] Override http request option.
|
|
64
64
|
* @throws {RequiredError}
|
|
65
|
-
* @memberof
|
|
65
|
+
* @memberof StackingRewardsApiInterface
|
|
66
66
|
*/
|
|
67
67
|
getBurnchainRewardListByAddressRaw(requestParameters: GetBurnchainRewardListByAddressRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnchainRewardListResponse>>;
|
|
68
68
|
/**
|
|
69
|
-
*
|
|
69
|
+
* Retrieves a list of recent burnchain (e.g. Bitcoin) rewards for the given recipient with the associated amounts and block info
|
|
70
70
|
* Get recent burnchain reward for the given recipient
|
|
71
71
|
*/
|
|
72
72
|
getBurnchainRewardListByAddress(requestParameters: GetBurnchainRewardListByAddressRequest, initOverrides?: RequestInit): Promise<BurnchainRewardListResponse>;
|
|
73
73
|
/**
|
|
74
|
-
*
|
|
74
|
+
* Retrieves a list of the Bitcoin addresses that would validly receive Proof-of-Transfer commitments.
|
|
75
75
|
* @summary Get recent reward slot holders
|
|
76
76
|
* @param {number} [limit] max number of items to fetch
|
|
77
77
|
* @param {number} [offset] index of the first items to fetch
|
|
78
78
|
* @param {*} [options] Override http request option.
|
|
79
79
|
* @throws {RequiredError}
|
|
80
|
-
* @memberof
|
|
80
|
+
* @memberof StackingRewardsApiInterface
|
|
81
81
|
*/
|
|
82
82
|
getBurnchainRewardSlotHoldersRaw(requestParameters: GetBurnchainRewardSlotHoldersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnchainRewardSlotHolderListResponse>>;
|
|
83
83
|
/**
|
|
84
|
-
*
|
|
84
|
+
* Retrieves a list of the Bitcoin addresses that would validly receive Proof-of-Transfer commitments.
|
|
85
85
|
* Get recent reward slot holders
|
|
86
86
|
*/
|
|
87
87
|
getBurnchainRewardSlotHolders(requestParameters: GetBurnchainRewardSlotHoldersRequest, initOverrides?: RequestInit): Promise<BurnchainRewardSlotHolderListResponse>;
|
|
88
88
|
/**
|
|
89
|
-
*
|
|
89
|
+
* Retrieves a list of the Bitcoin addresses that would validly receive Proof-of-Transfer commitments for a given reward slot holder recipient address.
|
|
90
90
|
* @summary Get recent reward slot holder entries for the given address
|
|
91
91
|
* @param {string} address Reward slot holder recipient address. Should either be in the native burnchain\'s format (e.g. B58 for Bitcoin), or if a STX principal address is provided it will be encoded as into the equivalent burnchain format
|
|
92
92
|
* @param {number} [limit] max number of items to fetch
|
|
93
93
|
* @param {number} [offset] index of the first items to fetch
|
|
94
94
|
* @param {*} [options] Override http request option.
|
|
95
95
|
* @throws {RequiredError}
|
|
96
|
-
* @memberof
|
|
96
|
+
* @memberof StackingRewardsApiInterface
|
|
97
97
|
*/
|
|
98
98
|
getBurnchainRewardSlotHoldersByAddressRaw(requestParameters: GetBurnchainRewardSlotHoldersByAddressRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnchainRewardSlotHolderListResponse>>;
|
|
99
99
|
/**
|
|
100
|
-
*
|
|
100
|
+
* Retrieves a list of the Bitcoin addresses that would validly receive Proof-of-Transfer commitments for a given reward slot holder recipient address.
|
|
101
101
|
* Get recent reward slot holder entries for the given address
|
|
102
102
|
*/
|
|
103
103
|
getBurnchainRewardSlotHoldersByAddress(requestParameters: GetBurnchainRewardSlotHoldersByAddressRequest, initOverrides?: RequestInit): Promise<BurnchainRewardSlotHolderListResponse>;
|
|
104
104
|
/**
|
|
105
|
-
*
|
|
105
|
+
* Retrieves the total burnchain (e.g. Bitcoin) rewards for a given recipient `address`
|
|
106
106
|
* @summary Get total burnchain rewards for the given recipient
|
|
107
107
|
* @param {string} address Reward recipient address. Should either be in the native burnchain\'s format (e.g. B58 for Bitcoin), or if a STX principal address is provided it will be encoded as into the equivalent burnchain format
|
|
108
108
|
* @param {*} [options] Override http request option.
|
|
109
109
|
* @throws {RequiredError}
|
|
110
|
-
* @memberof
|
|
110
|
+
* @memberof StackingRewardsApiInterface
|
|
111
111
|
*/
|
|
112
112
|
getBurnchainRewardsTotalByAddressRaw(requestParameters: GetBurnchainRewardsTotalByAddressRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnchainRewardsTotal>>;
|
|
113
113
|
/**
|
|
114
|
-
*
|
|
114
|
+
* Retrieves the total burnchain (e.g. Bitcoin) rewards for a given recipient `address`
|
|
115
115
|
* Get total burnchain rewards for the given recipient
|
|
116
116
|
*/
|
|
117
117
|
getBurnchainRewardsTotalByAddress(requestParameters: GetBurnchainRewardsTotalByAddressRequest, initOverrides?: RequestInit): Promise<BurnchainRewardsTotal>;
|
|
@@ -119,54 +119,54 @@ export interface BurnchainApiInterface {
|
|
|
119
119
|
/**
|
|
120
120
|
*
|
|
121
121
|
*/
|
|
122
|
-
export declare class
|
|
122
|
+
export declare class StackingRewardsApi extends runtime.BaseAPI implements StackingRewardsApiInterface {
|
|
123
123
|
/**
|
|
124
|
-
*
|
|
124
|
+
* Retrieves a list of recent burnchain (e.g. Bitcoin) reward recipients with the associated amounts and block info
|
|
125
125
|
* Get recent burnchain reward recipients
|
|
126
126
|
*/
|
|
127
127
|
getBurnchainRewardListRaw(requestParameters: GetBurnchainRewardListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnchainRewardListResponse>>;
|
|
128
128
|
/**
|
|
129
|
-
*
|
|
129
|
+
* Retrieves a list of recent burnchain (e.g. Bitcoin) reward recipients with the associated amounts and block info
|
|
130
130
|
* Get recent burnchain reward recipients
|
|
131
131
|
*/
|
|
132
132
|
getBurnchainRewardList(requestParameters: GetBurnchainRewardListRequest, initOverrides?: RequestInit): Promise<BurnchainRewardListResponse>;
|
|
133
133
|
/**
|
|
134
|
-
*
|
|
134
|
+
* Retrieves a list of recent burnchain (e.g. Bitcoin) rewards for the given recipient with the associated amounts and block info
|
|
135
135
|
* Get recent burnchain reward for the given recipient
|
|
136
136
|
*/
|
|
137
137
|
getBurnchainRewardListByAddressRaw(requestParameters: GetBurnchainRewardListByAddressRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnchainRewardListResponse>>;
|
|
138
138
|
/**
|
|
139
|
-
*
|
|
139
|
+
* Retrieves a list of recent burnchain (e.g. Bitcoin) rewards for the given recipient with the associated amounts and block info
|
|
140
140
|
* Get recent burnchain reward for the given recipient
|
|
141
141
|
*/
|
|
142
142
|
getBurnchainRewardListByAddress(requestParameters: GetBurnchainRewardListByAddressRequest, initOverrides?: RequestInit): Promise<BurnchainRewardListResponse>;
|
|
143
143
|
/**
|
|
144
|
-
*
|
|
144
|
+
* Retrieves a list of the Bitcoin addresses that would validly receive Proof-of-Transfer commitments.
|
|
145
145
|
* Get recent reward slot holders
|
|
146
146
|
*/
|
|
147
147
|
getBurnchainRewardSlotHoldersRaw(requestParameters: GetBurnchainRewardSlotHoldersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnchainRewardSlotHolderListResponse>>;
|
|
148
148
|
/**
|
|
149
|
-
*
|
|
149
|
+
* Retrieves a list of the Bitcoin addresses that would validly receive Proof-of-Transfer commitments.
|
|
150
150
|
* Get recent reward slot holders
|
|
151
151
|
*/
|
|
152
152
|
getBurnchainRewardSlotHolders(requestParameters: GetBurnchainRewardSlotHoldersRequest, initOverrides?: RequestInit): Promise<BurnchainRewardSlotHolderListResponse>;
|
|
153
153
|
/**
|
|
154
|
-
*
|
|
154
|
+
* Retrieves a list of the Bitcoin addresses that would validly receive Proof-of-Transfer commitments for a given reward slot holder recipient address.
|
|
155
155
|
* Get recent reward slot holder entries for the given address
|
|
156
156
|
*/
|
|
157
157
|
getBurnchainRewardSlotHoldersByAddressRaw(requestParameters: GetBurnchainRewardSlotHoldersByAddressRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnchainRewardSlotHolderListResponse>>;
|
|
158
158
|
/**
|
|
159
|
-
*
|
|
159
|
+
* Retrieves a list of the Bitcoin addresses that would validly receive Proof-of-Transfer commitments for a given reward slot holder recipient address.
|
|
160
160
|
* Get recent reward slot holder entries for the given address
|
|
161
161
|
*/
|
|
162
162
|
getBurnchainRewardSlotHoldersByAddress(requestParameters: GetBurnchainRewardSlotHoldersByAddressRequest, initOverrides?: RequestInit): Promise<BurnchainRewardSlotHolderListResponse>;
|
|
163
163
|
/**
|
|
164
|
-
*
|
|
164
|
+
* Retrieves the total burnchain (e.g. Bitcoin) rewards for a given recipient `address`
|
|
165
165
|
* Get total burnchain rewards for the given recipient
|
|
166
166
|
*/
|
|
167
167
|
getBurnchainRewardsTotalByAddressRaw(requestParameters: GetBurnchainRewardsTotalByAddressRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnchainRewardsTotal>>;
|
|
168
168
|
/**
|
|
169
|
-
*
|
|
169
|
+
* Retrieves the total burnchain (e.g. Bitcoin) rewards for a given recipient `address`
|
|
170
170
|
* Get total burnchain rewards for the given recipient
|
|
171
171
|
*/
|
|
172
172
|
getBurnchainRewardsTotalByAddress(requestParameters: GetBurnchainRewardsTotalByAddressRequest, initOverrides?: RequestInit): Promise<BurnchainRewardsTotal>;
|