Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
Signed-off-by: Chengxuan Xing <[email protected]>
  • Loading branch information
Chengxuan committed Jan 9, 2024
1 parent 61c4506 commit 585884e
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,15 +127,15 @@ There are various options for creating your own customized tests. A full list of
- The test will allow at most `startRate` actions to happen per second. Over the period of `rateRampUpTime` seconds the allowed rate will increase linearly until `endRate` actions per seconds are reached. At this point the test will continue at `endRate` actions per second until the test finishes.
- If `startRate` is the only value that is set, the test will run at that rate for the entire test.
- Waiting for mint transactions to be confirmed before doing the next one
- See `NoWaitSubmission` (defaults to `false`).
- See `noWaitSubmission` (defaults to `false`).
- When set to `true` each worker routine will perform its action (e.g. minting a token) and wait for confirmation of that event before doing its next action.
- Setting the features of a token being tested
- See `supportsData` and `supportsURI` attributes of a test instance.
- `supportsData` defaults to `true` since the sample token contract used by FireFly supports minting tokens with data. When set to `true` the message included in the mint transaction will include the ID of the worker routine and used to correlate received confirmation events.
- `supportsURI` defaults to `true` for nonfungible tokens. This attribute is ignored for fungible token tests. If set to `true` the ID of a worker routine will be set in the URI and used to correlate received confirmation events.
- If neither attribute is set to true any received confirmation events cannot be correlated with mint transactions. In this case the test behaves as if `NoWaitSubmission` is set to `true`.
- If neither attribute is set to true any received confirmation events cannot be correlated with mint transactions. In this case the test behaves as if `noWaitSubmission` is set to `true`.
- Waiting at the end of the test for the minted token balance of the `mintRecipient` address to equal the expected value. Since a test might be run several times with the same address the test gets the balance at the beginning of the test, and then again at the end. The difference is expected to equal the value of `maxActions`. To enable this check set the `maxTokenBalanceWait` token option the length of time to wait for the balance to be reached. If `maxTokenBalanceWait` is not set the test will not check balances.
- Having a worker loop submit more than 1 action per loop by setting `actionsPerLoop` for the test. This can be helpful when you want to scale the number of actions done in parallel without having to scale the number of workers. The default value is `1` for this attribute. If setting to a value > `1` it is recommended to have `NoWaitSubmission` to set `false`.
- Having a worker loop submit more than 1 action per loop by setting `actionsPerLoop` for the test. This can be helpful when you want to scale the number of actions done in parallel without having to scale the number of workers. The default value is `1` for this attribute. If setting to a value > `1` it is recommended to have `noWaitSubmission` to set `false`.

## Distributed Deployment

Expand Down
2 changes: 1 addition & 1 deletion config/example-remote-node-instances-fungible.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ instances:
workers: 4
fireflyNamespace: default
maxTimePerAction: 300s
NoWaitSubmission: true
noWaitSubmission: true
rampLength: 60m
tokenOptions:
tokenType: nonfungible
Expand Down
2 changes: 1 addition & 1 deletion scripts/prepForRemote.sh
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ instances:
apiPrefix: ${REMOTE_ENDPOINT_API_PREFIX}
signingAddress: ${SIGNING_KEY}
maxTimePerAction: 60s
NoWaitSubmission: true
noWaitSubmission: true
delinquentAction: log
length: 500h
tokenOptions:
Expand Down

0 comments on commit 585884e

Please sign in to comment.