Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Version up to 1.1.0 #56

Merged
merged 16 commits into from
Nov 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion documentation/index.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ info:
version: "0.9.0"
contact:
name: API support
url: https://forum.klaytn.foundation/
url: https://devforum.kaia.io/
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
Expand Down
2 changes: 1 addition & 1 deletion documentation/namespaces/admin.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ info:
version: "0.9.0"
contact:
name: API support
url: https://forum.klaytn.foundation/
url: https://devforum.kaia.io/
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
Expand Down
2 changes: 1 addition & 1 deletion documentation/namespaces/debug.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ info:
version: "0.9.0"
contact:
name: API support
url: https://forum.klaytn.foundation/
url: https://devforum.kaia.io/
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
Expand Down
2 changes: 1 addition & 1 deletion documentation/namespaces/eth.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ info:
version: "0.9.0"
contact:
name: API support
url: https://forum.klaytn.foundation/
url: https://devforum.kaia.io/
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
Expand Down
2 changes: 1 addition & 1 deletion documentation/namespaces/governance.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ info:
version: "0.9.0"
contact:
name: API support
url: https://forum.klaytn.foundation/
url: https://devforum.kaia.io/
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
Expand Down
2 changes: 1 addition & 1 deletion documentation/namespaces/kaia.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ info:
version: "0.9.0"
contact:
name: API support
url: https://forum.klaytn.foundation/
url: https://devforum.kaia.io/
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
Expand Down
2 changes: 1 addition & 1 deletion documentation/namespaces/klay.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ info:
version: "0.9.0"
contact:
name: API support
url: https://forum.klaytn.foundation/
url: https://devforum.kaia.io/
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
Expand Down
2 changes: 1 addition & 1 deletion documentation/namespaces/mainbridge.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ info:
version: "0.9.0"
contact:
name: API support
url: https://forum.klaytn.foundation/
url: https://devforum.kaia.io/
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
Expand Down
2 changes: 1 addition & 1 deletion documentation/namespaces/net.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ info:
version: "0.9.0"
contact:
name: API support
url: https://forum.klaytn.foundation/
url: https://devforum.kaia.io/
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
Expand Down
2 changes: 1 addition & 1 deletion documentation/namespaces/personal.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ info:
version: "0.9.0"
contact:
name: API support
url: https://forum.klaytn.foundation/
url: https://devforum.kaia.io/
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
Expand Down
2 changes: 1 addition & 1 deletion documentation/namespaces/subbridge.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ info:
version: "0.9.0"
contact:
name: API support
url: https://forum.klaytn.foundation/
url: https://devforum.kaia.io/
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
Expand Down
2 changes: 1 addition & 1 deletion documentation/namespaces/txpool.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ info:
version: "0.9.0"
contact:
name: API support
url: https://forum.klaytn.foundation/
url: https://devforum.kaia.io/
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
Expand Down
2 changes: 1 addition & 1 deletion documentation/redocly.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# See https://redocly.com/docs/cli/configuration/ for more information.
organization: klaytn.foundation
organization: kaia.io
apis:
[email protected]:
root: ./index.yaml
Expand Down
32 changes: 16 additions & 16 deletions ethers-ext/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Ethers.js Extension for Klaytn
# Ethers.js Extension for Kaia

Ethers.js Extension for Klaytn offers:
Ethers.js Extension for Kaia offers:

- Drop-in replacement to `ethers.Wallet` that handles both Ethereum and Klaytn transaction types
- Drop-in replacement to `ethers.Wallet` that handles both Ethereum and Kaia transaction types
involving AccountKey and TxTypes.
- Drop-in replacement to `ethers.providers.JsonRpcProvider` that provides accesses to both Ethereum RPCs and
Klaytn-specific RPCs.
Kaia-specific RPCs.
- Drop-in replacement to `ethers.Web3Provider` to work with both MetaMask (`window.ethereum`) and Kaikas (`window.klaytn`)

## Note for ethers v6
Expand All @@ -31,7 +31,7 @@ Ethers.js Extension for Klaytn offers:

```js
const ethers = require("ethers"); // ethers v5
const { Wallet } = require("@klaytn/ethers-ext/v5");
const { Wallet } = require("@kaiachain/ethers-ext/v5");

const provider = new ethers.providers.JsonRpcProvider(
"https://public-en-kairos.node.kaia.io"
Expand All @@ -43,7 +43,7 @@ Ethers.js Extension for Klaytn offers:

```js
const ethers = require("ethers"); // ethers v6
const { Wallet } = require("@klaytn/ethers-ext/v6");
const { Wallet } = require("@kaiachain/ethers-ext/v6");

const provider = new ethers.JsonRpcProvider(
"https://public-en-kairos.node.kaia.io"
Expand Down Expand Up @@ -73,21 +73,21 @@ Ethers.js Extension for Klaytn offers:
- ESM or TypeScript

```ts
import { Wallet, JsonRpcProvider } from "@klaytn/ethers-ext";
import { Wallet, JsonRpcProvider } from "@kaiachain/ethers-ext";

// esm
// v5
import { v5 } from "@klaytn/ethers-ext";
import { v5 } from "@kaiachain/ethers-ext";
const { Wallet, JsonRpcProvider } = v5;
// v6
import { v6 } from "@klaytn/ethers-ext";
import { v6 } from "@kaiachain/ethers-ext";
const { Wallet, JsonRpcProvider } = v6;

// esm subpath import. If using typescript, add "moduleResolution": "nodenext" to tsconfig.json
// v5
import { Wallet, JsonRpcProvider } from "@klaytn/ethers-ext/v5";
import { Wallet, JsonRpcProvider } from "@kaiachain/ethers-ext/v5";
// v6
import { Wallet, JsonRpcProvider } from "@klaytn/ethers-ext/v6";
import { Wallet, JsonRpcProvider } from "@kaiachain/ethers-ext/v6";

const provider = new JsonRpcProvider("https://public-en-kairos.node.kaia.io");
const wallet = new Wallet("<private key>", provider);
Expand All @@ -97,12 +97,12 @@ Ethers.js Extension for Klaytn offers:

```js
// v5
const { Wallet, JsonRpcProvider } = require("@klaytn/ethers-ext");
const { Wallet, JsonRpcProvider } = require("@klaytn/ethers-ext").v5;
const { Wallet, JsonRpcProvider } = require("@klaytn/ethers-ext/v5");
const { Wallet, JsonRpcProvider } = require("@kaiachain/ethers-ext");
const { Wallet, JsonRpcProvider } = require("@kaiachain/ethers-ext").v5;
const { Wallet, JsonRpcProvider } = require("@kaiachain/ethers-ext/v5");
// v6
const { Wallet, JsonRpcProvider } = require("@klaytn/ethers-ext").v6;
const { Wallet, JsonRpcProvider } = require("@klaytn/ethers-ext/v6");
const { Wallet, JsonRpcProvider } = require("@kaiachain/ethers-ext").v6;
const { Wallet, JsonRpcProvider } = require("@kaiachain/ethers-ext/v6");

const provider = new JsonRpcProvider("https://public-en-kairos.node.kaia.io");
const wallet = new Wallet("<private key>", provider);
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// AccountKeyLegacy
// https://docs.klaytn.foundation/docs/learn/accounts/
// https://docs.kaia.io/docs/learn/accounts/

const { ethers } = require("ethers5");

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// AccountKeyPublic
// https://docs.klaytn.foundation/docs/learn/accounts/
// https://docs.kaia.io/docs/learn/accounts/

const { ethers } = require("ethers5");

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// AccountKeyRoleBased
// https://docs.klaytn.foundation/docs/learn/accounts/
// https://docs.kaia.io/docs/learn/accounts/

const { ethers } = require("ethers5");

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// AccountKeyWeightedMultiSig
// https://docs.klaytn.foundation/docs/learn/accounts/
// https://docs.kaia.io/docs/learn/accounts/

const { ethers } = require("ethers5");

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// AccountKeyLegacy
// https://docs.klaytn.foundation/docs/learn/accounts/
// https://docs.kaia.io/docs/learn/accounts/

const { ethers } = require("ethers5");

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// AccountKeyPublic
// https://docs.klaytn.foundation/docs/learn/accounts/
// https://docs.kaia.io/docs/learn/accounts/

const { ethers } = require("ethers5");

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// AccountKeyRoleBased
// https://docs.klaytn.foundation/docs/learn/accounts/
// https://docs.kaia.io/docs/learn/accounts/

const { ethers } = require("ethers5");

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// AccountKeyWeightedMultiSig
// https://docs.klaytn.foundation/docs/learn/accounts/
// https://docs.kaia.io/docs/learn/accounts/

const { ethers } = require("ethers5");

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// AccountKeyLegacy
// https://docs.klaytn.foundation/docs/learn/accounts/
// https://docs.kaia.io/docs/learn/accounts/

const { ethers } = require("ethers5");

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// AccountKeyPublic
// https://docs.klaytn.foundation/docs/learn/accounts/
// https://docs.kaia.io/docs/learn/accounts/

const { ethers } = require("ethers5");

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// AccountKeyRoleBased
// https://docs.klaytn.foundation/docs/learn/accounts/
// https://docs.kaia.io/docs/learn/accounts/

const { ethers } = require("ethers5");

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// AccountKeyWeightedMultiSig
// https://docs.klaytn.foundation/docs/learn/accounts/
// https://docs.kaia.io/docs/learn/accounts/

const { ethers } = require("ethers5");

Expand Down
2 changes: 1 addition & 1 deletion ethers-ext/example/v5/rpc/rpc.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ async function main() {
let provider = new JsonRpcProvider("https://public-en-kairos.node.kaia.io/");

// The full list of JSON-RPC is available at:
// https://docs.klaytn.foundation/content/dapp/json-rpc/api-references
// https://docs.kaia.io/references/json-rpc/references
const num = await provider.klay.blockNumber();
console.log("klay.blockNumber", num);

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// TxTypeValueTransfer
// https://docs.klaytn.foundation/docs/learn/transactions/
// https://docs.kaia.io/docs/learn/transactions/

const ethers = require("ethers5");

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// TxTypeValueTransferMemo
// https://docs.klaytn.foundation/docs/learn/transactions/
// https://docs.kaia.io/docs/learn/transactions/

const ethers = require("ethers5");

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// TxTypeAccountUpdate
// https://docs.klaytn.foundation/docs/learn/transactions/
// https://docs.kaia.io/docs/learn/transactions/

const ethers = require("ethers5");

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// TxTypeSmartContractDeploy
// https://docs.klaytn.foundation/docs/learn/transactions/
// https://docs.kaia.io/docs/learn/transactions/

const ethers = require("ethers5");

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// TxTypeSmartContractExecution
// https://docs.klaytn.foundation/docs/learn/transactions/
// https://docs.kaia.io/docs/learn/transactions/

const ethers = require("ethers5");

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// TxTypeCancel
// https://docs.klaytn.foundation/docs/learn/transactions/
// https://docs.kaia.io/docs/learn/transactions/

const ethers = require("ethers5");

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// TxtypeFeeDelegatedValueTransfer
// https://docs.klaytn.foundation/docs/learn/transactions/
// https://docs.kaia.io/docs/learn/transactions/

const ethers = require("ethers5");

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// TxTypeFeeDelegatedValueTransferMemo
// https://docs.klaytn.foundation/docs/learn/transactions/
// https://docs.kaia.io/docs/learn/transactions/

const ethers = require("ethers5");

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// TxTypeFeeDelegatedAccountUpdate
// https://docs.klaytn.foundation/docs/learn/transactions/
// https://docs.kaia.io/docs/learn/transactions/

const ethers = require("ethers5");

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// TxTypeFeeDelegatedSmartContractDeploy
// https://docs.klaytn.foundation/docs/learn/transactions/
// https://docs.kaia.io/docs/learn/transactions/

const ethers = require("ethers5");

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// TxTypeFeeDelegatedSmartContractExecution
// https://docs.klaytn.foundation/docs/learn/transactions/
// https://docs.kaia.io/docs/learn/transactions/

const ethers = require("ethers5");

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// TxTypeFeeDelegatedCancel
// https://docs.klaytn.foundation/docs/learn/transactions/
// https://docs.kaia.io/docs/learn/transactions/

const ethers = require("ethers5");

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// TxTypeFeeDelegatedValueTransferWithRatio
// https://docs.klaytn.foundation/docs/learn/transactions/
// https://docs.kaia.io/docs/learn/transactions/

const ethers = require("ethers5");

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// TxTypeFeeDelegatedValueTransferMemoWithRatio
// https://docs.klaytn.foundation/docs/learn/transactions/
// https://docs.kaia.io/docs/learn/transactions/

const ethers = require("ethers5");

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// TxTypeFeeDelegatedAccountUpdateWithRatio
// https://docs.klaytn.foundation/docs/learn/transactions/
// https://docs.kaia.io/docs/learn/transactions/

const ethers = require("ethers5");

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// TxTypeFeeDelegatedSmartContractDeployWithRatio
// https://docs.klaytn.foundation/docs/learn/transactions/
// https://docs.kaia.io/docs/learn/transactions/

const ethers = require("ethers5");

Expand Down
Loading
Loading