V7 tweaks #317
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -70,20 +70,20 @@ As well as allowing you to control creation and deployment of apps, the `AppFact | |
| This is possible via two methods on the app factory: | ||
|
|
||
| - [`factory.getAppClientById(params)`](../code/classes/types_app_factory.AppFactory.md#getappclientbyid) - Returns a new `AppClient` client for an app instance of the given ID. Automatically populates appName, defaultSender and source maps from the factory if not specified in the params. | ||
| - [`factory.getAppClientByCreatorAndName(params)`](../code/classes/types_app_factory.AppFactory.md#getappclientbycreatorandname) - Returns a new `AppClient` client, resolving the app by creator address and name using AlgoKit app deployment semantics (i.e. looking for the app creation transaction note). Automatically populates appName, defaultSender and source maps from the factory if not specified in the params. | ||
|
|
||
| ```typescript | ||
| const appClient1 = factory.getAppClientById({ appId: 12345n }) | ||
| const appClient2 = factory.getAppClientById({ appId: 12346n }) | ||
| const appClient3 = factory.getAppClientById({ appId: 12345n, defaultSender: 'SENDER2ADDRESS' }) | ||
| const appClient4 = factory.getAppClientByCreatorAndName({ | ||
| creatorAddress: 'CREATORADDRESS', | ||
| }) | ||
| const appClient5 = factory.getAppClientByCreatorAndName({ | ||
| creatorAddress: 'CREATORADDRESS', | ||
| appName: 'NonDefaultAppName', | ||
| }) | ||
| const appClient6 = factory.getAppClientByCreatorAndName({ | ||
| creatorAddress: 'CREATORADDRESS', | ||
| appName: 'NonDefaultAppName', | ||
| ignoreCache: true, // Perform fresh indexer lookups | ||
|
|
@@ -108,9 +108,9 @@ The create method is a wrapper over the `appCreate` (bare calls) and `appCreateM | |
|
|
||
| ```typescript | ||
| // Use no-argument bare-call | ||
| const { result, appClient } = factory.send.bare.create() | ||
| // Specify parameters for bare-call and override other parameters | ||
| const { result, appClient } = factory.send.bare.create({ | ||
|
There was a problem hiding this comment. We also settled on |
||
| args: [new Uint8Array(1, 2, 3, 4)], | ||
| staticFee: (3000).microAlgo(), | ||
| onComplete: algosdk.OnApplicationComplete.OptIn, | ||
|
|
@@ -123,13 +123,13 @@ const { result, app } = factory.create({ | |
| populateAppCallResources: true, | ||
| }) | ||
| // Specify parameters for ABI method call | ||
| const { result, appClient } = factory.send.create({ | ||
| method: 'create_application', | ||
| args: [1, 'something'], | ||
| }) | ||
| ``` | ||
|
|
||
| If you want to construct a custom create call, use the underlying [`algorand.send.appCreate` / `algorand.createTransaction.appCreate` / `algorand.send.appCreateMethodCall` / `algorand.createTransaction.appCreateMethodCall` methods](./app.md#creation) then you can get params objects: | ||
|
There was a problem hiding this comment. @SilentRhetoric We didn't rename |
||
|
|
||
| - `factory.params.create(params)` - ABI method create call for deploy method or an underlying [`appCreateMethodCall` call](./app.md#creation) | ||
| - `factory.params.bare.create(params)` - Bare create call for deploy method or an underlying [`appCreate` call](./app.md#creation) | ||
|
|
@@ -150,9 +150,9 @@ The deploy method is a wrapper over the [`AppDeployer`'s `deploy` method](./app- | |
| ```typescript | ||
| // Use no-argument bare-calls to deploy with default behaviour | ||
| // for when update or schema break detected (fail the deployment) | ||
| const { result, appClient } = factory.deploy({}) | ||
| // Specify parameters for bare-calls and override the schema break behaviour | ||
| const { result, appClient } = factory.deploy({ | ||
| createParams: { | ||
| args: [new Uint8Array(1, 2, 3, 4)], | ||
| staticFee: (3000).microAlgo(), | ||
|
|
@@ -174,7 +174,7 @@ const { result, app } = factory.deploy({ | |
| deletable: true, | ||
| }) | ||
| // Specify parameters for ABI method calls | ||
| const { result, appClient } = factory.deploy({ | ||
| createParams: { | ||
| method: "create_application", | ||
| args: [1, "something"], | ||
|
|
@@ -210,8 +210,8 @@ This is done via the following properties: | |
|
|
||
| - `appClient.params.{onComplete}(params)` - Params for an ABI method call | ||
| - `appClient.params.bare.{onComplete}(params)` - Params for a bare call | ||
| - `appClient.createTransaction.{onComplete}(params)` - Transaction(s) for an ABI method call | ||
| - `appClient.createTransaction.bare.{onComplete}(params)` - Transaction for a bare call | ||
| - `appClient.send.{onComplete}(params)` - Sign and send an ABI method call | ||
| - `appClient.send.bare.{onComplete}(params)` - Sign and send a bare call | ||
|
|
||
|
|
@@ -229,23 +229,23 @@ The input payload for all of these calls is the same as the [underlying app meth | |
| The return payload for all of these is the same as the [underlying methods](./app.md#calling-apps). | ||
|
|
||
| ```typescript | ||
| const call1 = await appClient.send.update({ | ||
| method: 'update_abi', | ||
| args: ['string_io'], | ||
| deployTimeParams, | ||
| }) | ||
| const call2 = await appClient.send.delete({ | ||
| method: 'delete_abi', | ||
| args: ['string_io'], | ||
| }) | ||
| const call3 = await appClient.send.optIn({ method: 'opt_in' }) | ||
| const call4 = await appClient.send.bare.clearState() | ||
|
|
||
| const transaction = await appClient.createTransaction.bare.closeOut({ | ||
| args: [new Uint8Array(1, 2, 3)], | ||
| }) | ||
|
|
||
| const params = appClient.params.optIn({ method: 'optin' }) | ||
| ``` | ||
|
|
||
| ## Funding the app account | ||
|
|
@@ -259,18 +259,18 @@ The input parameters are: | |
| Note: If you are passing the funding payment in as an ABI argument so it can be validated by the ABI method then you'll want to get the funding call as a transaction, e.g.: | ||
|
|
||
| ```typescript | ||
| const result = await appClient.send.call({ | ||
| method: 'bootstrap', | ||
| args: [ | ||
| appClient.createTransaction.fundAppAccount({ | ||
| amount: microAlgo(200_000), | ||
| }), | ||
| ], | ||
| boxReferences: ['Box1'], | ||
| }) | ||
| ``` | ||
|
|
||
| You can also get the funding call as a params object via `appClient.params.fundAppAccount(params)`. | ||
|
|
||
| ## Reading state | ||
|
|
||
|
|
@@ -282,9 +282,9 @@ The ARC-56 app spec can specify detailed information about the encoding format o | |
|
|
||
| You can access this functionality via: | ||
|
|
||
| - `appClient.state.global.{method}()` - Global state | ||
| - `appClient.state.local(address).{method}()` - Local state | ||
| - `appClient.state.box.{method}()` - Box storage | ||
|
|
||
| Where `{method}` is one of: | ||
|
|
||
|
|
@@ -294,10 +294,10 @@ Where `{method}` is one of: | |
| - `getMap(mapName)` - Returns all map values for the given map in a key=>value record. It's recommended that this is only done when you have a unique `prefix` for the map otherwise there's a high risk that incorrect values will be included in the map. | ||
|
|
||
| ```typescript | ||
| const values = appClient.state.global.getAll() | ||
| const value = appClient.state.local('ADDRESS').getValue('value1') | ||
| const mapValue = appClient.state.box.getMapValue('map1', 'mapKey') | ||
| const map = appClient.state.global.getMap('myMap') | ||
| ``` | ||
|
|
||
| ### Generic methods | ||
|
|
@@ -313,17 +313,17 @@ There are various methods defined that let you read state from the smart contrac | |
| - `getBoxValuesFromABIType(type, filter)` - Gets the current values of the boxes from an ABI type using [`algorand.app.getBoxValuesFromABIType`](./app.md#boxes) | ||
|
|
||
| ```typescript | ||
| const globalState = await appClient.getGlobalState() | ||
| const localState = await appClient.getLocalState('ACCOUNTADDRESS') | ||
|
|
||
| const boxName: BoxReference = 'my-box' | ||
| const boxName2: BoxReference = 'my-box2' | ||
|
|
||
| const boxNames = appClient.getBoxNames() | ||
| const boxValue = appClient.getBoxValue(boxName) | ||
| const boxValues = appClient.getBoxValues([boxName, boxName2]) | ||
| const boxABIValue = appClient.getBoxValueFromABIType(boxName, algosdk.ABIStringType) | ||
| const boxABIValues = appClient.getBoxValuesFromABIType([boxName, boxName2], algosdk.ABIStringType) | ||
| ``` | ||
|
|
||
| ## Handling logic errors and diagnosing errors | ||
|
|
@@ -364,3 +364,7 @@ Config.configure({ debug: true }) | |
| If you do that then the exception will have the `traces` property within the underlying exception will have key information from the simulation within it and this will get populated into the `led.traces` property of the thrown error. | ||
|
|
||
| When this debug flag is set, it will also emit debugging symbols to allow break-point debugging of the calls if the [project root is also configured](./debugging.md). | ||
|
|
||
| ## Default arguments | ||
|
|
||
| If an ABI method call specifies default argument values for any of its arguments you can pass in `undefined` for the value of that argument for the default value to be automatically populated. | ||
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@SilentRhetoric even though it adds a little bit of verbosity we made the decision that every time a transaction is sent to the network you will see the word
send(apart from thedeploycall, but that's a special case since it may or may not send transactions and is a higher-order function).As part of this we renamed
executetosend(with a backwards compatible@deprecate) inAlgoKitComposerand renamedExecuteParamstoSendParams.