@algorandfoundation/algokit-client-generator 2.2.5 → 2.2.6-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -3
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# AlgoKit TypeScript client generator (algokit-client-generator-ts)
|
|
2
2
|
|
|
3
|
-
This project generates a type-safe smart contract client in TypeScript for the Algorand Blockchain that wraps the [application client](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/docs/capabilities/app-client.md) in [AlgoKit Utils](https://github.com/algorandfoundation/algokit-utils-ts). It does this by reading an [ARC-0032](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0032.md) application spec file.
|
|
3
|
+
This project generates a type-safe smart contract client in TypeScript for the Algorand Blockchain that wraps the [application client](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/docs/capabilities/app-client.md) in [AlgoKit Utils](https://github.com/algorandfoundation/algokit-utils-ts) and tailors it to a specific smart contract. It does this by reading an [ARC-0032](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0032.md) application spec file and generating a client which exposes methods for each ABI method in the target smart contract, along with helpers to create, update, and delete the application.
|
|
4
4
|
|
|
5
5
|
## Usage
|
|
6
6
|
|
|
@@ -9,17 +9,19 @@ This project generates a type-safe smart contract client in TypeScript for the A
|
|
|
9
9
|
To be able to consume the generated file you need to include it in a TypeScript project that has (at least) the following package installed:
|
|
10
10
|
|
|
11
11
|
```
|
|
12
|
-
npm install @algorandfoundation/algokit-utils
|
|
12
|
+
npm install @algorandfoundation/algokit-utils
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
### Use
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
The cli can be used to generate a client via the following command.
|
|
18
18
|
|
|
19
19
|
```
|
|
20
20
|
npx --yes @algorandfoundation/algokit-client-generator generate -a ./application.json -o ./client.generated.ts
|
|
21
21
|
```
|
|
22
22
|
|
|
23
|
+
For details on how to use the generated client see the more detailed [usage docs](./docs/usage.md)
|
|
24
|
+
|
|
23
25
|
## Examples
|
|
24
26
|
|
|
25
27
|
There are a range of [examples](./examples) that you can look at to see a source smart contract (`{contract.py}`), the generated client (`client.ts`) and some tests that demonstrate how you can use the client (`client.spec.ts`).
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"main": "index.js",
|
|
3
3
|
"types": "index.d.ts",
|
|
4
4
|
"name": "@algorandfoundation/algokit-client-generator",
|
|
5
|
-
"version": "2.2.
|
|
5
|
+
"version": "2.2.6-beta.1",
|
|
6
6
|
"description": "Generates a TypeScript client for interacting with, and deploying ARC-0032 smart contracts on the Algorand Blockchain.",
|
|
7
7
|
"private": false,
|
|
8
8
|
"bin": {
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
"semver": "7.5.2"
|
|
16
16
|
},
|
|
17
17
|
"dependencies": {
|
|
18
|
-
"@algorandfoundation/algokit-utils": "^
|
|
18
|
+
"@algorandfoundation/algokit-utils": "^5.0.0",
|
|
19
19
|
"algosdk": "^2.5.0",
|
|
20
20
|
"chalk": "^4.1.2",
|
|
21
21
|
"change-case": "^4.1.2",
|