Class Profile

Hierarchy

Profile

Index

Constructors

Methods

create createProfileWithGumDomain delete get getAllProfiles getOrCreate getProfile getProfileByDomainName getProfilesByAuthority getProfilesByProfileAccount getProfilesByScreenName update validateProfileMetadata

Constructors

constructor

new Profile(sdk: SDK): Profile
Parameters
- sdk: SDK
Returns Profile
- Defined in profile.ts:28

Methods

create

create(metadataUri: string, screenNameAccount: PublicKey, authority: PublicKey, payer?: PublicKey): Promise<{
instructionMethodBuilder: MethodsBuilder<GplCore, Object>;
profilePDA: PublicKey;
}>
Parameters
- metadataUri: string
- screenNameAccount: PublicKey
- authority: PublicKey
- payer: PublicKey = authority
Returns Promise<{
instructionMethodBuilder: MethodsBuilder<GplCore, Object>;
profilePDA: PublicKey;
}>
- Defined in profile.ts:61

createProfileWithGumDomain

createProfileWithGumDomain(metadataUri: string, domainName: string, authority: PublicKey, payer?: PublicKey): Promise<{
instructionMethodBuilder: MethodsBuilder<GplCore, Object>;
profilePDA: PublicKey;
}>
Parameters
- metadataUri: string
- domainName: string
- authority: PublicKey
- payer: PublicKey = authority
Returns Promise<{
instructionMethodBuilder: MethodsBuilder<GplCore, Object>;
profilePDA: PublicKey;
}>
- Defined in profile.ts:92

delete

delete(profileAccount: PublicKey, authority: PublicKey): MethodsBuilder<GplCore, Object>
Parameters
- profileAccount: PublicKey
- authority: PublicKey
Returns MethodsBuilder<GplCore, Object>
- Defined in profile.ts:163

get

get(profileAccount: PublicKey): Promise<DecodeStruct<{
    fields: [{
        name: "issuer";
        type: "publicKey";
    }, {
        name: "holder";
        type: "publicKey";
    }, {
        name: "updateAuthority";
        type: "publicKey";
    }, {
        name: "schema";
        type: "publicKey";
    }, {
        name: "metadataUri";
        type: "string";
    }];
    kind: "struct";
} | {
    fields: [{
        name: "authority";
        type: "publicKey";
    }, {
        name: "verified";
        type: "bool";
    }];
    kind: "struct";
} | {
    fields: [{
        name: "authority";
        type: "publicKey";
    }, {
        name: "metadataUri";
        type: "string";
    }, {
        name: "randomHash";
        type: {
            array: ["u8", 32];
        };
    }];
    kind: "struct";
} | {
    fields: [{
        name: "fromProfile";
        type: "publicKey";
    }, {
        name: "toProfile";
        type: "publicKey";
    }];
    kind: "struct";
} | {
    fields: [{
        name: "profile";
        type: "publicKey";
    }, {
        name: "metadataUri";
        type: "string";
    }, {
        name: "randomHash";
        type: {
            array: ["u8", 32];
        };
    }, {
        name: "replyTo";
        type: {
            option: "publicKey";
        };
    }];
    kind: "struct";
} | {
    fields: [{
        name: "authority";
        type: "publicKey";
    }, {
        name: "metadataUri";
        type: "string";
    }, {
        name: "screenName";
        type: "publicKey";
    }, {
        name: "randomHash";
        type: {
            array: ["u8", 32];
        };
    }];
    kind: "struct";
} | {
    fields: [{
        name: "fromProfile";
        type: "publicKey";
    }, {
        name: "toPost";
        type: "publicKey";
    }, {
        name: "reactionType";
        type: "string";
    }];
    kind: "struct";
}, DecodedHelper<[{
    name: "PostError";
    type: {
        kind: "enum";
        variants: [{
            name: "URITooLong";
        }];
    };
}, {
    name: "ProfileMetadataError";
    type: {
        kind: "enum";
        variants: [{
            name: "URITooLong";
        }];
    };
}, {
    name: "ConnectionError";
    type: {
        kind: "enum";
        variants: [{
            name: "CannotConnectToSelf";
        }];
    };
}], EmptyDefined>>>
Parameters
- profileAccount: PublicKey
Returns Promise<DecodeStruct<{
    fields: [{
        name: "issuer";
        type: "publicKey";
    }, {
        name: "holder";
        type: "publicKey";
    }, {
        name: "updateAuthority";
        type: "publicKey";
    }, {
        name: "schema";
        type: "publicKey";
    }, {
        name: "metadataUri";
        type: "string";
    }];
    kind: "struct";
} | {
    fields: [{
        name: "authority";
        type: "publicKey";
    }, {
        name: "verified";
        type: "bool";
    }];
    kind: "struct";
} | {
    fields: [{
        name: "authority";
        type: "publicKey";
    }, {
        name: "metadataUri";
        type: "string";
    }, {
        name: "randomHash";
        type: {
            array: ["u8", 32];
        };
    }];
    kind: "struct";
} | {
    fields: [{
        name: "fromProfile";
        type: "publicKey";
    }, {
        name: "toProfile";
        type: "publicKey";
    }];
    kind: "struct";
} | {
    fields: [{
        name: "profile";
        type: "publicKey";
    }, {
        name: "metadataUri";
        type: "string";
    }, {
        name: "randomHash";
        type: {
            array: ["u8", 32];
        };
    }, {
        name: "replyTo";
        type: {
            option: "publicKey";
        };
    }];
    kind: "struct";
} | {
    fields: [{
        name: "authority";
        type: "publicKey";
    }, {
        name: "metadataUri";
        type: "string";
    }, {
        name: "screenName";
        type: "publicKey";
    }, {
        name: "randomHash";
        type: {
            array: ["u8", 32];
        };
    }];
    kind: "struct";
} | {
    fields: [{
        name: "fromProfile";
        type: "publicKey";
    }, {
        name: "toPost";
        type: "publicKey";
    }, {
        name: "reactionType";
        type: "string";
    }];
    kind: "struct";
}, DecodedHelper<[{
    name: "PostError";
    type: {
        kind: "enum";
        variants: [{
            name: "URITooLong";
        }];
    };
}, {
    name: "ProfileMetadataError";
    type: {
        kind: "enum";
        variants: [{
            name: "URITooLong";
        }];
    };
}, {
    name: "ConnectionError";
    type: {
        kind: "enum";
        variants: [{
            name: "CannotConnectToSelf";
        }];
    };
}], EmptyDefined>>>
- Defined in profile.ts:32

getAllProfiles

getAllProfiles(): Promise<GumDecodedProfile[]>
Returns Promise<GumDecodedProfile[]>
- Defined in profile.ts:252

getOrCreate

getOrCreate(metadataUri: string, screenNameAccount: PublicKey, authority: PublicKey, payer?: PublicKey): Promise<PublicKey>
Gets or creates a profile for a given user account and namespace.

To use this method, you must first initialize an instance of the SDK and pass a GraphQL client to the constructor. The client will be used to fetch profile information.
Parameters
- metadataUri: string
- screenNameAccount: PublicKey
- authority: PublicKey
- payer: PublicKey = authority
Returns Promise<PublicKey>
- Defined in profile.ts:42

getProfile

getProfile(screenNameAccount: PublicKey, authority: PublicKey): Promise<GumDecodedProfile>
Parameters
- screenNameAccount: PublicKey
- authority: PublicKey
Returns Promise<GumDecodedProfile>
- Defined in profile.ts:224

getProfileByDomainName

getProfileByDomainName(domainName: string): Promise<GumDecodedProfile>
Parameters
- domainName: string
Returns Promise<GumDecodedProfile>
- Defined in profile.ts:339

getProfilesByAuthority

getProfilesByAuthority(authority: PublicKey): Promise<GumDecodedProfile[]>
Parameters
- authority: PublicKey
Returns Promise<GumDecodedProfile[]>
- Defined in profile.ts:269

getProfilesByProfileAccount

getProfilesByProfileAccount(profileAccount: PublicKey): Promise<GumDecodedProfile>
Parameters
- profileAccount: PublicKey
Returns Promise<GumDecodedProfile>
- Defined in profile.ts:317

getProfilesByScreenName

getProfilesByScreenName(screenNameAccount: PublicKey): Promise<GumDecodedProfile[]>
Parameters
- screenNameAccount: PublicKey
Returns Promise<GumDecodedProfile[]>
- Defined in profile.ts:295

update

update(metadataUri: string, profileAccount: PublicKey, screenNameAccount: PublicKey, authority: PublicKey): Promise<MethodsBuilder<GplCore, Object>>
Parameters
- metadataUri: string
- profileAccount: PublicKey
- screenNameAccount: PublicKey
- authority: PublicKey
Returns Promise<MethodsBuilder<GplCore, Object>>
- Defined in profile.ts:148

validateProfileMetadata

validateProfileMetadata(metadataUri: string): Promise<boolean>
Parameters
- metadataUri: string
Returns Promise<boolean>
- Defined in profile.ts:175

Class Profile

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

sdk: SDK

Returns Profile

Methods

create

Parameters

metadataUri: string

screenNameAccount: PublicKey

authority: PublicKey

payer: PublicKey = authority

Returns Promise<{ instructionMethodBuilder: MethodsBuilder<GplCore, Object>; profilePDA: PublicKey; }>

createProfileWithGumDomain

Parameters

metadataUri: string

domainName: string

authority: PublicKey

payer: PublicKey = authority

Returns Promise<{ instructionMethodBuilder: MethodsBuilder<GplCore, Object>; profilePDA: PublicKey; }>

delete

Parameters

profileAccount: PublicKey

authority: PublicKey

Returns MethodsBuilder<GplCore, Object>

get

Parameters

profileAccount: PublicKey

getAllProfiles

Returns Promise<GumDecodedProfile[]>

getOrCreate

Parameters

metadataUri: string

screenNameAccount: PublicKey

authority: PublicKey

payer: PublicKey = authority

Returns Promise<PublicKey>

getProfile

Parameters

screenNameAccount: PublicKey

authority: PublicKey

Returns Promise<GumDecodedProfile>

getProfileByDomainName

Parameters

domainName: string

Returns Promise<GumDecodedProfile>

getProfilesByAuthority

Parameters

authority: PublicKey

Returns Promise<GumDecodedProfile[]>

getProfilesByProfileAccount

Parameters

profileAccount: PublicKey

Returns Promise<GumDecodedProfile>

getProfilesByScreenName

Parameters

screenNameAccount: PublicKey

Returns Promise<GumDecodedProfile[]>

update

Parameters

metadataUri: string

profileAccount: PublicKey

screenNameAccount: PublicKey

authority: PublicKey

Returns Promise<MethodsBuilder<GplCore, Object>>

validateProfileMetadata

Parameters

metadataUri: string

Returns Promise<boolean>

Settings

Member Visibility

Theme

Returns Promise<{
instructionMethodBuilder: MethodsBuilder<GplCore, Object>;
profilePDA: PublicKey;
}>

Returns Promise<{
instructionMethodBuilder: MethodsBuilder<GplCore, Object>;
profilePDA: PublicKey;
}>