Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: allow passing boxname when getting box value #351

Merged
merged 2 commits into from
Dec 14, 2024
+18 −17
Merged

fix: allow passing boxname when getting box value #351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6829add
fix: allow passing boxname when getting box value
neilcampbell Dec 13, 2024
d96975d
chore: fix audit issues
neilcampbell Dec 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions docs/code/classes/types_app_manager.AppManager.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ Returns the value of the given box name for the given app.
| Name | Type | Description |
| :------ | :------ | :------ |
| `appId` | `bigint` | The ID of the app return box names for |
| `boxName` | [`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) | The name of the box to return either as a string, binary array or `BoxName` |
| `boxName` | [`BoxName`](../interfaces/types_app.BoxName.md) \| [`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) | The name of the box to return either as a string, binary array or `BoxName` |

#### Returns

Expand Down Expand Up @@ -213,7 +213,7 @@ The current box value as an ABI value

#### Defined in

[src/types/app-manager.ts:277](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L277)
[src/types/app-manager.ts:278](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L278)

___

Expand All @@ -228,7 +228,7 @@ Returns the value of the given box names for the given app.
| Name | Type | Description |
| :------ | :------ | :------ |
| `appId` | `bigint` | The ID of the app return box names for |
| `boxNames` | [`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier)[] | The names of the boxes to return either as a string, binary array or `BoxName` |
| `boxNames` | ([`BoxName`](../interfaces/types_app.BoxName.md) \| [`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier))[] | The names of the boxes to return either as a string, binary array or `BoxName` |

#### Returns

Expand All @@ -238,7 +238,7 @@ The current box values as a byte array in the same order as the passed in box na

#### Defined in

[src/types/app-manager.ts:268](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L268)
[src/types/app-manager.ts:269](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L269)

___

Expand All @@ -262,7 +262,7 @@ The current box values as an ABI value in the same order as the passed in box na

#### Defined in

[src/types/app-manager.ts:288](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L288)
[src/types/app-manager.ts:289](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L289)

___

Expand Down Expand Up @@ -391,7 +391,7 @@ An object keyeed by the UTF-8 representation of the key with various parsings of

#### Defined in

[src/types/app-manager.ts:312](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L312)
[src/types/app-manager.ts:313](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L313)

___

Expand All @@ -416,7 +416,7 @@ The return value for the method call

#### Defined in

[src/types/app-manager.ts:361](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L361)
[src/types/app-manager.ts:362](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L362)

___

Expand All @@ -440,7 +440,7 @@ The box reference ready to pass into a `algosdk.Transaction`

#### Defined in

[src/types/app-manager.ts:298](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L298)
[src/types/app-manager.ts:299](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L299)

___

Expand Down Expand Up @@ -473,7 +473,7 @@ The replaced TEAL code

#### Defined in

[src/types/app-manager.ts:391](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L391)
[src/types/app-manager.ts:392](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L392)

___

Expand All @@ -500,7 +500,7 @@ The TEAL code with replacements

#### Defined in

[src/types/app-manager.ts:422](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L422)
[src/types/app-manager.ts:423](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L423)

___

Expand All @@ -524,4 +524,4 @@ The TEAL without comments

#### Defined in

[src/types/app-manager.ts:457](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L457)
[src/types/app-manager.ts:458](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L458)
6 changes: 3 additions & 3 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 4 additions & 3 deletions src/types/app-manager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,8 +253,9 @@ export class AppManager {
* @param boxName The name of the box to return either as a string, binary array or `BoxName`
* @returns The current box value as a byte array
*/
public async getBoxValue(appId: bigint, boxName: BoxIdentifier): Promise<Uint8Array> {
const name = AppManager.getBoxReference(boxName).name
public async getBoxValue(appId: bigint, boxName: BoxIdentifier | BoxName): Promise<Uint8Array> {
const boxId = typeof boxName === 'object' && 'nameRaw' in boxName ? boxName.nameRaw : boxName
const name = AppManager.getBoxReference(boxId).name
const boxResult = await this._algod.getApplicationBoxByName(Number(appId), name).do()
return boxResult.value
}
Expand All @@ -265,7 +266,7 @@ export class AppManager {
* @param boxNames The names of the boxes to return either as a string, binary array or `BoxName`
* @returns The current box values as a byte array in the same order as the passed in box names
*/
public async getBoxValues(appId: bigint, boxNames: BoxIdentifier[]): Promise<Uint8Array[]> {
public async getBoxValues(appId: bigint, boxNames: (BoxIdentifier | BoxName)[]): Promise<Uint8Array[]> {
return await Promise.all(boxNames.map(async (boxName) => await this.getBoxValue(appId, boxName)))
}

Expand Down
Loading