Class: FungibleTokenClaimContract

Properties overview

• events: {
  claim: typeof ClaimEvent;
  offer: typeof ClaimEvent;
  updateWhitelist: typeof Whitelist;
  withdraw: typeof ClaimEvent;
  }; ↗
• claim: typeof ClaimEvent = ClaimEvent; ↗
• offer: typeof ClaimEvent = ClaimEvent; ↗
• updateWhitelist: typeof Whitelist = Whitelist; ↗
• withdraw: typeof ClaimEvent = ClaimEvent; ↗
• Overrides: SmartContract.events ↗
• maxAmount: State; ↗
• owner: State; ↗
• token: State; ↗
• whitelist: State; ↗
• Overrides: SmartContract.deploy ↗

Methods overview

• claim() ↗
• deploy() ↗
• initialize() ↗
• offer() ↗
• updateWhitelist() ↗
• withdraw() ↗

Defined in: packages/token/src/claim.ts:31

Extends

• SmartContract

Constructors

new FungibleTokenClaimContract()

new FungibleTokenClaimContract(address: PublicKey, tokenId?: Field): FungibleTokenClaimContract

Defined in: node_modules/o1js/dist/node/lib/mina/zkapp.d.ts:148

Parameters

address

PublicKey

tokenId?

Field

Returns

FungibleTokenClaimContract

Inherited from

SmartContract.constructor

Properties

events

events: {
  claim: typeof ClaimEvent;
  offer: typeof ClaimEvent;
  updateWhitelist: typeof Whitelist;
  withdraw: typeof ClaimEvent;
};

Defined in: packages/token/src/claim.ts:50

A list of event types that can be emitted using this.emitEvent()`.

claim

claim: typeof ClaimEvent = ClaimEvent;

offer

offer: typeof ClaimEvent = ClaimEvent;

updateWhitelist

updateWhitelist: typeof Whitelist = Whitelist;

withdraw

withdraw: typeof ClaimEvent = ClaimEvent;

Overrides

SmartContract.events

maxAmount

maxAmount: State<UInt64>;

Defined in: packages/token/src/claim.ts:35

owner

owner: State<PublicKey>;

Defined in: packages/token/src/claim.ts:32

token

token: State<PublicKey>;

Defined in: packages/token/src/claim.ts:33

whitelist

whitelist: State<Whitelist>;

Defined in: packages/token/src/claim.ts:34

Methods

claim()

claim(amount: UInt64): Promise<void>

Defined in: packages/token/src/claim.ts:110

Parameters

amount

UInt64

Returns

Promise<void>

deploy()

deploy(args: FungibleTokenClaimContractDeployProps): Promise<void>

Defined in: packages/token/src/claim.ts:37

Deploys a SmartContract.

let tx = await Mina.transaction(sender, async () => {
  AccountUpdate.fundNewAccount(sender);
  await zkapp.deploy();
});
tx.sign([senderKey, zkAppKey]);

Parameters

args

FungibleTokenClaimContractDeployProps

Returns

Promise<void>

Overrides

SmartContract.deploy

initialize()

initialize(
   owner: PublicKey, 
   token: PublicKey, 
amount: UInt64): Promise<void>

Defined in: packages/token/src/claim.ts:57

Parameters

owner

PublicKey

token

PublicKey

amount

UInt64

Returns

Promise<void>

offer()

offer(amount: UInt64): Promise<void>

Defined in: packages/token/src/claim.ts:73

Parameters

amount

UInt64

Returns

Promise<void>

updateWhitelist()

updateWhitelist(whitelist: Whitelist): Promise<void>

Defined in: packages/token/src/claim.ts:141

Parameters

whitelist

Whitelist

Returns

Promise<void>

withdraw()

withdraw(amount: UInt64): Promise<void>

Defined in: packages/token/src/claim.ts:89

Parameters

amount

UInt64

Returns

Promise<void>