https://github.com/thenamespace/namespace-sdk
A typescript library for interacting with namespace contracts and apis
https://github.com/thenamespace/namespace-sdk
Last synced: 4 months ago
JSON representation
A typescript library for interacting with namespace contracts and apis
- Host: GitHub
- URL: https://github.com/thenamespace/namespace-sdk
- Owner: thenamespace
- Created: 2024-07-19T20:58:43.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-12-15T20:19:32.000Z (over 1 year ago)
- Last Synced: 2024-12-15T21:25:08.418Z (over 1 year ago)
- Language: TypeScript
- Size: 112 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Namespace-SDK
A Typescript library used to interact with Namespace contracts and APIs.
It uses Viem under the hood and can be used to:
* Find names listed on the Namespace platform
* Check the availability of subnames
* Mint subnames
This is the initial version, expect many more functionalities in the future!
# Installation
Use a package manager to install the library into your project
Yarn
```bash
yarn add namespace-sdk
```
Npm
```bash
npm install namespace-sdk
```
# Getting started
First, we can create a simple NamespaceClient and specify the chainID. The chain id specifies a chain on which read/write blockchain operations happen. If we list our name on a Mainnet and subnames are minted on Mainnet, we'll have to specify a chainID 1. We will use a sepolia testnet as an example.
The chainID is required since the library supports minting subnames on both Layer 1 and its testnet (Sepolia) but also on Layer 2 (currently, only Base chain is supported).
```typescript
import { createNamespaceClient } from "namespace-sdk";
import { sepolia } from "viem/chains";
const namespaceClient = createNamespaceClient({
chainId: sepolia.id
});
```
# Minting a subname
Minting ENS subnames requires a couple of steps.
## 1. Listing an ENS name
First, we would need to have an ENS name that is listed on the Namespace platform. To do so, visit our [Platform](https://app.namespace.tech) and check
[Manager](https://docs.namespace.tech/namespace-platform/manager)
For testing purposes, you can use "namespace-sdk.eth" on the Sepolia chain.
## 2. Generate minting parameters
After we list the ENS name, our platform allows minting subnames under it. We can use a library to check for subname availability and to generate mint transaction parameters.
```typescript
import { createNamespaceClient, SetRecordsRequest, MintTransactionParameters } from "namespace-sdk";
import { sepolia } from "viem/chains";
const namespaceClient = createNamespaceClient({
chainId: sepolia.id,
});
const LISTED_NAME = "namespace-sdk.eth"
const ETH_COIN_TYPE = 60;
const generateMintingParameters = async (): Promise => {
// Get listed name from namespace api
const listedName = await namespaceClient.getListedName(
LISTED_NAME,
sepolia.id
);
const subnameLabel = "myfunnylabel";
const minterAddress = "0x6CaBE5E77F90d58600A3C13127Acf6320Bee0aA7"
// Check for name availability
const isNotTaken = await namespaceClient.isSubnameAvailable(
listedName,
subnameLabel
);
if (!isNotTaken) {
throw Error("Subname is already taken!");
}
// Generate mint transcation parameters
const mintDetails = await namespaceClient.getMintTransactionParameters(listedName, {
minterAddress: minterAddress,
subnameLabel: subnameLabel,
subnameOwner: minterAddress,
// Optionaly, we can also set resolver records with the mint transaction
records: {
addresses: [
{
address: minterAddress,
coinType: ETH_COIN_TYPE
}
],
texts: [
{
key: "name",
value: "namespace"
}
]
}
});
return mintDetails;
};
```
## 3. Send Transaction
Sending a transaction is the last step. Since the library uses Viem under the hood, we will use WalletClient to send a transaction.
```typescript
import { sepolia } from "viem/chains";
import { privateKeyToAccount } from "viem/accounts";
import { createWalletClient, http } from "viem";
import { generateMintingParameters } from "./minting";
const sendMintTransaction = async () => {
// Import your wallet and create a Viem Wallet Client
const wallet = privateKeyToAccount("0xYourWallet");
const walletClient = createWalletClient({
transport: http(),
chain: sepolia,
account: wallet
})
// Generate minting parameters
const mintParams = await generateMintingParameters();
// Send transaction
const transactionHash = await walletClient.writeContract({
abi: mintParams.abi,
address: mintParams.contractAddress,
functionName: mintParams.functionName,
args: mintParams.args,
value: mintParams.value
})
console.log(transactionHash);
}
```
## Authors
[artii.eth](https://github.com/nenadmitt)