@helium/blockchain-api 0.3.5 → 0.3.7

package/dist/index.js

@@ -250,10 +250,12 @@ var TokenBalanceDataSchema = z.object({
   tokens: z.array(TokenAccountSchema)
 });
 var TransferOutputSchema = z.object({
-  transactionData: TransactionDataSchema
+  transactionData: TransactionDataSchema,
+  estimatedSolFee: TokenAmountOutputSchema
 });
 var CreateHntAccountOutputSchema = z.object({
-  transactionData: TransactionDataSchema
+  transactionData: TransactionDataSchema,
+  estimatedSolFee: TokenAmountOutputSchema
 });
 var HotspotTypeSchema = z.enum(["iot", "mobile", "all"]);
 var GetHotspotsInputSchema = z.object({
@@ -364,13 +366,16 @@ var HotspotsDataSchema = z.object({
   totalPages: z.number()
 });
 var ClaimRewardsOutputSchema = z.object({
-  transactionData: TransactionDataSchema
+  transactionData: TransactionDataSchema,
+  estimatedSolFee: TokenAmountOutputSchema
 });
 var TransferHotspotOutputSchema = z.object({
-  transactionData: TransactionDataSchema
+  transactionData: TransactionDataSchema,
+  estimatedSolFee: TokenAmountOutputSchema
 });
 var UpdateRewardsDestinationOutputSchema = z.object({
-  transactionData: TransactionDataSchema
+  transactionData: TransactionDataSchema,
+  estimatedSolFee: TokenAmountOutputSchema
 });
 var SplitShareSchema = z.object({
   wallet: z.string(),
@@ -385,10 +390,12 @@ var SplitResponseSchema = z.object({
   shares: z.array(SplitShareSchema)
 });
 var CreateSplitOutputSchema = z.object({
-  transactionData: TransactionDataSchema
+  transactionData: TransactionDataSchema,
+  estimatedSolFee: TokenAmountOutputSchema
 });
 var DeleteSplitOutputSchema = z.object({
-  transactionData: TransactionDataSchema
+  transactionData: TransactionDataSchema,
+  estimatedSolFee: TokenAmountOutputSchema
 });
 var AutomationStatusOutputSchema = z.object({
   hasExistingAutomation: z.boolean(),
@@ -419,13 +426,16 @@ var AutomationStatusOutputSchema = z.object({
   // lamports as string
 });
 var SetupAutomationOutputSchema = z.object({
-  transactionData: TransactionDataSchema
+  transactionData: TransactionDataSchema,
+  estimatedSolFee: TokenAmountOutputSchema
 });
 var FundAutomationOutputSchema = z.object({
-  transactionData: TransactionDataSchema
+  transactionData: TransactionDataSchema,
+  estimatedSolFee: TokenAmountOutputSchema
 });
 var CloseAutomationOutputSchema = z.object({
-  transactionData: TransactionDataSchema
+  transactionData: TransactionDataSchema,
+  estimatedSolFee: TokenAmountOutputSchema
 });
 var FundingEstimateOutputSchema = z.object({
   rentFee: z.number(),
@@ -492,6 +502,7 @@ var UpdateHotspotInfoInputSchema = z.discriminatedUnion("deviceType", [
 ]);
 var UpdateHotspotInfoOutputSchema = z.object({
   transactionData: TransactionDataSchema,
+  estimatedSolFee: TokenAmountOutputSchema,
   appliedTo: z.object({
     iot: z.boolean(),
     mobile: z.boolean()
@@ -632,15 +643,25 @@ var CreateRewardContractTransactionInputSchema = z.object({
     "The schedule on which rewards would be distributed to recipients"
   )
 });
+var EstimateCostToCreateRewardContractResponseSchema = z.object({
+  total: TokenAmountOutputSchema.describe("The total cost to create the contract."),
+  lineItems: z.object({
+    transactionFees: TokenAmountOutputSchema.describe("The cost of transaction fees, including funding for future scheduled transactions."),
+    rentFee: TokenAmountOutputSchema.describe("The cost of the rent fee."),
+    recipientGift: TokenAmountOutputSchema.describe("The total cost of gifted currency, bundled with the contract.")
+  }).describe("A breakdown of the costs invovled. Should sum to the total cost.")
+});
 var CreateRewardContractTransactionResponseSchema = z.object({
   unsignedTransactionData: TransactionDataSchema.describe(
     "The unsigned transaction data which, when signed and submitted will create the pending or finalized reward contract"
-  )
+  ),
+  estimatedSolFee: TokenAmountOutputSchema
 });
 var DeleteRewardContractTransactionResponseSchema = z.object({
   unsignedTransactionData: TransactionDataSchema.describe(
     "The unsigned transaction data which, when signed and submitted will delete the contract"
-  )
+  ),
+  estimatedSolFee: TokenAmountOutputSchema
 });
 var CreateInviteResponseSchema = z.object({
   unsignedMessage: z.string().min(1).describe(
@@ -655,7 +676,8 @@ var ClaimInviteRequestSchema = z.object({
 var ClaimInviteResponseSchema = z.object({
   unsignedTransactionData: TransactionDataSchema.describe(
     "The unsigned transaction data which, when signed and submitted will claim the pending reward contract"
-  )
+  ),
+  estimatedSolFee: TokenAmountOutputSchema
 });
 var SubmitInputSchema = z.object({
   transactions: z.array(TransactionItemSchema),
@@ -744,6 +766,30 @@ var PayerBatchesOutputSchema = z.object({
     totalPages: z.number()
   })
 });
+var EstimateInputSchema = z.object({
+  transactions: z.array(TransactionItemSchema),
+  parallel: z.boolean(),
+  tag: z.string().optional(),
+  simulationCommitment: z.enum(["confirmed", "finalized"]).optional().default("confirmed")
+});
+var CostBreakdownSchema = z.object({
+  transactionFees: TokenAmountOutputSchema,
+  rent: TokenAmountOutputSchema,
+  tokenTransfers: z.array(TokenAmountOutputSchema)
+});
+var TransactionEstimateSchema = z.object({
+  index: z.number(),
+  computeUnits: z.number(),
+  success: z.boolean(),
+  error: z.string().optional(),
+  logs: z.array(z.string()).optional(),
+  costs: CostBreakdownSchema
+});
+var EstimateOutputSchema = z.object({
+  totalSol: TokenAmountOutputSchema,
+  breakdown: CostBreakdownSchema,
+  transactions: z.array(TransactionEstimateSchema)
+});
 var WelcomePackListInputSchema = z.object({
   walletAddress: WalletAddressSchema
 });
@@ -799,13 +845,16 @@ var WelcomePackSchema = z.object({
 var WelcomePackListOutputSchema = z.array(WelcomePackSchema);
 var WelcomePackCreateOutputSchema = z.object({
   welcomePack: WelcomePackSchema,
-  transactionData: TransactionDataSchema
+  transactionData: TransactionDataSchema,
+  estimatedSolFee: TokenAmountOutputSchema
 });
 var WelcomePackDeleteOutputSchema = z.object({
-  transactionData: TransactionDataSchema
+  transactionData: TransactionDataSchema,
+  estimatedSolFee: TokenAmountOutputSchema
 });
 var WelcomePackClaimOutputSchema = z.object({
-  transactionData: TransactionDataSchema
+  transactionData: TransactionDataSchema,
+  estimatedSolFee: TokenAmountOutputSchema
 });
 var WelcomePackInviteOutputSchema = z.object({
   message: z.string(),
@@ -977,6 +1026,17 @@ var rewardContract = oc.tag("Reward Contract").prefix("/hotspots").router({
     NOT_FOUND,
     BAD_REQUEST
   }).output(FindRewardContractResponseSchema),
+  estimateCreationCost: oc.route({
+    method: "GET",
+    path: "/{entityPubKey}/reward-contract/estimate-creation-cost",
+    summary: "Estimate Creation Cost",
+    description: "Estimates the cost to create a reward contract for a specific hotspot entity."
+  }).input(CreateRewardContractTransactionInputSchema.extend({
+    entityPubKey: HeliumPublicKeySchema.describe("The public key of the hotspot entity")
+  })).output(EstimateCostToCreateRewardContractResponseSchema).errors({
+    BAD_REQUEST,
+    NOT_FOUND
+  }),
   create: oc.route({
     method: "POST",
     path: "/{entityPubKey}/reward-contract",
@@ -1082,6 +1142,10 @@ var transactionsContract = oc.tag("Transactions").router({
   }),
   getByPayerAndTag: oc.route({ method: "GET", path: "/transactions/payer/{payer}/tag/{tag}", summary: "Get transactions by payer and tag" }).input(GetByPayerAndTagInputSchema).output(PayerBatchesOutputSchema).errors({
     BAD_REQUEST
+  }),
+  estimate: oc.route({ method: "POST", path: "/transactions/estimate", summary: "Estimate transaction costs" }).input(EstimateInputSchema).output(EstimateOutputSchema).errors({
+    BAD_REQUEST,
+    SIMULATION_FAILED
   })
 });
 var welcomePacksContract = oc.tag("Welcome Packs").router({
@@ -1192,4 +1256,4 @@ var fullApiContract = oc.router({
   webhooks: webhooksContract
 });
 
-export { AutomationScheduleSchema, AutomationStatusOutputSchema, BAD_REQUEST, BankAccountListOutputSchema, BankAccountSchema, BatchStatusOutputSchema, BridgeTransferSchema, CONFLICT, ClaimInviteRequestSchema, ClaimInviteResponseSchema, ClaimRewardsInputSchema, ClaimRewardsOutputSchema, CloseAutomationInputSchema, CloseAutomationOutputSchema, CreateBankAccountInputSchema, CreateHntAccountInputSchema, CreateHntAccountOutputSchema, CreateInviteResponseSchema, CreateRewardContractTransactionInputSchema, CreateRewardContractTransactionResponseSchema, CreateSplitInputSchema, CreateSplitOutputSchema, DeleteBankAccountInputSchema, DeleteBankAccountOutputSchema, DeleteRewardContractTransactionResponseSchema, DeleteSplitInputSchema, DeleteSplitOutputSchema, DeviceTypeSchema, ErrorResponseSchema, FeesOutputSchema, FindRewardContractResponseSchema, FundAutomationInputSchema, FundAutomationOutputSchema, FundingEstimateOutputSchema, GetAutomationStatusInputSchema, GetBalancesInputSchema, GetBankAccountInputSchema, GetByPayerAndTagInputSchema, GetByPayerInputSchema, GetFundingEstimateInputSchema, GetHotspotsInputSchema, GetInputSchema, GetInstructionsInputSchema, GetPendingRewardsInputSchema, GetPendingRewardsOutputSchema, GetQuoteInputSchema, GetSendQuoteInputSchema, GetSplitInputSchema, GetTokensInputSchema, GetTransferInputSchema, HealthResponseSchema, HeliumPublicKeySchema, HotspotSchema, HotspotSharesSchema, HotspotTypeSchema, HotspotsDataSchema, INSUFFICIENT_FUNDS, INVALID_WALLET_ADDRESS, InitKycInputSchema, KycStatusOutputSchema, NOT_FOUND, OwnershipTypeSchema, PaginationInputSchema, PaginationOutputSchema, PayerBatchSummarySchema, PayerBatchesOutputSchema, PublicKeySchema, QuoteOutputSchema, QuoteResponseSchema, RATE_LIMITED, ResubmitInputSchema, ResubmitOutputSchema, RewardSplitInputSchema, SIMULATION_FAILED, ScheduleInputSchema, SendFundsInputSchema, SendFundsOutputSchema, SetupAutomationInputSchema, SetupAutomationOutputSchema, SplitResponseSchema, SplitShareSchema, SubmitInputSchema, SubmitOutputSchema, SwapTransactionDataSchema, TRANSACTION_FAILED, TokenAccountSchema, TokenAmountInputSchema, TokenAmountOutputSchema, TokenBalanceDataSchema, TokenListOutputSchema, TokenSchema, TransactionBatchRequestSchema, TransactionBatchResponseSchema, TransactionDataSchema, TransactionItemSchema, TransactionMetadataSchema, TransactionStatusSchema, TransferHotspotInputSchema, TransferHotspotOutputSchema, TransferInputSchema, TransferOutputSchema, UNAUTHENTICATED, UNAUTHORIZED, UpdateHotspotInfoInputSchema, UpdateHotspotInfoOutputSchema, UpdateRewardsDestinationInputSchema, UpdateRewardsDestinationOutputSchema, UpdateTransferInputSchema, UpdateTransferOutputSchema, WalletAddressSchema, WelcomePackClaimInputSchema, WelcomePackClaimOutputSchema, WelcomePackCreateInputSchema, WelcomePackCreateOutputSchema, WelcomePackDeleteInputSchema, WelcomePackDeleteOutputSchema, WelcomePackGetByAddressInputSchema, WelcomePackGetInputSchema, WelcomePackInviteInputSchema, WelcomePackInviteOutputSchema, WelcomePackListInputSchema, WelcomePackListOutputSchema, WelcomePackSchema, apiContract, fullApiContract };
+export { AutomationScheduleSchema, AutomationStatusOutputSchema, BAD_REQUEST, BankAccountListOutputSchema, BankAccountSchema, BatchStatusOutputSchema, BridgeTransferSchema, CONFLICT, ClaimInviteRequestSchema, ClaimInviteResponseSchema, ClaimRewardsInputSchema, ClaimRewardsOutputSchema, CloseAutomationInputSchema, CloseAutomationOutputSchema, CreateBankAccountInputSchema, CreateHntAccountInputSchema, CreateHntAccountOutputSchema, CreateInviteResponseSchema, CreateRewardContractTransactionInputSchema, CreateRewardContractTransactionResponseSchema, CreateSplitInputSchema, CreateSplitOutputSchema, DeleteBankAccountInputSchema, DeleteBankAccountOutputSchema, DeleteRewardContractTransactionResponseSchema, DeleteSplitInputSchema, DeleteSplitOutputSchema, DeviceTypeSchema, ErrorResponseSchema, EstimateCostToCreateRewardContractResponseSchema, EstimateInputSchema, EstimateOutputSchema, FeesOutputSchema, FindRewardContractResponseSchema, FundAutomationInputSchema, FundAutomationOutputSchema, FundingEstimateOutputSchema, GetAutomationStatusInputSchema, GetBalancesInputSchema, GetBankAccountInputSchema, GetByPayerAndTagInputSchema, GetByPayerInputSchema, GetFundingEstimateInputSchema, GetHotspotsInputSchema, GetInputSchema, GetInstructionsInputSchema, GetPendingRewardsInputSchema, GetPendingRewardsOutputSchema, GetQuoteInputSchema, GetSendQuoteInputSchema, GetSplitInputSchema, GetTokensInputSchema, GetTransferInputSchema, HealthResponseSchema, HeliumPublicKeySchema, HotspotSchema, HotspotSharesSchema, HotspotTypeSchema, HotspotsDataSchema, INSUFFICIENT_FUNDS, INVALID_WALLET_ADDRESS, InitKycInputSchema, KycStatusOutputSchema, NOT_FOUND, OwnershipTypeSchema, PaginationInputSchema, PaginationOutputSchema, PayerBatchSummarySchema, PayerBatchesOutputSchema, PublicKeySchema, QuoteOutputSchema, QuoteResponseSchema, RATE_LIMITED, ResubmitInputSchema, ResubmitOutputSchema, RewardSplitInputSchema, SIMULATION_FAILED, ScheduleInputSchema, SendFundsInputSchema, SendFundsOutputSchema, SetupAutomationInputSchema, SetupAutomationOutputSchema, SplitResponseSchema, SplitShareSchema, SubmitInputSchema, SubmitOutputSchema, SwapTransactionDataSchema, TRANSACTION_FAILED, TokenAccountSchema, TokenAmountInputSchema, TokenAmountOutputSchema, TokenBalanceDataSchema, TokenListOutputSchema, TokenSchema, TransactionBatchRequestSchema, TransactionBatchResponseSchema, TransactionDataSchema, TransactionItemSchema, TransactionMetadataSchema, TransactionStatusSchema, TransferHotspotInputSchema, TransferHotspotOutputSchema, TransferInputSchema, TransferOutputSchema, UNAUTHENTICATED, UNAUTHORIZED, UpdateHotspotInfoInputSchema, UpdateHotspotInfoOutputSchema, UpdateRewardsDestinationInputSchema, UpdateRewardsDestinationOutputSchema, UpdateTransferInputSchema, UpdateTransferOutputSchema, WalletAddressSchema, WelcomePackClaimInputSchema, WelcomePackClaimOutputSchema, WelcomePackCreateInputSchema, WelcomePackCreateOutputSchema, WelcomePackDeleteInputSchema, WelcomePackDeleteOutputSchema, WelcomePackGetByAddressInputSchema, WelcomePackGetInputSchema, WelcomePackInviteInputSchema, WelcomePackInviteOutputSchema, WelcomePackListInputSchema, WelcomePackListOutputSchema, WelcomePackSchema, apiContract, fullApiContract };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helium/blockchain-api",
-  "version": "0.3.5",
+  "version": "0.3.7",
   "description": "TypeScript client and schemas for the Helium Blockchain API",
   "license": "Apache-2.0",
   "repository": {
@@ -34,4 +34,4 @@
     "tsup": "^8.0.0",
     "typescript": "^5.0.0"
   }
-}
+}