GetApplicationBoxByName API #586
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jasonpaulos
reviewed
Jun 22, 2022
algochoi
commented
Jul 6, 2022
algochoi
commented
Jul 6, 2022
jdtzmn
reviewed
Jul 6, 2022
| } | ||
|
|
||
| // name sets the box name in base64 encoded format. | ||
| name(name: Uint8Array) { |
There was a problem hiding this comment.
Why limit the name to Uint8Array and then encoding that as a base64 app arg as opposed to supporting the app arg format directly?
There was a problem hiding this comment.
Good question - We discussed a bit about it offline last week and came to two thoughts:
- Since
appArgsare inUint8Arrayin this SDK, it makes sense for box name to mimic the JS SDK format (rather than mimic the goal format) - It's out of scope for this PR to include these conversion tools for now. We may revisit this in the future and provide functions to convert
ints oraddrs later for box names.
There was a problem hiding this comment.
Makes sense. Thanks for the explanation!
| @@ -127,6 +127,54 @@ module.exports = function getSteps(options) { | |||
|
|
|||
| const { algod_token: algodToken, kmd_token: kmdToken } = options; | |||
|
|
|||
| // String parsing helper methods | |||
| function processAppArgs(subArg) { | |||
There was a problem hiding this comment.
If not supporting passing app args directly through the name() method, consider exporting this method to make it easier to encode app args.
jdtzmn
approved these changes
Jul 6, 2022
| import HTTPClient from '../../client'; | ||
| import IntDecoding from '../../../types/intDecoding'; | ||
|
|
||
| export default class GetApplicationBoxByName extends JSONRequest { |
There was a problem hiding this comment.
nit: consider typing the response with JSONRequest<types.Box>
michaeldiamant
approved these changes
Jul 7, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces:
GetApplicationBoxByNameendpoint for boxes