Skip to content

Commit

Permalink
Port code examples to another repo; update dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
SeiyaKobayashi committed Aug 29, 2024
1 parent 405db52 commit 991a698
Show file tree
Hide file tree
Showing 22 changed files with 57 additions and 2,834 deletions.
3 changes: 0 additions & 3 deletions .gitmodules

This file was deleted.

6 changes: 0 additions & 6 deletions packages/v1/.env.example

This file was deleted.

1 change: 0 additions & 1 deletion packages/v1/JPYCv2
Submodule JPYCv2 deleted from e06edf
36 changes: 11 additions & 25 deletions packages/v1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ Install packages.

```sh
# yarn
$ yarn add @jpyc/sdk-core @jpyc/sdk-v1
$ yarn add @jpyc/sdk-v1

# npm
$ npm i @jpyc/sdk-core @jpyc/sdk-v1
$ npm i @jpyc/sdk-v1
```

#### 2. Set Environment Variables
Expand Down Expand Up @@ -78,34 +78,20 @@ console.log(`totalSupply: ${totalSupply.toString()}`);

## ✨ Code Examples

For your reference, we provide code examples in `examples` directory. Please follow the instructions on [`README`](./examples/README.md) file.
For your reference, we provide code examples in the separate [`sdk-examples` repository](https://github.com/jcam1/sdk-examples). Please follow the instructions specified in `README` files.

## 🤖 Available Commands

The following commands are available as yarn scripts for local development & testing.

| Command | Description |
| ----------------------------: | :------------------------------------------------------ |
| `docs` | Generate Markdown documents from TSDoc-style comments |
| `env` | Generate `.env` file |
| `lint` | Run Eslint |
| `lint:dry-run` | Run Eslint without fixing |
| `format` | Run Prettier |
| `format:dry-run` | Run Prettier without fixing |
| `compile` | Compile (transpile) SDK |
| `compile:contracts` | Compile contracts |
| `clean` | Delete contract artifacts |
| `node` | Run hardhat network & node locally |
| `deploy` | Deploy compiled contracts to local hardhat network |
| `mint` | Example code: mint new tokens |
| `total-supply` | Example code: get total-supply |
| `transfer` | Example code: transfer tokens |
| `approve` | Example code: approve allowance |
| `permit` | Example code: permit allowance (EIP2612) |
| `transfer-from` | Example code: transfer tokens from spender |
| `transfer-with-authorization` | Example code: transfer tokens with signatures (EIP3009) |
| `receive-with-authorization` | Example code: receive tokens with signatures (EIP3009) |
| `cancel-authorization` | Example code: cancel token authorization (EIP3009) |
| Command | Description |
| ---------------: | :---------------------------------------------------- |
| `docs` | Generate Markdown documents from TSDoc-style comments |
| `lint` | Run Eslint |
| `lint:dry-run` | Run Eslint without fixing |
| `format` | Run Prettier |
| `format:dry-run` | Run Prettier without fixing |
| `compile` | Compile (transpile) SDK |

## 📚 Documentation

Expand Down
60 changes: 0 additions & 60 deletions packages/v1/examples/README.md

This file was deleted.

25 changes: 0 additions & 25 deletions packages/v1/examples/approve.ts

This file was deleted.

115 changes: 0 additions & 115 deletions packages/v1/examples/cancel-authorization.ts

This file was deleted.

14 changes: 0 additions & 14 deletions packages/v1/examples/constants.ts

This file was deleted.

41 changes: 0 additions & 41 deletions packages/v1/examples/index.ts

This file was deleted.

32 changes: 0 additions & 32 deletions packages/v1/examples/mint.ts

This file was deleted.

Loading

0 comments on commit 991a698

Please sign in to comment.