Skip to content
Open
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 README.md
Original file line number Diff line number Diff line change
Expand Up @@ -544,7 +544,7 @@ const signerFunction = createSigner.fromEthersWallet(wallet);
await guildClient.guild.create(
{
name: "My New Guild",
urlName: "my-new-guild-123", // Optinal
urlName: "my-new-guild-123", // Optional
description: "Cool stuff", // Optional
admins: ["0x916b1aBC3C38852B338a22B08aF19DEe14113627"], // Optional
showMembers: true, // Optional
Expand Down
2 changes: 1 addition & 1 deletion examples/custom-point-distribution/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ It sets the following things in the Guild:

- Basic data (its name, urlName, ...)
- A role with a GUILD_SNAPSHOT requirement. This requirement will be the source of the point distribution
- A POINTS reward, which taks it's input from the requirement
- A POINTS reward, which takes its input from the requirement

## Editing the points

Expand Down
6 changes: 3 additions & 3 deletions v2-migration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@

## Signing a message

Use `createSigner` to construct a signer function. There are multiple ways to create a signer function, for example `createSigner.fromEthersWallet` can construct a signer from an `ethers.Walllet`
Use `createSigner` to construct a signer function. There are multiple ways to create a signer function, for example `createSigner.fromEthersWallet` can construct a signer from an `ethers.Wallet`

```ts
import { createSigner, guild } from "@guildxyz/sdk";
Expand Down Expand Up @@ -100,7 +100,7 @@ const guildMembership = userMemberships.find(

#### `join`

Use the `actions.join` client. Create a new join action with `actions.join.start`, then poll it's state by either calling `actions.join.poll`, or `actions.join.await`. The former will make a single poll, while the latter will keep polling the state until the job is done
Use the `actions.join` client. Create a new join action with `actions.join.start`, then poll its state by either calling `actions.join.poll`, or `actions.join.await`. The former will make a single poll, while the latter will keep polling the state until the job is done

```ts
import { actions } from "@guildxyz/sdk";
Expand Down Expand Up @@ -215,7 +215,7 @@ await guild.delete(someGuildId, mySigner);

#### `get`

Use `guild.role.get`. It now needs a `guildIdOrUrlName` param as well, and optionally takes a signer for more detailed results. The `guildId`, `members`, `requirements` and `rolePlatforms` fields aren't included in the result anymore. `guildId` is assumed to be known, as it is needed to make the get call, the other three can be fetched sepatarately with `guild.getMembers`, `guild.role.requirement.getAll` and `guild.role.reward.getAll`
Use `guild.role.get`. It now needs a `guildIdOrUrlName` param as well, and optionally takes a signer for more detailed results. The `guildId`, `members`, `requirements` and `rolePlatforms` fields aren't included in the result anymore. `guildId` is assumed to be known, as it is needed to make the get call, the other three can be fetched separately with `guild.getMembers`, `guild.role.requirement.getAll` and `guild.role.reward.getAll`

```ts
import { guild } from "@guildxyz/sdk";
Expand Down