Skip to content

Commit

Permalink
🤖 Documentation auto-update
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Oct 16, 2024
1 parent 1027996 commit 3609e96
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions packages/utils/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,13 +128,14 @@ Create an agent for a given identity

Parameters:

- `identity`: A mandatory identity to use for the agent
- `host`: An optional host to connect to
- `fetchRootKey`: Fetch root key for certificate validation during local development or on testnet
- `verifyQuerySignatures`: Check for signatures in the state tree signed by the node that replies to queries - i.e. certify responses.
- `retryTimes`: Set the number of retries the agent should perform before errorring.

[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/agent.utils.ts#L24)
- `params`: The parameters to create a new HTTP agent
- `params.identity`: A mandatory identity to use for the agent
- `params.host`: An optional host to connect to
- `params.fetchRootKey`: Fetch root key for certificate validation during local development or on testnet
- `params.verifyQuerySignatures`: Check for signatures in the state tree signed by the node that replies to queries - i.e. certify responses.
- `params.retryTimes`: Set the number of retries the agent should perform before errorring.

[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/agent.utils.ts#L26)

#### :gear: createServices

Expand Down

0 comments on commit 3609e96

Please sign in to comment.